render_session.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_RENDER_SESSION_H
#define MAPLIBRE_NATIVE_C_RENDER_SESSION_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "completion.h"
#include "render_target.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum mln_render_result : uint32_t {
  MLN_RENDER_RESULT_RENDERED = 0,
  MLN_RENDER_RESULT_NO_UPDATE = 1,
  MLN_RENDER_RESULT_TARGET_NOT_READY = 3,
  MLN_RENDER_RESULT_SUPERSEDED = 4,
} mln_render_result;

typedef enum mln_render_session_state : uint32_t {
  MLN_RENDER_SESSION_STATE_ATTACHING = 1U,
  MLN_RENDER_SESSION_STATE_ATTACHED = 2U,
  MLN_RENDER_SESSION_STATE_DETACHING = 3U,
  MLN_RENDER_SESSION_STATE_DETACHED = 4U,
  MLN_RENDER_SESSION_STATE_TARGET_LOST = 5U,
  MLN_RENDER_SESSION_STATE_ABANDONED = 6U,
} mln_render_session_state;

typedef enum MLN_BINDING("kind=bitmask") mln_frame_demand_flag : uint32_t {
  MLN_FRAME_DEMAND_IF_NEEDED = 1U << 0U,
  MLN_FRAME_DEMAND_PRESENT = 1U << 1U,
  MLN_FRAME_DEMAND_WAIT_FOR_UPDATE = 1U << 2U,
} mln_frame_demand_flag;

typedef struct mln_frame_demand {
  uint32_t size;
  uint32_t flags MLN_BINDING("enum=mln_frame_demand_flag");
  uint64_t token;
} mln_frame_demand;

typedef struct mln_render_frame_result {
  uint32_t size;
  uint32_t disposition MLN_BINDING("enum=mln_render_result");
  uint64_t token;
  uint64_t map_update_generation;
  uint64_t generation;
  uint64_t frame_generation;
  bool needs_repaint;
  mln_map_view view;
} mln_render_frame_result;

typedef struct mln_render_frame_batch_view {
  uint32_t size;
  uint32_t result_size;
  const mln_render_frame_result* results
    MLN_BINDING("length=result_count;stride=result_size");
  size_t result_count;
} mln_render_frame_batch_view;

typedef struct mln_render_session_snapshot {
  uint32_t size;
  uint32_t state MLN_BINDING("enum=mln_render_session_state");
  mln_logical_extent extent;
  uint64_t generation;
  uint64_t map_update_generation;
  uint64_t rendered_update_generation;
  uint64_t frame_generation;
  uint32_t acquired_frame_count;
  bool pending_changes;
} mln_render_session_snapshot;

typedef enum mln_render_abandon_disposition : uint32_t {
  MLN_RENDER_ABANDON_DISPOSITION_CLEAN = 0U,
  MLN_RENDER_ABANDON_DISPOSITION_QUARANTINED = 1U,
} mln_render_abandon_disposition;
 
typedef struct mln_render_abandon_result {
  uint32_t size;
  uint32_t disposition MLN_BINDING("enum=mln_render_abandon_disposition");
  uint32_t quarantined_resource_count;
  uint32_t reserved MLN_BINDING("kind=reserved");
} mln_render_abandon_result;

MLN_API mln_frame_demand mln_frame_demand_default(void) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_get_capabilities(
  mln_render_session session,
  mln_render_session_capabilities* out_capabilities
    MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=snapshot")
MLN_API mln_status mln_render_session_get_snapshot(
  mln_render_session session,
  mln_render_session_snapshot* out_snapshot MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_request_frame(
  mln_render_session session, const mln_frame_demand* demand,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=event_batch")
MLN_API mln_status mln_render_session_drain_frame_results(
  mln_render_session session,
  mln_render_frame_batch* out_batch MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_frame_batch_get(
  mln_render_frame_batch batch,
  mln_render_frame_batch_view* out_view MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API void mln_render_frame_batch_release(
  mln_render_frame_batch batch
) MLN_NOEXCEPT;

MLN_BINDING("absent_on=MLN_STATUS_NOT_READY")
MLN_API mln_status mln_render_session_acquire_frame(
  mln_render_session session,
  mln_acquired_frame* out_frame MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_acquired_frame_get_result(
  mln_acquired_frame frame,
  mln_render_frame_result* out_result MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("view_owner=frame")
MLN_API mln_status mln_acquired_frame_get_producer_sync(
  mln_acquired_frame frame, mln_gpu_sync* out_sync MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_acquired_frame_release(
  mln_acquired_frame frame, const mln_gpu_sync* consumer_completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_acquired_frame_view_begin(
  mln_acquired_frame frame,
  void** out_scope MLN_BINDING("direction=out;kind=context"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API void mln_acquired_frame_view_end(
  void* scope MLN_BINDING("kind=context")
) MLN_NOEXCEPT;

MLN_BINDING("execution=command")
MLN_API mln_status mln_render_session_resize(
  mln_render_session session, mln_logical_extent extent,
  const mln_completion* completion, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_barrier(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_reduce_memory_use(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_clear_data(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=operation")
MLN_API mln_status mln_render_session_dump_debug_logs(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_service_driver_work(
  mln_render_session session, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_BINDING("execution=lifecycle")
MLN_API mln_status mln_render_session_detach(
  mln_render_session session, const mln_completion* completion,
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_abandon(
  mln_render_session session,
  mln_render_abandon_result* out_result MLN_BINDING("direction=out"),
  mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_release(
  mln_render_session session, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_render_session_dispose(
  mln_render_session session, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;

MLN_API mln_status mln_acquired_frame_dispose(
  mln_acquired_frame frame, mln_diagnostic* out_diagnostic
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_RENDER_SESSION_H