Class RenderSessionHandle

[asyncDispose]

[dispose]

discarding

• get discarding(): RenderSessionHandleDiscarding

  The commands of this owner that discard their outcomes.

  Returns RenderSessionHandleDiscarding

abandon

• abandon(): RenderAbandonResult

  Irreversibly ends session work and destroys the session's graphics objects where that is safe.

  See mln_render_session_abandon in the C API reference.

  Returns RenderAbandonResult

acquireFrame

• acquireFrame(): AcquiredFrameHandle | undefined

  Acquires the oldest rendered frame that is not already acquired. The frame owns its slot until release. The call is nonblocking.

  See mln_render_session_acquire_frame in the C API reference.

  Returns AcquiredFrameHandle | undefined

barrier

• barrier(): Promise<void>

  Ends every frame demand that has not started with MLN_RENDER_RESULT_NO_UPDATE and completes after earlier driver work has finished. A running demand finishes its attempt and ends any wait for a map update or a free slot. After completion, a new frame demand is required to render again.

  See mln_render_session_barrier in the C API reference.

  Returns Promise<void>

clearData

• clearData(): Promise<void>

  Starts asynchronous renderer-data clearing.

  See mln_render_session_clear_data in the C API reference.

  Returns Promise<void>

close

• close(): void

  Retires a detached or abandoned session handle. The call is CPU-only and may run on any native thread, including from one of the session's own completions. If an abandonment is still in progress on another thread, this waits for it to finish before consuming the session owner.

  See mln_render_session_release in the C API reference.

  Returns void

detach

• detach(): Promise<void>

  Starts normal graphics-owner teardown and map detachment.

  See mln_render_session_detach in the C API reference.

  Returns Promise<void>

dispose

• dispose(): void

  Consumes a session and schedules its retirement and destruction.

  See mln_render_session_dispose in the C API reference.

  Returns void

drainFrameResults

• drainFrameResults(): RenderFrameBatchHandle | undefined

  Drains every currently queued terminal frame result into an independently owned batch. The records remain stable until the batch is released.

  See mln_render_session_drain_frame_results in the C API reference.

  Returns RenderFrameBatchHandle | undefined

dumpDebugLogs

• dumpDebugLogs(): Promise<void>

  Starts asynchronous renderer diagnostic-log emission.

  See mln_render_session_dump_debug_logs in the C API reference.

  Returns Promise<void>

getCapabilities

• getCapabilities(): RenderSessionCapabilities

  Returns the immutable capabilities fixed during attachment.

  See mln_render_session_get_capabilities in the C API reference.

  Returns RenderSessionCapabilities

getSnapshot

• getSnapshot(): RenderSessionSnapshot

  Copies the latest render-session snapshot from any native thread.

  See mln_render_session_get_snapshot in the C API reference.

  Returns RenderSessionSnapshot

queryFeatureExtensions

• queryFeatureExtensions(
      sourceId: string,
      feature: string,
      extension: string,
      extensionField: string,
      argumentsValue?: string,
  ): Promise<string>

  Starts a feature-extension query against the latest driver state. The completion borrows one mln_buffer_view holding UTF-8 JSON (value_count 1), valid only for the callback.

  See mln_render_session_query_feature_extensions in the C API reference.

  Parameters

  • sourceId: string
  • feature: string
  • extension: string
  • extensionField: string
  • OptionalargumentsValue: string

  Returns Promise<string>

queryRenderedFeatures

• queryRenderedFeatures(
      geometry: RenderedQueryGeometry,
      options?: RenderedFeatureQueryOptions,
  ): Promise<readonly RenderedFeature[]>

  Starts a rendered-feature query against the session's latest driver state.

  See mln_render_session_query_rendered_features in the C API reference.

  Parameters

  • geometry: RenderedQueryGeometry
  • Optionaloptions: RenderedFeatureQueryOptions

  Returns Promise<readonly RenderedFeature[]>

querySourceFeatures

• querySourceFeatures(
      sourceId: string,
      options?: SourceFeatureQueryOptions,
  ): Promise<readonly SourceFeature[]>

  Starts a source-feature query against the session's latest driver state.

  See mln_render_session_query_source_features in the C API reference.

  Parameters

  • sourceId: string
  • Optionaloptions: SourceFeatureQueryOptions

  Returns Promise<readonly SourceFeature[]>

readTexture

• readTexture(): Promise<TextureReadbackResult>

  Reads back the latest frame of the session's owned texture as premultiplied RGBA8.

  See mln_render_session_read_texture in the C API reference.

  Returns Promise<TextureReadbackResult>

reduceMemoryUse

