Deploying to master from @ gfx-rs/wgpu@38f3c47 🚀

Author: cwfitzgerald

doc/search-index.js

@@ -261,7 +261,29 @@
 <a href="#260" id="260">260</a>
 <a href="#261" id="261">261</a>
 <a href="#262" id="262">262</a>
-<a href="#263" id="263">263</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::boxed::Box;
+<a href="#263" id="263">263</a>
+<a href="#264" id="264">264</a>
+<a href="#265" id="265">265</a>
+<a href="#266" id="266">266</a>
+<a href="#267" id="267">267</a>
+<a href="#268" id="268">268</a>
+<a href="#269" id="269">269</a>
+<a href="#270" id="270">270</a>
+<a href="#271" id="271">271</a>
+<a href="#272" id="272">272</a>
+<a href="#273" id="273">273</a>
+<a href="#274" id="274">274</a>
+<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>
+<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></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::boxed::Box;
 <span class="kw">use </span>core::ops::{Deref, DerefMut};
 
 <span class="kw">use crate</span>::<span class="kw-2">*</span>;
@@ -523,5 +545,27 @@
     </span><span class="kw">pub fn </span>on_submitted_work_done(<span class="kw-2">&amp;</span><span class="self">self</span>, callback: <span class="kw">impl </span>FnOnce() + Send + <span class="lifetime">'static</span>) {
         <span class="self">self</span>.inner.on_submitted_work_done(Box::new(callback));
     }
+
+    <span class="doccomment">/// Returns the inner hal Queue using a callback. The hal queue will be `None` if the
+    /// backend type argument does not match with this wgpu Queue
+    ///
+    /// # Safety
+    ///
+    /// - The raw handle obtained from the hal Queue 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::Queue&gt;) -&gt; R, R&gt;(
+        <span class="kw-2">&amp;</span><span class="self">self</span>,
+        hal_queue_callback: F,
+    ) -&gt; R {
+        <span class="kw">if let </span><span class="prelude-val">Some</span>(core_queue) = <span class="self">self</span>.inner.as_core_opt() {
+            <span class="kw">unsafe </span>{
+                core_queue
+                    .context
+                    .queue_as_hal::&lt;A, F, R&gt;(core_queue, hal_queue_callback)
+            }
+        } <span class="kw">else </span>{
+            hal_queue_callback(<span class="prelude-val">None</span>)
+        }
+    }
 }
 </code></pre></div></section></main></body></html>

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

@@ -3606,7 +3606,15 @@
 <a href="#3605" id="3605">3605</a>
 <a href="#3606" id="3606">3606</a>
 <a href="#3607" id="3607">3607</a>
