Preparing search index...

    Class DepthStencilRenderTargetProvider

    Access to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.

    Hierarchy (View Summary)

    Index

    Properties

    clearDepthValue: number

    Float value in range [0.0..1.0] used in depth buffer clear operation in "CustomValue" mode.

    1
    
    clearStencilValue: number

    Unsigned int value in range [0..0xFF] used in stencil buffer clear operation in "CustomValue" mode.

    0
    
    depthClearOption: DepthClearOption

    Depth buffer clear option. "None" - depth buffer clear operation will be skipped. "CustomValue" - depth buffer will be cleared by "clearDepthValue" property value. "CustomTexture" - depth buffer will be cleared by texture from "inputTexture" property, if "inputTexture" is null then depth clear option will fallback to "CustomValue" mode.

    Lens Scripting Version 152

    DepthClearOption.None
    
    inputTexture: Texture

    Texture with Depth24_Stencil8 format. Depth24 part used in depth clear operation in "CustomTexture" mode.

    Lens Scripting Version 152

    null
    
    maskTexture: Texture

    Texture with Depth24_Stencil8 format. Stencil8 part used in stencil clear operation in "CustomTexture" mode.

    Lens Scripting Version 152

    null
    
    mipmapsEnabled: boolean

    Enable mipmaps on the current render target.

    Lens Scripting Version 314

    false
    
    outputResolution: number

    The ouput resolution of the current render target.

    Lens Scripting Version 314

    DepthStencilRenderTargetProvider.OutputResolution.Custom
    
    resolution: vec2

    Custom render target resolution, this property will use if the "outputResolution" property is a "Custom".

    Lens Scripting Version 152

    (0, 0)
    
    stencilClearOption: StencilClearOption

    Stencil buffer clear option. "None" - stencil buffer clear operation will be skipped. "CustomValue" - stencil buffer will be cleared by "clearStencilValue" property value. "CustomTexture" - stencil buffer will be cleared by texture from "maskTexture" property, if "maskTexture" is null then the stencil clear option will fallback to "CustomValue" mode.

    Lens Scripting Version 152

    StencilClearOption.None
    

    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