Skip to content

Commit 35b3904

Browse files
cwfitzgeraldcwfitzgerald
committed
Deploying to master from @ gfx-rs/wgpu@9770409 🚀
1 parent 3c11806 commit 35b3904

File tree

4 files changed

+46
-14
lines changed

4 files changed

+46
-14
lines changed

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,16 @@
243243
<a href="#242" id="242">242</a>
244244
<a href="#243" id="243">243</a>
245245
<a href="#244" id="244">244</a>
246-
<a href="#245" id="245">245</a></pre></div><pre class="rust"><code><span class="kw">use </span>std::ops::{Deref, DerefMut};
246+
<a href="#245" id="245">245</a>
247+
<a href="#246" id="246">246</a>
248+
<a href="#247" id="247">247</a>
249+
<a href="#248" id="248">248</a>
250+
<a href="#249" id="249">249</a>
251+
<a href="#250" id="250">250</a>
252+
<a href="#251" id="251">251</a>
253+
<a href="#252" id="252">252</a>
254+
<a href="#253" id="253">253</a>
255+
<a href="#254" id="254">254</a></pre></div><pre class="rust"><code><span class="kw">use </span>std::ops::{Deref, DerefMut};
247256

248257
<span class="kw">use crate</span>::<span class="kw-2">*</span>;
249258

@@ -354,6 +363,11 @@
354363
/// If possible, consider using [`Queue::write_buffer_with`] instead. That
355364
/// method avoids an intermediate copy and is often able to transfer data
356365
/// more efficiently than this one.
366+
///
367+
/// Currently on native platforms, for both of these methods the staging
368+
/// memory will be a new allocation. This will then be released after the
369+
/// next submission finishes. To entirely avoid short-lived allocations, you might
370+
/// be able to use [`StagingBelt`](crate::util::StagingBelt).
357371
</span><span class="kw">pub fn </span>write_buffer(<span class="kw-2">&amp;</span><span class="self">self</span>, buffer: <span class="kw-2">&amp;</span>Buffer, offset: BufferAddress, data: <span class="kw-2">&amp;</span>[u8]) {
358372
<span class="self">self</span>.inner.write_buffer(<span class="kw-2">&amp;</span>buffer.inner, offset, data);
359373
}
@@ -386,6 +400,10 @@
386400
/// ```
387401
///
388402
/// This method fails if `size` is greater than the size of `buffer` starting at `offset`.
403+
///
404+
/// Currently on native platforms, the staging memory will be a new allocation, which will
405+
/// then be released after the next submission finishes. To entirely avoid short-lived
406+
/// allocations, you might be able to use [`StagingBelt`](crate::util::StagingBelt).
389407
</span><span class="attr">#[must_use]
390408
</span><span class="kw">pub fn </span>write_buffer_with&lt;<span class="lifetime">'a</span>&gt;(
391409
<span class="kw-2">&amp;</span><span class="lifetime">'a </span><span class="self">self</span>,

‎doc/wgpu/api/queue/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
<!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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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-245">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::api::queue::Queue::submit"><code>Queue::submit</code></a>. Can be used
1+
<!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-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.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-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-b0742ba02757f159.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.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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-254">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::api::queue::Queue::submit"><code>Queue::submit</code></a>. Can be used
22
as part of an argument to <a href="../device/struct.Device.html#method.poll" title="method wgpu::api::device::Device::poll"><code>Device::poll</code></a> to block for a particular
33
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.Maintain.html" title="type wgpu::api::queue::Maintain">Maintain</a></div><div class="desc docblock-short">Passed to <a href="../device/struct.Device.html#method.poll" title="method wgpu::api::device::Device::poll"><code>Device::poll</code></a> to control how and if it should block.</div></li></ul></section></div></main></body></html>

0 commit comments

Comments
 (0)