Struct Options 

pub struct Options {
    pub power_preference: PowerPreference,
    pub backends: Backends,
    pub wgpu_trace_path: Option<PathBuf>,
}

Graphics backend options

Fields

power_preference: PowerPreference

Adapter power preference. Default value: low power.

backends: Backends

Adapter backend. Default value: PRIMARY (Vulkan/Metal/DX12).

wgpu_trace_path: Option<PathBuf>

WGPU’s API tracing path

Implementations

impl Options

pub fn load_from_env(&mut self)

Read values from environment variables

This replaces values in self where specified via env vars. Use e.g. Options::default().load_from_env().

The following environment variables are read, in case-insensitive mode.

Graphics options

The KAS_POWER_PREFERENCE variable supports:

• Default
• LowPower
• HighPerformance

The KAS_BACKENDS variable supports:

• Vulkan
• GL
• Metal
• DX11
• DX12
• BROWSER_WEBGPU: web target through webassembly
• PRIMARY: any of Vulkan, Metal or DX12
• SECONDARY: any of GL or DX11
• FALLBACK: force use of fallback (CPU) rendering

The default backend is PRIMARY. Note that secondary backends are less well supported by WGPU, possibly leading to other issues.

WGPU has an API tracing feature for debugging. To use this, ensure the wgpu/trace feature is enabled and set the output path:

export KAS_WGPU_TRACE_PATH="api_trace"

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Hash for Options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Options

impl StructuralPartialEq for Options