Struct iced_native::program::State

source ·
pub struct State<P>where
    P: Program + 'static,{ /* private fields */ }
Expand description

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

Implementations§

source§

impl<P> State<P>where P: Program + 'static, <P::Renderer as Renderer>::Theme: StyleSheet,

source

pub fn new( program: P, bounds: Size, 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.

source

pub fn program(&self) -> &P

Returns a reference to the Program of the State.

source

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

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

source

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

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

source

pub fn is_queue_empty(&self) -> bool

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

source

pub fn mouse_interaction(&self) -> Interaction

Returns the current mouse::Interaction of the State.

source

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

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

Returns a list containing the instances of Event that were not captured by any widget, and the Command obtained from Program after updating it, only if an update was necessary.

Auto Trait Implementations§

§

impl<P> !RefUnwindSafe for State<P>

§

impl<P> !Send for State<P>

§

impl<P> !Sync for State<P>

§

impl<P> Unpin for State<P>where P: Unpin, <P as Program>::Message: Unpin,

§

impl<P> !UnwindSafe for State<P>

Blanket Implementations§

source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere T: FloatComponent, Swp: WhitePoint, Dwp: WhitePoint, D: AdaptFrom<S, Swp, Dwp, T>,

source§

fn adapt_into_using<M>(self, method: M) -> Dwhere M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method
source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default
source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere 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, U> IntoColor<U> for Twhere U: FromColor<T>,

source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
source§

impl<T, U> IntoColorUnclamped<U> for Twhere U: FromColorUnclamped<T>,

source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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, U> TryIntoColor<U> for Twhere U: TryFromColor<T>,

source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more