API Reference

Class List

pc.PostEffectQueue

Used to manage multiple post effects for a camera.

Summary

Methods

addEffect

Adds a post effect to the queue.

destroy

Removes all the effects from the queue and disables it.

disable

Disables the queue and all of its effects.

enable

Enables the queue and all of its effects.

removeEffect

Removes a post effect from the queue.

Details

Constructor

PostEffectQueue(app, camera)

Create a new PostEffectQueue.

Parameters

apppc.Application

The application.

camerapc.CameraComponent

The camera component.

Methods

addEffect(effect)

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

Parameters

effectpc.PostEffect

The post effect to add to the queue.

destroy()

Removes all the effects from the queue and disables it.

disable()

Disables the queue and all of its effects.

enable()

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

removeEffect(effect)

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

Parameters

effectpc.PostEffect

The post effect to remove.