Engine API Reference
    Preparing search index...

    Class CameraFrame

    Implementation of a simple to use camera rendering pass, which supports SSAO, Bloom and other rendering effects.

    Index

    Constructors

    Properties

    bloom: Bloom = ...

    Bloom settings.

    debug: null | "scene" | "ssao" | "bloom" | "vignette" | "dofcoc" | "dofblur" = null

    Debug rendering. Set to null to disable.

    dof: Dof = ...

    DoF settings.

    fringing: Fringing = ...

    Fringing settings.

    grading: Grading = ...

    Grading settings.

    rendering: Rendering = ...

    Rendering settings.

    ssao: Ssao = ...

    SSAO settings.

    taa: Taa = ...

    Taa settings.

    vignette: Vignette = ...

    Vignette settings.

    Accessors

    • get enabled(): boolean

      Gets the enabled state of the camera frame.

      Returns boolean

    • set enabled(value: boolean): void

      Sets the enabled state of the camera frame. Passing false will release associated resources.

      Parameters

      • value: boolean

      Returns void

    Methods

    • Creates a render pass for the camera frame. Override this method to utilize a custom render pass, typically one that extends RenderPassCameraFrame.

      Returns RenderPassCameraFrame

      • The render pass.
    • Destroys the camera frame, removing all render passes.

      Returns void

    • Applies any changes made to the properties of this instance.

      Returns void