HgiShaderFunctionDesc Struct Reference

Describes the properties needed to create a GPU shader function. More...

Public Attributes

std::string debugName
HgiShaderStage shaderStage
const char * shaderCodeDeclarations
const char * shaderCode
std::string * generatedShaderCodeOut
std::vector< HgiShaderFunctionTextureDesctextures
std::vector< HgiShaderFunctionBufferDescbuffers
std::vector< HgiShaderFunctionParamDescconstantParams
std::vector< HgiShaderFunctionParamDescstageGlobalMembers
std::vector< HgiShaderFunctionParamDescstageInputs
std::vector< HgiShaderFunctionParamDescstageOutputs
std::vector< HgiShaderFunctionParamBlockDescstageInputBlocks
std::vector< HgiShaderFunctionParamBlockDescstageOutputBlocks
HgiShaderFunctionComputeDesc computeDescriptor
HgiShaderFunctionTessellationDesc tessellationDescriptor
HgiShaderFunctionGeometryDesc geometryDescriptor
HgiShaderFunctionFragmentDesc fragmentDescriptor

Detailed Description

Describes the properties needed to create a GPU shader function.

  • debugName: This label can be applied as debug label for gpu debugging.
  • shaderStage: The shader stage this function represents.
  • shaderCodeDeclarations: Optional ascii shader code containing defines and type declarations which need to be emitted before generated resource bindings.
  • shaderCode: The ascii shader code used to compile the shader.
  • generatedShaderCodeOut: Optional pointer to a string that will be filled in with the ascii shader code after shader generation is complete.
  • textures: List of texture descriptions to be passed into a shader.
  • buffers: List of buffer descriptions to be passed into a shader.
  • constantParams: List of descriptions of constant params passed into a shader.
  • stageGlobalMembers: List of descriptions of params declared at global scope.
  • stageInputs: List of descriptions of the inputs of the shader.
  • stageOutputs: List of descriptions of the outputs of the shader.
  • stageInputBlocks: List of descriptions of the input blocks of the shader.
  • stageOutputsBlocks: List of descriptions of the output blocks of the shader.
  • computeDescriptor: Description of compute shader function.
  • tessellationDescriptor: Description of tessellation shader function.
  • geometryDescriptor: Description of geometry shader function.
  • fragmentDescriptor: Description of fragment shader function.

Definition at line 437 of file shaderFunctionDesc.h.

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