Tgl::Texture Class Reference

[AI] Represents a GPU or system memory texture for use in rendering. More...

#include <tgl.h>

Inheritance diagram for Tgl::Texture:

Collaboration diagram for Tgl::Texture:

Public Member Functions
virtual Result	SetTexels (int width, int height, int bitsPerTexel, void *pTexels)=0
	[AI] Sets the texture image data (texels and size). More...
virtual void	FillRowsOfTexture (int y, int height, void *pBuffer)=0
	[AI] Fills lines of texel data in the image buffer. More...
virtual Result	Changed (int texelsChanged, int paletteChanged)=0
	[AI] Notifies of changes to texels or palette. More...
virtual Result	GetBufferAndPalette (int *pWidth, int *pHeight, int *pDepth, void **ppBuffer, int *pPaletteSize, PaletteEntry **ppPalette)=0
	[AI] Retrieves texture buffer and palette for external access. More...
virtual Result	SetPalette (int entryCount, PaletteEntry *pEntries)=0
	[AI] Assigns a palette to the texture. More...
Public Member Functions inherited from Tgl::Object
virtual	~Object ()
	[AI] Destructor; releases resources. More...
virtual void *	ImplementationDataPtr ()=0
	[AI] Returns a pointer to internal/implementation data, if any. More...

Detailed Description

[AI] Represents a GPU or system memory texture for use in rendering.

[AI]

[AI] Allows uploading texel data, palette control, and buffer retrieval. [AI]

Definition at line 826 of file tgl.h.

Member Function Documentation

Changed()

virtual Result Tgl::Texture::Changed ( int  texelsChanged, int  paletteChanged  )

pure virtual

[AI] Notifies of changes to texels or palette.

[AI]

Parameters

texelsChanged	Nonzero if the texel data has changed. [AI]
paletteChanged	Nonzero if the palette has changed. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::TextureImpl.

FillRowsOfTexture()

virtual void Tgl::Texture::FillRowsOfTexture ( int  y, int  height, void *  pBuffer  )

pure virtual

[AI] Fills lines of texel data in the image buffer.

[AI]

Parameters

y	Starting row. [AI]
height	Number of rows. [AI]
pBuffer	Pointer to data buffer. [AI]

Implemented in TglImpl::TextureImpl.

GetBufferAndPalette()

virtual Result Tgl::Texture::GetBufferAndPalette ( int *  pWidth, int *  pHeight, int *  pDepth, void **  ppBuffer, int *  pPaletteSize, PaletteEntry **  ppPalette  )

pure virtual

[AI] Retrieves texture buffer and palette for external access.

[AI]

Parameters

pWidth	Output width. [AI]
pHeight	Output height. [AI]
pDepth	Output bits-per-texel. [AI]
ppBuffer	Output pointer to texture buffer. [AI]
pPaletteSize	Output palette entry count. [AI]
ppPalette	Output pointer to palette data. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::TextureImpl.

SetPalette()

virtual Result Tgl::Texture::SetPalette ( int  entryCount, PaletteEntry *  pEntries  )

pure virtual

[AI] Assigns a palette to the texture.

[AI]

Parameters

entryCount	Number of palette entries. [AI]
pEntries	Palette entries. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::TextureImpl.

SetTexels()

virtual Result Tgl::Texture::SetTexels ( int  width, int  height, int  bitsPerTexel, void *  pTexels  )

pure virtual

[AI] Sets the texture image data (texels and size).

[AI]

Parameters

width	Texture width. [AI]
height	Texture height. [AI]
bitsPerTexel	Texel bit depth. [AI]
pTexels	Pointer to texel buffer. [AI]

Returns

Result Success or Error. [AI]

Implemented in TglImpl::TextureImpl.

---

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

• tgl.h