proka-bootloader 0.1.7

//! The output module, which provides framebuffer info and
//! its utilities.

/// The framebuffer structure, which provides basic 5
/// elements.
///
/// - Framebuffer base address;
/// - Framebuffer height;
/// - Framebuffer width;
/// - Framebuffer BPB
/// - Framebuffer pitch
///
/// You can use it to do output/graphics operations.
///
/// If you want to compute the offset, you can use this:
///
/// `offset = x * bpp + y * pitch`
#[repr(C, packed)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "default", derive(Default))]
pub struct Framebuffer {
    fb_addr: *mut u8,
    width: u64,
    height: u64,
    bpp: u64,
    pitch: u64,
}

impl Framebuffer {
    /// Creates a nee framebuffer object.
    ///
    /// Note: This method will automatically create by
    /// bootloader entry, if you are using kernel, this
    /// method is not needed and not usable.
    #[cfg(feature = "loader_main")]
    pub fn new(addr: *mut u8, width: u64, height: u64, bpp: u64, pitch: u64) -> Self {
        Self {
            fb_addr: addr,
            width,
            height,
            bpp,
            pitch,
        }
    }

    /// Get the framebuffer address.
    pub fn address(&self) -> *mut u8 {
        self.fb_addr
    }

    /// Get the framebuffer width.
    pub fn width(&self) -> u64 {
        self.width
    }

    /// Get the framebuffer height.
    pub fn height(&self) -> u64 {
        self.height
    }

    /// Get the framebuffer BPP.
    pub fn bpp(&self) -> u64 {
        self.bpp
    }

    /// Get the framebuffer pitch.
    pub fn pitch(&self) -> u64 {
        self.pitch
    }
}