Method

MaplibreNativeFfiMapattach_offscreen

Declaration [src] 

MaplibreNativeFfiRenderSession*
maplibre_native_ffi_map_attach_offscreen (
  MaplibreNativeFfiMap* self,
  const MaplibreNativeFfiOffscreenDescriptor* descriptor,
  MaplibreNativeFfiRenderSessionAttachOptions* options,
  MaplibreNativeFfiOffscreenDevice* device,
  GError** error
)

Description [src]

Attaches a render session that renders the map offscreen.

Read each image’s pixels with maplibre_native_ffi_render_session_read_texture_async().

The session renders on device. When device is null, the session creates a device with the default options, and releases it when the session ends.

The object is ready once maplibre_native_ffi_render_session_ready_async finishes, which fails with the errors that the completion reports.

See mln_map_attach_offscreen in the C API reference.

It fails with these errors:

  • MAPLIBRE_NATIVE_FFI_ERROR_INVALID_STATE when the map already has a render session.
  • MAPLIBRE_NATIVE_FFI_ERROR_NATIVE_ERROR when device is null and the platform can’t create a device.

Parameters

descriptor

Type: MaplibreNativeFfiOffscreenDescriptor

No description available.

The data is owned by the caller of the method.
options

Type: MaplibreNativeFfiRenderSessionAttachOptions

No description available.

The data is owned by the caller of the method.
device

Type: MaplibreNativeFfiOffscreenDevice

The handle, or NULL.

The argument can be NULL.
The data is owned by the caller of the method.
error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.
If the return location is not NULL, then you must initialize it to a NULL GError*.
The argument will be left initialized to NULL by the method if there are no errors.
In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: MaplibreNativeFfiRenderSession

The new object, or NULL with error set.

The caller of the method takes ownership of the returned data, and is responsible for freeing it.