mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
15 lines
11 KiB
HTML
15 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="An item which will be drawn to the screen. A phase item should be queued up for rendering during the `RenderStageLabel::Queue` stage. Afterwards it will be sorted and rendered automatically in the `RenderStageLabel::PhaseSort` stage and `RenderStageLabel::Render` stage, respectively."><title>PhaseItem in maplibre::render::render_phase - 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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.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.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.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 trait"><!--[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></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><h2 class="location"><a href="#">PhaseItem</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.SortKey">SortKey</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.draw_function">draw_function</a></li><li><a href="#tymethod.sort_key">sort_key</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In maplibre::render::render_phase</a></h2></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="Click or press ‘S’ 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"><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>Trait <a href="../../index.html">maplibre</a>::<wbr><a href="../index.html">render</a>::<wbr><a href="index.html">render_phase</a>::<wbr><a class="trait" href="#">PhaseItem</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="src" href="../../../src/maplibre/render/render_phase/draw.rs.html#19-26">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait PhaseItem {
|
||
type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.sort_key" class="fn">sort_key</a>(&self) -> Self::<a class="associatedtype" href="draw/trait.PhaseItem.html#associatedtype.SortKey" title="type maplibre::render::render_phase::draw::PhaseItem::SortKey">SortKey</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.draw_function" class="fn">draw_function</a>(&self) -> &dyn <a class="trait" href="draw/trait.Draw.html" title="trait maplibre::render::render_phase::draw::Draw">Draw</a><Self>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>An item which will be drawn to the screen. A phase item should be queued up for rendering
|
||
during the <a href="crate::RenderStageLabel::Queue"><code>RenderStageLabel::Queue</code></a> stage.
|
||
Afterwards it will be sorted and rendered automatically in the
|
||
<a href="crate::RenderStageLabel::PhaseSort"><code>RenderStageLabel::PhaseSort</code></a> stage and
|
||
<a href="crate::RenderStageLabel::Render"><code>RenderStageLabel::Render</code></a> stage, respectively.</p>
|
||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.SortKey" class="method"><a class="src rightside" href="../../../src/maplibre/render/render_phase/draw.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a></h4></section></summary><div class="docblock"><p>The type used for ordering the items. The smallest values are drawn first.</p>
|
||
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.sort_key" class="method"><a class="src rightside" href="../../../src/maplibre/render/render_phase/draw.rs.html#23">source</a><h4 class="code-header">fn <a href="#tymethod.sort_key" class="fn">sort_key</a>(&self) -> Self::<a class="associatedtype" href="draw/trait.PhaseItem.html#associatedtype.SortKey" title="type maplibre::render::render_phase::draw::PhaseItem::SortKey">SortKey</a></h4></section></summary><div class="docblock"><p>Determines the order in which the items are drawn during the corresponding <a href="struct.RenderPhase.html" title="struct maplibre::render::render_phase::RenderPhase"><code>RenderPhase</code></a>.</p>
|
||
</div></details><section id="tymethod.draw_function" class="method"><a class="src rightside" href="../../../src/maplibre/render/render_phase/draw.rs.html#25">source</a><h4 class="code-header">fn <a href="#tymethod.draw_function" class="fn">draw_function</a>(&self) -> &dyn <a class="trait" href="draw/trait.Draw.html" title="trait maplibre::render::render_phase::draw::Draw">Draw</a><Self></h4></section></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-PhaseItem-for-TileDebugItem" class="impl"><a class="src rightside" href="../../../src/maplibre/debug/mod.rs.html#54-64">source</a><a href="#impl-PhaseItem-for-TileDebugItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="draw/trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem">PhaseItem</a> for <a class="struct" href="../../debug/struct.TileDebugItem.html" title="struct maplibre::debug::TileDebugItem">TileDebugItem</a></h3></section></summary><div class="impl-items"><section id="associatedtype.SortKey-1" class="associatedtype trait-impl"><a href="#associatedtype.SortKey-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a> = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-PhaseItem-for-LayerItem" class="impl"><a class="src rightside" href="../../../src/maplibre/render/render_phase/mod.rs.html#59-69">source</a><a href="#impl-PhaseItem-for-LayerItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="draw/trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem">PhaseItem</a> for <a class="struct" href="struct.LayerItem.html" title="struct maplibre::render::render_phase::LayerItem">LayerItem</a></h3></section></summary><div class="impl-items"><section id="associatedtype.SortKey-2" class="associatedtype trait-impl"><a href="#associatedtype.SortKey-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a> = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-PhaseItem-for-TileMaskItem" class="impl"><a class="src rightside" href="../../../src/maplibre/render/render_phase/mod.rs.html#76-86">source</a><a href="#impl-PhaseItem-for-TileMaskItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="draw/trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem">PhaseItem</a> for <a class="struct" href="struct.TileMaskItem.html" title="struct maplibre::render::render_phase::TileMaskItem">TileMaskItem</a></h3></section></summary><div class="impl-items"><section id="associatedtype.SortKey-3" class="associatedtype trait-impl"><a href="#associatedtype.SortKey-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a> = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section></div></details></div><script src="../../../trait.impl/maplibre/render/render_phase/draw/trait.PhaseItem.js" async></script></section></div></main></body></html> |