Sdr module#

Summary: The Sdr (Shader Definition Registry) is a specialized version of Ndr for Shaders.

Python bindings for libSdr

Classes:

`DiscoveryPlugin`
`DiscoveryPluginContext`
`DiscoveryUri`
`MetadataHelpers`
`NodeContext`
`NodeDiscoveryResult`
`NodeMetadata`
`NodeRole`
`PropertyMetadata`
`PropertyRole`
`PropertyTypes`
`Registry`
`SdfTypeIndicator`
`ShaderNode`
`ShaderNodeList`
`ShaderProperty`
`Version`
`VersionFilter`

class pxr.Sdr.DiscoveryPlugin#

Methods:

`DiscoverShaderNodes`
`GetSearchURIs`

Attributes:

expired

True if this object has expired, False otherwise.

DiscoverShaderNodes()#

GetSearchURIs()#

property expired#: True if this object has expired, False otherwise.

class pxr.Sdr.DiscoveryPluginContext#

Methods:

GetSourceType

Attributes:

expired

True if this object has expired, False otherwise.

GetSourceType()#

property expired#: True if this object has expired, False otherwise.

class pxr.Sdr.DiscoveryUri#

Attributes:

`resolvedUri`
`uri`

property resolvedUri#

property uri#

class pxr.Sdr.MetadataHelpers#

Methods:

ParseSdfValue

ParseSdfValue()#

class pxr.Sdr.NodeContext#

Attributes:

`Displacement`
`DisplayFilter`
`Light`
`LightFilter`
`Pattern`
`PixelFilter`
`SampleFilter`
`Surface`
`Volume`

Displacement = 'displacement'#

DisplayFilter = 'displayFilter'#

Light = 'light'#

LightFilter = 'lightFilter'#

Pattern = 'pattern'#

PixelFilter = 'pixelFilter'#

SampleFilter = 'sampleFilter'#

Surface = 'surface'#

Volume = 'volume'#

class pxr.Sdr.NodeDiscoveryResult#

Attributes:

`blindData`
`discoveryType`
`family`
`identifier`
`metadata`
`name`
`resolvedUri`
`sourceCode`
`sourceType`
`subIdentifier`
`uri`
`version`

property blindData#

property discoveryType#

property family#

property identifier#

property metadata#

property name#

property resolvedUri#

property sourceCode#

property sourceType#

property subIdentifier#

property uri#

property version#

class pxr.Sdr.NodeMetadata#

Attributes:

`Category`
`Departments`
`Help`
`ImplementationName`
`Label`
`OpenPages`
`Pages`
`Primvars`
`Role`
`SdrDefinitionNameFallbackPrefix`
`SdrUsdEncodingVersion`
`Target`

Category = 'category'#

Departments = 'departments'#

Help = 'help'#

ImplementationName = '__SDR__implementationName'#

Label = 'label'#

OpenPages = 'openPages'#

Pages = 'pages'#

Primvars = 'primvars'#

Role = 'role'#

SdrDefinitionNameFallbackPrefix = 'sdrDefinitionNameFallbackPrefix'#

SdrUsdEncodingVersion = 'sdrUsdEncodingVersion'#

Target = '__SDR__target'#

class pxr.Sdr.NodeRole#

Attributes:

`Field`
`Math`
`Primvar`
`Texture`

Field = 'field'#

Math = 'math'#

Primvar = 'primvar'#

Texture = 'texture'#

class pxr.Sdr.PropertyMetadata#

Attributes:

Colorspace = '__SDR__colorspace'#

Connectable = 'connectable'#

DefaultInput = '__SDR__defaultinput'#

Help = 'help'#

Hints = 'hints'#

ImplementationName = '__SDR__implementationName'#

IsAssetIdentifier = '__SDR__isAssetIdentifier'#

IsDynamicArray = 'isDynamicArray'#

Label = 'label'#

Options = 'options'#

Page = 'page'#

RenderType = 'renderType'#

Role = 'role'#

SdrUsdDefinitionType = 'sdrUsdDefinitionType'#

ShownIf = 'shownIf'#

Tag = 'tag'#

Target = '__SDR__target'#

TupleSize = 'tupleSize'#

ValidConnectionTypes = 'validConnectionTypes'#

VstructConditionalExpr = 'vstructConditionalExpr'#

VstructMemberName = 'vstructMemberName'#

VstructMemberOf = 'vstructMemberOf'#

Widget = 'widget'#

class pxr.Sdr.PropertyRole#

Attributes:

None

None = 'none'#

class pxr.Sdr.PropertyTypes#

Attributes:

`Color`
`Color4`
`Float`
`Int`
`Matrix`
`Normal`
`Point`
`String`
`Struct`
`Terminal`
`Unknown`
`Vector`
`Vstruct`

Color = 'color'#

Color4 = 'color4'#

Float = 'float'#

Int = 'int'#

Matrix = 'matrix'#

Normal = 'normal'#

Point = 'point'#

String = 'string'#

Struct = 'struct'#

Terminal = 'terminal'#

Unknown = 'unknown'#

Vector = 'vector'#

Vstruct = 'vstruct'#

class pxr.Sdr.Registry#

Methods:

`AddDiscoveryResult`
`GetAllShaderNodeSourceTypes`
`GetSearchURIs`
`GetShaderNodeByIdentifier`
`GetShaderNodeByIdentifierAndType`
`GetShaderNodeByName`
`GetShaderNodeByNameAndType`
`GetShaderNodeFromAsset`
`GetShaderNodeFromSourceCode`
`GetShaderNodeIdentifiers`
`GetShaderNodeNames`
`GetShaderNodesByFamily`
`GetShaderNodesByIdentifier`
`GetShaderNodesByName`
`SetExtraDiscoveryPlugins`
`SetExtraParserPlugins`

