HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
shaderFunctionDesc.h File Reference
#include "pxr/pxr.h"
#include "pxr/imaging/hgi/api.h"
#include "pxr/imaging/hgi/enums.h"
#include "pxr/imaging/hgi/types.h"
#include <string>
#include <vector>
+ Include dependency graph for shaderFunctionDesc.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  HgiShaderFunctionTextureDesc
 
struct  HgiShaderFunctionBufferDesc
 
struct  HgiShaderFunctionParamDesc
 
struct  HgiShaderFunctionDesc
 

Typedefs

using HgiShaderFunctionTextureDescVector = std::vector< HgiShaderFunctionTextureDesc >
 
using HgiShaderFunctionBufferDescVector = std::vector< HgiShaderFunctionBufferDesc >
 
using HgiShaderFunctionParamDescVector = std::vector< HgiShaderFunctionParamDesc >
 
using HgiShaderFunctionDescVector = std::vector< HgiShaderFunctionDesc >
 

Functions

HGI_API bool operator== (const HgiShaderFunctionTextureDesc &lhs, const HgiShaderFunctionTextureDesc &rhs)
 
HGI_API bool operator!= (const HgiShaderFunctionTextureDesc &lhs, const HgiShaderFunctionTextureDesc &rhs)
 
HGI_API bool operator== (const HgiShaderFunctionBufferDesc &lhs, const HgiShaderFunctionBufferDesc &rhs)
 
HGI_API bool operator!= (const HgiShaderFunctionBufferDesc &lhs, const HgiShaderFunctionBufferDesc &rhs)
 
HGI_API bool operator== (const HgiShaderFunctionParamDesc &lhs, const HgiShaderFunctionParamDesc &rhs)
 
HGI_API bool operator!= (const HgiShaderFunctionParamDesc &lhs, const HgiShaderFunctionParamDesc &rhs)
 
HGI_API bool operator== (const HgiShaderFunctionDesc &lhs, const HgiShaderFunctionDesc &rhs)
 
HGI_API bool operator!= (const HgiShaderFunctionDesc &lhs, const HgiShaderFunctionDesc &rhs)
 
HGI_API void HgiShaderFunctionAddTexture (HgiShaderFunctionDesc *desc, const std::string &nameInShader, uint32_t dimensions=2, const HgiFormat &format=HgiFormatFloat32Vec4)
 Adds texture descriptor to given shader function descriptor. More...
 
HGI_API void HgiShaderFunctionAddBuffer (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type)
 Adds buffer descriptor to given shader function descriptor. More...
 
HGI_API void HgiShaderFunctionAddConstantParam (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string(), const std::string &attribute=std::string(), const std::string &attributeIndex=std::string())
 
HGI_API void HgiShaderFunctionAddStageInput (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string(), const std::string &attribute=std::string(), const std::string &attributeIndex=std::string())
 
HGI_API void HgiShaderFunctionAddStageOutput (HgiShaderFunctionDesc *desc, const std::string &nameInShader, const std::string &type, const std::string &role=std::string(), const std::string &attribute=std::string(), const std::string &attributeIndex=std::string())
 

Typedef Documentation

Definition at line 189 of file shaderFunctionDesc.h.

Definition at line 139 of file shaderFunctionDesc.h.

Function Documentation

HGI_API void HgiShaderFunctionAddBuffer ( HgiShaderFunctionDesc desc,
const std::string nameInShader,
const std::string type 
)

Adds buffer descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddConstantParam ( HgiShaderFunctionDesc desc,
const std::string nameInShader,
const std::string type,
const std::string role = std::string(),
const std::string attribute = std::string(),
const std::string attributeIndex = std::string() 
)

Adds constant function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddStageInput ( HgiShaderFunctionDesc desc,
const std::string nameInShader,
const std::string type,
const std::string role = std::string(),
const std::string attribute = std::string(),
const std::string attributeIndex = std::string() 
)

Adds stage input function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddStageOutput ( HgiShaderFunctionDesc desc,
const std::string nameInShader,
const std::string type,
const std::string role = std::string(),
const std::string attribute = std::string(),
const std::string attributeIndex = std::string() 
)

Adds stage output function param descriptor to given shader function descriptor.

HGI_API void HgiShaderFunctionAddTexture ( HgiShaderFunctionDesc desc,
const std::string nameInShader,
uint32_t  dimensions = 2,
const HgiFormat format = HgiFormatFloat32Vec4 
)

Adds texture descriptor to given shader function descriptor.

HGI_API bool operator== ( const HgiShaderFunctionDesc lhs,
const HgiShaderFunctionDesc rhs 
)