#include <shader.h>

Inheritance diagram for UsdShadeShader:

Public Member Functions
	UsdShadeShader (const UsdPrim &prim=UsdPrim())

	UsdShadeShader (const UsdSchemaBase &schemaObj)

virtual USDSHADE_API	~UsdShadeShader ()
	Destructor. More...

Conversion to and from UsdShadeConnectableAPI
USDSHADE_API	UsdShadeShader (const UsdShadeConnectableAPI &connectable)

USDSHADE_API UsdShadeConnectableAPI	ConnectableAPI () const

Outputs API
Outputs represent a typed attribute on a shader or node-graph whose value is computed externally. When they exist on a node-graph, they are connectable and are typically connected to the output of a shader within the node-graph.
USDSHADE_API UsdShadeOutput	CreateOutput (const TfToken &name, const SdfValueTypeName &typeName)

USDSHADE_API UsdShadeOutput	GetOutput (const TfToken &name) const

USDSHADE_API std::vector < UsdShadeOutput >	GetOutputs (bool onlyAuthored=true) const

Inputs API
Inputs are connectable attribute with a typed value. On shaders, the shader parameters are encoded as inputs. On node-graphs, interface attributes are represented as inputs.
USDSHADE_API UsdShadeInput	CreateInput (const TfToken &name, const SdfValueTypeName &typeName)

USDSHADE_API UsdShadeInput	GetInput (const TfToken &name) const

USDSHADE_API std::vector < UsdShadeInput >	GetInputs (bool onlyAuthored=true) const

