UsdShadeShaderDefParserPlugin Class Reference

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

#include <shaderDefParser.h>

Inheritance diagram for UsdShadeShaderDefParserPlugin:

Public Member Functions
USDSHADE_API SdrShaderNodeUniquePtr	ParseShaderNode (const SdrShaderNodeDiscoveryResult &discoveryResult) override
	Takes the specified SdrShaderNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new SdrShaderNode.
USDSHADE_API const SdrTokenVec &	GetDiscoveryTypes () const override
	Returns the types of nodes that this plugin can parse.
USDSHADE_API const TfToken &	GetSourceType () const override
	Returns the source type that this parser operates on.
virtual SDR_API SdrShaderNodeUniquePtr	ParseShaderNode (const SdrShaderNodeDiscoveryResult &discoveryResult)=0
	Takes the specified SdrShaderNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new SdrShaderNode.
virtual SDR_API const SdrTokenVec &	GetDiscoveryTypes () const =0
	Returns the types of nodes that this plugin can parse.
virtual SDR_API const TfToken &	GetSourceType () const =0
	Returns the source type that this parser operates on.
Public Member Functions inherited from 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)
	Gets an invalid node based on the discovery result provided.
Protected Member Functions inherited from 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.

Member Function Documentation

GetDiscoveryTypes()

USDSHADE_API const SdrTokenVec & 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.

GetSourceType()

USDSHADE_API const TfToken & GetSourceType ( ) const

overridevirtual

Returns the source type that this parser operates on.

A source type is the most general type for a node. The parser plugin is responsible for parsing all discovery results that have the types declared under GetDiscoveryTypes(), and those types are collectively identified as one "source type".

Implements SdrParserPlugin.

ParseShaderNode()

USDSHADE_API SdrShaderNodeUniquePtr 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, source type, and family must match.

Implements SdrParserPlugin.

---

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

• pxr/usd/usdShade/shaderDefParser.h