14 lines
5.8 KiB
HTML
14 lines
5.8 KiB
HTML
<!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="Create an new instance of wgpu, but disabling `Backends::BROWSER_WEBGPU` if no WebGPU support was detected."><title>new_instance_with_webgpu_detection in wgpu::util - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="wgpu" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../wgpu/index.html"><img src="https://raw.githubusercontent.com/gfx-rs/wgpu/trunk/logo.png" alt="logo"></a><h2><a href="../../wgpu/index.html">wgpu</a><span class="version">23.0.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">new_<wbr>instance_<wbr>with_<wbr>webgpu_<wbr>detection</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panics" title="Panics">Panics</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In wgpu::<wbr>util</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">wgpu</a>::<wbr><a href="index.html">util</a></span><h1>Function <span class="fn">new_instance_with_webgpu_detection</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/wgpu/util/init.rs.html#183-195">Source</a> </span></div><pre class="rust item-decl"><code>pub async fn new_instance_with_webgpu_detection(
|
||
instance_desc: <a class="struct" href="../struct.InstanceDescriptor.html" title="struct wgpu::InstanceDescriptor">InstanceDescriptor</a>,
|
||
) -> <a class="struct" href="../struct.Instance.html" title="struct wgpu::Instance">Instance</a></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an new instance of wgpu, but disabling <a href="../struct.Backends.html#associatedconstant.BROWSER_WEBGPU" title="associated constant wgpu::Backends::BROWSER_WEBGPU"><code>Backends::BROWSER_WEBGPU</code></a> if no WebGPU support was detected.</p>
|
||
<p>If the instance descriptor enables <a href="../struct.Backends.html#associatedconstant.BROWSER_WEBGPU" title="associated constant wgpu::Backends::BROWSER_WEBGPU"><code>Backends::BROWSER_WEBGPU</code></a>,
|
||
this checks via <a href="fn.is_browser_webgpu_supported.html" title="fn wgpu::util::is_browser_webgpu_supported"><code>is_browser_webgpu_supported</code></a> for WebGPU support before forwarding
|
||
the descriptor with or without <a href="../struct.Backends.html#associatedconstant.BROWSER_WEBGPU" title="associated constant wgpu::Backends::BROWSER_WEBGPU"><code>Backends::BROWSER_WEBGPU</code></a> respecitively to <a href="../struct.Instance.html#method.new" title="associated function wgpu::Instance::new"><code>Instance::new</code></a>.</p>
|
||
<p>You should prefer this method over <a href="../struct.Instance.html#method.new" title="associated function wgpu::Instance::new"><code>Instance::new</code></a> if you want to target WebGPU and automatically
|
||
fall back to WebGL if WebGPU is not available.
|
||
This is because WebGPU support has to be decided upon instance creation and <a href="../struct.Instance.html#method.new" title="associated function wgpu::Instance::new"><code>Instance::new</code></a>
|
||
(being a <code>sync</code> function) can’t establish WebGPU support (details see <a href="fn.is_browser_webgpu_supported.html" title="fn wgpu::util::is_browser_webgpu_supported"><code>is_browser_webgpu_supported</code></a>).</p>
|
||
<h2 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h2>
|
||
<p>If no backend feature for the active target platform is enabled,
|
||
this method will panic, see <a href="../struct.Instance.html#method.enabled_backend_features" title="associated function wgpu::Instance::enabled_backend_features"><code>Instance::enabled_backend_features()</code></a>.</p>
|
||
</div></details></section></div></main></body></html> |