Deploying to master from @ gfx-rs/wgpu@ef996e6 🚀

Author: Wumpf

doc/src/wgpu_examples/framework.rs.html

@@ -619,26 +619,6 @@
 <a href="#618" id="618">618</a>
 <a href="#619" id="619">619</a>
 <a href="#620" id="620">620</a>
-<a href="#621" id="621">621</a>
-<a href="#622" id="622">622</a>
-<a href="#623" id="623">623</a>
-<a href="#624" id="624">624</a>
-<a href="#625" id="625">625</a>
-<a href="#626" id="626">626</a>
-<a href="#627" id="627">627</a>
-<a href="#628" id="628">628</a>
-<a href="#629" id="629">629</a>
-<a href="#630" id="630">630</a>
-<a href="#631" id="631">631</a>
-<a href="#632" id="632">632</a>
-<a href="#633" id="633">633</a>
-<a href="#634" id="634">634</a>
-<a href="#635" id="635">635</a>
-<a href="#636" id="636">636</a>
-<a href="#637" id="637">637</a>
-<a href="#638" id="638">638</a>
-<a href="#639" id="639">639</a>
-<a href="#640" id="640">640</a>
 </pre></div><pre class="rust"><code><span class="kw">use </span>std::sync::Arc;
 
 <span class="kw">use </span>wgpu::{Instance, Surface};
@@ -920,37 +900,14 @@
             gles_minor_version,
         });
         surface.pre_adapter(<span class="kw-2">&amp;</span>instance, window);
-        <span class="kw">let </span>adapter = wgpu::util::initialize_adapter_from_env_or_default(<span class="kw-2">&amp;</span>instance, surface.get())
-            .<span class="kw">await
-            </span>.expect(<span class="string">"No suitable GPU adapters found on the system!"</span>);
-
-        <span class="kw">let </span>adapter_info = adapter.get_info();
-        <span class="macro">log::info!</span>(<span class="string">"Using {} ({:?})"</span>, adapter_info.name, adapter_info.backend);
-
-        <span class="kw">let </span>optional_features = E::optional_features();
-        <span class="kw">let </span>required_features = E::required_features();
-        <span class="kw">let </span>adapter_features = adapter.features();
-        <span class="macro">assert!</span>(
-            adapter_features.contains(required_features),
-            <span class="string">"Adapter does not support required features for this example: {:?}"</span>,
-            required_features - adapter_features
-        );
-
-        <span class="kw">let </span>required_downlevel_capabilities = E::required_downlevel_capabilities();
-        <span class="kw">let </span>downlevel_capabilities = adapter.get_downlevel_capabilities();
-        <span class="macro">assert!</span>(
-            downlevel_capabilities.shader_model &gt;= required_downlevel_capabilities.shader_model,
-            <span class="string">"Adapter does not support the minimum shader model required to run this example: {:?}"</span>,
-            required_downlevel_capabilities.shader_model
-        );
-        <span class="macro">assert!</span>(
-            downlevel_capabilities
-                .flags
-                .contains(required_downlevel_capabilities.flags),
-            <span class="string">"Adapter does not support the downlevel capabilities required to run this example: {:?}"</span>,
-            required_downlevel_capabilities.flags - downlevel_capabilities.flags
-        );
 
+        <span class="kw">let </span>adapter = get_adapter_with_capabilities_or_from_env(
+            <span class="kw-2">&amp;</span>instance,
+            <span class="kw-2">&amp;</span>E::required_features(),
+            <span class="kw-2">&amp;</span>E::required_downlevel_capabilities(),
+            <span class="kw-2">&amp;</span>surface.get(),
+        )
+        .<span class="kw">await</span>;
         <span class="comment">// Make sure we use the texture resolution limits from the adapter, so we can support images the size of the surface.
         </span><span class="kw">let </span>needed_limits = E::required_limits().using_resolution(adapter.limits());
 
