Deploying to master from @ gfx-rs/wgpu@77d2b00 🚀

Author: andyleiserson

doc/search-index.js

@@ -518,7 +518,7 @@
 </span><span class="kw">use </span><span class="kw">crate</span>::device::trace::Command <span class="kw">as </span>TraceCommand;
 <span class="kw">use crate</span>::{
     api_log,
-    command::CommandEncoderError,
+    command::EncoderStateError,
     device::DeviceError,
     get_lowest_common_denom,
     global::Global,
@@ -587,7 +587,7 @@
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),
     <span class="attr">#[error(transparent)]
-    </span>CommandEncoderError(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(transparent)]
     </span>InvalidResource(<span class="attr">#[from] </span>InvalidResourceError),
 }

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

@@ -1332,12 +1332,14 @@
 <a href="#1331" id="1331">1331</a>
 <a href="#1332" id="1332">1332</a>
 <a href="#1333" id="1333">1333</a>
-<a href="#1334" id="1334">1334</a></pre></div><pre class="rust"><code><span class="kw">use </span>thiserror::Error;
+<a href="#1334" id="1334">1334</a>
+<a href="#1335" id="1335">1335</a></pre></div><pre class="rust"><code><span class="kw">use </span>thiserror::Error;
 <span class="kw">use </span>wgt::{BufferAddress, DynamicOffset};
 
 <span class="kw">use </span>alloc::{borrow::Cow, boxed::Box, sync::Arc, vec::Vec};
 <span class="kw">use </span>core::{fmt, str};
 
+<span class="kw">use </span><span class="kw">crate</span>::command::EncoderStateError;
 <span class="kw">use </span><span class="kw">crate</span>::ray_tracing::AsAction;
 <span class="kw">use crate</span>::{
     binding_model::{
@@ -1461,7 +1463,7 @@
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(<span class="string">"Parent encoder is invalid"</span>)]
     </span>InvalidParentEncoder,
     <span class="attr">#[error(<span class="string">"Bind group index {index} is greater than the device's requested `max_bind_group` limit {max}"</span>)]
@@ -1635,7 +1637,7 @@
 
         <span class="kw">match </span>cmd_buf.data.lock().lock_encoder() {
             <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; {}
-            <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>make_err(e, arc_desc),
+            <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>make_err(e.into(), arc_desc),
         };
 
         arc_desc.timestamp_writes = <span class="kw">match </span>desc

doc/src/wgpu_core/command/clear.rs.html

@@ -1083,7 +1083,16 @@
 <a href="#1082" id="1082">1082</a>
 <a href="#1083" id="1083">1083</a>
 <a href="#1084" id="1084">1084</a>
-<a href="#1085" id="1085">1085</a></pre></div><pre class="rust"><code><span class="kw">mod </span>allocator;
+<a href="#1085" id="1085">1085</a>
+<a href="#1086" id="1086">1086</a>
+<a href="#1087" id="1087">1087</a>
+<a href="#1088" id="1088">1088</a>
+<a href="#1089" id="1089">1089</a>
+<a href="#1090" id="1090">1090</a>
+<a href="#1091" id="1091">1091</a>
+<a href="#1092" id="1092">1092</a>
+<a href="#1093" id="1093">1093</a>
+<a href="#1094" id="1094">1094</a></pre></div><pre class="rust"><code><span class="kw">mod </span>allocator;
 <span class="kw">mod </span>bind;
 <span class="kw">mod </span>bundle;
 <span class="kw">mod </span>clear;
@@ -1180,15 +1189,15 @@
 
 <span class="kw">impl </span>CommandEncoderStatus {
     <span class="doccomment">/// Checks that the encoder is in the [`Self::Recording`] state.
-    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>record(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;RecordingGuard&lt;<span class="lifetime">'_</span>&gt;, CommandEncoderError&gt; {
+    </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>record(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;RecordingGuard&lt;<span class="lifetime">'_</span>&gt;, EncoderStateError&gt; {
         <span class="kw">match </span><span class="self">self </span>{
             <span class="self">Self</span>::Recording(<span class="kw">_</span>) =&gt; <span class="prelude-val">Ok</span>(RecordingGuard { inner: <span class="self">self </span>}),
             <span class="self">Self</span>::Locked(<span class="kw">_</span>) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Error;
-                <span class="prelude-val">Err</span>(CommandEncoderError::Locked)
+                <span class="prelude-val">Err</span>(EncoderStateError::Locked)
             }
-            <span class="self">Self</span>::Finished(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::NotRecording),
-            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Invalid),
+            <span class="self">Self</span>::Finished(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Ended),
+            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Invalid),
         }
     }
 
