@pmndrs/bvh
    Preparing search index...

    Interface BvhPoolBuildEvent

    One build's progress through a pool (BvhWorkerPoolOptions.onBuild).

    interface BvhPoolBuildEvent {
        error?: string;
        geometry: MeshGeometry;
        id: number;
        inWorker: boolean;
        ms: number;
        outcome?: "built" | "failed" | "cancelled";
        phase: "queued" | "started" | "finished";
        triangleCount: number;
    }
    Index
    error? geometry id inWorker ms outcome? phase triangleCount
    error?: string

    'finished' with 'failed' or 'cancelled': why.

    geometry: MeshGeometry

    The geometry passed to BvhWorkerPool.build (the same object, to tell meshes apart; its arrays may have moved into a worker).

    id: number

    The build's number in this pool, from 1: the same in its events.

    inWorker: boolean

    Started on a worker (true) or inline on the calling thread (false); for 'queued', whether the pool uses workers now; for a build cancelled before it started, false.

    ms: number

    Milliseconds since the build was queued (0 for 'queued').

    outcome?: "built" | "failed" | "cancelled"

    'finished' only: a tree came back, the build failed, or it was cancelled (its signal, or the pool's dispose).

    phase: "queued" | "started" | "finished"

    'queued' when asked for, 'started' when a worker (or the calling thread) takes it, 'finished' when its promise settles.

    triangleCount: number

    Settings
    Member Visibility

    On This Page
    Properties