All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiTextureDesc Struct Reference

#include <texture.h>

Public Member Functions

 HgiTextureDesc ()

Public Attributes

std::string debugName
HgiTextureUsage usage
HgiFormat format
HgiTextureType type
GfVec3i dimensions
uint16_t layerCount
uint16_t mipLevels
HgiSampleCount sampleCount
size_t pixelsByteSize
void constinitialData

Detailed Description

Describes the properties needed to create a GPU texture.

  • debugName: This label can be applied as debug label for GPU debugging.
  • usage: Describes how the texture is intended to be used.
  • format: The format of the texture.
  • dimensions: The resolution of the texture (width, height, depth).
  • type: Type of texture (2D, 3D).
  • layerCount: The number of layers (texture-arrays).
  • mipLevels: The number of mips in texture.
  • sampleCount: samples per texel (multi-sampling).
  • pixelsByteSize: Byte size (length) of pixel data (i.e., initialData).
  • initialData: CPU pointer to initialization pixels of the texture. The memory is consumed immediately during the creation of the HgiTexture. The application may alter or free this memory as soon as the constructor of the HgiTexture has returned. Data may optionally include pixels for each mip-level.

Definition at line 71 of file texture.h.

Constructor & Destructor Documentation

HgiTextureDesc::HgiTextureDesc ( )

Definition at line 73 of file texture.h.

Member Data Documentation

std::string HgiTextureDesc::debugName

Definition at line 85 of file texture.h.

GfVec3i HgiTextureDesc::dimensions

Definition at line 89 of file texture.h.

HgiFormat HgiTextureDesc::format

Definition at line 87 of file texture.h.

void const* HgiTextureDesc::initialData

Definition at line 94 of file texture.h.

uint16_t HgiTextureDesc::layerCount

Definition at line 90 of file texture.h.

uint16_t HgiTextureDesc::mipLevels

Definition at line 91 of file texture.h.

size_t HgiTextureDesc::pixelsByteSize

Definition at line 93 of file texture.h.

HgiSampleCount HgiTextureDesc::sampleCount

Definition at line 92 of file texture.h.

HgiTextureType HgiTextureDesc::type

Definition at line 88 of file texture.h.

HgiTextureUsage HgiTextureDesc::usage

Definition at line 86 of file texture.h.

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