• reduceMemoryUse(): Promise<void>

  Starts best-effort release of renderer caches.

  See mln_render_session_reduce_memory_use in the C API reference.

  Returns Promise<void>

requestFrame

• requestFrame(demand?: FrameDemand): void

  Requests a frame without waiting. Every accepted demand produces one terminal result record. Caller-driver sessions require service on the graphics thread. Core-worker sessions need no host service.

  See mln_render_session_request_frame in the C API reference.

  Parameters

  • demand: FrameDemand = {}

  Returns void

resize

• resize(extent?: LogicalExtent): Promise<CommandCompletion>

  Starts an ordered logical resize of the driver and the map. The driver applies the extent in order with its other work, and later driver work does not wait for the map. The completion runs after both have applied it and the map has published its snapshot. Frames render once a map update matches the applied extent; static and tile maps publish that update for their next still image.

  See mln_render_session_resize in the C API reference.

  Parameters

  • extent: LogicalExtent = {}

  Returns Promise<CommandCompletion>

serviceDriverWork

• serviceDriverWork(): void

  Services every queued item for a caller-graphics-thread driver. The first successful service call fixes the session's graphics-thread identity; later calls from another native thread return MLN_STATUS_WRONG_THREAD. The target context must be current. Core-worker sessions return MLN_STATUS_INVALID_STATE.

  See mln_render_session_service_driver_work in the C API reference.

  Returns void

setMetalBorrowedTextureTarget

• setMetalBorrowedTextureTarget(
      descriptor?: MetalBorrowedTextureDescriptor,
  ): Promise<void>

  Starts an ordered replacement of every texture of a caller-owned Metal ring.

  See mln_render_session_set_metal_borrowed_texture_target in the C API reference.

  Parameters

  • descriptor: MetalBorrowedTextureDescriptor = {}

  Returns Promise<void>

setMetalSurfaceTarget

• setMetalSurfaceTarget(descriptor?: MetalSurfaceDescriptor): Promise<void>

  Starts an ordered Metal surface replacement.

  See mln_render_session_set_metal_surface_target in the C API reference.

  Parameters

  • descriptor: MetalSurfaceDescriptor = {}

  Returns Promise<void>

setOpenglBorrowedTextureTarget

• setOpenglBorrowedTextureTarget(
      descriptor?: OpenglBorrowedTextureDescriptor,
  ): Promise<void>

  Starts an ordered replacement of every texture of a caller-owned OpenGL ring.

  See mln_render_session_set_opengl_borrowed_texture_target in the C API reference.

  Parameters

  • descriptor: OpenglBorrowedTextureDescriptor = {}

  Returns Promise<void>

setOpenglSurfaceTarget

• setOpenglSurfaceTarget(descriptor?: OpenglSurfaceDescriptor): Promise<void>

  Starts an ordered OpenGL surface replacement.

  See mln_render_session_set_opengl_surface_target in the C API reference.

  Parameters

  • descriptor: OpenglSurfaceDescriptor = {}

  Returns Promise<void>

setVulkanBorrowedTextureTarget

• setVulkanBorrowedTextureTarget(
      descriptor?: VulkanBorrowedTextureDescriptor,
  ): Promise<void>

  Starts an ordered replacement of every image of a caller-owned Vulkan ring.

  See mln_render_session_set_vulkan_borrowed_texture_target in the C API reference.

  Parameters

  • descriptor: VulkanBorrowedTextureDescriptor = {}

  Returns Promise<void>

setVulkanSurfaceTarget

• setVulkanSurfaceTarget(descriptor?: VulkanSurfaceDescriptor): Promise<void>

  Starts an ordered Vulkan surface replacement.

  See mln_render_session_set_vulkan_surface_target in the C API reference.

  Parameters

  • descriptor: VulkanSurfaceDescriptor = {}

  Returns Promise<void>

setWebgpuBorrowedTextureTarget

• setWebgpuBorrowedTextureTarget(
      descriptor?: WebgpuBorrowedTextureDescriptor,
  ): Promise<void>

  Starts an ordered replacement of every texture of a caller-owned WebGPU ring.

  See mln_render_session_set_webgpu_borrowed_texture_target in the C API reference.

  Parameters

  • descriptor: WebgpuBorrowedTextureDescriptor = {}

  Returns Promise<void>

setWebgpuSurfaceTarget

• setWebgpuSurfaceTarget(descriptor?: WebgpuSurfaceDescriptor): Promise<void>

  Starts an ordered WebGPU surface replacement.

  See mln_render_session_set_webgpu_surface_target in the C API reference.

  Parameters

  • descriptor: WebgpuSurfaceDescriptor = {}

  Returns Promise<void>