MHuiShadowedTexture Class Reference

class MHuiShadowedTexture

MHuiShadowedTexture is an interface for textures that support dropshadows that are generated out of the texture's content.

Constructor & Destructor Documentation

~MHuiShadowedTexture()

~MHuiShadowedTexture ( ) [inline, virtual]

Virtual destructor.

Member Functions Documentation

EnableShadow(TBool)

void EnableShadow ( TBool aEnable = ETrue ) [pure virtual]

Enables or disables the generation of a shadow when a new image is uploaded. Note that when the shadow is enabled, a new texture image needs to be uploaded before the shadow is actually generated.

Parameters

TBool aEnable = ETrue Enables or disables shadow generation and usage.

GetShadowTexture(THuiTextureHandle &)

TBool GetShadowTexture ( THuiTextureHandle & aHandle ) const [pure virtual]

Gets a handle to the shadow texture. The handle can be a null handle if the shadow is disabled or has not been generated yet.

Does not return the handle as a return value because that would make it too easy to construct a THuiImage directly out of the handle, and cause a crash since the THuiImage would then reference a temporary object.

Parameters

THuiTextureHandle & aHandle Handle to the shadow texture is returned here.

IsShadowEnabled()

TBool IsShadowEnabled ( ) const [pure virtual]

Determines if shadow generation has been enabled.