Class WorldDepthTextureProvider

Provides depth information of the video feed that the Lens is being applied to when available.

Hierarchy (View Summary)

TextureProvider
- WorldDepthTextureProvider

Index

Methods

getAspect getHeight getLoadStatus getTypeName getWidth isOfType isSame sampleDepthAtPoint

Methods

getAspect

getAspect(): number
Returns the texture's aspect ratio, which is calculated as width / height.

Returns number
Inherited from TextureProvider.getAspect

getHeight

getHeight(): number
Returns the height of the texture in pixels.

Returns number
Inherited from TextureProvider.getHeight

getLoadStatus

getLoadStatus(): LoadStatus
Returns LoadStatus
Inherited from TextureProvider.getLoadStatus

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from TextureProvider.getTypeName

getWidth

getWidth(): number
Returns the width of the texture in pixels.

Returns number
Inherited from TextureProvider.getWidth

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from TextureProvider.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from TextureProvider.isSame

sampleDepthAtPoint

sampleDepthAtPoint(point: vec2): number
Exposes User Data
Returns the depth at the passed in point (values between 0 and 1, where (0, 0) represents the top-left corner) of the physical camera. The depth returned samples raw depth captured by the camera--that is: the depth of the real world in cm. The depth will be provided as a positive number.
Parameters
- point: vec2
Returns number
Deprecated