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

#include <shaderDefParser.h>

+ Inheritance diagram for UsdShadeShaderDefParserPlugin:

Public Member Functions

USDSHADE_API UsdShadeShaderDefParserPlugin ()=default
USDSHADE_API ~UsdShadeShaderDefParserPlugin () override=default
USDSHADE_API NdrNodeUniquePtr Parse (const NdrNodeDiscoveryResult &discoveryResult) override
USDSHADE_API const NdrTokenVecGetDiscoveryTypes () const override
USDSHADE_API const TfTokenGetSourceType () const override
- Public Member Functions inherited from NdrParserPlugin
NDR_API NdrParserPlugin ()
virtual NDR_API ~NdrParserPlugin ()
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 TfWeakBase (const TfWeakBase &)
const TfWeakBase__GetTfWeakBase__ () const
const TfWeakBaseoperator= (const TfWeakBase &)
void EnableNotification2 () const
TF_API void constGetUniqueIdentifier () const

Additional Inherited Members

- Static Public Member Functions inherited from NdrParserPlugin
static NDR_API NdrNodeUniquePtr GetInvalidNode (const NdrNodeDiscoveryResult &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 42 of file shaderDefParser.h.

Constructor & Destructor Documentation

USDSHADE_API UsdShadeShaderDefParserPlugin::UsdShadeShaderDefParserPlugin ( )
USDSHADE_API UsdShadeShaderDefParserPlugin::~UsdShadeShaderDefParserPlugin ( )

Member Function Documentation

USDSHADE_API const NdrTokenVec& UsdShadeShaderDefParserPlugin::GetDiscoveryTypes ( ) const

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 NdrNodeDiscoveryResult to its parser plugin; this value is not exposed in the node's API.

Implements NdrParserPlugin.

USDSHADE_API const TfToken& UsdShadeShaderDefParserPlugin::GetSourceType ( ) const

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 NdrParserPlugin.

USDSHADE_API NdrNodeUniquePtr UsdShadeShaderDefParserPlugin::Parse ( const NdrNodeDiscoveryResult discoveryResult)

Takes the specified NdrNodeDiscoveryResult instance, which was a result of the discovery process, and generates a new NdrNode. The node's name, source type, and family must match.

Implements NdrParserPlugin.

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