Lens Scripting API
    Preparing search index...

    Class DepthTextureProvider

    Provides depth information of the video feed that the Lens is being applied to when available. Can be accessed from mainPass.baseTex.control of a Spectacles Depth material.

    // Get a reference to the Spectacles Depth material, set in the Inspector panel
    // @input Asset.Material depthMaterial

    // Bind an event to run every frame
    script.createEvent("UpdateEvent").bind(function()
    {
        // The point at the center of the screen
        var screenPosition = new vec2(0.5, 0.5);

        // Get the depth at the screen position
        var depth = script.depthMaterial.mainPass.baseTex.control.getDepth(screenPosition);

        // Print the depth value
        print (depth);
    });

    Hierarchy (View Summary)

    Index

    Methods

    ensureLoaded getAspect getHeight getLoadStatus getTypeName getTypeName getWidth isOfType isSame sampleDepthAtPoint

    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

    • 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

    • Exposes User Data

      Get the depth at the given point

      Parameters

      Returns number

    Settings

    Member Visibility

    On This Page

    Methods