Engine API Reference - v2.24.0-beta.16
    Preparing search index...

    Interface CameraFrameEffectContext

    interface CameraFrameEffectContext {
        dt: number;
        renderHeight: number;
        renderWidth: number;
        sceneHeight: number;
        sceneTexture: Texture;
        sceneWidth: number;
    }
    Index
    dt: number

    The time since the camera frame last rendered, in seconds - the time the application advanced by in its updates since, as scripts are updated by: scaled by AppBase#timeScale and limited by AppBase#maxDeltaTime per update. It is 0 for a frame rendered again without the application updating, and while the application is paused.

    renderHeight: number

    The height the scene renders at this frame, in pixels.

    renderWidth: number

    The width the scene renders at this frame, in pixels - the size of the scene render target, which the passes rendering into the scene have.

    sceneHeight: number

    The height of the scene texture this frame, in pixels.

    sceneTexture: Texture

    The scene color the composition reads this frame, once it is resolved: the output of the temporal anti-aliasing when it is enabled, which alternates between two textures from frame to frame, and the scene render target's color otherwise.

    sceneWidth: number

    The width of the scene texture this frame, in pixels. It is the width the scene renders at, unless the scene is resolved to another resolution, as the temporal anti-aliasing does when it upscales.