mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
11 lines
9.8 KiB
HTML
11 lines
9.8 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Maplibre-rs"><meta name="keywords" content="rust, rustlang, rust-lang, maplibre"><title>maplibre - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../maplibre/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../maplibre/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate maplibre</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></div></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../maplibre/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">maplibre</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/maplibre/lib.rs.html#1-59">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="maplibre-rs"><a href="#maplibre-rs">Maplibre-rs</a></h2>
|
||
<p>A multi-platform library for rendering vector tile maps with WebGPU.</p>
|
||
<p>Maplibre-rs is a map renderer that can run natively on MacOS, Linux, Windows, Android, iOS and the web.
|
||
It takes advantage of Lyon to tessellate vector tiles and WebGPU to display them efficiently.
|
||
Maplibre-rs also has an headless mode (<em>work in progress</em>) that can generate raster images.</p>
|
||
<p>The official guide book can be found <a href="https://maplibre.org/maplibre-rs/docs/book/">here</a>.</p>
|
||
<h4 id="example"><a href="#example">Example</a></h4>
|
||
<p>To import maplibre-rs in your <code>Cargo.toml</code>:</p>
|
||
<div class="example-wrap"><pre class="language-toml"><code>maplibre = "0.0.2"</code></pre></div></div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="benchmarking/index.html" title="maplibre::benchmarking mod">benchmarking</a></div><div class="item-right docblock-short">Collection of utilities used to perform certain calculations more conveniently.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="context/index.html" title="maplibre::context mod">context</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="coords/index.html" title="maplibre::coords mod">coords</a></div><div class="item-right docblock-short">Provides utilities related to coordinates.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="debug/index.html" title="maplibre::debug mod">debug</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="environment/index.html" title="maplibre::environment mod">environment</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="event_loop/index.html" title="maplibre::event_loop mod">event_loop</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="io/index.html" title="maplibre::io mod">io</a></div><div class="item-right docblock-short">Handles IO related processing as well as multithreading.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="kernel/index.html" title="maplibre::kernel mod">kernel</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="map/index.html" title="maplibre::map mod">map</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="platform/index.html" title="maplibre::platform mod">platform</a></div><div class="item-right docblock-short">Handles platform specific code. Depending on the compilation target, different
|
||
parts of this module are used.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="plugin/index.html" title="maplibre::plugin mod">plugin</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="raster/index.html" title="maplibre::raster mod">raster</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="render/index.html" title="maplibre::render mod">render</a></div><div class="item-right docblock-short">This module implements the rendering algorithm of maplibre-rs. It manages the whole
|
||
communication with the GPU.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="schedule/index.html" title="maplibre::schedule mod">schedule</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="style/index.html" title="maplibre::style mod">style</a></div><div class="item-right docblock-short">Vector tile format styling.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tcs/index.html" title="maplibre::tcs mod">tcs</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tessellation/index.html" title="maplibre::tessellation mod">tessellation</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">Tessellation for lines and polygons is implemented here.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tile/index.html" title="maplibre::tile mod">tile</a></div><div class="item-right docblock-short">Nested message and enum types in <code>Tile</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="util/index.html" title="maplibre::util mod">util</a></div><div class="item-right docblock-short">Utils which are used internally</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="vector/index.html" title="maplibre::vector mod">vector</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="view_state/index.html" title="maplibre::view_state mod">view_state</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="window/index.html" title="maplibre::window mod">window</a></div><div class="item-right docblock-short">Utilities for the window system.</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.define_label.html" title="maplibre::define_label macro">define_label</a></div><div class="item-right docblock-short">Macro to define a new label trait</div></div><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.multi_stage.html" title="maplibre::multi_stage macro">multi_stage</a></div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="maplibre" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html> |