Lens Scripting API

    Class BodyDepthTextureProvider

    Provides depth values of the tracked body encoded as D24_UNORM_S8_UINT in screen resolution. Depth is normalized between 0-1, and the stencil component is ignored. The values may be remapped from normalized units (0 to 1) to negative centimeters from the camera (-near in cm to -far in cm) using the Depth Map mode of the Texture 2D Sample node in Material Editor.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    constructor

    Properties

    bodyIndex minimumConfidence trackingScope zFar zNear

    Methods

    getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame

    Constructors

    Properties

    bodyIndex: number

    The index of the body to track. The first body detected is 0.

    minimumConfidence: number

    A background depth (where confidence < minimumConfidence) is represented by 1.0 (zFar). A value from 0.0 to 1.0 (default value 0.5).

    trackingScope: PersonTrackingScope

    The tracking context this effect is being applied to.

    zFar: number

    Far plane value in cm, Read only, always outputs 1000.0.

    zNear: number

    Near plane value in cm, Read only, always outputs 1.0.

    Methods

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

      Returns number

    • 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

    Constructors
    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR