Engine API Reference - v2.22.0-beta.8
    Preparing search index...

    Class PostEffectQueue

    Used to manage multiple post effects for a camera. This is the legacy post-processing path. For new work use CameraFrame, which implements bloom, SSAO, depth of field, TAA, volumetric fog and tone mapping as one HDR pipeline; playcanvas/scripts/esm/camera-frame.mjs wraps it as an attachable script.

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

    • Removes all the effects from the queue and disables it.

      Returns void

    • Disables the queue and all of its effects.

      Returns void

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

      Returns void

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

      Parameters

      Returns void