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

12 lines
8.2 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"><title>maplibre - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-081576b923113409.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="maplibre" data-themes="" data-resource-suffix="" data-rustdoc-version="1.79.0 (129f3b996 2024-06-10)" data-channel="1.79.0" data-search-js="search-bf21c90c8c1d92b1.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-e32f0c247825364d.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-09095024cf37855e.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../maplibre/index.html">maplibre</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../maplibre/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Type ‘S’ or ‘/’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings">Settings</a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">maplibre</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/maplibre/lib.rs.html#1-58">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="maplibre-rs"><a class="doc-anchor" href="#maplibre-rs">§</a>Maplibre-rs</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 class="doc-anchor" href="#example">§</a>Example</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="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="benchmarking/index.html" title="mod maplibre::benchmarking">benchmarking</a></div><div class="desc docblock-short">Collection of utilities used to perform certain calculations more conveniently.</div></li><li><div class="item-name"><a class="mod" href="context/index.html" title="mod maplibre::context">context</a></div></li><li><div class="item-name"><a class="mod" href="coords/index.html" title="mod maplibre::coords">coords</a></div><div class="desc docblock-short">Provides utilities related to coordinates.</div></li><li><div class="item-name"><a class="mod" href="debug/index.html" title="mod maplibre::debug">debug</a></div></li><li><div class="item-name"><a class="mod" href="environment/index.html" title="mod maplibre::environment">environment</a></div></li><li><div class="item-name"><a class="mod" href="event_loop/index.html" title="mod maplibre::event_loop">event_loop</a></div></li><li><div class="item-name"><a class="mod" href="io/index.html" title="mod maplibre::io">io</a></div><div class="desc docblock-short">Handles IO related processing as well as multithreading.</div></li><li><div class="item-name"><a class="mod" href="kernel/index.html" title="mod maplibre::kernel">kernel</a></div></li><li><div class="item-name"><a class="mod" href="map/index.html" title="mod maplibre::map">map</a></div></li><li><div class="item-name"><a class="mod" href="platform/index.html" title="mod maplibre::platform">platform</a></div><div class="desc docblock-short">Handles platform specific code. Depending on the compilation target, different
parts of this module are used.</div></li><li><div class="item-name"><a class="mod" href="plugin/index.html" title="mod maplibre::plugin">plugin</a></div></li><li><div class="item-name"><a class="mod" href="raster/index.html" title="mod maplibre::raster">raster</a></div></li><li><div class="item-name"><a class="mod" href="render/index.html" title="mod maplibre::render">render</a></div><div class="desc docblock-short">This module implements the rendering algorithm of maplibre-rs. It manages the whole
communication with the GPU.</div></li><li><div class="item-name"><a class="mod" href="schedule/index.html" title="mod maplibre::schedule">schedule</a></div></li><li><div class="item-name"><a class="mod" href="style/index.html" title="mod maplibre::style">style</a></div><div class="desc docblock-short">Vector tile format styling.</div></li><li><div class="item-name"><a class="mod" href="tcs/index.html" title="mod maplibre::tcs">tcs</a></div></li><li><div class="item-name"><a class="mod" href="tessellation/index.html" title="mod maplibre::tessellation">tessellation</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="desc docblock-short">Tessellation for lines and polygons is implemented here.</div></li><li><div class="item-name"><a class="mod" href="tile/index.html" title="mod maplibre::tile">tile</a></div><div class="desc docblock-short">Nested message and enum types in <code>Tile</code>.</div></li><li><div class="item-name"><a class="mod" href="util/index.html" title="mod maplibre::util">util</a></div><div class="desc docblock-short">Utils which are used internally</div></li><li><div class="item-name"><a class="mod" href="vector/index.html" title="mod maplibre::vector">vector</a></div></li><li><div class="item-name"><a class="mod" href="window/index.html" title="mod maplibre::window">window</a></div><div class="desc docblock-short">Utilities for the window system.</div></li></ul><h2 id="macros" class="section-header">Macros<a href="#macros" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="macro" href="macro.define_label.html" title="macro maplibre::define_label">define_label</a></div><div class="desc docblock-short">Macro to define a new label trait</div></li><li><div class="item-name"><a class="macro" href="macro.multi_stage.html" title="macro maplibre::multi_stage">multi_stage</a></div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink