DepthStencilRenderTargetProvider
ClassAccess to a Depth Stencil Render Target that can output depth and stencil values from a Camera in Depth24/Stencil8 format.
- Available on all platforms
Index
Properties
Methods
Extends
Properties
clearDepthValue
clearDepthValue:
number
Float value in range [0.0..1.0] used in depth buffer clear operation in "CustomValue" mode.
Default Value
1
clearStencilValue
clearStencilValue:
number
Unsigned int value in range [0..0xFF] used in stencil buffer clear operation in "CustomValue" mode.
Default Value
0
depthClearOption
depthClearOption:
DepthClearOption
Depth buffer clear option. "None" - depth buffer clear operation will be skipped. "CustomValue" - depth buffer will be cleared by "clearDepthValue" property value. "CustomTexture" - depth buffer will be cleared by texture from "inputTexture" property, if "inputTexture" is null then depth clear option will fallback to "CustomValue" mode.
Since
Lens Scripting Version 152
Default Value
DepthClearOption.None
inputTexture
inputTexture:
Texture
Texture with Depth24_Stencil8 format. Depth24 part used in depth clear operation in "CustomTexture" mode.
Since
Lens Scripting Version 152
Default Value
null
maskTexture
maskTexture:
Texture
Texture with Depth24_Stencil8 format. Stencil8 part used in stencil clear operation in "CustomTexture" mode.
Since
Lens Scripting Version 152
Default Value
null
mipmapsEnabled
mipmapsEnabled:
boolean
Enable mipmaps on the current render target.
Since
Lens Scripting Version 314
Default Value
false
outputResolution
outputResolution:
number
The ouput resolution of the current render target.
Since
Lens Scripting Version 314
Default Value
DepthStencilRenderTargetProvider.OutputResolution.Custom
resolution
resolution:
vec2
Custom render target resolution, this property will use if the "outputResolution" property is a "Custom".
Since
Lens Scripting Version 152
Default Value
(0, 0)
stencilClearOption
stencilClearOption:
StencilClearOption
Stencil buffer clear option. "None" - stencil buffer clear operation will be skipped. "CustomValue" - stencil buffer will be cleared by "clearStencilValue" property value. "CustomTexture" - stencil buffer will be cleared by texture from "maskTexture" property, if "maskTexture" is null then the stencil clear option will fallback to "CustomValue" mode.
Since
Lens Scripting Version 152
Default Value
StencilClearOption.None
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<DepthStencilRenderTargetProvider>
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<DepthStencilRenderTargetProvider>
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