Description

Provides depth information of the video feed that the Lens is being applied to when available, such as in Lenses for Spectacles 3. Can be accessed from mainPass.baseTex.control of a Spectacles Depth material.

See the Lenses for Spectacles guide for more information.

Example

// 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);
});
interface DepthTextureProvider {
    getAspect(): number;
    getDepth(point): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Methods

  • Returns number

    Description

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

  • Parameters

    Returns number

    Exposes User Data

    Description

    Returns the depth at the screen space position "point". The value returned is between 0 and 6,550, which corresponds to the distance the point is from the camera in centimeters, or world-space units. If depth data is not available, -1 will be returned. Note that depth data isn't available during the very first Initialize event, before TurnOn event fires.

  • Returns number

    Description

    Returns the height of the texture in pixels.

  • Returns number

    Description

    Returns the width of the texture in pixels.

  • Parameters

    • type: string

    Returns boolean

    Description

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

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Generated using TypeDoc