Method

MaplibreNativeFfiRenderSessiondemand_frame

Declaration [src]

gboolean
maplibre_native_ffi_render_session_demand_frame (
  MaplibreNativeFfiRenderSession* self,
  const MaplibreNativeFfiFrameDemand* demand,
  GError** error
)

Description [src]

Asks the session to render a frame.

The frame shows the map commands that you sent before the call, except the changes that an open command group holds back.

You can call it once the attach call returns. While the attach runs, the demand waits for it to complete. Every demand finishes with one frame result that carries its token, and maplibre_native_ffi_render_session_drain_frame_results() takes it. A demand without MAPLIBRE_NATIVE_FFI_FRAME_DEMAND_FORCE replaces each pending demand with the same flags.

See mln_render_session_demand_frame in the C API reference.

It fails with these errors:

  • MAPLIBRE_NATIVE_FFI_ERROR_TARGET_LOST or MAPLIBRE_NATIVE_FFI_ERROR_NATIVE_ERROR, as MaplibreNativeFfiRenderSessionSnapshot.failure_status reports, when the session has failed.
  • MAPLIBRE_NATIVE_FFI_ERROR_INVALID_STATE when you detached, abandoned, released, or disposed the session, or discarded a frame from every texture of its ring.

Parameters

demand

Type: MaplibreNativeFfiFrameDemand

No description available.

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: gboolean

TRUE on success, or FALSE with error set.