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

Deploying to gh-pages from @ maplibre/maplibre-rs@1e438056df 🚀

Browse Source
This commit is contained in:
maxammann 2022-09-07 16:17:26 +00:00
parent 9277f01300
commit 7215904147
5 changed files with 27 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/api/maplibre/render/settings/struct.Features.html
View File

@ -128,10 +128,14 @@ the consequences.</p>
</ul>
<p>This is a native only feature.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.TEXTURE_BINDING_ARRAY" class="associatedconstant has-srclink"><a href="#associatedconstant.TEXTURE_BINDING_ARRAY" class="anchor"></a><h4 class="code-header">pub const <a href="#associatedconstant.TEXTURE_BINDING_ARRAY" class="constant">TEXTURE_BINDING_ARRAY</a>: <a class="struct" href="struct.Features.html" title="struct maplibre::render::settings::Features">Features</a> = Self{bits: 1 << 17,}</h4></section></summary><div class="docblock"><p>Allows the user to create uniform arrays of textures in shaders:</p>
<p>eg. <code>uniform texture2D textures[10]</code>.</p>
<p>ex.
<code>var textures: binding_array&lt;texture_2d&lt;f32&gt;, 10&gt;</code> (WGSL)<br />
<code>uniform texture2D textures[10]</code> (GLSL)</p>
<p>If <a href="struct.Features.html#associatedconstant.STORAGE_RESOURCE_BINDING_ARRAY" title="Features::STORAGE_RESOURCE_BINDING_ARRAY"><code>Features::STORAGE_RESOURCE_BINDING_ARRAY</code></a> is supported as well as this, the user
may also create uniform arrays of storage textures.</p>
<p>eg. <code>uniform image2D textures[10]</code>.</p>
<p>ex.
<code>var textures: array&lt;texture_storage_2d&lt;f32, write&gt;, 10&gt;</code> (WGSL)<br />
<code>uniform image2D textures[10]</code> (GLSL)</p>
<p>This capability allows them to exist and to be indexed by dynamically uniform
values.</p>
<p>Supported platforms:</p>
@ -142,12 +146,16 @@ values.</p>
</ul>
<p>This is a native only feature.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.BUFFER_BINDING_ARRAY" class="associatedconstant has-srclink"><a href="#associatedconstant.BUFFER_BINDING_ARRAY" class="anchor"></a><h4 class="code-header">pub const <a href="#associatedconstant.BUFFER_BINDING_ARRAY" class="constant">BUFFER_BINDING_ARRAY</a>: <a class="struct" href="struct.Features.html" title="struct maplibre::render::settings::Features">Features</a> = Self{bits: 1 << 18,}</h4></section></summary><div class="docblock"><p>Allows the user to create arrays of buffers in shaders:</p>
<p>eg. <code>uniform myBuffer { .... } buffer_array[10]</code>.</p>
<p>ex.
<code>var&lt;uniform&gt; buffer_array: array&lt;MyBuffer, 10&gt;</code> (WGSL)<br />
<code>uniform myBuffer { ... } buffer_array[10]</code> (GLSL)</p>
<p>This capability allows them to exist and to be indexed by dynamically uniform
values.</p>
<p>If <a href="struct.Features.html#associatedconstant.STORAGE_RESOURCE_BINDING_ARRAY" title="Features::STORAGE_RESOURCE_BINDING_ARRAY"><code>Features::STORAGE_RESOURCE_BINDING_ARRAY</code></a> is supported as well as this, the user
may also create arrays of storage buffers.</p>
<p>eg. <code>buffer myBuffer { ... } buffer_array[10]</code></p>
<p>ex.
<code>var&lt;storage&gt; buffer_array: array&lt;MyBuffer, 10&gt;</code> (WGSL)<br />
<code>buffer myBuffer { ... } buffer_array[10]</code> (GLSL)</p>
<p>Supported platforms:</p>
<ul>
<li>DX12</li>
@ -166,14 +174,14 @@ values.</p>
</ul>
<p>This is a native only feature.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING" class="associatedconstant has-srclink"><a href="#associatedconstant.SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING" class="anchor"></a><h4 class="code-header">pub const <a href="#associatedconstant.SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING" class="constant">SAMPLED_TEXTURE_AND_STORAGE_BUFFER_ARRAY_NON_UNIFORM_INDEXING</a>: <a class="struct" href="struct.Features.html" title="struct maplibre::render::settings::Features">Features</a> = Self{bits: 1 << 20,}</h4></section></summary><div class="docblock"><p>Allows shaders to index sampled texture and storage buffer resource arrays with dynamically non-uniform values:</p>
<p>eg. <code>texture_array[vertex_data]</code></p>
<p>ex. <code>texture_array[vertex_data]</code></p>
<p>In order to use this capability, the corresponding GLSL extension must be enabled like so:</p>
<p><code>#extension GL_EXT_nonuniform_qualifier : require</code></p>
<p>and then used either as <code>nonuniformEXT</code> qualifier in variable declaration:</p>
<p>eg. <code>layout(location = 0) nonuniformEXT flat in int vertex_data;</code></p>
<p>ex. <code>layout(location = 0) nonuniformEXT flat in int vertex_data;</code></p>
<p>or as <code>nonuniformEXT</code> constructor:</p>
<p>eg. <code>texture_array[nonuniformEXT(vertex_data)]</code></p>
<p>HLSL does not need any extension.</p>
<p>ex. <code>texture_array[nonuniformEXT(vertex_data)]</code></p>
<p>WGSL and HLSL do not need any extension.</p>
<p>Supported platforms:</p>
<ul>
<li>DX12</li>
@ -182,14 +190,14 @@ values.</p>
</ul>
<p>This is a native only feature.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING" class="associatedconstant has-srclink"><a href="#associatedconstant.UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING" class="anchor"></a><h4 class="code-header">pub const <a href="#associatedconstant.UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING" class="constant">UNIFORM_BUFFER_AND_STORAGE_TEXTURE_ARRAY_NON_UNIFORM_INDEXING</a>: <a class="struct" href="struct.Features.html" title="struct maplibre::render::settings::Features">Features</a> = Self{bits: 1 << 21,}</h4></section></summary><div class="docblock"><p>Allows shaders to index uniform buffer and storage texture resource arrays with dynamically non-uniform values:</p>
<p>eg. <code>texture_array[vertex_data]</code></p>
<p>ex. <code>texture_array[vertex_data]</code></p>
<p>In order to use this capability, the corresponding GLSL extension must be enabled like so:</p>
<p><code>#extension GL_EXT_nonuniform_qualifier : require</code></p>
<p>and then used either as <code>nonuniformEXT</code> qualifier in variable declaration:</p>
<p>eg. <code>layout(location = 0) nonuniformEXT flat in int vertex_data;</code></p>
<p>ex. <code>layout(location = 0) nonuniformEXT flat in int vertex_data;</code></p>
<p>or as <code>nonuniformEXT</code> constructor:</p>
<p>eg. <code>texture_array[nonuniformEXT(vertex_data)]</code></p>
<p>HLSL does not need any extension.</p>
<p>ex. <code>texture_array[nonuniformEXT(vertex_data)]</code></p>
<p>WGSL and HLSL do not need any extension.</p>
<p>Supported platforms:</p>
<ul>
<li>DX12</li>
@ -350,6 +358,7 @@ bandwidth usage.</p>
<p>Supported Platforms:</p>
<ul>
<li>Metal</li>
<li>Vulkan</li>
</ul>
<p>This is a native-only feature.</p>
</div></details><details class="rustdoc-toggle" open><summary><section id="associatedconstant.WRITE_TIMESTAMP_INSIDE_PASSES" class="associatedconstant has-srclink"><a href="#associatedconstant.WRITE_TIMESTAMP_INSIDE_PASSES" class="anchor"></a><h4 class="code-header">pub const <a href="#associatedconstant.WRITE_TIMESTAMP_INSIDE_PASSES" class="constant">WRITE_TIMESTAMP_INSIDE_PASSES</a>: <a class="struct" href="struct.Features.html" title="struct maplibre::render::settings::Features">Features</a> = Self{bits: 1 << 41,}</h4></section></summary><div class="docblock"><p>Allows for timestamp queries inside renderpasses. Metal does not allow this

