Struct FramebufferTag

#[repr(C, align(8))]
pub struct FramebufferTag { /* private fields */ }

The VBE Framebuffer information tag.

Implementations

impl FramebufferTag

pub fn new( address: u64, pitch: u32, width: u32, height: u32, bpp: u8, buffer_type: FramebufferType<'_>, ) -> Box<Self>

Constructs a new tag.

pub const fn address(&self) -> u64

Contains framebuffer physical address.

This field is 64-bit wide but bootloader should set it under 4GiB if possible for compatibility with payloads which aren’t aware of PAE or amd64.

pub const fn pitch(&self) -> u32

Contains the pitch in bytes.

pub const fn width(&self) -> u32

Contains framebuffer width in pixels.

pub const fn height(&self) -> u32

Contains framebuffer height in pixels.

pub const fn bpp(&self) -> u8

Contains number of bits per pixel.

pub fn buffer_type(&self) -> Result<FramebufferType<'_>, UnknownFramebufferType>

The type of framebuffer, one of: Indexed, RGB or Text.

Trait Implementations

impl Debug for FramebufferTag

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

Formats the value using the given formatter.

impl MaybeDynSized for FramebufferTag

const BASE_SIZE: usize = 32usize

The true base size of the struct without any implicit or additional padding. Note that size_of::<T>() isn’t sufficient, as for example the type could have three u32 fields, which would add an implicit u32 padding. However, this constant must always fulfill BASE_SIZE >= size_of::<Self::Header>().

type Header = TagHeader

The associated Header of this tag.

fn dst_len(header: &TagHeader) -> usize

Returns the amount of items in the dynamically sized portion of the DST. Note that this is not the amount of bytes. So if the dynamically sized portion is 16 bytes in size and each element is 4 bytes big, then this function must return 4.

fn header(&self) -> &Self::Header

Returns the corresponding Header.

fn payload(&self) -> &[u8]

Returns the payload, i.e., all memory that is not occupied by the Header of the type.

fn as_bytes(&self) -> BytesRef<'_, Self::Header>

Returns the whole allocated bytes for this structure encapsulated in BytesRef. This includes padding bytes. To only get the “true” tag data, read the tag size from Self::header and create a sub slice.

fn as_ptr(&self) -> *const Self::Header

Returns a pointer to this structure.

impl PartialEq for FramebufferTag

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Pointee for FramebufferTag

where [u8]: Pointee,

type Metadata = <[u8] as Pointee>::Metadata

The metadata type for pointers and references to this type.

impl Tag for FramebufferTag

const ID: TagType = TagType::Framebuffer

The ID of this tag. This should be unique across all implementors.

type IDType = TagType

The ID type that identifies the tag.

impl Eq for FramebufferTag