Loading...
Searching...
No Matches
HgiShaderFunctionParamDesc Struct Reference

Describes a param passed into a shader or between shader stages. More...

#include <shaderFunctionDesc.h>

Public Attributes

std::string nameInShader
 
std::string type
 
int32_t location
 
int32_t interstageSlot
 
HgiInterpolationType interpolation
 
HgiSamplingType sampling
 
HgiStorageType storage
 
std::string role
 
std::string arraySize
 

Detailed Description

Describes a param passed into a shader or between shader stages.

  • nameInShader: The name written from the codegen into the shader file for the param.
  • type: Type of the param within the shader file.
  • location: For OpenGL, optionally specify the layout location. For Metal, if no role is specified, this generates the role
  • interstageSlot: Optionally specify an index for interstage parameters.
  • interpolation: Optionally specify the interpolation: Default, Flat or NoPerspective.
  • sampling: Optionally specify the sampling: Default, Centroid or Sample.
  • storage: Optionally specify the storage type: Default, Patch.
  • role: Optionally a role can be specified, like position, uv, color.
  • arraySize: If specified, generates an array type parameter with given size.

Definition at line 163 of file shaderFunctionDesc.h.

Member Data Documentation

◆ arraySize

std::string arraySize

Definition at line 176 of file shaderFunctionDesc.h.

◆ interpolation

HgiInterpolationType interpolation

Definition at line 172 of file shaderFunctionDesc.h.

◆ interstageSlot

int32_t interstageSlot

Definition at line 171 of file shaderFunctionDesc.h.

◆ location

int32_t location

Definition at line 170 of file shaderFunctionDesc.h.

◆ nameInShader

std::string nameInShader

Definition at line 168 of file shaderFunctionDesc.h.

◆ role

std::string role

Definition at line 175 of file shaderFunctionDesc.h.

◆ sampling

HgiSamplingType sampling

Definition at line 173 of file shaderFunctionDesc.h.

◆ storage

HgiStorageType storage

Definition at line 174 of file shaderFunctionDesc.h.

◆ type

std::string type

Definition at line 169 of file shaderFunctionDesc.h.


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