16 lines
11 KiB
HTML
16 lines
11 KiB
HTML
<!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 `DescriptorPool` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, DescriptorPool"><title>vulkano::descriptor::descriptor_set::DescriptorPool - 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 DescriptorPool</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.Alloc">Alloc</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.alloc">alloc</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-DescriptorPool-for-Arc%3CStdDescriptorPool%3E">Arc<StdDescriptorPool></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'>descriptor</a>::<wbr><a href='index.html'>descriptor_set</a></p><script>window.sidebarCurrent = {name: 'DescriptorPool', 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/descriptor/descriptor_set/sys.rs.html#39-47' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>descriptor</a>::<wbr><a href='index.html'>descriptor_set</a>::<wbr><a class="trait" href=''>DescriptorPool</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait DescriptorPool: <a class="trait" href="../../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> {
|
||
type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/descriptor/descriptor_set/trait.DescriptorPoolAlloc.html" title="trait vulkano::descriptor::descriptor_set::DescriptorPoolAlloc">DescriptorPoolAlloc</a>;
|
||
fn <a href='#tymethod.alloc' class='fnname'>alloc</a>(<br> &mut self, <br> layout: &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a><br> ) -> <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/descriptor/descriptor_set/trait.DescriptorPool.html#associatedtype.Alloc" title="type vulkano::descriptor::descriptor_set::DescriptorPool::Alloc">Alloc</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>>;
|
||
}</pre></div><div class='docblock'><p>A pool from which descriptor sets can be allocated.</p>
|
||
<p>Since the destructor of <code>Alloc</code> must free the descriptor set, this trait is usually implemented
|
||
on <code>Arc<T></code> or <code>&'a T</code> and not <code>T</code> directly, so that the <code>Alloc</code> object can hold 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.Alloc' class='method'><code id='Alloc.t'>type <a href='#associatedtype.Alloc' class="type">Alloc</a>: <a class="trait" href="../../../vulkano/descriptor/descriptor_set/trait.DescriptorPoolAlloc.html" title="trait vulkano::descriptor::descriptor_set::DescriptorPoolAlloc">DescriptorPoolAlloc</a></code></h3><div class='docblock'><p>Object that represented an allocated descriptor set.</p>
|
||
<p>The destructor of this object should free the descriptor set.</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>(<br> &mut self, <br> layout: &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a><br>) -> <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/descriptor/descriptor_set/trait.DescriptorPool.html#associatedtype.Alloc" title="type vulkano::descriptor::descriptor_set::DescriptorPool::Alloc">Alloc</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>></code></h3><div class='docblock'><p>Allocates a descriptor set.</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-DescriptorPool-for-Arc%3CStdDescriptorPool%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../../vulkano/descriptor/descriptor_set/trait.DescriptorPool.html" title="trait vulkano::descriptor::descriptor_set::DescriptorPool">DescriptorPool</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/descriptor/descriptor_set/struct.StdDescriptorPool.html" title="struct vulkano::descriptor::descriptor_set::StdDescriptorPool">StdDescriptorPool</a>></code><a href='#impl-DescriptorPool-for-Arc%3CStdDescriptorPool%3E' class='anchor'></a><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/std_pool.rs.html#64-147' title='goto source code'>[src]</a></h3><div class='impl-items'><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/descriptor/descriptor_set/struct.StdDescriptorPoolAlloc.html" title="struct vulkano::descriptor::descriptor_set::StdDescriptorPoolAlloc">StdDescriptorPoolAlloc</a></code></h4><h4 id='method.alloc' class="method hidden"><code id='alloc.v-1'>fn <a href='#method.alloc' class='fnname'>alloc</a>(<br> &mut self, <br> layout: &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.StdDescriptorPoolAlloc.html" title="struct vulkano::descriptor::descriptor_set::StdDescriptorPoolAlloc">StdDescriptorPoolAlloc</a>, <a class="enum" href="../../../vulkano/enum.OomError.html" title="enum vulkano::OomError">OomError</a>></code><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/std_pool.rs.html#68-146' 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/descriptor/descriptor_set/trait.DescriptorPool.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> |