docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdShadeMaterial

    Inheritance
    Object
    UsdSchemaBase
    UsdTyped
    UsdShadeNodeGraph
    UsdShadeMaterial
    Inherited Members
    UsdShadeNodeGraph.ConnectableAPI()
    UsdShadeNodeGraph.CreateOutput(TfToken, SdfValueTypeName)
    UsdShadeNodeGraph.GetOutput(TfToken)
    UsdShadeNodeGraph.GetOutputs()
    UsdShadeNodeGraph.ComputeOutputSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)
    UsdShadeNodeGraph.CreateInput(TfToken, SdfValueTypeName)
    UsdShadeNodeGraph.GetInput(TfToken)
    UsdShadeNodeGraph.GetInputs()
    UsdShadeNodeGraph.GetInterfaceInputs()
    UsdShadeNodeGraph.ComputeInterfaceInputConsumersMap(Boolean)
    UsdShadeNodeGraph.ComputeInterfaceInputConsumersMap()
    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 UsdShadeMaterial : UsdShadeNodeGraph, IDisposable

    Constructors

    UsdShadeMaterial()

    Declaration
    public UsdShadeMaterial()

    UsdShadeMaterial(UsdPrim)

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

    UsdShadeMaterial(UsdSchemaBase)

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

    Methods

    ClearBaseMaterial()

    Declaration
    public void ClearBaseMaterial()

    ComputeDisplacementSource()

    Declaration
    public UsdShadeShader ComputeDisplacementSource()
    Returns
    Type Description
    UsdShadeShader

    ComputeDisplacementSource(TfToken)

    Declaration
    public UsdShadeShader ComputeDisplacementSource(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeShader

    ComputeDisplacementSource(TfToken, TfToken)

    Declaration
    public UsdShadeShader ComputeDisplacementSource(TfToken renderContext, TfToken sourceName)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    Returns
    Type Description
    UsdShadeShader

    ComputeDisplacementSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)

    Declaration
    public UsdShadeShader ComputeDisplacementSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    SWIGTYPE_p_UsdShadeAttributeType sourceType
    Returns
    Type Description
    UsdShadeShader

    ComputeSurfaceSource()

    Declaration
    public UsdShadeShader ComputeSurfaceSource()
    Returns
    Type Description
    UsdShadeShader

    ComputeSurfaceSource(TfToken)

    Declaration
    public UsdShadeShader ComputeSurfaceSource(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeShader

    ComputeSurfaceSource(TfToken, TfToken)

    Declaration
    public UsdShadeShader ComputeSurfaceSource(TfToken renderContext, TfToken sourceName)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    Returns
    Type Description
    UsdShadeShader

    ComputeSurfaceSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)

    Declaration
    public UsdShadeShader ComputeSurfaceSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    SWIGTYPE_p_UsdShadeAttributeType sourceType
    Returns
    Type Description
    UsdShadeShader

    ComputeVolumeSource()

    Declaration
    public UsdShadeShader ComputeVolumeSource()
    Returns
    Type Description
    UsdShadeShader

    ComputeVolumeSource(TfToken)

    Declaration
    public UsdShadeShader ComputeVolumeSource(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeShader

    ComputeVolumeSource(TfToken, TfToken)

    Declaration
    public UsdShadeShader ComputeVolumeSource(TfToken renderContext, TfToken sourceName)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    Returns
    Type Description
    UsdShadeShader

    ComputeVolumeSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)

    Declaration
    public UsdShadeShader ComputeVolumeSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
    Parameters
    Type Name Description
    TfToken renderContext
    TfToken sourceName
    SWIGTYPE_p_UsdShadeAttributeType sourceType
    Returns
    Type Description
    UsdShadeShader

    CreateDisplacementAttr()

    Declaration
    public UsdAttribute CreateDisplacementAttr()
    Returns
    Type Description
    UsdAttribute

    CreateDisplacementAttr(VtValue)

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

    CreateDisplacementAttr(VtValue, Boolean)

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

    CreateDisplacementOutput()

    Declaration
    public UsdShadeOutput CreateDisplacementOutput()
    Returns
    Type Description
    UsdShadeOutput

    CreateDisplacementOutput(TfToken)

    Declaration
    public UsdShadeOutput CreateDisplacementOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    CreateMasterMaterialVariant(UsdPrim, UsdPrimVector)

    Declaration
    public static bool CreateMasterMaterialVariant(UsdPrim masterPrim, UsdPrimVector MaterialPrims)
    Parameters
    Type Name Description
    UsdPrim masterPrim
    UsdPrimVector MaterialPrims
    Returns
    Type Description
    Boolean

    CreateMasterMaterialVariant(UsdPrim, UsdPrimVector, TfToken)

    Declaration
    public static bool CreateMasterMaterialVariant(UsdPrim masterPrim, UsdPrimVector MaterialPrims, TfToken masterVariantSetName)
    Parameters
    Type Name Description
    UsdPrim masterPrim
    UsdPrimVector MaterialPrims
    TfToken masterVariantSetName
    Returns
    Type Description
    Boolean

    CreateSurfaceAttr()

    Declaration
    public UsdAttribute CreateSurfaceAttr()
    Returns
    Type Description
    UsdAttribute

    CreateSurfaceAttr(VtValue)

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

    CreateSurfaceAttr(VtValue, Boolean)

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

    CreateSurfaceOutput()

    Declaration
    public UsdShadeOutput CreateSurfaceOutput()
    Returns
    Type Description
    UsdShadeOutput

    CreateSurfaceOutput(TfToken)

    Declaration
    public UsdShadeOutput CreateSurfaceOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    CreateVolumeAttr()

    Declaration
    public UsdAttribute CreateVolumeAttr()
    Returns
    Type Description
    UsdAttribute

    CreateVolumeAttr(VtValue)

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

    CreateVolumeAttr(VtValue, Boolean)

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

    CreateVolumeOutput()

    Declaration
    public UsdShadeOutput CreateVolumeOutput()
    Returns
    Type Description
    UsdShadeOutput

    CreateVolumeOutput(TfToken)

    Declaration
    public UsdShadeOutput CreateVolumeOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    Define(UsdStageWeakPtr, SdfPath)

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

    Dispose()

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

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

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

    GetBaseMaterial()

    Declaration
    public UsdShadeMaterial GetBaseMaterial()
    Returns
    Type Description
    UsdShadeMaterial

    GetBaseMaterialPath()

    Declaration
    public SdfPath GetBaseMaterialPath()
    Returns
    Type Description
    SdfPath

    GetDisplacementAttr()

    Declaration
    public UsdAttribute GetDisplacementAttr()
    Returns
    Type Description
    UsdAttribute

    GetDisplacementOutput()

    Declaration
    public UsdShadeOutput GetDisplacementOutput()
    Returns
    Type Description
    UsdShadeOutput

    GetDisplacementOutput(TfToken)

    Declaration
    public UsdShadeOutput GetDisplacementOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    GetEditContextForVariant(TfToken)

    Declaration
    public SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t GetEditContextForVariant(TfToken MaterialVariantName)
    Parameters
    Type Name Description
    TfToken MaterialVariantName
    Returns
    Type Description
    SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t

    GetEditContextForVariant(TfToken, SdfLayerHandle)

    Declaration
    public SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t GetEditContextForVariant(TfToken MaterialVariantName, SdfLayerHandle layer)
    Parameters
    Type Name Description
    TfToken MaterialVariantName
    SdfLayerHandle layer
    Returns
    Type Description
    SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t

    GetMaterialVariant()

    Declaration
    public UsdVariantSet GetMaterialVariant()
    Returns
    Type Description
    UsdVariantSet

    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

    GetSurfaceAttr()

    Declaration
    public UsdAttribute GetSurfaceAttr()
    Returns
    Type Description
    UsdAttribute

    GetSurfaceOutput()

    Declaration
    public UsdShadeOutput GetSurfaceOutput()
    Returns
    Type Description
    UsdShadeOutput

    GetSurfaceOutput(TfToken)

    Declaration
    public UsdShadeOutput GetSurfaceOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    GetVolumeAttr()

    Declaration
    public UsdAttribute GetVolumeAttr()
    Returns
    Type Description
    UsdAttribute

    GetVolumeOutput()

    Declaration
    public UsdShadeOutput GetVolumeOutput()
    Returns
    Type Description
    UsdShadeOutput

    GetVolumeOutput(TfToken)

    Declaration
    public UsdShadeOutput GetVolumeOutput(TfToken renderContext)
    Parameters
    Type Name Description
    TfToken renderContext
    Returns
    Type Description
    UsdShadeOutput

    HasBaseMaterial()

    Declaration
    public bool HasBaseMaterial()
    Returns
    Type Description
    Boolean

    SetBaseMaterial(UsdShadeMaterial)

    Declaration
    public void SetBaseMaterial(UsdShadeMaterial baseMaterial)
    Parameters
    Type Name Description
    UsdShadeMaterial baseMaterial

    SetBaseMaterialPath(SdfPath)

    Declaration
    public void SetBaseMaterialPath(SdfPath baseMaterialPath)
    Parameters
    Type Name Description
    SdfPath baseMaterialPath
    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