MapLibre Native C API
Public C ABI for the MapLibre Native wrapper.
Loading...
Searching...
No Matches
base.h File Reference

Go to the source code of this file.

Enumerations

enum  mln_status : int32_t {
}
 
enum  mln_render_backend_flag : uint32_t
 

Functions

uint32_t mln_c_version (void)
 
uint32_t mln_supported_render_backend_mask (void)
 

Detailed Description

Public C API declarations for base ABI types and status values.

Enumeration Type Documentation

◆ mln_render_backend_flag

enum mln_render_backend_flag : uint32_t

Render backend support flags reported by this native library build.

◆ mln_status

enum mln_status : int32_t

Status values returned by status-returning functions.

Enumerator
MLN_STATUS_INVALID_ARGUMENT 

A pointer, size field, mask, or handle argument was invalid.

MLN_STATUS_INVALID_STATE 

The object is valid but not currently in a state that permits the call.

MLN_STATUS_WRONG_THREAD 

The handle is thread-affine and the call was made from the wrong thread.

MLN_STATUS_UNSUPPORTED 

The entry point or requested behavior is unavailable in this build.

MLN_STATUS_NATIVE_ERROR 

A native MapLibre error or C++ exception was converted to status.

Function Documentation

◆ mln_c_version()

uint32_t mln_c_version ( void )

Reports the C ABI contract version. The value is 0 while the ABI is unstable, and will increment on each SemVer major release.

◆ mln_supported_render_backend_mask()

uint32_t mln_supported_render_backend_mask ( void )

Reports the render backends available in this native library build.

The return value is a mask of mln_render_backend_flag values.