SubImage

Scaleform::Render::ImageBase
    Scaleform::Render::Image
        Scaleform::Render::SubImage

Declaration

class SubImage : public Image;

Description

SubImage is an implementation of Image that references a sub-rectangle of an original image. Objects of this class are created by Image::CreateSubImage to support image packing.

Methods

Method	Description
GetFormat	Returns the format (ImageFormat) of this image.
GetAsImage	Returns the current object as a Render::Image pointer.
Decode	Decodes image into the destination ImageData, potentially converting data a scan-line at a time.
GetImageType	Returns the image type (ImageType) for this image.
GetBaseImage	Returns the base image that is referenced by SubImage object which uses the sub-rectangle of the base image.
GetSize	Obtains the logical dimensions of the images.
GetMatrixInverse	Retrieves the inverse image matrix used with an image for adjusting its size and/or location.
GetTexture	Obtains the texture pointer from the data, intended for use with a given renderer.
GetMipmapCount	Obtains the number of mipmaps of the texture in the image.
SubImage	SubImage constructor.
TextureLost	Called to indicate texture contents are lost and releases the texture references held by the images.
GetUse	Returns the use flag set for the image.
Map	Maps texture contents to user memory and causes the specified mipmap level of the texture to be accessible in system memory.
Unmap	Ends access to texture memory (from Map).
GetRect	Obtains a sub-rectangle of texture or entire texture to use within an image.

File

Render_Image.h