Skip to main content

WindowBackend

Struct WindowBackend 

Source
pub struct WindowBackend<P: Presenter> { /* private fields */ }
Expand description

A Backend built from a Presenter plus an input event queue.

Backend fuses input and output, which does not fit a window: some event loop owns input, while a per-renderer surface owns output. WindowBackend reunites the two so Terminal gets the full Backend it needs, while renderer crates implement only Presenter:

event loop.push_event(e) ──> VecDeque<Event> ──> app.poll_event()
                                                       │
                                                       v
                                            Terminal<WindowBackend<P>>
                                                       │
                             draw / flush / resize     v
                             ◄────────────────────  WindowBackend
                                                       │
                                                       v
                                                P: Presenter (output)

With the winit feature enabled, winit::run_windowed and winit::run_app own the event loop, call push_event as winit events are translated, and call Presenter::present once per frame; callers never touch WindowBackend directly. With winit disabled, retroglyph-window exports no event loop at all: a caller driving its own loop (SDL2, tao, a custom driver) constructs WindowBackend::new(presenter) itself, calls push_event for each translated input event, and calls Terminal::present (which drives Presenter::flush) plus presenter_mut().present() once per frame.

poll_event never blocks: frame timing is owned by the event loop, not by input waits.

Implementations§

Source§

impl<P: Presenter> WindowBackend<P>

Source

pub const fn new(presenter: P) -> Self

Wrap a presenter, creating an empty event queue.

Source

pub const fn presenter(&self) -> &P

The wrapped presenter.

Source

pub const fn presenter_mut(&mut self) -> &mut P

The wrapped presenter, mutably.

Source

pub fn into_presenter(self) -> P

Unwrap into the presenter, discarding queued events.

Trait Implementations§

Source§

impl<P: Presenter> Backend for WindowBackend<P>

Source§

type Error = <P as Presenter>::Error

Error type returned by fallible operations.
Source§

fn draw<'a, I>(&mut self, content: I) -> Result<(), Self::Error>
where I: Iterator<Item = (Pos, &'a Tile)>,

Draw changed cells to the output surface. Read more
Source§

fn draw_layers<'a, I>(&mut self, content: I) -> Result<(), Self::Error>
where I: Iterator<Item = (u8, Pos, &'a Tile)>,

Draw changed cells across all layers. Read more
Source§

fn flush(&mut self) -> Result<(), Self::Error>

Flush buffered output to the display. Read more
Source§

fn size(&self) -> Size

Return current display dimensions.
Source§

fn clear(&mut self) -> Result<(), Self::Error>

Clear the entire display. Read more
Source§

fn resize(&mut self, size: Size)

Notify the backend of a terminal resize. Read more
Source§

fn needs_full_frame(&self) -> bool

Returns true if the backend needs the entire frame (all cells on all layers) on every call to draw_layers, rather than just the changed cells. Read more
Source§

fn composites_layers(&self) -> bool

Whether this backend composites layers itself (per pixel or quad), receiving the raw layered stream from draw_layers. Read more
Source§

fn poll_event(&mut self, _timeout: Duration) -> Option<Event>

Poll for an input event, waiting up to timeout.
Source§

fn push_event(&mut self, event: Event)

Push an event into the backend’s event buffer. Read more
Source§

fn set_cursor_visible(&mut self, _visible: bool)

Show or hide the cursor.
Source§

fn set_cursor_position(&mut self, _position: Pos)

Move the cursor to a position.

Auto Trait Implementations§

§

impl<P> Freeze for WindowBackend<P>
where P: Freeze,

§

impl<P> RefUnwindSafe for WindowBackend<P>
where P: RefUnwindSafe,

§

impl<P> Send for WindowBackend<P>
where P: Send,

§

impl<P> Sync for WindowBackend<P>
where P: Sync,

§

impl<P> Unpin for WindowBackend<P>
where P: Unpin,

§

impl<P> UnsafeUnpin for WindowBackend<P>
where P: UnsafeUnpin,

§

impl<P> UnwindSafe for WindowBackend<P>
where P: UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

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

Source§

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 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