Struct XFrontend 

pub struct XFrontend { /* private fields */ }

Available on crate features unsafe_ffi and x11 only.

🐚 ⬡ An X11 frontend for frame-driven runtimes.

---

^{📍 sys/device/display/x11}

---

Owns the current X11 runtime backend and its presentation finalizer, while leaving runtime control, app logic, and rendering policy external.

The current implementation manages one window. That is an implementation detail, not the intended long-term boundary.

Implementations

impl XFrontend

pub fn open(x: i16, y: i16, width: u16, height: u16) -> Result<Self, XError>

Opens an X11 frontend.

pub fn open_with( mode: XImageMode, x: i16, y: i16, width: u16, height: u16, ) -> Result<Self, XError>

Opens an X11 frontend with the given image mode.

pub const fn display(&self) -> &XDisplay

Returns a shared reference to the X11 Display server.

pub const fn display_mut(&mut self) -> &mut XDisplay

Returns an exclusive reference to the X11 Display server.

pub const fn has_shm(&self) -> bool

Returns whether MIT-SHM is available on this display.

pub const fn mode(&self) -> XImageMode

Returns the configured X11 image presentation mode.

This is the mode requested when opening the frontend. It may still be XImageMode::Auto before any presentation occurs.

pub fn active_mode(&self) -> Option<XImageMode>

Returns the currently resolved X11 image presentation mode, if any.

This resolves the active backing chosen after presentation begins.

It returns None while no presentation surface has been created yet.

pub fn poll_event(&mut self) -> Event

Polls the next event without blocking.

See XDisplay::poll_event for more information.

pub fn wait_event(&mut self) -> Event

Waits for the next event, blocking until one is available.

See XDisplay::wait_event for more information.

impl XFrontend

pub fn step_frame<T, A, R, S, RE>( &mut self, driver: &mut RunDriver<T>, app: &mut A, renderer: &mut R, scene: &S, events: &mut [A::Event], ) -> Result<RunControl, RunDriverFrameError<XError, A::Error, RE, XError>>

where A: RunApp<Event = Event>, for<'a> R: RunRender<S, Event, XFrameCtx<'a>, Error = RE, Output<'a> = XPresent<'a>>,

Drives one X11 runtime iteration including rendering and presentation.

pub fn run_frame<T, A, R, S, RE>( &mut self, driver: &mut RunDriver<T>, app: &mut A, renderer: &mut R, scene: &S, events: &mut [A::Event], ) -> Result<(), RunDriverFrameError<XError, A::Error, RE, XError>>

where A: RunApp<Event = Event>, for<'a> R: RunRender<S, Event, XFrameCtx<'a>, Error = RE, Output<'a> = XPresent<'a>>,

Runs until the app stops or an error occurs, including rendering and presentation.

impl XFrontend

pub fn with_surface_frame<F, T>( &mut self, width: u16, height: u16, depth: u8, clear_redraw: bool, render: F, ) -> Result<T, XError>

where F: FnOnce(&mut XSurfaceFrame<'_>) -> Result<T, XError>,

Renders directly into the retained X11 surface and presents it.

This bypasses XRasterRenderer and avoids the scene-to-surface copy.

pub fn step_frame_surface<R, A, F, RE>( &mut self, driver: &mut RunDriver<R>, app: &mut A, width: u16, height: u16, depth: u8, clear_redraw: bool, events: &mut [Event], render: F, ) -> Result<RunControl, RunDriverFrameError<XError, A::Error, RE, XError>>

where A: RunApp<Event = Event>, F: FnOnce(&mut XSurfaceFrame<'_>) -> Result<(), RE>,

Advances one runtime frame and renders directly into the retained X11 surface.

This is the X11-specific zero-copy rendering path. It bypasses XRasterRenderer and exposes the retained surface bytes for the duration of one frame.

This avoids the intermediate artifact-to-surface copy, but it also gives up backend independence.

Trait Implementations

impl Debug for XFrontend

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

Formats the value using the given formatter.