@@ -1207,18 +1216,18 @@
     <span class="doccomment">/// Locks the encoder by putting it in the [`Self::Locked`] state.
     ///
     /// Call [`Self::unlock_encoder`] to put the [`CommandBuffer`] back into the [`Self::Recording`] state.
-    </span><span class="kw">fn </span>lock_encoder(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), CommandEncoderError&gt; {
+    </span><span class="kw">fn </span>lock_encoder(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), EncoderStateError&gt; {
         <span class="kw">match </span>mem::replace(<span class="self">self</span>, <span class="self">Self</span>::Error) {
             <span class="self">Self</span>::Recording(inner) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Locked(inner);
                 <span class="prelude-val">Ok</span>(())
             }
             <span class="self">Self</span>::Finished(inner) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Finished(inner);
-                <span class="prelude-val">Err</span>(CommandEncoderError::NotRecording)
+                <span class="prelude-val">Err</span>(EncoderStateError::Ended)
             }
-            <span class="self">Self</span>::Locked(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Locked),
-            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Invalid),
+            <span class="self">Self</span>::Locked(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Locked),
+            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Invalid),
         }
     }
 
@@ -1227,18 +1236,18 @@
     /// This function is the unlocking counterpart to [`Self::lock_encoder`].
     ///
     /// It is only valid to call this function if the encoder is in the [`Self::Locked`] state.
-    </span><span class="kw">fn </span>unlock_encoder(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;RecordingGuard&lt;<span class="lifetime">'_</span>&gt;, CommandEncoderError&gt; {
+    </span><span class="kw">fn </span>unlock_encoder(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Result</span>&lt;RecordingGuard&lt;<span class="lifetime">'_</span>&gt;, EncoderStateError&gt; {
         <span class="kw">match </span>mem::replace(<span class="self">self</span>, <span class="self">Self</span>::Error) {
             <span class="self">Self</span>::Locked(inner) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Recording(inner);
                 <span class="prelude-val">Ok</span>(RecordingGuard { inner: <span class="self">self </span>})
             }
             <span class="self">Self</span>::Finished(inner) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Finished(inner);
-                <span class="prelude-val">Err</span>(CommandEncoderError::NotRecording)
+                <span class="prelude-val">Err</span>(EncoderStateError::Ended)
             }
-            <span class="self">Self</span>::Recording(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Invalid),
-            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Invalid),
+            <span class="self">Self</span>::Recording(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Invalid),
+            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Invalid),
         }
     }
 
@@ -1256,10 +1265,10 @@
             }
             <span class="self">Self</span>::Finished(inner) =&gt; {
                 <span class="kw-2">*</span><span class="self">self </span>= <span class="self">Self</span>::Finished(inner);
-                <span class="prelude-val">Err</span>(CommandEncoderError::NotRecording)
+                <span class="prelude-val">Err</span>(EncoderStateError::Ended.into())
             }
-            <span class="self">Self</span>::Locked(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Locked),
-            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(CommandEncoderError::Invalid),
+            <span class="self">Self</span>::Locked(<span class="kw">_</span>) =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Locked.into()),
+            <span class="self">Self</span>::Error =&gt; <span class="prelude-val">Err</span>(EncoderStateError::Invalid.into()),
         }
     }
 }
@@ -1810,18 +1819,27 @@
     }
 }
 
