Lens Scripting API
    Preparing search index...

    Class SamplerWrappers

    A proxy class that provides the access to the properties of the sampler under the hood of the passes contained in the Material asset and VFXAsset via either VFXAsset's PassWrapper.samplers or Material's Pass.samplers. Each property returns a corresponding SamplerWrapper.

    This class uses dynamic properties, meaning that its properties depend on the referenced material or vfx asset and thus not shown below.

    In the example below, the material that is referenced in the material asset contains the baseTex property, which this class then provides access to.

    Lens Scripting Version 147

    // @input Asset.Material myMaterial

    const samplers = script.myMaterial.mainPass.samplers;
    const baseTex = samplers.baseTex;

    baseTex.filtering = FilteringMode.Nearest;

    baseTex.wrapU = WrapMode.ClampToEdge;
    baseTex.wrapV = WrapMode.ClampToEdge;
    baseTex.wrapZ = WrapMode.ClampToEdge;
    baseTex.wrap = WrapMode.ClampToEdge;

    Hierarchy (View Summary)

    Indexable

    • [index: string]: any
    Index

    Methods

    getTypeName getTypeName isOfType isSame

    Methods

    • Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

      Returns string

      Lens Scripting Version 147

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Methods