HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdShadeShaderDefUtils Class Reference

#include <shaderDefUtils.h>

Static Public Member Functions

static USDSHADE_API
NdrNodeDiscoveryResultVec 
GetNodeDiscoveryResults (const UsdShadeShader &shaderDef, const std::string &sourceUri)
 
static USDSHADE_API
SdrShaderNodeDiscoveryResultVec 
GetDiscoveryResults (const UsdShadeShader &shaderDef, const std::string &sourceUri)
 
static USDSHADE_API
NdrPropertyUniquePtrVec 
GetShaderProperties (const UsdShadeConnectableAPI &shaderDef)
 
static USDSHADE_API
SdrShaderPropertyUniquePtrVec 
GetProperties (const UsdShadeConnectableAPI &shaderDef)
 
static USDSHADE_API std::string GetPrimvarNamesMetadataString (const SdrTokenMap metadata, const UsdShadeConnectableAPI &shaderDef)
 

Detailed Description

This class contains a set of utility functions used for populating the shader registry with shaders definitions specified using UsdShade schemas.

Definition at line 28 of file shaderDefUtils.h.

Member Function Documentation

static USDSHADE_API SdrShaderNodeDiscoveryResultVec UsdShadeShaderDefUtils::GetDiscoveryResults ( const UsdShadeShader shaderDef,
const std::string &  sourceUri 
)
static

Returns the list of SdrShaderNodeDiscoveryResult objects that must be added to the shader registry for the given shader shaderDef, assuming it is found in a shader definition file found by an Sdr discovery plugin.

To enable the shaderDef parser to find and parse this shader, sourceUri should have the resolved path to the usd file containing this shader prim.

static USDSHADE_API NdrNodeDiscoveryResultVec UsdShadeShaderDefUtils::GetNodeDiscoveryResults ( const UsdShadeShader shaderDef,
const std::string &  sourceUri 
)
static

Returns the list of SdrShaderNodeDiscoveryResult objects that must be added to the shader registry for the given shader shaderDef, assuming it is found in a shader definition file found by an Sdr discovery plugin.

To enable the shaderDef parser to find and parse this shader, sourceUri should have the resolved path to the usd file containing this shader prim.

Deprecated:
Deprecated in favor of GetDiscoveryResults
static USDSHADE_API std::string UsdShadeShaderDefUtils::GetPrimvarNamesMetadataString ( const SdrTokenMap  metadata,
const UsdShadeConnectableAPI shaderDef 
)
static

Collects all the names of valid primvar inputs of the given metadata and the given shaderDef and returns the string used to represent them in SdrShaderNode metadata.

static USDSHADE_API SdrShaderPropertyUniquePtrVec UsdShadeShaderDefUtils::GetProperties ( const UsdShadeConnectableAPI shaderDef)
static

Gets all input and output properties of the given shaderDef and translates them into SdrShaderProperties that can be used as the properties for an SdrShaderNode.

static USDSHADE_API NdrPropertyUniquePtrVec UsdShadeShaderDefUtils::GetShaderProperties ( const UsdShadeConnectableAPI shaderDef)
static

Gets all input and output properties of the given shaderDef and translates them into SdrShaderProperties that can be used as the properties for an SdrShaderNode.

Deprecated:
Deprecated in favor of GetProperties

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