@@ -959,7 +916,8 @@
             .request_device(
                 <span class="kw-2">&amp;</span>wgpu::DeviceDescriptor {
                     label: <span class="prelude-val">None</span>,
-                    required_features: (optional_features &amp; adapter_features) | required_features,
+                    required_features: (E::optional_features() &amp; adapter.features())
+                        | E::required_features(),
                     required_limits: needed_limits,
                     memory_hints: wgpu::MemoryHints::MemoryUsage,
                 },
@@ -1155,6 +1113,8 @@
 <span class="attr">#[cfg(test)]
 </span><span class="kw">pub use </span>wgpu_test::image::ComparisonType;
 
+<span class="kw">use </span><span class="kw">crate</span>::utils::get_adapter_with_capabilities_or_from_env;
+
 <span class="attr">#[cfg(test)]
 #[derive(Clone)]
 </span><span class="kw">pub struct </span>ExampleTestParams&lt;E&gt; {

doc/src/wgpu_examples/utils.rs.html

@@ -157,6 +157,108 @@
 <a href="#156" id="156">156</a>
 <a href="#157" id="157">157</a>
 <a href="#158" id="158">158</a>
+<a href="#159" id="159">159</a>
+<a href="#160" id="160">160</a>
+<a href="#161" id="161">161</a>
+<a href="#162" id="162">162</a>
+<a href="#163" id="163">163</a>
+<a href="#164" id="164">164</a>
+<a href="#165" id="165">165</a>
+<a href="#166" id="166">166</a>
+<a href="#167" id="167">167</a>
+<a href="#168" id="168">168</a>
+<a href="#169" id="169">169</a>
+<a href="#170" id="170">170</a>
+<a href="#171" id="171">171</a>
+<a href="#172" id="172">172</a>
+<a href="#173" id="173">173</a>
+<a href="#174" id="174">174</a>
+<a href="#175" id="175">175</a>
+<a href="#176" id="176">176</a>
+<a href="#177" id="177">177</a>
+<a href="#178" id="178">178</a>
+<a href="#179" id="179">179</a>
+<a href="#180" id="180">180</a>
+<a href="#181" id="181">181</a>
+<a href="#182" id="182">182</a>
+<a href="#183" id="183">183</a>
+<a href="#184" id="184">184</a>
+<a href="#185" id="185">185</a>
+<a href="#186" id="186">186</a>
+<a href="#187" id="187">187</a>
+<a href="#188" id="188">188</a>
+<a href="#189" id="189">189</a>
+<a href="#190" id="190">190</a>
+<a href="#191" id="191">191</a>
+<a href="#192" id="192">192</a>
+<a href="#193" id="193">193</a>
+<a href="#194" id="194">194</a>
+<a href="#195" id="195">195</a>
+<a href="#196" id="196">196</a>
+<a href="#197" id="197">197</a>
+<a href="#198" id="198">198</a>
+<a href="#199" id="199">199</a>
+<a href="#200" id="200">200</a>
+<a href="#201" id="201">201</a>
+<a href="#202" id="202">202</a>
+<a href="#203" id="203">203</a>
+<a href="#204" id="204">204</a>
+<a href="#205" id="205">205</a>
+<a href="#206" id="206">206</a>
+<a href="#207" id="207">207</a>
+<a href="#208" id="208">208</a>
+<a href="#209" id="209">209</a>
+<a href="#210" id="210">210</a>
+<a href="#211" id="211">211</a>
+<a href="#212" id="212">212</a>
+<a href="#213" id="213">213</a>
+<a href="#214" id="214">214</a>
+<a href="#215" id="215">215</a>
+<a href="#216" id="216">216</a>
+<a href="#217" id="217">217</a>
+<a href="#218" id="218">218</a>
+<a href="#219" id="219">219</a>
+<a href="#220" id="220">220</a>
+<a href="#221" id="221">221</a>
+<a href="#222" id="222">222</a>
+<a href="#223" id="223">223</a>
+<a href="#224" id="224">224</a>
+<a href="#225" id="225">225</a>
+<a href="#226" id="226">226</a>
+<a href="#227" id="227">227</a>
+<a href="#228" id="228">228</a>
+<a href="#229" id="229">229</a>
+<a href="#230" id="230">230</a>
+<a href="#231" id="231">231</a>
+<a href="#232" id="232">232</a>
+<a href="#233" id="233">233</a>
+<a href="#234" id="234">234</a>
+<a href="#235" id="235">235</a>
+<a href="#236" id="236">236</a>
+<a href="#237" id="237">237</a>
+<a href="#238" id="238">238</a>
+<a href="#239" id="239">239</a>
+<a href="#240" id="240">240</a>
+<a href="#241" id="241">241</a>
+<a href="#242" id="242">242</a>
+<a href="#243" id="243">243</a>
+<a href="#244" id="244">244</a>
+<a href="#245" id="245">245</a>
+<a href="#246" id="246">246</a>
+<a href="#247" id="247">247</a>
+<a href="#248" id="248">248</a>
+<a href="#249" id="249">249</a>
+<a href="#250" id="250">250</a>
+<a href="#251" id="251">251</a>
+<a href="#252" id="252">252</a>
+<a href="#253" id="253">253</a>
+<a href="#254" id="254">254</a>
+<a href="#255" id="255">255</a>
+<a href="#256" id="256">256</a>
+<a href="#257" id="257">257</a>
+<a href="#258" id="258">258</a>
+<a href="#259" id="259">259</a>
+<a href="#260" id="260">260</a>
 </pre></div><pre class="rust"><code><span class="attr">#[cfg(not(target_arch = <span class="string">"wasm32"</span>))]
 </span><span class="kw">use </span>std::io::Write;
 <span class="attr">#[cfg(target_arch = <span class="string">"wasm32"</span>)]
@@ -315,4 +417,106 @@
     <span class="macro">log::info!</span>(<span class="string">"Created new output target image: {:?}"</span>, <span class="kw-2">&amp;</span>new_image);
     new_image
 }
+
+<span class="attr">#[cfg(not(target_arch = <span class="string">"wasm32"</span>))]
+</span><span class="doccomment">/// If the environment variable `WGPU_ADAPTER_NAME` is set, this function will attempt to
+/// initialize the adapter with that name. If it is not set, it will attempt to initialize
+/// the adapter which supports the required features.
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async fn </span>get_adapter_with_capabilities_or_from_env(
+    instance: <span class="kw-2">&amp;</span>wgpu::Instance,
+    required_features: <span class="kw-2">&amp;</span>wgpu::Features,
+    required_downlevel_capabilities: <span class="kw-2">&amp;</span>wgpu::DownlevelCapabilities,
+    surface: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>wgpu::Surface&lt;<span class="lifetime">'_</span>&gt;&gt;,
+) -&gt; wgpu::Adapter {
+    <span class="kw">use </span>wgpu::Backends;
+    <span class="kw">if </span>std::env::var(<span class="string">"WGPU_ADAPTER_NAME"</span>).is_ok() {
+        <span class="kw">let </span>adapter = wgpu::util::initialize_adapter_from_env_or_default(instance, <span class="kw-2">*</span>surface)
+            .<span class="kw">await
+            </span>.expect(<span class="string">"No suitable GPU adapters found on the system!"</span>);
+
+        <span class="kw">let </span>adapter_info = adapter.get_info();
+        <span class="macro">log::info!</span>(<span class="string">"Using {} ({:?})"</span>, adapter_info.name, adapter_info.backend);
+
+        <span class="kw">let </span>adapter_features = adapter.features();
+        <span class="macro">assert!</span>(
+            adapter_features.contains(<span class="kw-2">*</span>required_features),
+            <span class="string">"Adapter does not support required features for this example: {:?}"</span>,
+            <span class="kw-2">*</span>required_features - adapter_features
+        );
+
+        <span class="kw">let </span>downlevel_capabilities = adapter.get_downlevel_capabilities();
+        <span class="macro">assert!</span>(
+            downlevel_capabilities.shader_model &gt;= required_downlevel_capabilities.shader_model,
+            <span class="string">"Adapter does not support the minimum shader model required to run this example: {:?}"</span>,
+            required_downlevel_capabilities.shader_model
+        );
+        <span class="macro">assert!</span>(
+                downlevel_capabilities
+                    .flags
+                    .contains(required_downlevel_capabilities.flags),
+                <span class="string">"Adapter does not support the downlevel capabilities required to run this example: {:?}"</span>,
+                required_downlevel_capabilities.flags - downlevel_capabilities.flags
+            );
+        adapter
+    } <span class="kw">else </span>{
+        <span class="kw">let </span>adapters = instance.enumerate_adapters(Backends::all());
+
+        <span class="kw">let </span><span class="kw-2">mut </span>chosen_adapter = <span class="prelude-val">None</span>;
+        <span class="kw">for </span>adapter <span class="kw">in </span>adapters {
+            <span class="kw">if let </span><span class="prelude-val">Some</span>(surface) = surface {
+                <span class="kw">if </span>!adapter.is_surface_supported(surface) {
+                    <span class="kw">continue</span>;
+                }
+            }
+
+            <span class="kw">let </span>required_features = <span class="kw-2">*</span>required_features;
+            <span class="kw">let </span>adapter_features = adapter.features();
+            <span class="kw">if </span>!adapter_features.contains(required_features) {
+                <span class="kw">continue</span>;
+            } <span class="kw">else </span>{
+                chosen_adapter = <span class="prelude-val">Some</span>(adapter);
+                <span class="kw">break</span>;
+            }
+        }
+
+        chosen_adapter.expect(<span class="string">"No suitable GPU adapters found on the system!"</span>)
+    }
+}
+
+<span class="attr">#[cfg(target_arch = <span class="string">"wasm32"</span>)]
+</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">async fn </span>get_adapter_with_capabilities_or_from_env(
+    instance: <span class="kw-2">&amp;</span>wgpu::Instance,
+    required_features: <span class="kw-2">&amp;</span>wgpu::Features,
+    required_downlevel_capabilities: <span class="kw-2">&amp;</span>wgpu::DownlevelCapabilities,
+    surface: <span class="kw-2">&amp;</span><span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>wgpu::Surface&lt;<span class="lifetime">'_</span>&gt;&gt;,
+) -&gt; wgpu::Adapter {
+    <span class="kw">let </span>adapter = wgpu::util::initialize_adapter_from_env_or_default(instance, <span class="kw-2">*</span>surface)
+        .<span class="kw">await
+        </span>.expect(<span class="string">"No suitable GPU adapters found on the system!"</span>);
+
+    <span class="kw">let </span>adapter_info = adapter.get_info();
+    <span class="macro">log::info!</span>(<span class="string">"Using {} ({:?})"</span>, adapter_info.name, adapter_info.backend);
+
+    <span class="kw">let </span>adapter_features = adapter.features();
+    <span class="macro">assert!</span>(
+        adapter_features.contains(<span class="kw-2">*</span>required_features),
+        <span class="string">"Adapter does not support required features for this example: {:?}"</span>,
+        <span class="kw-2">*</span>required_features - adapter_features
+    );
+
+    <span class="kw">let </span>downlevel_capabilities = adapter.get_downlevel_capabilities();
+    <span class="macro">assert!</span>(
+        downlevel_capabilities.shader_model &gt;= required_downlevel_capabilities.shader_model,
+        <span class="string">"Adapter does not support the minimum shader model required to run this example: {:?}"</span>,
+        required_downlevel_capabilities.shader_model
+    );
+    <span class="macro">assert!</span>(
+        downlevel_capabilities
+            .flags
+            .contains(required_downlevel_capabilities.flags),
+        <span class="string">"Adapter does not support the downlevel capabilities required to run this example: {:?}"</span>,
+        required_downlevel_capabilities.flags - downlevel_capabilities.flags
+    );
+    adapter
+}
 </code></pre></div></section></main></body></html>