Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

Rm2DTexture Class Reference

2D Texture More...

#include <RmSurface.h>

Inheritance diagram for Rm2DTexture:

RmTexture List of all members.

Public Member Functions

 Rm2DTexture ()
 Constructor.

virtual ~Rm2DTexture ()
 Destructor.

bool Create (RmPixelFormatType pixelFormat, int width, int height, int numMipmaps)
 Creation of Texture.

virtual void Destroy ()
 Destroy.

int GetNumMipmaps () const
 Get number mipmap.

RmSurfaceGetMipmap (int level)
 Get mipmap.

const RmSurfaceGetMipmap (int level) const
 Get mipmap.

RmTextureType GetTextureType () const
 Tetxure type.

int GetWidth () const
 Get width.

int GetHeight () const
 Get height.

RmPixelFormatType GetPixelFormat () const
 Pixelformat.


Detailed Description

2D Texture

2D Texture


Constructor & Destructor Documentation

Rm2DTexture::Rm2DTexture  ) 
 

Constructor.

Constructor

virtual Rm2DTexture::~Rm2DTexture  )  [virtual]
 

Destructor.

Destructor


Member Function Documentation

bool Rm2DTexture::Create RmPixelFormatType  pixelFormat,
int  width,
int  height,
int  numMipmaps
 

Creation of Texture.

Create

  • Create 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:
width Width of surface
height Height of surface
numMipmaps Number of mipmaps to create. If 0, it will create all the way down 1x1
Returns:
True on success

virtual void Rm2DTexture::Destroy  )  [virtual]
 

Destroy.

Cleanup all the memory allocated for texture

Returns:
None

Reimplemented from RmTexture.

int Rm2DTexture::GetHeight  )  const [inline]
 

Get height.

Get height

Returns:
Height of top level mipmap

const RmSurface* Rm2DTexture::GetMipmap int  level  )  const
 

Get mipmap.

Get mipmap by index

Parameters:
level Mipmap level
Returns:
Mipmap surface
See also:
RmSurface

RmSurface* Rm2DTexture::GetMipmap int  level  ) 
 

Get mipmap.

Get mipmap by index

Parameters:
level Mipmap level
Returns:
Mipmap surface
See also:
RmSurface

int Rm2DTexture::GetNumMipmaps  )  const [inline]
 

Get number mipmap.

Get number of mipmaps

Returns:
Number of mipmaps

RmPixelFormatType Rm2DTexture::GetPixelFormat  )  const [inline, virtual]
 

Pixelformat.

Return current pixel format

Returns:
Pixelformat
See also:
RmPixelFormatType

Implements RmTexture.

RmTextureType Rm2DTexture::GetTextureType  )  const [inline, virtual]
 

Tetxure type.

Return texture type

Returns:
Texture type
See also:
RmTextureType

Implements RmTexture.

int Rm2DTexture::GetWidth  )  const [inline]
 

Get width.

Get width

Returns:
Width of top level mipmap


The documentation for this class was generated from the following file:
Generated on Fri Feb 25 16:08:52 2005 for RenderMonkey SDK by doxygen 1.3.6