UsdShadeNodeDefAPI forwarding
USDSHADE_API UsdAttribute	GetImplementationSourceAttr () const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API UsdAttribute	CreateImplementationSourceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API UsdAttribute	GetIdAttr () const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API UsdAttribute	CreateIdAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API TfToken	GetImplementationSource () const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	SetShaderId (const TfToken &id) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	GetShaderId (TfToken *id) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	SetSourceAsset (const SdfAssetPath &sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	GetSourceAsset (SdfAssetPath *sourceAsset, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	SetSourceAssetSubIdentifier (const TfToken &subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	GetSourceAssetSubIdentifier (TfToken *subIdentifier, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	SetSourceCode (const std::string &sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API bool	GetSourceCode (std::string *sourceCode, const TfToken &sourceType=UsdShadeTokens->universalSourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

USDSHADE_API SdrShaderNodeConstPtr	GetShaderNodeForSourceType (const TfToken &sourceType) const
	Forwards to UsdShadeNodeDefAPI(prim). More...

Shader Sdr Metadata API
This section provides API for authoring and querying shader registry metadata. When the shader's implementationSource is sourceAsset or sourceCode, the authored "sdrMetadata" dictionary value provides additional metadata needed to process the shader source correctly. It is used in combination with the sourceAsset or sourceCode value to fetch the appropriate node from the shader registry. We expect the keys in sdrMetadata to correspond to the keys in SdrNodeMetadata. However, this is not strictly enforced in the API. The only allowed value type in the "sdrMetadata" dictionary is a std::string since it needs to be converted into a NdrTokenMap, which Sdr will parse using the utilities available in SdrMetadataHelpers.
USDSHADE_API NdrTokenMap	GetSdrMetadata () const

USDSHADE_API std::string	GetSdrMetadataByKey (const TfToken &key) const

USDSHADE_API void	SetSdrMetadata (const NdrTokenMap &sdrMetadata) const

USDSHADE_API void	SetSdrMetadataByKey (const TfToken &key, const std::string &value) const

USDSHADE_API bool	HasSdrMetadata () const

USDSHADE_API bool	HasSdrMetadataByKey (const TfToken &key) const

USDSHADE_API void	ClearSdrMetadata () const

USDSHADE_API void	ClearSdrMetadataByKey (const TfToken &key) const

Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())

	UsdTyped (const UsdSchemaBase &schemaObj)

virtual USD_API	~UsdTyped ()
	Destructor. More...

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const

bool	IsTyped () const

bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...

bool	IsAppliedAPISchema () const

bool	IsMultipleApplyAPISchema () const

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim. More...

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`. More...

virtual USD_API	~UsdSchemaBase ()
	Destructor. More...

USD_API	operator bool () const

UsdPrim	GetPrim () const
	Return this schema object's held prim. More...

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDSHADE_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static USDSHADE_API UsdShadeShader	Get (const UsdStagePtr &stage, const SdfPath &path)

static USDSHADE_API UsdShadeShader	Define (const UsdStagePtr &stage, const SdfPath &path)

Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped

Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDSHADE_API UsdSchemaKind	_GetSchemaKind () const override

Protected Member Functions inherited from UsdTyped
USD_API bool	_IsCompatible () const override

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Detailed Description

Base class for all USD shaders. Shaders are the building blocks of shading networks. While UsdShadeShader objects are not target specific, each renderer or application target may derive its own renderer-specific shader object types from this base, if needed.

Objects of this class generally represent a single shading object, whether it exists in the target renderer or not. For example, a texture, a fractal, or a mix node.

The UsdShadeNodeDefAPI provides attributes to uniquely identify the type of this node. The id resolution into a renderable shader target type of this node. The id resolution into a renderable shader target is deferred to the consuming application.

The purpose of representing them in Usd is two-fold:

To represent, via "connections" the topology of the shading network that must be reconstructed in the renderer. Facilities for authoring and manipulating connections are encapsulated in the API schema UsdShadeConnectableAPI.
To present a (partial or full) interface of typed input parameters whose values can be set and overridden in Usd, to be provided later at render-time as parameter values to the actual render shader objects. Shader input parameters are encapsulated in the property schema UsdShadeInput.

Definition at line 85 of file shader.h.

Constructor & Destructor Documentation

UsdShadeShader::UsdShadeShader ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

Construct a UsdShadeShader on UsdPrim prim . Equivalent to UsdShadeShader::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 97 of file shader.h.

UsdShadeShader::UsdShadeShader ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdShadeShader on the prim held by schemaObj . Should be preferred over UsdShadeShader(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 105 of file shader.h.

virtual USDSHADE_API UsdShadeShader::~UsdShadeShader ( )

virtual

Destructor.

USDSHADE_API UsdShadeShader::UsdShadeShader ( const UsdShadeConnectableAPI & connectable )

Constructor that takes a ConnectableAPI object. Allow implicit (auto) conversion of UsdShadeConnectableAPI to UsdShadeShader, so that a ConnectableAPI can be passed into any function that accepts a Shader.

Note: that the conversion may produce an invalid Shader object, because not all UsdShadeConnectableAPIs are Shaders

Member Function Documentation

USDSHADE_API UsdSchemaKind UsdShadeShader::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also: UsdSchemaKind

Reimplemented from UsdTyped.

USDSHADE_API void UsdShadeShader::ClearSdrMetadata ( ) const

Clears any "sdrMetadata" value authored on the shader in the current EditTarget.

USDSHADE_API void UsdShadeShader::ClearSdrMetadataByKey ( const TfToken & key ) const

Clears the entry corresponding to the given key in the "sdrMetadata" dictionary authored in the current EditTarget.

USDSHADE_API UsdShadeConnectableAPI UsdShadeShader::ConnectableAPI ( ) const

Contructs and returns a UsdShadeConnectableAPI object with this shader.

Note that most tasks can be accomplished without explicitly constructing a UsdShadeConnectable API, since connection-related API such as UsdShadeConnectableAPI::ConnectToSource() are static methods, and UsdShadeShader will auto-convert to a UsdShadeConnectableAPI when passed to functions that want to act generically on a connectable UsdShadeConnectableAPI object.

USDSHADE_API UsdAttribute UsdShadeShader::CreateIdAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API UsdAttribute UsdShadeShader::CreateImplementationSourceAttr	(	VtValue const &	defaultValue = `VtValue()`,
		bool	writeSparsely = `false`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API UsdShadeInput UsdShadeShader::CreateInput	(	const TfToken &	name,
		const SdfValueTypeName &	typeName
	)

Create an input which can either have a value or can be connected. The attribute representing the input is created in the "inputs:" namespace. Inputs on both shaders and node-graphs are connectable.

USDSHADE_API UsdShadeOutput UsdShadeShader::CreateOutput	(	const TfToken &	name,
		const SdfValueTypeName &	typeName
	)

Create an output which can either have a value or can be connected. The attribute representing the output is created in the "outputs:" namespace. Outputs on a shader cannot be connected, as their value is assumed to be computed externally.

static USDSHADE_API UsdShadeShader UsdShadeShader::Define	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDSHADE_API UsdShadeShader UsdShadeShader::Get	(	const UsdStagePtr &	stage,
		const SdfPath &	path
	)

static

Return a UsdShadeShader holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdShadeShader(stage->GetPrimAtPath(path));

USDSHADE_API UsdAttribute UsdShadeShader::GetIdAttr ( ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API TfToken UsdShadeShader::GetImplementationSource ( ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API UsdAttribute UsdShadeShader::GetImplementationSourceAttr ( ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API UsdShadeInput UsdShadeShader::GetInput ( const TfToken & name ) const

Return the requested input if it exists.

USDSHADE_API std::vector<UsdShadeInput> UsdShadeShader::GetInputs ( bool onlyAuthored = true ) const

Inputs are represented by attributes in the "inputs:" namespace. If onlyAuthored is true (the default), then only return authored attributes; otherwise, this also returns un-authored builtins.

USDSHADE_API UsdShadeOutput UsdShadeShader::GetOutput ( const TfToken & name ) const

Return the requested output if it exists.

USDSHADE_API std::vector<UsdShadeOutput> UsdShadeShader::GetOutputs ( bool onlyAuthored = true ) const

Outputs are represented by attributes in the "outputs:" namespace. If onlyAuthored is true (the default), then only return authored attributes; otherwise, this also returns un-authored builtins.

static USDSHADE_API const TfTokenVector& UsdShadeShader::GetSchemaAttributeNames ( bool includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDSHADE_API NdrTokenMap UsdShadeShader::GetSdrMetadata ( ) const

Returns this shader's composed "sdrMetadata" dictionary as a NdrTokenMap.

USDSHADE_API std::string UsdShadeShader::GetSdrMetadataByKey ( const TfToken & key ) const

Returns the value corresponding to key in the composed sdrMetadata dictionary.

USDSHADE_API bool UsdShadeShader::GetShaderId ( TfToken * id ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API SdrShaderNodeConstPtr UsdShadeShader::GetShaderNodeForSourceType ( const TfToken & sourceType ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::GetSourceAsset	(	SdfAssetPath *	sourceAsset,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::GetSourceAssetSubIdentifier	(	TfToken *	subIdentifier,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::GetSourceCode	(	std::string *	sourceCode,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::HasSdrMetadata ( ) const

Returns true if the shader has a non-empty composed "sdrMetadata" dictionary value.

USDSHADE_API bool UsdShadeShader::HasSdrMetadataByKey ( const TfToken & key ) const

Returns true if there is a value corresponding to the given key in the composed "sdrMetadata" dictionary.

USDSHADE_API void UsdShadeShader::SetSdrMetadata ( const NdrTokenMap & sdrMetadata ) const

Authors the given sdrMetadata on this shader at the current EditTarget.

USDSHADE_API void UsdShadeShader::SetSdrMetadataByKey	(	const TfToken &	key,
		const std::string &	value
	)		const

Sets the value corresponding to key to the given string value, in the shader's "sdrMetadata" dictionary at the current EditTarget.

USDSHADE_API bool UsdShadeShader::SetShaderId ( const TfToken & id ) const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::SetSourceAsset	(	const SdfAssetPath &	sourceAsset,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::SetSourceAssetSubIdentifier	(	const TfToken &	subIdentifier,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const

Forwards to UsdShadeNodeDefAPI(prim).

USDSHADE_API bool UsdShadeShader::SetSourceCode	(	const std::string &	sourceCode,
		const TfToken &	sourceType = `UsdShadeTokens->universalSourceType`
	)		const