+<span class="doccomment">/// Errors related to the state of a command or pass encoder.
+</span><span class="attr">#[derive(Clone, Debug, Error)]
+#[non_exhaustive]
+</span><span class="kw">pub enum </span>EncoderStateError {
+    <span class="attr">#[error(<span class="string">"Encoder is invalid"</span>)]
+    </span>Invalid,
+    <span class="attr">#[error(<span class="string">"Encoding must not have ended"</span>)]
+    </span>Ended,
+
+    <span class="doccomment">/// Note: only command encoders can be locked (not pass encoders).
+    </span><span class="attr">#[error(<span class="string">"Encoder is locked by a previously created render/compute pass. Before recording any new commands, the pass must be ended."</span>)]
+    </span>Locked,
+}
+
 <span class="attr">#[derive(Clone, Debug, Error)]
 #[non_exhaustive]
 </span><span class="kw">pub enum </span>CommandEncoderError {
-    <span class="attr">#[error(<span class="string">"Command encoder is invalid"</span>)]
-    </span>Invalid,
-    <span class="attr">#[error(<span class="string">"Command encoder must be active"</span>)]
-    </span>NotRecording,
+    <span class="attr">#[error(transparent)]
+    </span>State(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),
-    <span class="attr">#[error(<span class="string">"Command encoder is locked by a previously created render/compute pass. Before recording any new commands, the pass must be ended."</span>)]
-    </span>Locked,
-
     <span class="attr">#[error(transparent)]
     </span>InvalidColorAttachment(<span class="attr">#[from] </span>ColorAttachmentError),
     <span class="attr">#[error(transparent)]

doc/src/wgpu_core/command/compute.rs.html

@@ -498,7 +498,7 @@
 <span class="attr">#[cfg(feature = <span class="string">"trace"</span>)]
 </span><span class="kw">use </span><span class="kw">crate</span>::device::trace::Command <span class="kw">as </span>TraceCommand;
 <span class="kw">use crate</span>::{
-    command::{CommandBuffer, CommandEncoderError},
+    command::{CommandBuffer, EncoderStateError},
     device::{DeviceError, MissingFeatures},
     global::Global,
     id,
@@ -590,7 +590,7 @@
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(transparent)]
     </span>MissingFeature(<span class="attr">#[from] </span>MissingFeatures),
     <span class="attr">#[error(<span class="string">"Error encountered while trying to use queries"</span>)]

doc/src/wgpu_core/command/mod.rs.html

@@ -3653,7 +3653,8 @@
 <a href="#3652" id="3652">3652</a>
 <a href="#3653" id="3653">3653</a>
 <a href="#3654" id="3654">3654</a>
-<a href="#3655" id="3655">3655</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{borrow::Cow, sync::Arc, vec::Vec};
+<a href="#3655" id="3655">3655</a>
+<a href="#3656" id="3656">3656</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{borrow::Cow, sync::Arc, vec::Vec};
 <span class="kw">use </span>core::{fmt, num::NonZeroU32, ops::Range, str};
 
 <span class="kw">use </span>arrayvec::ArrayVec;
@@ -3666,6 +3667,7 @@
 <span class="kw">use </span><span class="kw">crate</span>::binding_model::BindGroup;
 <span class="kw">use </span><span class="kw">crate</span>::command::{
     validate_and_begin_occlusion_query, validate_and_begin_pipeline_statistics_query,
+    EncoderStateError,
 };
 <span class="kw">use </span><span class="kw">crate</span>::init_tracker::BufferInitTrackerAction;
 <span class="kw">use </span><span class="kw">crate</span>::pipeline::{RenderPipeline, VertexStep};
@@ -4317,7 +4319,7 @@
     <span class="attr">#[error(transparent)]
     </span>ColorAttachment(<span class="attr">#[from] </span>ColorAttachmentError),
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(<span class="string">"Parent encoder is invalid"</span>)]
     </span>InvalidParentEncoder,
     <span class="attr">#[error(<span class="string">"The format of the {location} ({format:?}) is not resolvable"</span>)]
@@ -5265,7 +5267,7 @@
 
         <span class="kw">match </span>cmd_buf.data.lock().lock_encoder() {
             <span class="prelude-val">Ok</span>(<span class="kw">_</span>) =&gt; {}
-            <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>make_err(e, arc_desc),
+            <span class="prelude-val">Err</span>(e) =&gt; <span class="kw">return </span>make_err(e.into(), arc_desc),
         };
 
         <span class="kw">let </span>err = fill_arc_desc(hub, desc, <span class="kw-2">&amp;mut </span>arc_desc, <span class="kw-2">&amp;</span>cmd_buf.device).err();

doc/src/wgpu_core/command/query.rs.html

@@ -1189,11 +1189,7 @@
 <a href="#1188" id="1188">1188</a>
 <a href="#1189" id="1189">1189</a>
 <a href="#1190" id="1190">1190</a>
-<a href="#1191" id="1191">1191</a>
-<a href="#1192" id="1192">1192</a>
-<a href="#1193" id="1193">1193</a>
-<a href="#1194" id="1194">1194</a>
-<a href="#1195" id="1195">1195</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{sync::Arc, vec::Vec};
+<a href="#1191" id="1191">1191</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{sync::Arc, vec::Vec};
 
 <span class="kw">use </span>arrayvec::ArrayVec;
 <span class="kw">use </span>thiserror::Error;
@@ -1203,7 +1199,7 @@
 </span><span class="kw">use </span><span class="kw">crate</span>::device::trace::Command <span class="kw">as </span>TraceCommand;
 <span class="kw">use crate</span>::{
     api_log,
-    command::{clear_texture, CommandEncoderError},
+    command::{clear_texture, EncoderStateError},
     conv,
     device::{Device, DeviceError, MissingDownlevelFlags},
     global::Global,
@@ -1356,7 +1352,9 @@
 #[non_exhaustive]
 </span><span class="kw">pub enum </span>CopyError {
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
+    <span class="attr">#[error(transparent)]
+    </span>Device(<span class="attr">#[from] </span>DeviceError),
     <span class="attr">#[error(<span class="string">"Copy error"</span>)]
     </span>Transfer(<span class="attr">#[from] </span>TransferError),
     <span class="attr">#[error(transparent)]
@@ -1365,12 +1363,6 @@
     </span>InvalidResource(<span class="attr">#[from] </span>InvalidResourceError),
 }
 
-<span class="kw">impl </span>From&lt;DeviceError&gt; <span class="kw">for </span>CopyError {
-    <span class="kw">fn </span>from(err: DeviceError) -&gt; <span class="self">Self </span>{
-        CopyError::Encoder(CommandEncoderError::Device(err))
-    }
-}
-
 <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>extract_texture_selector&lt;T&gt;(
     copy_texture: <span class="kw-2">&amp;</span>wgt::TexelCopyTextureInfo&lt;T&gt;,
     copy_size: <span class="kw-2">&amp;</span>Extent3d,

doc/src/wgpu_core/command/render.rs.html

@@ -89,21 +89,17 @@
 <a href="#88" id="88">88</a>
 <a href="#89" id="89">89</a>
 <a href="#90" id="90">90</a>
-<a href="#91" id="91">91</a>
-<a href="#92" id="92">92</a>
-<a href="#93" id="93">93</a></pre></div><pre class="rust"><code><span class="kw">use </span>thiserror::Error;
+<a href="#91" id="91">91</a></pre></div><pre class="rust"><code><span class="kw">use </span>thiserror::Error;
 
 <span class="kw">use crate</span>::{
-    command::CommandBuffer,
+    command::{CommandBuffer, EncoderStateError},
     device::DeviceError,
     global::Global,
     id::{BufferId, CommandEncoderId, TextureId},
     resource::{InvalidResourceError, ParentDevice},
     track::ResourceUsageCompatibilityError,
 };
 
-<span class="kw">use </span><span class="kw">super</span>::CommandEncoderError;
-
 <span class="kw">impl </span>Global {
     <span class="kw">pub fn </span>command_encoder_transition_resources(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
@@ -178,7 +174,7 @@
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
     <span class="attr">#[error(transparent)]
     </span>InvalidResource(<span class="attr">#[from] </span>InvalidResourceError),
     <span class="attr">#[error(transparent)]

doc/src/wgpu_core/command/transfer.rs.html

@@ -268,7 +268,7 @@
 <span class="kw">use </span>wgt::{AccelerationStructureGeometryFlags, BufferAddress, IndexFormat, VertexFormat};
 
 <span class="kw">use crate</span>::{
-    command::CommandEncoderError,
+    command::EncoderStateError,
     device::{DeviceError, MissingFeatures},
     id::{BlasId, BufferId, TlasId},
     resource::{
@@ -305,7 +305,7 @@
 </span><span class="attr">#[derive(Clone, Debug, Error)]
 </span><span class="kw">pub enum </span>BuildAccelerationStructureError {
     <span class="attr">#[error(transparent)]
-    </span>Encoder(<span class="attr">#[from] </span>CommandEncoderError),
+    </span>EncoderState(<span class="attr">#[from] </span>EncoderStateError),
 
     <span class="attr">#[error(transparent)]
     </span>Device(<span class="attr">#[from] </span>DeviceError),