TextureImage

Scaleform::Render::ImageBase
    Scaleform::Render::Image
        Scaleform::Render::TextureImage

Declaration

class TextureImage : public Image;

Description

TextureImage is a version of Image that delegates all of its implementation to a Texture, not storing any additional plane information in memory. TextureImage typically can't be mapped locally, but it may be updateable based on the requested capabilities.

// If texture data cannot be lost (ImageUse_InitOnly) and is agreeable to the mapping settings, create a TextureImage directly.

Methods

Method	Description
GetAsImage	Returns the current object as a Render::Image pointer.
GetFormat	Returns the format (ImageFormat) of this image.
GetImageType	Returns the image type (ImageType) for this image.
GetMipmapCount	Obtains the number of mipmaps of the texture in the image.
GetSize	Obtains the logical dimensions of the images.
GetUse	Returns the use flag set for the image.
Map	Maps texture contents to user memory and enables the mipmap levels to be accessible in the system memory.
RefreshCachedFormat	Reinitializes the Size and Format for an image, from the underlying texture.
TextureImage	TextureImage constructor.
TextureLost	Called to indicate texture contents are lost and releases the texture references held by images.
Unmap	Ends access to texture memory (from Map).

File

Render_Image.h