MapLibre Native C API
Public C ABI for the MapLibre Native wrapper.
Loading...
Searching...
No Matches
base.h
Go to the documentation of this file.
1
5
6#ifndef MAPLIBRE_NATIVE_C_BASE_H
7#define MAPLIBRE_NATIVE_C_BASE_H
8
9#ifndef __cplusplus
10#include <stdbool.h>
11#endif
12
13#include <stddef.h>
14#include <stdint.h>
15
16#include "binding.h"
17
18#ifdef _WIN32
19#if defined(MLN_STATIC)
20#define MLN_API
21#elif defined(MLN_BUILDING_C)
22#define MLN_API __declspec(dllexport)
23#else
24#define MLN_API __declspec(dllimport)
25#endif
26#else
27#define MLN_API __attribute__((visibility("default")))
28#endif
29
30#ifdef __cplusplus
31#define MLN_NOEXCEPT noexcept
32#else
33#define MLN_NOEXCEPT
34#endif
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
73
75#define MLN_DIAGNOSTIC_MESSAGE_CAPACITY 4096u
76
88
96
98typedef uint32_t mln_render_backend_flags;
99
101#define MLN_HANDLE_NULL ((uint64_t)0)
102
104typedef uint64_t mln_runtime MLN_BINDING(
105 "kind=handle;release=mln_runtime_release;"
106 "dispose=mln_runtime_dispose"
107);
109typedef uint64_t mln_map MLN_BINDING(
110 "kind=handle;release=mln_map_release;parent=mln_runtime;"
111 "dispose=mln_map_dispose"
112);
114typedef uint64_t mln_style_expression MLN_BINDING(
115 "kind=handle;release=mln_style_expression_release;"
116 "dispose=mln_style_expression_release"
117);
119typedef uint64_t mln_offscreen_device MLN_BINDING(
120 "kind=handle;release=mln_offscreen_device_release;"
121 "dispose=mln_offscreen_device_release"
122);
124typedef uint64_t mln_vulkan_device MLN_BINDING(
125 "kind=handle;release=mln_vulkan_device_release;"
126 "dispose=mln_vulkan_device_release"
127);
129typedef uint64_t mln_map_projection MLN_BINDING(
130 "kind=handle;release=mln_map_projection_release;"
131 "dispose=mln_map_projection_release"
132);
134typedef uint64_t mln_resource_request MLN_BINDING(
135 "kind=handle;release=mln_resource_request_release;"
136 "dispose=mln_resource_request_release"
137);
139typedef uint64_t mln_resource_transform_request MLN_BINDING(
140 "kind=handle;release=mln_resource_transform_request_release;"
141 "dispose=mln_resource_transform_request_release"
142);
144typedef uint64_t mln_render_session MLN_BINDING(
145 "kind=handle;release=mln_render_session_release;parent=mln_map;"
146 "abandon=mln_render_session_abandon;dispose=mln_render_session_dispose"
147);
149typedef uint64_t mln_acquired_frame MLN_BINDING(
150 "kind=handle;release=mln_acquired_frame_release;parent=mln_render_session;"
151 "discard=mln_acquired_frame_discard;"
152 "view_begin=mln_acquired_frame_view_begin;"
153 "view_end=mln_acquired_frame_view_end"
154);
156typedef uint64_t mln_render_frame_batch MLN_BINDING(
157 "kind=handle;release=mln_render_frame_batch_release;"
158 "dispose=mln_render_frame_batch_release"
159);
161typedef uint64_t mln_frame_pacer MLN_BINDING(
162 "kind=handle;release=mln_frame_pacer_release;"
163 "dispose=mln_frame_pacer_release"
164);
166typedef uint64_t mln_delivery_queue MLN_BINDING(
167 "kind=handle;release=mln_delivery_queue_release;"
168 "dispose=mln_delivery_queue_release"
169);
170
178typedef struct mln_buffer_view {
179 const void* data;
180 size_t size MLN_BINDING("kind=count");
182
191typedef void (*mln_user_data_release)(void* user_data);
192
194#define MLN_C_VERSION 0u
195
202MLN_API uint32_t mln_c_version(void) MLN_NOEXCEPT;
203
207
208// Helpers for C callers. Each binding has its own, so the generator skips
209// these.
210#ifndef MLN_BINDGEN
211
217static inline mln_buffer_view mln_buffer_view_from_cstr(const char* text) {
218 // Counts instead of calling strlen() so the headers stay freestanding.
219 size_t size = 0;
220 if (text != NULL) {
221 while (text[size] != '\0') {
222 size++;
223 }
224 }
225 const mln_buffer_view view = {text, size};
226 return view;
227}
228
235#define MLN_STRIDED_AT(type, items, stride, index) \
236 ((const type*)((const unsigned char*)(items) + \
237 ((size_t)(index) * (size_t)(stride))))
238
239#endif // MLN_BINDGEN
240
241#ifdef __cplusplus
242}
243#endif
244
245#endif // MAPLIBRE_NATIVE_C_BASE_H
#define MLN_DIAGNOSTIC_MESSAGE_CAPACITY
Definition base.h:75
uint64_t mln_render_session
Definition base.h:147
uint32_t mln_render_backend_flags
Definition base.h:98
uint64_t mln_resource_transform_request
Definition base.h:142
uint64_t mln_delivery_queue
Definition base.h:169
uint64_t mln_render_frame_batch
Definition base.h:159
uint64_t mln_style_expression
Definition base.h:117
uint64_t mln_map
Definition base.h:112
uint64_t mln_offscreen_device
Definition base.h:122
uint64_t mln_vulkan_device
Definition base.h:127
void(*) mln_user_data_release(void *user_data)
Definition base.h:191
uint64_t mln_acquired_frame
Definition base.h:154
uint64_t mln_runtime
Definition base.h:107
uint64_t mln_resource_request
Definition base.h:137
mln_render_backend_flags mln_supported_render_backend_mask(void)
uint64_t mln_map_projection
Definition base.h:132
mln_status
Definition base.h:41
@ MLN_STATUS_NATIVE_ERROR
Definition base.h:58
@ MLN_STATUS_TARGET_LOST
Definition base.h:67
@ MLN_STATUS_ALREADY_EXISTS
Definition base.h:71
@ MLN_STATUS_UNSUPPORTED
Definition base.h:53
@ MLN_STATUS_OK
Definition base.h:42
@ MLN_STATUS_INVALID_STATE
Definition base.h:49
@ MLN_STATUS_WRONG_THREAD
Definition base.h:51
@ MLN_STATUS_INVALID_ARGUMENT
Definition base.h:44
@ MLN_STATUS_BUSY
Definition base.h:65
@ MLN_STATUS_NOT_FOUND
Definition base.h:69
@ MLN_STATUS_CANCELLED
Definition base.h:63
mln_render_backend_flag
Definition base.h:90
@ MLN_RENDER_BACKEND_FLAG_WEB_GPU
Definition base.h:94
@ MLN_RENDER_BACKEND_FLAG_VULKAN
Definition base.h:92
@ MLN_RENDER_BACKEND_FLAG_OPEN_GL
Definition base.h:93
@ MLN_RENDER_BACKEND_FLAG_METAL
Definition base.h:91
uint64_t mln_frame_pacer
Definition base.h:164
uint32_t mln_c_version(void)
Definition base.h:178
const void * data
Definition base.h:179
size_t size
Definition base.h:180
Definition base.h:84
uint32_t size
Definition base.h:85
char message[MLN_DIAGNOSTIC_MESSAGE_CAPACITY]
Definition base.h:86