Skip to main content

BasePlaceholder

Class

Base class for Input and Output Placeholders used by MLComponent.

  • 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

Extends

Extended by

Properties

dataLayout

dataLayout: DataLayout

The data layout of the current BasePlaceholder, which defines the order in which multidimensional data is accessed in memory.

Since

Lens Scripting Version 310

Default Value

MachineLearning.DataLayout.NHWC

internalDataLayout

readonly internalDataLayout: DataLayout

The internal data layout of the current BasePlaceholder. This layout is used by ML backend. If dataLayout is not the same as internalDataLayout, a layout conversion will happen when process model’s input/output.

Since

Lens Scripting Version 310


name

readonly name: string

The name of the Placeholder.


shape

readonly shape: vec3

The shape of the Placeholder's data.


transformer

readonly transformer: Transformer

Transformer object for applying transformations on the PlaceHolder's data.

Methods

getTypeName()

static getTypeName(): TypeName<BasePlaceholder>

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

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