pub struct FrameBuffer<'a> { /* private fields */ }
Expand description

Frame Buffer Struct Used To Get Raw Pixel Data

Implementations§

source§

impl<'a> FrameBuffer<'a>

source

pub fn new( raw_buffer: &'a mut [u8], buffer: &'a mut Vec<u8>, width: u32, height: u32, row_pitch: u32, depth_pitch: u32, color_format: ColorFormat ) -> Self

Create A New Frame Buffer

source

pub const fn width(&self) -> u32

Get The Frame Buffer Width

source

pub const fn height(&self) -> u32

Get The Frame Buffer Height

source

pub const fn row_pitch(&self) -> u32

Get The Frame Buffer Row Pitch

source

pub const fn depth_pitch(&self) -> u32

Get The Frame Buffer Depth Pitch

source

pub const fn has_padding(&self) -> bool

Check If The Buffer Has Padding

source

pub fn as_raw_buffer(&'a mut self) -> &'a mut [u8] ⓘ

Get The Raw Pixel Data Might Have Padding

source

pub fn as_raw_nopadding_buffer( &'a mut self ) -> Result<&'a mut [u8], Box<dyn Error + Send + Sync>>

Get The Raw Pixel Data Without Padding

source

pub fn save_as_image<T: AsRef<Path>>( &self, path: T ) -> Result<(), Box<dyn Error + Send + Sync>>

Save The Frame Buffer As An Image To The Specified Path

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for FrameBuffer<'a>

§

impl<'a> Send for FrameBuffer<'a>

§

impl<'a> Sync for FrameBuffer<'a>

§

impl<'a> Unpin for FrameBuffer<'a>

§

impl<'a> !UnwindSafe for FrameBuffer<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.