style.h

Go to the documentation of this file.

 
#ifndef MAPLIBRE_NATIVE_C_STYLE_H
#define MAPLIBRE_NATIVE_C_STYLE_H
 
#ifndef __cplusplus
#include <stdbool.h>
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "base.h"
#include "map.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct mln_style_id_list mln_style_id_list;

typedef enum mln_style_source_type : uint32_t {
  MLN_STYLE_SOURCE_TYPE_UNKNOWN = 0,
  MLN_STYLE_SOURCE_TYPE_VECTOR = 1,
  MLN_STYLE_SOURCE_TYPE_RASTER = 2,
  MLN_STYLE_SOURCE_TYPE_RASTER_DEM = 3,
  MLN_STYLE_SOURCE_TYPE_GEOJSON = 4,
  MLN_STYLE_SOURCE_TYPE_IMAGE = 5,
  MLN_STYLE_SOURCE_TYPE_VIDEO = 6,
  MLN_STYLE_SOURCE_TYPE_ANNOTATIONS = 7,
  MLN_STYLE_SOURCE_TYPE_CUSTOM_VECTOR = 8,
} mln_style_source_type;

typedef enum mln_style_tile_source_option_field : uint32_t {
  MLN_STYLE_TILE_SOURCE_OPTION_MIN_ZOOM = 1U << 0U,
  MLN_STYLE_TILE_SOURCE_OPTION_MAX_ZOOM = 1U << 1U,
  MLN_STYLE_TILE_SOURCE_OPTION_ATTRIBUTION = 1U << 2U,
  MLN_STYLE_TILE_SOURCE_OPTION_SCHEME = 1U << 3U,
  MLN_STYLE_TILE_SOURCE_OPTION_BOUNDS = 1U << 4U,
  MLN_STYLE_TILE_SOURCE_OPTION_TILE_SIZE = 1U << 5U,
  MLN_STYLE_TILE_SOURCE_OPTION_VECTOR_ENCODING = 1U << 6U,
  MLN_STYLE_TILE_SOURCE_OPTION_RASTER_ENCODING = 1U << 7U,
} mln_style_tile_source_option_field;

typedef enum mln_style_tile_scheme : uint32_t {
  MLN_STYLE_TILE_SCHEME_XYZ = 0,
  MLN_STYLE_TILE_SCHEME_TMS = 1,
} mln_style_tile_scheme;

typedef enum mln_style_vector_tile_encoding : uint32_t {
  MLN_STYLE_VECTOR_TILE_ENCODING_MVT = 0,
  MLN_STYLE_VECTOR_TILE_ENCODING_MLT = 1,
} mln_style_vector_tile_encoding;

typedef enum mln_style_raster_dem_encoding : uint32_t {
  MLN_STYLE_RASTER_DEM_ENCODING_MAPBOX = 0,
  MLN_STYLE_RASTER_DEM_ENCODING_TERRARIUM = 1,
} mln_style_raster_dem_encoding;

typedef enum mln_geojson_source_option_field : uint32_t {
  MLN_GEOJSON_SOURCE_OPTION_MIN_ZOOM = 1U << 0U,
  MLN_GEOJSON_SOURCE_OPTION_MAX_ZOOM = 1U << 1U,
  MLN_GEOJSON_SOURCE_OPTION_TOLERANCE = 1U << 2U,
  MLN_GEOJSON_SOURCE_OPTION_CLUSTER_MAX_ZOOM = 1U << 3U,
  MLN_GEOJSON_SOURCE_OPTION_CLUSTER_PROPERTIES = 1U << 4U,
  MLN_GEOJSON_SOURCE_OPTION_TILE_SIZE = 1U << 5U,
  MLN_GEOJSON_SOURCE_OPTION_BUFFER = 1U << 6U,
  MLN_GEOJSON_SOURCE_OPTION_CLUSTER_RADIUS = 1U << 7U,
  MLN_GEOJSON_SOURCE_OPTION_CLUSTER_MIN_POINTS = 1U << 8U,
  MLN_GEOJSON_SOURCE_OPTION_LINE_METRICS = 1U << 9U,
  MLN_GEOJSON_SOURCE_OPTION_CLUSTER = 1U << 10U,
} mln_geojson_source_option_field;

typedef enum mln_custom_geometry_source_option_field : uint32_t {
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_MIN_ZOOM = 1U << 0U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_MAX_ZOOM = 1U << 1U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_TOLERANCE = 1U << 2U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_TILE_SIZE = 1U << 3U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_BUFFER = 1U << 4U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_CLIP = 1U << 5U,
  MLN_CUSTOM_GEOMETRY_SOURCE_OPTION_WRAP = 1U << 6U,
} mln_custom_geometry_source_option_field;

typedef enum mln_style_image_option_field : uint32_t {
  MLN_STYLE_IMAGE_OPTION_PIXEL_RATIO = 1U << 0U,
  MLN_STYLE_IMAGE_OPTION_SDF = 1U << 1U,
} mln_style_image_option_field;

