TextureDesc

A structure representing a texture description.

File location: framework/cauldron/framework/inc/render/texture.h

Methods

Return type	Description
static TextureDesc	Tex1D ( const wchar_t* name, ResourceFormat format, uint32_t width, uint32_t arraySize = 1, uint32_t mipLevels = 0, ResourceFlags flags = ResourceFlags::None ) A convenience function to create a texture description for 1D textures.
static TextureDesc	Tex2D ( const wchar_t* name, ResourceFormat format, uint32_t width, uint32_t height, uint32_t arraySize = 1, uint32_t mipLevels = 0, ResourceFlags flags = ResourceFlags::None ) A convenience function to create a texture description for 2D textures.
static TextureDesc	Tex3D ( const wchar_t* name, ResourceFormat format, uint32_t width, uint32_t height, uint32_t depth = 1, uint32_t mipLevels = 0, ResourceFlags flags = ResourceFlags::None ) A convenience function to create a texture description for 3D textures.
static TextureDesc	TexCube ( const wchar_t* name, ResourceFormat format, uint32_t width, uint32_t height, uint32_t depth = 1, uint32_t mipLevels = 0, ResourceFlags flags = ResourceFlags::None ) A convenience function to create a texture description for cube textures.

Detailed description

A structure representing a texture description.

Data fields

Type	Description
ResourceFormat	Format The “ResourceFormat“ for the texture.
ResourceFlags	Flags The “ResourceFlags“ for the texture.
uint32_t	Width The texture’s width.
uint32_t	Height The texture’s height.
TextureDimension	Dimension The texture’s dimension (1D/2D/3D/etc.).
uint32_t	DepthOrArraySize The texture’s depth or number of arrays.
uint32_t	MipLevels The texture’s mip map count.
std::wstring	Name The tesxture’s name.

Methods

Tex1D

Copied!

static TextureDesc Tex1D (
    const wchar_t* name,
    ResourceFormat  format,
    uint32_t width,
    uint32_t arraySize = 1,
    uint32_t mipLevels = 0,
    ResourceFlags  flags = ResourceFlags::None
)

A convenience function to create a texture description for 1D textures.

Tex2D

Copied!

static TextureDesc Tex2D (
    const wchar_t* name,
    ResourceFormat  format,
    uint32_t width,
    uint32_t height,
    uint32_t arraySize = 1,
    uint32_t mipLevels = 0,
    ResourceFlags  flags = ResourceFlags::None
)

A convenience function to create a texture description for 2D textures.

Tex3D

Copied!

static TextureDesc Tex3D (
    const wchar_t* name,
    ResourceFormat  format,
    uint32_t width,
    uint32_t height,
    uint32_t depth = 1,
    uint32_t mipLevels = 0,
    ResourceFlags  flags = ResourceFlags::None
)

A convenience function to create a texture description for 3D textures.

TexCube

Copied!

static TextureDesc TexCube (
    const wchar_t* name,
    ResourceFormat  format,
    uint32_t width,
    uint32_t height,
    uint32_t depth = 1,
    uint32_t mipLevels = 0,
    ResourceFlags  flags = ResourceFlags::None
)