Skip to main content

SamplerWrapper

Class

An accessor for Pass.samplers when using PassWrappers

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v147

Index

Extends

Properties

filtering

filtering: FilteringMode

How the texture will be filtered by the sampler.

Since

Lens Scripting Version 147

Default Value

FilteringMode.Bilinear

texture

texture: Texture

The texture used by the sampler.

Since

Lens Scripting Version 147


wrap

wrap: WrapMode

Whether the texture should wrap.

Since

Lens Scripting Version 147

Default Value

WrapMode.ClampToEdge

wrapU

wrapU: WrapMode

Whether the texture should wrap in the x-axis.

Since

Lens Scripting Version 147

Default Value

WrapMode.ClampToEdge

wrapV

wrapV: WrapMode

Whether the texture should wrap in the y-axis.

Since

Lens Scripting Version 147

Default Value

WrapMode.ClampToEdge

wrapW

wrapW: WrapMode

Whether the texture should wrap in the z-axis.

Since

Lens Scripting Version 147

Default Value

WrapMode.ClampToEdge

Methods

getTypeName()

static getTypeName(): TypeName<SamplerWrapper>

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

Since

Lens Scripting Version 147

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

ScriptObject.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

ScriptObject.isSame