Struct HeadlessWindow 

pub struct HeadlessWindow { /* private fields */ }

The one canonical offscreen window marker. It implements platform_core::Window, so a single type satisfies both the renderer bound (which needs only the raw-window-handle traits) and the platform bound (Window). Its handles are always HandleError::Unavailable — there is no surface — so a renderer built against it must use its new_headless constructor, and AppHandler detects the unavailable handle to build an offscreen renderer. request_redraw is a no-op: crate::HeadlessPlatform drives frames explicitly rather than through a windowing system’s redraw queue.

This replaces the ad-hoc HeadlessWindow that lived in renderer-hardware and the per-test struct Fake; markers that renderer tests each defined for themselves.

Implementations

impl HeadlessWindow

pub fn new(width: u32, height: u32) -> Self

A logical width×height offscreen surface at scale 1.0 reporting no OS light/dark preference.

pub fn with_options( width: u32, height: u32, scale_factor: f64, prefers_dark: Option<bool>, ) -> Self

Full control over the reported Window::scale_factor and Window::prefers_dark.

Trait Implementations

impl Clone for HeadlessWindow

fn clone(&self) -> HeadlessWindow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl HasDisplayHandle for HeadlessWindow

fn display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>

Get a handle to the display controller of the windowing system.

impl HasWindowHandle for HeadlessWindow

fn window_handle(&self) -> Result<WindowHandle<'_>, HandleError>

Get a handle to the window.

impl Window for HeadlessWindow

fn width(&self) -> u32

fn height(&self) -> u32

fn request_redraw(&self)

fn scale_factor(&self) -> f64

fn prefers_dark(&self) -> Option<bool>

The OS light/dark preference, if the platform can report it: Some(true) = prefer dark. None when undetectable (e.g. X11, or a compositor without the settings portal). Defaults to None.

fn is_offscreen(&self) -> bool

Whether this window renders to an offscreen target with no on-screen surface (its raw handles are unavailable). A handler must build a windowless renderer for it — a windowed renderer would fail to create a surface. Defaults to false (an on-screen window).

fn drag_window(&self)

Begins an OS-driven interactive move (drag the window by a custom title bar). Must be called while the pointer button that started the drag is still pressed. No-op on backends without a movable top-level window (layer-shell surfaces, headless).

fn set_minimized(&self, _minimized: bool)

Minimizes (true) or restores (false) the window. No-op where unsupported.

fn set_maximized(&self, _maximized: bool)

Maximizes (true) or restores (false) the window. No-op where unsupported.

fn is_maximized(&self) -> bool

Whether the window is currently maximized. Defaults to false where unsupported.

fn set_title(&self, _title: &str)

Updates the OS window title. No-op where unsupported.

fn focus_window(&self)

Brings the window to the front and requests input focus. No-op where unsupported or where the window manager forbids programmatic activation (e.g. some Wayland compositors).

fn set_cursor(&self, _cursor: Cursor)

Sets the pointer shape over this window. No-op where unsupported (headless).