typedef enum mln_location_indicator_image_kind : uint32_t {
  MLN_LOCATION_INDICATOR_IMAGE_KIND_TOP = 0,
  MLN_LOCATION_INDICATOR_IMAGE_KIND_BEARING = 1,
  MLN_LOCATION_INDICATOR_IMAGE_KIND_SHADOW = 2,
} mln_location_indicator_image_kind;

typedef struct mln_style_source_info {
  uint32_t size;
  uint32_t type;
  size_t id_size;
  bool is_volatile;
  bool has_attribution;
  size_t attribution_size;
} mln_style_source_info;

typedef struct mln_style_tile_source_options {
  uint32_t size;
  uint32_t fields;
  double min_zoom;
  double max_zoom;
  mln_string_view attribution;
  uint32_t scheme;
  mln_lat_lng_bounds bounds;
  uint32_t tile_size;
  uint32_t vector_encoding;
  uint32_t raster_encoding;
} mln_style_tile_source_options;

typedef struct mln_geojson_source_options {
  uint32_t size;
  uint32_t fields;
  double min_zoom;
  double max_zoom;
  double tolerance;
  double cluster_max_zoom;
  const mln_json_value* cluster_properties;
  uint32_t tile_size;
  uint32_t buffer;
  uint32_t cluster_radius;
  uint32_t cluster_min_points;
  bool line_metrics;
  bool cluster;
} mln_geojson_source_options;

typedef struct mln_canonical_tile_id {
  uint32_t z;
  uint32_t x;
  uint32_t y;
} mln_canonical_tile_id;

typedef void (*mln_custom_geometry_source_tile_callback)(
  void* user_data, mln_canonical_tile_id tile_id
);

typedef struct mln_custom_geometry_source_options {
  uint32_t size;
  uint32_t fields;
  mln_custom_geometry_source_tile_callback fetch_tile;
  mln_custom_geometry_source_tile_callback cancel_tile;
  void* user_data;
  double min_zoom;
  double max_zoom;
  double tolerance;
  uint32_t tile_size;
  uint32_t buffer;
  bool clip;
  bool wrap;
} mln_custom_geometry_source_options;

typedef struct mln_premultiplied_rgba8_image {
  uint32_t size;
  uint32_t width;
  uint32_t height;
  uint32_t stride;
  const uint8_t* pixels;
  size_t byte_length;
} mln_premultiplied_rgba8_image;

typedef struct mln_style_image_options {
  uint32_t size;
  uint32_t fields;
  float pixel_ratio;
  bool sdf;
} mln_style_image_options;

typedef struct mln_style_image_info {
  uint32_t size;
  uint32_t width;
  uint32_t height;
  uint32_t stride;
  size_t byte_length;
  float pixel_ratio;
  bool sdf;
} mln_style_image_info;

MLN_API mln_style_tile_source_options
mln_style_tile_source_options_default(void) MLN_NOEXCEPT;

MLN_API mln_geojson_source_options
mln_geojson_source_options_default(void) MLN_NOEXCEPT;

MLN_API mln_custom_geometry_source_options
mln_custom_geometry_source_options_default(void) MLN_NOEXCEPT;

MLN_API mln_premultiplied_rgba8_image
mln_premultiplied_rgba8_image_default(void) MLN_NOEXCEPT;

MLN_API mln_style_image_options
mln_style_image_options_default(void) MLN_NOEXCEPT;

MLN_API mln_style_image_info mln_style_image_info_default(void) MLN_NOEXCEPT;

MLN_API mln_status mln_style_id_list_count(
  const mln_style_id_list* list, size_t* out_count
) MLN_NOEXCEPT;

MLN_API mln_status mln_style_id_list_get(
  const mln_style_id_list* list, size_t index, mln_string_view* out_id
) MLN_NOEXCEPT;

