Deploying to master from @ gfx-rs/wgpu@e446551 🚀

Author: cwfitzgerald

doc/search-index.js

@@ -1137,15 +1137,15 @@
     /// # Validation
     /// If any of the following is not satisfied a validation error is generated
     ///
-    /// The device ***must*** have [Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE] enabled.
-    /// if `sizes` is [BlasGeometrySizeDescriptors::Triangles] then the following must be satisfied
+    /// The device ***must*** have [`Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE`] enabled.
+    /// if `sizes` is [`BlasGeometrySizeDescriptors::Triangles`] then the following must be satisfied
     /// - For every geometry descriptor (for the purposes this is called `geo_desc`) of `sizes.descriptors` the following must be satisfied:
     ///     - `geo_desc.vertex_format` must be within allowed formats (allowed formats for a given feature set
-    ///       may be queried with [Features::allowed_vertex_formats_for_blas]).
+    ///       may be queried with [`Features::allowed_vertex_formats_for_blas`]).
     ///     - Both or neither of `geo_desc.index_format` and `geo_desc.index_count` must be provided.
     ///
-    /// [Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE]: wgt::Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE
-    /// [Features::allowed_vertex_formats_for_blas]: wgt::Features::allowed_vertex_formats_for_blas
+    /// [`Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE`]: wgt::Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE
+    /// [`Features::allowed_vertex_formats_for_blas`]: wgt::Features::allowed_vertex_formats_for_blas
     </span><span class="attr">#[must_use]
     </span><span class="kw">pub fn </span>create_blas(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
@@ -1166,9 +1166,9 @@
     /// # Validation
     /// If any of the following is not satisfied a validation error is generated
     ///
-    /// The device ***must*** have [Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE] enabled.
+    /// The device ***must*** have [`Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE`] enabled.
     ///
-    /// [Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE]: wgt::Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE
+    /// [`Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE`]: wgt::Features::EXPERIMENTAL_RAY_TRACING_ACCELERATION_STRUCTURE
     </span><span class="attr">#[must_use]
     </span><span class="kw">pub fn </span>create_tlas(<span class="kw-2">&amp;</span><span class="self">self</span>, desc: <span class="kw-2">&amp;</span>CreateTlasDescriptor&lt;<span class="lifetime">'_</span>&gt;) -&gt; Tlas {
         <span class="kw">let </span>tlas = <span class="self">self</span>.inner.create_tlas(desc);

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

@@ -178,9 +178,9 @@
 <span class="doccomment">/// Object debugging label.
 </span><span class="kw">pub type </span>Label&lt;<span class="lifetime">'a</span>&gt; = <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">'a </span>str&gt;;
 
-<span class="doccomment">/// A cute utility type that works just like PhantomData, but also
-/// implements Drop. This forces any lifetimes that are associated
-/// with the type to be used until the Drop impl is ran. This prevents
+<span class="doccomment">/// A cute utility type that works just like `PhantomData`, but also
+/// implements `Drop`. This forces any lifetimes that are associated
+/// with the type to be used until the `Drop` impl is ran. This prevents
 /// lifetimes from being shortened.
 </span><span class="attr">#[derive(Debug)]
 </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>PhantomDrop&lt;T&gt;(core::marker::PhantomData&lt;T&gt;);

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

@@ -577,7 +577,13 @@
 <a href="#576" id="576">576</a>
 <a href="#577" id="577">577</a>
 <a href="#578" id="578">578</a>
-<a href="#579" id="579">579</a></pre></div><pre class="rust"><code><span class="kw">use </span>core::ops::Range;
+<a href="#579" id="579">579</a>
+<a href="#580" id="580">580</a>
+<a href="#581" id="581">581</a>
+<a href="#582" id="582">582</a>
+<a href="#583" id="583">583</a>
+<a href="#584" id="584">584</a>
+<a href="#585" id="585">585</a></pre></div><pre class="rust"><code><span class="kw">use </span>core::ops::Range;
 
 <span class="kw">use crate</span>::<span class="kw-2">*</span>;
 <span class="kw">pub use </span>wgt::{LoadOp, Operations, StoreOp};
@@ -751,12 +757,13 @@
     <span class="doccomment">/// Draws primitives from the active vertex buffer(s).
     ///
     /// The active vertex buffer(s) can be set with [`RenderPass::set_vertex_buffer`].
-    /// Does not use an Index Buffer. If you need this see [`RenderPass::draw_indexed`]
+    /// This does not use an index buffer. If you need indexed drawing, see [`RenderPass::draw_indexed`]
     ///
-    /// Panics if vertices Range is outside of the range of the vertices range of any set vertex buffer.
+    /// Panics if `vertices` range is outside of the range of the vertices range of any set vertex buffer.
+    ///
+    /// - `vertices`: The range of vertices to draw.
+    /// - `instances`: Range of instances to draw. Use `0..1` if instance buffers are not used.
     ///
-    /// vertices: The range of vertices to draw.
-    /// instances: Range of Instances to draw. Use 0..1 if instance buffers are not used.
     /// E.g.of how its used internally
     /// ```rust ignore
     /// for instance_id in instance_range {
@@ -778,11 +785,12 @@
     /// The active index buffer can be set with [`RenderPass::set_index_buffer`]
     /// The active vertex buffers can be set with [`RenderPass::set_vertex_buffer`].
     ///
-    /// Panics if indices Range is outside of the range of the indices range of any set index buffer.
+    /// Panics if `indices` range is outside of the range of the indices range of the set index buffer.
+    ///
+    /// - `indices`: The range of indices to draw.
+    /// - `base_vertex`: value added to each index value before indexing into the vertex buffers.
+    /// - `instances`: Range of instances to draw. Use `0..1` if instance buffers are not used.
     ///
-    /// indices: The range of indices to draw.
-    /// base_vertex: value added to each index value before indexing into the vertex buffers.
-    /// instances: Range of Instances to draw. Use 0..1 if instance buffers are not used.
     /// E.g.of how its used internally
     /// ```rust ignore
     /// for instance_id in instance_range {
@@ -809,7 +817,7 @@
     /// Indirect drawing has some caveats depending on the features available. We are not currently able to validate
     /// these and issue an error.
     /// - If [`Features::INDIRECT_FIRST_INSTANCE`] is not present on the adapter,
-    ///   [`DrawIndirect::first_instance`](crate::util::DrawIndirectArgs::first_instance) will be ignored.
+    ///   [`DrawIndirectArgs::first_instance`](crate::util::DrawIndirectArgs::first_instance) will be ignored.
     /// - If [`DownlevelFlags::VERTEX_AND_INSTANCE_INDEX_RESPECTS_RESPECTIVE_FIRST_VALUE_IN_INDIRECT_DRAW`] is not present on the adapter,
     ///   any use of `@builtin(vertex_index)` or `@builtin(instance_index)` in the vertex shader will have different values.
     ///
@@ -828,7 +836,7 @@
     /// Indirect drawing has some caveats depending on the features available. We are not currently able to validate
     /// these and issue an error.
     /// - If [`Features::INDIRECT_FIRST_INSTANCE`] is not present on the adapter,
-    ///   [`DrawIndexedIndirect::first_instance`](crate::util::DrawIndexedIndirectArgs::first_instance) will be ignored.
+    ///   [`DrawIndexedIndirectArgs::first_instance`](crate::util::DrawIndexedIndirectArgs::first_instance) will be ignored.
     /// - If [`DownlevelFlags::VERTEX_AND_INSTANCE_INDEX_RESPECTS_RESPECTIVE_FIRST_VALUE_IN_INDIRECT_DRAW`] is not present on the adapter,
     ///   any use of `@builtin(vertex_index)` or `@builtin(instance_index)` in the vertex shader will have different values.
     ///
@@ -951,7 +959,6 @@
     /// The active index buffer can be set with [`RenderPass::set_index_buffer`], while the active
     /// vertex buffers can be set with [`RenderPass::set_vertex_buffer`].
     ///
-    ///
     /// The structure expected in `indirect_buffer` must conform to [`DrawIndexedIndirectArgs`](crate::util::DrawIndexedIndirectArgs).
     ///
     /// These draw structures are expected to be tightly packed.
@@ -1048,13 +1055,15 @@
 
 <span class="kw">impl </span>RenderPass&lt;<span class="lifetime">'_</span>&gt; {
     <span class="doccomment">/// Start a occlusion query on this render pass. It can be ended with
-    /// `end_occlusion_query`. Occlusion queries may not be nested.
+    /// [`end_occlusion_query`](Self::end_occlusion_query).
+    /// Occlusion queries may not be nested.
     </span><span class="kw">pub fn </span>begin_occlusion_query(<span class="kw-2">&amp;mut </span><span class="self">self</span>, query_index: u32) {
         <span class="self">self</span>.inner.begin_occlusion_query(query_index);
     }
 
     <span class="doccomment">/// End the occlusion query on this render pass. It can be started with
-    /// `begin_occlusion_query`. Occlusion queries may not be nested.
+    /// [`begin_occlusion_query`](Self::begin_occlusion_query).
+    /// Occlusion queries may not be nested.
     </span><span class="kw">pub fn </span>end_occlusion_query(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
         <span class="self">self</span>.inner.end_occlusion_query();
     }
@@ -1063,14 +1072,16 @@
 <span class="doccomment">/// [`Features::PIPELINE_STATISTICS_QUERY`] must be enabled on the device in order to call these functions.
 </span><span class="kw">impl </span>RenderPass&lt;<span class="lifetime">'_</span>&gt; {
     <span class="doccomment">/// Start a pipeline statistics query on this render pass. It can be ended with
-    /// `end_pipeline_statistics_query`. Pipeline statistics queries may not be nested.
+    /// [`end_pipeline_statistics_query`](Self::end_pipeline_statistics_query).
+    /// Pipeline statistics queries may not be nested.
     </span><span class="kw">pub fn </span>begin_pipeline_statistics_query(<span class="kw-2">&amp;mut </span><span class="self">self</span>, query_set: <span class="kw-2">&amp;</span>QuerySet, query_index: u32) {
         <span class="self">self</span>.inner
             .begin_pipeline_statistics_query(<span class="kw-2">&amp;</span>query_set.inner, query_index);
     }
 
     <span class="doccomment">/// End the pipeline statistics query on this render pass. It can be started with
-    /// `begin_pipeline_statistics_query`. Pipeline statistics queries may not be nested.
+    /// [`begin_pipeline_statistics_query`](Self::begin_pipeline_statistics_query).
+    /// Pipeline statistics queries may not be nested.
     </span><span class="kw">pub fn </span>end_pipeline_statistics_query(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
         <span class="self">self</span>.inner.end_pipeline_statistics_query();
     }
@@ -1079,7 +1090,8 @@
 <span class="doccomment">/// Describes the timestamp writes of a render pass.
 ///
 /// For use with [`RenderPassDescriptor`].
-/// At least one of `beginning_of_pass_write_index` and `end_of_pass_write_index` must be `Some`.
+/// At least one of [`Self::beginning_of_pass_write_index`] and [`Self::end_of_pass_write_index`]
+/// must be `Some`.
 ///
 /// Corresponds to [WebGPU `GPURenderPassTimestampWrite`](
 /// https://gpuweb.github.io/gpuweb/#dictdef-gpurenderpasstimestampwrites).

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

@@ -71,12 +71,12 @@
 <span class="macro">crate::cmp::impl_eq_ord_hash_proxy!</span>(TextureView =&gt; .inner);
 
 <span class="kw">impl </span>TextureView {
-    <span class="doccomment">/// Returns the inner hal TextureView using a callback. The hal texture will be `None` if the
+    <span class="doccomment">/// Returns the inner hal `TextureView` using a callback. The hal texture will be `None` if the
     /// backend type argument does not match with this wgpu Texture
     ///
     /// # Safety
     ///
-    /// - The raw handle obtained from the hal TextureView must not be manually destroyed
+    /// - The raw handle obtained from the hal `TextureView` must not be manually destroyed
     </span><span class="attr">#[cfg(wgpu_core)]
     </span><span class="kw">pub unsafe fn </span>as_hal&lt;A: wgc::hal_api::HalApi, F: FnOnce(<span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>A::TextureView&gt;) -&gt; R, R&gt;(
         <span class="kw-2">&amp;</span><span class="self">self</span>,

doc/src/wgpu/api/device.rs.html

@@ -194,18 +194,18 @@
 
 <span class="doccomment">/// Entry for a top level acceleration structure build.
 /// Used with raw instance buffers for an unvalidated builds.
-/// See [TlasPackage] for the safe version.
+/// See [`TlasPackage`] for the safe version.
 </span><span class="kw">pub struct </span>TlasBuildEntry&lt;<span class="lifetime">'a</span>&gt; {
     <span class="doccomment">/// Reference to the acceleration structure.
     </span><span class="kw">pub </span>tlas: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Tlas,
-    <span class="doccomment">/// Reference to the raw instance buffer, each instance is similar to [TlasInstance] but contains a handle to the BLAS.
+    <span class="doccomment">/// Reference to the raw instance buffer, each instance is similar to [`TlasInstance`] but contains a handle to the BLAS.
     </span><span class="kw">pub </span>instance_buffer: <span class="kw-2">&amp;</span><span class="lifetime">'a </span>Buffer,
     <span class="doccomment">/// Number of instances in the instance buffer.
     </span><span class="kw">pub </span>instance_count: u32,
 }
 <span class="macro">static_assertions::assert_impl_all!</span>(TlasBuildEntry&lt;<span class="lifetime">'_</span>&gt;: WasmNotSendSync);
 
-<span class="doccomment">/// The safe version of TlasEntry, containing TlasInstances instead of a raw buffer.
+<span class="doccomment">/// The safe version of [`TlasBuildEntry`], containing [`TlasInstance`]s instead of a raw buffer.
 </span><span class="kw">pub struct </span>TlasPackage {
     <span class="kw">pub</span>(<span class="kw">crate</span>) tlas: Tlas,
     <span class="kw">pub</span>(<span class="kw">crate</span>) instances: Vec&lt;<span class="prelude-ty">Option</span>&lt;TlasInstance&gt;&gt;,
@@ -214,13 +214,13 @@
 <span class="macro">static_assertions::assert_impl_all!</span>(TlasPackage: WasmNotSendSync);
 
 <span class="kw">impl </span>TlasPackage {
-    <span class="doccomment">/// Construct [TlasPackage] consuming the [Tlas] (prevents modification of the [Tlas] without using this package).
+    <span class="doccomment">/// Construct [`TlasPackage`] consuming the [`Tlas`] (prevents modification of the [`Tlas`] without using this package).
     </span><span class="kw">pub fn </span>new(tlas: Tlas) -&gt; <span class="self">Self </span>{
         <span class="kw">let </span>max_instances = tlas.shared.max_instances;
         <span class="self">Self</span>::new_with_instances(tlas, <span class="macro">vec!</span>[<span class="prelude-val">None</span>; max_instances <span class="kw">as </span>usize])
     }
 
-    <span class="doccomment">/// Construct [TlasPackage] consuming the [Tlas] (prevents modification of the Tlas without using this package).
+    <span class="doccomment">/// Construct [`TlasPackage`] consuming the [`Tlas`] (prevents modification of the [`Tlas`] without using this package).
     /// This constructor moves the instances into the package (the number of instances needs to fit into tlas,
     /// otherwise when building a validation error will be raised).
     </span><span class="kw">pub fn </span>new_with_instances(tlas: Tlas, instances: Vec&lt;<span class="prelude-ty">Option</span>&lt;TlasInstance&gt;&gt;) -&gt; <span class="self">Self </span>{
@@ -242,7 +242,7 @@
     </span><span class="comment">// this recommendation is not useful yet, but is likely to be when ability to update arrives or possible optimisations for building get implemented.
     </span><span class="doccomment">/// For best performance it is recommended to prefer access to low elements and modify higher elements as little as possible.
     /// This can be done by ordering instances from the most to the least used. It is recommended
-    /// to use [Self::index_mut] unless the option if out of bounds is required
+    /// to use [`Self::index_mut`] unless the option if out of bounds is required
     </span><span class="kw">pub fn </span>get_mut_slice(<span class="kw-2">&amp;mut </span><span class="self">self</span>, range: Range&lt;usize&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span>[<span class="prelude-ty">Option</span>&lt;TlasInstance&gt;]&gt; {
         <span class="kw">if </span>range.end &gt; <span class="self">self</span>.instances.len() {
             <span class="kw">return </span><span class="prelude-val">None</span>;
@@ -259,7 +259,7 @@
     </span><span class="comment">// this recommendation is not useful yet, but is likely to be when ability to update arrives or possible optimisations for building get implemented.
     </span><span class="doccomment">/// For best performance it is recommended to prefer access to low elements and modify higher elements as little as possible.
     /// This can be done by ordering instances from the most to the least used. It is recommended
-    /// to use [Self::index_mut] unless the option if out of bounds is required
+    /// to use [`Self::index_mut`] unless the option if out of bounds is required
     </span><span class="kw">pub fn </span>get_mut_single(<span class="kw-2">&amp;mut </span><span class="self">self</span>, index: usize) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;mut </span><span class="prelude-ty">Option</span>&lt;TlasInstance&gt;&gt; {
         <span class="kw">if </span>index &gt;= <span class="self">self</span>.instances.len() {
             <span class="kw">return </span><span class="prelude-val">None</span>;
@@ -270,14 +270,14 @@
         <span class="prelude-val">Some</span>(<span class="kw-2">&amp;mut </span><span class="self">self</span>.instances[index])
     }
 
-    <span class="doccomment">/// Get the binding resource for the underling acceleration structure, to be used when creating a [BindGroup]
+    <span class="doccomment">/// Get the binding resource for the underling acceleration structure, to be used when creating a [`BindGroup`]
     ///
-    /// [BindGroup]: super::BindGroup
+    /// [`BindGroup`]: super::BindGroup
     </span><span class="kw">pub fn </span>as_binding(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; BindingResource&lt;<span class="lifetime">'_</span>&gt; {
         BindingResource::AccelerationStructure(<span class="kw-2">&amp;</span><span class="self">self</span>.tlas)
     }
 
-    <span class="doccomment">/// Get a reference to the underling [Tlas].
+    <span class="doccomment">/// Get a reference to the underling [`Tlas`].
     </span><span class="kw">pub fn </span>tlas(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Tlas {
         <span class="kw-2">&amp;</span><span class="self">self</span>.tlas
     }