 |
|
|
|
UsdShadeTokens provides static, efficient TfTokens for use in all public USD API. More...
#include <tokens.h>
Public Attributes | |
| const TfToken | allPurpose |
| "" | |
| const TfToken | bindMaterialAs |
| "bindMaterialAs" | |
| const TfToken | coordSys |
| "coordSys" | |
| const TfToken | coordSys_MultipleApplyTemplate_Binding |
| "coordSys:__INSTANCE_NAME__:binding" | |
| const TfToken | displacement |
| "displacement" | |
| const TfToken | fallbackStrength |
| "fallbackStrength" | |
| const TfToken | full |
| "full" | |
| const TfToken | id |
| "id" | |
| const TfToken | infoId |
| "info:id" | |
| const TfToken | infoImplementationSource |
| "info:implementationSource" | |
| const TfToken | inputs |
| "inputs:" | |
| const TfToken | interfaceOnly |
| "interfaceOnly" | |
| const TfToken | materialBind |
| "materialBind" | |
| const TfToken | materialBinding |
| "material:binding" | |
| const TfToken | materialBindingCollection |
| "material:binding:collection" | |
| const TfToken | materialVariant |
| "materialVariant" | |
| const TfToken | outputs |
| "outputs:" | |
| const TfToken | outputsDisplacement |
| "outputs:displacement" | |
| const TfToken | outputsSurface |
| "outputs:surface" | |
| const TfToken | outputsVolume |
| "outputs:volume" | |
| const TfToken | preview |
| "preview" | |
| const TfToken | sdrMetadata |
| "sdrMetadata" | |
| const TfToken | sourceAsset |
| "sourceAsset" | |
| const TfToken | sourceCode |
| "sourceCode" | |
| const TfToken | strongerThanDescendants |
| "strongerThanDescendants" | |
| const TfToken | subIdentifier |
| "subIdentifier" | |
| const TfToken | surface |
| "surface" | |
| const TfToken | universalRenderContext |
| "" | |
| const TfToken | universalSourceType |
| "" | |
| const TfToken | volume |
| "volume" | |
| const TfToken | weakerThanDescendants |
| "weakerThanDescendants" | |
| const TfToken | ConnectableAPI |
| "ConnectableAPI" | |
| const TfToken | CoordSysAPI |
| "CoordSysAPI" | |
| const TfToken | Material |
| "Material" | |
| const TfToken | MaterialBindingAPI |
| "MaterialBindingAPI" | |
| const TfToken | NodeDefAPI |
| "NodeDefAPI" | |
| const TfToken | NodeGraph |
| "NodeGraph" | |
| const TfToken | Shader |
| "Shader" | |
| const std::vector< TfToken > | allTokens |
| A vector of all of the tokens listed above. | |
UsdShadeTokens provides static, efficient TfTokens for use in all public USD API.
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:
| 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 std::vector<TfToken> allTokens |
| const TfToken bindMaterialAs |
| const TfToken ConnectableAPI |
"ConnectableAPI"
Schema identifer and family for UsdShadeConnectableAPI
| const TfToken coordSys |
"coordSys"
Property namespace prefix for the UsdShadeCoordSysAPI schema.
| const TfToken coordSys_MultipleApplyTemplate_Binding |
| const TfToken CoordSysAPI |
"CoordSysAPI"
Schema identifer and family for UsdShadeCoordSysAPI
| 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 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. , 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.
| const TfToken id |
"id"
Fallback value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()
| const TfToken infoId |
| const TfToken infoImplementationSource |
| const TfToken inputs |
| 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 Material |
"Material"
Schema identifer and family for UsdShadeMaterial
| const TfToken materialBind |
| const TfToken materialBinding |
"material:binding"
The relationship name on non-shading prims to denote a binding to a UsdShadeMaterial.
| const TfToken MaterialBindingAPI |
"MaterialBindingAPI"
Schema identifer and family for UsdShadeMaterialBindingAPI
| 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 NodeDefAPI |
"NodeDefAPI"
Schema identifer and family for UsdShadeNodeDefAPI
| const TfToken NodeGraph |
"NodeGraph"
Schema identifer and family for UsdShadeNodeGraph
| const TfToken outputs |
| const TfToken outputsDisplacement |
| const TfToken outputsSurface |
| const TfToken outputsVolume |
| 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 Shader |
| const TfToken sourceAsset |
"sourceAsset"
Possible value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()
| const TfToken sourceCode |
"sourceCode"
Possible value for UsdShadeNodeDefAPI::GetImplementationSourceAttr()
| const TfToken strongerThanDescendants |
| const TfToken subIdentifier |
| 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 |
1.9.6