#[non_exhaustive]pub struct AccessibilityPreferences {
pub text_scaling_factor: f32,
pub reduce_motion: bool,
pub high_contrast: bool,
pub reduce_transparency: bool,
}Expand description
OS-detected accessibility preferences.
A single copy lives on SystemTheme, shared across light and dark
variants. These are runtime values detected from the OS – not stored
in TOML presets. Outside this crate, start from
AccessibilityPreferences::DEFAULT (or default()) and set fields.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.text_scaling_factor: f32Text scaling factor (1.0 = no scaling): the factor of the user’s
preference for larger text that the toolkit has not applied. Multiply
font sizes by it (scaled) to honour the preference.
Where the toolkit’s own scale factor carries the preference, it is
1.0: on a GNOME or Budgie X11 session, where winit and gpui take their
scale factor from the Xft.dpi gnome-settings-daemon writes as
96 × text-scaling-factor × the window scale (gnome-settings-daemon
51.0 plugins/xsettings/gsd-xsettings-manager.c:666-668, :742,
:797-798; winit 0.30.13 src/platform_impl/linux/x11/util/randr.rs:41-53,
:145-146; gpui-pre-linux 0.3.12 src/linux/x11/client.rs:2674-2681).
They do so only while WINIT_X11_SCALE_FACTOR and
GPUI_X11_SCALE_FACTOR are unset (randr.rs:112-154,
client.rs:2623-2669); with an override the application owns the
scale, and the factor is applied nowhere.
reduce_motion: boolWhether the user has requested reduced motion.
high_contrast: boolWhether a high-contrast mode is active.
reduce_transparency: boolWhether the user has requested reduced transparency.
Implementations§
Source§impl AccessibilityPreferences
impl AccessibilityPreferences
Sourcepub const DEFAULT: Self
pub const DEFAULT: Self
No text scaling and no flag set: what Default::default returns,
usable in a const or static.
Sourcepub fn from_system() -> Self
pub fn from_system() -> Self
Read the OS accessibility preferences without resolving a theme.
Runs the same platform reader SystemTheme::from_system runs (KDE
kdeglobals, GNOME portal + gsettings, macOS NSWorkspace, Windows
UISettings) and takes its accessibility block, blocking on it with
pollster::block_on. Fields no reader supplies keep their defaults.
Never fails: with no reader or a failing reader the defaults are
returned, with reduce_motion the platform’s read
(crate::detect::detect_reduced_motion, the one the readers make).
Use it on the preset path, where accessibility is orthogonal to the theme choice (a user with large text wants it under a preset too).
Sourcepub fn text_scale_factor(&self) -> f32
pub fn text_scale_factor(&self) -> f32
The text-scaling multiplier the toolkit has not applied:
text_scaling_factor when it is finite
and positive, else 1.0, so a factor no platform could mean (NaN,
zero, negative, infinite) leaves text at its size.
Sourcepub fn scaled(&self, size: f32) -> f32
pub fn scaled(&self, size: f32) -> f32
A text size times text_scale_factor.
For every text size alike: a widget’s font, a text_scale role’s
size, the default fonts. No other length is scaled. Where the product
is not a normal positive number (a finite factor large enough to
overflow f32, or one small enough to make it subnormal or zero),
size is returned unscaled, as for a factor that is not finite and
positive.