RmCubemap Class Reference

Cubemap texture. More...

#include <RmSurface.h>

Inheritance diagram for RmCubemap:

List of all members.

Public Member Functions
	RmCubemap ()
	Constructor.
virtual	~RmCubemap ()
	Destructor.
bool	Create (RmPixelFormatType pixelFormat, int edgeSize, int numMipmaps)
	Create cubemap.
virtual void	Destroy ()
	Destroy.
RmSurface *	GetFaceSurface (RmCubemapFaceType whichFace, int mipLevel)
	Get face surface.
const RmSurface *	GetFaceSurface (RmCubemapFaceType whichFace, int mipLevel) const
	Get face surface.
RmTextureType	GetTextureType () const
	Tetxure type.
int	GetNumMipmaps () const
	Get number mipmap.
int	GetEdgeSize () const
	Face's edge size.
RmPixelFormatType	GetPixelFormat () const
	Pixelformat.

---

Detailed Description

Cubemap texture.

Cubemap

• Cubemap Texture.

Call GetFaceSurface to retrieve cubemap's surface.

Eg. pSurface = pCubemap->GetFaceSurface(RM_CUBEMAP_FACE_X_POS, 3); returns Cubemap's surface ( positive X direction face ) at mipmap level 3.

---

Constructor & Destructor Documentation

RmCubemap::RmCubemap (   )

Constructor. Constructor

virtual RmCubemap::~RmCubemap (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

bool RmCubemap::Create (  RmPixelFormatType  pixelFormat, int  edgeSize, int  numMipmaps )

Create cubemap. Create Create cubemap texture with given size and pixel format. If numMipmaps == 0, it will create all levels ( down to 1x1 ) Parameters: pixelFormat  Format of surface See also: RmPixelFormatType Parameters: edgeSize  Edge size of each face of cubemap numMipmaps  Number of mipmaps to create. If 0, it will create all the way down 1x1 Returns: True on success

virtual void RmCubemap::Destroy (   )  [virtual]

Destroy. Cleanup all the memory allocated for texture Returns: None Reimplemented from RmTexture.

int RmCubemap::GetEdgeSize (   )  const [inline]

Face's edge size. Get face's edge size Returns: Edge size of each face

const RmSurface* RmCubemap::GetFaceSurface (  RmCubemapFaceType  whichFace, int  mipLevel )  const

Get face surface. Retriev cubemap's face Parameters: whichFace  Which cubemap face to retrieve See also: RmCubemapFaceType Mipmap level Returns: Cubemap's face surface See also: RmSurface

RmSurface* RmCubemap::GetFaceSurface (  RmCubemapFaceType  whichFace, int  mipLevel )

Get face surface. Retriev cubemap's face Parameters: whichFace  Which cubemap face to retrieve See also: RmCubemapFaceType Mipmap level Returns: Cubemap's face surface See also: RmSurface

int RmCubemap::GetNumMipmaps (   )  const [inline]

Get number mipmap. Get number of mipmaps Returns: Number of mipmaps

RmPixelFormatType RmCubemap::GetPixelFormat (   )  const [inline, virtual]

Pixelformat. Return current pixel format Returns: Pixelformat See also: RmPixelFormatType Implements RmTexture.

RmTextureType RmCubemap::GetTextureType (   )  const [inline, virtual]

Tetxure type. Return texture type Returns: Texture type See also: RmTextureType Implements RmTexture.

---

The documentation for this class was generated from the following file:

• RmSurface.h

---