Lens Scripting API
    Preparing search index...

    Class OutputPlaceholder

    Provides output data from the neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.

    Returned By: MLComponent#getOutput, OutputBuilder#build

    //@input Component.MLComponent mlComponent
    //@input string outputName = "output"

    var outputData;

    script.mlComponent.onLoadingFinished = onLoadingFinished;

    function onLoadingFinished() {
        var output = script.mlComponent.getOutput(script.outputName);
        outputData = output.data;
    }

    function onUpdate() {
        // do something with data
    }

    Hierarchy (View Summary)

    Index

    Properties

    data dataLayout internalDataLayout mode name shape texture transformer

    Methods

    getTypeName isOfType isSame

    Properties

    data: Float32Array

    Output as a Float32Array. Usable when mode is set to MachineLearning.OutputMode.Data.

    dataLayout: DataLayout

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

    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 models input/output.

    mode: OutputMode

    Which type of data the output is provided as. For example, Texture or Data.

    name: string

    The name of the Placeholder.

    shape: vec3

    The shape of the Placeholder's data.

    texture: Texture

    Output as a Texture. Usable when mode is set to MachineLearning.OutputMode.Texture.

    transformer: Transformer

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

    Methods

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

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods