|
|
<!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 `CommandPool` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, CommandPool"><title>vulkano::command_buffer::pool::CommandPool - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="shortcut icon" href="../../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../vulkano/index.html'><div class='logo-container'><img src='https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png' alt='logo'></div></a><p class='location'>Trait CommandPool</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Iter">Iter</a><a href="#associatedtype.Builder">Builder</a><a href="#associatedtype.Alloc">Alloc</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.alloc">alloc</a><a href="#tymethod.queue_family">queue_family</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-CommandPool-for-Arc%3CStandardCommandPool%3E">Arc<StandardCommandPool></a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>command_buffer</a>::<wbr><a href='index.html'>pool</a></p><script>window.sidebarCurrent = {name: 'CommandPool', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/vulkano/command_buffer/pool/mod.rs.html#53-69' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>command_buffer</a>::<wbr><a href='index.html'>pool</a>::<wbr><a class="trait" href=''>CommandPool</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait CommandPool: <a class="trait" href="../../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> {
|
|
|
type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Builder" title="type vulkano::command_buffer::pool::CommandPool::Builder">Builder</a>>;
|
|
|
type <a href='#associatedtype.Builder' class="type">Builder</a>: <a class="trait" href="../../../vulkano/command_buffer/pool/trait.CommandPoolBuilderAlloc.html" title="trait vulkano::command_buffer::pool::CommandPoolBuilderAlloc">CommandPoolBuilderAlloc</a><Alloc = Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Alloc" title="type vulkano::command_buffer::pool::CommandPool::Alloc">Alloc</a>>;
|
|
|
type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/command_buffer/pool/trait.CommandPoolAlloc.html" title="trait vulkano::command_buffer::pool::CommandPoolAlloc">CommandPoolAlloc</a>;
|
|
|
fn <a href='#tymethod.alloc' class='fnname'>alloc</a>(&self, secondary: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Iter" title="type vulkano::command_buffer::pool::CommandPool::Iter">Iter</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.queue_family' class='fnname'>queue_family</a>(&self) -> <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a>;
|
|
|
}</pre></div><div class='docblock'><p>Types that manage the memory of command buffers.</p>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<p>A Vulkan command pool must be externally synchronized as if it owned the command buffers that
|
|
|
were allocated from it. This includes allocating from the pool, freeing from the pool,
|
|
|
resetting the pool or individual command buffers, and most importantly recording commands to
|
|
|
command buffers.</p>
|
|
|
<p>The implementation of <code>CommandPool</code> is expected to manage this. For as long as a <code>Builder</code>
|
|
|
is alive, the trait implementation is expected to lock the pool that allocated the <code>Builder</code>
|
|
|
for the current thread.</p>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: This may be modified in the future to allow different implementation strategies.</p>
|
|
|
</blockquote>
|
|
|
<p>The destructors of the <code>CommandPoolBuilderAlloc</code> and the <code>CommandPoolAlloc</code> are expected to
|
|
|
free the command buffer, reset the command buffer, or add it to a pool so that it gets reused.
|
|
|
If the implementation frees or resets the command buffer, it must not forget that this
|
|
|
operation must lock the pool.</p>
|
|
|
</div>
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Iter' class='method'><code id='Iter.t'>type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Builder" title="type vulkano::command_buffer::pool::CommandPool::Builder">Builder</a>></code></h3><div class='docblock'><p>See <code>alloc()</code>.</p>
|
|
|
</div><h3 id='associatedtype.Builder' class='method'><code id='Builder.t'>type <a href='#associatedtype.Builder' class="type">Builder</a>: <a class="trait" href="../../../vulkano/command_buffer/pool/trait.CommandPoolBuilderAlloc.html" title="trait vulkano::command_buffer::pool::CommandPoolBuilderAlloc">CommandPoolBuilderAlloc</a><Alloc = Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Alloc" title="type vulkano::command_buffer::pool::CommandPool::Alloc">Alloc</a>></code></h3><div class='docblock'><p>Represents a command buffer that has been allocated and that is currently being built.</p>
|
|
|
</div><h3 id='associatedtype.Alloc' class='method'><code id='Alloc.t'>type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/command_buffer/pool/trait.CommandPoolAlloc.html" title="trait vulkano::command_buffer::pool::CommandPoolAlloc">CommandPoolAlloc</a></code></h3><div class='docblock'><p>Represents a command buffer that has been allocated and that is pending execution or is
|
|
|
being executed.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.alloc' class='method'><code id='alloc.v'>fn <a href='#tymethod.alloc' class='fnname'>alloc</a>(&self, secondary: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Iter" title="type vulkano::command_buffer::pool::CommandPool::Iter">Iter</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>></code></h3><div class='docblock'><p>Allocates command buffers from this pool.</p>
|
|
|
<p>Returns an iterator that contains an bunch of allocated command buffers.</p>
|
|
|
</div><h3 id='tymethod.queue_family' class='method'><code id='queue_family.v'>fn <a href='#tymethod.queue_family' class='fnname'>queue_family</a>(&self) -> <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a></code></h3><div class='docblock'><p>Returns the queue family that this pool targets.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-CommandPool-for-Arc%3CStandardCommandPool%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html" title="trait vulkano::command_buffer::pool::CommandPool">CommandPool</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/command_buffer/pool/standard/struct.StandardCommandPool.html" title="struct vulkano::command_buffer::pool::standard::StandardCommandPool">StandardCommandPool</a>></code><a href='#impl-CommandPool-for-Arc%3CStandardCommandPool%3E' class='anchor'></a><a class='srclink' href='../../../src/vulkano/command_buffer/pool/standard.rs.html#86-176' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Iter-1' class="type"><code id='Iter.t-1'>type <a href='#associatedtype.Iter' class="type">Iter</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.IntoIter.html" title="struct alloc::vec::IntoIter">VecIntoIter</a><<a class="struct" href="../../../vulkano/command_buffer/pool/standard/struct.StandardCommandPoolBuilder.html" title="struct vulkano::command_buffer::pool::standard::StandardCommandPoolBuilder">StandardCommandPoolBuilder</a>></code></h4><h4 id='associatedtype.Builder-1' class="type"><code id='Builder.t-1'>type <a href='#associatedtype.Builder' class="type">Builder</a> = <a class="struct" href="../../../vulkano/command_buffer/pool/standard/struct.StandardCommandPoolBuilder.html" title="struct vulkano::command_buffer::pool::standard::StandardCommandPoolBuilder">StandardCommandPoolBuilder</a></code></h4><h4 id='associatedtype.Alloc-1' class="type"><code id='Alloc.t-1'>type <a href='#associatedtype.Alloc' class="type">Alloc</a> = <a class="struct" href="../../../vulkano/command_buffer/pool/standard/struct.StandardCommandPoolAlloc.html" title="struct vulkano::command_buffer::pool::standard::StandardCommandPoolAlloc">StandardCommandPoolAlloc</a></code></h4><h4 id='method.alloc' class="method hidden"><code id='alloc.v-1'>fn <a href='#method.alloc' class='fnname'>alloc</a>(&self, secondary: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, count: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self::<a class="type" href="../../../vulkano/command_buffer/pool/trait.CommandPool.html#associatedtype.Iter" title="type vulkano::command_buffer::pool::CommandPool::Iter">Iter</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>></code><a class='srclink' href='../../../src/vulkano/command_buffer/pool/standard.rs.html#91-167' title='goto source code'>[src]</a></h4><h4 id='method.queue_family' class="method hidden"><code id='queue_family.v-1'>fn <a href='#method.queue_family' class='fnname'>queue_family</a>(&self) -> <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a></code><a class='srclink' href='../../../src/vulkano/command_buffer/pool/standard.rs.html#170-175' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
src="../../../implementors/vulkano/command_buffer/pool/trait.CommandPool.js">
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "vulkano";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |
