19 lines
12 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="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."><meta name="keywords" content="rust, rustlang, rust-lang, PhaseItem"><title>PhaseItem in maplibre::render::render_phase::draw - 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 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">&#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="#">PhaseItem</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.SortKey">SortKey</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.sort_key">sort_key</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul><li><a href="#impl-PhaseItem-for-(IndexEntry%2C%20TileShape)">(IndexEntry, TileShape)</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In maplibre::render::render_phase::draw</a></h2><div id="sidebar-vars" data-name="PhaseItem" data-ty="trait" 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">Trait <a href="../../../index.html">maplibre</a>::<wbr><a href="../../index.html">render</a>::<wbr><a href="../index.html">render_phase</a>::<wbr><a href="index.html">draw</a>::<wbr><a class="trait" href="#">PhaseItem</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/render_phase/draw.rs.html#18-23">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait PhaseItem {
type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a>: <a class="trait" href="https://doc.rust-lang.org/1.62.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>;
fn <a href="#tymethod.sort_key" class="fnname">sort_key</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.PhaseItem.html#associatedtype.SortKey" title="type maplibre::render::render_phase::draw::PhaseItem::SortKey">SortKey</a>;
}</code></pre></div><details class="rustdoc-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="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.SortKey" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../../src/maplibre/render/render_phase/draw.rs.html#20">source</a></div><h4 class="code-header">type <a href="#associatedtype.SortKey" class="associatedtype">SortKey</a>: <a class="trait" href="https://doc.rust-lang.org/1.62.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a></h4></div></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="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.sort_key" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../../src/maplibre/render/render_phase/draw.rs.html#22">source</a></div><h4 class="code-header">fn <a href="#tymethod.sort_key" class="fnname">sort_key</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.PhaseItem.html#associatedtype.SortKey" title="type maplibre::render::render_phase::draw::PhaseItem::SortKey">SortKey</a></h4></div></summary><div class="docblock"><p>Determines the order in which the items are drawn during the corresponding <a href="../struct.RenderPhase.html"><code>RenderPhase</code></a>.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PhaseItem-for-(IndexEntry%2C%20TileShape)" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../../src/maplibre/render/render_commands.rs.html#17-23">source</a></span><a href="#impl-PhaseItem-for-(IndexEntry%2C%20TileShape)" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem">PhaseItem</a> for <a class="primitive" href="https://doc.rust-lang.org/1.62.0/std/primitive.tuple.html">(</a><a class="struct" href="../../resource/buffer_pool/struct.IndexEntry.html" title="struct maplibre::render::resource::buffer_pool::IndexEntry">IndexEntry</a>, <a class="struct" href="../../tile_view_pattern/struct.TileShape.html" title="struct maplibre::render::tile_view_pattern::TileShape">TileShape</a><a class="primitive" href="https://doc.rust-lang.org/1.62.0/std/primitive.tuple.html">)</a></h3></section></summary><div class="impl-items"><section id="associatedtype.SortKey-1" class="associatedtype trait-impl has-srclink"><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.62.0/std/primitive.u32.html">u32</a></h4></section><section id="method.sort_key" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="../../../../src/maplibre/render/render_commands.rs.html#20-22">source</a></span><a href="#method.sort_key" class="anchor"></a><h4 class="code-header">fn <a href="#tymethod.sort_key" class="fnname">sort_key</a>(&amp;self) -&gt; Self::<a class="associatedtype" href="trait.PhaseItem.html#associatedtype.SortKey" title="type maplibre::render::render_phase::draw::PhaseItem::SortKey">SortKey</a></h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-PhaseItem" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../../../src/maplibre/render/render_commands.rs.html#11-15">source</a></span><a href="#impl-PhaseItem" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.PhaseItem.html" title="trait maplibre::render::render_phase::draw::PhaseItem">PhaseItem</a> for <a class="struct" href="../../tile_view_pattern/struct.TileInView.html" title="struct maplibre::render::tile_view_pattern::TileInView">TileInView</a></h3></section></summary><div class="impl-items"><section id="associatedtype.SortKey-2" class="associatedtype trait-impl has-srclink"><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.62.0/std/primitive.unit.html">()</a></h4></section></div></details></div><script type="text/javascript" src="../../../../implementors/maplibre/render/render_phase/draw/trait.PhaseItem.js" data-ignore-extern-crates="std" async></script></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.62.0 (a8314ef7d 2022-06-27)" ></div>
</body></html>