-<a href="#3608" id="3608">3608</a></pre></div><pre class="rust"><code><span class="kw">use </span>alloc::{
+<a href="#3608" id="3608">3608</a>
+<a href="#3609" id="3609">3609</a>
+<a href="#3610" id="3610">3610</a>
+<a href="#3611" id="3611">3611</a>
+<a href="#3612" id="3612">3612</a>
+<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::{
     borrow::Cow::Borrowed,
     boxed::Box,
     format,
@@ -3975,6 +3983,14 @@
 
         <span class="macro">format!</span>(<span class="string">"Validation Error\n\nCaused by:\n{output}"</span>)
     }
+
+    <span class="kw">pub unsafe fn </span>queue_as_hal&lt;A: wgc::hal_api::HalApi, F: FnOnce(<span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>A::Queue&gt;) -&gt; R, R&gt;(
+        <span class="kw-2">&amp;</span><span class="self">self</span>,
+        queue: <span class="kw-2">&amp;</span>CoreQueue,
+        hal_queue_callback: F,
+    ) -&gt; R {
+        <span class="kw">unsafe </span>{ <span class="self">self</span>.<span class="number">0</span>.queue_as_hal::&lt;A, F, R&gt;(queue.id, hal_queue_callback) }
+    }
 }
 
 <span class="kw">fn </span>map_buffer_copy_view(view: <span class="kw">crate</span>::TexelCopyBufferInfo&lt;<span class="lifetime">'_</span>&gt;) -&gt; wgc::command::TexelCopyBufferInfo {

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

@@ -1491,7 +1491,13 @@
 <a href="#1490" id="1490">1490</a>
 <a href="#1491" id="1491">1491</a>
 <a href="#1492" id="1492">1492</a>
-<a href="#1493" id="1493">1493</a></pre></div><pre class="rust"><code><span class="doccomment">/*!
+<a href="#1493" id="1493">1493</a>
+<a href="#1494" id="1494">1494</a>
+<a href="#1495" id="1495">1495</a>
+<a href="#1496" id="1496">1496</a>
+<a href="#1497" id="1497">1497</a>
+<a href="#1498" id="1498">1498</a>
+<a href="#1499" id="1499">1499</a></pre></div><pre class="rust"><code><span class="doccomment">/*!
 # Vulkan API internals.
 
 ## Stack memory
@@ -2266,6 +2272,12 @@
     signal_semaphores: Mutex&lt;(Vec&lt;vk::Semaphore&gt;, Vec&lt;u64&gt;)&gt;,
 }
 
+<span class="kw">impl </span>Queue {
+    <span class="kw">pub fn </span>as_raw(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; vk::Queue {
+        <span class="self">self</span>.raw
+    }
+}
+
 <span class="kw">impl </span>Drop <span class="kw">for </span>Queue {
     <span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
         <span class="kw">unsafe </span>{ <span class="self">self</span>.relay_semaphores.lock().destroy(<span class="kw-2">&amp;</span><span class="self">self</span>.device.raw) };

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

@@ -1,3 +1,3 @@
-<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `queue` mod in crate `wgpu`."><title>wgpu::api::queue - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="wgpu" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt="logo"></a><h2><a href="../../../wgpu/index.html">wgpu</a><span class="version">24.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module queue</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In wgpu::<wbr>api</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">wgpu</a>::<wbr><a href="../index.html">api</a></span><h1>Module <span>queue</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/wgpu/api/queue.rs.html#1-263">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Queue.html" title="struct wgpu::api::queue::Queue">Queue</a></div><div class="desc docblock-short">Handle to a command queue on a device.</div></li><li><div class="item-name"><a class="struct" href="struct.QueueWriteBufferView.html" title="struct wgpu::api::queue::QueueWriteBufferView">Queue<wbr>Write<wbr>Buffer<wbr>View</a></div><div class="desc docblock-short">A write-only view into a staging buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.SubmissionIndex.html" title="struct wgpu::api::queue::SubmissionIndex">Submission<wbr>Index</a></div><div class="desc docblock-short">Identifier for a particular call to <a href="../../struct.Queue.html#method.submit" title="method wgpu::Queue::submit"><code>Queue::submit</code></a>. Can be used
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `queue` mod in crate `wgpu`."><title>wgpu::api::queue - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-46132b98.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="wgpu" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0 (4d91de4e4 2025-02-17)" data-channel="1.85.0" data-search-js="search-75f5ac3e.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt="logo"></a><h2><a href="../../../wgpu/index.html">wgpu</a><span class="version">24.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module queue</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In wgpu::<wbr>api</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../../index.html">wgpu</a>::<wbr><a href="../index.html">api</a></span><h1>Module <span>queue</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/wgpu/api/queue.rs.html#1-285">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Queue.html" title="struct wgpu::api::queue::Queue">Queue</a></div><div class="desc docblock-short">Handle to a command queue on a device.</div></li><li><div class="item-name"><a class="struct" href="struct.QueueWriteBufferView.html" title="struct wgpu::api::queue::QueueWriteBufferView">Queue<wbr>Write<wbr>Buffer<wbr>View</a></div><div class="desc docblock-short">A write-only view into a staging buffer.</div></li><li><div class="item-name"><a class="struct" href="struct.SubmissionIndex.html" title="struct wgpu::api::queue::SubmissionIndex">Submission<wbr>Index</a></div><div class="desc docblock-short">Identifier for a particular call to <a href="../../struct.Queue.html#method.submit" title="method wgpu::Queue::submit"><code>Queue::submit</code></a>. Can be used
 as part of an argument to <a href="../../struct.Device.html#method.poll" title="method wgpu::Device::poll"><code>Device::poll</code></a> to block for a particular
 submission to finish.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.MaintainBase.html" title="enum wgpu::api::queue::MaintainBase">Maintain<wbr>Base</a></div><div class="desc docblock-short">Passed to <code>Device::poll</code> to control how and if it should block.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.PollType.html" title="type wgpu::api::queue::PollType">Poll<wbr>Type</a></div><div class="desc docblock-short">Passed to <a href="../../struct.Device.html#method.poll" title="method wgpu::Device::poll"><code>Device::poll</code></a> to control how and if it should block.</div></li></ul></section></div></main></body></html>