Attributes:

expired

True if this object has expired, False otherwise.

AddDiscoveryResult()#

GetAllShaderNodeSourceTypes()#

GetSearchURIs()#

GetShaderNodeByIdentifier()#

GetShaderNodeByIdentifierAndType()#

GetShaderNodeByName()#

GetShaderNodeByNameAndType()#

GetShaderNodeFromAsset()#

GetShaderNodeFromSourceCode()#

GetShaderNodeIdentifiers()#

GetShaderNodeNames()#

GetShaderNodesByFamily()#

GetShaderNodesByIdentifier()#

GetShaderNodesByName()#

SetExtraDiscoveryPlugins()#

SetExtraParserPlugins()#

property expired#: True if this object has expired, False otherwise.

class pxr.Sdr.SdfTypeIndicator#

Methods:

`GetSdfType`
`GetSdrType`
`HasSdfType`

GetSdfType()#

GetSdrType()#

HasSdfType()#

class pxr.Sdr.ShaderNode#

Methods:

GetAdditionalPrimvarProperties()#

GetAllVstructNames()#

GetAssetIdentifierInputNames()#

GetCategory()#

GetContext()#

GetDefaultInput()#

GetDepartments()#

GetFamily()#

GetHelp()#

GetIdentifier()#

GetImplementationName()#

GetInfoString()#

GetLabel()#

GetMetadata()#

GetName()#

GetOpenPages()#

GetPages()#

GetPrimvars()#

GetPropertyNamesForPage()#

GetResolvedDefinitionURI()#

GetResolvedImplementationURI()#

GetRole()#

GetShaderInput()#

GetShaderInputNames()#

GetShaderOutput()#

GetShaderOutputNames()#

GetShaderVersion()#

GetSourceCode()#

GetSourceType()#

IsValid()#

class pxr.Sdr.ShaderNodeList#

Methods:

`append`
`extend`

append()#

extend()#

class pxr.Sdr.ShaderProperty#

Methods:

CanConnectTo()#

GetArraySize()#

GetDefaultValue()#

GetDefaultValueAsSdfType()#

GetHelp()#

GetHints()#

GetImplementationName()#

GetInfoString()#

GetLabel()#

GetMetadata()#

GetName()#

GetOptions()#

GetPage()#

GetShownIf()#

GetTupleSize()#

GetType()#

GetTypeAsSdfType()#

GetVStructConditionalExpr()#

GetVStructMemberName()#

GetVStructMemberOf()#

GetValidConnectionTypes()#

GetWidget()#

IsArray()#

IsAssetIdentifier()#

IsConnectable()#

IsDefaultInput()#

IsDynamicArray()#

IsOutput()#

IsVStruct()#

IsVStructMember()#

class pxr.Sdr.Version#

Methods:

`GetAsDefault`
`GetMajor`
`GetMinor`
`GetStringSuffix`
`IsDefault`

GetAsDefault()#

GetMajor()#

GetMinor()#

GetStringSuffix()#

IsDefault()#

class pxr.Sdr.VersionFilter#

Methods:

GetValueFromName

Attributes:

allValues

static GetValueFromName()#

allValues = (Sdr.VersionFilterDefaultOnly, Sdr.VersionFilterAllVersions)#

`Colorspace`
`Connectable`
`DefaultInput`
`Help`
`Hints`
`ImplementationName`
`IsAssetIdentifier`
`IsDynamicArray`
`Label`
`Options`
`Page`
`RenderType`
`Role`
`SdrUsdDefinitionType`
`ShownIf`
`Tag`
`Target`
`TupleSize`
`ValidConnectionTypes`
`VstructConditionalExpr`
`VstructMemberName`
`VstructMemberOf`
`Widget`

`GetAdditionalPrimvarProperties`
`GetAllVstructNames`
`GetAssetIdentifierInputNames`
`GetCategory`
`GetContext`
`GetDefaultInput`
`GetDepartments`
`GetFamily`
`GetHelp`
`GetIdentifier`
`GetImplementationName`
`GetInfoString`
`GetLabel`
`GetMetadata`
`GetName`
`GetOpenPages`
`GetPages`
`GetPrimvars`
`GetPropertyNamesForPage`
`GetResolvedDefinitionURI`
`GetResolvedImplementationURI`
`GetRole`
`GetShaderInput`
`GetShaderInputNames`
`GetShaderOutput`
`GetShaderOutputNames`
`GetShaderVersion`
`GetSourceCode`
`GetSourceType`
`IsValid`

`CanConnectTo`
`GetArraySize`
`GetDefaultValue`
`GetDefaultValueAsSdfType`
`GetHelp`
`GetHints`
`GetImplementationName`
`GetInfoString`
`GetLabel`
`GetMetadata`
`GetName`
`GetOptions`
`GetPage`
`GetShownIf`
`GetTupleSize`
`GetType`
`GetTypeAsSdfType`
`GetVStructConditionalExpr`
`GetVStructMemberName`
`GetVStructMemberOf`
`GetValidConnectionTypes`
`GetWidget`
`IsArray`
`IsAssetIdentifier`
`IsConnectable`
`IsDefaultInput`
`IsDynamicArray`
`IsOutput`
`IsVStruct`
`IsVStructMember`