Struct Frame

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

Represents a frame captured from a graphics capture item.

Example

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

Implementations

impl<'a> Frame<'a>

pub const fn new( d3d_device: &'a ID3D11Device, frame_surface: IDirect3DSurface, frame_texture: ID3D11Texture2D, timestamp: TimeSpan, context: &'a ID3D11DeviceContext, buffer: &'a mut Vec<u8>, width: u32, height: u32, color_format: ColorFormat, title_bar_height: Option<u32>, ) -> Self

Creates a new Frame.

Arguments

• d3d_device - The ID3D11Device used for creating the frame.
• frame_surface - The IDirect3DSurface representing the frame’s surface.
• frame_texture - The ID3D11Texture2D representing the frame’s texture.
• timestamp - The TimeSpan representing the frame’s timestamp, in 100-nanosecond units.
• context - The ID3D11DeviceContext used for copying the texture.
• buffer - A mutable reference to the buffer for the frame data.
• width - The width of the frame.
• height - The height of the frame.
• color_format - The ColorFormat of the frame.
• title_bar_height - The height of the title bar, if applicable.

Returns

A new Frame instance.

pub const fn width(&self) -> u32

Gets the width of the frame.

Returns

The width of the frame.

pub const fn height(&self) -> u32

Gets the height of the frame.

Returns

The height of the frame.

pub const fn timestamp(&self) -> TimeSpan

Gets the timestamp of the frame.

Returns

The timestamp of the frame.

pub const fn color_format(&self) -> ColorFormat

Gets the color format of the frame.

Returns

The color format of the frame.

pub const unsafe fn as_raw_surface(&self) -> &IDirect3DSurface

Gets the raw surface of the frame.

Returns

The IDirect3DSurface representing the raw surface of the frame.

Safety

This method is unsafe because it returns a reference to an underlying Windows API object.

pub const unsafe fn as_raw_texture(&self) -> &ID3D11Texture2D

Gets the raw texture of the frame.

Returns

The ID3D11Texture2D representing the raw texture of the frame.

Safety

This method is unsafe because it returns a reference to an underlying Windows API object.

pub fn buffer(&mut self) -> Result<FrameBuffer<'_>, Error>

Gets the frame buffer.

Returns

A FrameBuffer containing the frame data.

pub fn buffer_crop( &mut self, start_width: u32, start_height: u32, end_width: u32, end_height: u32, ) -> Result<FrameBuffer<'_>, Error>

Get a cropped frame buffer.

Arguments

• start_width - The starting width of the cropped frame.
• start_height - The starting height of the cropped frame.
• end_width - The ending width of the cropped frame.
• end_height - The ending height of the cropped frame.

Returns

A FrameBuffer containing the cropped frame data.

pub fn buffer_without_title_bar(&mut self) -> Result<FrameBuffer<'_>, Error>

Gets the frame buffer without the title bar.

Returns

A FrameBuffer containing the frame data without the title bar.

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 ImageFormat of the saved image.

Returns

An empty Result if successful, or an Error if there was an issue saving the image.