Class UsdShadeMaterial
Inheritance
UsdShadeMaterial
Namespace: pxr
Syntax
public class UsdShadeMaterial : UsdShadeNodeGraph, IDisposable
Constructors
UsdShadeMaterial()
Declaration
public UsdShadeMaterial()
UsdShadeMaterial(UsdPrim)
Declaration
public UsdShadeMaterial(UsdPrim prim)
Parameters
UsdShadeMaterial(UsdSchemaBase)
Declaration
public UsdShadeMaterial(UsdSchemaBase schemaObj)
Parameters
Methods
ClearBaseMaterial()
Declaration
public void ClearBaseMaterial()
ComputeDisplacementSource()
Declaration
public UsdShadeShader ComputeDisplacementSource()
Returns
ComputeDisplacementSource(TfToken)
Declaration
public UsdShadeShader ComputeDisplacementSource(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
ComputeDisplacementSource(TfToken, TfToken)
Declaration
public UsdShadeShader ComputeDisplacementSource(TfToken renderContext, TfToken sourceName)
Parameters
Returns
ComputeDisplacementSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)
Declaration
public UsdShadeShader ComputeDisplacementSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
Parameters
Returns
ComputeSurfaceSource()
Declaration
public UsdShadeShader ComputeSurfaceSource()
Returns
ComputeSurfaceSource(TfToken)
Declaration
public UsdShadeShader ComputeSurfaceSource(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
ComputeSurfaceSource(TfToken, TfToken)
Declaration
public UsdShadeShader ComputeSurfaceSource(TfToken renderContext, TfToken sourceName)
Parameters
Returns
ComputeSurfaceSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)
Declaration
public UsdShadeShader ComputeSurfaceSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
Parameters
Returns
ComputeVolumeSource()
Declaration
public UsdShadeShader ComputeVolumeSource()
Returns
ComputeVolumeSource(TfToken)
Declaration
public UsdShadeShader ComputeVolumeSource(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
ComputeVolumeSource(TfToken, TfToken)
Declaration
public UsdShadeShader ComputeVolumeSource(TfToken renderContext, TfToken sourceName)
Parameters
Returns
ComputeVolumeSource(TfToken, TfToken, SWIGTYPE_p_UsdShadeAttributeType)
Declaration
public UsdShadeShader ComputeVolumeSource(TfToken renderContext, TfToken sourceName, SWIGTYPE_p_UsdShadeAttributeType sourceType)
Parameters
Returns
CreateDisplacementAttr()
Declaration
public UsdAttribute CreateDisplacementAttr()
Returns
CreateDisplacementAttr(VtValue)
Declaration
public UsdAttribute CreateDisplacementAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateDisplacementAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateDisplacementAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateDisplacementOutput()
Declaration
public UsdShadeOutput CreateDisplacementOutput()
Returns
CreateDisplacementOutput(TfToken)
Declaration
public UsdShadeOutput CreateDisplacementOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
CreateMasterMaterialVariant(UsdPrim, UsdPrimVector)
Declaration
public static bool CreateMasterMaterialVariant(UsdPrim masterPrim, UsdPrimVector MaterialPrims)
Parameters
Returns
CreateMasterMaterialVariant(UsdPrim, UsdPrimVector, TfToken)
Declaration
public static bool CreateMasterMaterialVariant(UsdPrim masterPrim, UsdPrimVector MaterialPrims, TfToken masterVariantSetName)
Parameters
Returns
CreateSurfaceAttr()
Declaration
public UsdAttribute CreateSurfaceAttr()
Returns
CreateSurfaceAttr(VtValue)
Declaration
public UsdAttribute CreateSurfaceAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateSurfaceAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateSurfaceAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateSurfaceOutput()
Declaration
public UsdShadeOutput CreateSurfaceOutput()
Returns
CreateSurfaceOutput(TfToken)
Declaration
public UsdShadeOutput CreateSurfaceOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
CreateVolumeAttr()
Declaration
public UsdAttribute CreateVolumeAttr()
Returns
CreateVolumeAttr(VtValue)
Declaration
public UsdAttribute CreateVolumeAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateVolumeAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateVolumeAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateVolumeOutput()
Declaration
public UsdShadeOutput CreateVolumeOutput()
Returns
CreateVolumeOutput(TfToken)
Declaration
public UsdShadeOutput CreateVolumeOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
Define(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdShadeMaterial Define(UsdStageWeakPtr stage, SdfPath path)
Parameters
Returns
Dispose()
Declaration
public override void Dispose()
Overrides
Finalize()
Declaration
protected void Finalize()
Get(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdShadeMaterial Get(UsdStageWeakPtr stage, SdfPath path)
Parameters
Returns
GetBaseMaterial()
Declaration
public UsdShadeMaterial GetBaseMaterial()
Returns
GetBaseMaterialPath()
Declaration
public SdfPath GetBaseMaterialPath()
Returns
GetDisplacementAttr()
Declaration
public UsdAttribute GetDisplacementAttr()
Returns
GetDisplacementOutput()
Declaration
public UsdShadeOutput GetDisplacementOutput()
Returns
GetDisplacementOutput(TfToken)
Declaration
public UsdShadeOutput GetDisplacementOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
GetEditContextForVariant(TfToken)
Declaration
public SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t GetEditContextForVariant(TfToken MaterialVariantName)
Parameters
| Type |
Name |
Description |
| TfToken |
MaterialVariantName |
|
Returns
GetEditContextForVariant(TfToken, SdfLayerHandle)
Declaration
public SWIGTYPE_p_std__pairT_UsdStageWeakPtr_UsdEditTarget_t GetEditContextForVariant(TfToken MaterialVariantName, SdfLayerHandle layer)
Parameters
Returns
GetMaterialVariant()
Declaration
public UsdVariantSet GetMaterialVariant()
Returns
GetSchemaAttributeNames()
Declaration
public static TfTokenVector GetSchemaAttributeNames()
Returns
GetSchemaAttributeNames(Boolean)
Declaration
public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
Parameters
| Type |
Name |
Description |
| Boolean |
includeInherited |
|
Returns
GetSurfaceAttr()
Declaration
public UsdAttribute GetSurfaceAttr()
Returns
GetSurfaceOutput()
Declaration
public UsdShadeOutput GetSurfaceOutput()
Returns
GetSurfaceOutput(TfToken)
Declaration
public UsdShadeOutput GetSurfaceOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
GetVolumeAttr()
Declaration
public UsdAttribute GetVolumeAttr()
Returns
GetVolumeOutput()
Declaration
public UsdShadeOutput GetVolumeOutput()
Returns
GetVolumeOutput(TfToken)
Declaration
public UsdShadeOutput GetVolumeOutput(TfToken renderContext)
Parameters
| Type |
Name |
Description |
| TfToken |
renderContext |
|
Returns
HasBaseMaterial()
Declaration
public bool HasBaseMaterial()
Returns
SetBaseMaterial(UsdShadeMaterial)
Declaration
public void SetBaseMaterial(UsdShadeMaterial baseMaterial)
Parameters
SetBaseMaterialPath(SdfPath)
Declaration
public void SetBaseMaterialPath(SdfPath baseMaterialPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
baseMaterialPath |
|
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.