Collapse all Symbian^3 Product Developer Library

THuiTextureHandle Class Reference

class THuiTextureHandle : public MHuiTexture

Handle to a single-segment texture object. Only used for referencing existing textures. Destroying the handle does not affect the texture object itself.

Inherits from

THuiTextureHandle
- MHuiTexture

Public Member Functions
	THuiTextureHandle()
	THuiTextureHandle(TUint, const TSize &, const TSize &)
IMPORT_C TBool	HasContent()
IMPORT_C TBool	IsNull()
IMPORT_C TUint	Name()
IMPORT_C void	Release()
IMPORT_C TInt	SegmentCount()
IMPORT_C TUint	SegmentName(TInt)
IMPORT_C TPoint	SegmentOffset(TInt)
IMPORT_C TSize	SegmentSize(TInt)
IMPORT_C TSize	SegmentTextureSize(TInt)
IMPORT_C MHuiSegmentedTexture *	SegmentedTexture()
IMPORT_C const MHuiSegmentedTexture *	SegmentedTexture()
IMPORT_C void	Set(TUint, const TSize &, const TSize &)
IMPORT_C void	SetName(TUint)
IMPORT_C void	SetSize(const TSize &)
IMPORT_C void	SetTextureSize(const TSize &)
IMPORT_C MHuiShadowedTexture *	ShadowedTexture()
IMPORT_C const MHuiShadowedTexture *	ShadowedTexture()
IMPORT_C TSize	Size()
IMPORT_C TBool	TextureChanged()
IMPORT_C void	TextureClearChanged()

Protected Member Functions
IMPORT_C void	TextureExtension(const TUid &, TAny **)

Inherited Functions
	MHuiTexture::~MHuiTexture()

Public Attributes
TUint	iName
TSize	iSize
TSize	iTextureSize

Constructor & Destructor Documentation

THuiTextureHandle()

IMPORT_C

THuiTextureHandle

(

)

Constructors and destructor. Constructor.

THuiTextureHandle(TUint, const TSize &, const TSize &)

IMPORT_C	THuiTextureHandle	(	TUint	aName,
			const TSize &	aSize,
			const TSize &	aTextureSize
		)

Constructs a texture handle. Set()

Parameters

TUint aName
const TSize & aSize
const TSize & aTextureSize

Member Functions Documentation

HasContent()

IMPORT_C TBool

HasContent

(

)

const [virtual]

Determines whether the texture has content. Only textures that have content can be drawn.

Note that a texture that has not finished loading will return EFalse here, because its content will only become available after it has been fully loaded.

IsNull()

IMPORT_C TBool

IsNull

(

)

const

Determines if this is a null handle.

Name()

IMPORT_C TUint

Name

(

)

const

Release()

IMPORT_C void

Release

(

)

Releases the texture object that the handle references.

SegmentCount()

IMPORT_C TInt

SegmentCount

(

)

const

SegmentName(TInt)

IMPORT_C TUint

SegmentName

(

TInt

aSegment

)

const

Parameters

TInt aSegment

SegmentOffset(TInt)

IMPORT_C TPoint

SegmentOffset

(

TInt

aSegment

)

const

Parameters

TInt aSegment

SegmentSize(TInt)

IMPORT_C TSize

SegmentSize

(

TInt

aSegment

)

const

Parameters

TInt aSegment

SegmentTextureSize(TInt)

IMPORT_C TSize

SegmentTextureSize

(

TInt

aSegment

)

const

Parameters

TInt aSegment

SegmentedTexture()

IMPORT_C MHuiSegmentedTexture *

SegmentedTexture

(

)

[virtual]

SegmentedTexture()

IMPORT_C const MHuiSegmentedTexture *

SegmentedTexture

(

)

const [virtual]

Set(TUint, const TSize &, const TSize &)

IMPORT_C void	Set	(	TUint	aName,
			const TSize &	aSize,
			const TSize &	aTextureSize
		)

Sets the handle's texture name, logical size and texture size. This is equivalent to calling SetName(), SetSize(), and SetTextureSize().

Parameters

TUint aName	Assigns texture name of this handle. For example, with OpenGL ES renderer, this will be the texture name generated with glGenTextures().
const TSize & aSize	The actual texture size of this texture.
const TSize & aTextureSize

SetName(TUint)

IMPORT_C void

SetName

(

TUint

aName

)

Sets the name of the named texture object that this handle refers to.

Parameters

TUint aName

Name of the texture object.

SetSize(const TSize &)

IMPORT_C void

SetSize

(

const TSize &

aSize

)

Sets the logical size of the texture object this handle refers to.

Parameters

const TSize & aSize

Logical size.

SetTextureSize(const TSize &)

IMPORT_C void

SetTextureSize

(

const TSize &

aTextureSize

)

Sets the actual size of the texture object this handle refers to. For example, with OpenGL ES, this is the size of the texture object itself, which is limited to powers of two.

Parameters

const TSize & aTextureSize

Texture size.

ShadowedTexture()

IMPORT_C MHuiShadowedTexture *

ShadowedTexture

(

)

[virtual]

ShadowedTexture()

IMPORT_C const MHuiShadowedTexture *

ShadowedTexture

(

)

const [virtual]

Size()

IMPORT_C TSize

Size

(

)

const

TextureChanged()

IMPORT_C TBool

TextureChanged

(

)

const [virtual]

Returns true if the texture has changed since the last change notification. Changed means that the bitmap data of the texture has been modified, and must be re-uploaded to texture memory.

TextureClearChanged()

IMPORT_C void

TextureClearChanged

(

)

const [virtual]

Clears the changed status of the visual.

TextureExtension(const TUid &, TAny **)

IMPORT_C void	TextureExtension	(	const TUid &	aExtensionUid,
			TAny **	aExtensionParameters
		)	[protected, virtual]

Parameters

const TUid & aExtensionUid
TAny ** aExtensionParameters

Member Data Documentation

TUint iName

TUint

iName

Name of the GL texture.

TSize iSize

TSize

iSize

Logical size of this texture.

TSize iTextureSize

TSize

iTextureSize

Real size of the GL texture object.