Rm3DTexture Class Reference

3D Texture More...

#include <RmVolume.h>

Inheritance diagram for Rm3DTexture:

List of all members.

Public Member Functions
	Rm3DTexture ()
	Constructor.
virtual	~Rm3DTexture ()
	Destructor.
bool	Create (RmPixelFormatType pixelFormat, int width, int height, int depth, int numMipmaps)
	Create volume texture.
void	Destroy ()
	Destroy.
int	GetNumMipmaps () const
	Get number of mipmaps.
RmVolume *	GetMipmap (int level)
	Get mipmap.
const RmVolume *	GetMipmap (int level) const
	Get mipmap.
RmTextureType	GetTextureType () const
	Texture type.
int	GetWidth () const
	Get width.
int	GetHeight () const
	Get height.
int	GetDepth () const
	Get depth.
RmPixelFormatType	GetPixelFormat () const
	Get pixel format.

---

Detailed Description

3D Texture

3D volume texture

• Contains a volumetric texture representation along with a collection of mip volumes. Each successive mip volume level is 1/2 the size of the previous one

---

Constructor & Destructor Documentation

Rm3DTexture::Rm3DTexture (   )

Constructor. Constructor

virtual Rm3DTexture::~Rm3DTexture (   )  [virtual]

Destructor. Destructor

---

Member Function Documentation

bool Rm3DTexture::Create (  RmPixelFormatType  pixelFormat, int  width, int  height, int  depth, int  numMipmaps )

Create volume texture. Create Create volume texture with given size and pixel format. If numMipmaps == 0, it will create all levels ( down to 1x1 ) Parameters: pixelFormat  Pixel format See also: RmPixelFormatType Parameters: width  Width of volume height  Height of volume depth  Depth of volume numMipmaps  Number of mipmaps Returns: True on success

void Rm3DTexture::Destroy (   )  [virtual]

Destroy. Destroy volume texture. Returns: None Reimplemented from RmTexture.

int Rm3DTexture::GetDepth (   )  const [inline]

Get depth. Return depth of the top level mipmap Returns: Depth of the top level volume

int Rm3DTexture::GetHeight (   )  const [inline]

Get height. Return height of the top level mipmap Returns: Height of the top level volume

const RmVolume* Rm3DTexture::GetMipmap (  int  level  )  const

Get mipmap. Retrieve volume at a given mip level Parameters: level  Mip level Returns: Volume at given mip level See also: RmVolume

RmVolume* Rm3DTexture::GetMipmap (  int  level  )

Get mipmap. Retrieve volume at a given mip level Parameters: level  Mip level Returns: Volume at given mip level See also: RmVolume

int Rm3DTexture::GetNumMipmaps (   )  const [inline]

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

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

Get pixel format. Returns pixel format of the volume Returns: Pixelformat See also: RmPixelFormatType Implements RmTexture.

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

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

int Rm3DTexture::GetWidth (   )  const [inline]

Get width. Return width of the top level mipmap Returns: Width of the top level volume

---

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

• RmVolume.h

---