Struct multiboot2::FramebufferTag

#[repr(C)]
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<'_> ) -> BoxedDst<Self>

pub 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 fn pitch(&self) -> u32

Contains the pitch in bytes.

pub fn width(&self) -> u32

Contains framebuffer width in pixels.

pub fn height(&self) -> u32

Contains framebuffer height in pixels.

pub 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 PartialEq<FramebufferTag> for FramebufferTag

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Pointee for FramebufferTagwhere [u8]: Pointee,

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

The type for metadata in pointers and references to Self.

impl TagTrait for FramebufferTag

const ID: TagType = TagType::Framebuffer

The numeric ID of this tag.

fn dst_size(base_tag: &Tag) -> 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 as_base_tag(&self) -> &Tag

Returns the tag as the common base tag structure.

fn size(&self) -> usize

Returns the total size of the tag. The depends on the size field of the tag.

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

Returns a slice to the underlying bytes of the tag. This includes all bytes, also for tags that are DSTs. The slice length depends on the size field of the tag.

unsafe fn from_base_tag<'a>(tag: &Tag) -> &'a Self

Creates a reference to a (dynamically sized) tag type in a safe way. DST tags need to implement a proper Self::dst_size implementation.

impl Eq for FramebufferTag

impl StructuralEq for FramebufferTag