21 lines
17 KiB
HTML
21 lines
17 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 `RenderPassDescClearValues` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, RenderPassDescClearValues"><title>vulkano::framebuffer::RenderPassDescClearValues - 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 RenderPassDescClearValues</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.convert_clear_values">convert_clear_values</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: 'RenderPassDescClearValues', 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#123-138' 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=''>RenderPassDescClearValues</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait RenderPassDescClearValues<C> {
|
||
fn <a href='#tymethod.convert_clear_values' class='fnname'>convert_clear_values</a>(&self, _: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>>;
|
||
}</pre></div><div class='docblock'><p>Extension trait for <code>RenderPassDesc</code>. Defines which types are allowed as a list of clear values.</p>
|
||
<p>When the user enters a render pass, they need to pass a list of clear values to apply to
|
||
the attachments of the framebuffer. To do so, the render pass object or the framebuffer
|
||
(depending on the function you use) must implement <code>RenderPassDescClearValues<C></code> where <code>C</code> is
|
||
the parameter that the user passed. The trait method is then responsible for checking the
|
||
correctness of these values and turning them into a list that can be processed by vulkano.</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.convert_clear_values' class='method'><code id='convert_clear_values.v'>fn <a href='#tymethod.convert_clear_values' class='fnname'>convert_clear_values</a>(&self, _: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code></h3><div class='docblock'><p>Decodes a <code>C</code> into a list of clear values where each element corresponds
|
||
to an attachment. The size of the returned iterator must be the same as the number of
|
||
attachments.</p>
|
||
<p>The format of the clear value <strong>must</strong> match the format of the attachment. Attachments
|
||
that are not loaded with <code>LoadOp::Clear</code> must have an entry equal to <code>ClearValue::None</code>.</p>
|
||
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
||
<p>This trait is unsafe because vulkano doesn't check whether the clear value is in a format
|
||
that matches the attachment.</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-RenderPassDescClearValues%3C()%3E' class='impl'><code class='in-band'>impl RenderPassDescClearValues<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>> for <a class="struct" href="../../vulkano/framebuffer/struct.EmptySinglePassRenderPassDesc.html" title="struct vulkano::framebuffer::EmptySinglePassRenderPassDesc">EmptySinglePassRenderPassDesc</a></code><a href='#impl-RenderPassDescClearValues%3C()%3E' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/empty.rs.html#124-129' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values' class="method hidden"><code id='convert_clear_values.v-1'>fn <a href='#method.convert_clear_values' class='fnname'>convert_clear_values</a>(&self, _: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/framebuffer/empty.rs.html#126-128' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassDescClearValues%3CVec%3CClearValue%3E%3E' class='impl'><code class='in-band'>impl RenderPassDescClearValues<<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>> for <a class="struct" href="../../vulkano/framebuffer/struct.EmptySinglePassRenderPassDesc.html" title="struct vulkano::framebuffer::EmptySinglePassRenderPassDesc">EmptySinglePassRenderPassDesc</a></code><a href='#impl-RenderPassDescClearValues%3CVec%3CClearValue%3E%3E' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/empty.rs.html#116-122' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values-1' class="method hidden"><code id='convert_clear_values.v-2'>fn <a href='#method.convert_clear_values-1' class='fnname'>convert_clear_values</a>(<br> &self, <br> values: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>><br>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/framebuffer/empty.rs.html#118-121' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassDescClearValues%3CC%3E' class='impl'><code class='in-band'>impl<C, D> RenderPassDescClearValues<C> 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.RenderPassDescClearValues.html" title="trait vulkano::framebuffer::RenderPassDescClearValues">RenderPassDescClearValues</a><C>, </span></code><a href='#impl-RenderPassDescClearValues%3CC%3E' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/sys.rs.html#445-452' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values-2' class="method hidden"><code id='convert_clear_values.v-3'>fn <a href='#method.convert_clear_values-2' class='fnname'>convert_clear_values</a>(&self, vals: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/framebuffer/sys.rs.html#449-451' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassDescClearValues%3CC%3E-1' class='impl'><code class='in-band'>impl<C, Mv, L, Rp> RenderPassDescClearValues<C> 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.RenderPassDescClearValues.html" title="trait vulkano::framebuffer::RenderPassDescClearValues">RenderPassDescClearValues</a><C>, </span></code><a href='#impl-RenderPassDescClearValues%3CC%3E-1' class='anchor'></a><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#293-300' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values-3' class="method hidden"><code id='convert_clear_values.v-4'>fn <a href='#method.convert_clear_values-3' class='fnname'>convert_clear_values</a>(&self, vals: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/pipeline/graphics_pipeline/mod.rs.html#297-299' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassDescClearValues%3CC%3E-2' class='impl'><code class='in-band'>impl<C, Rp, A> RenderPassDescClearValues<C> 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.RenderPassDescClearValues.html" title="trait vulkano::framebuffer::RenderPassDescClearValues">RenderPassDescClearValues</a><C>, </span></code><a href='#impl-RenderPassDescClearValues%3CC%3E-2' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#418-425' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values-4' class="method hidden"><code id='convert_clear_values.v-5'>fn <a href='#method.convert_clear_values-4' class='fnname'>convert_clear_values</a>(&self, vals: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#422-424' title='goto source code'>[src]</a></h4></div><h3 id='impl-RenderPassDescClearValues%3CC%3E-3' class='impl'><code class='in-band'>impl<T, C> RenderPassDescClearValues<C> 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.RenderPassDescClearValues.html" title="trait vulkano::framebuffer::RenderPassDescClearValues">RenderPassDescClearValues</a><C>, </span></code><a href='#impl-RenderPassDescClearValues%3CC%3E-3' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/traits.rs.html#140-148' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.convert_clear_values-5' class="method hidden"><code id='convert_clear_values.v-6'>fn <a href='#method.convert_clear_values-5' class='fnname'>convert_clear_values</a>(&self, vals: C) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="enum" href="../../vulkano/format/enum.ClearValue.html" title="enum vulkano::format::ClearValue">ClearValue</a>>></code><a class='srclink' href='../../src/vulkano/framebuffer/traits.rs.html#145-147' title='goto source code'>[src]</a></h4></div></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/framebuffer/trait.RenderPassDescClearValues.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> |