usdrt::UsdShadeTokensType

Defined in usdrt/scenegraph/usd/usdShade/tokens.h

Functions

Variables

class UsdShadeTokensType

Provides standard set of public tokens for UsdShade schema. Access via the RtTokens helper accessor.

These tokens are auto-generated from the module’s schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

UsdShadeTokens also contains all of the allowedTokens values declared for schema builtin attributes of ‘token’ scene description type. Use UsdShadeTokens like so:

prim.GetAttribute(RtTokens->worldPosition);

Public Functions

inline UsdShadeTokensType()

Public Members

const TfToken allPurpose

“”

Possible value for the ‘materialPurpose’ parameter in the various methods available in UsdShadeMaterialBindingAPI. Its value is empty and its purpose is to represent a general purpose material- binding that applies in the absence of a specific-purpose binding.

const TfToken bindMaterialAs

“bindMaterialAs”

Token valued metadata key authored on a material binding relationship to indicate the strength of the binding relative to bindings authored on descendants.

const TfToken coordSys

“coordSys:”

Namespace prefix for relationships that bind coordinate systems.

const TfToken displacement

“displacement”

Describes the displacement output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the displacement of a UsdShadeMaterial.

const TfToken fallbackStrength

“fallbackStrength”

Sentinal value to be used for ‘bindMaterialAs’ metadata’s default value. Clients should pass this in for the ‘bindingStrength’ argument to UsdShadeMaterialBindingAPI::Bind(), if they want to author the default value (weakerThanDescendants) sparsely. The value “fallbackStrength” never gets authored into scene description.

const TfToken full

“full”

Possible value for ‘connectability’ metadata on a UsdShadeInput. When connectability of an input is set to “full”, it implies that it can be connected to any input or output. , Possible value for the ‘materialPurpose’ parameter in UsdShadeMaterialBindingAPI, to be used when the purpose of the render is entirely about visualizing the truest representation of a scene, considering all lighting and material information, at highest fidelity.

const TfToken id

“id”

Possible value for UsdShadeNodeDefAPI::GetInfoImplementationSourceAttr(), Default value for UsdShadeNodeDefAPI::GetInfoImplementationSourceAttr()

const TfToken infoId

“info:id”

UsdShadeNodeDefAPI

const TfToken infoImplementationSource

“info:implementationSource”

UsdShadeNodeDefAPI

const TfToken inputs

“inputs:”

The prefix on shading attributes denoting an input.

const TfToken interfaceOnly

“interfaceOnly”

Possible value for ‘connectability’ metadata on a UsdShadeInput. It implies that the input can only connect to a NodeGraph Input (which represents an interface override, not a render-time dataflow connection), or another Input whose connectability is also ‘interfaceOnly’.

const TfToken materialBind

“materialBind”

The name of the GeomSubset family used to identify face subsets defined for the purpose of binding materials to facesets.

const TfToken materialBinding

“material:binding”

The relationship name on non-shading prims to denote a binding to a UsdShadeMaterial.

const TfToken materialBindingCollection

“material:binding:collection”

The relationship name on non-shading prims to denote a collection-based binding to a UsdShadeMaterial.

const TfToken materialVariant

“materialVariant”

The variant name of material variation described on a UsdShadeMaterial.

const TfToken outputs

“outputs:”

The prefix on shading attributes denoting an output.

const TfToken outputsDisplacement

“outputs:displacement”

UsdShadeMaterial

const TfToken outputsSurface

“outputs:surface”

UsdShadeMaterial

const TfToken outputsVolume

“outputs:volume”

UsdShadeMaterial

const TfToken preview

“preview”

Possible value for the ‘materialPurpose’ parameter in UsdShadeMaterialBindingAPI, to be used when the render is in service of a goal other than a high fidelity “full” render (such as scene manipulation, modeling, or realtime playback). Latency and speed are generally of greater concern for preview renders, therefore preview materials are generally designed to be “lighterweight” compared to full materials.

const TfToken sdrMetadata

“sdrMetadata”

Dictionary valued metadata key authored on Shader prims with implementationSource value of sourceAsset or sourceCode to pass along metadata to the shader parser or compiler. It is also used to author metadata on shader properties in a UsdShade-based shader definition file.

const TfToken sourceAsset

“sourceAsset”

Possible value for UsdShadeNodeDefAPI::GetInfoImplementationSourceAttr()

const TfToken sourceCode

“sourceCode”

Possible value for UsdShadeNodeDefAPI::GetInfoImplementationSourceAttr()

const TfToken strongerThanDescendants

“strongerThanDescendants”

Possible value for ‘bindMaterialAs’ metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is stronger than any bindings authored on the descendants.

const TfToken subIdentifier

“subIdentifier”

This identifier is used in conjunction with a specific source asset to indicate a particular definition within the source asset, if the source asset specifies more than one shader node definition.

const TfToken surface

“surface”

Describes the surface output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the surface of a UsdShadeMaterial.

const TfToken universalRenderContext

“”

Possible value for the “renderContext” parameter in UsdShadeMaterial_Outputs API. Represents the universal renderContext. An output with a universal renderContext is applicable to all possible rendering contexts.

const TfToken universalSourceType

“”

Possible value for the “sourceType” parameter in UsdShadeNodeDefAPI_ImplementationSource API. Represents the universal or fallback source type.

const TfToken volume

“volume”

Describes the volume output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the volume of a UsdShadeMaterial.

const TfToken weakerThanDescendants

“weakerThanDescendants”

Possible value for ‘bindMaterialAs’ metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is weaker than any bindings authored on the descendants.

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.