MapLibre-native-rs

Rust bindings to the MapLibre Native map rendering engine.

Usage

We use maplibre-natives' "core library", a static, pre-compiled library. We also allow you to compile this yourself. Instructions for this are below.

Backend Features

This crate supports multiple rendering backends:

• vulkan (default on Linux/Windows): cargo build --features vulkan
• metal (default on macOS/iOS): cargo build --features metal
• opengl (Linux/Windows): cargo build --features opengl

On Linux, OpenGL uses EGL by default for headless rendering. Use the glx feature only when you explicitly need rendering through GLX/X11.

We also support the following other features (all enabled by default):

• json: load styles and layers from JSON via serde_json
• geojson: interoperate with the geojson crate
• log: logging via the log crate

At its core, we work as follows:

use maplibre_native::{CameraUpdate, ImageRendererBuilder, Image, LatLng};
use std::num::NonZeroU32;

let mut renderer = ImageRendererBuilder::new()
                      .with_size(NonZeroU32::new(512).unwrap(),NonZeroU32::new(512).unwrap())
                      .build_static_renderer();
renderer.load_style_from_url(&"https://demotiles.maplibre.org/style.json".parse().unwrap());
let camera = CameraUpdate::new()
    .center(LatLng { lat: 0.0, lng: 0.0 })
    .zoom(0.0);
let image: Image = renderer.render_static(&camera).unwrap();

// Access the underlying ImageBuffer for all operations
let img_buffer = image.as_image();
println!("Image dimensions: {}x{}", img_buffer.width(), img_buffer.height());
img_buffer.save("map.png").unwrap();

TIP: Next to the static rendering map mode, we also have continous and a tile based one. Continous is desiged to be interactive, while the tile based one is primarily for tile servers

Platform Support

The following platform and rendering-API combinations are supported and tested in CI:

[^1]: Vulkan support on macos is provided via MoltenVK. There is a slight performance overhead for this with little upsides. Both Metal and Vulkan run through the same extensive test suite upstream. You can use Vulkan if you find a bug in the Metal implementation until we have fixed it upstream.

Dependencies

This command will install the required dependencies on Linux or macOS for the vulkan backend. You may also use it with the opengl or glx parameter on Linux. It is OK to run this command multiple times for each backend.

just install-dependencies vulkan

Getting the core library

Since we wrap the Maplibre native library, we need this and its headers to be included.

By default the library will be downloaded and build locally during the build process of maplibre-native-rs.

We can get the library and headers from two places:

• The specific version of MapLibre Native used is controlled by package.metadata.mln.release in Cargo.toml. This dependency is automatically updated via a GitHub workflow on the 1st of each month repository. A pull request is created if an update is available.

• If you don't want to allow network access during buildscript execution, we allow you to download the release and tell us where you have downloaded the contents. You can also build from source by following the steps that maplibre-native does in CI to produce the artefacts.

Development

• This project is easier to develop with just, a modern alternative to make. Install it with cargo install just.
• To get a list of available commands, run just.
• To run tests, use just test.

Getting Involved

Join the #maplibre-martin slack channel at OSMUS -- automatic invite is at https://slack.openstreetmap.us/

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT) at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual-licensed as above, without any additional terms or conditions.

MapLibre Native Licence

This crate incorporates MapLibre Native assets during compilation by downloading and statically linking them. As a result, any project using this crate must comply with the MapLibre Native License (BSD 2-Clause) requirements for binary distribution. This includes providing proper attribution and including the license text with your distributed binaries or source code.