|
|
|
|
|
<!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 `DescriptorSet` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, DescriptorSet"><title>vulkano::descriptor::descriptor_set::DescriptorSet - 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 DescriptorSet</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.buffer">buffer</a><a href="#tymethod.image">image</a><a href="#tymethod.inner">inner</a><a href="#tymethod.num_buffers">num_buffers</a><a href="#tymethod.num_images">num_images</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: 'DescriptorSet', 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/mod.rs.html#80-101' 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=''>DescriptorSet</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait DescriptorSet: <a class="trait" href="../../../vulkano/descriptor/descriptor_set/trait.DescriptorSetDesc.html" title="trait vulkano::descriptor::descriptor_set::DescriptorSetDesc">DescriptorSetDesc</a> {
|
|
|
|
|
|
fn <a href='#tymethod.inner' class='fnname'>inner</a>(&self) -> &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSet.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSet">UnsafeDescriptorSet</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.num_buffers' class='fnname'>num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.buffer' class='fnname'>buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.num_images' class='fnname'>num_images</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.image' class='fnname'>image</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait for objects that contain a collection of resources that will be accessible by shaders.</p>
|
|
|
|
|
|
<p>Objects of this type can be passed when submitting a draw command.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.inner' class='method'><code id='inner.v'>fn <a href='#tymethod.inner' class='fnname'>inner</a>(&self) -> &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSet.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSet">UnsafeDescriptorSet</a></code></h3><div class='docblock'><p>Returns the inner <code>UnsafeDescriptorSet</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.num_buffers' class='method'><code id='num_buffers.v'>fn <a href='#tymethod.num_buffers' class='fnname'>num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Returns the number of buffers within this descriptor set.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.buffer' class='method'><code id='buffer.v'>fn <a href='#tymethod.buffer' class='fnname'>buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h3><div class='docblock'><p>Returns the <code>index</code>th buffer of this descriptor set, or <code>None</code> if out of range. Also
|
|
|
|
|
|
returns the index of the descriptor that uses this buffer.</p>
|
|
|
|
|
|
<p>The valid range is between 0 and <code>num_buffers()</code>.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.num_images' class='method'><code id='num_images.v'>fn <a href='#tymethod.num_images' class='fnname'>num_images</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>Returns the number of images within this descriptor set.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.image' class='method'><code id='image.v'>fn <a href='#tymethod.image' class='fnname'>image</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code></h3><div class='docblock'><p>Returns the <code>index</code>th image of this descriptor set, or <code>None</code> if out of range. Also returns
|
|
|
|
|
|
the index of the descriptor that uses this image.</p>
|
|
|
|
|
|
<p>The valid range is between 0 and <code>num_images()</code>.</p>
|
|
|
|
|
|
</div></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'><h3 id='impl-DescriptorSet' class='impl'><code class='in-band'>impl<L, R> DescriptorSet for <a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.FixedSizeDescriptorSet.html" title="struct vulkano::descriptor::descriptor_set::FixedSizeDescriptorSet">FixedSizeDescriptorSet</a><L, R> <span class="where fmt-newline">where<br> L: <a class="trait" href="../../../vulkano/descriptor/pipeline_layout/trait.PipelineLayoutAbstract.html" title="trait vulkano::descriptor::pipeline_layout::PipelineLayoutAbstract">PipelineLayoutAbstract</a>,<br> R: PersistentDescriptorSetResources, </span></code><a href='#impl-DescriptorSet' class='anchor'></a><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/fixed_size_pool.rs.html#133-161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.inner' class="method hidden"><code id='inner.v-1'>fn <a href='#method.inner' class='fnname'>inner</a>(&self) -> &<a class="struct" href="../../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSet.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSet">UnsafeDescriptorSet</a></code><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/fixed_size_pool.rs.html#138-140' title='goto source code'>[src]</a></h4><h4 id='method.num_buffers' class="method hidden"><code id='num_buffers.v-1'>fn <a href='#method.num_buffers' class='fnname'>num_buffers</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/fixed_size_pool.rs.html#143-145' title='goto source code'>[src]</a></h4><h4 id='method.buffer' class="method hidden"><code id='buffer.v-1'>fn <a href='#method.buffer' class='fnname'>buffer</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/fixed_size_pool.rs.html#148-150' title='goto source code'>[src]</a></h4><h4 id='method.num_images' class="method hidden"><code id='num_images.v-1'>fn <a href='#method.num_images' class='fnname'>num_images</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../../src/vulkano/descriptor/descriptor_set/fixed_size_pool.rs.html#153-155' title='goto source code'>[src]</a></h4><h4 id='method.image' class="method hidden"><code id='image.v-1'>fn <a href='#method.image' class='fnname'>image</a>(&self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>&dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive
|
|
|
|
|
|
src="../../../implementors/vulkano/descriptor/descriptor_set/trait.DescriptorSet.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>
|
