Interface ScriptScene

Represents the Lens scene. Accessible through global.scene.

Example

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");
interface ScriptScene {
    captureTarget: Texture;
    isRayTracingSupported: boolean;
    liveOverlayTarget: Texture;
    liveTarget: Texture;
    createDepthStencilRenderTargetTexture(): Texture;
    createRenderTargetTexture(): Texture;
    createSceneObject(name: string): SceneObject;
    getCameraType(): string;
    getRootObject(index: number): SceneObject;
    getRootObjectsCount(): number;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isRecording(): boolean;
    isSame(other: ScriptObject): boolean;
}

Hierarchy (view full)

Properties

captureTarget isRayTracingSupported liveOverlayTarget liveTarget

Methods

createDepthStencilRenderTargetTexture createRenderTargetTexture createSceneObject getCameraType getRootObject getRootObjectsCount getTypeName isOfType isRecording isSame

Properties

captureTarget

captureTarget: Texture

The output Render Target of the actual recorded video.

ReadonlyisRayTracingSupported

isRayTracingSupported: boolean

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

liveOverlayTarget

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

liveTarget: Texture

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

Methods

createDepthStencilRenderTargetTexture

  • createDepthStencilRenderTargetTexture(): Texture

  • Create a texture containing the DepthStencilRenderTargetProvider.

    Returns Texture

createRenderTargetTexture

createSceneObject

getCameraType

  • getCameraType(): string

  • 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

getRootObject

getRootObjectsCount

  • getRootObjectsCount(): number

  • Returns the number of SceneObjects in the current scene.

    Returns number

getTypeName

isOfType

  • isOfType(type): boolean

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

    Parameters

    • type: string

    Returns boolean

isRecording

  • isRecording(): boolean

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

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods