use crate::{Adapter, Instance, RequestAdapterOptions, Surface};
#[cfg(doc)]
use crate::Backends;
#[cfg(wgpu_core)]
#[cfg_attr(not(std), expect(unused_variables, unreachable_code))]
pub fn initialize_adapter_from_env(
instance: &Instance,
compatible_surface: Option<&Surface<'_>>,
) -> Result<Adapter, wgt::RequestAdapterError> {
let desired_adapter_name: alloc::string::String = {
cfg_if::cfg_if! {
if #[cfg(std)] {
std::env::var("WGPU_ADAPTER_NAME")
.as_deref()
.map(str::to_lowercase)
.map_err(|_| wgt::RequestAdapterError::EnvNotSet)?
} else {
return Err(wgt::RequestAdapterError::EnvNotSet)
}
}
};
let adapters = instance.enumerate_adapters(crate::Backends::all());
let mut chosen_adapter = None;
for adapter in adapters {
let info = adapter.get_info();
if let Some(surface) = compatible_surface {
if !adapter.is_surface_supported(surface) {
continue;
}
}
if info.name.to_lowercase().contains(&desired_adapter_name) {
chosen_adapter = Some(adapter);
break;
}
}
Ok(chosen_adapter.expect("WGPU_ADAPTER_NAME set but no matching adapter found!"))
}
#[cfg(not(wgpu_core))]
pub fn initialize_adapter_from_env(
_instance: &Instance,
_compatible_surface: Option<&Surface<'_>>,
) -> Result<Adapter, wgt::RequestAdapterError> {
Err(wgt::RequestAdapterError::EnvNotSet)
}
pub async fn initialize_adapter_from_env_or_default(
instance: &Instance,
compatible_surface: Option<&Surface<'_>>,
) -> Result<Adapter, wgt::RequestAdapterError> {
match initialize_adapter_from_env(instance, compatible_surface) {
Ok(a) => Ok(a),
Err(_) => {
instance
.request_adapter(&RequestAdapterOptions {
power_preference: crate::PowerPreference::from_env().unwrap_or_default(),
force_fallback_adapter: false,
compatible_surface,
})
.await
}
}
}
pub async fn is_browser_webgpu_supported() -> bool {
#[cfg(webgpu)]
{
let gpu = crate::backend::get_browser_gpu_property();
let Ok(Some(gpu)) = gpu else {
return false;
};
let adapter_promise = gpu.request_adapter();
wasm_bindgen_futures::JsFuture::from(adapter_promise)
.await
.is_ok_and(|adapter| !adapter.is_undefined() && !adapter.is_null())
}
#[cfg(not(webgpu))]
{
false
}
}
pub async fn new_instance_with_webgpu_detection(
instance_desc: &wgt::InstanceDescriptor,
) -> crate::Instance {
let mut instance_desc = instance_desc.clone();
if instance_desc
.backends
.contains(wgt::Backends::BROWSER_WEBGPU)
&& !is_browser_webgpu_supported().await
{
instance_desc.backends.remove(wgt::Backends::BROWSER_WEBGPU);
}
crate::Instance::new(&instance_desc)
}