BodyDepthTextureProvider
ClassProvides depth values of the tracked body encoded as D24_UNORM_S8_UINT in screen resolution.
- Available on all platforms
Since Lens Scripting v171
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.
Index
Properties
Methods
Extends
Properties
bodyIndex
bodyIndex:
number
The index of the body to track. The first body detected is 0.
Since
Lens Scripting Version 171
Default Value
0
minimumConfidence
minimumConfidence:
number
A background depth (where confidence < minimumConfidence) is represented by 1.0 (zFar). A value from 0.0 to 1.0.
Since
Lens Scripting Version 171
Default Value
0.5
trackingScope
trackingScope:
PersonTrackingScope
The tracking context this effect is being applied to.
Since
Lens Scripting Version 309
Default Value
null
zFar
readonlyzFar:number
Far plane value in cm, Read only, always outputs 1000.0.
Since
Lens Scripting Version 171
zNear
readonlyzNear:number
Near plane value in cm, Read only, always outputs 1.0.
Since
Lens Scripting Version 171
Methods
ensureLoaded()
ensureLoaded():
Promise<void>
Returns a Promise that resolves once this Provider has finished loading its resource.
Returns
Promise<void>
Remarks
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.
Since
Lens Scripting Version 370
Example
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());
Inherited from
getAspect()
getAspect():
number
Returns the texture's aspect ratio, which is calculated as width / height.
Returns
number
Inherited from
getHeight()
getHeight():
number
Returns the height of the texture in pixels.
Returns
number
Inherited from
getLoadStatus()
getLoadStatus():
LoadStatus
Returns
Inherited from
getTypeName()
staticgetTypeName():TypeName<BodyDepthTextureProvider>
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
TypeName<BodyDepthTextureProvider>
Since
Lens Scripting Version 171
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
getWidth()
getWidth():
number
Returns the width of the texture in pixels.
Returns
number
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean