All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Attributes | List of all members
HgiTextureViewDesc Struct Reference

Describes the properties needed to create a GPU texture view from an existing GPU texture object. More...

Public Attributes

std::string debugName
 
HgiFormat format
 
uint16_t layerCount
 
uint16_t mipLevels
 
HgiTextureHandle sourceTexture
 
uint16_t sourceFirstLayer
 
uint16_t sourceFirstMip
 

Detailed Description

Describes the properties needed to create a GPU texture view from an existing GPU texture object.

  • debugName: This label can be applied as debug label for GPU debugging.
  • format: The format of the texture view. This format must be compatible with the sourceTexture, but does not have to be the identical format. Generally: All 8-, 16-, 32-, 64-, and 128-bit color formats are compatible with other formats with the same bit length. For example HgiFormatFloat32Vec4 and HgiFormatInt32Vec4 are compatible.
  • layerCount: The number of layers (texture-arrays).
  • mipLevels: The number of mips in texture.
  • sourceTexture: Handle to the HgiTexture to be used as the source data backing.
  • sourceFirstLayer: The layer index to use from the source texture as the first layer of the view.
  • sourceFirstMip: The mip index to ues from the source texture as the first mip of the view.

Definition at line 238 of file texture.h.

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