Struct iced_native::program::State

pub struct State<P> where
    P: Program + 'static,  { /* fields omitted */ }

The execution state of a Program. It leverages caching, event processing, and rendering primitive storage.

Methods

impl<P> State<P> where
    P: Program + 'static, 

pub fn new(
    program: P,
    bounds: Size,
    cursor_position: Point,
    renderer: &mut P::Renderer,
    debug: &mut Debug
) -> Self

Creates a new State with the provided Program, initializing its primitive with the given logical bounds and renderer.

pub fn program(&self) -> &P

Returns a reference to the Program of the State.

pub fn primitive(&self) -> &<P::Renderer as Renderer>::Output

Returns a reference to the current rendering primitive of the State.

pub fn queue_event(&mut self, event: Event)

Queues an event in the State for processing during an update.

pub fn queue_message(&mut self, message: P::Message)

Queues a message in the State for processing during an update.

pub fn is_queue_empty(&self) -> bool

Returns whether the event queue of the State is empty or not.

pub fn next_animation(&self) -> AnimationState

Returns the soonest moment the event loop needs to animate.

pub fn update(
    &mut self,
    bounds: Size,
    cursor_position: Point,
    clipboard: Option<&dyn Clipboard>,
    renderer: &mut P::Renderer,
    debug: &mut Debug
) -> Option<Command<P::Message>>

Processes all the queued events and messages, rebuilding and redrawing the widgets of the linked Program if necessary.

Returns the [Command] obtained from Program after updating it, only if an update was necessary.