Struct FrameBuffer

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

Represents a frame buffer containing pixel data.

Example

// Get frame from the capture session
let mut buffer = frame.buffer()?;
buffer.save_as_image("screenshot.png", ImageFormat::Png)?;

Implementations

impl<'a> FrameBuffer<'a>

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.

Arguments

• raw_buffer - A mutable reference to the raw pixel data buffer.
• buffer - A mutable reference to the buffer used for copying pixel data without padding.
• width - The width of the frame buffer.
• height - The height of the frame buffer.
• row_pitch - The row pitch of the frame buffer.
• depth_pitch - The depth pitch of the frame buffer.
• color_format - The color format of the frame buffer.

Returns

A new FrameBuffer instance.

pub const fn width(&self) -> u32

Get the width of the frame buffer.

pub const fn height(&self) -> u32

Get the height of the frame buffer.

pub const fn row_pitch(&self) -> u32

Get the row pitch of the frame buffer.

pub const fn depth_pitch(&self) -> u32

Get the depth pitch of the frame buffer.

pub const fn has_padding(&self) -> bool

Check if the buffer has padding.

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

Get the raw pixel data with possible padding.

pub fn as_nopadding_buffer(&mut self) -> Result<&mut [u8], Error>

Get the raw pixel data without padding.

Returns

A mutable reference to the buffer containing pixel data without padding.

pub fn save_as_image<T: AsRef<Path>>( &mut self, path: T, format: ImageFormat, ) -> Result<(), Error>

Save the frame buffer as an image to the specified path.

Arguments

• path - The path where the image will be saved.
• format - The image format to use for saving.

Returns

An Ok result if the image is successfully saved, or an Err result if there was an error.