Skip to main content

PlatformWindow

Struct PlatformWindow 

Source
pub struct PlatformWindow {
    pub id: u64,
    pub focused_accessibility_id: State<AccessibilityId>,
    pub focused_accessibility_node: State<Node>,
    pub root_size: State<Size2D>,
    pub scale_factor: State<f64>,
    pub custom_scale_factor: State<f64>,
    pub navigation_mode: State<NavigationMode>,
    pub preferred_theme: State<PreferredTheme>,
    pub is_app_focused: State<bool>,
    pub accent_color: State<AccentColor>,
    pub sender: Rc<dyn Fn(UserEvent)>,
}
Expand description

State and APIs for a given window.

§Example

use freya_core::prelude::*;

fn app() -> impl IntoElement {
    let window = Platform::get().current_window();
    let root_size = *window.root_size.read();
    let preferred_theme = *window.preferred_theme.read();

    format!(
        "Window: {:.0} × {:.0}, preferred theme: {preferred_theme:?}",
        root_size.width, root_size.height,
    )
}

Fields§

§id: u64§focused_accessibility_id: State<AccessibilityId>

The AccessibilityId of the currently focused node in this window.

§focused_accessibility_node: State<Node>

Accessibility data for this window’s currently focused node.

§root_size: State<Size2D>

This window’s size in logical pixels.

§scale_factor: State<f64>

This window’s effective rendering scale factor.

§custom_scale_factor: State<f64>

The custom scale factor, changed through Self::set_custom_scale_factor.

§navigation_mode: State<NavigationMode>

The current NavigationMode in this window.

§preferred_theme: State<PreferredTheme>

The color theme preferred by the operating system for this window.

§is_app_focused: State<bool>

Whether this window has operating-system focus.

§accent_color: State<AccentColor>

The operating system’s accent color, when available.

§sender: Rc<dyn Fn(UserEvent)>

Dispatches UserEvents to this window’s renderer.

Implementations§

Source§

impl PlatformWindow

Source

pub fn send(&self, event: UserEvent)

Source

pub fn request_redraw(&self)

Request a render of this window.

Source

pub fn set_custom_scale_factor(&self, custom_scale_factor: f64)

Request a custom rendering scale factor for this window.

Trait Implementations§

Source§

impl Clone for PlatformWindow

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more