freya_core/
platform.rs

1use std::rc::Rc;
2
3pub use mundy::{
4    AccentColor,
5    Srgba,
6};
7use torin::prelude::Size2D;
8
9use crate::{
10    accessibility::id::AccessibilityId,
11    prelude::{
12        State,
13        consume_root_context,
14    },
15    user_event::UserEvent,
16};
17
18#[derive(Clone, Copy, PartialEq, Eq, Default, Debug, Hash)]
19pub enum NavigationMode {
20    #[default]
21    NotKeyboard,
22    Keyboard,
23}
24
25#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
26pub enum PreferredTheme {
27    #[default]
28    Light,
29    Dark,
30}
31
32/// Access point to different Freya-managed states such as the focused node,
33/// root window size, navigation mode, and theme preference.
34///
35/// Retrieve it from any component with [`Platform::get`].
36#[derive(Clone)]
37pub struct Platform {
38    /// The [`AccessibilityId`] of the currently focused node.
39    pub focused_accessibility_id: State<AccessibilityId>,
40    /// The accessibility node data of the currently focused node.
41    pub focused_accessibility_node: State<accesskit::Node>,
42    /// The size of the root window.
43    pub root_size: State<Size2D>,
44    /// Rendering scale factor, the OS scale factor multiplied by the custom scale factor.
45    pub scale_factor: State<f64>,
46    /// Custom scale factor, change it with [`Platform::set_custom_scale_factor`].
47    pub custom_scale_factor: State<f64>,
48    /// The current [`NavigationMode`].
49    pub navigation_mode: State<NavigationMode>,
50    /// The OS-level [`PreferredTheme`].
51    pub preferred_theme: State<PreferredTheme>,
52    /// Whether the app currently has the OS-level focus.
53    pub is_app_focused: State<bool>,
54    /// The OS-level [`AccentColor`].
55    pub accent_color: State<AccentColor>,
56    /// Sender used to dispatch [`UserEvent`]s to the active renderer.
57    pub sender: Rc<dyn Fn(UserEvent)>,
58}
59
60impl Platform {
61    /// Retrieve the [`Platform`] from the root context.
62    pub fn get() -> Self {
63        consume_root_context()
64    }
65
66    /// Dispatch a [`UserEvent`] to the active renderer.
67    pub fn send(&self, event: UserEvent) {
68        (self.sender)(event)
69    }
70
71    /// Request the renderer to use a custom scale factor, multiplied with the
72    /// OS scale factor. The value might get clamped to a reasonable range.
73    pub fn set_custom_scale_factor(&self, custom_scale_factor: f64) {
74        self.send(UserEvent::SetCustomScaleFactor(custom_scale_factor));
75    }
76}
freya_core/platform.rs

freya_core/
platform.rs
