HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
UsdShadeShaderDefParserPlugin Class Reference

#include <shaderDefParser.h>

+ Inheritance diagram for UsdShadeShaderDefParserPlugin:

Public Member Functions

USDSHADE_API UsdShadeShaderDefParserPlugin ()=default
 
USDSHADE_API ~UsdShadeShaderDefParserPlugin () override=default
 
USDSHADE_API SdrShaderNodeUniquePtr ParseShaderNode (const SdrShaderNodeDiscoveryResult &discoveryResult) override
 
USDSHADE_API const SdrTokenVec & GetDiscoveryTypes () const override
 
USDSHADE_API const TfToken & GetShadingSystem () const override
 Returns the shading system that this parser operates in. More...
 
- Public Member Functions inherited from SdrParserPlugin
SDR_API SdrParserPlugin ()
 
virtual SDR_API ~SdrParserPlugin ()
 
virtual SDR_API const TfToken & GetSourceType () const
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase & __GetTfWeakBase__ () const
 
const TfWeakBase & operator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Additional Inherited Members

- Static Public Member Functions inherited from SdrParserPlugin
static SDR_API
SdrShaderNodeUniquePtr 		GetInvalidShaderNode (const SdrShaderNodeDiscoveryResult &dr)
 
- Protected Member Functions inherited from TfWeakBase
 ~TfWeakBase ()
 
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Detailed Description

Parses shader definitions represented using USD scene description using the schemas provided by UsdShade.

Definition at line 23 of file shaderDefParser.h.

Constructor & Destructor Documentation

USDSHADE_API UsdShadeShaderDefParserPlugin::UsdShadeShaderDefParserPlugin ( )
default
USDSHADE_API UsdShadeShaderDefParserPlugin::~UsdShadeShaderDefParserPlugin ( )
overridedefault

Member Function Documentation

USDSHADE_API const SdrTokenVec& UsdShadeShaderDefParserPlugin::GetDiscoveryTypes ( ) const
overridevirtual

Returns the types of nodes that this plugin can parse.

"Type" here is the discovery type (in the case of files, this will probably be the file extension, but in other systems will be data that can be determined during discovery). This type should only be used to match up a SdrShaderNodeDiscoveryResult to its parser plugin; this value is not exposed in the node's API.

Implements SdrParserPlugin.

USDSHADE_API const TfToken& UsdShadeShaderDefParserPlugin::GetShadingSystem ( ) const
overridevirtual

Returns the shading system that this parser operates in.

Reimplemented from SdrParserPlugin.

USDSHADE_API SdrShaderNodeUniquePtr UsdShadeShaderDefParserPlugin::ParseShaderNode ( const SdrShaderNodeDiscoveryResult &  discoveryResult)
overridevirtual

Takes the specified SdrShaderNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new SdrShaderNode. The node's name, shading system, and function must match.

Implements SdrParserPlugin.

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