Struct WindowState 

#[repr(C)]
pub struct WindowState {

    pub title: AzString,
    pub theme: WindowTheme,
    pub size: WindowSize,
    pub position: WindowPosition,
    pub flags: WindowFlags,
    pub debug_state: DebugState,
    pub keyboard_state: KeyboardState,
    pub mouse_state: MouseState,
    pub touch_state: TouchState,
    pub ime_position: ImePosition,
    pub monitor: Monitor,
    pub platform_specific_options: PlatformSpecificOptions,
    pub renderer_options: RendererOptions,
    pub background_color: ColorU,
    pub layout_callback: LayoutCallback,
    pub close_callback: OptionCallback,
}

Fields

title: AzString

theme: WindowTheme

Theme of this window (dark or light) - can be set / overridden by the user

Usually the operating system will set this field. On change, it will emit a WindowEventFilter::ThemeChanged event

size: WindowSize

Size of the window + max width / max height: 800 x 600 by default

position: WindowPosition

The x and y position, or None to let the WM decide where to put the window (default)

flags: WindowFlags

Flags such as whether the window is minimized / maximized, fullscreen, etc.

debug_state: DebugState

Mostly used for debugging, shows WebRender-builtin graphs on the screen. Used for performance monitoring and displaying frame times (rendering-only).

keyboard_state: KeyboardState

Current keyboard state - NOTE: mutating this field (currently) does nothing (doesn’t get synchronized with OS-level window)!

mouse_state: MouseState

Current mouse state

touch_state: TouchState

Stores all states of currently connected touch input devices, pencils, tablets, etc.

ime_position: ImePosition

Sets location of IME candidate box in client area coordinates relative to the top left of the window.

monitor: Monitor

Which monitor the window is currently residing on

platform_specific_options: PlatformSpecificOptions

Window options that can only be set on a certain platform (WindowsWindowOptions / LinuxWindowOptions / MacWindowOptions).

renderer_options: RendererOptions

Whether this window has SRGB / vsync / hardware acceleration

background_color: ColorU

Color of the window background (can be transparent if necessary)

layout_callback: LayoutCallback

The layout() function for this window, stored as a callback function pointer, There are multiple reasons for doing this (instead of requiring T: Layout everywhere):

• It seperates the Dom from the Layout trait, making it possible to split the UI solving and styling into reusable crates
• It’s less typing work (prevents having to type <T: Layout> everywhere)
• It’s potentially more efficient to compile (less type-checking required)
• It’s a preparation for the C ABI, in which traits don’t exist (for language bindings). In the C ABI “traits” are simply structs with function pointers (and void* instead of T)

close_callback: OptionCallback

Optional callback to run when the window closes

Implementations

impl WindowState

pub fn new(callback: LayoutCallbackType) -> Self

Creates a new, default WindowState with the given CSS style

pub fn get_mouse_state(&self) -> &MouseState

Returns the current keyboard keyboard state. We don’t want the library user to be able to modify this state, only to read it.

pub fn get_keyboard_state(&self) -> &KeyboardState

Returns the current windows mouse state. We don’t want the library user to be able to modify this state, only to read it.

pub fn get_physical_size(&self) -> (usize, usize)

Returns the physical (width, height) in pixel of this window

pub fn get_hidpi_factor(&self) -> f32

Returns the current HiDPI factor for this window.

Trait Implementations

impl Clone for WindowState

fn clone(&self) -> WindowState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowState

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WindowState

fn default() -> Self

Returns the “default value” for a type.

impl From<FullWindowState> for WindowState

fn from(full_window_state: FullWindowState) -> WindowState

Converts to this type from the input type.

impl PartialEq for WindowState

fn eq(&self, other: &WindowState) -> 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 StructuralPartialEq for WindowState