UsdShade module#

Summary: The UsdShade module provides schemas and behaviors for creating and binding materials, which encapsulate shading networks.

Classes:

`AttributeType`
`ConnectableAPI`
`ConnectionModification`
`ConnectionSourceInfo`
`CoordSysAPI`
`Input`
`Material`
`MaterialBindingAPI`
`NodeDefAPI`
`NodeGraph`
`Output`
`Shader`
`ShaderDefParserPlugin`
`ShaderDefUtils`
`Tokens`
`UdimUtils`
`Utils`

class pxr.UsdShade.AttributeType#

Attributes:

`Input`
`Invalid`
`Output`
`names`
`values`

Input = pxr.UsdShade.AttributeType.Input#

Invalid = pxr.UsdShade.AttributeType.Invalid#

Output = pxr.UsdShade.AttributeType.Output#

names = {'Input': pxr.UsdShade.AttributeType.Input, 'Invalid': pxr.UsdShade.AttributeType.Invalid, 'Output': pxr.UsdShade.AttributeType.Output}#

values = {0: pxr.UsdShade.AttributeType.Invalid, 1: pxr.UsdShade.AttributeType.Input, 2: pxr.UsdShade.AttributeType.Output}#

class pxr.UsdShade.ConnectableAPI#

Methods:

static CanConnect()#

static ClearSource()#

static ClearSources()#

static ConnectToSource()#

CreateInput()#

CreateOutput()#

static DisconnectSource()#

static Get()#

static GetConnectedSource()#

static GetConnectedSources()#

GetInput()#

GetInputs()#

GetOutput()#

GetOutputs()#

static GetRawConnectedSourcePaths()#

static GetSchemaAttributeNames()#

static HasConnectableAPI()#

static HasConnectedSource()#

IsContainer()#

static IsSourceConnectionFromBaseMaterial()#

RequiresEncapsulation()#

static SetConnectedSources()#

class pxr.UsdShade.ConnectionModification#

Attributes:

`Append`
`Prepend`
`Replace`
`names`
`values`

Append = pxr.UsdShade.ConnectionModification.Append#

Prepend = pxr.UsdShade.ConnectionModification.Prepend#

Replace = pxr.UsdShade.ConnectionModification.Replace#

names = {'Append': pxr.UsdShade.ConnectionModification.Append, 'Prepend': pxr.UsdShade.ConnectionModification.Prepend, 'Replace': pxr.UsdShade.ConnectionModification.Replace}#

values = {0: pxr.UsdShade.ConnectionModification.Replace, 1: pxr.UsdShade.ConnectionModification.Prepend, 2: pxr.UsdShade.ConnectionModification.Append}#

class pxr.UsdShade.ConnectionSourceInfo#

Methods:

IsValid

Attributes:

`source`
`sourceName`
`sourceType`
`typeName`

IsValid()#

property source#

property sourceName#

property sourceType#

property typeName#

class pxr.UsdShade.CoordSysAPI#

Methods:

static Apply()#

ApplyAndBind()#

Bind()#

BlockBinding()#

static CanApply()#

static CanContainPropertyName()#

ClearBinding()#

CreateBindingRel()#

FindBindingWithInheritance()#

FindBindingsWithInheritance()#

static FindBindingsWithInheritanceForPrim()#

static Get()#

static GetAll()#

GetBindingRel()#

static GetCoordSysRelationshipName()#

GetLocalBinding()#

GetLocalBindings()#

static GetLocalBindingsForPrim()#

static GetSchemaAttributeNames()#

HasLocalBindings()#

static HasLocalBindingsForPrim()#

static IsCoordSysAPIPath()#

class pxr.UsdShade.Input#

Methods:

CanConnect()#

ClearConnectability()#

ClearSdrMetadata()#

ClearSdrMetadataByKey()#

ClearSource()#

ClearSources()#

ConnectToSource()#

DisconnectSource()#

Get()#

GetAttr()#

GetBaseName()#

GetConnectability()#

GetConnectedSource()#

GetConnectedSources()#

GetDisplayGroup()#

GetDocumentation()#

GetFullName()#

GetPrim()#

GetRawConnectedSourcePaths()#

GetRenderType()#

GetSdrMetadata()#

GetSdrMetadataByKey()#

GetTypeName()#

GetValueProducingAttribute()#

GetValueProducingAttributes()#

HasConnectedSource()#

HasRenderType()#

HasSdrMetadata()#

HasSdrMetadataByKey()#

static IsInput()#

static IsInterfaceInputName()#

IsSourceConnectionFromBaseMaterial()#

Set()#

SetConnectability()#

