|
|
<!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 `ColorSpace` enum in crate `vulkano`."><meta name="keywords" content="rust, rustlang, rust-lang, ColorSpace"><title>vulkano::swapchain::ColorSpace - 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 enum"><!--[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'>Enum ColorSpace</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.SrgbNonLinear">SrgbNonLinear</a><a href="#variant.DisplayP3NonLinear">DisplayP3NonLinear</a><a href="#variant.ExtendedSrgbLinear">ExtendedSrgbLinear</a><a href="#variant.DciP3Linear">DciP3Linear</a><a href="#variant.DciP3NonLinear">DciP3NonLinear</a><a href="#variant.Bt709Linear">Bt709Linear</a><a href="#variant.Bt709NonLinear">Bt709NonLinear</a><a href="#variant.Bt2020Linear">Bt2020Linear</a><a href="#variant.Hdr10St2084">Hdr10St2084</a><a href="#variant.DolbyVision">DolbyVision</a><a href="#variant.Hdr10Hlg">Hdr10Hlg</a><a href="#variant.AdobeRgbLinear">AdobeRgbLinear</a><a href="#variant.AdobeRgbNonLinear">AdobeRgbNonLinear</a><a href="#variant.PassThrough">PassThrough</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq%3CColorSpace%3E">PartialEq<ColorSpace></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-ToOwned">ToOwned</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'>swapchain</a></p><script>window.sidebarCurrent = {name: 'ColorSpace', ty: 'enum', 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/swapchain/capabilities.rs.html#558-573' title='goto source code'>[src]</a></span><span class='in-band'>Enum <a href='../index.html'>vulkano</a>::<wbr><a href='index.html'>swapchain</a>::<wbr><a class="enum" href=''>ColorSpace</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust enum'><span class="docblock attributes top-attr">#[repr(u32)]
|
|
|
</span>pub enum ColorSpace {
|
|
|
SrgbNonLinear,
|
|
|
DisplayP3NonLinear,
|
|
|
ExtendedSrgbLinear,
|
|
|
DciP3Linear,
|
|
|
DciP3NonLinear,
|
|
|
Bt709Linear,
|
|
|
Bt709NonLinear,
|
|
|
Bt2020Linear,
|
|
|
Hdr10St2084,
|
|
|
DolbyVision,
|
|
|
Hdr10Hlg,
|
|
|
AdobeRgbLinear,
|
|
|
AdobeRgbNonLinear,
|
|
|
PassThrough,
|
|
|
}</pre></div><div class='docblock'><p>How the presentation engine should interpret the data.</p>
|
|
|
<h1 id="a-quick-lesson-about-color-spaces" class="section-header"><a href="#a-quick-lesson-about-color-spaces">A quick lesson about color spaces</a></h1><h2 id="what-is-a-color-space" class="section-header"><a href="#what-is-a-color-space">What is a color space?</a></h2>
|
|
|
<p>Each pixel of a monitor is made of three components: one red, one green, and one blue. In the
|
|
|
past, computers would simply send to the monitor the intensity of each of the three components.</p>
|
|
|
<p>This proved to be problematic, because depending on the brand of the monitor the colors would
|
|
|
not exactly be the same. For example on some monitors, a value of <code>[1.0, 0.0, 0.0]</code> would be a
|
|
|
bit more orange than on others.</p>
|
|
|
<p>In order to standardize this, there exist what are called <em>color spaces</em>: sRGB, AdobeRGB,
|
|
|
DCI-P3, scRGB, etc. When you manipulate RGB values in a specific color space, these values have
|
|
|
a precise absolute meaning in terms of color, that is the same across all systems and monitors.</p>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: Color spaces are orthogonal to concept of RGB. <em>RGB</em> only indicates what is the
|
|
|
representation of the data, but not how it is interpreted. You can think of this a bit like
|
|
|
text encoding. An <em>RGB</em> value is a like a byte, in other words it is the medium by which
|
|
|
values are communicated, and a <em>color space</em> is like a text encoding (eg. UTF-8), in other
|
|
|
words it is the way the value should be interpreted.</p>
|
|
|
</blockquote>
|
|
|
<p>The most commonly used color space today is sRGB. Most monitors today use this color space,
|
|
|
and most images files are encoded in this color space.</p>
|
|
|
<h2 id="pixel-formats-and-linear-vs-non-linear" class="section-header"><a href="#pixel-formats-and-linear-vs-non-linear">Pixel formats and linear vs non-linear</a></h2>
|
|
|
<p>In Vulkan all images have a specific format in which the data is stored. The data of an image
|
|
|
consists of pixels in RGB but contains no information about the color space (or lack thereof)
|
|
|
of these pixels. You are free to store them in whatever color space you want.</p>
|
|
|
<p>But one big practical problem with color spaces is that they are sometimes not linear, and in
|
|
|
particular the popular sRGB color space is not linear. In a non-linear color space, a value of
|
|
|
<code>[0.6, 0.6, 0.6]</code> for example is <strong>not</strong> twice as bright as a value of <code>[0.3, 0.3, 0.3]</code>. This
|
|
|
is problematic, because operations such as taking the average of two colors or calculating the
|
|
|
lighting of a texture with a dot product are mathematically incorrect and will produce
|
|
|
incorrect colors.</p>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: If the texture format has an alpha component, it is not affected by the color space
|
|
|
and always behaves linearly.</p>
|
|
|
</blockquote>
|
|
|
<p>In order to solve this Vulkan also provides image formats with the <code>Srgb</code> suffix, which are
|
|
|
expected to contain RGB data in the sRGB color space. When you sample an image with such a
|
|
|
format from a shader, the implementation will automatically turn the pixel values into a linear
|
|
|
color space that is suitable for linear operations (such as additions or multiplications).
|
|
|
When you write to a framebuffer attachment with such a format, the implementation will
|
|
|
automatically perform the opposite conversion. These conversions are most of the time performed
|
|
|
by the hardware and incur no additional cost.</p>
|
|
|
<h2 id="color-space-of-the-swapchain" class="section-header"><a href="#color-space-of-the-swapchain">Color space of the swapchain</a></h2>
|
|
|
<p>The color space that you specify when you create a swapchain is how the implementation will
|
|
|
interpret the raw data inside of the image.</p>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: The implementation can choose to send the data in the swapchain image directly to
|
|
|
the monitor, but it can also choose to write it in an intermediary buffer that is then read
|
|
|
by the operating system or windowing system. Therefore the color space that the
|
|
|
implementation supports is not necessarily the same as the one supported by the monitor.</p>
|
|
|
</blockquote>
|
|
|
<p>It is <em>your</em> job to ensure that the data in the swapchain image is in the color space
|
|
|
that is specified here, otherwise colors will be incorrect.
|
|
|
The implementation will never perform any additional automatic conversion after the colors have
|
|
|
been written to the swapchain image.</p>
|
|
|
<h1 id="how-do-i-handle-this-correctly" class="section-header"><a href="#how-do-i-handle-this-correctly">How do I handle this correctly?</a></h1>
|
|
|
<p>The easiest way to handle color spaces in a cross-platform program is:</p>
|
|
|
<ul>
|
|
|
<li>Always request the <code>SrgbNonLinear</code> color space when creating the swapchain.</li>
|
|
|
<li>Make sure that all your image files use the sRGB color space, and load them in images whose
|
|
|
format has the <code>Srgb</code> suffix. Only use non-sRGB image formats for intermediary computations
|
|
|
or to store non-color data.</li>
|
|
|
<li>Swapchain images should have a format with the <code>Srgb</code> suffix.</li>
|
|
|
</ul>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: It is unclear whether the <code>SrgbNonLinear</code> color space is always supported by the
|
|
|
the implementation or not. See https://github.com/KhronosGroup/Vulkan-Docs/issues/442.</p>
|
|
|
</blockquote>
|
|
|
<blockquote>
|
|
|
<p><strong>Note</strong>: Lots of developers are confused by color spaces. You can sometimes find articles
|
|
|
talking about gamma correction and suggestion to put your colors to the power 2.2 for
|
|
|
example. These are all hacks and you should use the sRGB pixel formats instead.</p>
|
|
|
</blockquote>
|
|
|
<p>If you follow these three rules, then everything should render the same way on all platforms.</p>
|
|
|
<p>Additionally you can try detect whether the implementation supports any additional color space
|
|
|
and perform a manual conversion to that color space from inside your shader.</p>
|
|
|
</div><h2 id='variants' class='variants small-section-header'>
|
|
|
Variants<a href='#variants' class='anchor'></a></h2>
|
|
|
<div id="variant.SrgbNonLinear" class="variant small-section-header"><a href="#variant.SrgbNonLinear" class="anchor field"></a><code id='SrgbNonLinear.v'>SrgbNonLinear</code></div><div id="variant.DisplayP3NonLinear" class="variant small-section-header"><a href="#variant.DisplayP3NonLinear" class="anchor field"></a><code id='DisplayP3NonLinear.v'>DisplayP3NonLinear</code></div><div id="variant.ExtendedSrgbLinear" class="variant small-section-header"><a href="#variant.ExtendedSrgbLinear" class="anchor field"></a><code id='ExtendedSrgbLinear.v'>ExtendedSrgbLinear</code></div><div id="variant.DciP3Linear" class="variant small-section-header"><a href="#variant.DciP3Linear" class="anchor field"></a><code id='DciP3Linear.v'>DciP3Linear</code></div><div id="variant.DciP3NonLinear" class="variant small-section-header"><a href="#variant.DciP3NonLinear" class="anchor field"></a><code id='DciP3NonLinear.v'>DciP3NonLinear</code></div><div id="variant.Bt709Linear" class="variant small-section-header"><a href="#variant.Bt709Linear" class="anchor field"></a><code id='Bt709Linear.v'>Bt709Linear</code></div><div id="variant.Bt709NonLinear" class="variant small-section-header"><a href="#variant.Bt709NonLinear" class="anchor field"></a><code id='Bt709NonLinear.v'>Bt709NonLinear</code></div><div id="variant.Bt2020Linear" class="variant small-section-header"><a href="#variant.Bt2020Linear" class="anchor field"></a><code id='Bt2020Linear.v'>Bt2020Linear</code></div><div id="variant.Hdr10St2084" class="variant small-section-header"><a href="#variant.Hdr10St2084" class="anchor field"></a><code id='Hdr10St2084.v'>Hdr10St2084</code></div><div id="variant.DolbyVision" class="variant small-section-header"><a href="#variant.DolbyVision" class="anchor field"></a><code id='DolbyVision.v'>DolbyVision</code></div><div id="variant.Hdr10Hlg" class="variant small-section-header"><a href="#variant.Hdr10Hlg" class="anchor field"></a><code id='Hdr10Hlg.v'>Hdr10Hlg</code></div><div id="variant.AdobeRgbLinear" class="variant small-section-header"><a href="#variant.AdobeRgbLinear" class="anchor field"></a><code id='AdobeRgbLinear.v'>AdobeRgbLinear</code></div><div id="variant.AdobeRgbNonLinear" class="variant small-section-header"><a href="#variant.AdobeRgbNonLinear" class="anchor field"></a><code id='AdobeRgbNonLinear.v'>AdobeRgbNonLinear</code></div><div id="variant.PassThrough" class="variant small-section-header"><a href="#variant.PassThrough" class="anchor field"></a><code id='PassThrough.v'>PassThrough</code></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Eq' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a href='#impl-Eq' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
|
|
</div></div><h3 id='impl-PartialEq%3CColorSpace%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a>> for <a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a href='#impl-PartialEq%3CColorSpace%3E' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|
|
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'><span class="docblock attributes">#[must_use]
|
|
|
</span>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Rhs) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/cmp.rs.html#208' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
|
|
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' title='goto source code'>[src]</a></h3><div class='impl-items'></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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/vulkano/swapchain/capabilities.rs.html#556' 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/swapchain/capabilities.rs.html#556' 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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</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="enum" href="../../vulkano/swapchain/enum.ColorSpace.html" title="enum vulkano::swapchain::ColorSpace">ColorSpace</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-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <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/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></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> |
