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

    Type Alias RenderingState

    Per-canvas rendering pipeline state.

    Lets components react to which rendering pipeline (if any) is active without the user having to manually configure each component. The defaults match the behavior of default rendering with no custom pipeline.

    type RenderingState = {
        _oitCount: number;
        acquireOit: () => () => void;
        transparencyMode: TransparencyMode;
    }
    Index

    Properties

    _oitCount: number

    reference count of active OIT pipelines.

    acquireOit: () => () => void

    Register an active OIT pipeline. Sets RenderingState.transparencyMode to 'oit'. Returns a release function that must be called when the pipeline is disposed; the mode reverts to 'standard' once all registrations are released. Reference counted so multiple/short-lived passes behave correctly.

    transparencyMode: TransparencyMode

    The active transparency mode. Defaults to 'standard'.