SamplerWrappers
ClassA 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…
- Available on all platforms
Since Lens Scripting v147
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.
Index
Methods
Example
// @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;
Extends
Indexable
[
index:string]:any
Methods
getTypeName()
staticgetTypeName():TypeName<SamplerWrappers>
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
TypeName<SamplerWrappers>
Since
Lens Scripting Version 147
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean