Deploying to master from @ gfx-rs/wgpu@49b773f 🚀

Author: ErichDonGubler

doc/search-index.js

@@ -198,7 +198,16 @@
 <a href="#197" id="197">197</a>
 <a href="#198" id="198">198</a>
 <a href="#199" id="199">199</a>
-<a href="#200" id="200">200</a></pre></div><pre class="rust"><code><span class="kw">use </span>core::future::Future;
+<a href="#200" id="200">200</a>
+<a href="#201" id="201">201</a>
+<a href="#202" id="202">202</a>
+<a href="#203" id="203">203</a>
+<a href="#204" id="204">204</a>
+<a href="#205" id="205">205</a>
+<a href="#206" id="206">206</a>
+<a href="#207" id="207">207</a>
+<a href="#208" id="208">208</a>
+<a href="#209" id="209">209</a></pre></div><pre class="rust"><code><span class="kw">use </span>core::future::Future;
 <span class="attr">#[cfg(wgpu_core)]
 </span><span class="kw">use </span>core::ops::Deref;
 
@@ -266,14 +275,14 @@
         }
     }
 
-    <span class="doccomment">/// Create a wgpu [`Device`] and [`Queue`] from a wgpu-hal `OpenDevice`
+    <span class="doccomment">/// Create a wgpu [`Device`] and [`Queue`] from a wgpu-hal [`hal::OpenDevice`].
     ///
     /// # Safety
     ///
     /// - `hal_device` must be created from this adapter internal handle.
-    /// - `desc.features` must be a subset of `hal_device` features.
+    /// - `desc.features` must be a subset of `hal_device`'s supported features.
     </span><span class="attr">#[cfg(wgpu_core)]
