mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
17 lines
11 KiB
HTML
17 lines
11 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="This module implements the rendering algorithm of maplibre-rs. It manages the whole communication with the GPU."><title>maplibre::render - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-9bb858ba049f1f21.css" id="mainThemeStyle"><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.72.1 (d5c2e9c34 2023-09-13)" data-channel="1.72.1" data-search-js="search-f6292fe389d70017.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-0f8c037637f9eb3e.css" data-theme-dark-css="dark-1097f8e92a01e3cf.css" data-theme-ayu-css="ayu-614652228113ac93.css" ><script src="../../static.files/storage-59fd9b8ccb335783.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-0f8c037637f9eb3e.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-1097f8e92a01e3cf.css"><link rel="stylesheet" href="../../static.files/noscript-13285aec31fa243e.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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"><!--[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="logo-container" href="../../maplibre/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../maplibre/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module render</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#constants">Constants</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">maplibre</a>::<wbr><a class="mod" href="#">render</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/maplibre/render/mod.rs.html#1-601">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module implements the rendering algorithm of maplibre-rs. It manages the whole
|
||
communication with the GPU.</p>
|
||
<p>The render in this module is largely based on the
|
||
<a href="https://github.com/bevyengine/bevy/tree/aced6a/crates/bevy_render">bevy_render</a>
|
||
crate with commit <code>aced6a</code>.
|
||
It is dual-licensed under MIT and Apache:</p>
|
||
<div class="example-wrap"><pre class="language-text"><code>Bevy is dual-licensed under either
|
||
|
||
* MIT License (docs/LICENSE-MIT or http://opensource.org/licenses/MIT)
|
||
* Apache License, Version 2.0 (docs/LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
||
at your option.
|
||
</code></pre></div>
|
||
<p>We appreciate the design and implementation work which as gone into it.</p>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.ShaderVertex"><code>pub use shaders::<a class="struct" href="shaders/struct.ShaderVertex.html" title="struct maplibre::render::shaders::ShaderVertex">ShaderVertex</a>;</code></div></li></ul><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="builder/index.html" title="mod maplibre::render::builder">builder</a></div></li><li><div class="item-name"><a class="mod" href="camera/index.html" title="mod maplibre::render::camera">camera</a></div><div class="desc docblock-short">Main camera</div></li><li><div class="item-name"><a class="mod" href="draw_graph/index.html" title="mod maplibre::render::draw_graph">draw_graph</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Labels for the “draw” graph</div></li><li><div class="item-name"><a class="mod" href="error/index.html" title="mod maplibre::render::error">error</a></div></li><li><div class="item-name"><a class="mod" href="eventually/index.html" title="mod maplibre::render::eventually">eventually</a></div></li><li><div class="item-name"><a class="mod" href="graph/index.html" title="mod maplibre::render::graph">graph</a></div></li><li><div class="item-name"><a class="mod" href="graph_runner/index.html" title="mod maplibre::render::graph_runner">graph_runner</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Executes a <a href="graph/graph/struct.RenderGraph.html" title="struct maplibre::render::graph::graph::RenderGraph"><code>RenderGraph</code></a></div></li><li><div class="item-name"><a class="mod" href="main_graph/index.html" title="mod maplibre::render::main_graph">main_graph</a></div></li><li><div class="item-name"><a class="mod" href="main_pass/index.html" title="mod maplibre::render::main_pass">main_pass</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">The main render pass for this application.</div></li><li><div class="item-name"><a class="mod" href="render_commands/index.html" title="mod maplibre::render::render_commands">render_commands</a></div><div class="desc docblock-short">Specifies the instructions which are going to be sent to the GPU. Render commands can be concatenated
|
||
into a new render command which executes multiple instruction sets.</div></li><li><div class="item-name"><a class="mod" href="render_phase/index.html" title="mod maplibre::render::render_phase">render_phase</a></div><div class="desc docblock-short">Describes the concept of a <a href="render_phase/struct.RenderPhase.html" title="struct maplibre::render::render_phase::RenderPhase"><code>RenderPhase</code></a> and <a href="render_phase/draw/trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem"><code>PhaseItem</code></a></div></li><li><div class="item-name"><a class="mod" href="resource/index.html" title="mod maplibre::render::resource">resource</a></div><div class="desc docblock-short">Utilities which holds references to GPU-owned. Usually a resource is a wrapper which makes using
|
||
buffers or textures simpler.</div></li><li><div class="item-name"><a class="mod" href="settings/index.html" title="mod maplibre::render::settings">settings</a></div><div class="desc docblock-short">Settings for the renderer</div></li><li><div class="item-name"><a class="mod" href="shaders/index.html" title="mod maplibre::render::shaders">shaders</a></div></li><li><div class="item-name"><a class="mod" href="systems/index.html" title="mod maplibre::render::systems">systems</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Rendering specific systems</div></li><li><div class="item-name"><a class="mod" href="tile_view_pattern/index.html" title="mod maplibre::render::tile_view_pattern">tile_view_pattern</a></div><div class="desc docblock-short">Utility for generating a tile pattern which can be used for masking.</div></li><li><div class="item-name"><a class="mod" href="view_state/index.html" title="mod maplibre::render::view_state">view_state</a></div></li></ul><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.MaskPipeline.html" title="struct maplibre::render::MaskPipeline">MaskPipeline</a></div></li><li><div class="item-name"><a class="struct" href="struct.RenderPlugin.html" title="struct maplibre::render::RenderPlugin">RenderPlugin</a></div></li><li><div class="item-name"><a class="struct" href="struct.RenderResources.html" title="struct maplibre::render::RenderResources">RenderResources</a></div></li><li><div class="item-name"><a class="struct" href="struct.Renderer.html" title="struct maplibre::render::Renderer">Renderer</a></div></li></ul><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.RenderStageLabel.html" title="enum maplibre::render::RenderStageLabel">RenderStageLabel</a></div><div class="desc docblock-short">The labels of the default App rendering stages.</div></li></ul><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.INDEX_FORMAT.html" title="constant maplibre::render::INDEX_FORMAT">INDEX_FORMAT</a><span title="Restricted Visibility"> 🔒</span> </div></li></ul></section></div></main></body></html> |