Skip to main content

SurfaceOptions

Class

Used with DeviceTracking#surfaceOptions to change settings for Surface tracking mode.

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

Index

Example

// Tell the DeviceTracking component to enhance surface tracking with native AR
//@input Component.DeviceTracking deviceTracking

script.deviceTracking.surfaceOptions.enhanceWithNativeAR = true;

Extends

Properties

enhanceWithNativeAR

enhanceWithNativeAR: boolean

If enabled, surface tracking will be improved using native AR tracking.

Default Value

false

Methods

getTypeName()

static getTypeName(): TypeName<SurfaceOptions>

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

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