<!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="Source to the Rust file `/home/mrh/source/vulkano/vulkano/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</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 source"><!--[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></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"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10"> 10</span>
<span id="11"> 11</span>
<span id="12"> 12</span>
<span id="13"> 13</span>
<span id="14"> 14</span>
<span id="15"> 15</span>
<span id="16"> 16</span>
<span id="17"> 17</span>
<span id="18"> 18</span>
<span id="19"> 19</span>
<span id="20"> 20</span>
<span id="21"> 21</span>
<span id="22"> 22</span>
<span id="23"> 23</span>
<span id="24"> 24</span>
<span id="25"> 25</span>
<span id="26"> 26</span>
<span id="27"> 27</span>
<span id="28"> 28</span>
<span id="29"> 29</span>
<span id="30"> 30</span>
<span id="31"> 31</span>
<span id="32"> 32</span>
<span id="33"> 33</span>
<span id="34"> 34</span>
<span id="35"> 35</span>
<span id="36"> 36</span>
<span id="37"> 37</span>
<span id="38"> 38</span>
<span id="39"> 39</span>
<span id="40"> 40</span>
<span id="41"> 41</span>
<span id="42"> 42</span>
<span id="43"> 43</span>
<span id="44"> 44</span>
<span id="45"> 45</span>
<span id="46"> 46</span>
<span id="47"> 47</span>
<span id="48"> 48</span>
<span id="49"> 49</span>
<span id="50"> 50</span>
<span id="51"> 51</span>
<span id="52"> 52</span>
<span id="53"> 53</span>
<span id="54"> 54</span>
<span id="55"> 55</span>
<span id="56"> 56</span>
<span id="57"> 57</span>
<span id="58"> 58</span>
<span id="59"> 59</span>
<span id="60"> 60</span>
<span id="61"> 61</span>
<span id="62"> 62</span>
<span id="63"> 63</span>
<span id="64"> 64</span>
<span id="65"> 65</span>
<span id="66"> 66</span>
<span id="67"> 67</span>
<span id="68"> 68</span>
<span id="69"> 69</span>
<span id="70"> 70</span>
<span id="71"> 71</span>
<span id="72"> 72</span>
<span id="73"> 73</span>
<span id="74"> 74</span>
<span id="75"> 75</span>
<span id="76"> 76</span>
<span id="77"> 77</span>
<span id="78"> 78</span>
<span id="79"> 79</span>
<span id="80"> 80</span>
<span id="81"> 81</span>
<span id="82"> 82</span>
<span id="83"> 83</span>
<span id="84"> 84</span>
<span id="85"> 85</span>
<span id="86"> 86</span>
<span id="87"> 87</span>
<span id="88"> 88</span>
<span id="89"> 89</span>
<span id="90"> 90</span>
<span id="91"> 91</span>
<span id="92"> 92</span>
<span id="93"> 93</span>
<span id="94"> 94</span>
<span id="95"> 95</span>
<span id="96"> 96</span>
<span id="97"> 97</span>
<span id="98"> 98</span>
<span id="99"> 99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">// Copyright (c) 2016 The vulkano developers</span>
<span class="comment">// Licensed under the Apache License, Version 2.0</span>
<span class="comment">// <LICENSE-APACHE or</span>
<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0> or the MIT</span>
<span class="comment">// license <LICENSE-MIT or http://opensource.org/licenses/MIT>,</span>
<span class="comment">// at your option. All files in the project carrying such</span>
<span class="comment">// notice may not be copied, modified, or distributed except</span>
<span class="comment">// according to those terms.</span>
<span class="attribute">#![<span class="ident">doc</span>(<span class="ident">html_logo_url</span> <span class="op">=</span> <span class="string">"https://raw.githubusercontent.com/vulkano-rs/vulkano/master/logo.png"</span>)]</span>
<span class="doccomment">//! Safe and rich Rust wrapper around the Vulkan API.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Brief summary of Vulkan</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - The [`Instance`](instance/struct.Instance.html) object is the API entry point. It is the</span>
<span class="doccomment">//! first object you must create before starting to use Vulkan.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - The [`PhysicalDevice`](instance/struct.PhysicalDevice.html) object represents an</span>
<span class="doccomment">//! implementation of Vulkan available on the system (eg. a graphics card, a software</span>
<span class="doccomment">//! implementation, etc.). Physical devices can be enumerated from an instance with</span>
<span class="doccomment">//! [`PhysicalDevice::enumerate()`](instance/struct.PhysicalDevice.html#method.enumerate).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - Once you have chosen a physical device to use, you can create a</span>
<span class="doccomment">//! [`Device`](device/index.html) object from it. The `Device` is the most important</span>
<span class="doccomment">//! object of Vulkan, as it represents an open channel of communication with a physical device.</span>
<span class="doccomment">//! You always need to have one before you can do interesting things with Vulkan.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - [*Buffers*](buffer/index.html) and [*images*](image/index.html) can be used to store data on</span>
<span class="doccomment">//! memory accessible by the GPU (or more generally by the Vulkan implementation). Buffers are</span>
<span class="doccomment">//! usually used to store information about vertices, lights, etc. or arbitrary data, while</span>
<span class="doccomment">//! images are used to store textures or multi-dimensional data.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - In order to show something on the screen, you need a [`Swapchain`](swapchain/index.html).</span>
<span class="doccomment">//! A `Swapchain` contains special `Image`s that correspond to the content of the window or the</span>
<span class="doccomment">//! monitor. When you *present* a swapchain, the content of one of these special images is shown</span>
<span class="doccomment">//! on the screen.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - In order to ask the GPU to do something, you must create a</span>
<span class="doccomment">//! [*command buffer*](command_buffer/index.html). A command buffer contains a list of commands</span>
<span class="doccomment">//! that the GPU must perform. This can include copies between buffers and images, compute</span>
<span class="doccomment">//! operations, or graphics operations. For the work to start, the command buffer must then be</span>
<span class="doccomment">//! submitted to a [`Queue`](device/struct.Queue.html), which is obtained when you create the</span>
<span class="doccomment">//! `Device`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - In order to be able to add a compute operation or a graphics operation to a command buffer,</span>
<span class="doccomment">//! you need to have created a [`ComputePipeline` or a `GraphicsPipeline`</span>
<span class="doccomment">//! object](pipeline/index.html) that describes the operation you want. These objects are usually</span>
<span class="doccomment">//! created during your program's initialization. `Shader`s are programs that the GPU will</span>
<span class="doccomment">//! execute as part of a pipeline. [*Descriptors*](descriptor/index.html) can be used to access</span>
<span class="doccomment">//! the content of buffers or images from within shaders.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - For graphical operations, [`RenderPass`es and `Framebuffer`s](framebuffer/index.html)</span>
<span class="doccomment">//! describe on which images the implementation must draw upon.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - Once you have built a *command buffer* that contains a list of commands, submitting it to the</span>
<span class="doccomment">//! GPU will return an object that implements [the `GpuFuture` trait](sync/index.html).</span>
<span class="doccomment">//! `GpuFuture`s allow you to chain multiple submissions together and are essential to performing</span>
<span class="doccomment">//! multiple operations on multiple different GPU queues.</span>
<span class="doccomment">//!</span>
<span class="comment">//#![warn(missing_docs)] // TODO: activate</span>
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span> <span class="comment">// TODO: remove</span>
<span class="attribute">#![<span class="ident">allow</span>(<span class="ident">unused_variables</span>)]</span> <span class="comment">// TODO: remove</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">crossbeam</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">fnv</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lazy_static</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">shared_library</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">smallvec</span>;
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">vk_sys</span> <span class="kw">as</span> <span class="ident">vk</span>;
<span class="kw">pub</span> <span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">half</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">tests</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">mod</span> <span class="ident">extensions</span>;
<span class="kw">mod</span> <span class="ident">features</span>;
<span class="kw">mod</span> <span class="ident">version</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">buffer</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">command_buffer</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">descriptor</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">device</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">format</span>;
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">framebuffer</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">image</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">instance</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">memory</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">pipeline</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">query</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sampler</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">swapchain</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">sync</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">error</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">fmt</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::<span class="ident">Deref</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">Arc</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">MutexGuard</span>;
<span class="doccomment">/// Alternative to the `Deref` trait. Contrary to `Deref`, must always return the same object.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">trait</span> <span class="ident">SafeDeref</span>: <span class="ident">Deref</span> {}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span> <span class="ident">SafeDeref</span> <span class="kw">for</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">T</span> {
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span> <span class="ident">SafeDeref</span> <span class="kw">for</span> <span class="ident">Arc</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">T</span>: <span class="question-mark">?</span><span class="ident">Sized</span><span class="op">></span> <span class="ident">SafeDeref</span> <span class="kw">for</span> <span class="ident">Box</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
}
<span class="kw">pub</span> <span class="kw">trait</span> <span class="ident">VulkanHandle</span> {
<span class="kw">fn</span> <span class="ident">value</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span>;
}
<span class="kw">impl</span> <span class="ident">VulkanHandle</span> <span class="kw">for</span> <span class="ident">usize</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">value</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { <span class="kw-2">*</span><span class="self">self</span> <span class="kw">as</span> <span class="ident">u64</span> }
}
<span class="kw">impl</span> <span class="ident">VulkanHandle</span> <span class="kw">for</span> <span class="ident">u64</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">value</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">u64</span> { <span class="kw-2">*</span><span class="self">self</span> }
}
<span class="doccomment">/// Gives access to the internal identifier of an object.</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">trait</span> <span class="ident">VulkanObject</span> {
<span class="doccomment">/// The type of the object.</span>
<span class="kw">type</span> <span class="ident">Object</span>: <span class="ident">VulkanHandle</span>;
<span class="doccomment">/// The `DebugReportObjectTypeEXT` of the internal Vulkan handle.</span>
<span class="kw">const</span> <span class="ident">TYPE</span>: <span class="ident">vk</span>::<span class="ident">DebugReportObjectTypeEXT</span>;
<span class="doccomment">/// Returns a reference to the object.</span>
<span class="kw">fn</span> <span class="ident">internal_object</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="self">Self</span>::<span class="ident">Object</span>;
}
<span class="doccomment">/// Gives access to the internal identifier of an object.</span>
<span class="comment">// TODO: remove ; crappy design</span>
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">trait</span> <span class="ident">SynchronizedVulkanObject</span> {
<span class="doccomment">/// The type of the object.</span>
<span class="kw">type</span> <span class="ident">Object</span>: <span class="ident">VulkanHandle</span>;
<span class="doccomment">/// Returns a reference to the object.</span>
<span class="kw">fn</span> <span class="ident">internal_object_guard</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">MutexGuard</span><span class="op"><</span><span class="self">Self</span>::<span class="ident">Object</span><span class="op">></span>;
}
<span class="doccomment">/// Error type returned by most Vulkan functions.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
<span class="kw">pub</span> <span class="kw">enum</span> <span class="ident">OomError</span> {
<span class="doccomment">/// There is no memory available on the host (ie. the CPU, RAM, etc.).</span>
<span class="ident">OutOfHostMemory</span>,
<span class="doccomment">/// There is no memory available on the device (ie. video memory).</span>
<span class="ident">OutOfDeviceMemory</span>,
}
<span class="kw">impl</span> <span class="ident">error</span>::<span class="ident">Error</span> <span class="kw">for</span> <span class="ident">OomError</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">description</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="kw-2">&</span><span class="ident">str</span> {
<span class="kw">match</span> <span class="kw-2">*</span><span class="self">self</span> {
<span class="ident">OomError</span>::<span class="ident">OutOfHostMemory</span> <span class="op">=</span><span class="op">></span> <span class="string">"no memory available on the host"</span>,
<span class="ident">OomError</span>::<span class="ident">OutOfDeviceMemory</span> <span class="op">=</span><span class="op">></span> <span class="string">"no memory available on the graphical device"</span>,
}
}
}
<span class="kw">impl</span> <span class="ident">fmt</span>::<span class="ident">Display</span> <span class="kw">for</span> <span class="ident">OomError</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">fmt</span>::<span class="ident">Formatter</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">fmt</span>::<span class="ident">Error</span><span class="op">></span> {
<span class="macro">write</span><span class="macro">!</span>(<span class="ident">fmt</span>, <span class="string">"{}"</span>, <span class="ident">error</span>::<span class="ident">Error</span>::<span class="ident">description</span>(<span class="self">self</span>))
}
}
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">Error</span><span class="op">></span> <span class="kw">for</span> <span class="ident">OomError</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">err</span>: <span class="ident">Error</span>) <span class="op">-</span><span class="op">></span> <span class="ident">OomError</span> {
<span class="kw">match</span> <span class="ident">err</span> {
<span class="ident">Error</span>::<span class="ident">OutOfHostMemory</span> <span class="op">=</span><span class="op">></span> <span class="ident">OomError</span>::<span class="ident">OutOfHostMemory</span>,
<span class="ident">Error</span>::<span class="ident">OutOfDeviceMemory</span> <span class="op">=</span><span class="op">></span> <span class="ident">OomError</span>::<span class="ident">OutOfDeviceMemory</span>,
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"unexpected error: {:?}"</span>, <span class="ident">err</span>),
}
}
}
<span class="doccomment">/// All possible success codes returned by any Vulkan function.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">u32</span>)]</span>
<span class="kw">enum</span> <span class="ident">Success</span> {
<span class="ident">Success</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">SUCCESS</span>,
<span class="ident">NotReady</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">NOT_READY</span>,
<span class="ident">Timeout</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">TIMEOUT</span>,
<span class="ident">EventSet</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">EVENT_SET</span>,
<span class="ident">EventReset</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">EVENT_RESET</span>,
<span class="ident">Incomplete</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">INCOMPLETE</span>,
<span class="ident">Suboptimal</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">SUBOPTIMAL_KHR</span>,
}
<span class="doccomment">/// All possible errors returned by any Vulkan function.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This type is not public. Instead all public error types should implement `From<Error>` and</span>
<span class="doccomment">/// panic for error code that aren't supposed to happen.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>, <span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
<span class="attribute">#[<span class="ident">repr</span>(<span class="ident">u32</span>)]</span>
<span class="comment">// TODO: being pub is necessary because of the weird visibility rules in rustc</span>
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum</span> <span class="ident">Error</span> {
<span class="ident">OutOfHostMemory</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_HOST_MEMORY</span>,
<span class="ident">OutOfDeviceMemory</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_DEVICE_MEMORY</span>,
<span class="ident">InitializationFailed</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_INITIALIZATION_FAILED</span>,
<span class="ident">DeviceLost</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_DEVICE_LOST</span>,
<span class="ident">MemoryMapFailed</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_MEMORY_MAP_FAILED</span>,
<span class="ident">LayerNotPresent</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_LAYER_NOT_PRESENT</span>,
<span class="ident">ExtensionNotPresent</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_EXTENSION_NOT_PRESENT</span>,
<span class="ident">FeatureNotPresent</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_FEATURE_NOT_PRESENT</span>,
<span class="ident">IncompatibleDriver</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_INCOMPATIBLE_DRIVER</span>,
<span class="ident">TooManyObjects</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_TOO_MANY_OBJECTS</span>,
<span class="ident">FormatNotSupported</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_FORMAT_NOT_SUPPORTED</span>,
<span class="ident">SurfaceLost</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_SURFACE_LOST_KHR</span>,
<span class="ident">NativeWindowInUse</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_NATIVE_WINDOW_IN_USE_KHR</span>,
<span class="ident">OutOfDate</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_DATE_KHR</span>,
<span class="ident">IncompatibleDisplay</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_INCOMPATIBLE_DISPLAY_KHR</span>,
<span class="ident">ValidationFailed</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_VALIDATION_FAILED_EXT</span>,
<span class="ident">OutOfPoolMemory</span> <span class="op">=</span> <span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_POOL_MEMORY_KHR</span>,
}
<span class="doccomment">/// Checks whether the result returned correctly.</span>
<span class="kw">fn</span> <span class="ident">check_errors</span>(<span class="ident">result</span>: <span class="ident">vk</span>::<span class="prelude-ty">Result</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Success</span>, <span class="ident">Error</span><span class="op">></span> {
<span class="kw">match</span> <span class="ident">result</span> {
<span class="ident">vk</span>::<span class="ident">SUCCESS</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">Success</span>),
<span class="ident">vk</span>::<span class="ident">NOT_READY</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">NotReady</span>),
<span class="ident">vk</span>::<span class="ident">TIMEOUT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">Timeout</span>),
<span class="ident">vk</span>::<span class="ident">EVENT_SET</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">EventSet</span>),
<span class="ident">vk</span>::<span class="ident">EVENT_RESET</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">EventReset</span>),
<span class="ident">vk</span>::<span class="ident">INCOMPLETE</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">Incomplete</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_HOST_MEMORY</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">OutOfHostMemory</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_DEVICE_MEMORY</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">OutOfDeviceMemory</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_INITIALIZATION_FAILED</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">InitializationFailed</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_DEVICE_LOST</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">DeviceLost</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_MEMORY_MAP_FAILED</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">MemoryMapFailed</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_LAYER_NOT_PRESENT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">LayerNotPresent</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_EXTENSION_NOT_PRESENT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">ExtensionNotPresent</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_FEATURE_NOT_PRESENT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">FeatureNotPresent</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_INCOMPATIBLE_DRIVER</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">IncompatibleDriver</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_TOO_MANY_OBJECTS</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">TooManyObjects</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_FORMAT_NOT_SUPPORTED</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">FormatNotSupported</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_SURFACE_LOST_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">SurfaceLost</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_NATIVE_WINDOW_IN_USE_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">NativeWindowInUse</span>),
<span class="ident">vk</span>::<span class="ident">SUBOPTIMAL_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Ok</span>(<span class="ident">Success</span>::<span class="ident">Suboptimal</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_DATE_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">OutOfDate</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_INCOMPATIBLE_DISPLAY_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">IncompatibleDisplay</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_VALIDATION_FAILED_EXT</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">ValidationFailed</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_OUT_OF_POOL_MEMORY_KHR</span> <span class="op">=</span><span class="op">></span> <span class="prelude-val">Err</span>(<span class="ident">Error</span>::<span class="ident">OutOfPoolMemory</span>),
<span class="ident">vk</span>::<span class="ident">ERROR_INVALID_SHADER_NV</span> <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Vulkan function returned \
VK_ERROR_INVALID_SHADER_NV"</span>),
<span class="ident">c</span> <span class="op">=</span><span class="op">></span> <span class="macro">unreachable</span><span class="macro">!</span>(<span class="string">"Unexpected error code returned by Vulkan: {}"</span>, <span class="ident">c</span>),
}
}
</pre></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 src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>