MLN_API void mln_style_id_list_destroy(mln_style_id_list* list) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_style_source_json(
  mln_map* map, mln_string_view source_id, const mln_json_value* source_json
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_remove_style_source(
  mln_map* map, mln_string_view source_id, bool* out_removed
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_style_source_exists(
  mln_map* map, mln_string_view source_id, bool* out_exists
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_source_type(
  mln_map* map, mln_string_view source_id, uint32_t* out_source_type,
  bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_source_info(
  mln_map* map, mln_string_view source_id, mln_style_source_info* out_info,
  bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_copy_style_source_attribution(
  mln_map* map, mln_string_view source_id, char* out_attribution,
  size_t attribution_capacity, size_t* out_attribution_size, bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_list_style_source_ids(
  mln_map* map, mln_style_id_list** out_source_ids
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_geojson_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url,
  const mln_geojson_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_geojson_source_data(
  mln_map* map, mln_string_view source_id, const mln_geojson* data,
  const mln_geojson_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_geojson_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_geojson_source_data(
  mln_map* map, mln_string_view source_id, const mln_geojson* data
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_vector_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url,
  const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_vector_source_tiles(
  mln_map* map, mln_string_view source_id, const mln_string_view* tiles,
  size_t tile_count, const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_raster_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url,
  const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_raster_source_tiles(
  mln_map* map, mln_string_view source_id, const mln_string_view* tiles,
  size_t tile_count, const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_raster_dem_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url,
  const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_raster_dem_source_tiles(
  mln_map* map, mln_string_view source_id, const mln_string_view* tiles,
  size_t tile_count, const mln_style_tile_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_custom_geometry_source(
  mln_map* map, mln_string_view source_id,
  const mln_custom_geometry_source_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_custom_geometry_source_tile_data(
  mln_map* map, mln_string_view source_id, mln_canonical_tile_id tile_id,
  const mln_geojson* data
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_invalidate_custom_geometry_source_tile(
  mln_map* map, mln_string_view source_id, mln_canonical_tile_id tile_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_invalidate_custom_geometry_source_region(
  mln_map* map, mln_string_view source_id, mln_lat_lng_bounds bounds
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_style_image(
  mln_map* map, mln_string_view image_id,
  const mln_premultiplied_rgba8_image* image,
  const mln_style_image_options* options
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_remove_style_image(
  mln_map* map, mln_string_view image_id, bool* out_removed
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_style_image_exists(
  mln_map* map, mln_string_view image_id, bool* out_exists
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_image_info(
  mln_map* map, mln_string_view image_id, mln_style_image_info* out_info,
  bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_copy_style_image_premultiplied_rgba8(
  mln_map* map, mln_string_view image_id, uint8_t* out_pixels,
  size_t pixel_capacity, size_t* out_byte_length, bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_image_source_url(
  mln_map* map, mln_string_view source_id, const mln_lat_lng* coordinates,
  size_t coordinate_count, mln_string_view url
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_image_source_image(
  mln_map* map, mln_string_view source_id, const mln_lat_lng* coordinates,
  size_t coordinate_count, const mln_premultiplied_rgba8_image* image
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_image_source_url(
  mln_map* map, mln_string_view source_id, mln_string_view url
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_image_source_image(
  mln_map* map, mln_string_view source_id,
  const mln_premultiplied_rgba8_image* image
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_image_source_coordinates(
  mln_map* map, mln_string_view source_id, const mln_lat_lng* coordinates,
  size_t coordinate_count
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_image_source_coordinates(
  mln_map* map, mln_string_view source_id, mln_lat_lng* out_coordinates,
  size_t coordinate_capacity, size_t* out_coordinate_count, bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_hillshade_layer(
  mln_map* map, mln_string_view layer_id, mln_string_view source_id,
  mln_string_view before_layer_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_color_relief_layer(
  mln_map* map, mln_string_view layer_id, mln_string_view source_id,
  mln_string_view before_layer_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_location_indicator_layer(
  mln_map* map, mln_string_view layer_id, mln_string_view before_layer_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_location_indicator_location(
  mln_map* map, mln_string_view layer_id, mln_lat_lng coordinate,
  double altitude
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_location_indicator_bearing(
  mln_map* map, mln_string_view layer_id, double bearing
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_location_indicator_accuracy_radius(
  mln_map* map, mln_string_view layer_id, double radius
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_location_indicator_image_name(
  mln_map* map, mln_string_view layer_id, uint32_t image_kind,
  mln_string_view image_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_add_style_layer_json(
  mln_map* map, const mln_json_value* layer_json,
  mln_string_view before_layer_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_remove_style_layer(
  mln_map* map, mln_string_view layer_id, bool* out_removed
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_style_layer_exists(
  mln_map* map, mln_string_view layer_id, bool* out_exists
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_layer_type(
  mln_map* map, mln_string_view layer_id, mln_string_view* out_layer_type,
  bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_list_style_layer_ids(
  mln_map* map, mln_style_id_list** out_layer_ids
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_move_style_layer(
  mln_map* map, mln_string_view layer_id, mln_string_view before_layer_id
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_layer_json(
  mln_map* map, mln_string_view layer_id, mln_json_snapshot** out_layer,
  bool* out_found
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_style_light_json(
  mln_map* map, const mln_json_value* light_json
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_style_light_property(
  mln_map* map, mln_string_view property_name, const mln_json_value* value
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_style_light_property(
  mln_map* map, mln_string_view property_name, mln_json_snapshot** out_value
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_layer_property(
  mln_map* map, mln_string_view layer_id, mln_string_view property_name,
  const mln_json_value* value
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_layer_property(
  mln_map* map, mln_string_view layer_id, mln_string_view property_name,
  mln_json_snapshot** out_value
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_set_layer_filter(
  mln_map* map, mln_string_view layer_id, const mln_json_value* filter
) MLN_NOEXCEPT;

MLN_API mln_status mln_map_get_layer_filter(
  mln_map* map, mln_string_view layer_id, mln_json_snapshot** out_filter
) MLN_NOEXCEPT;
 
#ifdef __cplusplus
}
#endif
 
#endif  // MAPLIBRE_NATIVE_C_STYLE_H