Struct framebuffer::Framebuffer

pub struct Framebuffer {
    pub device: File,
    pub frame: MmapMut,
    pub var_screen_info: VarScreeninfo,
    pub fix_screen_info: FixScreeninfo,
}

Struct that should be used to work with the framebuffer. Direct usage of frame should not be necessary.

Fields

device: File

frame: MmapMut

var_screen_info: VarScreeninfo

fix_screen_info: FixScreeninfo

Implementations

impl Framebuffer

pub fn new<P: AsRef<Path>>(
    path_to_device: P
) -> Result<Framebuffer, FramebufferError>

pub fn write_frame(&mut self, frame: &[u8])

Writes a frame to the Framebuffer.

pub fn read_frame(&self) -> &[u8]

Reads a frame from the framebuffer.

pub fn get_fix_screeninfo(
    device: &File
) -> Result<FixScreeninfo, FramebufferError>

Creates a FixScreeninfo struct and fills it using ioctl.

pub fn get_var_screeninfo(
    device: &File
) -> Result<VarScreeninfo, FramebufferError>

Creates a VarScreeninfo struct and fills it using ioctl.

pub fn put_var_screeninfo(
    device: &File,
    screeninfo: &VarScreeninfo
) -> Result<i32, FramebufferError>

pub fn pan_display(
    device: &File,
    screeninfo: &VarScreeninfo
) -> Result<i32, FramebufferError>

pub fn set_kd_mode(kd_mode: KdMode) -> Result<i32, FramebufferError>

Sets the tty graphics mode. Make sure to change it back to KdMode::Text after the program is done!

pub fn set_kd_mode_ex<P: AsRef<Path>>(
    path_to_device: P,
    kd_mode: KdMode
) -> Result<i32, FramebufferError>

Allows setting tty mode from non-terminal session by explicitly specifying device name

Trait Implementations

impl Debug for Framebuffer

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

Formats the value using the given formatter.