SetConnectedSources()#

SetDisplayGroup()#

SetDocumentation()#

SetRenderType()#

SetSdrMetadata()#

SetSdrMetadataByKey()#

class pxr.UsdShade.Material#

Methods:

ClearBaseMaterial()#

ComputeDisplacementSource()#

ComputeSurfaceSource()#

ComputeVolumeSource()#

CreateDisplacementAttr()#

CreateDisplacementOutput()#

static CreateMasterMaterialVariant()#

CreateSurfaceAttr()#

CreateSurfaceOutput()#

CreateVolumeAttr()#

CreateVolumeOutput()#

static Define()#

static Get()#

GetBaseMaterial()#

GetBaseMaterialPath()#

GetDisplacementAttr()#

GetDisplacementOutput()#

GetDisplacementOutputs()#

GetEditContextForVariant()#

GetMaterialVariant()#

static GetSchemaAttributeNames()#

GetSurfaceAttr()#

GetSurfaceOutput()#

GetSurfaceOutputs()#

GetVolumeAttr()#

GetVolumeOutput()#

GetVolumeOutputs()#

HasBaseMaterial()#

SetBaseMaterial()#

SetBaseMaterialPath()#

class pxr.UsdShade.MaterialBindingAPI#

Classes:

`CollectionBinding`
`DirectBinding`

Methods:

class CollectionBinding#

Methods:

`GetBindingRel`
`GetCollection`
`GetCollectionPath`
`GetMaterial`
`GetMaterialPath`
`IsCollectionBindingRel`
`IsValid`

GetBindingRel()#

GetCollection()#

GetCollectionPath()#

GetMaterial()#

GetMaterialPath()#

static IsCollectionBindingRel()#

IsValid()#

class DirectBinding#

Methods:

`GetBindingRel`
`GetMaterial`
`GetMaterialPath`
`GetMaterialPurpose`

GetBindingRel()#

GetMaterial()#

GetMaterialPath()#

GetMaterialPurpose()#

AddPrimToBindingCollection()#

static Apply()#

Bind()#

static CanApply()#

static CanContainPropertyName()#

ComputeBoundMaterial()#

static ComputeBoundMaterials()#

CreateMaterialBindSubset()#

static Get()#

GetCollectionBindingRel()#

GetCollectionBindingRels()#

GetCollectionBindings()#

GetDirectBinding()#

GetDirectBindingRel()#

GetMaterialBindSubsets()#

GetMaterialBindSubsetsFamilyType()#

static GetMaterialBindingStrength()#

static GetMaterialPurposes()#

static GetResolvedTargetPathFromBindingRel()#

static GetSchemaAttributeNames()#

RemovePrimFromBindingCollection()#

SetMaterialBindSubsetsFamilyType()#

static SetMaterialBindingStrength()#

UnbindAllBindings()#

UnbindCollectionBinding()#

UnbindDirectBinding()#

class pxr.UsdShade.NodeDefAPI#

Methods:

`Apply`
`CanApply`
`CreateIdAttr`
`CreateImplementationSourceAttr`
`Get`
`GetIdAttr`
`GetImplementationSource`
`GetImplementationSourceAttr`
`GetSchemaAttributeNames`
`GetShaderId`
`GetShaderNodeForSourceType`
`GetSourceAsset`
`GetSourceAssetSubIdentifier`
`GetSourceCode`
`GetSourceTypes`
`SetShaderId`
`SetSourceAsset`
`SetSourceAssetSubIdentifier`
`SetSourceCode`

static Apply()#

static CanApply()#

CreateIdAttr()#

CreateImplementationSourceAttr()#

static Get()#

GetIdAttr()#

GetImplementationSource()#

GetImplementationSourceAttr()#

static GetSchemaAttributeNames()#

GetShaderId()#

GetShaderNodeForSourceType()#

GetSourceAsset()#

GetSourceAssetSubIdentifier()#

GetSourceCode()#

GetSourceTypes()#

SetShaderId()#

SetSourceAsset()#

SetSourceAssetSubIdentifier()#

SetSourceCode()#

class pxr.UsdShade.NodeGraph#

Methods:

`ComputeInterfaceInputConsumersMap`
`ComputeOutputSource`
`ConnectableAPI`
`CreateInput`
`CreateOutput`
`Define`
`Get`
`GetInput`
`GetInputs`
`GetInterfaceInputs`
`GetOutput`
`GetOutputs`
`GetSchemaAttributeNames`

ComputeInterfaceInputConsumersMap()#

ComputeOutputSource()#

ConnectableAPI()#

CreateInput()#

CreateOutput()#

static Define()#

