Struct State

pub struct State<P: Program>
where
    P::Theme: Base,
{ /* private fields */ }

Available on crate feature program only.

The state of a multi-windowed Program.

Implementations

impl<P: Program> State<P>

where P::Theme: Base,

pub fn new(application: &P, window_id: Id, window: &Window) -> Self

Creates a new State for the provided Program’s window.

pub fn viewport(&self) -> &Viewport

Returns the current [Viewport] of the State.

pub fn viewport_version(&self) -> u64

Returns the version of the [Viewport] of the State.

The version is incremented every time the [Viewport] changes.

pub fn physical_size(&self) -> Size<u32>

Returns the physical [Size] of the [Viewport] of the State.

pub fn logical_size(&self) -> Size<f32>

Returns the logical [Size] of the [Viewport] of the State.

pub fn scale_factor(&self) -> f64

Returns the current scale factor of the [Viewport] of the State.

pub fn cursor(&self) -> Cursor

Returns the current cursor position of the State.

pub fn modifiers(&self) -> ModifiersState

Returns the current keyboard modifiers of the State.

pub fn theme(&self) -> &P::Theme

Returns the current theme of the State.

pub fn background_color(&self) -> Color

Returns the current background [Color] of the State.

pub fn text_color(&self) -> Color

Returns the current text [Color] of the State.

pub fn update( &mut self, window: &Window, event: &WindowEvent, _debug: &mut Debug, )

Processes the provided window event and updates the State accordingly.

pub fn synchronize(&mut self, application: &P, window_id: Id, window: &Window)

Synchronizes the State with its Program and its respective window.

Normally, a Program should be synchronized with its State and window after calling State::update.

Trait Implementations

impl<P: Program> Debug for State<P>

where P::Theme: Base,

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

Formats the value using the given formatter.