4
docs/api/maplibre/window/trait.HeadedMapWindow.html
View File

@ -5,10 +5,10 @@
<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="#">HeadedMapWindow</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.RawWindow">RawWindow</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.inner">inner</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::window</a></h2><div id="sidebar-vars" data-name="HeadedMapWindow" 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">window</a>::<wbr><a class="trait" href="#">HeadedMapWindow</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/window.rs.html#14-18">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 HeadedMapWindow: <a class="trait" href="trait.MapWindow.html" title="trait maplibre::window::MapWindow">MapWindow</a> {
type <a href="#associatedtype.RawWindow" class="associatedtype">RawWindow</a>: HasRawWindowHandle;
type <a href="#associatedtype.RawWindow" class="associatedtype">RawWindow</a>: HasRawWindowHandle + HasRawDisplayHandle;
fn <a href="#tymethod.inner" class="fnname">inner</a>(&amp;self) -&gt; &amp;Self::<a class="associatedtype" href="trait.HeadedMapWindow.html#associatedtype.RawWindow" title="type maplibre::window::HeadedMapWindow::RawWindow">RawWindow</a>;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Window which references a physical <code>RawWindow</code>. This is only implemented by headed windows and
not by headless windows.</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"><div id="associatedtype.RawWindow" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/maplibre/window.rs.html#15">source</a></div><h4 class="code-header">type <a href="#associatedtype.RawWindow" class="associatedtype">RawWindow</a>: HasRawWindowHandle</h4></div></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.inner" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/maplibre/window.rs.html#17">source</a></div><h4 class="code-header">fn <a href="#tymethod.inner" class="fnname">inner</a>(&amp;self) -&gt; &amp;Self::<a class="associatedtype" href="trait.HeadedMapWindow.html#associatedtype.RawWindow" title="type maplibre::window::HeadedMapWindow::RawWindow">RawWindow</a></h4></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../implementors/maplibre/window/trait.HeadedMapWindow.js" data-ignore-extern-crates="" 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.1 (e092d0b6b 2022-07-16)" ></div>
</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"><div id="associatedtype.RawWindow" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/maplibre/window.rs.html#15">source</a></div><h4 class="code-header">type <a href="#associatedtype.RawWindow" class="associatedtype">RawWindow</a>: HasRawWindowHandle + HasRawDisplayHandle</h4></div></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><div id="tymethod.inner" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/maplibre/window.rs.html#17">source</a></div><h4 class="code-header">fn <a href="#tymethod.inner" class="fnname">inner</a>(&amp;self) -&gt; &amp;Self::<a class="associatedtype" href="trait.HeadedMapWindow.html#associatedtype.RawWindow" title="type maplibre::window::HeadedMapWindow::RawWindow">RawWindow</a></h4></div></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../implementors/maplibre/window/trait.HeadedMapWindow.js" data-ignore-extern-crates="" 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.1 (e092d0b6b 2022-07-16)" ></div>
</body></html>