static Get()#

GetInput()#

GetInputs()#

GetInterfaceInputs()#

GetOutput()#

GetOutputs()#

static GetSchemaAttributeNames()#

class pxr.UsdShade.Output#

Methods:

CanConnect()#

ClearSdrMetadata()#

ClearSdrMetadataByKey()#

ClearSource()#

ClearSources()#

ConnectToSource()#

DisconnectSource()#

GetAttr()#

GetBaseName()#

GetConnectedSource()#

GetConnectedSources()#

GetFullName()#

GetPrim()#

GetRawConnectedSourcePaths()#

GetRenderType()#

GetSdrMetadata()#

GetSdrMetadataByKey()#

GetTypeName()#

GetValueProducingAttributes()#

HasConnectedSource()#

HasRenderType()#

HasSdrMetadata()#

HasSdrMetadataByKey()#

static IsOutput()#

IsSourceConnectionFromBaseMaterial()#

Set()#

SetConnectedSources()#

SetRenderType()#

SetSdrMetadata()#

SetSdrMetadataByKey()#

class pxr.UsdShade.Shader#

Methods:

ClearSdrMetadata()#

ClearSdrMetadataByKey()#

ConnectableAPI()#

CreateIdAttr()#

CreateImplementationSourceAttr()#

CreateInput()#

CreateOutput()#

static Define()#

static Get()#

GetIdAttr()#

GetImplementationSource()#

GetImplementationSourceAttr()#

GetInput()#

GetInputs()#

GetOutput()#

GetOutputs()#

static GetSchemaAttributeNames()#

GetSdrMetadata()#

GetSdrMetadataByKey()#

GetShaderId()#

GetShaderNodeForSourceType()#

GetSourceAsset()#

GetSourceAssetSubIdentifier()#

GetSourceCode()#

GetSourceTypes()#

HasSdrMetadata()#

HasSdrMetadataByKey()#

SetSdrMetadata()#

SetSdrMetadataByKey()#

SetShaderId()#

SetSourceAsset()#

SetSourceAssetSubIdentifier()#

SetSourceCode()#

class pxr.UsdShade.ShaderDefParserPlugin#

Methods:

`GetDiscoveryTypes`
`GetSourceType`
`Parse`

GetDiscoveryTypes()#

GetSourceType()#

Parse()#

class pxr.UsdShade.ShaderDefUtils#

Methods:

`GetNodeDiscoveryResults`
`GetPrimvarNamesMetadataString`
`GetShaderProperties`

static GetNodeDiscoveryResults()#

static GetPrimvarNamesMetadataString()#

static GetShaderProperties()#

class pxr.UsdShade.Tokens#

Attributes:

ConnectableAPI = 'ConnectableAPI'#

CoordSysAPI = 'CoordSysAPI'#

Material = 'Material'#

MaterialBindingAPI = 'MaterialBindingAPI'#

NodeDefAPI = 'NodeDefAPI'#

NodeGraph = 'NodeGraph'#

Shader = 'Shader'#

allPurpose = ''#

bindMaterialAs = 'bindMaterialAs'#

coordSys = 'coordSys'#

coordSys_MultipleApplyTemplate_Binding = 'coordSys:__INSTANCE_NAME__:binding'#

displacement = 'displacement'#

fallbackStrength = 'fallbackStrength'#

full = 'full'#

id = 'id'#

infoId = 'info:id'#

infoImplementationSource = 'info:implementationSource'#

inputs = 'inputs:'#

interfaceOnly = 'interfaceOnly'#

materialBind = 'materialBind'#

materialBinding = 'material:binding'#

materialBindingCollection = 'material:binding:collection'#

materialVariant = 'materialVariant'#

outputs = 'outputs:'#

outputsDisplacement = 'outputs:displacement'#

outputsSurface = 'outputs:surface'#

outputsVolume = 'outputs:volume'#

preview = 'preview'#

sdrMetadata = 'sdrMetadata'#

sourceAsset = 'sourceAsset'#

sourceCode = 'sourceCode'#

strongerThanDescendants = 'strongerThanDescendants'#

subIdentifier = 'subIdentifier'#

surface = 'surface'#

universalRenderContext = ''#

universalSourceType = ''#

volume = 'volume'#

weakerThanDescendants = 'weakerThanDescendants'#

class pxr.UsdShade.UdimUtils#

Methods:

`IsUdimIdentifier`
`ReplaceUdimPattern`
`ResolveUdimPath`
`ResolveUdimTilePaths`

static IsUdimIdentifier()#

static ReplaceUdimPattern()#

static ResolveUdimPath()#

