class Texture
The FidelityFX Cauldron Framework api/platform-agnostic representation of a texture resource.
File location: framework/cauldron/framework/inc/render/texture.h
Typedefs
|
Type |
Description |
|---|---|
|
typedef void |
(*ResizeFunction )( TextureDesc &, uint32_t, uint32_t, uint32_t, uint32_t )
|
Methods
|
Return type |
Description |
|---|---|
|
static Texture* |
CreateTexture ( const TextureDesc * pDesc, ResourceState initialState, ResizeFunction fn = nullptr )
Texture instance creation function (generic). Implemented per api/platform to return the correct internal resource type.
|
|
static Texture* |
Texture instance creation function for swap chains. Implemented per api/platform to return the correct internal resource type.
|
|
static Texture* |
CreateContentTexture (const TextureDesc * pDesc)
Texture instance creation function for loaded content. Implemented per api/platform to return the correct internal resource type.
|
|
ResourceFormat |
GetFormat () const
Returns the texture’s format.
|
|
const TextureDesc & |
GetDesc () const
Returns the texture’s description.
|
|
GetResource ()
Returns the texture’s backing “GPUResource“.
|
|
|
const GPUResource * |
GetResource () const
|
|
void |
CopyData (TextureDataBlock * pTextureDataBlock)
Copies data from a texture data block into the texture resource. Used when loading content from file/memory.
|
|
bool |
IsSwapChain () const
Returns true if this resource is a swap chain. Used to isolate swapchain surfaces from non-swap chain (specialization class exists per platform to overload this).
|
|
void |
OnRenderingResolutionResize ( uint32_t outputWidth, uint32_t outputHeight, uint32_t renderingWidth, uint32_t renderingHeight )
Callback invoked by OnResize event.
|
|
TextureInternal* |
GetImpl ()
Gets the internal implementation for api/platform parameter accessors.
|
|
const TextureInternal* |
GetImpl () const
|
Detailed description
The FidelityFX Cauldron Framework api/platform-agnostic representation of a texture resource.
Methods
CreateTexture
Copied!
static Texture* CreateTexture (
const TextureDesc * pDesc,
ResourceState initialState,
ResizeFunction fn = nullptr
)Texture instance creation function (generic). Implemented per api/platform to return the correct internal resource type.
CreateSwapchainTexture
Copied!
static Texture* CreateSwapchainTexture (
const TextureDesc * pDesc,
GPUResource * pResource
)Texture instance creation function for swap chains. Implemented per api/platform to return the correct internal resource type.
CreateContentTexture
Copied!
static Texture* CreateContentTexture (const TextureDesc * pDesc)Texture instance creation function for loaded content. Implemented per api/platform to return the correct internal resource type.
GetFormat
Copied!
ResourceFormat GetFormat () constReturns the texture’s format.
GetDesc
Copied!
const TextureDesc & GetDesc () constReturns the texture’s description.
GetResource
Copied!
GPUResource * GetResource ()Returns the texture’s backing GPUResource.
CopyData
Copied!
void CopyData (TextureDataBlock * pTextureDataBlock)Copies data from a texture data block into the texture resource. Used when loading content from file/memory.
IsSwapChain
Copied!
virtual bool IsSwapChain () constReturns true if this resource is a swap chain. Used to isolate swapchain surfaces from non-swap chain (specialization class exists per platform to overload this).
OnRenderingResolutionResize
Copied!
void OnRenderingResolutionResize (
uint32_t outputWidth,
uint32_t outputHeight,
uint32_t renderingWidth,
uint32_t renderingHeight
)Callback invoked by OnResize event.
GetImpl
Copied!
TextureInternal* GetImpl ()Gets the internal implementation for api/platform parameter accessors.
