Lens Scripting API

    Class ScriptScene

    Represents the Lens scene. Accessible through global.scene.

    if(global.scene.getCameraType() == "front")
    {
        print("the front camera is active");
    }
    else if(global.scene.getCameraType() == "back")
    {
        print("the back camera is active");
    }

    var newObject = global.scene.createSceneObject("newObject");

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    captureTarget isRayTracingSupported liveOverlayTarget liveTarget

    Methods

    createDepthStencilRenderTargetTexture createRenderTargetTexture createSceneObject getCameraType getRootObject getRootObjectsCount getTypeName isOfType isRecording isSame

    Constructors

    Properties

    captureTarget: Texture

    The output Render Target of the actual recorded video.

    isRayTracingSupported: boolean

    Returns true if the device supports Raytracing and Advanced Graphics Features is enabled in the project settings.

    liveOverlayTarget: Texture

    Similar to liveTarget, but this RenderTarget will not have predictive motion adjustments applied to it (only applicable on supported devices). Learn more

    liveTarget: Texture

    The output Render Target that users will see in the live camera and during recording.

    Methods

    • Create a texture containing the DepthStencilRenderTargetProvider.

      Returns Texture

    • Returns a string describing the currently active device camera.

      Returns "back" if the rear-facing (aka World) camera is active.

      Returns "front" if the front-facing (aka Selfie) camera is active.

      Otherwise, the camera is not initialized.

      Returns string

    • Returns the number of SceneObject in the current scene.

      Returns number

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

      Parameters

      • type: string

      Returns boolean

    • Returns whether or not the scene is currently being recorded.

      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

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR