Skip to main content

Camera.DepthStencilRenderTarget

Class

This class inherits from the BaseRenderTarget class.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

This class inherits from the BaseRenderTarget class. BaseRenderTarget class is not available for creation and is used like the base class for DepthStencilRenderTarget class to provide access to targetTexture, inputTexture and maskTexture properties.

Index

Extends

Properties

clearDepthValue

clearDepthValue: number

Float value in range [0.0..1.0] used in depth buffer clear operation in "CustomValue" mode.

Since

Lens Scripting Version 152

Default Value

1

clearStencilValue

clearStencilValue: number

Unsigned int value in range [0..0xFF] used in stencil buffer clear operation in "CustomValue" mode.

Since

Lens Scripting Version 152

Default Value

0

depthClearOption

depthClearOption: DepthClearOption

The same as "depthClearOption" property of DepthStencilRenderTargetProvider. But if Camera's depth clear option property is set to "CustomValue" or "CustomTexture" then this has priority over depth/stencil provider settings.

Since

Lens Scripting Version 152

Default Value

DepthClearOption.None

inputTexture

inputTexture: Texture

Color texture used in clear color operation in "CustomTexture" mode.

Default Value

null

Inherited from

BaseRenderTarget.inputTexture


maskTexture

maskTexture: Texture

Texture used like a color mask for target texture.

Default Value

null

Inherited from

BaseRenderTarget.maskTexture


stencilClearOption

stencilClearOption: StencilClearOption

The same as "stencilClearOption" property of DepthStencilRenderTargetProvider. But if Camera's stencil clear option property is set to "CustomValue" or "CustomTexture" then this has priority over depth/stencil provider settings.

Since

Lens Scripting Version 152

Default Value

StencilClearOption.None

targetTexture

targetTexture: Texture

Render target texture. Camera will render scene color values to this texture.

Default Value

null

Inherited from

BaseRenderTarget.targetTexture

Methods

getTypeName()

static getTypeName(): TypeName<DepthStencilRenderTarget>

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<DepthStencilRenderTarget>

Overrides

BaseRenderTarget.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BaseRenderTarget.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

BaseRenderTarget.isOfType


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

ParameterType
otherScriptObject

Returns

boolean

Inherited from

BaseRenderTarget.isSame