|
|
|
|
|
<!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 `ImageViewAccess` trait in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, ImageViewAccess"><title>vulkano::image::traits::ImageViewAccess - 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 ImageViewAccess</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_combined_image_sampler_layout">descriptor_set_combined_image_sampler_layout</a><a href="#tymethod.descriptor_set_input_attachment_layout">descriptor_set_input_attachment_layout</a><a href="#tymethod.descriptor_set_sampled_image_layout">descriptor_set_sampled_image_layout</a><a href="#tymethod.descriptor_set_storage_image_layout">descriptor_set_storage_image_layout</a><a href="#tymethod.dimensions">dimensions</a><a href="#tymethod.identity_swizzle">identity_swizzle</a><a href="#tymethod.inner">inner</a><a href="#tymethod.parent">parent</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.can_be_sampled">can_be_sampled</a><a href="#method.format">format</a><a href="#method.samples">samples</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'>image</a>::<wbr><a href='index.html'>traits</a></p><script>window.sidebarCurrent = {name: 'ImageViewAccess', 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/image/traits.rs.html#389-435' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>image</a>::<wbr><a href='index.html'>traits</a>::<wbr><a class="trait" href=''>ImageViewAccess</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub unsafe
|
|
|
|
|
|
fn <a href='#tymethod.parent' class='fnname'>parent</a>(&self) -> &dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.inner' class='fnname'>inner</a>(&self) -> &<a class="struct" href="../../../vulkano/image/sys/struct.UnsafeImageView.html" title="struct vulkano::image::sys::UnsafeImageView">UnsafeImageView</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.descriptor_set_storage_image_layout' class='fnname'>descriptor_set_storage_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.descriptor_set_combined_image_sampler_layout' class='fnname'>descriptor_set_combined_image_sampler_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.descriptor_set_sampled_image_layout' class='fnname'>descriptor_set_sampled_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.descriptor_set_input_attachment_layout' class='fnname'>descriptor_set_input_attachment_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.identity_swizzle' class='fnname'>identity_swizzle</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.samples' class='fnname'>samples</a>(&self) -> <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.can_be_sampled' class='fnname'>can_be_sampled</a>(&self, _sampler: &<a class="struct" href="../../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Trait for types that represent the GPU can access an image view.</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.parent' class='method'><code id='parent.v'>fn <a href='#tymethod.parent' class='fnname'>parent</a>(&self) -> &dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a></code></h3><h3 id='tymethod.dimensions' class='method'><code id='dimensions.v'>fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a></code></h3><div class='docblock'><p>Returns the dimensions of the image view.</p>
|
|
|
|
|
|
</div><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/image/sys/struct.UnsafeImageView.html" title="struct vulkano::image::sys::UnsafeImageView">UnsafeImageView</a></code></h3><div class='docblock'><p>Returns the inner unsafe image view object used by this image view.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.descriptor_set_storage_image_layout' class='method'><code id='descriptor_set_storage_image_layout.v'>fn <a href='#tymethod.descriptor_set_storage_image_layout' class='fnname'>descriptor_set_storage_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code></h3><div class='docblock'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.descriptor_set_combined_image_sampler_layout' class='method'><code id='descriptor_set_combined_image_sampler_layout.v'>fn <a href='#tymethod.descriptor_set_combined_image_sampler_layout' class='fnname'>descriptor_set_combined_image_sampler_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code></h3><div class='docblock'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.descriptor_set_sampled_image_layout' class='method'><code id='descriptor_set_sampled_image_layout.v'>fn <a href='#tymethod.descriptor_set_sampled_image_layout' class='fnname'>descriptor_set_sampled_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code></h3><div class='docblock'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.descriptor_set_input_attachment_layout' class='method'><code id='descriptor_set_input_attachment_layout.v'>fn <a href='#tymethod.descriptor_set_input_attachment_layout' class='fnname'>descriptor_set_input_attachment_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code></h3><div class='docblock'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.identity_swizzle' class='method'><code id='identity_swizzle.v'>fn <a href='#tymethod.identity_swizzle' class='fnname'>identity_swizzle</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the view doesn't use components swizzling.</p>
|
|
|
|
|
|
<p>Must be true when the view is used as a framebuffer attachment or TODO: I don't remember
|
|
|
|
|
|
the other thing.</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.format' class='method'><code id='format.v'>fn <a href='#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a></code></h3><div class='docblock'><p>Returns the format of this view. This can be different from the parent's format.</p>
|
|
|
|
|
|
</div><h3 id='method.samples' class='method'><code id='samples.v'>fn <a href='#method.samples' class='fnname'>samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></h3><h3 id='method.can_be_sampled' class='method'><code id='can_be_sampled.v'>fn <a href='#method.can_be_sampled' class='fnname'>can_be_sampled</a>(&self, _sampler: &<a class="struct" href="../../../vulkano/sampler/struct.Sampler.html" title="struct vulkano::sampler::Sampler">Sampler</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Returns true if the given sampler can be used with this image view.</p>
|
|
|
|
|
|
<p>This method should check whether the sampler's configuration can be used with the format
|
|
|
|
|
|
of the view.</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-ImageViewAccess' class='impl'><code class='in-band'>impl<F, A> ImageViewAccess for <a class="struct" href="../../../vulkano/image/attachment/struct.AttachmentImage.html" title="struct vulkano::image::attachment::AttachmentImage">AttachmentImage</a><F, A> <span class="where fmt-newline">where<br> F: 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-ImageViewAccess' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#530-576' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parent' class="method hidden"><code id='parent.v-1'>fn <a href='#method.parent' class='fnname'>parent</a>(&self) -> &dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#534-536' 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>(&self) -> <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#539-545' title='goto source code'>[src]</a></h4><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/image/sys/struct.UnsafeImageView.html" title="struct vulkano::image::sys::UnsafeImageView">UnsafeImageView</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#548-550' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_storage_image_layout' class="method hidden"><code id='descriptor_set_storage_image_layout.v-1'>fn <a href='#method.descriptor_set_storage_image_layout' class='fnname'>descriptor_set_storage_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#553-555' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_combined_image_sampler_layout' class="method hidden"><code id='descriptor_set_combined_image_sampler_layout.v-1'>fn <a href='#method.descriptor_set_combined_image_sampler_layout' class='fnname'>descriptor_set_combined_image_sampler_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#558-560' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_sampled_image_layout' class="method hidden"><code id='descriptor_set_sampled_image_layout.v-1'>fn <a href='#method.descriptor_set_sampled_image_layout' class='fnname'>descriptor_set_sampled_image_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a></code><a class='srclink' href='../../../src/vulkano/image/attachment.rs.html#563-565' title='goto source code'>[src]</a></h4><h4 id='method.descriptor_set_input_attachment_layout' class="method hidden"><code id='descriptor_set_input_attachment_layout.v-1'>fn <a href='#method.descriptor_set_input_attachment_layout' class='fnname'>descriptor_set_input_attachment_layout</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.
|
|
|
|
|
|
src="../../../implementors/vulkano/image/traits/trait.ImageViewAccess.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>
|
