Image

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

Declaration

class Image : public ImageBase;

Description

Image represents an image within Scaleform Player and is used to generate textures for it.

Image lifetime with respect to threads:

- Image ref-counting is thread-safe. Renderer thread has the right to hold additional references to image/texture only for as long as Render::ContextImpl::Context is alive. Calling Render::ContextImpl::Context destructor should also remove all image references from its nodes (even if they exist in render queues).

- This is possible because Render::ContextImpl::Context doesn't wait for next capture (but it needs to wait for the frame to finish).

Enumerations

Enumeration	Description
TextureLossReason	TextureLossReason notifies Image that texture contents were lost. Images can respond by releasing the texture reference if needed.

Methods

Method	Description
initTexture_NoAddRef	Used to initialize pTexture pointer on creation.
releaseTexture	Releases texture atomically with proper notification.
Create	Creates a new image of specified size and format and is allocated in the specified memory heap.
CreateSubImage	Creates an Image that references a subregion of this image.
Decode	Decodes image into the destination ImageData, potentially converting data a scan-line at a time.
GetFormat	Returns the format (ImageFormat) of this image.
GetMatrix	Retrieves the image matrix used with an image for adjusting its size and/or location.
GetMatrixInverse	Retrieves the inverse image matrix used with an image for adjusting its size and/or location.
GetAsMemoryImage
GetImageType	Returns the image type (ImageType) for this image.
GetRect	Obtains a sub-rectangle of texture or entire texture to use within an image. By default, full texture rectangle is reported.
GetTexture	Obtains the texture pointer from the data, intended for use with a given renderer.
GetSize	Obtains the logical dimensions of the images.
GetUVGenMatrix	Fills in a matrix that converts image pixel coordinate space (0, 0, Width, Height) into UV coordinate space expected by Render::HAL.
GetUVNormMatrix	Fills in a matrix that converts normalized UV (0, 0, 1, 1) coordinate space to the HAL-specific UV such as packed sub-images, resample, etc.
GetUse	Returns the capability flag set for the image. See ImageUse.
Image	Initializes Image object with image data and texture.
Map	Maps texture contents to user memory and causes the specified mipmap level of the texture to be accessible in system memory.
SetMatrix	Sets an image matrix to use with an image for adjusting its size and/or location.
SetMatrixInverse	Sets an inverse image matrix to use with an image for adjusting its size and/or location.
TextureLost	Called to indicate texture contents are lost and releases the texture references held by the images.
Unmap	Ends access to texture memory (from Map).
Update	Queues up either a full update or custom image update for the image.

File

Render_Image.h