|
|
|
|
<!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 `ImmutableImage` struct in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, ImmutableImage"><title>vulkano::image::immutable::ImmutableImage - 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 struct"><!--[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'>Struct ImmutableImage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.dimensions">dimensions</a><a href="#method.from_buffer">from_buffer</a><a href="#method.from_iter">from_iter</a><a href="#method.mipmap_levels">mipmap_levels</a><a href="#method.new">new</a><a href="#method.uninitialized">uninitialized</a><a href="#method.with_mipmaps">with_mipmaps</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-ImageAccess">ImageAccess</a><a href="#impl-ImageContent%3CP%3E">ImageContent<P></a><a href="#impl-ImageViewAccess">ImageViewAccess</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-Content">Content</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-ImageAccess">ImageAccess</a><a href="#impl-ImageViewAccess">ImageViewAccess</a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>image</a>::<wbr><a href='index.html'>immutable</a></p><script>window.sidebarCurrent = {name: 'ImmutableImage', ty: 'struct', 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'><sp
|
|
|
|
|
but then you must only ever read from it.</p>
|
|
|
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<F> <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#72-255' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a><'a, I>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>, <br> format: F, <br> queue_families: I<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F>>, <a class="enum" href="../../../vulkano/image/sys/enum.ImageCreationError.html" title="enum vulkano::image::sys::ImageCreationError">ImageCreationError</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../vulkano/format/trait.FormatDesc.html" title="trait vulkano::format::FormatDesc">FormatDesc</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a><'a>>, </span></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#75-86' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab deprecated'>Deprecated: <p>use ImmutableImage::uninitialized instead</p>
|
|
|
|
|
</div></div><h4 id='method.with_mipmaps' class="method"><code id='with_mipmaps.v'>pub fn <a href='#method.with_mipmaps' class='fnname'>with_mipmaps</a><'a, I, M>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>, <br> format: F, <br> mipmaps: M, <br> queue_families: I<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F>>, <a class="enum" href="../../../vulkano/image/sys/enum.ImageCreationError.html" title="enum vulkano::image::sys::ImageCreationError">ImageCreationError</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../vulkano/format/trait.FormatDesc.html" title="trait vulkano::format::FormatDesc">FormatDesc</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a><'a>>,<br> M: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../../vulkano/image/enum.MipmapsCount.html" title="enum vulkano::image::MipmapsCount">MipmapsCount</a>>, </span></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#90-113' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab deprecated'>Deprecated: <p>use ImmutableImage::uninitialized instead</p>
|
|
|
|
|
</div></div><h4 id='method.uninitialized' class="method"><code id='uninitialized.v'>pub fn <a href='#method.uninitialized' class='fnname'>uninitialized</a><'a, I, M>(<br> device: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/device/struct.Device.html" title="struct vulkano::device::Device">Device</a>>, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>, <br> format: F, <br> mipmaps: M, <br> usage: <a class="struct" href="../../../vulkano/image/struct.ImageUsage.html" title="struct vulkano::image::ImageUsage">ImageUsage</a>, <br> layout: <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>, <br> queue_families: I<br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F>>, <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImageInitialization.html" title="struct vulkano::image::immutable::ImmutableImageInitialization">ImmutableImageInitialization</a><F><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/image/sys/enum.ImageCreationError.html" title="enum vulkano::image::sys::ImageCreationError">ImageCreationError</a>> <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../vulkano/format/trait.FormatDesc.html" title="trait vulkano::format::FormatDesc">FormatDesc</a>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = <a class="struct" href="../../../vulkano/instance/struct.QueueFamily.html" title="struct vulkano::instance::QueueFamily">QueueFamily</a><'a>>,<br> M: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="enum" href="../../../vulkano/image/enum.MipmapsCount.html" title="enum vulkano::image::MipmapsCount">MipmapsCount</a>>, </span></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#118-187' title='goto source code'>[src]</a></h4><div class='docblock'><p>Builds an uninitialized immutable image.</p>
|
|
|
|
|
<p>Returns two things: the image, and a special access that should be used for the initial upload to the image.</p>
|
|
|
|
|
</div><h4 id='method.from_iter' class="method"><code id='from_iter.v'>pub fn <a href='#method.from_iter' class='fnname'>from_iter</a><P, I>(<br> iter: I, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>, <br> format: F, <br> queue: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/device/struct.Queue.html" title="struct vulkano::device::Queue">Queue</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>, <a class="struct" href="../../../vulkano/command_buffer/struct.CommandBufferExecFuture.html" title="struct vulkano::command_buffer::CommandBufferExecFuture">CommandBufferExecFuture</a><<a class="struct" href="../../../vulkano/sync/struct.NowFuture.html" title="struct vulkano::sync::NowFuture">NowFuture</a>, <a class="struct" href="../../../vulkano/command_buffer/struct.AutoCommandBuffer.html" title="struct vulkano::command_buffer::AutoCommandBuffer">AutoCommandBuffer</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/image/sys/enum.ImageCreationError.html" title="enum vulkano::image::sys::ImageCreationError">ImageCreationError</a>> <span class="where fmt-newline">where<br> P: <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> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + 'static,<br> F: <a class="trait" href="../../../vulkano/format/trait.FormatDesc.html" title="trait vulkano::format::FormatDesc">FormatDesc</a> + <a class="trait" href="../../../vulkano/format/trait.AcceptsPixels.html" title="trait vulkano::format::AcceptsPixels">AcceptsPixels</a><P> + '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>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a><Item = P>,<br> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a>: <a class="trait" href="../../../vulkano/format/trait.AcceptsPixels.html" title="trait vulkano::format::AcceptsPixels">AcceptsPixels</a><P>, </span></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#193-206' title='goto source code'>[src]</a></h4><div class='docblock'><p>Construct an ImmutableImage from the contents of <code>iter</code>.</p>
|
|
|
|
|
<p>TODO: Support mipmaps</p>
|
|
|
|
|
</div><h4 id='method.from_buffer' class="method"><code id='from_buffer.v'>pub fn <a href='#method.from_buffer' class='fnname'>from_buffer</a><B, P>(<br> source: B, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.Dimensions.html" title="enum vulkano::image::Dimensions">Dimensions</a>, <br> format: F, <br> queue: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><<a class="struct" href="../../../vulkano/device/struct.Queue.html" title="struct vulkano::device::Queue">Queue</a>><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html" title="struct alloc::sync::Arc">Arc</a><Self>, <a class="struct" href="../../../vulkano/command_buffer/struct.CommandBufferExecFuture.html" title="struct vulkano::command_buffer::CommandBufferExecFuture">CommandBufferExecFuture</a><<a class="struct" href="../../../vulkano/sync/struct.NowFuture.html" title="struct vulkano::sync::NowFuture">NowFuture</a>, <a class="struct" href="../../../vulkano/command_buffer/struct.AutoCommandBuffer.html" title="struct vulkano::command_buffer::AutoCommandBuffer">AutoCommandBuffer</a>><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../../../vulkano/image/sys/enum.ImageCreationError.html" title="enum vulkano::image::sys::ImageCreationError">ImageCreationError</a>> <span class="where fmt-newline">where<br> B: <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a> + <a class="trait" href="../../../vulkano/buffer/trait.TypedBufferAccess.html" title="trait vulkano::buffer::TypedBufferAccess">TypedBufferAccess</a><Content = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + <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>,<br> P: <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> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> + 'static,<br> F: <a class="trait" href="../../../vulkano/format/trait.FormatDesc.html" title="trait vulkano::format::FormatDesc">FormatDesc</a> + <a class="trait" href="../../../vulkano/format/trait.AcceptsPixels.html" title="trait vulkano::format::AcceptsPixels">AcceptsPixels</a><P> + '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>,<br> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a>: <a class="trait" href="../../../vulkano/format/trait.AcceptsPixels.html" title="trait vulkano::format::AcceptsPixels">AcceptsPixels</a><P>, </span></code><a class='srclink' href='../../../src/vu
|
|
|
|
|
<p>TODO: Support mipmaps</p>
|
|
|
|
|
</div></div><h3 id='impl-1' class='impl'><code class='in-band'>impl<F, A> <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A></code><a href='#impl-1' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#257-269' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.dimensions' class="method"><code id='dimensions.v'>pub 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/immutable.rs.html#260-262' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the dimensions of the image.</p>
|
|
|
|
|
</div><h4 id='method.mipmap_levels' class="method"><code id='mipmap_levels.v'>pub fn <a href='#method.mipmap_levels' class='fnname'>mipmap_levels</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#266-268' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns the number of mipmap levels of the image.</p>
|
|
|
|
|
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-ImageAccess' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</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-ImageAccess' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#271-339' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.inner' class="method hidden"><code id='inner.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.inner' class='fnname'>inner</a>(&self) -> <a class="struct" href="../../../vulkano/image/traits/struct.ImageInner.html" title="struct vulkano::image::traits::ImageInner">ImageInner</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#275-283' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the inner unsafe image object used by this image.</p>
|
|
|
|
|
</div><h4 id='method.initial_layout_requirement' class="method hidden"><code id='initial_layout_requirement.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.initial_layout_requirement' class='fnname'>initial_layout_requirement</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/immutable.rs.html#286-288' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the layout that the image has when it is first used in a primary command buffer. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.initial_layout_requirement">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.final_layout_requirement' class="method hidden"><code id='final_layout_requirement.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.final_layout_requirement' class='fnname'>final_layout_requirement</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/immutable.rs.html#291-293' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the layout that the image must be returned to before the end of the command buffer. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.final_layout_requirement">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflicts_buffer' class="method hidden"><code id='conflicts_buffer.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_buffer' class='fnname'>conflicts_buffer</a>(&self, other: &dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#296-298' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if an access to <code>self</code> potentially overlaps the same memory as an access to <code>other</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_buffer">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflicts_image' class="method hidden"><code id='conflicts_image.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_image' class='fnname'>conflicts_image</a>(&self, other: &dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#301-303' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if an access to <code>self</code> potentially overlaps the same memory as an access to <code>other</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_image">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflict_key' class="method hidden"><code id='conflict_key.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflict_key' class='fnname'>conflict_key</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#306-308' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a key that uniquely identifies the memory content of the image. Two ranges that potentially overlap in memory must return the same key. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflict_key">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.try_gpu_lock' class="method hidden"><code id='try_gpu_lock.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.try_gpu_lock' class='fnname'>try_gpu_lock</a>(<br> &self, <br> exclusive_access: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> expected_layout: <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../../vulkano/sync/enum.AccessError.html" title="enum vulkano::sync::AccessError">AccessError</a>></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#311-329' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.try_gpu_lock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.increase_gpu_lock' class="method hidden"><code id='increase_gpu_lock.v'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.increase_gpu_lock' class='fnname'>increase_gpu_lock</a>(&self)</code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#332-333' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.increase_gpu_lock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.unlock' class="method hidden"><code id='unlock.v'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.unlock' class='fnname'>unlock</a>(&self, new_layout: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>>)</code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#336-338' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Unlocks the resource previously acquired with <code>try_gpu_lock</code> or <code>increase_gpu_lock</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.unlock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.format' class="method hidden"><code id='format.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#37-39' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the format of this image.</p>
|
|
|
|
|
</div><h4 id='method.has_color' class="method hidden"><code id='has_color.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_color' class='fnname'>has_color</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#43-46' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image is a color image.</p>
|
|
|
|
|
</div><h4 id='method.has_depth' class="method hidden"><code id='has_depth.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_depth' class='fnname'>has_depth</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#51-54' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image has a depth component. In other words, if it is a depth or a depth-stencil format. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.has_depth">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.has_stencil' class="method hidden"><code id='has_stencil.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_stencil' class='fnname'>has_stencil</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#59-62' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image has a stencil component. In other words, if it is a stencil or a depth-stencil format. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.has_stencil">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.mipmap_levels-1' class="method hidden"><code id='mipmap_levels.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.mipmap_levels' class='fnname'>mipmap_levels</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#66-69' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the number of mipmap levels of this image.</p>
|
|
|
|
|
</div><h4 id='method.samples' class="method hidden"><code id='samples.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.samples' class='fnname'>samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#73-75' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the number of samples of this image.</p>
|
|
|
|
|
</div><h4 id='method.dimensions-1' class="method hidden"><code id='dimensions.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageDimensions.html" title="enum vulkano::image::ImageDimensions">ImageDimensions</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#79-82' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the dimensions of the image.</p>
|
|
|
|
|
</div><h4 id='method.supports_blit_source' class="method hidden"><code id='supports_blit_source.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.supports_blit_source' class='fnname'>supports_blit_source</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#86-88' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image can be used as a source for blits.</p>
|
|
|
|
|
</div><h4 id='method.supports_blit_destination' class="method hidden"><code id='supports_blit_destination.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.supports_blit_destination' class='fnname'>supports_blit_destination</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#92-94' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image can be used as a destination for blits.</p>
|
|
|
|
|
</div><h4 id='method.layout_initialized' class="method hidden"><code id='layout_initialized.v'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.layout_initialized' class='fnname'>layout_initialized</a>(&self)</code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#109' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>When images are created their memory layout is initially <code>Undefined</code> or <code>Preinitialized</code>. This method allows the image memory barrier creation process to signal when an image has been transitioned out of its initial <code>Undefined</code> or <code>Preinitialized</code> state. This allows vulkano to avoid creating unnecessary image memory barriers between future uses of the image. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.layout_initialized">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.is_layout_initialized' class="method hidden"><code id='is_layout_initialized.v'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.is_layout_initialized' class='fnname'>is_layout_initialized</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#111' title='goto source code'>[src]</a></h4><h4 id='method.preinitialized_layout' class="method hidden"><code id='preinitialized_layout.v'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.preinitialized_layout' class='fnname'>preinitialized_layout</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#113-115' title='goto source code'>[src]</a></h4><h4 id='method.forced_undefined_initial_layout' class="method hidden"><code id='forced_undefined_initial_layout.v'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.forced_undefined_initial_layout' class='fnname'>forced_undefined_initial_layout</a>(<br> self, <br> preinitialized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="struct" href="../../../vulkano/image/traits/struct.ImageAccessFromUndefinedLayout.html" title="struct vulkano::image::traits::ImageAccessFromUndefinedLayout">ImageAccessFromUndefinedLayout</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#140-148' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Wraps around this <code>ImageAccess</code> and returns an identical <code>ImageAccess</code> but whose initial layout requirement is either <code>Undefined</code> or <code>Preinitialized</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.forced_undefined_initial_layout">Read more</a></p>
|
|
|
|
|
</div></div><h3 id='impl-ImageContent%3CP%3E' class='impl'><code class='in-band'>impl<P, F, A> <a class="trait" href="../../../vulkano/image/traits/trait.ImageContent.html" title="trait vulkano::image::traits::ImageContent">ImageContent</a><P> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</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-ImageContent%3CP%3E' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#341-348' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.matches_format' class="method hidden"><code id='matches_format.v'>fn <a href='../../../vulkano/image/traits/trait.ImageContent.html#tymethod.matches_format' class='fnname'>matches_format</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#345-347' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Checks whether pixels of type <code>P</code> match the format of the image.</p>
|
|
|
|
|
</div></div><h3 id='impl-ImageViewAccess' class='impl'><code class='in-band'>impl<F: 'static, A> <a class="trait" href="../../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</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/immutable.rs.html#350-392' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parent' class="method hidden"><code id='parent.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#354-356' title='goto source code'>[src]</a></h4><h4 id='method.dimensions-2' class="method hidden"><code id='dimensions.v-2'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.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/immutable.rs.html#359-361' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the dimensions of the image view.</p>
|
|
|
|
|
</div><h4 id='method.inner-1' class="method hidden"><code id='inner.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#364-366' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the inner unsafe image view object used by this image view.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_storage_image_layout' class="method hidden"><code id='descriptor_set_storage_image_layout.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#369-371' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_combined_image_sampler_layout' class="method hidden"><code id='descriptor_set_combined_image_sampler_layout.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#374-376' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_sampled_image_layout' class="method hidden"><code id='descriptor_set_sampled_image_layout.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#379-381' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_input_attachment_layout' class="method hidden"><code id='descriptor_set_input_attachment_layout.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#384-386' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.identity_swizzle' class="method hidden"><code id='identity_swizzle.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#389-391' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the view doesn't use components swizzling. <a href="../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.identity_swizzle">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.format-1' class="method hidden"><code id='format.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#400-403' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the format of this view. This can be different from the parent's format.</p>
|
|
|
|
|
</div><h4 id='method.samples-1' class="method hidden"><code id='samples.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#method.samples' class='fnname'>samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#406-408' title='goto source code'>[src]</a></h4><h4 id='method.can_be_sampled' class="method hidden"><code id='can_be_sampled.v'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#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><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#430-432' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the given sampler can be used with this image view. <a href="../../../vulkano/image/traits/trait.ImageViewAccess.html#method.can_be_sampled">Read more</a></p>
|
|
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#55' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../../src/vulkano/image/immutable.rs.html#55' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
|
|
|
|
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,<br> F: <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-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<F, A> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../../vulkano/image/immutable/struct.ImmutableImage.html" title="struct vulkano::image::immutable::ImmutableImage">ImmutableImage</a><F, A> <span class="where fmt-newline">where<br> A: <a class="trait" href="https://doc.rust-
|
|
|
|
|
</div><h4 id='method.initial_layout_requirement-1' class="method hidden"><code id='initial_layout_requirement.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.initial_layout_requirement' class='fnname'>initial_layout_requirement</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#263-265' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the layout that the image has when it is first used in a primary command buffer. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.initial_layout_requirement">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.final_layout_requirement-1' class="method hidden"><code id='final_layout_requirement.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.final_layout_requirement' class='fnname'>final_layout_requirement</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#268-270' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the layout that the image must be returned to before the end of the command buffer. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.final_layout_requirement">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflicts_buffer-1' class="method hidden"><code id='conflicts_buffer.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_buffer' class='fnname'>conflicts_buffer</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, &dyn <a class="trait" href="../../../vulkano/buffer/trait.BufferAccess.html" title="trait vulkano::buffer::BufferAccess">BufferAccess</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#273-275' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if an access to <code>self</code> potentially overlaps the same memory as an access to <code>other</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_buffer">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflicts_image-1' class="method hidden"><code id='conflicts_image.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_image' class='fnname'>conflicts_image</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, &dyn <a class="trait" href="../../../vulkano/image/traits/trait.ImageAccess.html" title="trait vulkano::image::traits::ImageAccess">ImageAccess</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#278-280' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if an access to <code>self</code> potentially overlaps the same memory as an access to <code>other</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflicts_image">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.conflict_key-1' class="method hidden"><code id='conflict_key.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflict_key' class='fnname'>conflict_key</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#283-285' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a key that uniquely identifies the memory content of the image. Two ranges that potentially overlap in memory must return the same key. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.conflict_key">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.try_gpu_lock-1' class="method hidden"><code id='try_gpu_lock.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.try_gpu_lock' class='fnname'>try_gpu_lock</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="enum" href="../../../vulkano/sync/enum.AccessError.html" title="enum vulkano::sync::AccessError">AccessError</a>></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#288-291' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Locks the resource for usage on the GPU. Returns an error if the lock can't be acquired. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.try_gpu_lock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.increase_gpu_lock-1' class="method hidden"><code id='increase_gpu_lock.v-1'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.increase_gpu_lock' class='fnname'>increase_gpu_lock</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#294-296' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.increase_gpu_lock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.unlock-1' class="method hidden"><code id='unlock.v-1'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.unlock' class='fnname'>unlock</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../../vulkano/image/enum.ImageLayout.html" title="enum vulkano::image::ImageLayout">ImageLayout</a>>)</code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#299-301' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Unlocks the resource previously acquired with <code>try_gpu_lock</code> or <code>increase_gpu_lock</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#tymethod.unlock">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.layout_initialized-1' class="method hidden"><code id='layout_initialized.v-1'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.layout_initialized' class='fnname'>layout_initialized</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#304-306' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>When images are created their memory layout is initially <code>Undefined</code> or <code>Preinitialized</code>. This method allows the image memory barrier creation process to signal when an image has been transitioned out of its initial <code>Undefined</code> or <code>Preinitialized</code> state. This allows vulkano to avoid creating unnecessary image memory barriers between future uses of the image. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.layout_initialized">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.is_layout_initialized-1' class="method hidden"><code id='is_layout_initialized.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.is_layout_initialized' class='fnname'>is_layout_initialized</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#309-311' title='goto source code'>[src]</a></h4><h4 id='method.format-2' class="method hidden"><code id='format.v-2'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#37-39' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the format of this image.</p>
|
|
|
|
|
</div><h4 id='method.has_color-1' class="method hidden"><code id='has_color.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_color' class='fnname'>has_color</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#43-46' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image is a color image.</p>
|
|
|
|
|
</div><h4 id='method.has_depth-1' class="method hidden"><code id='has_depth.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_depth' class='fnname'>has_depth</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#51-54' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image has a depth component. In other words, if it is a depth or a depth-stencil format. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.has_depth">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.has_stencil-1' class="method hidden"><code id='has_stencil.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.has_stencil' class='fnname'>has_stencil</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#59-62' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image has a stencil component. In other words, if it is a stencil or a depth-stencil format. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.has_stencil">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.mipmap_levels-2' class="method hidden"><code id='mipmap_levels.v-2'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.mipmap_levels' class='fnname'>mipmap_levels</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#66-69' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the number of mipmap levels of this image.</p>
|
|
|
|
|
</div><h4 id='method.samples-2' class="method hidden"><code id='samples.v-2'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.samples' class='fnname'>samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#73-75' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the number of samples of this image.</p>
|
|
|
|
|
</div><h4 id='method.dimensions-3' class="method hidden"><code id='dimensions.v-3'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="enum" href="../../../vulkano/image/enum.ImageDimensions.html" title="enum vulkano::image::ImageDimensions">ImageDimensions</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#79-82' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the dimensions of the image.</p>
|
|
|
|
|
</div><h4 id='method.supports_blit_source-1' class="method hidden"><code id='supports_blit_source.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.supports_blit_source' class='fnname'>supports_blit_source</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#86-88' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image can be used as a source for blits.</p>
|
|
|
|
|
</div><h4 id='method.supports_blit_destination-1' class="method hidden"><code id='supports_blit_destination.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.supports_blit_destination' class='fnname'>supports_blit_destination</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#92-94' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the image can be used as a destination for blits.</p>
|
|
|
|
|
</div><h4 id='method.preinitialized_layout-1' class="method hidden"><code id='preinitialized_layout.v-1'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.preinitialized_layout' class='fnname'>preinitialized_layout</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#113-115' title='goto source code'>[src]</a></h4><h4 id='method.forced_undefined_initial_layout-1' class="method hidden"><code id='forced_undefined_initial_layout.v-1'>unsafe fn <a href='../../../vulkano/image/traits/trait.ImageAccess.html#method.forced_undefined_initial_layout' class='fnname'>forced_undefined_initial_layout</a>(<br> self, <br> preinitialized: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a><br>) -> <a class="struct" href="../../../vulkano/image/traits/struct.ImageAccessFromUndefinedLayout.html" title="struct vulkano::image::traits::ImageAccessFromUndefinedLayout">ImageAccessFromUndefinedLayout</a><Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#140-148' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Wraps around this <code>ImageAccess</code> and returns an identical <code>ImageAccess</code> but whose initial layout requirement is either <code>Undefined</code> or <code>Preinitialized</code>. <a href="../../../vulkano/image/traits/trait.ImageAccess.html#method.forced_undefined_initial_layout">Read more</a></p>
|
|
|
|
|
</div></div><h3 id='impl-ImageViewAccess-1' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../vulkano/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a> 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 as <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a>>::<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/image/traits/trait.ImageViewAccess.html" title="trait vulkano::image::traits::ImageViewAccess">ImageViewAccess</a>, </span></code><a href='#impl-ImageViewAccess-1' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#437-482' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.parent-1' class="method hidden"><code id='parent.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.parent' class='fnname'>parent</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#442-444' title='goto source code'>[src]</a></h4><h4 id='method.inner-3' class="method hidden"><code id='inner.v-3'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.inner' class='fnname'>inner</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#447-449' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the inner unsafe image view object used by this image view.</p>
|
|
|
|
|
</div><h4 id='method.dimensions-4' class="method hidden"><code id='dimensions.v-4'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.dimensions' class='fnname'>dimensions</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#452-454' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the dimensions of the image view.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_storage_image_layout-1' class="method hidden"><code id='descriptor_set_storage_image_layout.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.descriptor_set_storage_image_layout' class='fnname'>descriptor_set_storage_image_layout</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#457-459' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_combined_image_sampler_layout-1' class="method hidden"><code id='descriptor_set_combined_image_sampler_layout.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.descriptor_set_combined_image_sampler_layout' class='fnname'>descriptor_set_combined_image_sampler_layout</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#461-463' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_sampled_image_layout-1' class="method hidden"><code id='descriptor_set_sampled_image_layout.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.descriptor_set_sampled_image_layout' class='fnname'>descriptor_set_sampled_image_layout</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#465-467' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.descriptor_set_input_attachment_layout-1' class="method hidden"><code id='descriptor_set_input_attachment_layout.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.descriptor_set_input_attachment_layout' class='fnname'>descriptor_set_input_attachment_layout</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</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/traits.rs.html#469-471' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the image layout to use in a descriptor with the given subresource.</p>
|
|
|
|
|
</div><h4 id='method.identity_swizzle-1' class="method hidden"><code id='identity_swizzle.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.identity_swizzle' class='fnname'>identity_swizzle</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#474-476' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the view doesn't use components swizzling. <a href="../../../vulkano/image/traits/trait.ImageViewAccess.html#tymethod.identity_swizzle">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.can_be_sampled-1' class="method hidden"><code id='can_be_sampled.v-1'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#method.can_be_sampled' class='fnname'>can_be_sampled</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self, &<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><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#479-481' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the given sampler can be used with this image view. <a href="../../../vulkano/image/traits/trait.ImageViewAccess.html#method.can_be_sampled">Read more</a></p>
|
|
|
|
|
</div><h4 id='method.format-3' class="method hidden"><code id='format.v-3'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#method.format' class='fnname'>format</a>(&self) -> <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#400-403' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the format of this view. This can be different from the parent's format.</p>
|
|
|
|
|
</div><h4 id='method.samples-3' class="method hidden"><code id='samples.v-3'>fn <a href='../../../vulkano/image/traits/trait.ImageViewAccess.html#method.samples' class='fnname'>samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code><a class='srclink' href='../../../src/vulkano/image/traits.rs.html#406-408' title='goto source code'>[src]</a></h4></div><h3 id='impl-Content' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../../vulkano/memory/trait.Content.html" title="trait vulkano::memory::Content">Content</a> for T</code><a href='#impl-Content' class='anchor'></a><a class='srclink' href='../../../src/vulkano/memory/mod.rs.html#171-190' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.ref_from_ptr' class="method hidden"><code id='ref_from_ptr.v'>fn <a href='../../../vulkano/memory/trait.Content.html#tymethod.ref_from_ptr' class='fnname'>ref_from_ptr</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut </a><a class="enum" href="https://doc.rust-lang.org/nightly/core/ffi/enum.c_void.html" title="enum core::ffi::c_void">c_void</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.pointer.html">*mut T</a>></code><a class='srclink' href='../../../src/vulkano/memory/mod.rs.html#173-179' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Builds a pointer to this type from a raw pointer.</p>
|
|
|
|
|
</div><h4 id='method.is_size_suitable' class="method hidden"><code id='is_size_suitable.v'>fn <a href='../../../vulkano/memory/trait.Content.html#tymethod.is_size_suitable' class='fnname'>is_size_suitable</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../../src/vulkano/memory/mod.rs.html#182-184' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns true if the size is suitable to store a type like this.</p>
|
|
|
|
|
</div><h4 id='method.indiv_size' class="method hidden"><code id='indiv_size.v'>fn <a href='../../../vulkano/memory/trait.Content.html#tymethod.indiv_size' class='fnname'>indiv_size</a>() -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../../src/vulkano/memory/mod.rs.html#187-189' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns the size of an individual element.</p>
|
|
|
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
|
|
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
|
|
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
|
|
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
|
|
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
|
|
|
|
</div></div></div></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>
|