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

#include <shaderFunctionDesc.h>

Public Member Functions

HGI_API HgiShaderFunctionTextureDesc ()

Public Attributes

std::string nameInShader
uint32_t dimensions
HgiFormat format
HgiShaderTextureType textureType
size_t arraySize
bool writable

Detailed Description

Describes a texture to be passed into a shader

  • nameInShader: The name written from the codegen into shader file for the texture.
  • dimensions: 1d, 2d or 3d texture declaration.
  • format Format of the texture. This is required in APIs where sampler types depend on the texture (e.g., GL)
  • textureType: Type of the texture (e.g. array texture, shadow, etc.).
  • arraySize: If arraySize > 0, indicates the size of the array. Note that textureType = HgiTextureTypeTexture and arraySize = 2 would create an array with two textures whereas textureType = HgiTextureTypeArrayTexture and arraySize = 0 would create a single array texture (arrays of array textures are supported as well).
  • writable Whether the texture is writable.

Definition at line 63 of file shaderFunctionDesc.h.

Constructor & Destructor Documentation

HGI_API HgiShaderFunctionTextureDesc::HgiShaderFunctionTextureDesc ( )

Member Data Documentation

size_t HgiShaderFunctionTextureDesc::arraySize

Definition at line 72 of file shaderFunctionDesc.h.

uint32_t HgiShaderFunctionTextureDesc::dimensions

Definition at line 69 of file shaderFunctionDesc.h.

HgiFormat HgiShaderFunctionTextureDesc::format

Definition at line 70 of file shaderFunctionDesc.h.

std::string HgiShaderFunctionTextureDesc::nameInShader

Definition at line 68 of file shaderFunctionDesc.h.

HgiShaderTextureType HgiShaderFunctionTextureDesc::textureType

Definition at line 71 of file shaderFunctionDesc.h.

bool HgiShaderFunctionTextureDesc::writable

Definition at line 73 of file shaderFunctionDesc.h.

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