static ResolveUdimTilePaths()#

class pxr.UsdShade.Utils#

Methods:

`GetBaseNameAndType`
`GetConnectedSourcePath`
`GetFullName`
`GetPrefixForAttributeType`
`GetType`
`GetValueProducingAttributes`

static GetBaseNameAndType()#

static GetConnectedSourcePath()#

static GetFullName()#

static GetPrefixForAttributeType()#

static GetType()#

static GetValueProducingAttributes()#

`CanConnect`
`ClearSource`
`ClearSources`
`ConnectToSource`
`CreateInput`
`CreateOutput`
`DisconnectSource`
`Get`
`GetConnectedSource`
`GetConnectedSources`
`GetInput`
`GetInputs`
`GetOutput`
`GetOutputs`
`GetRawConnectedSourcePaths`
`GetSchemaAttributeNames`
`HasConnectableAPI`
`HasConnectedSource`
`IsContainer`
`IsSourceConnectionFromBaseMaterial`
`RequiresEncapsulation`
`SetConnectedSources`

`Apply`
`ApplyAndBind`
`Bind`
`BlockBinding`
`CanApply`
`CanContainPropertyName`
`ClearBinding`
`CreateBindingRel`
`FindBindingWithInheritance`
`FindBindingsWithInheritance`
`FindBindingsWithInheritanceForPrim`
`Get`
`GetAll`
`GetBindingRel`
`GetCoordSysRelationshipName`
`GetLocalBinding`
`GetLocalBindings`
`GetLocalBindingsForPrim`
`GetSchemaAttributeNames`
`HasLocalBindings`
`HasLocalBindingsForPrim`
`IsCoordSysAPIPath`

`CanConnect`
`ClearConnectability`
`ClearSdrMetadata`
`ClearSdrMetadataByKey`
`ClearSource`
`ClearSources`
`ConnectToSource`
`DisconnectSource`
`Get`
`GetAttr`
`GetBaseName`
`GetConnectability`
`GetConnectedSource`
`GetConnectedSources`
`GetDisplayGroup`
`GetDocumentation`
`GetFullName`
`GetPrim`
`GetRawConnectedSourcePaths`
`GetRenderType`
`GetSdrMetadata`
`GetSdrMetadataByKey`
`GetTypeName`
`GetValueProducingAttribute`
`GetValueProducingAttributes`
`HasConnectedSource`
`HasRenderType`
`HasSdrMetadata`
`HasSdrMetadataByKey`
`IsInput`
`IsInterfaceInputName`
`IsSourceConnectionFromBaseMaterial`
`Set`
`SetConnectability`
`SetConnectedSources`
`SetDisplayGroup`
`SetDocumentation`
`SetRenderType`
`SetSdrMetadata`
`SetSdrMetadataByKey`

`ClearBaseMaterial`
`ComputeDisplacementSource`
`ComputeSurfaceSource`
`ComputeVolumeSource`
`CreateDisplacementAttr`
`CreateDisplacementOutput`
`CreateMasterMaterialVariant`
`CreateSurfaceAttr`
`CreateSurfaceOutput`
`CreateVolumeAttr`
`CreateVolumeOutput`
`Define`
`Get`
`GetBaseMaterial`
`GetBaseMaterialPath`
`GetDisplacementAttr`
`GetDisplacementOutput`
`GetDisplacementOutputs`
`GetEditContextForVariant`
`GetMaterialVariant`
`GetSchemaAttributeNames`
`GetSurfaceAttr`
`GetSurfaceOutput`
`GetSurfaceOutputs`
`GetVolumeAttr`
`GetVolumeOutput`
`GetVolumeOutputs`
`HasBaseMaterial`
`SetBaseMaterial`
`SetBaseMaterialPath`

`AddPrimToBindingCollection`
`Apply`
`Bind`
`CanApply`
`CanContainPropertyName`
`ComputeBoundMaterial`
`ComputeBoundMaterials`
`CreateMaterialBindSubset`
`Get`
`GetCollectionBindingRel`
`GetCollectionBindingRels`
`GetCollectionBindings`
`GetDirectBinding`
`GetDirectBindingRel`
`GetMaterialBindSubsets`
`GetMaterialBindSubsetsFamilyType`
`GetMaterialBindingStrength`
`GetMaterialPurposes`
`GetResolvedTargetPathFromBindingRel`
`GetSchemaAttributeNames`
`RemovePrimFromBindingCollection`
`SetMaterialBindSubsetsFamilyType`
`SetMaterialBindingStrength`
`UnbindAllBindings`
`UnbindCollectionBinding`
`UnbindDirectBinding`