2
docs/api/src/maplibre/io/geometry_index.rs.html
View File

@ -589,7 +589,7 @@
}
<span class="doccomment">/// End of feature geometry processing.</span>
<span class="kw">fn</span> <span class="ident">geometry_end</span>(<span class="kw-2">&amp;mut</span> <span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span><span class="op">&lt;</span>(), <span class="ident">GeozeroError</span><span class="op">&gt;</span> {
<span class="kw">let</span> <span class="ident">geometry</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">geo_writer</span>.<span class="ident">geometry</span>().<span class="ident">cloned</span>().<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">geometry</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">geo_writer</span>.<span class="ident">take_geometry</span>().<span class="ident">unwrap</span>();
<span class="kw">match</span> <span class="ident">geometry</span> {
<span class="ident">Geometry::Polygon</span>(<span class="ident">polygon</span>) =&gt; <span class="self">self</span>.<span class="ident">geometries</span>.<span class="ident">push</span>(

2
docs/api/src/maplibre/platform/noweb/mod.rs.html
View File

@ -37,7 +37,7 @@
.<span class="ident">enable_time</span>()
.<span class="ident">on_thread_start</span>(<span class="op">|</span><span class="op">|</span> {
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">&quot;trace&quot;</span>)]</span>
<span class="ident">tracy_client::set_thread_name</span>(<span class="string">&quot;tokio-runtime-worker&quot;</span>);
<span class="macro">tracy_client::set_thread_name!</span>(<span class="string">&quot;tokio-runtime-worker&quot;</span>);
})
.<span class="ident">build</span>()
.<span class="ident">unwrap</span>()

4
docs/api/src/maplibre/window.rs.html
View File

@ -66,7 +66,7 @@
<span id="61">61</span>
</pre><pre class="rust"><code><span class="doccomment">//! Utilities for the window system.</span>
<span class="kw">use</span> <span class="ident">raw_window_handle::HasRawWindowHandle</span>;
<span class="kw">use</span> <span class="ident">raw_window_handle</span>::{<span class="ident">HasRawDisplayHandle</span>, <span class="ident">HasRawWindowHandle</span>};
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">HttpClient</span>, <span class="ident">InteractiveMapSchedule</span>, <span class="ident">ScheduleMethod</span>};
@ -78,7 +78,7 @@
<span class="doccomment">/// Window which references a physical `RawWindow`. This is only implemented by headed windows and</span>
<span class="doccomment">/// not by headless windows.</span>
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">HeadedMapWindow</span>: <span class="ident">MapWindow</span> {
<span class="kw">type</span> <span class="ident">RawWindow</span>: <span class="ident">HasRawWindowHandle</span>;
<span class="kw">type</span> <span class="ident">RawWindow</span>: <span class="ident">HasRawWindowHandle</span> <span class="op">+</span> <span class="ident">HasRawDisplayHandle</span>;
<span class="kw">fn</span> <span class="ident">inner</span>(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="ident"><span class="self">Self</span>::RawWindow</span>;
}