mitchellhansen
/
Trac3r-rust
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'da836f318e'
${ noResults }
Trac3r-rust/doc/vulkano/framebuffer/trait.FramebufferAbstract.html

24 lines
16 KiB
Raw Normal View History Unescape

add doc
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 `FramebufferAbstract` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, FramebufferAbstract"><title>vulkano::framebuffer::FramebufferAbstract - 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 FramebufferAbstract</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.attached_image_view">attached_image_view</a><a href="#tymethod.dimensions">dimensions</a><a href="#tymethod.inner">inner</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.height">height</a><a href="#method.layers">layers</a><a href="#method.width">width</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: 'FramebufferAbstract', 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/framebuffer/traits.rs.html#24-53' 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=''>FramebufferAbstract</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe trait FramebufferAbstract: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassAbstract.html" title="trait vulkano::framebuffer::RenderPassAbstract">RenderPassAbstract</a> {
fn <a href='#tymethod.inner' class='fnname'>inner</a>(&amp;self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.FramebufferSys.html" title="struct vulkano::framebuffer::FramebufferSys">FramebufferSys</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</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.array.html">; 3]</a>;
<div class='item-spacer'></div> fn <a href='#tymethod.attached_image_view' class='fnname'>attached_image_view</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&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;dyn <a class="trait" href="../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>&gt;;
fn <a href='#method.width' class='fnname'>width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.height' class='fnname'>height</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a> { ... }
<div class='item-spacer'></div> fn <a href='#method.layers' class='fnname'>layers</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a> { ... }
}</pre></div><div class='docblock'><p>Trait for objects that contain a Vulkan framebuffer object.</p>
<p>Any <code>Framebuffer</code> object implements this trait. You can therefore turn a <code>Arc&lt;Framebuffer&lt;_&gt;&gt;</code>
into a <code>Arc&lt;FramebufferAbstract + Send + Sync&gt;</code> for easier storage.</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>(&amp;self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.FramebufferSys.html" title="struct vulkano::framebuffer::FramebufferSys">FramebufferSys</a></code></h3><div class='docblock'><p>Returns an opaque struct that represents the framebuffer's internals.</p>
</div><h3 id='tymethod.dimensions' class='method'><code id='dimensions.v'>fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</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.array.html">; 3]</a></code></h3><div class='docblock'><p>Returns the width, height and array layers of the framebuffer.</p>
</div><h3 id='tymethod.attached_image_view' class='method'><code id='attached_image_view.v'>fn <a href='#tymethod.attached_image_view' class='fnname'>attached_image_view</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&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;dyn <a class="trait" href="../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>&gt;</code></h3><div class='docblock'><p>Returns the attachment of the framebuffer with the given index.</p>
<p>If the <code>index</code> is not between <code>0</code> and <code>num_attachments</code>, then <code>None</code> should be returned.</p>
</div></div><span class='loading-content'>Loading content...</span>
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.width' class='method'><code id='width.v'>fn <a href='#method.width' class='fnname'>width</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Returns the width of the framebuffer in pixels.</p>
</div><h3 id='method.height' class='method'><code id='height.v'>fn <a href='#method.height' class='fnname'>height</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Returns the height of the framebuffer in pixels.</p>
</div><h3 id='method.layers' class='method'><code id='layers.v'>fn <a href='#method.layers' class='fnname'>layers</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><div class='docblock'><p>Returns the number of layers (or depth) of the framebuffer.</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-FramebufferAbstract' class='impl'><code class='in-band'>impl&lt;Rp, A&gt; FramebufferAbstract for <a class="struct" href="../../vulkano/framebuffer/struct.Framebuffer.html" title="struct vulkano::framebuffer::Framebuffer">Framebuffer</a>&lt;Rp, A&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Rp: <a class="trait" href="../../vulkano/framebuffer/trait.RenderPassAbstract.html" title="trait vulkano::framebuffer::RenderPassAbstract">RenderPassAbstract</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;A: <a class="trait" href="../../vulkano/framebuffer/trait.AttachmentsList.html" title="trait vulkano::framebuffer::AttachmentsList">AttachmentsList</a>,&nbsp;</span></code><a href='#impl-FramebufferAbstract' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#364-382' 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>(&amp;self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.FramebufferSys.html" title="struct vulkano::framebuffer::FramebufferSys">FramebufferSys</a></code><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#369-371' title='goto source code'>[src]</a></h4><h4 id='method.dimensions' class="method hidden"><code id='dimensions.v-1'>fn <a href='#method.dimensions' class='fnname'>dimensions</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">[</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.array.html">; 3]</a></code><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#374-376' title='goto source code'>[src]</a></h4><h4 id='method.attached_image_view' class="method hidden"><code id='attached_image_view.v-1'>fn <a href='#method.attached_image_view' class='fnname'>attached_image_view</a>(&amp;self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -&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;dyn <a class="trait" href="../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>&gt;</code><a class='srclink' href='../../src/vulkano/framebuffer/framebuffer.rs.html#379-381' title='goto source code'>[src]</a></h4></div><h3 id='impl-FramebufferAbstract-1' class='impl'><code class='in-band'>impl&lt;T&gt; FramebufferAbstract for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: <a class="trait" href="../../vulkano/trait.SafeDeref.html" title="trait vulkano::SafeDeref">SafeDeref</a>,<br>&nbsp;&nbsp;&nbsp;&nbsp;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.FramebufferAbstract.html" title="trait vulkano::framebuffer::FramebufferAbstract">FramebufferAbstract</a>,&nbsp;</span></code><a href='#impl-FramebufferAbstract-1' class='anchor'></a><a class='srclink' href='../../src/vulkano/framebuffer/traits.rs.html#55-73' 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>(&amp;self) -&gt; <a class="struct" href="../../vulkano/framebuffer/struct.FramebufferSys.html" title="struct vulkano::framebuffer::FramebufferSys">FramebufferSys</a></code><a class='srclink' href='../../src/vulkano/framebuffer/traits.rs.html#60-62' title='goto source code'>[src]</a></h4><h4 id='method.dimensions-1' class="method hidden"><code i
src="../../implementors/vulkano/framebuffer/trait.FramebufferAbstract.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>