Struct XSurfaceFrame 

pub struct XSurfaceFrame<'a> { /* private fields */ }

Available on Unix and crate feature x11 only.

🐚 ⬡ Borrowed mutable X11 surface for direct frame rendering.

---

^{📍 sys/device/display/x11::XSurfaceFrame}

^{📦 size_of::<XSurfaceFrame<'_>>() == 32 bytes / 256 bits #️⃣ #[cfg(target_pointer_width = “64”)] ⚗️Option<T> 🟰 T}

---

This exposes the retained X11 presentation surface for one frame.

Drawing into this surface avoids the intermediate scene-to-surface copy used by XRasterRenderer.

XSurfaceFrame is the X11 direct-surface path.

It exposes the retained X11 surface for one frame, allowing callers to render directly into the CPU/SHM presentation buffer.

Use it when X11-specific performance or surface control matters.

Implementations

impl<'a> XSurfaceFrame<'a>

pub const fn width(&self) -> u16

Returns the surface width in pixels.

pub const fn height(&self) -> u16

Returns the surface height in pixels.

pub const fn depth(&self) -> u8

Returns the surface pixel depth in bits.

pub const fn bits_per_pixel(&self) -> u8

Returns the number of stored bits per pixel.

pub const fn bytes_per_pixel(&self) -> Option<u8>

Returns the number of stored bytes per pixel, when byte-aligned.

pub const fn bytes_per_line(&self) -> u32

Returns the byte stride between consecutive rows.

pub const fn mode(&self) -> XImageMode

Returns the active surface backing mode.

pub const fn is_tight_rows(&self) -> bool

Returns whether each row has no backend padding.

pub const fn raster_layout(&self) -> Option<RasterLayout>

Returns this surface’s byte-addressable raster layout.

The layout describes its pixel extent, stored bytes per pixel, row stride, and upper-first row orientation. It does not describe the pixel color or channel encoding.

Returns None when the stored pixel width is not byte-aligned.

pub const fn supports_rgb8(&self) -> bool

Returns whether RGB8 colors can be encoded and written directly to this surface.

pub const fn encode_rgb8(&self, rgb: [u8; 3]) -> Option<u32>

Encodes an RGB8 color as this X11 surface’s native pixel value.

Returns None when this surface does not support direct RGB8 encoding.

pub fn write_rgb8(&mut self, coord: Position2<u32>, rgb: [u8; 3]) -> bool

Encodes and writes an RGB8 color at coord.

Returns whether the pixel was written.

pub const fn supports_native_pixel(&self) -> bool

Returns whether native pixel values can be written directly to this surface.

pub fn write_native_pixel(&mut self, coord: Position2<u32>, pixel: u32) -> bool

Writes an already encoded native X11 pixel at coord.

Returns whether the pixel was written.

pub fn bytes_mut(&mut self) -> &mut [u8]

Returns the mutable surface bytes for direct rendering.