|
|
|
|
|
<!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 `RenderPassAbstract` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, RenderPassAbstract"><title>vulkano::framebuffer::RenderPassAbstract - 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 RenderPassAbstract</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.inner">inner</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'>framebuffer</a></p><script>window.sidebarCurrent = {name: 'RenderPassAbstract', 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/framebuffer/traits.rs.html#97-104' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>framebuffer</a>::<wbr><a class="trait" href=''>RenderPassAbstract</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait RenderPassAbstract: <a class="trait" href="../../vulkano/device/trait.DeviceOwned.html" title="trait vulkano::device::DeviceOwned">DeviceOwned</a> + <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassDesc.html" title="trait vulkano::framebuffer::RenderPassDesc">RenderPassDesc</a> {
|
|
|
|
|
|
fn <a href='#tymethod.inner' class='fnname'>inner</a>(&self) -> <a class="struct" href="../../vulkano/framebuffer/struct.RenderPassSys.html" title="struct vulkano::framebuffer::RenderPassSys">RenderPassSys</a>;
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait for objects that contain a Vulkan render pass object.</p>
|
|
|
|
|
|
<p>Any <code>RenderPass</code> object implements this trait. You can therefore turn a <code>Arc<RenderPass<_>></code>
|
|
|
|
|
|
into a <code>Arc<RenderPassAbstract + Send + Sync></code> for easier storage.</p>
|
|
|
|
|
|
<p>The <code>Arc<RenderPassAbstract + Send + Sync></code> accepts a <code>Vec<ClearValue></code> for clear values and a
|
|
|
|
|
|
<code>Vec<Arc<ImageView + Send + Sync>></code> for the list of attachments.</p>
|
|
|
|
|
|
<h1 id="example" class="section-header"><a href="#example">Example</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">framebuffer</span>::<span class="ident">EmptySinglePassRenderPassDesc</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">framebuffer</span>::<span class="ident">RenderPass</span>;
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">vulkano</span>::<span class="ident">framebuffer</span>::<span class="ident">RenderPassAbstract</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">render_pass</span> <span class="op">=</span> <span class="ident">RenderPass</span>::<span class="ident">new</span>(<span class="ident">device</span>.<span class="ident">clone</span>(), <span class="ident">EmptySinglePassRenderPassDesc</span>).<span class="ident">unwrap</span>();
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// For easier storage, turn this render pass into a `Arc<RenderPassAbstract + Send + Sync>`.</span>
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">stored_rp</span> <span class="op">=</span> <span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">render_pass</span>) <span class="kw">as</span> <span class="ident">Arc</span><span class="op"><</span><span class="ident">RenderPassAbstract</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span><span class="op">></span>;</pre></div>
|
|
|
|
|
|
</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/framebuffer/struct.RenderPassSys.html" title="struct vulkano::framebuffer::RenderPassSys">RenderPassSys</a></code></h3><div class='docblock'><p>Returns an opaque object representing the render pass' internals.</p>
|
|
|
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
|
|
|
<p>The trait implementation must return the same value every time.</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-RenderPassAbstract' class='impl'><code class='in-band'>impl<D> RenderPassAbstract for <a class="struct" href="../../vulkano/framebuffer/struct.RenderPass.html" title="struct vulkano::framebuffer::RenderPass">RenderPass</a><D> <span class="where fmt-newline">where<br> D: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassDesc.html" title="trait vulkano::framebuffer::RenderPassDesc">RenderPassDesc</a>, </span></code><a href='#impl-RenderPassAbstract' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/sys.rs.html#454-461' 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/framebuffer/struct.RenderPassSys.html" title="struct vulkano::framebuffer::RenderPassSys">RenderPassSys</a></code><a class='srclink' href='../../src/vulkano/framebuffer/sys.rs.html#458-460' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassAbstract-1' class='impl'><code class='in-band'>impl<Mv, L, Rp> RenderPassAbstract for <a class="struct" href="../../vulkano/pipeline/struct.GraphicsPipeline.html" title="struct vulkano::pipeline::GraphicsPipeline">GraphicsPipeline</a><Mv, L, Rp> <span class="where fmt-newline">where<br> Rp: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassAbstract.html" title="trait vulkano::framebuffer::RenderPassAbstract">RenderPassAbstract</a>, </span></code><a href='#impl-RenderPassAbstract-1' class='anchor'></a><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#250-257' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.inner-1' class="method hidden"><code id='inner.v-2'>fn <a href='#method.inner-1' class='fnname'>inner</a>(&self) -> <a class="struct" href="../../vulkano/framebuffer/struct.RenderPassSys.html" title="struct vulkano::framebuffer::RenderPassSys">RenderPassSys</a></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#254-256' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassAbstract-2' class='impl'><code class='in-band'>impl<Rp, A> RenderPassAbstract for <a class="struct" href="../../vulkano/framebuffer/struct.Framebuffer.html" title="struct vulkano::framebuffer::Framebuffer">Framebuffer</a><Rp, A> <span class="where fmt-newline">where<br> Rp: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassAbstract.html" title="trait vulkano::framebuffer::RenderPassAbstract">RenderPassAbstract</a>, </span></code><a href='#impl-RenderPassAbstract-2' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#427-434' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.inner-2' class="method hidden"><code id='inner.v-3'>fn <a href='#method.inner-2' class='fnname'>inner</a>(&self) -> <a class="struct" href="../../vulkano/framebuffer/struct.RenderPassSys.html" title="struct vulkano::framebuffer::RenderPassSys">RenderPassSys</a></code><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#431-433' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassAbstract-3' class='impl'><code class='in-band'>impl<T> RenderPassAbstract for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../../vulkano/trait.SafeDeref.html" title="trait vulkano::SafeDeref">SafeDeref</a>,<br> T::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html#associatedtype.Target" title="type core::ops::deref::Deref::Target">Target</a>: <a class="trait" href="../../vulkano/framebuffer/trait.RenderP
|
|
|
|
|
|
src="../../implementors/vulkano/framebuffer/trait.RenderPassAbstract.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>
|
