Interface BodyDepthTextureProvider

Description

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.

interface BodyDepthTextureProvider {
    bodyIndex: number;
    minimumConfidence: number;
    zFar: number;
    zNear: number;
    getAspect(): number;
    getHeight(): number;
    getLoadStatus(): LoadStatus;
    getTypeName(): string;
    getWidth(): number;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

bodyIndex minimumConfidence zFar zNear

Methods

getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame

Properties

bodyIndex

bodyIndex: number

Description

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

minimumConfidence

minimumConfidence: number

Description

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

Readonly zFar

zFar: number

Description

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

Readonly zNear

zNear: number

Description

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

Methods

getAspect

  • getAspect(): number

  • Returns number

    Description

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

getHeight

  • getHeight(): number

  • Returns number

    Description

    Returns the height of the texture in pixels.

getLoadStatus

getTypeName

getWidth

  • getWidth(): number

  • Returns number

    Description

    Returns the width of the texture in pixels.

isOfType

  • isOfType(type): boolean

  • Parameters

    • type: string

    Returns boolean

    Description

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

isSame

  • isSame(other): boolean

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc