base.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_BASE_H
#define MAPLIBRE_NATIVE_C_BASE_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "binding.h"
 
#ifdef _WIN32
#if defined(MLN_STATIC)
#define MLN_API
#elif defined(MLN_BUILDING_C)
#define MLN_API __declspec(dllexport)
#else
#define MLN_API __declspec(dllimport)
#endif
#else
#define MLN_API __attribute__((visibility("default")))
#endif
 
#ifdef __cplusplus
#define MLN_NOEXCEPT noexcept
#else
#define MLN_NOEXCEPT
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum mln_status : int32_t {
  MLN_STATUS_OK = 0,
  MLN_STATUS_INVALID_ARGUMENT = -1,
  MLN_STATUS_INVALID_STATE = -2,
  MLN_STATUS_WRONG_THREAD = -3,
  MLN_STATUS_UNSUPPORTED = -4,
  MLN_STATUS_NATIVE_ERROR = -5,
  MLN_STATUS_CANCELLED = -6,
  MLN_STATUS_BUSY = -7,
  MLN_STATUS_TARGET_LOST = -8,
  MLN_STATUS_NOT_READY = -9,
  MLN_STATUS_NOT_FOUND = -10,
} mln_status;

#define MLN_DIAGNOSTIC_MESSAGE_CAPACITY 4096

typedef struct mln_diagnostic {
  uint32_t size;
  char message[MLN_DIAGNOSTIC_MESSAGE_CAPACITY];
} mln_diagnostic;

typedef enum MLN_BINDING("kind=bitmask") mln_render_backend_flag : uint32_t {
  MLN_RENDER_BACKEND_FLAG_METAL = 1u << 0u,
  MLN_RENDER_BACKEND_FLAG_VULKAN = 1u << 1u,
  MLN_RENDER_BACKEND_FLAG_OPENGL = 1u << 2u,
  MLN_RENDER_BACKEND_FLAG_WEBGPU = 1u << 3u,
} mln_render_backend_flag;

#define MLN_HANDLE_NULL ((uint64_t)0)

typedef uint64_t mln_runtime MLN_BINDING(
  "kind=handle;release=mln_runtime_release;"
  "dispose=mln_runtime_dispose"
);
typedef uint64_t mln_map MLN_BINDING(
  "kind=handle;release=mln_map_release;parent=mln_runtime;"
  "dispose=mln_map_dispose"
);
typedef uint64_t mln_geojson_source_data MLN_BINDING(
  "kind=handle;release=mln_geojson_source_data_release;"
  "dispose=mln_geojson_source_data_release"
);
typedef uint64_t mln_style_expression MLN_BINDING(
  "kind=handle;release=mln_style_expression_release;"
  "dispose=mln_style_expression_release"
);
typedef uint64_t mln_map_projection MLN_BINDING(
  "kind=handle;release=mln_map_projection_release;"
  "dispose=mln_map_projection_release"
);
typedef uint64_t mln_resource_request MLN_BINDING(
  "kind=handle;release=mln_resource_request_release;"
  "dispose=mln_resource_request_release"
);
typedef uint64_t mln_resource_transform_request MLN_BINDING(
  "kind=handle;release=mln_resource_transform_request_release;"
  "dispose=mln_resource_transform_request_release"
);
typedef uint64_t mln_render_session MLN_BINDING(
  "kind=handle;release=mln_render_session_release;parent=mln_map;"
  "abandon=mln_render_session_abandon;dispose=mln_render_session_dispose"
);
typedef uint64_t mln_acquired_frame MLN_BINDING(
  "kind=handle;release=mln_acquired_frame_release;parent=mln_render_session;"
  "dispose=mln_acquired_frame_dispose;"
  "view_begin=mln_acquired_frame_view_begin;"
  "view_end=mln_acquired_frame_view_end"
);
typedef uint64_t mln_render_frame_batch MLN_BINDING(
  "kind=handle;release=mln_render_frame_batch_release;"
  "dispose=mln_render_frame_batch_release"
);
typedef uint64_t mln_delivery_queue MLN_BINDING(
  "kind=handle;release=mln_delivery_queue_release;"
  "dispose=mln_delivery_queue_release"
);
typedef uint64_t mln_delivery_batch MLN_BINDING(
  "kind=handle;release=mln_delivery_batch_release;"
  "dispose=mln_delivery_batch_release"
);

typedef struct mln_buffer_view {
  const void* data;
  size_t size MLN_BINDING("kind=count");
} mln_buffer_view;

typedef void (*mln_user_data_release)(void* user_data);

MLN_API uint32_t mln_c_version(void) MLN_NOEXCEPT;

MLN_BINDING("enum=mln_render_backend_flag")
MLN_API uint32_t mln_supported_render_backend_mask(void) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_BASE_H