DDSFile

Classes:

class

DDSFile::SurfaceData

Public Types

enum

_Anonymous_ {
  Cubemap_Surface_PosX 
  Cubemap_Surface_NegX 
  Cubemap_Surface_PosY 
  Cubemap_Surface_NegY 
  Cubemap_Surface_PosZ 
  Cubemap_Surface_NegZ 
  Cubemap_Surface_Count 
}

The index into mSurfaces for each cubemap face.

enum

DDSFlags {
  ComplexFlag = BIT(0)
  MipMapsFlag = BIT(1)
  CubeMapFlag = BIT(2)
  VolumeFlag = BIT(3)
  PitchSizeFlag = BIT(4)
  LinearSizeFlag = BIT(5)
  RGBData = BIT(6)
  CompressedData = BIT(7)
  CubeMap_PosX_Flag = BIT(8)
  CubeMap_NegX_Flag = BIT(9)
  CubeMap_PosY_Flag = BIT(10)
  CubeMap_NegY_Flag = BIT(11)
  CubeMap_PosZ_Flag = BIT(12)
  CubeMap_NegZ_Flag = BIT(13)
  CubeMap_All_Flags = CubeMapFlag|CubeMap_PosX_Flag | CubeMap_NegX_Flag | CubeMap_PosY_Flag | CubeMap_NegY_Flag | CubeMap_PosZ_Flag | CubeMap_NegZ_Flag
}

Public Attributes

U32

mBytesPerPixel

Ignored if we're a compressed texture.

String

mCacheString

U32

mDepth

BitSet32

mFlags

GFXFormat

mFormat

U32

mFourCC

bool

mHasTransparency

U32

mHeight

U32

mMipMapCount

U32

mPitchOrLinearSize

Torque::Path

mSourcePath

Vector< SurfaceData * >

mSurfaces

U32

mWidth

Public Static Attributes

S32

smActiveCopies

U32

smDropMipCount

Public Functions

DDSFile()

DDSFile(const DDSFile & dds)

~DDSFile()

void

clear()

Clear all our information; used before reading.

bool

decompressToGBitmap(GBitmap * dest)

U32

getDepth(U32 mipLevel)

GFXFormat

getFormat()

bool

getHasTransparency()

U32

getHeight(U32 mipLevel)

U32

getMipLevels()

U32

getSizeInBytes()

Returns the total video memory size of the texture including all mipmaps and compression settings.

const Torque::Path &

getSourcePath()

U32

getSurfacePitch(U32 mipLevel)

U32

getSurfaceSize(U32 height, U32 width, U32 mipLevel)

U32

getSurfaceSize(U32 mipLevel)

For our current format etc., what is the size of a surface with the given dimensions?

const String &

getTextureCacheString()

U32

getWidth(U32 mipLevel)

bool

isCubemap()

bool

read(Stream & s, U32 dropMipCount)

Reads a DDS file from the stream.

bool

readHeader(Stream & s)

Called from read() to read in the DDS header.

bool

write(Stream & s)

Writes this DDS file to the stream.

bool

writeHeader(Stream & s)

Called from write() to write the DDS header.

Public Static Functions

DDSFile *

createDDSCubemapFileFromGBitmaps(GBitmap ** gbmps)

DDSFile *

createDDSFileFromGBitmap(const GBitmap * gbmp)

U32

getSizeInBytes(GFXFormat format, U32 height, U32 width, U32 mipLevels)

Resource< DDSFile >

load(const Torque::Path & path, U32 dropMipCount)

Detailed Description