Struct XDisplay 

pub struct XDisplay { /* private fields */ }

🐚 ⬡ 🔒 A connection to an X11 display server.

---

^{📍 sys/device/display/x11}

^{📦 size_of::<XDisplay>() == 240 bytes / 1920 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T>}

---

Wraps an xcb_connection_t and its associated screen information. Represents the root environment required to create windows and interact with the X server.

Implementations

impl XDisplay

pub fn open() -> Result<Self, XError>

Opens the default X11 display and retrieves its first screen.

pub fn depth(&self) -> u8

Returns the root depth of the default screen.

pub const fn bits_per_pixel(&self) -> u8

pub const fn scanline_pad_bits(&self) -> u8

pub const fn bytes_per_line(&self, width: u16) -> u32

pub const fn has_shm(&self) -> bool

Returns whether MIT-SHM is available on this display.

pub fn poll_event(&mut self) -> Event

Polls the next event without blocking.

If a raw event is available, it is processed through handle_raw_event and returned as a high-level Event. If no event is pending, returns Event::None.

This is suitable for rendering loops or cooperative schedulers where the program must remain responsive without waiting.

pub fn wait_event(&mut self) -> Event

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

The raw event is passed to handle_raw_event and returned as a high-level Event. If the X connection enters an error state, returns Event::None.

This is the blocking counterpart of poll_event, used when the application should sleep until user input or a window notification arrives.

pub fn flush(&self)

Flushes pending XCB commands.

Trait Implementations

impl Debug for XDisplay

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

Formats the value using the given formatter.

impl Drop for XDisplay

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.