MapLibre Native C API
Public C ABI for the MapLibre Native wrapper.
Loading...
Searching...
No Matches
mln_render_session_attach_options Struct Reference

#include <render_target.h>

Data Fields

uint32_t size
mln_render_driver_kind driver
mln_gpu_sync_kind_flags producer_sync_kinds
mln_wake frame_wake
mln_wake redraw_wake
mln_wake driver_work_wake
mln_queue_lock queue_lock

Detailed Description

Options for attaching a render session to a map.

Field Documentation

◆ driver

mln_render_driver_kind mln_render_session_attach_options::driver

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

  • MLN_RENDER_DRIVER_CALLER_GRAPHICS_THREAD for a shared or dedicated EGL or WGL context, an existing WebGL context, or a browser's WebGPU device.
  • MLN_RENDER_DRIVER_CORE_WORKER 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 MLN_STATUS_UNSUPPORTED.

◆ driver_work_wake

mln_wake mln_render_session_attach_options::driver_work_wake

Called when a session driven by MLN_RENDER_DRIVER_CALLER_GRAPHICS_THREAD has work for mln_render_session_service_driver_work(). It isn't called again until a service runs.

◆ frame_wake

mln_wake mln_render_session_attach_options::frame_wake

Called when frame results are waiting for mln_render_session_drain_frame_results(). It isn't called again until a drain takes them.

◆ producer_sync_kinds

mln_gpu_sync_kind_flags mln_render_session_attach_options::producer_sync_kinds

The kinds of mln_gpu_sync 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.

◆ queue_lock

mln_queue_lock mln_render_session_attach_options::queue_lock

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

◆ redraw_wake

mln_wake mln_render_session_attach_options::redraw_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.

◆ size

uint32_t mln_render_session_attach_options::size

The documentation for this struct was generated from the following file: