archive-gh-me/maplibre-rs
1
0
Fork 0
mirror of https://github.com/maplibre/maplibre-rs.git synced 2025-12-08 19:05:57 +00:00
Code Issues Projects Releases Wiki Activity
maplibre-rs/docs/api/maplibre/index.html

35 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script 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">&#9776;</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.0.2</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li></ul></div></section><div id="sidebar-vars" data-name="maplibre" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></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"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></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-278">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</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 rasters.</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 = &quot;0.0.2&quot;</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"><p>Collection of utilities used to perform certain calculations more conveniently.</p>
</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 class="item-right docblock-short"></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"><p>Provides utilities related to coordinates.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="maplibre::error mod">error</a></div><div class="item-right docblock-short"><p>Errors which can happen in various parts of the library.</p>
</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"><p>Handles IO related processing as well as multithreading.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="map_schedule/index.html" title="maplibre::map_schedule mod">map_schedule</a></div><div class="item-right docblock-short"></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"><p>Handles platform specific code. Depending on the compilation target, different
parts of this module are used.</p>
</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"><p>This module implements the rendering algorithm of maplibre-rs. It manages the whole
communication with the GPU.</p>
</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 class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stages/index.html" title="maplibre::stages mod">stages</a></div><div class="item-right docblock-short"><p><a href="Stage">Stages</a> for requesting and preparing data</p>
</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"><p>Vector tile format styling.</p>
</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></div><div class="item-right docblock-short"><p>Tessellation for lines and polygons is implemented here.</p>
</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"><p>Utils which are used internally</p>
</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"><p>Utilities for the window system.</p>
</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"><p>Macro to define a new label trait</p>
</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 class="item-right docblock-short"></div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Map.html" title="maplibre::Map struct">Map</a></div><div class="item-right docblock-short"><p>The <a href="struct.Map.html" title="Map"><code>Map</code></a> defines the public interface of the map renderer.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapBuilder.html" title="maplibre::MapBuilder struct">MapBuilder</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.UninitializedMap.html" title="maplibre::UninitializedMap struct">UninitializedMap</a></div><div class="item-right docblock-short"><p>Stores the map configuration before the map’s state has been fully initialized.</p>
</div></div></div></section><section id="search" class="content hidden"></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.60.0 (7737e0b5c 2022-04-04)" ></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink