Skip to main content

Camera.ColorRenderTarget

Class

Color based RenderTarget.

  • 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.

Index

Extends

Properties

clearColor

clearColor: vec4

Sets the clear color of the camera when its clearColorOption is set to ClearColorOption.CustomColor

Default Value

(0, 0, 0, 1)

clearColorOption

clearColorOption: ClearColorOption

Sets how the RenderTarget's color will be cleared before rendering during each frame.

Since

Lens Scripting Version 141

Default Value

ClearColorOption.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


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

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

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