Struct kas_wgpu::options::Options

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

Shell options

Fields

config_path: PathBuf

Config file path. Default: empty. See KAS_CONFIG doc.

theme_config_path: PathBuf

Theme config path. Default: empty.

config_mode: ConfigMode

Config mode. Default: Read.

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 from_env() -> Self

Construct a new instance, reading from environment variables

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

Config files

WARNING: file formats are not stable and may not be compatible across KAS versions (aside from patch versions)!

The KAS_CONFIG variable, if given, provides a path to the KAS config file, which is read or written according to KAS_CONFIG_MODE. If KAS_CONFIG is not specified, platform-default configuration is used without reading or writing. This may change to use a platform-specific default path in future versions.

The KAS_THEME_CONFIG variable, if given, provides a path to the theme config file, which is read or written according to KAS_CONFIG_MODE. If KAS_THEME_CONFIG is not specified, platform-default configuration is used without reading or writing. This may change to use a platform-specific default path in future versions.

The KAS_CONFIG_MODE variable determines the read/write mode:

• Read (default): read-only
• ReadWrite: read on start-up, write on exit
• WriteDefault: generate platform-default configuration and write it to the config path(s) specified, overwriting any existing config

Note: in the future, the default will likely change to a read-write mode, allowing changes to be written out.

Graphics options

The KAS_POWER_PREFERENCE variable supports:

• Default
• LowPower
• HighPerformance

The KAS_BACKENDS variable supports:

• Vulkan
• GL
• Metal
• DX11
• DX12
• PRIMARY: any of Vulkan, Metal or DX12
• SECONDARY: any of GL or DX11

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"

pub fn init_theme_config<DS: DrawSharedImpl, T: Theme<DS>>(
    &self,
    theme: &mut T
) -> Result<(), Error>

Load/save theme config on start

pub fn read_config(&self) -> Result<Config, Error>

Load/save KAS config on start

pub fn write_config<DS: DrawSharedImpl, T: Theme<DS>>(
    &self,
    config: &Config,
    theme: &T
) -> Result<(), Error>

Save all config (on exit or after changes)

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy 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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Options> for Options

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Options