Texture

Scaleform::Render::FenceResource
    Scaleform::Render::Texture

Declaration

class Texture : public RefCountBase<Texture, StatRender_TextureManager_Mem>, public ListNodeSafe<Texture>, public FenceResource;

Description

Texture is a hardware version of image that is typically allocated from a HAL-specific renderer's TextureManager and is managed by the rendering thread. Before Image data can be rendered it needs to be transferred into a Texture, as only textures are accepted by the HAL.

Texture can typically be created/destroyed by either advance or rendering thread, as its objects memory management is thread-safe. The Map/Unmap and Update operations can, however, only be executed by the rendering thread.

Data Members

Data Member	Description
ImgSize	Size of the image.
MipLevels	Number of mip levels in the texture.
pImage	Source image for the texture.
pFormat	The TextureFormat used by the texture (platform specific derived classes of TextureFormat exist).
State	The current lifetime state of the texture.
TextureCount	Number of hardware textures this texture consists of (multiple with YUV[A] textures).
pMap	If texture is currently mapped, it is here.
TextureFlags	Texture usage flags (see TextureFlagBits in derived Texture classes).
Use	Image usage flags (see ImageUse).

Enumerations

Enumeration	Description
CreateState	Describes the lifetime state that the texture is in.
TextureFlagBits	Bits stored in TextureFlags (some of these may only apply to certain platforms).

Methods

Method	Description
ApplyTexture	Applies a texture to a to a given stage for a device, starting at stageIndex and advances the index.
DisposeTextureData	Identical to LoseTextureData, except it sets the status of the texture to State_Disposed.
GetBytes	Returns the size in bytes the underlying system uses to store the texture data.
GetFormat	Retrieves the format of the image associated with the texture.
GetMipmapCount	Obtains the number of mipmaps of the texture in the image.
GetImage	Retrieves the image associated with a texture.
GetImageFormat	Returns the image format of the original image.
GetPlaneCount	Returns the number of planes used by the texture format.
GetSize	Returns the size of the image.
GetTextureManager	Retrieves the TextureManager which is used for managing the created textures.
GetTextureSize	Returns the size of the texture.
GetTextureStageCount	Returns the number of texture stages that are supported by the renderer.
GetUVGenMatrix	Fills in a matrix that should be used to convert pixel coordinate space to the UV coordinates used by the renderer.
ImageLost	Notifies texture that its image is about to become unavailable.
Initialize	A platform-specific method, that will actually create the API specific texture object.
IsValid	Determines whether the Initialize call has already been made, and if it was successful.
LoseManager	Called from ~TextureManager, cleaning out most of the texture internal state.
LoseTextureData	Called after texture data has been lost.
Map	Maps the texture data planes into the process address space so they can be accessed directly; should be called only from the rendering thread.
ReleaseHWTextures	Causes the hardware textures associated with this texture to be released.
Texture	Texture constructor.
Unmap	Ends access to the texture memory (from Map).
Update	Updates a texture region based on the specified image data.
UpdateRenderTargetData	Synchronizes RenderTarget and Staging content.
UpdateStagingData	Synchronizes staging content.

Structures

Structure	Description
UpdateDesc	Update descriptor provides source and destination data for Update.

File

Render_Image.h