Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add WGPU_BACKEND environment variable #789

Merged
merged 2 commits into from
Mar 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions glow/src/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,12 @@ impl Default for Settings {
}
}
}

impl Settings {
/// Creates new [`Settings`] using environment configuration.
///
/// Currently, this is equivalent to calling [`Settings::default`].
pub fn from_env() -> Self {
Self::default()
}
}
2 changes: 1 addition & 1 deletion src/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ pub trait Application: Sized {
} else {
None
},
..crate::renderer::Settings::default()
..crate::renderer::Settings::from_env()
};

Ok(crate::runtime::application::run::<
Expand Down
41 changes: 41 additions & 0 deletions wgpu/src/settings.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ pub struct Settings {
/// [`Backend`]: crate::Backend
pub present_mode: wgpu::PresentMode,

/// The internal graphics backend to use.
pub internal_backend: wgpu::BackendBit,

/// The bytes of the font that will be used by default.
///
/// If `None` is provided, a default system font will be chosen.
Expand All @@ -30,14 +33,52 @@ pub struct Settings {
pub antialiasing: Option<Antialiasing>,
}

impl Settings {
/// Creates new [`Settings`] using environment configuration.
///
/// Specifically:
///
/// - The `internal_backend` can be configured using the `WGPU_BACKEND`
/// environment variable. If the variable is not set, the primary backend
/// will be used. The following values are allowed:
/// - `vulkan`
/// - `metal`
/// - `dx12`
/// - `dx11`
/// - `gl`
/// - `webgpu`
pub fn from_env() -> Self {
Settings {
internal_backend: backend_from_env()
.unwrap_or(wgpu::BackendBit::PRIMARY),
..Self::default()
}
}
}

impl Default for Settings {
fn default() -> Settings {
Settings {
format: wgpu::TextureFormat::Bgra8UnormSrgb,
present_mode: wgpu::PresentMode::Mailbox,
internal_backend: wgpu::BackendBit::PRIMARY,
default_font: None,
default_text_size: 20,
antialiasing: None,
}
}
}

fn backend_from_env() -> Option<wgpu::BackendBit> {
std::env::var("WGPU_BACKEND").ok().map(|backend| {
match backend.to_lowercase().as_str() {
"vulkan" => wgpu::BackendBit::VULKAN,
"metal" => wgpu::BackendBit::METAL,
"dx12" => wgpu::BackendBit::DX12,
"dx11" => wgpu::BackendBit::DX11,
"gl" => wgpu::BackendBit::GL,
"webgpu" => wgpu::BackendBit::BROWSER_WEBGPU,
other => panic!("Unknown backend: {}", other),
}
})
}
2 changes: 1 addition & 1 deletion wgpu/src/window/compositor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ impl Compositor {
///
/// Returns `None` if no compatible graphics adapter could be found.
pub async fn request(settings: Settings) -> Option<Self> {
let instance = wgpu::Instance::new(wgpu::BackendBit::PRIMARY);
let instance = wgpu::Instance::new(settings.internal_backend);

let adapter = instance
.request_adapter(&wgpu::RequestAdapterOptions {
Expand Down