BodyInstanceSegmentationTextureProvider
ClassProvides segmentation confidence values encoded in the R channel.
- Available on all platforms
Since Lens Scripting v292
Provides segmentation confidence values encoded in the R channel. The texture has the Colorspace#RGBA format in screen resolution, but G, B, A channels should be ignored.
Index
Properties
Methods
Example
// @input Component.Image image
// Get the Body Instance Segmentation Texture from passed in Image component
const bodySegmentationTexture = script.image.mainPass.baseTex;
// Get the provider of the texture
const segmentationTextureProvider = bodySegmentationTexture.control;
// On tap, switch betweeen first and second body to segment
script.createEvent("TapEvent").bind(function() {
const isTrackingBodyZero = segmentationTextureProvider.bodyIndex === 0;
const bodyToSegment = isTrackingBodyZero ? 1 : 0;
segmentationTextureProvider.bodyIndex = bodyToSegment;
print("Segmenting body: " + bodyToSegment);
})
Extends
Properties
bodyIndex
bodyIndex:
number
Which body to segment if multiple are available.
Since
Lens Scripting Version 292
Default Value
0
invertMask
invertMask:
boolean
Invert the segmentation of the body.
Since
Lens Scripting Version 303
Default Value
false
refineEdge
refineEdge:
boolean
Refine the edge of the segmentation of the body.
Since
Lens Scripting Version 301
Default Value
true
trackingScope
trackingScope:
PersonTrackingScope
The tracking context this effect is being applied to.
Since
Lens Scripting Version 292
Default Value
null
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<BodyInstanceSegmentationTextureProvider>
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<BodyInstanceSegmentationTextureProvider>
Since
Lens Scripting Version 292
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