mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
16 lines
12 KiB
HTML
16 lines
12 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."><meta name="keywords" content="rust, rustlang, rust-lang, render"><title>maplibre::render - 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="../../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"><!--[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="#">Module render</a></h2><div class="sidebar-elems"><section><div class="block"><ul><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="#constants">Constants</a></li><li><a href="#functions">Functions</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">Module <a href="../index.html">maplibre</a>::<wbr><a class="mod" href="#">render</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/render/mod.rs.html#1-533">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"><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><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.register_default_render_stages"><code>pub use stages::<a class="fn" href="stages/fn.register_default_render_stages.html" title="fn maplibre::render::stages::register_default_render_stages">register_default_render_stages</a>;</code></div></div></div><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="builder/index.html" title="maplibre::render::builder mod">builder</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="camera/index.html" title="maplibre::render::camera mod">camera</a></div><div class="item-right docblock-short">Main camera</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="debug_pass/index.html" title="maplibre::render::debug_pass mod">debug_pass</a><span title="Restricted Visibility"> 🔒</span> </div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="draw_graph/index.html" title="maplibre::render::draw_graph mod">draw_graph</a></div><div class="item-right docblock-short">Labels for the “draw” graph</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="error/index.html" title="maplibre::render::error mod">error</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="eventually/index.html" title="maplibre::render::eventually mod">eventually</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="graph/index.html" title="maplibre::render::graph mod">graph</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="graph_runner/index.html" title="maplibre::render::graph_runner mod">graph_runner</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">Executes a <a href="graph/graph/struct.RenderGraph.html" title="RenderGraph"><code>RenderGraph</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="main_graph/index.html" title="maplibre::render::main_graph mod">main_graph</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="main_pass/index.html" title="maplibre::render::main_pass mod">main_pass</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">The main render pass for this application.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="render_commands/index.html" title="maplibre::render::render_commands mod">render_commands</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right 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></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="render_phase/index.html" title="maplibre::render::render_phase mod">render_phase</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">Describes the concept of a <a href="render_phase/struct.RenderPhase.html" title="RenderPhase"><code>RenderPhase</code></a> and <a href="render_phase/draw/trait.PhaseItem.html" title="PhaseItem"><code>PhaseItem</code></a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="resource/index.html" title="maplibre::render::resource mod">resource</a></div><div class="item-right docblock-short">Utilities which holds references to GPU-owned. Usually a resource is a wrapper which makes using
|
||
buffers or textures simpler.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="settings/index.html" title="maplibre::render::settings mod">settings</a></div><div class="item-right docblock-short">Settings for the renderer</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="shaders/index.html" title="maplibre::render::shaders mod">shaders</a><span title="Restricted Visibility"> 🔒</span> </div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stages/index.html" title="maplibre::render::stages mod">stages</a></div><div class="item-right docblock-short">Rendering specific <a href="../schedule/trait.Stage.html">Stages</a></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tile_pipeline/index.html" title="maplibre::render::tile_pipeline mod">tile_pipeline</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">Utility for declaring pipelines.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="tile_view_pattern/index.html" title="maplibre::render::tile_view_pattern mod">tile_view_pattern</a><span title="Restricted Visibility"> 🔒</span> </div><div class="item-right docblock-short">Utility for generating a tile pattern which can be used for masking.</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.RenderState.html" title="maplibre::render::RenderState struct">RenderState</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Renderer.html" title="maplibre::render::Renderer struct">Renderer</a></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ShaderVertex.html" title="maplibre::render::ShaderVertex struct">ShaderVertex</a></div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.INDEX_FORMAT.html" title="maplibre::render::INDEX_FORMAT constant">INDEX_FORMAT</a><span title="Restricted Visibility"> 🔒</span> </div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.create_default_render_graph.html" title="maplibre::render::create_default_render_graph fn">create_default_render_graph</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> |