Torque3D Documentation / _generateds / GFXCubemap

GFXCubemap

Engine/source/gfx/gfxCubemap.h

More...

Public Friends

class

GFXDevice

class

GFXTextureManager

Protected Attributes

bool

mInitialized 

U32

mMipMapLevels 

String

mPath

The path to the cubemap file.

Protected Functions

void

_setPath(const String & path)

Sets the cubemap file path.

void

setToTexUnit(U32 tuNum)

Public Functions

GFXCubemap()

~GFXCubemap()

const String

describeSelf()

The resource should put a description of itself (number of vertices, size/width of texture, etc.) in buffer.
GFXFormat

getFormat()

Returns the face texture format.
const U32

getMipMapLevels()

Get the number of mip maps.
const String &

getPath()

Returns the cubemap file path set at creation.
U32

getSize()

Returns the size of the faces.
void

initDynamic(U32 texSize, GFXFormat faceFormat, U32 mipLevels)

create dynamic cubemap. mipLevels 0 is auto create mips, otherwise the value is how many mip levels you wish the cubemap to have
void

initNormalize(U32 size)

void

initStatic(DDSFile * dds)

Create a static cubemap from a DDS cubemap file.
void

initStatic(GFXTexHandle * faces)

Create a static cubemap from a list of 6 face textures.
bool

isInitialized()

Returns if this cubemap has been initialized.
Public Static Functions
U32

zUpFaceIndex(const U32 index)

Get Z up face index of the cubemap. DDS files will be stored Y up.
Detailed Description
Public Friends
Protected Attributes
bool mInitialized 

U32 mMipMapLevels 

String mPath 

The path to the cubemap file.
Protected Functions
_setPath(const String & path)

Sets the cubemap file path.
setToTexUnit(U32 tuNum)

Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
Public Functions
GFXCubemap()

~GFXCubemap()

describeSelf()

Reimplemented from: GFXResource
getFormat()

Returns the face texture format.
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
getMipMapLevels()

Get the number of mip maps.
getPath()

Returns the cubemap file path set at creation.
getSize()

Returns the size of the faces.
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
initDynamic(U32 texSize, GFXFormat faceFormat, U32 mipLevels)

create dynamic cubemap. mipLevels 0 is auto create mips, otherwise the value is how many mip levels you wish the cubemap to have
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
initNormalize(U32 size)

initStatic(DDSFile * dds)

Create a static cubemap from a DDS cubemap file.
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
initStatic(GFXTexHandle * faces)

Create a static cubemap from a list of 6 face textures.
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap, GFXNullCubemap
isInitialized()

Returns if this cubemap has been initialized.
Reimplemented by: GFXD3D11Cubemap, GFXGLCubemap
Public Static Functions
zUpFaceIndex(const U32 index)

Get Z up face index of the cubemap. DDS files will be stored Y up.