Loading...
Searching...
No Matches
HgiTextureViewDesc Struct Reference

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

#include <texture.h>

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 244 of file texture.h.

Constructor & Destructor Documentation

◆ HgiTextureViewDesc()

HgiTextureViewDesc ( )
inline

Definition at line 246 of file texture.h.

Member Data Documentation

◆ debugName

std::string debugName

Definition at line 255 of file texture.h.

◆ format

HgiFormat format

Definition at line 256 of file texture.h.

◆ layerCount

uint16_t layerCount

Definition at line 257 of file texture.h.

◆ mipLevels

uint16_t mipLevels

Definition at line 258 of file texture.h.

◆ sourceFirstLayer

uint16_t sourceFirstLayer

Definition at line 260 of file texture.h.

◆ sourceFirstMip

uint16_t sourceFirstMip

Definition at line 261 of file texture.h.

◆ sourceTexture

HgiTextureHandle sourceTexture

Definition at line 259 of file texture.h.


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