Mirror Engine
V5
How To
Mirror Engine Logo

Mirror Engine API


Mirror Engine API / PostEffectQueue

Class: PostEffectQueue

Used to manage multiple post effects for a camera.

Constructors

new PostEffectQueue()

new PostEffectQueue(app: AppBase, camera: CameraComponent): PostEffectQueue

Create a new PostEffectQueue instance.

Parameters

app

AppBase

The application.

camera

CameraComponent

The camera component.

Returns

PostEffectQueue

Methods

addEffect()

addEffect(effect: PostEffect): void

Adds a post effect to the queue. If the queue is disabled adding a post effect will automatically enable the queue.

Parameters

effect

PostEffect

The post effect to add to the queue.

Returns

void


destroy()

destroy(): void

Removes all the effects from the queue and disables it.

Returns

void


disable()

disable(): void

Disables the queue and all of its effects.

Returns

void


enable()

enable(): void

Enables the queue and all of its effects. If there are no effects then the queue will not be enabled.

Returns

void


removeEffect()

removeEffect(effect: PostEffect): void

Removes a post effect from the queue. If the queue becomes empty it will be disabled automatically.

Parameters

effect

PostEffect

The post effect to remove.

Returns

void

Mirror Engine Logo