@equinor/videx-3d
    Preparing search index...

    Type Alias RenderStatsProps

    RenderStats props

    type RenderStatsProps = {
        className?: string;
        gpu?: boolean;
        interval?: number;
        offset?: [number, number];
        origin?: "top-left" | "top-right" | "bottom-left" | "bottom-right";
        parent?: HTMLElement | null;
    }
    Index

    Properties

    className? gpu? interval? offset? origin? parent?

    Properties

    className?: string

    Optional class name applied to the overlay container (for custom styling).

    gpu?: boolean

    Measure real GPU time via EXT_disjoint_timer_query_webgl2. When the extension is unavailable (e.g. some browsers, or the WebGPU renderer) the GPU row shows n/a. Default true.

    interval?: number

    UI refresh interval in milliseconds (the metrics themselves sample every frame).

    offset?: [number, number]

    Pixel offset [x, y] from the anchored corner.

    origin?: "top-left" | "top-right" | "bottom-left" | "bottom-right"

    Corner the overlay is anchored to.

    parent?: HTMLElement | null

    DOM element the overlay is appended to. Defaults to the renderer canvas' parent element (falling back to document.body).

    Settings

    On This Page

    Properties