Skip to main content

OutputBuilder

Class

Builds OutputPlaceholders for 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.

Since Lens Scripting v145

Index

Example

//@input vec2 outputSize = {1, 1}
//@input string outputName = "probs"

var outputChannels = 200;

var outputBuilder = MachineLearning.createOutputBuilder();
outputBuilder.setName(script.outputName);
outputBuilder.setShape(new vec3(script.outputSize.x, script.outputSize.y, outputChannels));
outputBuilder.setOutputMode(MachineLearning.OutputMode.Data);
var outputPlaceholder = outputBuilder.build();

Extends

Methods

build()

build(): OutputPlaceholder

Builds and returns a new OutputPlaceholder.

Returns

OutputPlaceholder

Since

Lens Scripting Version 145


getTypeName()

static getTypeName(): TypeName<OutputBuilder>

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

Since

Lens Scripting Version 145

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


setName()

setName(name): OutputBuilder

Sets the name of the OutputPlaceholder to be built.

Parameters

ParameterType
namestring

Returns

OutputBuilder

Since

Lens Scripting Version 145


setOutputMode()

setOutputMode(outputMode): OutputBuilder

Sets the OutputMode of the OutputPlaceholder to be built.

Parameters

ParameterType
outputModeOutputMode

Returns

OutputBuilder

Since

Lens Scripting Version 145


setShape()

setShape(shape): OutputBuilder

Sets the shape of the OutputPlaceholder to be built.

Parameters

ParameterType
shapevec3

Returns

OutputBuilder

Since

Lens Scripting Version 310


setTransformer()

setTransformer(transformer): OutputBuilder

Sets the Transformer of the OutputPlaceholder to be built.

Parameters

ParameterType
transformerTransformer

Returns

OutputBuilder

Since

Lens Scripting Version 145