Diligent::TextureDesc struct

Texture description.

Base classes

struct DeviceObjectAttribs
Describes common device object attributes.

Public functions

auto operator==(const TextureDesc& RHS) const -> bool
Tests if two structures are equivalent.

Public variables

RESOURCE_DIMENSION Type
Texture type. See Diligent::RESOURCE_DIMENSION for details.
Uint32 Width
Texture width, in pixels.
Uint32 Height
Texture height, in pixels.
Uint32 ArraySize
For a 1D array or 2D array, number of array slices.
Uint32 Depth
For a 3D texture, number of depth slices.
TEXTURE_FORMAT Format
Texture format, see Diligent::TEXTURE_FORMAT.
Uint32 MipLevels
Number of Mip levels in the texture. Multisampled textures can only have 1 Mip level. Specify 0 to create full mipmap chain.
Uint32 SampleCount
Number of samples.
Only 2D textures or 2D texture arrays can be multisampled.
USAGE Usage
Texture usage. See Diligent::USAGE for details.
BIND_FLAGS BindFlags
Bind flags, see Diligent::BIND_FLAGS for details.
The following bind flags are allowed: Diligent::BIND_SHADER_RESOURCE, Diligent::BIND_RENDER_TARGET, Diligent::BIND_DEPTH_STENCIL, Diligent::and BIND_UNORDERED_ACCESS.
Multisampled textures cannot have Diligent::BIND_UNORDERED_ACCESS flag set.
CPU_ACCESS_FLAGS CPUAccessFlags
CPU access flags or 0 if no CPU access is allowed, see Diligent::CPU_ACCESS_FLAGS for details.
MISC_TEXTURE_FLAGS MiscFlags
Miscellaneous flags, see Diligent::MISC_TEXTURE_FLAGS for details.
OptimizedClearValue ClearValue
Optimized clear value.
Uint64 CommandQueueMask
Defines which command queues this texture can be used with.

Function documentation

bool Diligent::TextureDesc::operator==(const TextureDesc& RHS) const

Tests if two structures are equivalent.

Parameters
RHS in - reference to the structure to perform comparison with
Returns
  • True if all members of the two structures except for the Name are equal.
  • False otherwise. The operator ignores DeviceObjectAttribs::Name field as it does not affect the texture description state.