Lens Scripting API
    Preparing search index...

    Class BodyInstanceSegmentationTextureProvider

    Provides segmentation confidence values encoded in the R channel. The texture has the Colorspace#RGBA format in screen resolution, but G, B, A channels should be ignored.

    Lens Scripting Version 292

    // @input Component.Image image

    // Get the Body Instance Segmentation Texture from passed in Image component
    const bodySegmentationTexture = script.image.mainPass.baseTex;

    // Get the provider of the texture
    const segmentationTextureProvider = bodySegmentationTexture.control;

    // On tap, switch betweeen first and second body to segment
    script.createEvent("TapEvent").bind(function() {
        const isTrackingBodyZero = segmentationTextureProvider.bodyIndex === 0;
        const bodyToSegment = isTrackingBodyZero ? 1 : 0;
        segmentationTextureProvider.bodyIndex = bodyToSegment;

        print("Segmenting body: " + bodyToSegment);
    })

    Hierarchy (View Summary)

    Index

    Properties

    bodyIndex invertMask refineEdge trackingScope

    Methods

    ensureLoaded getAspect getHeight getLoadStatus getTypeName getTypeName getWidth isOfType isSame

    Properties

    bodyIndex: number

    Which body to segment if multiple are available.

    Lens Scripting Version 292

    0
    invertMask: boolean

    Invert the segmentation of the body.

    Lens Scripting Version 303

    false
    refineEdge: boolean

    Refine the edge of the segmentation of the body.

    Lens Scripting Version 301

    true
    trackingScope: PersonTrackingScope

    The tracking context this effect is being applied to.

    Lens Scripting Version 292

    null

    Methods

    • Returns a Promise that resolves once this Provider has finished loading its resource.

      Returns Promise<void>

      If the Provider is already loaded when ensureLoaded() is called, the returned Promise resolves immediately. Otherwise it resolves once loading completes.

      Completion is determined by the Provider's load status (see Provider.getLoadStatus). Some Providers only become loaded once supporting runtime data is available — for example, a Provider whose resource depends on tracking will not report loaded until the relevant tracking data has arrived — so the returned Promise stays pending until that data is produced.

      This method is useful when Lens script needs to await a Provider before reading its data — for example, waiting for a remote-asset Provider to finish downloading before sampling it.

      Lens Scripting Version 370

      Fetch a Texture at runtime via RemoteMediaModule and wait for its Provider to finish loading before using it:

      const internetModule = require("LensStudio:InternetModule");
      const remoteMediaModule = require("LensStudio:RemoteMediaModule");

      function loadImageTexture(url) {
        const resource = internetModule.makeResourceFromUrl(url);
        return new Promise((resolve, reject) => {
          remoteMediaModule.loadResourceAsImageTexture(resource, resolve, reject);
        });
      }

      const texture = await loadImageTexture("https://example.com/image.png");

      // Wait until the fetched Texture's Provider has finished loading before using it.
      await texture.control.ensureLoaded();
      print("Texture ready, loadStatus: " + texture.control.getLoadStatus());

    • Returns the texture's aspect ratio, which is calculated as width / height.

      Returns number

    • 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 string

      Lens Scripting Version 292

    • Returns the width of the texture in pixels.

      Returns number

    • 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