docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdRiLightAPI

    Inheritance
    Object
    UsdSchemaBase
    UsdAPISchemaBase
    UsdRiLightAPI
    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 UsdRiLightAPI : UsdAPISchemaBase, IDisposable

    Constructors

    UsdRiLightAPI()

    Declaration
    public UsdRiLightAPI()

    UsdRiLightAPI(UsdPrim)

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

    UsdRiLightAPI(UsdSchemaBase)

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

    Methods

    Apply(UsdPrim)

    Declaration
    public static UsdRiLightAPI Apply(UsdPrim prim)
    Parameters
    Type Name Description
    UsdPrim prim
    Returns
    Type Description
    UsdRiLightAPI

    CreateRiIntensityNearDistAttr()

    Declaration
    public UsdAttribute CreateRiIntensityNearDistAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiIntensityNearDistAttr(VtValue)

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

    CreateRiIntensityNearDistAttr(VtValue, Boolean)

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

    CreateRiLightGroupAttr()

    Declaration
    public UsdAttribute CreateRiLightGroupAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiLightGroupAttr(VtValue)

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

    CreateRiLightGroupAttr(VtValue, Boolean)

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

    CreateRiSamplingFixedSampleCountAttr()

    Declaration
    public UsdAttribute CreateRiSamplingFixedSampleCountAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiSamplingFixedSampleCountAttr(VtValue)

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

    CreateRiSamplingFixedSampleCountAttr(VtValue, Boolean)

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

    CreateRiSamplingImportanceMultiplierAttr()

    Declaration
    public UsdAttribute CreateRiSamplingImportanceMultiplierAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiSamplingImportanceMultiplierAttr(VtValue)

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

    CreateRiSamplingImportanceMultiplierAttr(VtValue, Boolean)

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

    CreateRiShadowThinShadowAttr()

    Declaration
    public UsdAttribute CreateRiShadowThinShadowAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiShadowThinShadowAttr(VtValue)

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

    CreateRiShadowThinShadowAttr(VtValue, Boolean)

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

    CreateRiTraceLightPathsAttr()

    Declaration
    public UsdAttribute CreateRiTraceLightPathsAttr()
    Returns
    Type Description
    UsdAttribute

    CreateRiTraceLightPathsAttr(VtValue)

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

    CreateRiTraceLightPathsAttr(VtValue, Boolean)

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

    Dispose()

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

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

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

    GetRiIntensityNearDistAttr()

    Declaration
    public UsdAttribute GetRiIntensityNearDistAttr()
    Returns
    Type Description
    UsdAttribute

    GetRiLightGroupAttr()

    Declaration
    public UsdAttribute GetRiLightGroupAttr()
    Returns
    Type Description
    UsdAttribute

    GetRiSamplingFixedSampleCountAttr()

    Declaration
    public UsdAttribute GetRiSamplingFixedSampleCountAttr()
    Returns
    Type Description
    UsdAttribute

    GetRiSamplingImportanceMultiplierAttr()

    Declaration
    public UsdAttribute GetRiSamplingImportanceMultiplierAttr()
    Returns
    Type Description
    UsdAttribute

    GetRiShadowThinShadowAttr()

    Declaration
    public UsdAttribute GetRiShadowThinShadowAttr()
    Returns
    Type Description
    UsdAttribute

    GetRiTraceLightPathsAttr()

    Declaration
    public UsdAttribute GetRiTraceLightPathsAttr()
    Returns
    Type Description
    UsdAttribute

    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
    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