Struct Windowed 

pub struct Windowed<B> { /* private fields */ }

Available on crate feature winit only.

Pairs a windowed backend’s PresenterBuilder with the window title Launch needs to open one.

PresenterBuilder (retroglyph#1192) describes renderer configuration only (grid, scale, font, tileset): a window title isn’t part of that surface, and adding one would mean retroglyph-software’s headless pixel-test path (which never opens a window) carries a field it has no use for. This wrapper is the seam that adds it back for the one call site that does need it, Launch::launch, without touching PresenterBuilder itself.

Generic over B: PresenterBuilder rather than duplicated per backend crate: Launch is implemented here, once, for any Windowed<B>, so retroglyph-software, retroglyph-gl, and retroglyph-wgpu need no impl (and no dependency on this crate’s winit feature beyond what they already carry) of their own to be launchable this way.

Examples

use retroglyph_core::app::{App, Flow, Frame, Launch, RunOptions};
use retroglyph_core::backend::Backend;
use retroglyph_core::terminal::Terminal;
use retroglyph_window::PresenterBuilder;
use retroglyph_window::winit::Windowed;

struct MyGame;
impl<B: Backend> App<B> for MyGame {
    fn update(&mut self, _term: &mut Terminal<B>, _frame: &Frame) -> Flow {
        Flow::Exit
    }
}

// Opens a real window, so this example is `no_run`.
Windowed::new(builder, "demo").launch(MyGame, RunOptions::animated(60))?;

Implementations

impl<B: PresenterBuilder> Windowed<B>

pub fn new(builder: B, title: impl Into<String>) -> Self

Pairs builder with title, the window’s title bar text.

Trait Implementations

impl<B: Clone> Clone for Windowed<B>

fn clone(&self) -> Windowed<B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B: Debug> Debug for Windowed<B>

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

Formats the value using the given formatter.

impl<B> Launch for Windowed<B>

where B: PresenterBuilder,

fn launch<A>(self, app: A, options: RunOptions) -> Result<(), Self::Error>

where A: App<Self::Backend> + 'static,

Builds self’s presenter, opens a window sized to fit it (paced by options), and drives app on it until it returns Flow::Exit.

RunOptions::idle_wake has no windowed meaning and is ignored; see WindowConfig::with_run_options for why.

Errors

Returns WindowedLaunchError::Build if the presenter builder’s configuration is invalid, or WindowedLaunchError::EventLoop if the event loop cannot be created or fails while running.

type Backend = WindowBackend<<B as PresenterBuilder>::Presenter>

The backend this impl launches App on.

type Error = WindowedLaunchError<<B as PresenterBuilder>::Error>

The error this impl’s launch can fail with; each backend surfaces its own, unwrapped (see this trait’s docs for why there is no unified error here).