-    </span><span class="kw">pub unsafe fn </span>create_device_from_hal&lt;A: wgc::hal_api::HalApi&gt;(
+    </span><span class="kw">pub unsafe fn </span>create_device_from_hal&lt;A: hal::Api&gt;(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         hal_device: hal::OpenDevice&lt;A&gt;,
         desc: <span class="kw-2">&amp;</span>DeviceDescriptor&lt;<span class="lifetime">'_</span>&gt;,
@@ -303,6 +312,15 @@
     /// Returns a guard that dereferences to the type of the hal backend
     /// which implements [`A::Adapter`].
     ///
+    /// # Types
+    ///
+    /// The returned type depends on the backend:
+    ///
+    </span><span class="attr">#[doc = <span class="macro">crate::hal_type_vulkan!</span>(<span class="string">"Adapter"</span>)]
+    #[doc = <span class="macro">crate::hal_type_metal!</span>(<span class="string">"Adapter"</span>)]
+    #[doc = <span class="macro">crate::hal_type_dx12!</span>(<span class="string">"Adapter"</span>)]
+    #[doc = <span class="macro">crate::hal_type_gles!</span>(<span class="string">"Adapter"</span>)]
+    </span><span class="doccomment">///
     /// # Errors
     ///
     /// This method will return None if:
@@ -318,7 +336,7 @@
     ///
     /// [`A::Adapter`]: hal::Api::Adapter
     </span><span class="attr">#[cfg(wgpu_core)]
-    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: wgc::hal_api::HalApi&gt;(
+    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: hal::Api&gt;(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
     ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::Adapter&gt; + WasmNotSendSync&gt; {
         <span class="kw">let </span>adapter = <span class="self">self</span>.inner.as_core_opt()<span class="question-mark">?</span>;

doc/search.desc/wgpu/wgpu-desc-0-.js

@@ -276,7 +276,16 @@
 <a href="#275" id="275">275</a>
 <a href="#276" id="276">276</a>
 <a href="#277" id="277">277</a>
-<a href="#278" id="278">278</a></pre></div><pre class="rust"><code><span class="attr">#[cfg(wgpu_core)]
+<a href="#278" id="278">278</a>
+<a href="#279" id="279">279</a>
+<a href="#280" id="280">280</a>
+<a href="#281" id="281">281</a>
+<a href="#282" id="282">282</a>
+<a href="#283" id="283">283</a>
+<a href="#284" id="284">284</a>
+<a href="#285" id="285">285</a>
+<a href="#286" id="286">286</a>
+<a href="#287" id="287">287</a></pre></div><pre class="rust"><code><span class="attr">#[cfg(wgpu_core)]
 </span><span class="kw">use </span>core::ops::Deref;
 
 <span class="kw">use </span>alloc::{boxed::Box, vec::Vec};
@@ -440,6 +449,15 @@
     /// Returns a guard that dereferences to the type of the hal backend
     /// which implements [`A::AccelerationStructure`].
     ///
+    /// # Types
+    ///
+    /// The returned type depends on the backend:
+    ///
+    </span><span class="attr">#[doc = <span class="macro">crate::hal_type_vulkan!</span>(<span class="string">"AccelerationStructure"</span>)]
+    #[doc = <span class="macro">crate::hal_type_metal!</span>(<span class="string">"AccelerationStructure"</span>)]
+    #[doc = <span class="macro">crate::hal_type_dx12!</span>(<span class="string">"AccelerationStructure"</span>)]
+    #[doc = <span class="macro">crate::hal_type_gles!</span>(<span class="string">"AccelerationStructure"</span>)]
+    </span><span class="doccomment">///
     /// # Deadlocks
     ///
     /// - The returned guard holds a read-lock on a device-local "destruction"
@@ -461,7 +479,7 @@
     ///
     /// [`A::AccelerationStructure`]: hal::Api::AccelerationStructure
     </span><span class="attr">#[cfg(wgpu_core)]
-    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: wgc::hal_api::HalApi&gt;(
+    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: hal::Api&gt;(
         <span class="kw-2">&amp;mut </span><span class="self">self</span>,
     ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::AccelerationStructure&gt; + WasmNotSendSync&gt; {
         <span class="kw">let </span>blas = <span class="self">self</span>.inner.as_core_opt()<span class="question-mark">?</span>;

doc/search.desc/wgpu/wgpu-desc-1-.js

@@ -914,7 +914,16 @@
 <a href="#913" id="913">913</a>
 <a href="#914" id="914">914</a>
 <a href="#915" id="915">915</a>
-<a href="#916" id="916">916</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{boxed::Box, sync::Arc, vec::Vec};
+<a href="#916" id="916">916</a>
+<a href="#917" id="917">917</a>
+<a href="#918" id="918">918</a>
+<a href="#919" id="919">919</a>
+<a href="#920" id="920">920</a>
+<a href="#921" id="921">921</a>
+<a href="#922" id="922">922</a>
+<a href="#923" id="923">923</a>
+<a href="#924" id="924">924</a>
+<a href="#925" id="925">925</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{boxed::Box, sync::Arc, vec::Vec};
 <span class="kw">use </span>core::{
     error, fmt,
     ops::{Bound, Deref, DerefMut, Range, RangeBounds},
@@ -1124,6 +1133,15 @@
     /// Returns a guard that dereferences to the type of the hal backend
     /// which implements [`A::Buffer`].
     ///
+    /// # Types
+    ///
+    /// The returned type depends on the backend:
+    ///
+    </span><span class="attr">#[doc = <span class="macro">crate::hal_type_vulkan!</span>(<span class="string">"Buffer"</span>)]
+    #[doc = <span class="macro">crate::hal_type_metal!</span>(<span class="string">"Buffer"</span>)]
+    #[doc = <span class="macro">crate::hal_type_dx12!</span>(<span class="string">"Buffer"</span>)]
+    #[doc = <span class="macro">crate::hal_type_gles!</span>(<span class="string">"Buffer"</span>)]
+    </span><span class="doccomment">///
     /// # Deadlocks
     ///
     /// - The returned guard holds a read-lock on a device-local "destruction"
@@ -1146,7 +1164,7 @@
     ///
     /// [`A::Buffer`]: hal::Api::Buffer
     </span><span class="attr">#[cfg(wgpu_core)]
-    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: wgc::hal_api::HalApi&gt;(
+    </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: hal::Api&gt;(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
     ) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw">impl </span>Deref&lt;Target = A::Buffer&gt; + WasmNotSendSync&gt; {
         <span class="kw">let </span>buffer = <span class="self">self</span>.inner.as_core_opt()<span class="question-mark">?</span>;