Struct RenderSessionAttachOptions 

pub struct RenderSessionAttachOptions {
    pub driver: RenderDriverKind,
    pub producer_sync_kinds: GpuSyncKindFlag,
    pub frame_wake: Wake,
    pub redraw_wake: Wake,
    pub driver_work_wake: Wake,
    pub queue_lock: QueueLock,
}

Options for attaching a render session to a map.

See mln_render_session_attach_options in the C API reference.

Fields

driver: RenderDriverKind

The thread that runs the session’s graphics work, which depends on the target:

• RenderDriverKind::CallerGraphicsThread for a shared or dedicated EGL or WGL context, an existing WebGL context, or a browser’s WebGPU device.
• RenderDriverKind::CoreWorker for a transferred WebGL canvas, an Android, OpenHarmony, or Win32 window, a Wayland surface, a ring of Android hardware buffers, dmabufs, DXGI shared textures, or IOSurfaces, or an offscreen session.
• Either one for another Metal or Vulkan target.

An attach with another driver fails with Status::Unsupported.

producer_sync_kinds: GpuSyncKindFlag

The kinds of GpuSync that you can wait on before you read an acquired frame. The session uses one of them that its target supports. Zero lets the session pick a kind that names no object to wait on.

frame_wake: Wake

Called when frame results are waiting for RenderSessionHandle::drain_frame_results(). It isn’t called again until a drain takes them.

redraw_wake: Wake

Called when the session has something new to draw. Demand a frame at your next display refresh. It isn’t called again until you demand a frame, or while the session has no target.

driver_work_wake: Wake

Called when a session driven by RenderDriverKind::CallerGraphicsThread has work for RenderSessionHandle::service_driver_work(). It isn’t called again until a service runs.

queue_lock: QueueLock

Your lock on the Vulkan queue, when you submit to it yourself.

Implementations

impl RenderSessionAttachOptions

pub fn new(driver: RenderDriverKind) -> Self

Trait Implementations

impl Clone for RenderSessionAttachOptions

fn clone(&self) -> RenderSessionAttachOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RenderSessionAttachOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.