Public Types

enum {
HasDepth = (1 << 0) , HasStencil = (1 << 1) , IsColorSpace_sRGB = (1 << 2) , IsCompressed = (1 << 3) ,
IsNormalized = (1 << 4) , IsInteger = (1 << 5) , IsUnsigned = (1 << 6) , IsPacked = (1 << 7) ,
SupportsRenderTarget = (1 << 8) , SupportsMips = (1 << 9) , SupportsGenerateMips = (1 << 10) , SupportsTexture1D = (1 << 11) ,
SupportsTexture2D = (1 << 12) , SupportsTexture3D = (1 << 13) , SupportsTextureCube = (1 << 14) , SupportsVertex = (1 << 15) ,
IsUnsignedInteger = (IsUnsigned | IsInteger) , HasDepthStencil = (HasDepth | HasStencil)
}

Detailed Description

Format attribute flags enumeration.

See also: FormatAttributes::flags

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
HasDepth	Specifies whether the format has a depth component (e.g. Format::D16UNorm or Format::D24UNormS8UInt).
HasStencil	Specifies whether the format has a stencil component (e.g. Format::D24UNormS8UInt).
IsColorSpace_sRGB	Specifies whether the format is in non-linear sRGB color space (e.g. Format::RGBA8UNorm_sRGB or Format::BC1UNorm_sRGB).
IsCompressed	Specifies whether the format is compressed (e.g. Format::BC1UNorm or Format::BC5SNorm).
IsNormalized	Specifies whether the format has normalized integer components (e.g. Format::R8UNorm or Format::R8SNorm).
IsInteger	Specifies whether the format is an integer format (e.g. Format::R8UNorm or Format::R8SInt).
IsUnsigned	Specifies whether the format is an unsigned format (e.g. Format::R8UInt or Format::RG11B10Float).
IsPacked	Specifies whether the format is packed (e.g. Format::RGB10A2UNorm or Format::RGB9E5Float).
SupportsRenderTarget	Specifies whether the format can be used for render targets or rather depth-stencil or color attachments. See also BindFlags::ColorAttachment BindFlags::DepthStencilAttachment
SupportsMips	Specifies whether the format can have more than one MIP-map. See also TextureDescriptor::mipLevels
SupportsGenerateMips	Specifies whether the format supports to automatically generate MIP-maps. Remarks This implies that the flags `SupportsMips` and `SupportsRenderTarget` are also enabled. See also MiscFlags::GenerateMips CommandBuffer::GenerateMips
SupportsTexture1D	Specifies whether the format can be used for 1D and 1D-array textures. Remarks For example, block compressions (e.g. Format::BC1UNorm) cannot be used for 1D textures, because they are made out of 4x4 blocks. See also TextureType::Texture1D TextureType::Texture1DArray
SupportsTexture2D	Specifies whether the format can be used for 2D and 2D-array textures (both regular and multisampled). See also TextureType::Texture2D TextureType::Texture2DArray TextureType::Texture2DMS TextureType::Texture2DMSArray
SupportsTexture3D	Specifies whether the format can be used for 3D textures. See also TextureType::Texture3D
SupportsTextureCube	Specifies whether the format can be used for cube and cube-array textures. See also TextureType::TextureCube TextureType::TextureCubeArray
SupportsVertex	Specifies whether the format can be used for vertex attributes. See also VertexAttribute::format
IsUnsignedInteger	Combines the format flags `IsInteger` and `IsUnsigned`.
HasDepthStencil	Combines the format flags `HasDepth` and `HasStencil`.

The documentation for this struct was generated from the following file:

Format.h