mirror of
https://github.com/storytold/wgpu.git
synced 2026-11-19 14:01:08 +01:00
1040 lines
38 KiB
Rust
1040 lines
38 KiB
Rust
//! [`Backend`], [`Backends`], and backend-specific options.
|
|
|
|
use alloc::string::{String, ToString};
|
|
use core::{hash::Hash, str::FromStr};
|
|
|
|
use macro_rules_attribute::derive;
|
|
|
|
#[cfg(any(feature = "serde", test))]
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use crate::{link_to_wgpu_docs, ConstDefault};
|
|
|
|
#[cfg(doc)]
|
|
use crate::InstanceDescriptor;
|
|
|
|
/// Backends supported by wgpu.
|
|
///
|
|
/// See also [`Backends`].
|
|
#[repr(u8)]
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
|
|
pub enum Backend {
|
|
/// Dummy backend, which may be used for testing.
|
|
///
|
|
/// It performs no rendering or computation, but allows creation of stub GPU resource types,
|
|
/// so that code which manages GPU resources can be tested without an available GPU.
|
|
/// Specifically, the following operations are implemented:
|
|
///
|
|
/// * Enumerating adapters will always return one noop adapter, which can be used to create
|
|
/// devices.
|
|
/// * Buffers may be created, written, mapped, and copied to other buffers.
|
|
/// * Command encoders may be created, but only buffer operations are useful.
|
|
///
|
|
/// Other resources can be created but are nonfunctional; notably,
|
|
///
|
|
/// * Render passes and compute passes are not executed.
|
|
/// * Textures may be created, but do not store any texels.
|
|
/// * There are no compatible surfaces.
|
|
///
|
|
/// An adapter using the noop backend can only be obtained if [`NoopBackendOptions`]
|
|
/// enables it, in addition to the ordinary requirement of [`Backends::NOOP`] being set.
|
|
/// This ensures that applications not desiring a non-functional backend will not receive it.
|
|
Noop = 0,
|
|
|
|
/// Vulkan API (Windows, Linux, Android, MacOS via `vulkan-portability`/MoltenVK)
|
|
Vulkan = 1,
|
|
|
|
/// Metal API (Apple platforms)
|
|
Metal = 2,
|
|
|
|
/// Direct3D-12 (Windows)
|
|
Dx12 = 3,
|
|
|
|
/// OpenGL 3.3+, OpenGL ES 3.0+, WebGL2.
|
|
///
|
|
/// - On Windows, this is normally OpenGL. If you build with
|
|
/// `cfg(windows_angle)` to use ANGLE instead, then this is OpenGL ES.
|
|
///
|
|
/// - On Linux, we create a full OpenGL context if possible (Mesa offers
|
|
/// it), but if that fails we fall back to OpenGL ES.
|
|
///
|
|
/// - On Android and macOS with ANGLE, we get OpenGL ES.
|
|
///
|
|
/// - When running in a web browser, we get WebGL2.
|
|
Gl = 4,
|
|
|
|
/// WebGPU in the browser
|
|
BrowserWebGpu = 5,
|
|
}
|
|
|
|
impl Backend {
|
|
/// Array of all [`Backend`] values, corresponding to [`Backends::all()`].
|
|
pub const ALL: [Backend; Backends::all().bits().count_ones() as usize] = [
|
|
Self::Noop,
|
|
Self::Vulkan,
|
|
Self::Metal,
|
|
Self::Dx12,
|
|
Self::Gl,
|
|
Self::BrowserWebGpu,
|
|
];
|
|
|
|
/// Returns the string name of the backend.
|
|
#[must_use]
|
|
pub const fn to_str(self) -> &'static str {
|
|
match self {
|
|
Backend::Noop => "noop",
|
|
Backend::Vulkan => "vulkan",
|
|
Backend::Metal => "metal",
|
|
Backend::Dx12 => "dx12",
|
|
Backend::Gl => "gl",
|
|
Backend::BrowserWebGpu => "webgpu",
|
|
}
|
|
}
|
|
}
|
|
|
|
impl core::fmt::Display for Backend {
|
|
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
|
|
f.write_str(self.to_str())
|
|
}
|
|
}
|
|
|
|
bitflags::bitflags! {
|
|
/// Represents the backends that wgpu will use.
|
|
#[repr(transparent)]
|
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
#[cfg_attr(feature = "serde", serde(transparent))]
|
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
|
|
pub struct Backends: u32 {
|
|
/// [`Backend::Noop`].
|
|
const NOOP = 1 << Backend::Noop as u32;
|
|
|
|
/// [`Backend::Vulkan`].
|
|
/// Supported on Windows, Linux/Android, and macOS/iOS via Vulkan Portability (with the Vulkan feature enabled)
|
|
const VULKAN = 1 << Backend::Vulkan as u32;
|
|
|
|
/// [`Backend::Gl`].
|
|
/// Supported on Linux/Android, the web through webassembly via WebGL, and
|
|
/// Windows through native OpenGL by default or ANGLE with `cfg(windows_angle)`.
|
|
const GL = 1 << Backend::Gl as u32;
|
|
|
|
/// [`Backend::Metal`].
|
|
/// Supported on macOS and iOS.
|
|
const METAL = 1 << Backend::Metal as u32;
|
|
|
|
/// [`Backend::Dx12`].
|
|
/// Supported on Windows 10 and later
|
|
const DX12 = 1 << Backend::Dx12 as u32;
|
|
|
|
/// [`Backend::BrowserWebGpu`].
|
|
/// Supported when targeting the web through WebAssembly with the `webgpu` feature enabled.
|
|
///
|
|
/// The WebGPU backend is special in several ways:
|
|
/// It is not not implemented by `wgpu_core` and instead by the higher level `wgpu` crate.
|
|
/// Whether WebGPU is targeted is decided upon the creation of the `wgpu::Instance`,
|
|
/// *not* upon adapter creation. See `wgpu::Instance::new`.
|
|
const BROWSER_WEBGPU = 1 << Backend::BrowserWebGpu as u32;
|
|
|
|
/// All the apis that wgpu offers first tier of support for.
|
|
///
|
|
/// * [`Backends::VULKAN`]
|
|
/// * [`Backends::METAL`]
|
|
/// * [`Backends::DX12`]
|
|
/// * [`Backends::BROWSER_WEBGPU`]
|
|
const PRIMARY = Self::VULKAN.bits()
|
|
| Self::METAL.bits()
|
|
| Self::DX12.bits()
|
|
| Self::BROWSER_WEBGPU.bits();
|
|
|
|
/// All the apis that wgpu offers second tier of support for. These may
|
|
/// be unsupported/still experimental.
|
|
///
|
|
/// * [`Backends::GL`]
|
|
const SECONDARY = Self::GL.bits();
|
|
}
|
|
}
|
|
|
|
impl Default for Backends {
|
|
fn default() -> Self {
|
|
Self::all()
|
|
}
|
|
}
|
|
|
|
impl From<Backend> for Backends {
|
|
fn from(backend: Backend) -> Self {
|
|
Self::from_bits(1 << backend as u32).unwrap()
|
|
}
|
|
}
|
|
|
|
impl Backends {
|
|
/// Gets a set of backends from the environment variable `WGPU_BACKEND`.
|
|
///
|
|
/// See [`Self::from_comma_list()`] for the format of the string.
|
|
pub fn from_env() -> Option<Self> {
|
|
let env = crate::env::var("WGPU_BACKEND")?;
|
|
Some(Self::from_comma_list(&env))
|
|
}
|
|
|
|
/// Takes the given options, modifies them based on the `WGPU_BACKEND` environment variable, and returns the result.
|
|
pub fn with_env(&self) -> Self {
|
|
if let Some(env) = Self::from_env() {
|
|
env
|
|
} else {
|
|
*self
|
|
}
|
|
}
|
|
|
|
/// Generates a set of backends from a comma separated list of case-insensitive backend names.
|
|
///
|
|
/// Whitespace is stripped, so both 'gl, dx12' and 'gl,dx12' are valid.
|
|
///
|
|
/// Always returns WEBGPU on wasm over webgpu.
|
|
///
|
|
/// Names:
|
|
/// - vulkan = "vulkan" or "vk"
|
|
/// - dx12 = "dx12" or "d3d12"
|
|
/// - metal = "metal" or "mtl"
|
|
/// - gles = "opengl" or "gles" or "gl"
|
|
/// - webgpu = "webgpu"
|
|
pub fn from_comma_list(string: &str) -> Self {
|
|
let mut backends = Self::empty();
|
|
for backend in string.to_lowercase().split(',') {
|
|
backends |= match backend.trim() {
|
|
"vulkan" | "vk" => Self::VULKAN,
|
|
"dx12" | "d3d12" => Self::DX12,
|
|
"metal" | "mtl" => Self::METAL,
|
|
"opengl" | "gles" | "gl" => Self::GL,
|
|
"webgpu" => Self::BROWSER_WEBGPU,
|
|
"noop" => Self::NOOP,
|
|
b => {
|
|
log::warn!("unknown backend string '{b}'");
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
if backends.is_empty() {
|
|
log::warn!("no valid backend strings found!");
|
|
}
|
|
|
|
backends
|
|
}
|
|
}
|
|
|
|
/// Options that are passed to a given backend.
|
|
///
|
|
/// Part of [`InstanceDescriptor`].
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub struct BackendOptions {
|
|
/// Options for the OpenGL/OpenGLES backend, [`Backend::Gl`].
|
|
pub gl: GlBackendOptions,
|
|
/// Options for the DX12 backend, [`Backend::Dx12`].
|
|
pub dx12: Dx12BackendOptions,
|
|
/// Options for the noop backend, [`Backend::Noop`].
|
|
pub noop: NoopBackendOptions,
|
|
}
|
|
|
|
impl BackendOptions {
|
|
/// Choose backend options by calling `from_env` on every field.
|
|
///
|
|
/// See those methods for more information.
|
|
#[must_use]
|
|
pub fn from_env_or_default() -> Self {
|
|
Self {
|
|
gl: GlBackendOptions::from_env_or_default(),
|
|
dx12: Dx12BackendOptions::from_env_or_default(),
|
|
noop: NoopBackendOptions::from_env_or_default(),
|
|
}
|
|
}
|
|
|
|
/// Takes the given options, modifies them based on the environment variables, and returns the result.
|
|
///
|
|
/// This is equivalent to calling `with_env` on every field.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
Self {
|
|
gl: self.gl.with_env(),
|
|
dx12: self.dx12.with_env(),
|
|
noop: self.noop.with_env(),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Configuration for the OpenGL/OpenGLES backend.
|
|
///
|
|
/// Part of [`BackendOptions`].
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub struct GlBackendOptions {
|
|
/// Which OpenGL ES 3 minor version to request, if using OpenGL ES.
|
|
pub gles_minor_version: Gles3MinorVersion,
|
|
/// Behavior of OpenGL fences. Affects how `on_completed_work_done` and `device.poll` behave.
|
|
pub fence_behavior: GlFenceBehavior,
|
|
/// Controls whether debug functions (`glPushDebugGroup`, `glPopDebugGroup`,
|
|
/// `glObjectLabel`, etc.) are enabled when supported by the driver.
|
|
///
|
|
/// By default ([`GlDebugFns::Auto`]), debug functions are automatically
|
|
/// disabled on devices with known bugs (e.g., Mali GPUs can crash in
|
|
/// `glPushDebugGroup`). Use [`GlDebugFns::ForceEnabled`] to override this
|
|
/// behavior, or [`GlDebugFns::Disabled`] to disable debug functions entirely.
|
|
///
|
|
/// See also [`InstanceFlags::DISCARD_HAL_LABELS`], which prevents debug
|
|
/// markers and labels from being sent to *any* backend, but without the
|
|
/// driver-specific bug workarounds provided here.
|
|
///
|
|
/// [`InstanceFlags::DISCARD_HAL_LABELS`]: crate::InstanceFlags::DISCARD_HAL_LABELS
|
|
pub debug_fns: GlDebugFns,
|
|
}
|
|
|
|
impl GlBackendOptions {
|
|
/// Choose OpenGL backend options by calling `from_env` on every field.
|
|
///
|
|
/// See those methods for more information.
|
|
#[must_use]
|
|
pub fn from_env_or_default() -> Self {
|
|
let gles_minor_version = Gles3MinorVersion::from_env().unwrap_or_default();
|
|
let debug_fns = GlDebugFns::from_env().unwrap_or_default();
|
|
Self {
|
|
gles_minor_version,
|
|
fence_behavior: GlFenceBehavior::Normal,
|
|
debug_fns,
|
|
}
|
|
}
|
|
|
|
/// Takes the given options, modifies them based on the environment variables, and returns the result.
|
|
///
|
|
/// This is equivalent to calling `with_env` on every field.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
let gles_minor_version = self.gles_minor_version.with_env();
|
|
let fence_behavior = self.fence_behavior.with_env();
|
|
let debug_fns = self.debug_fns.with_env();
|
|
Self {
|
|
gles_minor_version,
|
|
fence_behavior,
|
|
debug_fns,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Controls whether OpenGL debug functions are enabled.
|
|
///
|
|
/// Debug functions include `glPushDebugGroup`, `glPopDebugGroup`, `glObjectLabel`, etc.
|
|
/// These are useful for debugging but can cause crashes on some buggy drivers.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, ConstDefault!)]
|
|
pub enum GlDebugFns {
|
|
/// Automatically decide whether to enable debug functions.
|
|
///
|
|
/// Debug functions will be enabled if supported by the driver, unless
|
|
/// running on a device known to have buggy debug function implementations
|
|
/// (e.g., Mali GPUs which can crash in `glPushDebugGroup`).
|
|
///
|
|
/// This is the default behavior.
|
|
#[custom(default)]
|
|
Auto,
|
|
/// Force enable debug functions if supported by the driver.
|
|
///
|
|
/// This ignores any device-specific workarounds and enables debug functions
|
|
/// on all devices that support them, including those with known bugs.
|
|
ForceEnabled,
|
|
/// Disable debug functions entirely.
|
|
///
|
|
/// Debug functions will not be used even if supported by the driver.
|
|
Disabled,
|
|
}
|
|
|
|
impl GlDebugFns {
|
|
/// Choose debug functions setting from the environment variable `WGPU_GL_DEBUG_FNS`.
|
|
///
|
|
/// Possible values (case insensitive):
|
|
/// - `auto` - automatically decide based on device
|
|
/// - `forceenabled`, `force_enabled`, or `enabled` - force enable
|
|
/// - `disabled` - disable entirely
|
|
///
|
|
/// Use with `unwrap_or_default()` to get the default value if the environment variable is not set.
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_GL_DEBUG_FNS")
|
|
.as_deref()?
|
|
.to_lowercase();
|
|
match value.as_str() {
|
|
"auto" => Some(Self::Auto),
|
|
"forceenabled" | "force_enabled" | "enabled" => Some(Self::ForceEnabled),
|
|
"disabled" => Some(Self::Disabled),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given setting, modifies it based on the `WGPU_GL_DEBUG_FNS` environment variable, and returns the result.
|
|
///
|
|
/// See `from_env` for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(debug_fns) = Self::from_env() {
|
|
debug_fns
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Used to force wgpu to expose certain features on passthrough shaders even when
|
|
/// those features aren't present on runtime-compiled shaders
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub struct ForceShaderModelToken {
|
|
inner: Option<DxcShaderModel>,
|
|
}
|
|
impl ForceShaderModelToken {
|
|
/// Creates an unsafe token, opting you in to seeing features that you may not necessarily use
|
|
/// on standard runtime-compiled shaders.
|
|
/// # Safety
|
|
/// Do not make use in runtime-compiled shaders of any features that may not be supported by the FXC or DXC
|
|
/// version you use.
|
|
pub const unsafe fn with_shader_model(sm: DxcShaderModel) -> Self {
|
|
Self { inner: Some(sm) }
|
|
}
|
|
|
|
/// Returns the shader model version, if any, in this token.
|
|
pub const fn get(&self) -> Option<DxcShaderModel> {
|
|
self.inner
|
|
}
|
|
}
|
|
|
|
/// Behavior when the Agility SDK fails to load.
|
|
///
|
|
/// See [`Dx12AgilitySDK`] for details on the Agility SDK.
|
|
#[derive(Clone, Copy, Debug, ConstDefault!, PartialEq, Eq)]
|
|
pub enum Dx12AgilitySDKLoadFailure {
|
|
/// Log a warning and fall back to the system-installed D3D12 runtime.
|
|
///
|
|
/// This is the default behavior and is appropriate for most applications.
|
|
#[custom(default)]
|
|
Fallback,
|
|
/// Fail instance creation entirely if the Agility SDK cannot be loaded.
|
|
///
|
|
/// Use this in environments where you are shipping the Agility SDK alongside your application
|
|
/// and want to ensure that it is being loaded correctly.
|
|
Error,
|
|
}
|
|
|
|
impl Dx12AgilitySDKLoadFailure {
|
|
/// Read the load failure behavior from the environment variable
|
|
/// `WGPU_DX12_AGILITY_SDK_REQUIRE`.
|
|
///
|
|
/// When set to `1`, returns [`Error`](Self::Error).
|
|
/// When set to `0`, returns [`Fallback`](Self::Fallback).
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_DX12_AGILITY_SDK_REQUIRE")?;
|
|
match value.as_str() {
|
|
"1" => Some(Self::Error),
|
|
"0" => Some(Self::Fallback),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given setting, modifies it based on the
|
|
/// `WGPU_DX12_AGILITY_SDK_REQUIRE` environment variable, and returns the result.
|
|
///
|
|
/// See [`from_env`](Self::from_env) for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(v) = Self::from_env() {
|
|
v
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Configuration for loading a specific [DirectX 12 Agility SDK] runtime.
|
|
///
|
|
/// The Agility SDK allows applications to ship a newer version of the D3D12 runtime
|
|
/// (`D3D12Core.dll`) alongside the application, enabling access to the latest D3D12
|
|
/// features without waiting for the OS to update its built-in runtime. This is the
|
|
/// standard way for games and applications to adopt new D3D12 functionality on older
|
|
/// Windows versions.
|
|
///
|
|
/// Downloads and release notes are available at the [DirectX 12 Agility SDK] page.
|
|
///
|
|
/// wgpu loads the Agility SDK via the [Independent Devices API], which allows
|
|
/// specifying the SDK path and version at runtime without requiring exported constants
|
|
/// or developer mode. The [`sdk_version`](Self::sdk_version) must match the version of
|
|
/// the `D3D12Core.dll` in the provided path exactly, or loading will fail, irrespective of
|
|
/// the OS's built-in runtime version.
|
|
///
|
|
/// If the shipped SDK is older than the system runtime, the system runtime will be used.
|
|
/// This allows applications to ship a minimum SDK version while still benefiting from SDK updates on the user's system.
|
|
///
|
|
/// If the Agility SDK fails to load (version mismatch, missing DLL, unsupported OS,
|
|
/// etc.), the behavior is controlled by [`on_load_failure`](Self::on_load_failure).
|
|
/// By default, wgpu logs a warning and falls back to the system-installed D3D12 runtime.
|
|
/// Set it to [`Error`](Dx12AgilitySDKLoadFailure::Error) to fail instance creation instead
|
|
/// (useful in CI/testing).
|
|
///
|
|
/// ## OS requirements
|
|
///
|
|
/// The Independent Devices API requires a Windows update from August/September 2023
|
|
/// or newer:
|
|
///
|
|
/// - [Windows 11 21H2+ (KB5029332)][win11-21h2]
|
|
/// - [Windows 10 22H2+ (KB5029331)][win10-22h2]
|
|
/// - [Windows Server 2022+ (KB5030216)][server-2022]
|
|
///
|
|
/// On older OS builds the Agility SDK will not load and wgpu will log a warning and
|
|
/// fall back to the system runtime (or error, per [`on_load_failure`](Self::on_load_failure)).
|
|
///
|
|
/// [DirectX 12 Agility SDK]: https://devblogs.microsoft.com/directx/directx12agility/
|
|
/// [Independent Devices API]: https://devblogs.microsoft.com/directx/d3d12-independent-devices/
|
|
/// [win11-21h2]: https://support.microsoft.com/en-us/topic/august-22-2023-kb5029332-os-build-22000-2360-preview-8f8aec64-77b4-4225-9a0f-f0153204ae28
|
|
/// [win10-22h2]: https://support.microsoft.com/en-gb/topic/august-22-2023-kb5029331-os-build-19045-3393-preview-9f6c1dbd-0ee6-469b-af24-f9d0bf35ca18
|
|
/// [server-2022]: https://support.microsoft.com/en-au/topic/september-12-2023-kb5030216-os-build-20348-1970-34d4aff3-fd05-4270-b288-4ab6379c7f81
|
|
#[derive(Clone, Debug, Eq, PartialEq)]
|
|
pub struct Dx12AgilitySDK {
|
|
/// The Agility SDK version number (e.g., 614 for SDK version 1.614.0).
|
|
///
|
|
/// This must match the version of the `D3D12Core.dll` at [`sdk_path`](Self::sdk_path)
|
|
/// exactly, or the runtime will fail to load.
|
|
pub sdk_version: u32,
|
|
/// Path to the directory containing the Agility SDK's `D3D12Core.dll`.
|
|
pub sdk_path: String,
|
|
/// What to do if the Agility SDK fails to load.
|
|
///
|
|
/// Defaults to [`Fallback`](Dx12AgilitySDKLoadFailure::Fallback).
|
|
///
|
|
/// Can also be set via the `WGPU_DX12_AGILITY_SDK_REQUIRE` environment variable
|
|
/// (`1` for [`Error`](Dx12AgilitySDKLoadFailure::Error),
|
|
/// `0` for [`Fallback`](Dx12AgilitySDKLoadFailure::Fallback)).
|
|
pub on_load_failure: Dx12AgilitySDKLoadFailure,
|
|
}
|
|
|
|
impl Dx12AgilitySDK {
|
|
/// Read Agility SDK configuration from environment variables.
|
|
///
|
|
/// Reads `WGPU_DX12_AGILITY_SDK_PATH`, `WGPU_DX12_AGILITY_SDK_VERSION`,
|
|
/// and `WGPU_DX12_AGILITY_SDK_REQUIRE`.
|
|
/// Both path and version must be set for this to return `Some`.
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let sdk_path = crate::env::var("WGPU_DX12_AGILITY_SDK_PATH")?;
|
|
let sdk_version_str = crate::env::var("WGPU_DX12_AGILITY_SDK_VERSION")?;
|
|
let sdk_version = sdk_version_str.parse::<u32>().ok()?;
|
|
let on_load_failure = Dx12AgilitySDKLoadFailure::from_env().unwrap_or_default();
|
|
Some(Self {
|
|
sdk_version,
|
|
sdk_path,
|
|
on_load_failure,
|
|
})
|
|
}
|
|
|
|
/// Takes the given configuration, overrides fields with environment variables if present,
|
|
/// and returns the result.
|
|
///
|
|
/// Reads `WGPU_DX12_AGILITY_SDK_PATH`, `WGPU_DX12_AGILITY_SDK_VERSION`,
|
|
/// and `WGPU_DX12_AGILITY_SDK_REQUIRE`.
|
|
/// Each variable overrides the corresponding field independently.
|
|
#[must_use]
|
|
pub fn with_env(mut self) -> Self {
|
|
if let Some(sdk_path) = crate::env::var("WGPU_DX12_AGILITY_SDK_PATH") {
|
|
self.sdk_path = sdk_path;
|
|
}
|
|
if let Some(sdk_version_str) = crate::env::var("WGPU_DX12_AGILITY_SDK_VERSION") {
|
|
if let Ok(sdk_version) = sdk_version_str.parse::<u32>() {
|
|
self.sdk_version = sdk_version;
|
|
}
|
|
}
|
|
self.on_load_failure = self.on_load_failure.with_env();
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Configuration for the DX12 backend.
|
|
///
|
|
/// Part of [`BackendOptions`].
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub struct Dx12BackendOptions {
|
|
/// Which DX12 shader compiler to use.
|
|
pub shader_compiler: Dx12Compiler,
|
|
/// Presentation system to use.
|
|
pub presentation_system: Dx12SwapchainKind,
|
|
/// Whether to wait for the latency waitable object before acquiring the next swapchain image.
|
|
pub latency_waitable_object: Dx12UseFrameLatencyWaitableObject,
|
|
/// For use with passthrough shaders. Expose features as if this shader model is present, even if you do not
|
|
/// intend to ship DXC with your app.
|
|
///
|
|
/// This does not override the device's shader model version, only the external shader compiler's version.
|
|
pub force_shader_model: ForceShaderModelToken,
|
|
/// Optional Agility SDK configuration for using the Independent Devices API.
|
|
///
|
|
/// When set, wgpu will attempt to load the specified D3D12 runtime via the
|
|
/// Independent Devices API. If the API is unavailable or the configuration is
|
|
/// invalid, it falls back to the system-installed D3D12 runtime.
|
|
///
|
|
/// Can also be set via `WGPU_DX12_AGILITY_SDK_PATH` and `WGPU_DX12_AGILITY_SDK_VERSION`
|
|
/// environment variables.
|
|
pub agility_sdk: Option<Dx12AgilitySDK>,
|
|
}
|
|
|
|
impl Dx12BackendOptions {
|
|
/// Choose DX12 backend options by calling `from_env` on every field.
|
|
///
|
|
/// See those methods for more information.
|
|
#[must_use]
|
|
pub fn from_env_or_default() -> Self {
|
|
let compiler = Dx12Compiler::from_env().unwrap_or_default();
|
|
let presentation_system = Dx12SwapchainKind::from_env().unwrap_or_default();
|
|
let latency_waitable_object =
|
|
Dx12UseFrameLatencyWaitableObject::from_env().unwrap_or_default();
|
|
let agility_sdk = Dx12AgilitySDK::from_env();
|
|
Self {
|
|
shader_compiler: compiler,
|
|
presentation_system,
|
|
latency_waitable_object,
|
|
force_shader_model: ForceShaderModelToken::default(),
|
|
agility_sdk,
|
|
}
|
|
}
|
|
|
|
/// Takes the given options, modifies them based on the environment variables, and returns the result.
|
|
///
|
|
/// This is equivalent to calling `with_env` on every field.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
let shader_compiler = self.shader_compiler.with_env();
|
|
let presentation_system = self.presentation_system.with_env();
|
|
let latency_waitable_object = self.latency_waitable_object.with_env();
|
|
let agility_sdk = self
|
|
.agility_sdk
|
|
.map(|s| s.with_env())
|
|
.or_else(Dx12AgilitySDK::from_env);
|
|
Self {
|
|
shader_compiler,
|
|
presentation_system,
|
|
latency_waitable_object,
|
|
force_shader_model: ForceShaderModelToken::default(),
|
|
agility_sdk,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Configuration for the noop backend.
|
|
///
|
|
/// Part of [`BackendOptions`].
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub struct NoopBackendOptions {
|
|
/// Whether to allow the noop backend to be used.
|
|
///
|
|
/// The noop backend stubs out all operations except for buffer creation and mapping, so
|
|
/// it must not be used when not expected. Therefore, it will not be used unless explicitly
|
|
/// enabled.
|
|
pub enable: bool,
|
|
|
|
/// Specify the reported limits values. If `None`, reports maximally permissive limits.
|
|
pub limits: Option<crate::Limits>,
|
|
|
|
/// Specify the reported feature support. If `None`, reports support for all features.
|
|
pub features: Option<crate::Features>,
|
|
|
|
/// Specify the reported device type. If `None`, uses [`crate::DeviceType::Other`].
|
|
pub device_type: Option<crate::DeviceType>,
|
|
|
|
/// Specify the reported minimum subgroup size.
|
|
pub subgroup_min_size: Option<u32>,
|
|
|
|
/// Specify the reported maximum subgroup size.
|
|
pub subgroup_max_size: Option<u32>,
|
|
}
|
|
|
|
impl NoopBackendOptions {
|
|
/// Enable the noop backend.
|
|
pub fn enabled() -> Self {
|
|
Self {
|
|
enable: true,
|
|
..Default::default()
|
|
}
|
|
}
|
|
|
|
/// Choose whether the noop backend is enabled from the environment.
|
|
///
|
|
/// It will be enabled if the environment variable `WGPU_NOOP_BACKEND` has the value `1`
|
|
/// and not otherwise. Future versions may assign other meanings to other values.
|
|
#[must_use]
|
|
pub fn from_env_or_default() -> Self {
|
|
Self {
|
|
enable: Self::enable_from_env().unwrap_or(false),
|
|
..Default::default()
|
|
}
|
|
}
|
|
|
|
/// Takes the given options, modifies them based on the environment variables, and returns the
|
|
/// result.
|
|
///
|
|
/// See [`from_env_or_default()`](Self::from_env_or_default) for the interpretation.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
Self {
|
|
enable: Self::enable_from_env().unwrap_or(self.enable),
|
|
..self
|
|
}
|
|
}
|
|
|
|
fn enable_from_env() -> Option<bool> {
|
|
let value = crate::env::var("WGPU_NOOP_BACKEND")?;
|
|
match value.as_str() {
|
|
"1" => Some(true),
|
|
"0" => Some(false),
|
|
_ => None,
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Clone, Debug, ConstDefault!, Copy, PartialEq, Eq)]
|
|
/// Selects which kind of swapchain to use on DX12.
|
|
pub enum Dx12SwapchainKind {
|
|
/// Use a DXGI swapchain made directly from the window's HWND.
|
|
///
|
|
/// This does not support transparency but has better support from developer tooling from RenderDoc.
|
|
#[custom(default)]
|
|
DxgiFromHwnd,
|
|
/// Use a DXGI swapchain made from a DirectComposition visual made automatically from the window's HWND.
|
|
///
|
|
/// This creates a single [`IDCompositionVisual`] over the entire window that is used by the `Surface`.
|
|
/// If a user wants to manage the composition tree themselves, they should create their own device and
|
|
/// composition, and pass the relevant visual down via [`SurfaceTargetUnsafe::CompositionVisual`][CV].
|
|
///
|
|
/// This supports transparent windows, but does not have support from RenderDoc.
|
|
///
|
|
/// [`IDCompositionVisual`]: https://learn.microsoft.com/en-us/windows/win32/api/dcomp/nn-dcomp-idcompositionvisual
|
|
#[doc = link_to_wgpu_docs!(["CV"]: "struct.SurfaceTargetUnsafe.html#variant.CompositionVisual")]
|
|
DxgiFromVisual,
|
|
}
|
|
|
|
impl Dx12SwapchainKind {
|
|
/// Choose which presentation system to use from the environment variable `WGPU_DX12_PRESENTATION_SYSTEM`.
|
|
///
|
|
/// Valid values, case insensitive:
|
|
/// - `DxgiFromVisual` or `Visual`
|
|
/// - `DxgiFromHwnd` or `Hwnd` for [`Self::DxgiFromHwnd`]
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_DX12_PRESENTATION_SYSTEM")
|
|
.as_deref()?
|
|
.to_lowercase();
|
|
match value.as_str() {
|
|
"dxgifromvisual" | "visual" => Some(Self::DxgiFromVisual),
|
|
"dxgifromhwnd" | "hwnd" => Some(Self::DxgiFromHwnd),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given presentation system, modifies it based on the `WGPU_DX12_PRESENTATION_SYSTEM` environment variable, and returns the result.
|
|
///
|
|
/// See [`from_env`](Self::from_env) for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(presentation_system) = Self::from_env() {
|
|
presentation_system
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
/// DXC shader model.
|
|
#[derive(Clone, Copy, Eq, PartialEq, Debug)]
|
|
#[allow(missing_docs)]
|
|
pub enum DxcShaderModel {
|
|
V6_0,
|
|
V6_1,
|
|
V6_2,
|
|
V6_3,
|
|
V6_4,
|
|
V6_5,
|
|
V6_6,
|
|
V6_7,
|
|
V6_8,
|
|
V6_9,
|
|
}
|
|
|
|
impl DxcShaderModel {
|
|
/// Get the shader model supported by a certain DXC version.
|
|
pub fn from_dxc_version(major: u32, minor: u32) -> Self {
|
|
// DXC version roughly has corresponded to shader model so far, where DXC 1.x supports SM 6.x.
|
|
// See discussion in https://discord.com/channels/590611987420020747/996417435374714920/1471234702206701650.
|
|
// Presumably DXC 2.0 and up will still support shader model 6.9.
|
|
if major > 1 {
|
|
Self::V6_9
|
|
} else {
|
|
Self::from_parts(6, minor)
|
|
}
|
|
}
|
|
|
|
/// Parse a DxcShaderModel from its version components.
|
|
pub fn from_parts(major: u32, minor: u32) -> Self {
|
|
if major > 6 || minor > 8 {
|
|
Self::V6_9
|
|
} else {
|
|
match minor {
|
|
0 => DxcShaderModel::V6_0,
|
|
1 => DxcShaderModel::V6_1,
|
|
2 => DxcShaderModel::V6_2,
|
|
3 => DxcShaderModel::V6_3,
|
|
4 => DxcShaderModel::V6_4,
|
|
5 => DxcShaderModel::V6_5,
|
|
6 => DxcShaderModel::V6_6,
|
|
7 => DxcShaderModel::V6_7,
|
|
8 => DxcShaderModel::V6_8,
|
|
9 => DxcShaderModel::V6_9,
|
|
// > 6.9
|
|
_ => DxcShaderModel::V6_9,
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Selects which DX12 shader compiler to use.
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub enum Dx12Compiler {
|
|
/// The Fxc compiler (default) is old, slow and unmaintained.
|
|
///
|
|
/// However, it doesn't require any additional .dlls to be shipped with the application.
|
|
Fxc,
|
|
/// The Dxc compiler is new, fast and maintained.
|
|
///
|
|
/// However, it requires `dxcompiler.dll` to be shipped with the application.
|
|
/// These files can be downloaded from <https://github.com/microsoft/DirectXShaderCompiler/releases>.
|
|
///
|
|
/// Minimum supported version: [v1.8.2502](https://github.com/microsoft/DirectXShaderCompiler/releases/tag/v1.8.2502)
|
|
///
|
|
/// It also requires WDDM 2.1 (Windows 10 version 1607).
|
|
DynamicDxc {
|
|
/// Path to `dxcompiler.dll`.
|
|
dxc_path: String,
|
|
},
|
|
/// The statically-linked variant of Dxc.
|
|
///
|
|
/// The `static-dxc` feature is required for this setting to be used successfully on DX12.
|
|
/// Not available on `windows-aarch64-pc-*` targets.
|
|
StaticDxc,
|
|
/// Use statically-linked DXC if available. Otherwise check for dynamically linked DXC on the PATH. Finally, fallback to FXC.
|
|
#[custom(default)]
|
|
Auto,
|
|
}
|
|
|
|
impl Dx12Compiler {
|
|
/// Helper function to construct a `DynamicDxc` variant with default paths.
|
|
///
|
|
/// The dll must support at least shader model 6.8.
|
|
pub fn default_dynamic_dxc() -> Self {
|
|
Self::DynamicDxc {
|
|
dxc_path: String::from("dxcompiler.dll"),
|
|
}
|
|
}
|
|
|
|
/// Choose which DX12 shader compiler to use from the environment variable `WGPU_DX12_COMPILER`.
|
|
///
|
|
/// Valid values, case insensitive:
|
|
/// - `Fxc`
|
|
/// - `Dxc` or `DynamicDxc`
|
|
/// - `StaticDxc`
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let env = crate::env::var("WGPU_DX12_COMPILER")?;
|
|
env.parse().map_err(|expected_msg| {
|
|
log::warn!(
|
|
"Unknown value `{env:?}` for `WGPU_DX12_COMPILER` environment variable. {expected_msg}"
|
|
)
|
|
})
|
|
.ok()
|
|
}
|
|
|
|
/// Takes the given compiler, modifies it based on the `WGPU_DX12_COMPILER` environment variable, and returns the result.
|
|
///
|
|
/// See `from_env` for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(compiler) = Self::from_env() {
|
|
compiler
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
impl FromStr for Dx12Compiler {
|
|
type Err = &'static str;
|
|
|
|
fn from_str(value: &str) -> Result<Self, Self::Err> {
|
|
Ok(match value.to_lowercase().as_str() {
|
|
"dxc" | "dynamicdxc" => Self::default_dynamic_dxc(),
|
|
"staticdxc" => Self::StaticDxc,
|
|
"fxc" => Self::Fxc,
|
|
"auto" => Self::Auto,
|
|
path => Self::DynamicDxc {
|
|
dxc_path: path.to_string(),
|
|
},
|
|
})
|
|
}
|
|
}
|
|
|
|
/// Whether and how to use a waitable handle obtained from `GetFrameLatencyWaitableObject`.
|
|
#[derive(Clone, Debug, Eq, PartialEq, ConstDefault!)]
|
|
pub enum Dx12UseFrameLatencyWaitableObject {
|
|
/// Do not obtain a waitable handle and do not wait for it. The swapchain will
|
|
/// be created without the `DXGI_SWAP_CHAIN_FLAG_FRAME_LATENCY_WAITABLE_OBJECT` flag.
|
|
None,
|
|
/// Obtain a waitable handle and wait for it before acquiring the next swapchain image.
|
|
#[custom(default)]
|
|
Wait,
|
|
/// Create the swapchain with the `DXGI_SWAP_CHAIN_FLAG_FRAME_LATENCY_WAITABLE_OBJECT` flag and
|
|
/// obtain a waitable handle, but do not wait for it before acquiring the next swapchain image.
|
|
/// This is useful if the application wants to wait for the waitable object itself.
|
|
DontWait,
|
|
}
|
|
|
|
impl Dx12UseFrameLatencyWaitableObject {
|
|
/// Choose whether to use a frame latency waitable object from the environment variable `WGPU_DX12_USE_FRAME_LATENCY_WAITABLE_OBJECT`.
|
|
///
|
|
/// Valid values, case insensitive:
|
|
/// - `None`
|
|
/// - `Wait`
|
|
/// - `DontWait`
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_DX12_USE_FRAME_LATENCY_WAITABLE_OBJECT")
|
|
.as_deref()?
|
|
.to_lowercase();
|
|
match value.as_str() {
|
|
"none" => Some(Self::None),
|
|
"wait" => Some(Self::Wait),
|
|
"dontwait" => Some(Self::DontWait),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given setting, modifies it based on the `WGPU_DX12_USE_FRAME_LATENCY_WAITABLE_OBJECT` environment variable, and returns the result.
|
|
///
|
|
/// See `from_env` for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(compiler) = Self::from_env() {
|
|
compiler
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Selects which OpenGL ES 3 minor version to request.
|
|
///
|
|
/// When using ANGLE as an OpenGL ES/EGL implementation, explicitly requesting `Version1` can provide a non-conformant ES 3.1 on APIs like D3D11.
|
|
#[derive(Clone, Copy, Debug, ConstDefault!, Eq, PartialEq, Hash)]
|
|
pub enum Gles3MinorVersion {
|
|
/// No explicit minor version is requested, the driver automatically picks the highest available.
|
|
#[custom(default)]
|
|
Automatic,
|
|
|
|
/// Request an ES 3.0 context.
|
|
Version0,
|
|
|
|
/// Request an ES 3.1 context.
|
|
Version1,
|
|
|
|
/// Request an ES 3.2 context.
|
|
Version2,
|
|
}
|
|
|
|
impl Gles3MinorVersion {
|
|
/// Choose which minor OpenGL ES version to use from the environment variable `WGPU_GLES_MINOR_VERSION`.
|
|
///
|
|
/// Possible values are `0`, `1`, `2` or `automatic`. Case insensitive.
|
|
///
|
|
/// Use with `unwrap_or_default()` to get the default value if the environment variable is not set.
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_GLES_MINOR_VERSION")
|
|
.as_deref()?
|
|
.to_lowercase();
|
|
match value.as_str() {
|
|
"automatic" => Some(Self::Automatic),
|
|
"0" => Some(Self::Version0),
|
|
"1" => Some(Self::Version1),
|
|
"2" => Some(Self::Version2),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given compiler, modifies it based on the `WGPU_GLES_MINOR_VERSION` environment variable, and returns the result.
|
|
///
|
|
/// See `from_env` for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(compiler) = Self::from_env() {
|
|
compiler
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Dictate the behavior of fences in OpenGL.
|
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, ConstDefault!)]
|
|
pub enum GlFenceBehavior {
|
|
/// Fences in OpenGL behave normally. If you don't know what to pick, this is what you want.
|
|
#[custom(default)]
|
|
Normal,
|
|
/// Fences in OpenGL are short-circuited to always return `true` immediately.
|
|
///
|
|
/// This solves a very specific issue that arose due to a bug in wgpu-core that made
|
|
/// many WebGL programs work when they "shouldn't" have. If you have code that is trying
|
|
/// to call `device.poll(wgpu::PollType::Wait)` on WebGL, you need to enable this option
|
|
/// for the "Wait" to behave how you would expect.
|
|
///
|
|
/// Previously all `poll(Wait)` acted like the OpenGL fences were signalled even if they weren't.
|
|
/// See <https://github.com/gfx-rs/wgpu/issues/4589> for more information.
|
|
///
|
|
/// When this is set `Queue::on_completed_work_done` will always return the next time the device
|
|
/// is maintained, not when the work is actually done on the GPU.
|
|
AutoFinish,
|
|
}
|
|
|
|
impl GlFenceBehavior {
|
|
/// Returns true if the fence behavior is `AutoFinish`.
|
|
pub fn is_auto_finish(&self) -> bool {
|
|
matches!(self, Self::AutoFinish)
|
|
}
|
|
|
|
/// Returns true if the fence behavior is `Normal`.
|
|
pub fn is_normal(&self) -> bool {
|
|
matches!(self, Self::Normal)
|
|
}
|
|
|
|
/// Choose which minor OpenGL ES version to use from the environment variable `WGPU_GL_FENCE_BEHAVIOR`.
|
|
///
|
|
/// Possible values are `Normal` or `AutoFinish`. Case insensitive.
|
|
///
|
|
/// Use with `unwrap_or_default()` to get the default value if the environment variable is not set.
|
|
#[must_use]
|
|
pub fn from_env() -> Option<Self> {
|
|
let value = crate::env::var("WGPU_GL_FENCE_BEHAVIOR")
|
|
.as_deref()?
|
|
.to_lowercase();
|
|
match value.as_str() {
|
|
"normal" => Some(Self::Normal),
|
|
"autofinish" => Some(Self::AutoFinish),
|
|
_ => None,
|
|
}
|
|
}
|
|
|
|
/// Takes the given compiler, modifies it based on the `WGPU_GL_FENCE_BEHAVIOR` environment variable, and returns the result.
|
|
///
|
|
/// See `from_env` for more information.
|
|
#[must_use]
|
|
pub fn with_env(self) -> Self {
|
|
if let Some(fence) = Self::from_env() {
|
|
fence
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
}
|