<!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/image/attachment.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>attachment.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>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</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="kw">use</span> <span class="ident">std</span>::<span class="ident">iter</span>::<span class="ident">Empty</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">atomic</span>::<span class="ident">AtomicBool</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">AtomicUsize</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">Ordering</span>;
<span class="kw">use</span> <span class="ident">buffer</span>::<span class="ident">BufferAccess</span>;
<span class="kw">use</span> <span class="ident">device</span>::<span class="ident">Device</span>;
<span class="kw">use</span> <span class="ident">format</span>::<span class="ident">ClearValue</span>;
<span class="kw">use</span> <span class="ident">format</span>::<span class="ident">Format</span>;
<span class="kw">use</span> <span class="ident">format</span>::<span class="ident">FormatDesc</span>;
<span class="kw">use</span> <span class="ident">format</span>::<span class="ident">FormatTy</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">Dimensions</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">ImageDimensions</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">ImageInner</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">ImageLayout</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">ImageUsage</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">ViewType</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">sys</span>::<span class="ident">ImageCreationError</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">sys</span>::<span class="ident">UnsafeImage</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">sys</span>::<span class="ident">UnsafeImageView</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">traits</span>::<span class="ident">ImageAccess</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">traits</span>::<span class="ident">ImageClearValue</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">traits</span>::<span class="ident">ImageContent</span>;
<span class="kw">use</span> <span class="ident">image</span>::<span class="ident">traits</span>::<span class="ident">ImageViewAccess</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">DedicatedAlloc</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">AllocFromRequirementsFilter</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">AllocLayout</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">MappingRequirement</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">MemoryPool</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">MemoryPoolAlloc</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">PotentialDedicatedAllocation</span>;
<span class="kw">use</span> <span class="ident">memory</span>::<span class="ident">pool</span>::<span class="ident">StdMemoryPoolAlloc</span>;
<span class="kw">use</span> <span class="ident">sync</span>::<span class="ident">AccessError</span>;
<span class="kw">use</span> <span class="ident">sync</span>::<span class="ident">Sharing</span>;
<span class="doccomment">/// ImageAccess whose purpose is to be used as a framebuffer attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The image is always two-dimensional and has only one mipmap, but it can have any kind of</span>
<span class="doccomment">/// format. Trying to use a format that the backend doesn't support for rendering will result in</span>
<span class="doccomment">/// an error being returned when creating the image. Once you have an `AttachmentImage`, you are</span>
<span class="doccomment">/// guaranteed that you will be able to draw on it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The template parameter of `AttachmentImage` is a type that describes the format of the image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// # Regular vs transient</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Calling `AttachmentImage::new` will create a regular image, while calling</span>
<span class="doccomment">/// `AttachmentImage::transient` will create a *transient* image. Transient image are only</span>
<span class="doccomment">/// relevant for images that serve as attachments, so `AttachmentImage` is the only type of</span>
<span class="doccomment">/// image in vulkano that provides a shortcut for this.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A transient image is a special kind of image whose content is undefined outside of render</span>
<span class="doccomment">/// passes. Once you finish drawing, reading from it will returned undefined data (which can be</span>
<span class="doccomment">/// either valid or garbage, depending on the implementation).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This gives a hint to the Vulkan implementation that it is possible for the image's content to</span>
<span class="doccomment">/// live exclusively in some cache memory, and that no real memory has to be allocated for it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// In other words, if you are going to read from the image after drawing to it, use a regular</span>
<span class="doccomment">/// image. If you don't need to read from it (for example if it's some kind of intermediary color,</span>
<span class="doccomment">/// or a depth buffer that is only used once) then use a transient image as it may improve</span>
<span class="doccomment">/// performance.</span>
<span class="doccomment">///</span>
<span class="comment">// TODO: forbid reading transient images outside render passes?</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span> <span class="op">=</span> <span class="ident">Format</span>, <span class="ident">A</span> <span class="op">=</span> <span class="ident">PotentialDedicatedAllocation</span><span class="op"><</span><span class="ident">StdMemoryPoolAlloc</span><span class="op">></span><span class="op">></span> {
<span class="comment">// Inner implementation.</span>
<span class="ident">image</span>: <span class="ident">UnsafeImage</span>,
<span class="comment">// We maintain a view of the whole image since we will need it when rendering.</span>
<span class="ident">view</span>: <span class="ident">UnsafeImageView</span>,
<span class="comment">// Memory used to back the image.</span>
<span class="ident">memory</span>: <span class="ident">A</span>,
<span class="comment">// Format.</span>
<span class="ident">format</span>: <span class="ident">F</span>,
<span class="comment">// Layout to use when the image is used as a framebuffer attachment.</span>
<span class="comment">// Must be either "depth-stencil optimal" or "color optimal".</span>
<span class="ident">attachment_layout</span>: <span class="ident">ImageLayout</span>,
<span class="comment">// If true, then the image is in the layout of `attachment_layout` (above). If false, then it</span>
<span class="comment">// is still `Undefined`.</span>
<span class="ident">initialized</span>: <span class="ident">AtomicBool</span>,
<span class="comment">// Number of times this image is locked on the GPU side.</span>
<span class="ident">gpu_lock</span>: <span class="ident">AtomicUsize</span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> <span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
<span class="doccomment">/// Creates a new image with the given dimensions and format.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// Returns an error if the dimensions are too large or if the backend doesn't support this</span>
<span class="doccomment">/// format as a framebuffer attachment.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">ImageUsage</span>::<span class="ident">none</span>(), <span class="number">1</span>)
}
<span class="doccomment">/// Same as `new`, but creates an image that can be used as an input attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">input_attachment</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `new`, but creates a multisampled image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: You can also use this function and pass `1` for the number of samples if you</span>
<span class="doccomment">/// > want a regular image.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multisampled</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>, <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">ImageUsage</span>::<span class="ident">none</span>(), <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `multisampled`, but creates an image that can be used as an input attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multisampled_input_attachment</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>,
<span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `new`, but lets you specify additional usages.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// The `color_attachment` or `depth_stencil_attachment` usages are automatically added based</span>
<span class="doccomment">/// on the format of the usage. Therefore the `usage` parameter allows you specify usages in</span>
<span class="doccomment">/// addition to these two.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">with_usage</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>, <span class="ident">usage</span>: <span class="ident">ImageUsage</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `with_usage`, but creates a multisampled image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: You can also use this function and pass `1` for the number of samples if you</span>
<span class="doccomment">/// > want a regular image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">multisampled_with_usage</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>,
<span class="ident">format</span>: <span class="ident">F</span>, <span class="ident">usage</span>: <span class="ident">ImageUsage</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">usage</span>, <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `new`, except that the image can later be sampled.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sampled</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">sampled</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `sampled`, except that the image can be used as an input attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sampled_input_attachment</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">sampled</span>: <span class="bool-val">true</span>,
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `sampled`, but creates a multisampled image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: You can also use this function and pass `1` for the number of samples if you</span>
<span class="doccomment">/// > want a regular image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sampled_multisampled</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>, <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">sampled</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `sampled_multisampled`, but creates an image that can be used as an input</span>
<span class="doccomment">/// attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sampled_multisampled_input_attachment</span>(
<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>, <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">sampled</span>: <span class="bool-val">true</span>,
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `new`, except that the image will be transient.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// A transient image is special because its content is undefined outside of a render pass.</span>
<span class="doccomment">/// This means that the implementation has the possibility to not allocate any memory for it.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">transient</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">transient_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `transient`, except that the image can be used as an input attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">transient_input_attachment</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">transient_attachment</span>: <span class="bool-val">true</span>,
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="number">1</span>)
}
<span class="doccomment">/// Same as `transient`, but creates a multisampled image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: You can also use this function and pass `1` for the number of samples if you</span>
<span class="doccomment">/// > want a regular image.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">transient_multisampled</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>,
<span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">transient_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="ident">samples</span>)
}
<span class="doccomment">/// Same as `transient_multisampled`, but creates an image that can be used as an input</span>
<span class="doccomment">/// attachment.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// > **Note**: This function is just a convenient shortcut for `multisampled_with_usage`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">transient_multisampled_input_attachment</span>(
<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">samples</span>: <span class="ident">u32</span>, <span class="ident">format</span>: <span class="ident">F</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="kw">let</span> <span class="ident">base_usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">transient_attachment</span>: <span class="bool-val">true</span>,
<span class="ident">input_attachment</span>: <span class="bool-val">true</span>,
..<span class="ident">ImageUsage</span>::<span class="ident">none</span>()
};
<span class="ident">AttachmentImage</span>::<span class="ident">new_impl</span>(<span class="ident">device</span>, <span class="ident">dimensions</span>, <span class="ident">format</span>, <span class="ident">base_usage</span>, <span class="ident">samples</span>)
}
<span class="comment">// All constructors dispatch to this one.</span>
<span class="kw">fn</span> <span class="ident">new_impl</span>(<span class="ident">device</span>: <span class="ident">Arc</span><span class="op"><</span><span class="ident">Device</span><span class="op">></span>, <span class="ident">dimensions</span>: [<span class="ident">u32</span>; <span class="number">2</span>], <span class="ident">format</span>: <span class="ident">F</span>, <span class="ident">base_usage</span>: <span class="ident">ImageUsage</span>,
<span class="ident">samples</span>: <span class="ident">u32</span>)
<span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span><span class="op">></span><span class="op">></span>, <span class="ident">ImageCreationError</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span>
{
<span class="comment">// TODO: check dimensions against the max_framebuffer_width/height/layers limits</span>
<span class="kw">let</span> <span class="ident">is_depth</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">format</span>.<span class="ident">format</span>().<span class="ident">ty</span>() {
<span class="ident">FormatTy</span>::<span class="ident">Depth</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">true</span>,
<span class="ident">FormatTy</span>::<span class="ident">DepthStencil</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">true</span>,
<span class="ident">FormatTy</span>::<span class="ident">Stencil</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">true</span>,
<span class="ident">FormatTy</span>::<span class="ident">Compressed</span> <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(),
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">false</span>,
};
<span class="kw">let</span> <span class="ident">usage</span> <span class="op">=</span> <span class="ident">ImageUsage</span> {
<span class="ident">color_attachment</span>: <span class="op">!</span><span class="ident">is_depth</span>,
<span class="ident">depth_stencil_attachment</span>: <span class="ident">is_depth</span>,
..<span class="ident">base_usage</span>
};
<span class="kw">let</span> (<span class="ident">image</span>, <span class="ident">mem_reqs</span>) <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">dims</span> <span class="op">=</span> <span class="ident">ImageDimensions</span>::<span class="ident">Dim2d</span> {
<span class="ident">width</span>: <span class="ident">dimensions</span>[<span class="number">0</span>],
<span class="ident">height</span>: <span class="ident">dimensions</span>[<span class="number">1</span>],
<span class="ident">array_layers</span>: <span class="number">1</span>,
<span class="ident">cubemap_compatible</span>: <span class="bool-val">false</span>,
};
<span class="ident">UnsafeImage</span>::<span class="ident">new</span>(<span class="ident">device</span>.<span class="ident">clone</span>(),
<span class="ident">usage</span>,
<span class="ident">format</span>.<span class="ident">format</span>(),
<span class="ident">dims</span>,
<span class="ident">samples</span>,
<span class="number">1</span>,
<span class="ident">Sharing</span>::<span class="ident">Exclusive</span>::<span class="op"><</span><span class="ident">Empty</span><span class="op"><</span><span class="ident">u32</span><span class="op">></span><span class="op">></span>,
<span class="bool-val">false</span>,
<span class="bool-val">false</span>)<span class="question-mark">?</span>
};
<span class="kw">let</span> <span class="ident">mem</span> <span class="op">=</span> <span class="ident">MemoryPool</span>::<span class="ident">alloc_from_requirements</span>(<span class="kw-2">&</span><span class="ident">Device</span>::<span class="ident">standard_pool</span>(<span class="kw-2">&</span><span class="ident">device</span>),
<span class="kw-2">&</span><span class="ident">mem_reqs</span>,
<span class="ident">AllocLayout</span>::<span class="ident">Optimal</span>,
<span class="ident">MappingRequirement</span>::<span class="ident">DoNotMap</span>,
<span class="ident">DedicatedAlloc</span>::<span class="ident">Image</span>(<span class="kw-2">&</span><span class="ident">image</span>),
<span class="op">|</span><span class="ident">t</span><span class="op">|</span> <span class="kw">if</span> <span class="ident">t</span>.<span class="ident">is_device_local</span>() {
<span class="ident">AllocFromRequirementsFilter</span>::<span class="ident">Preferred</span>
} <span class="kw">else</span> {
<span class="ident">AllocFromRequirementsFilter</span>::<span class="ident">Allowed</span>
})<span class="question-mark">?</span>;
<span class="macro">debug_assert</span><span class="macro">!</span>((<span class="ident">mem</span>.<span class="ident">offset</span>() <span class="op">%</span> <span class="ident">mem_reqs</span>.<span class="ident">alignment</span>) <span class="op">=</span><span class="op">=</span> <span class="number">0</span>);
<span class="kw">unsafe</span> {
<span class="ident">image</span>.<span class="ident">bind_memory</span>(<span class="ident">mem</span>.<span class="ident">memory</span>(), <span class="ident">mem</span>.<span class="ident">offset</span>())<span class="question-mark">?</span>;
}
<span class="kw">let</span> <span class="ident">view</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">UnsafeImageView</span>::<span class="ident">raw</span>(<span class="kw-2">&</span><span class="ident">image</span>, <span class="ident">ViewType</span>::<span class="ident">Dim2d</span>, <span class="number">0</span> .. <span class="number">1</span>, <span class="number">0</span> .. <span class="number">1</span>)<span class="question-mark">?</span> };
<span class="prelude-val">Ok</span>(<span class="ident">Arc</span>::<span class="ident">new</span>(<span class="ident">AttachmentImage</span> {
<span class="ident">image</span>: <span class="ident">image</span>,
<span class="ident">view</span>: <span class="ident">view</span>,
<span class="ident">memory</span>: <span class="ident">mem</span>,
<span class="ident">format</span>: <span class="ident">format</span>,
<span class="ident">attachment_layout</span>: <span class="kw">if</span> <span class="ident">is_depth</span> {
<span class="ident">ImageLayout</span>::<span class="ident">DepthStencilAttachmentOptimal</span>
} <span class="kw">else</span> {
<span class="ident">ImageLayout</span>::<span class="ident">ColorAttachmentOptimal</span>
},
<span class="ident">initialized</span>: <span class="ident">AtomicBool</span>::<span class="ident">new</span>(<span class="bool-val">false</span>),
<span class="ident">gpu_lock</span>: <span class="ident">AtomicUsize</span>::<span class="ident">new</span>(<span class="number">0</span>),
}))
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> <span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> {
<span class="doccomment">/// Returns the dimensions of the image.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> [<span class="ident">u32</span>; <span class="number">2</span>] {
<span class="kw">let</span> <span class="ident">dims</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">image</span>.<span class="ident">dimensions</span>();
[<span class="ident">dims</span>.<span class="ident">width</span>(), <span class="ident">dims</span>.<span class="ident">height</span>()]
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> <span class="ident">ImageAccess</span> <span class="kw">for</span> <span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">inner</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageInner</span> {
<span class="ident">ImageInner</span> {
<span class="ident">image</span>: <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">image</span>,
<span class="ident">first_layer</span>: <span class="number">0</span>,
<span class="ident">num_layers</span>: <span class="self">self</span>.<span class="ident">image</span>.<span class="ident">dimensions</span>().<span class="ident">array_layers</span>() <span class="kw">as</span> <span class="ident">usize</span>,
<span class="ident">first_mipmap_level</span>: <span class="number">0</span>,
<span class="ident">num_mipmap_levels</span>: <span class="number">1</span>,
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">initial_layout_requirement</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="self">self</span>.<span class="ident">attachment_layout</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">final_layout_requirement</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="self">self</span>.<span class="ident">attachment_layout</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">conflicts_buffer</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">dyn</span> <span class="ident">BufferAccess</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="bool-val">false</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">conflicts_image</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">other</span>: <span class="kw-2">&</span><span class="ident">dyn</span> <span class="ident">ImageAccess</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">conflict_key</span>() <span class="op">=</span><span class="op">=</span> <span class="ident">other</span>.<span class="ident">conflict_key</span>()
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">conflict_key</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="self">self</span>.<span class="ident">image</span>.<span class="ident">key</span>()
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">try_gpu_lock</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="kw">_</span>: <span class="ident">bool</span>, <span class="ident">expected_layout</span>: <span class="ident">ImageLayout</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">AccessError</span><span class="op">></span> {
<span class="kw">if</span> <span class="ident">expected_layout</span> <span class="op">!</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">attachment_layout</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">expected_layout</span> <span class="op">!</span><span class="op">=</span> <span class="ident">ImageLayout</span>::<span class="ident">Undefined</span> {
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">initialized</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">AccessError</span>::<span class="ident">UnexpectedImageLayout</span> {
<span class="ident">requested</span>: <span class="ident">expected_layout</span>,
<span class="ident">allowed</span>: <span class="self">self</span>.<span class="ident">attachment_layout</span>,
});
} <span class="kw">else</span> {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">AccessError</span>::<span class="ident">UnexpectedImageLayout</span> {
<span class="ident">requested</span>: <span class="ident">expected_layout</span>,
<span class="ident">allowed</span>: <span class="ident">ImageLayout</span>::<span class="ident">Undefined</span>,
});
}
}
<span class="kw">if</span> <span class="ident">expected_layout</span> <span class="op">!</span><span class="op">=</span> <span class="ident">ImageLayout</span>::<span class="ident">Undefined</span> {
<span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">initialized</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) {
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">AccessError</span>::<span class="ident">ImageNotInitialized</span> { <span class="ident">requested</span>: <span class="ident">expected_layout</span> });
}
}
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">gpu_lock</span>.<span class="ident">compare_and_swap</span>(<span class="number">0</span>, <span class="number">1</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>) <span class="op">=</span><span class="op">=</span> <span class="number">0</span> {
<span class="prelude-val">Ok</span>(())
} <span class="kw">else</span> {
<span class="prelude-val">Err</span>(<span class="ident">AccessError</span>::<span class="ident">AlreadyInUse</span>)
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">increase_gpu_lock</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">gpu_lock</span>.<span class="ident">fetch_add</span>(<span class="number">1</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>);
<span class="macro">debug_assert</span><span class="macro">!</span>(<span class="ident">val</span> <span class="op">></span><span class="op">=</span> <span class="number">1</span>);
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">unlock</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">new_layout</span>: <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ImageLayout</span><span class="op">></span>) {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">new_layout</span>) <span class="op">=</span> <span class="ident">new_layout</span> {
<span class="macro">debug_assert_eq</span><span class="macro">!</span>(<span class="ident">new_layout</span>, <span class="self">self</span>.<span class="ident">attachment_layout</span>);
<span class="self">self</span>.<span class="ident">initialized</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>);
}
<span class="kw">let</span> <span class="ident">prev_val</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">gpu_lock</span>.<span class="ident">fetch_sub</span>(<span class="number">1</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>);
<span class="macro">debug_assert</span><span class="macro">!</span>(<span class="ident">prev_val</span> <span class="op">></span><span class="op">=</span> <span class="number">1</span>);
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">layout_initialized</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">initialized</span>.<span class="ident">store</span>(<span class="bool-val">true</span>, <span class="ident">Ordering</span>::<span class="ident">SeqCst</span>);
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">is_layout_initialized</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">initialized</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">SeqCst</span>)
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> <span class="ident">ImageClearValue</span><span class="op"><</span><span class="ident">F</span>::<span class="ident">ClearValue</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="ident">FormatDesc</span> <span class="op">+</span> <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">decode</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">value</span>: <span class="ident">F</span>::<span class="ident">ClearValue</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">ClearValue</span><span class="op">></span> {
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">format</span>.<span class="ident">decode_clear_value</span>(<span class="ident">value</span>))
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">P</span>, <span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> <span class="ident">ImageContent</span><span class="op"><</span><span class="ident">P</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Arc</span><span class="op"><</span><span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">matches_format</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="bool-val">true</span> <span class="comment">// FIXME:</span>
}
}
<span class="kw">unsafe</span> <span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span> <span class="ident">ImageViewAccess</span> <span class="kw">for</span> <span class="ident">AttachmentImage</span><span class="op"><</span><span class="ident">F</span>, <span class="ident">A</span><span class="op">></span>
<span class="kw">where</span> <span class="ident">F</span>: <span class="lifetime">'static</span> <span class="op">+</span> <span class="ident">Send</span> <span class="op">+</span> <span class="ident">Sync</span>
{
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">parent</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">dyn</span> <span class="ident">ImageAccess</span> {
<span class="self">self</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">dimensions</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Dimensions</span> {
<span class="kw">let</span> <span class="ident">dims</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">image</span>.<span class="ident">dimensions</span>();
<span class="ident">Dimensions</span>::<span class="ident">Dim2d</span> {
<span class="ident">width</span>: <span class="ident">dims</span>.<span class="ident">width</span>(),
<span class="ident">height</span>: <span class="ident">dims</span>.<span class="ident">height</span>(),
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">inner</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">UnsafeImageView</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">view</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">descriptor_set_storage_image_layout</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="ident">ImageLayout</span>::<span class="ident">ShaderReadOnlyOptimal</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">descriptor_set_combined_image_sampler_layout</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="ident">ImageLayout</span>::<span class="ident">ShaderReadOnlyOptimal</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">descriptor_set_sampled_image_layout</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="ident">ImageLayout</span>::<span class="ident">ShaderReadOnlyOptimal</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">descriptor_set_input_attachment_layout</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">ImageLayout</span> {
<span class="ident">ImageLayout</span>::<span class="ident">ShaderReadOnlyOptimal</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">identity_swizzle</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="bool-val">true</span>
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="ident">AttachmentImage</span>;
<span class="kw">use</span> <span class="ident">format</span>::<span class="ident">Format</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">create_regular</span>() {
<span class="kw">let</span> (<span class="ident">device</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="macro">gfx_dev_and_queue</span><span class="macro">!</span>();
<span class="kw">let</span> <span class="ident">_img</span> <span class="op">=</span> <span class="ident">AttachmentImage</span>::<span class="ident">new</span>(<span class="ident">device</span>, [<span class="number">32</span>, <span class="number">32</span>], <span class="ident">Format</span>::<span class="ident">R8G8B8A8Unorm</span>).<span class="ident">unwrap</span>();
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">create_transient</span>() {
<span class="kw">let</span> (<span class="ident">device</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="macro">gfx_dev_and_queue</span><span class="macro">!</span>();
<span class="kw">let</span> <span class="ident">_img</span> <span class="op">=</span> <span class="ident">AttachmentImage</span>::<span class="ident">transient</span>(<span class="ident">device</span>, [<span class="number">32</span>, <span class="number">32</span>], <span class="ident">Format</span>::<span class="ident">R8G8B8A8Unorm</span>).<span class="ident">unwrap</span>();
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">d16_unorm_always_supported</span>() {
<span class="kw">let</span> (<span class="ident">device</span>, <span class="kw">_</span>) <span class="op">=</span> <span class="macro">gfx_dev_and_queue</span><span class="macro">!</span>();
<span class="kw">let</span> <span class="ident">_img</span> <span class="op">=</span> <span class="ident">AttachmentImage</span>::<span class="ident">new</span>(<span class="ident">device</span>, [<span class="number">32</span>, <span class="number">32</span>], <span class="ident">Format</span>::<span class="ident">D16Unorm</span>).<span class="ident">unwrap</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>