You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/vulkano/descriptor/trait.PipelineLayoutAbstrac...

16 lines
18 KiB

5 years ago
<!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 `PipelineLayoutAbstract` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, PipelineLayoutAbstract"><title>vulkano::descriptor::PipelineLayoutAbstract - 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">&#9776;</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 PipelineLayoutAbstract</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.descriptor_set_layout">descriptor_set_layout</a><a href="#tymethod.sys">sys</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></p><script>window.sidebarCurrent = {name: 'PipelineLayoutAbstract', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/vulkano/descriptor/pipeline_layout/traits.rs.html#30-42' 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 class="trait" href=''>PipelineLayoutAbstract</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait PipelineLayoutAbstract: <a class="trait" href="../../vulkano/descriptor/pipeline_layout/trait.PipelineLayoutDesc.html" title="trait vulkano::descriptor::pipeline_layout::PipelineLayoutDesc">PipelineLayoutDesc</a> + <a class="trait" href="../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> {
fn <a href='#tymethod.sys' class='fnname'>sys</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/descriptor/pipeline_layout/struct.PipelineLayoutSys.html" title="struct vulkano::descriptor::pipeline_layout::PipelineLayoutSys">PipelineLayoutSys</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.descriptor_set_layout' class='fnname'>descriptor_set_layout</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>&nbsp;&nbsp;&nbsp;&nbsp;) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a>&gt;&gt;;
}</pre></div><div class='docblock'><p>Trait for objects that describe the layout of the descriptors and push constants of a pipeline.</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.sys' class='method'><code id='sys.v'>fn <a href='#tymethod.sys' class='fnname'>sys</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/descriptor/pipeline_layout/struct.PipelineLayoutSys.html" title="struct vulkano::descriptor::pipeline_layout::PipelineLayoutSys">PipelineLayoutSys</a></code></h3><div class='docblock'><p>Returns an opaque object that allows internal access to the pipeline layout.</p>
<p>Can be obtained by calling <code>PipelineLayoutAbstract::sys()</code> on the pipeline layout.</p>
<blockquote>
<p><strong>Note</strong>: This is an internal function that you normally don't need to call.</p>
</blockquote>
</div><h3 id='tymethod.descriptor_set_layout' class='method'><code id='descriptor_set_layout.v'>fn <a href='#tymethod.descriptor_set_layout' class='fnname'>descriptor_set_layout</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a>&gt;&gt;</code></h3><div class='docblock'><p>Returns the <code>UnsafeDescriptorSetLayout</code> object of the specified set index.</p>
<p>Returns <code>None</code> if out of range or if the set is empty for this index.</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-PipelineLayoutAbstract' class='impl'><code class='in-band'>impl&lt;D&gt; PipelineLayoutAbstract for <a class="struct" href="../../vulkano/descriptor/pipeline_layout/struct.PipelineLayout.html" title="struct vulkano::descriptor::pipeline_layout::PipelineLayout">PipelineLayout</a>&lt;D&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;D: <a class="trait" href="../../vulkano/descriptor/pipeline_layout/trait.PipelineLayoutDesc.html" title="trait vulkano::descriptor::pipeline_layout::PipelineLayoutDesc">PipelineLayoutDesc</a>,&nbsp;</span></code><a href='#impl-PipelineLayoutAbstract' class='anchor'></a><a class='srclink' href='../../src/vulkano/descriptor/pipeline_layout/sys.rs.html#174-186' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.sys' class="method hidden"><code id='sys.v-1'>fn <a href='#method.sys' class='fnname'>sys</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/descriptor/pipeline_layout/struct.PipelineLayoutSys.html" title="struct vulkano::descriptor::pipeline_layout::PipelineLayoutSys">PipelineLayoutSys</a></code><a class='srclink' href='../../src/vulkano/descriptor/pipeline_layout/sys.rs.html#178-180' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_layout' class="method hidden"><code id='descriptor_set_layout.v-1'>fn <a href='#method.descriptor_set_layout' class='fnname'>descriptor_set_layout</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;&amp;<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a>&lt;<a class="struct" href="../../vulkano/descriptor/descriptor_set/struct.UnsafeDescriptorSetLayout.html" title="struct vulkano::descriptor::descriptor_set::UnsafeDescriptorSetLayout">UnsafeDescriptorSetLayout</a>&gt;&gt;</code><a class='srclink' href='../../src/vulkano/descriptor/pipeline_layout/sys.rs.html#183-185' title='goto source code'>[src]</a></h4></div><h3 id='impl-PipelineLayoutAbstract-1' class='impl'><code class='in-band'>impl&lt;Mv, L, Rp&gt; PipelineLayoutAbstract for <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipeline.html" title="struct vulkano::pipeline::GraphicsPipeline">GraphicsPipeline</a>&lt;Mv, L, Rp&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;L: <a class="trait" href="../../vulkano/descriptor/pipeline_layout/trait.PipelineLayoutAbstract.html" title="trait vulkano::descriptor::pipeline_layout::PipelineLayoutAbstract">PipelineLayoutAbstract</a>,&nbsp;</span></code><a href='#impl-PipelineLayoutAbstract-1' class='anchor'></a><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#193-205' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.sys-1' class="method hidden"><code id='sys.v-2'>fn <a href='#method.sys-1' class='fnname'>sys</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/descriptor/pipeline_layout/struct.PipelineLayoutSys.html" title="struct vulkano::descriptor::pipeline_layout::PipelineLayoutSys">PipelineLayoutSys</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#197-199' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_layout-1' class="method hidden"><code id='descriptor_set_layout.v-2'>fn <a href='#method.descriptor_set_layout-1' class='fnname'>descriptor_set_layout</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;&amp;self, <br>&nbsp;&nbsp;&nbsp;&nbsp;index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Optio
src="../../implementors/vulkano/descriptor/trait.PipelineLayoutAbstract.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>&#9166;</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>