Deploying to master from @ gfx-rs/wgpu@326ad03 🚀

Author: ErichDonGubler

doc/search-index.js

@@ -199,10 +199,7 @@
 <a href="#198" id="198">198</a>
 <a href="#199" id="199">199</a>
 <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></pre></div><pre class="rust"><code><span class="kw">use </span>core::future::Future;
+<a href="#201" id="201">201</a></pre></div><pre class="rust"><code><span class="kw">use </span>core::future::Future;
 
 <span class="kw">use crate</span>::<span class="kw-2">*</span>;
 
@@ -250,8 +247,7 @@
     /// # Arguments
     ///
     /// - `desc` - Description of the features and limits requested from the given device.
-    /// - `trace_path` - Can be used for API call tracing, if that feature is
-    ///   enabled in `wgpu-core`.
+    /// - `trace` - Can be used for API call tracing, if the feature is enabled.
     ///
     /// # Panics
     ///
@@ -265,9 +261,8 @@
     </span><span class="kw">pub fn </span>request_device(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         desc: <span class="kw-2">&amp;</span>DeviceDescriptor&lt;<span class="lifetime">'_</span>&gt;,
-        trace_path: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::Path&gt;,
     ) -&gt; <span class="kw">impl </span>Future&lt;Output = <span class="prelude-ty">Result</span>&lt;(Device, Queue), RequestDeviceError&gt;&gt; + WasmNotSend {
-        <span class="kw">let </span>device = <span class="self">self</span>.inner.request_device(desc, trace_path);
+        <span class="kw">let </span>device = <span class="self">self</span>.inner.request_device(desc);
         <span class="kw">async move </span>{
             device
                 .<span class="kw">await
@@ -286,13 +281,12 @@
         <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;,
-        trace_path: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::Path&gt;,
     ) -&gt; <span class="prelude-ty">Result</span>&lt;(Device, Queue), RequestDeviceError&gt; {
         <span class="kw">let </span>core_adapter = <span class="self">self</span>.inner.as_core();
         <span class="kw">let </span>(device, queue) = <span class="kw">unsafe </span>{
             core_adapter
                 .context
-                .create_device_from_hal(core_adapter, hal_device, desc, trace_path)
+                .create_device_from_hal(core_adapter, hal_device, desc)
         }<span class="question-mark">?</span>;
 
         <span class="prelude-val">Ok</span>((

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

@@ -3614,7 +3614,15 @@
 <a href="#3613" id="3613">3613</a>
 <a href="#3614" id="3614">3614</a>
 <a href="#3615" id="3615">3615</a>
-<a href="#3616" id="3616">3616</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{
+<a href="#3616" id="3616">3616</a>
+<a href="#3617" id="3617">3617</a>
+<a href="#3618" id="3618">3618</a>
+<a href="#3619" id="3619">3619</a>
+<a href="#3620" id="3620">3620</a>
+<a href="#3621" id="3621">3621</a>
+<a href="#3622" id="3622">3622</a>
+<a href="#3623" id="3623">3623</a>
+<a href="#3624" id="3624">3624</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{
     borrow::Cow::Borrowed,
     boxed::Box,
     format,
@@ -3720,19 +3728,23 @@
         adapter: <span class="kw-2">&amp;</span>CoreAdapter,
         hal_device: hal::OpenDevice&lt;A&gt;,
         desc: <span class="kw-2">&amp;</span><span class="kw">crate</span>::DeviceDescriptor&lt;<span class="lifetime">'_</span>&gt;,
-        trace_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::Path&gt;,
     ) -&gt; <span class="prelude-ty">Result</span>&lt;(CoreDevice, CoreQueue), <span class="kw">crate</span>::RequestDeviceError&gt; {
-        <span class="kw">if </span>trace_dir.is_some() {
-            <span class="macro">log::error!</span>(<span class="string">"Feature 'trace' has been removed temporarily, see https://github.com/gfx-rs/wgpu/issues/5974"</span>);
+        <span class="kw">if </span>!<span class="macro">matches!</span>(desc.trace, wgt::Trace::Off) {
+            <span class="macro">log::error!</span>(
+                <span class="string">"
+                Feature 'trace' has been removed temporarily; \
+                see https://github.com/gfx-rs/wgpu/issues/5974. \
+                The `trace` parameter will have no effect."
+            </span>);
         }
+
         <span class="kw">let </span>(device_id, queue_id) = <span class="kw">unsafe </span>{
             <span class="self">self</span>.<span class="number">0</span>.create_device_from_hal(
                 adapter.id,
                 hal_device.into(),
                 <span class="kw-2">&amp;</span>desc.map_label(|l| l.map(Borrowed)),
                 <span class="prelude-val">None</span>,
                 <span class="prelude-val">None</span>,
-                <span class="prelude-val">None</span>,
             )
         }<span class="question-mark">?</span>;
         <span class="kw">let </span>error_sink = Arc::new(Mutex::new(ErrorSinkRaw::new()));
@@ -4492,17 +4504,21 @@
     <span class="kw">fn </span>request_device(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         desc: <span class="kw-2">&amp;</span><span class="kw">crate</span>::DeviceDescriptor&lt;<span class="lifetime">'_</span>&gt;,
-        trace_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::Path&gt;,
     ) -&gt; Pin&lt;Box&lt;<span class="kw">dyn </span>dispatch::RequestDeviceFuture&gt;&gt; {
-        <span class="kw">if </span>trace_dir.is_some() {
-            <span class="macro">log::error!</span>(<span class="string">"Feature 'trace' has been removed temporarily, see https://github.com/gfx-rs/wgpu/issues/5974"</span>);
+        <span class="kw">if </span>!<span class="macro">matches!</span>(desc.trace, wgt::Trace::Off) {
+            <span class="macro">log::error!</span>(
+                <span class="string">"
+                Feature 'trace' has been removed temporarily; \
+                see https://github.com/gfx-rs/wgpu/issues/5974. \
+                The `trace` parameter will have no effect."
+            </span>);
         }
+
         <span class="kw">let </span>res = <span class="self">self</span>.context.<span class="number">0</span>.adapter_request_device(
             <span class="self">self</span>.id,
             <span class="kw-2">&amp;</span>desc.map_label(|l| l.map(Borrowed)),
             <span class="prelude-val">None</span>,
             <span class="prelude-val">None</span>,
-            <span class="prelude-val">None</span>,
         );
         <span class="kw">let </span>(device_id, queue_id) = <span class="kw">match </span>res {
             <span class="prelude-val">Ok</span>(ids) =&gt; ids,

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

@@ -815,8 +815,7 @@
 <a href="#814" id="814">814</a>
 <a href="#815" id="815">815</a>
 <a href="#816" id="816">816</a>
-<a href="#817" id="817">817</a>
-<a href="#818" id="818">818</a></pre></div><pre class="rust"><code><span class="doccomment">//! Infrastructure for dispatching calls to the appropriate "backend". The "backends" are:
+<a href="#817" id="817">817</a></pre></div><pre class="rust"><code><span class="doccomment">//! Infrastructure for dispatching calls to the appropriate "backend". The "backends" are:
 //!
 //! - `wgpu_core`: An implementation of the the wgpu api on top of various native graphics APIs.
 //! - `webgpu`: An implementation of the wgpu api which calls WebGPU directly.
@@ -900,7 +899,6 @@
     <span class="kw">fn </span>request_device(
         <span class="kw-2">&amp;</span><span class="self">self</span>,
         desc: <span class="kw-2">&amp;</span><span class="kw">crate</span>::DeviceDescriptor&lt;<span class="lifetime">'_</span>&gt;,
-        trace_dir: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::Path&gt;,
     ) -&gt; Pin&lt;Box&lt;<span class="kw">dyn </span>RequestDeviceFuture&gt;&gt;;
 
     <span class="kw">fn </span>is_surface_supported(<span class="kw-2">&amp;</span><span class="self">self</span>, surface: <span class="kw-2">&amp;</span>DispatchSurface) -&gt; bool;

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

@@ -211,7 +211,7 @@
     StencilFaceState, StencilOperation, StencilState, StorageTextureAccess, SurfaceCapabilities,
     SurfaceStatus, TexelCopyBufferLayout, TextureAspect, TextureDimension, TextureFormat,
     TextureFormatFeatureFlags, TextureFormatFeatures, TextureSampleType, TextureTransition,
-    TextureUsages, TextureUses, TextureViewDimension, VertexAttribute, VertexFormat,
+    TextureUsages, TextureUses, TextureViewDimension, Trace, VertexAttribute, VertexFormat,
     VertexStepMode, WasmNotSend, WasmNotSendSync, WasmNotSync, COPY_BUFFER_ALIGNMENT,
     COPY_BYTES_PER_ROW_ALIGNMENT, MAP_ALIGNMENT, PUSH_CONSTANT_ALIGNMENT,
     QUERY_RESOLVE_BUFFER_ALIGNMENT, QUERY_SET_MAX_QUERIES, QUERY_SIZE, VERTEX_STRIDE_ALIGNMENT,

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

@@ -3838,7 +3838,24 @@
 <a href="#3837" id="3837">3837</a>
 <a href="#3838" id="3838">3838</a>
 <a href="#3839" id="3839">3839</a>
-<a href="#3840" id="3840">3840</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{
+<a href="#3840" id="3840">3840</a>
+<a href="#3841" id="3841">3841</a>
+<a href="#3842" id="3842">3842</a>
+<a href="#3843" id="3843">3843</a>
+<a href="#3844" id="3844">3844</a>
+<a href="#3845" id="3845">3845</a>
+<a href="#3846" id="3846">3846</a>
+<a href="#3847" id="3847">3847</a>
+<a href="#3848" id="3848">3848</a>
+<a href="#3849" id="3849">3849</a>
+<a href="#3850" id="3850">3850</a>
+<a href="#3851" id="3851">3851</a>
+<a href="#3852" id="3852">3852</a>
+<a href="#3853" id="3853">3853</a>
+<a href="#3854" id="3854">3854</a>
+<a href="#3855" id="3855">3855</a>
+<a href="#3856" id="3856">3856</a>
+<a href="#3857" id="3857">3857</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{
     borrow::Cow,
     boxed::Box,
     string::{String, ToString <span class="kw">as _</span>},
@@ -4040,13 +4057,27 @@
         raw_device: Box&lt;<span class="kw">dyn </span>hal::DynDevice&gt;,
         adapter: <span class="kw-2">&amp;</span>Arc&lt;Adapter&gt;,
         desc: <span class="kw-2">&amp;</span>DeviceDescriptor,
-        trace_dir_name: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
         instance_flags: wgt::InstanceFlags,
     ) -&gt; <span class="prelude-ty">Result</span>&lt;<span class="self">Self</span>, DeviceError&gt; {
         <span class="attr">#[cfg(not(feature = <span class="string">"trace"</span>))]
-        </span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw">_</span>) = trace_dir_name {
-            <span class="macro">log::error!</span>(<span class="string">"Feature 'trace' is not enabled"</span>);
-        }
+        </span><span class="kw">match </span><span class="kw-2">&amp;</span>desc.trace {
+            wgt::Trace::Off =&gt; {}
+            <span class="kw">_ </span>=&gt; {
+                <span class="macro">log::error!</span>(<span class="string">"wgpu-core feature 'trace' is not enabled"</span>);
+            }
+        };
+        <span class="attr">#[cfg(feature = <span class="string">"trace"</span>)]
+        </span><span class="kw">let </span>trace_dir_name: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>std::path::PathBuf&gt; = <span class="kw">match </span><span class="kw-2">&amp;</span>desc.trace {
+            wgt::Trace::Off =&gt; <span class="prelude-val">None</span>,
+            wgt::Trace::Directory(d) =&gt; <span class="prelude-val">Some</span>(d),
+            <span class="comment">// The enum is non_exhaustive, so we must have a fallback arm (that should be
+            // unreachable in practice).
+            </span>t =&gt; {
+                <span class="macro">log::error!</span>(<span class="string">"unimplemented wgpu_types::Trace variant {t:?}"</span>);
+                <span class="prelude-val">None
+            </span>}
+        };
+
         <span class="kw">let </span>fence = <span class="kw">unsafe </span>{ raw_device.create_fence() }.map_err(DeviceError::from_hal)<span class="question-mark">?</span>;
 
         <span class="kw">let </span>command_allocator = command::CommandAllocator::new();
@@ -4112,16 +4143,19 @@
             <span class="attr">#[cfg(feature = <span class="string">"trace"</span>)]
             </span>trace: Mutex::new(
                 rank::DEVICE_TRACE,
-                trace_dir_name.and_then(|dir_path_name| <span class="kw">match </span>trace::Trace::new(dir_path_name) {
+                trace_dir_name.and_then(|path| <span class="kw">match </span>trace::Trace::new(path.clone()) {
                     <span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>trace) =&gt; {
                         trace.add(trace::Action::Init {
-                            desc: desc.clone(),
+                            desc: wgt::DeviceDescriptor {
+                                trace: wgt::Trace::Off,
+                                ..desc.clone()
+                            },
                             backend: adapter.backend(),
                         });
                         <span class="prelude-val">Some</span>(trace)
                     }
                     <span class="prelude-val">Err</span>(e) =&gt; {
-                        <span class="macro">log::error!</span>(<span class="string">"Unable to start a trace in '{dir_path_name:?}': {e}"</span>);
+                        <span class="macro">log::error!</span>(<span class="string">"Unable to start a trace in '{path:?}': {e}"</span>);
                         <span class="prelude-val">None
                     </span>}
                 }),