#include <render_session.h>

Data Fields
uint32_t	disposition
uint64_t	map_update_generation
uint64_t	generation
uint64_t	frame_generation
bool	needs_repaint
mln_map_view	view

Detailed Description

Terminal result of one frame demand, held by an owned frame-result batch and copied by mln_acquired_frame_get_result().

Step through a batch's records by mln_render_frame_batch_view.result_size rather than by the size of this struct: a later version may append a member and widen the stride. In a batch, each record's size equals that stride.

Field Documentation

◆ disposition

uint32_t mln_render_frame_result::disposition

One mln_render_result value.

◆ frame_generation

uint64_t mln_render_frame_result::frame_generation

Position of the frame among the frames that the session rendered, counting from one. Zero unless disposition is MLN_RENDER_RESULT_RENDERED.

◆ generation

uint64_t mln_render_frame_result::generation

The session's target generation when the demand reached its result. See mln_render_session_snapshot.generation.

◆ map_update_generation

uint64_t mln_render_frame_result::map_update_generation

Generation of the map render update the demand evaluated. When disposition is MLN_RENDER_RESULT_RENDERED, the frame drew that update; compare it with mln_completion_result.render_update_generation to find the first frame that includes a command.

◆ needs_repaint

bool mln_render_frame_result::needs_repaint

Whether the map asked for another frame while it rendered this one, as during an ongoing paint transition. Set only when disposition is MLN_RENDER_RESULT_RENDERED, and false for every other outcome. It matches the needs_repaint field of MLN_RUNTIME_EVENT_MAP_RENDER_FRAME_FINISHED. A camera transition does not set it: the map publishes an update for each of the transition's frames instead, which a render-if-needed demand renders.

◆ view

mln_map_view mln_render_frame_result::view

The view that this frame drew, from the transform of the map update that it rendered. A host that displays the frame builds its projection with mln_map_projection_create() to place overlays where the frame drew their coordinates. Zero, with a size of zero, unless disposition is MLN_RENDER_RESULT_RENDERED.

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

/home/runner/_work/maplibre-native-ffi/maplibre-native-ffi/include/maplibre_native_c/render_session.h

Data Fields