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( capture_frame: Direct3D11CaptureFrame, d3d_device: &'a ID3D11Device, frame_surface: IDirect3DSurface, frame_texture: ID3D11Texture2D, context: &'a ID3D11DeviceContext, desc: D3D11_TEXTURE2D_DESC, color_format: ColorFormat, title_bar_height: Option<u32>, ) -> Self

Constructs a new Frame.

pub const fn width(&self) -> u32

Gets the width of the frame.

pub fn dirty_regions(&self) -> Result<Vec<DirtyRegion>, Error>

Gets the dirty regions of the frame.

pub const fn height(&self) -> u32

Gets the height of the frame.

pub fn timestamp(&self) -> Result<TimeSpan, Error>

Gets the timestamp of the frame.

pub const fn color_format(&self) -> ColorFormat

Gets the color format of the frame.

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

Gets the raw surface of the frame.

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

Gets the raw texture of the frame.

pub const fn device(&self) -> &ID3D11Device

Gets the underlying Direct3D device associated with this frame.

pub const fn device_context(&self) -> &ID3D11DeviceContext

Gets the device context used for GPU operations on this frame.

pub const fn desc(&self) -> &D3D11_TEXTURE2D_DESC

Gets the texture description of the frame.

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

Gets the frame buffer.

pub fn buffer_crop( &mut self, start_x: u32, start_y: u32, end_x: u32, end_y: u32, ) -> Result<FrameBuffer<'_>, Error>

Gets a cropped frame buffer.

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

Gets the frame buffer without the title bar.

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

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