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>
 
#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;

typedef enum 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;
typedef uint64_t mln_map;
typedef uint64_t mln_map_projection;
typedef uint64_t mln_offline_region_snapshot;
typedef uint64_t mln_offline_region_list;
typedef uint64_t mln_buffer;
typedef uint64_t mln_resource_request_handle;
typedef uint64_t mln_render_session;
typedef uint64_t mln_wake_source;

typedef struct mln_buffer_view {
  const void* data;
  size_t size;
} mln_buffer_view;

MLN_API mln_status
mln_buffer_get(mln_buffer buffer, mln_buffer_view* out_view) MLN_NOEXCEPT;

MLN_API void mln_buffer_destroy(mln_buffer buffer) MLN_NOEXCEPT;

MLN_API uint32_t mln_c_version(void) MLN_NOEXCEPT;

MLN_API uint32_t mln_supported_render_backend_mask(void) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_BASE_H