docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdShadeShader

    Inheritance
    Object
    UsdSchemaBase
    UsdTyped
    UsdShadeShader
    UsdRiRisObject
    UsdRiRslShader
    Inherited Members
    UsdSchemaBase.swigCMemOwn
    UsdSchemaBase.IsConcrete()
    UsdSchemaBase.IsTyped()
    UsdSchemaBase.IsAPISchema()
    UsdSchemaBase.IsAppliedAPISchema()
    UsdSchemaBase.IsMultipleApplyAPISchema()
    UsdSchemaBase.GetSchemaType()
    UsdSchemaBase.GetPrim()
    UsdSchemaBase.GetPath()
    UsdSchemaBase.GetSchemaClassPrimDefinition()
    UsdSchemaBase.Equals(UsdSchemaBase, UsdSchemaBase)
    UsdSchemaBase.GetHashCode()
    UsdSchemaBase.Equals(Object)
    UsdSchemaBase._IsValid()
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: pxr
    Syntax
    public class UsdShadeShader : UsdTyped, IDisposable

    Constructors

    UsdShadeShader()

    Declaration
    public UsdShadeShader()

    UsdShadeShader(UsdPrim)

    Declaration
    public UsdShadeShader(UsdPrim prim)
    Parameters
    Type Name Description
    UsdPrim prim

    UsdShadeShader(UsdSchemaBase)

    Declaration
    public UsdShadeShader(UsdSchemaBase schemaObj)
    Parameters
    Type Name Description
    UsdSchemaBase schemaObj

    UsdShadeShader(UsdShadeConnectableAPI)

    Declaration
    public UsdShadeShader(UsdShadeConnectableAPI connectable)
    Parameters
    Type Name Description
    UsdShadeConnectableAPI connectable

    Methods

    ClearSdrMetadata()

    Declaration
    public void ClearSdrMetadata()

    ClearSdrMetadataByKey(TfToken)

    Declaration
    public void ClearSdrMetadataByKey(TfToken key)
    Parameters
    Type Name Description
    TfToken key

    ConnectableAPI()

    Declaration
    public UsdShadeConnectableAPI ConnectableAPI()
    Returns
    Type Description
    UsdShadeConnectableAPI

    CreateIdAttr()

    Declaration
    public UsdAttribute CreateIdAttr()
    Returns
    Type Description
    UsdAttribute

    CreateIdAttr(VtValue)

    Declaration
    public UsdAttribute CreateIdAttr(VtValue defaultValue)
    Parameters
    Type Name Description
    VtValue defaultValue
    Returns
    Type Description
    UsdAttribute

    CreateIdAttr(VtValue, Boolean)

    Declaration
    public UsdAttribute CreateIdAttr(VtValue defaultValue, bool writeSparsely)
    Parameters
    Type Name Description
    VtValue defaultValue
    Boolean writeSparsely
    Returns
    Type Description
    UsdAttribute

    CreateImplementationSourceAttr()

    Declaration
    public UsdAttribute CreateImplementationSourceAttr()
    Returns
    Type Description
    UsdAttribute

    CreateImplementationSourceAttr(VtValue)

    Declaration
    public UsdAttribute CreateImplementationSourceAttr(VtValue defaultValue)
    Parameters
    Type Name Description
    VtValue defaultValue
    Returns
    Type Description
    UsdAttribute

    CreateImplementationSourceAttr(VtValue, Boolean)

    Declaration
    public UsdAttribute CreateImplementationSourceAttr(VtValue defaultValue, bool writeSparsely)
    Parameters
    Type Name Description
    VtValue defaultValue
    Boolean writeSparsely
    Returns
    Type Description
    UsdAttribute

    CreateInput(TfToken, SdfValueTypeName)

    Declaration
    public UsdShadeInput CreateInput(TfToken name, SdfValueTypeName typeName)
    Parameters
    Type Name Description
    TfToken name
    SdfValueTypeName typeName
    Returns
    Type Description
    UsdShadeInput

    CreateOutput(TfToken, SdfValueTypeName)

    Declaration
    public UsdShadeOutput CreateOutput(TfToken name, SdfValueTypeName typeName)
    Parameters
    Type Name Description
    TfToken name
    SdfValueTypeName typeName
    Returns
    Type Description
    UsdShadeOutput

    Define(UsdStageWeakPtr, SdfPath)

    Declaration
    public static UsdShadeShader Define(UsdStageWeakPtr stage, SdfPath path)
    Parameters
    Type Name Description
    UsdStageWeakPtr stage
    SdfPath path
    Returns
    Type Description
    UsdShadeShader

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    UsdTyped.Dispose()

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

    Declaration
    public static UsdShadeShader Get(UsdStageWeakPtr stage, SdfPath path)
    Parameters
    Type Name Description
    UsdStageWeakPtr stage
    SdfPath path
    Returns
    Type Description
    UsdShadeShader

    GetIdAttr()

    Declaration
    public UsdAttribute GetIdAttr()
    Returns
    Type Description
    UsdAttribute

    GetImplementationSource()

    Declaration
    public TfToken GetImplementationSource()
    Returns
    Type Description
    TfToken

    GetImplementationSourceAttr()

    Declaration
    public UsdAttribute GetImplementationSourceAttr()
    Returns
    Type Description
    UsdAttribute

    GetInput(TfToken)

    Declaration
    public UsdShadeInput GetInput(TfToken name)
    Parameters
    Type Name Description
    TfToken name
    Returns
    Type Description
    UsdShadeInput

    GetInputs()

    Declaration
    public UsdShadeInputVector GetInputs()
    Returns
    Type Description
    UsdShadeInputVector

    GetOutput(TfToken)

    Declaration
    public UsdShadeOutput GetOutput(TfToken name)
    Parameters
    Type Name Description
    TfToken name
    Returns
    Type Description
    UsdShadeOutput

    GetOutputs()

    Declaration
    public UsdShadeOutputVector GetOutputs()
    Returns
    Type Description
    UsdShadeOutputVector

    GetSchemaAttributeNames()

    Declaration
    public static TfTokenVector GetSchemaAttributeNames()
    Returns
    Type Description
    TfTokenVector

    GetSchemaAttributeNames(Boolean)

    Declaration
    public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
    Parameters
    Type Name Description
    Boolean includeInherited
    Returns
    Type Description
    TfTokenVector

    GetSdrMetadata()

    Declaration
    public SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t GetSdrMetadata()
    Returns
    Type Description
    SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t

    GetSdrMetadataByKey(TfToken)

    Declaration
    public string GetSdrMetadataByKey(TfToken key)
    Parameters
    Type Name Description
    TfToken key
    Returns
    Type Description
    String

    GetShaderId(TfToken)

    Declaration
    public bool GetShaderId(TfToken id)
    Parameters
    Type Name Description
    TfToken id
    Returns
    Type Description
    Boolean

    GetShaderNodeForSourceType(TfToken)

    Declaration
    public SdrShaderNode GetShaderNodeForSourceType(TfToken sourceType)
    Parameters
    Type Name Description
    TfToken sourceType
    Returns
    Type Description
    SdrShaderNode

    GetSourceAsset(SdfAssetPath)

    Declaration
    public bool GetSourceAsset(SdfAssetPath sourceAsset)
    Parameters
    Type Name Description
    SdfAssetPath sourceAsset
    Returns
    Type Description
    Boolean

    GetSourceAsset(SdfAssetPath, TfToken)

    Declaration
    public bool GetSourceAsset(SdfAssetPath sourceAsset, TfToken sourceType)
    Parameters
    Type Name Description
    SdfAssetPath sourceAsset
    TfToken sourceType
    Returns
    Type Description
    Boolean

    GetSourceAssetSubIdentifier(TfToken)

    Declaration
    public bool GetSourceAssetSubIdentifier(TfToken subIdentifier)
    Parameters
    Type Name Description
    TfToken subIdentifier
    Returns
    Type Description
    Boolean

    GetSourceAssetSubIdentifier(TfToken, TfToken)

    Declaration
    public bool GetSourceAssetSubIdentifier(TfToken subIdentifier, TfToken sourceType)
    Parameters
    Type Name Description
    TfToken subIdentifier
    TfToken sourceType
    Returns
    Type Description
    Boolean

    GetSourceCode(out String)

    Declaration
    public bool GetSourceCode(out string sourceCode)
    Parameters
    Type Name Description
    String sourceCode
    Returns
    Type Description
    Boolean

    GetSourceCode(out String, TfToken)

    Declaration
    public bool GetSourceCode(out string sourceCode, TfToken sourceType)
    Parameters
    Type Name Description
    String sourceCode
    TfToken sourceType
    Returns
    Type Description
    Boolean

    HasSdrMetadata()

    Declaration
    public bool HasSdrMetadata()
    Returns
    Type Description
    Boolean

    HasSdrMetadataByKey(TfToken)

    Declaration
    public bool HasSdrMetadataByKey(TfToken key)
    Parameters
    Type Name Description
    TfToken key
    Returns
    Type Description
    Boolean

    SetSdrMetadata(SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t)

    Declaration
    public void SetSdrMetadata(SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t sdrMetadata)
    Parameters
    Type Name Description
    SWIGTYPE_p_std__unordered_mapT_TfToken_std__string_TfToken__HashFunctor_t sdrMetadata

    SetSdrMetadataByKey(TfToken, String)

    Declaration
    public void SetSdrMetadataByKey(TfToken key, string value)
    Parameters
    Type Name Description
    TfToken key
    String value

    SetShaderId(TfToken)

    Declaration
    public bool SetShaderId(TfToken id)
    Parameters
    Type Name Description
    TfToken id
    Returns
    Type Description
    Boolean

    SetSourceAsset(SdfAssetPath)

    Declaration
    public bool SetSourceAsset(SdfAssetPath sourceAsset)
    Parameters
    Type Name Description
    SdfAssetPath sourceAsset
    Returns
    Type Description
    Boolean

    SetSourceAsset(SdfAssetPath, TfToken)

    Declaration
    public bool SetSourceAsset(SdfAssetPath sourceAsset, TfToken sourceType)
    Parameters
    Type Name Description
    SdfAssetPath sourceAsset
    TfToken sourceType
    Returns
    Type Description
    Boolean

    SetSourceAssetSubIdentifier(TfToken)

    Declaration
    public bool SetSourceAssetSubIdentifier(TfToken subIdentifier)
    Parameters
    Type Name Description
    TfToken subIdentifier
    Returns
    Type Description
    Boolean

    SetSourceAssetSubIdentifier(TfToken, TfToken)

    Declaration
    public bool SetSourceAssetSubIdentifier(TfToken subIdentifier, TfToken sourceType)
    Parameters
    Type Name Description
    TfToken subIdentifier
    TfToken sourceType
    Returns
    Type Description
    Boolean

    SetSourceCode(String)

    Declaration
    public bool SetSourceCode(string sourceCode)
    Parameters
    Type Name Description
    String sourceCode
    Returns
    Type Description
    Boolean

    SetSourceCode(String, TfToken)

    Declaration
    public bool SetSourceCode(string sourceCode, TfToken sourceType)
    Parameters
    Type Name Description
    String sourceCode
    TfToken sourceType
    Returns
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on Thursday, October 19, 2023