@maplibre/native-ffi
    Preparing search index...

    Interface RenderSessionAttachOptions

    Common attachment policy copied before an attach call returns.

    See mln_render_session_attach_options in the C API reference.

    interface RenderSessionAttachOptions {
        driver?: RenderDriverKind;
        driverWorkWake?: Wake;
        frameWake?: Wake;
        producerSyncKind?: GpuSyncKind;
        queueLock?: QueueLock;
        requestedTextureRingDepth?: number;
    }
    Index
    driver? driverWorkWake? frameWake? producerSyncKind? queueLock? requestedTextureRingDepth?
    driver?: RenderDriverKind

    One mln_render_driver_kind value. Defaults to MLN_RENDER_DRIVER_CALLER_GRAPHICS_THREAD.

    driverWorkWake?: Wake

    Wakes the graphics receiver when caller-driver work is available, including work that a finished driver result releases.

    frameWake?: Wake

    Wakes the receiver when the frame-result queue becomes nonempty.

    producerSyncKind?: GpuSyncKind

    Producer synchronization for acquired texture frames. Defaults to MLN_GPU_SYNC_CPU_COMPLETE. MLN_GPU_SYNC_OPENGL_FENCE requires a shared EGL or WGL texture target and a caller-graphics-thread driver. Other targets support only CPU completion and fail an unsupported request.

    queueLock?: QueueLock

    Host lock on the graphics queue, disabled by default. Only Vulkan targets accept an enabled lock; other backends fail the attach with MLN_STATUS_UNSUPPORTED.

    requestedTextureRingDepth?: number

    Requested slot count of a session-owned texture ring, from one to MLN_TEXTURE_RING_MAX_DEPTH. Private targets grant one slot regardless of this value. A borrowed texture ring's depth is its texture count, so borrowed and other targets ignore this value. Defaults to 2, so the host can retain one frame while the session renders its replacement.

    Settings
    Member Visibility

    On This Page
    Properties