|
|
<!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 `UnsafeImage` struct in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, UnsafeImage"><title>vulkano::image::sys::UnsafeImage - 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 UnsafeImage</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.bind_memory">bind_memory</a><a href="#method.color_linear_layout">color_linear_layout</a><a href="#method.depth_linear_layout">depth_linear_layout</a><a href="#method.device">device</a><a href="#method.dimensions">dimensions</a><a href="#method.format">format</a><a href="#method.from_raw">from_raw</a><a href="#method.key">key</a><a href="#method.mipmap_levels">mipmap_levels</a><a href="#method.new">new</a><a href="#method.preinitialized_layout">preinitialized_layout</a><a href="#method.samples">samples</a><a href="#method.stencil_linear_layout">stencil_linear_layout</a><a href="#method.supports_blit_destination">supports_blit_destination</a><a href="#method.supports_blit_source">supports_blit_source</a><a href="#method.supports_linear_filtering">supports_linear_filtering</a><a href="#method.usage_color_attachment">usage_color_attachment</a><a href="#method.usage_depth_stencil_attachment">usage_depth_stencil_attachment</a><a href="#method.usage_input_attachment">usage_input_attachment</a><a href="#method.usage_sampled">usage_sampled</a><a href="#method.usage_storage">usage_storage</a><a href="#method.usage_transfer_destination">usage_transfer_destination</a><a href="#method.usage_transfer_source">usage_transfer_source</a><a href="#method.usage_transient_attachment">usage_transient_attachment</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Drop">Drop</a><a href="#impl-VulkanObject">VulkanObject</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-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'>sys</a></p><script>window.sidebarCurrent = {name: 'UnsafeImage', 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'><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/sys.rs.html#55-71' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../../index.html'>vulkano</a>::<wbr><a href='../index.html'>image</a>::<wbr><a href='index.html'>sys</a>::<wbr><a class="struct" href=''>UnsafeImage</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'>pub struct UnsafeImage { /* fields omitted */ }</pre></div><div class='docblock'><p>A storage for pixels or arbitrary data.</p>
|
|
|
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
|
|
|
<p>This type is not just unsafe but very unsafe. Don't use it directly.</p>
|
|
|
<ul>
|
|
|
<li>You must manually bind memory to the image with <code>bind_memory</code>. The memory must respect the
|
|
|
requirements returned by <code>new</code>.</li>
|
|
|
<li>The memory that you bind to the image must be manually kept alive.</li>
|
|
|
<li>The queue family ownership must be manually enforced.</li>
|
|
|
<li>The usage must be manually enforced.</li>
|
|
|
<li>The image layout must be manually enforced and transitioned.</li>
|
|
|
</ul>
|
|
|
</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 <a class="struct" href="../../../vulkano/image/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#73-789' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub unsafe fn <a href='#method.new' class='fnname'>new</a><'a, Mi, 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> usage: <a class="struct" href="../../../vulkano/image/struct.ImageUsage.html" title="struct vulkano::image::ImageUsage">ImageUsage</a>, <br> format: <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a>, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.ImageDimensions.html" title="enum vulkano::image::ImageDimensions">ImageDimensions</a>, <br> num_samples: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> mipmaps: Mi, <br> sharing: <a class="enum" href="../../../vulkano/sync/enum.Sharing.html" title="enum vulkano::sync::Sharing">Sharing</a><I>, <br> linear_tiling: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> preinitialized_layout: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</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="../../../vulkano/image/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a>, <a class="struct" href="../../../vulkano/memory/struct.MemoryRequirements.html" title="struct vulkano::memory::MemoryRequirements">MemoryRequirements</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> Mi: <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>>,<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>>, </span></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#83-105' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a new image and allocates memory for it.</p>
|
|
|
<h1 id="panic" class="section-header"><a href="#panic">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if one of the dimensions is 0.</li>
|
|
|
<li>Panics if the number of mipmaps is 0.</li>
|
|
|
<li>Panics if the number of samples is 0.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.from_raw' class="method"><code id='from_raw.v'>pub unsafe fn <a href='#method.from_raw' class='fnname'>from_raw</a>(<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> handle: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <br> usage: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> format: <a class="enum" href="../../../vulkano/format/enum.Format.html" title="enum vulkano::format::Format">Format</a>, <br> dimensions: <a class="enum" href="../../../vulkano/image/enum.ImageDimensions.html" title="enum vulkano::image::ImageDimensions">ImageDimensions</a>, <br> samples: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> mipmaps: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <a class="struct" href="../../../vulkano/image/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#564-587' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates an image from a raw handle. The image won't be destroyed.</p>
|
|
|
<p>This function is for example used at the swapchain's initialization.</p>
|
|
|
</div><h4 id='method.bind_memory' class="method"><code id='bind_memory.v'>pub unsafe fn <a href='#method.bind_memory' class='fnname'>bind_memory</a>(<br> &self, <br> memory: &<a class="struct" href="../../../vulkano/memory/struct.DeviceMemory.html" title="struct vulkano::memory::DeviceMemory">DeviceMemory</a>, <br> offset: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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/enum.OomError.html" title="enum vulkano::OomError">OomError</a>></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#589-608' title='goto source code'>[src]</a></h4><h4 id='method.device' class="method"><code id='device.v'>pub fn <a href='#method.device' class='fnname'>device</a>(&self) -> &<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>></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#611-613' title='goto source code'>[src]</a></h4><h4 id='method.format' class="method"><code id='format.v'>pub 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><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#616-618' title='goto source code'>[src]</a></h4><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/sys.rs.html#621-623' title='goto source code'>[src]</a></h4><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.ImageDimensions.html" title="enum vulkano::image::ImageDimensions">ImageDimensions</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#626-628' title='goto source code'>[src]</a></h4><h4 id='method.samples' class="method"><code id='samples.v'>pub 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><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#631-633' title='goto source code'>[src]</a></h4><h4 id='method.key' class="method"><code id='key.v'>pub fn <a href='#method.key' class='fnname'>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/sys.rs.html#637-639' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns a key unique to each <code>UnsafeImage</code>. Can be used for the <code>conflicts_key</code> method.</p>
|
|
|
</div><h4 id='method.color_linear_layout' class="method"><code id='color_linear_layout.v'>pub unsafe fn <a href='#method.color_linear_layout' class='fnname'>color_linear_layout</a>(&self, mip_level: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../../vulkano/image/sys/struct.LinearLayout.html" title="struct vulkano::image::sys::LinearLayout">LinearLayout</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#664-666' title='goto source code'>[src]</a></h4><div class='docblock'><p>Queries the layout of an image in memory. Only valid for images with linear tiling.</p>
|
|
|
<p>This function is only valid for images with a color format. See the other similar functions
|
|
|
for the other aspects.</p>
|
|
|
<p>The layout is invariant for each image. However it is not cached, as this would waste
|
|
|
memory in the case of non-linear-tiling images. You are encouraged to store the layout
|
|
|
somewhere in order to avoid calling this semi-expensive function at every single memory
|
|
|
access.</p>
|
|
|
<p>Note that while Vulkan allows querying the array layers other than 0, it is redundant as
|
|
|
you can easily calculate the position of any layer.</p>
|
|
|
<h1 id="panic-1" class="section-header"><a href="#panic-1">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if the mipmap level is out of range.</li>
|
|
|
</ul>
|
|
|
<h1 id="safety-1" class="section-header"><a href="#safety-1">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The image must <em>not</em> have a depth, stencil or depth-stencil format.</li>
|
|
|
<li>The image must have been created with linear tiling.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.depth_linear_layout' class="method"><code id='depth_linear_layout.v'>pub unsafe fn <a href='#method.depth_linear_layout' class='fnname'>depth_linear_layout</a>(&self, mip_level: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../../vulkano/image/sys/struct.LinearLayout.html" title="struct vulkano::image::sys::LinearLayout">LinearLayout</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#680-682' title='goto source code'>[src]</a></h4><div class='docblock'><p>Same as <code>color_linear_layout</code>, except that it retrieves the depth component of the image.</p>
|
|
|
<h1 id="panic-2" class="section-header"><a href="#panic-2">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if the mipmap level is out of range.</li>
|
|
|
</ul>
|
|
|
<h1 id="safety-2" class="section-header"><a href="#safety-2">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The image must have a depth or depth-stencil format.</li>
|
|
|
<li>The image must have been created with linear tiling.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.stencil_linear_layout' class="method"><code id='stencil_linear_layout.v'>pub unsafe fn <a href='#method.stencil_linear_layout' class='fnname'>stencil_linear_layout</a>(&self, mip_level: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="struct" href="../../../vulkano/image/sys/struct.LinearLayout.html" title="struct vulkano::image::sys::LinearLayout">LinearLayout</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#696-698' title='goto source code'>[src]</a></h4><div class='docblock'><p>Same as <code>color_linear_layout</code>, except that it retrieves the stencil component of the image.</p>
|
|
|
<h1 id="panic-3" class="section-header"><a href="#panic-3">Panic</a></h1>
|
|
|
<ul>
|
|
|
<li>Panics if the mipmap level is out of range.</li>
|
|
|
</ul>
|
|
|
<h1 id="safety-3" class="section-header"><a href="#safety-3">Safety</a></h1>
|
|
|
<ul>
|
|
|
<li>The image must have a stencil or depth-stencil format.</li>
|
|
|
<li>The image must have been created with linear tiling.</li>
|
|
|
</ul>
|
|
|
</div><h4 id='method.supports_blit_source' class="method"><code id='supports_blit_source.v'>pub fn <a href='#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/sys.rs.html#729-731' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the image can be used as a source for blits.</p>
|
|
|
</div><h4 id='method.supports_blit_destination' class="method"><code id='supports_blit_destination.v'>pub fn <a href='#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/sys.rs.html#735-737' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the image can be used as a destination for blits.</p>
|
|
|
</div><h4 id='method.supports_linear_filtering' class="method"><code id='supports_linear_filtering.v'>pub fn <a href='#method.supports_linear_filtering' class='fnname'>supports_linear_filtering</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/sys.rs.html#741-743' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the image can be sampled with a linear filtering.</p>
|
|
|
</div><h4 id='method.usage_transfer_source' class="method"><code id='usage_transfer_source.v'>pub fn <a href='#method.usage_transfer_source' class='fnname'>usage_transfer_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/sys.rs.html#746-748' title='goto source code'>[src]</a></h4><h4 id='method.usage_transfer_destination' class="method"><code id='usage_transfer_destination.v'>pub fn <a href='#method.usage_transfer_destination' class='fnname'>usage_transfer_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/sys.rs.html#751-753' title='goto source code'>[src]</a></h4><h4 id='method.usage_sampled' class="method"><code id='usage_sampled.v'>pub fn <a href='#method.usage_sampled' class='fnname'>usage_sampled</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/sys.rs.html#756-758' title='goto source code'>[src]</a></h4><h4 id='method.usage_storage' class="method"><code id='usage_storage.v'>pub fn <a href='#method.usage_storage' class='fnname'>usage_storage</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/sys.rs.html#761-763' title='goto source code'>[src]</a></h4><h4 id='method.usage_color_attachment' class="method"><code id='usage_color_attachment.v'>pub fn <a href='#method.usage_color_attachment' class='fnname'>usage_color_attachment</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/sys.rs.html#766-768' title='goto source code'>[src]</a></h4><h4 id='method.usage_depth_stencil_attachment' class="method"><code id='usage_depth_stencil_attachment.v'>pub fn <a href='#method.usage_depth_stencil_attachment' class='fnname'>usage_depth_stencil_attachment</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/sys.rs.html#771-773' title='goto source code'>[src]</a></h4><h4 id='method.usage_transient_attachment' class="method"><code id='usage_transient_attachment.v'>pub fn <a href='#method.usage_transient_attachment' class='fnname'>usage_transient_attachment</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/sys.rs.html#776-778' title='goto source code'>[src]</a></h4><h4 id='method.usage_input_attachment' class="method"><code id='usage_input_attachment.v'>pub fn <a href='#method.usage_input_attachment' class='fnname'>usage_input_attachment</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/sys.rs.html#781-783' title='goto source code'>[src]</a></h4><h4 id='method.preinitialized_layout' class="method"><code id='preinitialized_layout.v'>pub fn <a href='#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/sys.rs.html#786-788' title='goto source code'>[src]</a></h4></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-VulkanObject' class='impl'><code class='in-band'>impl <a class="trait" href="../../../vulkano/trait.VulkanObject.html" title="trait vulkano::VulkanObject">VulkanObject</a> for <a class="struct" href="../../../vulkano/image/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a href='#impl-VulkanObject' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#791-800' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Object' class="type"><code id='Object.t'>type <a href='../../../vulkano/trait.VulkanObject.html#associatedtype.Object' class="type">Object</a> = <a class="type" href="../../../vk_sys/type.Image.html" title="type vk_sys::Image">Image</a></code></h4><div class='docblock'><p>The type of the object.</p>
|
|
|
</div><h4 id='associatedconstant.TYPE' class="associatedconstant hidden"><code id='TYPE.v'>const <a href='../../../vulkano/trait.VulkanObject.html#associatedconstant.TYPE' class="constant"><b>TYPE</b></a>: <a class="type" href="../../../vk_sys/type.DebugReportObjectTypeEXT.html" title="type vk_sys::DebugReportObjectTypeEXT">DebugReportObjectTypeEXT</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#794' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>The <code>DebugReportObjectTypeEXT</code> of the internal Vulkan handle.</p>
|
|
|
</div><h4 id='method.internal_object' class="method hidden"><code id='internal_object.v'>fn <a href='../../../vulkano/trait.VulkanObject.html#tymethod.internal_object' class='fnname'>internal_object</a>(&self) -> <a class="type" href="../../../vk_sys/type.Image.html" title="type vk_sys::Image">Image</a></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#797-799' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a reference to the object.</p>
|
|
|
</div></div><h3 id='impl-Drop' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="../../../vulkano/image/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a href='#impl-Drop' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#809-821' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.drop' class="method hidden"><code id='drop.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop' class='fnname'>drop</a>(&mut self)</code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#811-820' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#802-807' 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, fmt: &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="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="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code><a class='srclink' href='../../../src/vulkano/image/sys.rs.html#804-806' 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 <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></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 <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></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 <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></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 <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></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 <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/sys/struct.UnsafeImage.html" title="struct vulkano::image::sys::UnsafeImage">UnsafeImage</a></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><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> |
