Struct DxgiDuplicationFrame 

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

Represents a pre-assembled full desktop image for the current frame, backed by the internal GPU texture. Call DxgiDuplicationFrame::buffer to obtain a CPU-readable crate::frame::FrameBuffer.

Implementations

impl<'a> DxgiDuplicationFrame<'a>

pub const fn width(&self) -> u32

Gets the width of the frame.

pub const fn height(&self) -> u32

Gets the height of the frame.

pub const fn format(&self) -> DxgiDuplicationFormat

Gets the pixel format 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 underlying Direct3D device context used for GPU operations.

pub const fn duplication(&self) -> &IDXGIOutputDuplication

Gets the underlying IDXGIOutputDuplication interface.

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

Gets the underlying [windows::Win32::Graphics::Direct3D11::ID3D11Texture2D] interface.

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

Gets the [windows::Win32::Graphics::Direct3D11::D3D11_TEXTURE2D_DESC] of the underlying texture.

pub const fn frame_info(&self) -> &DXGI_OUTDUPL_FRAME_INFO

Gets the frame information for the current frame.

pub fn buffer<'b>(&'b mut self) -> Result<DxgiDuplicationFrameBuffer<'b>, Error>

Maps the internal frame into CPU accessible memory and returns a crate::frame::FrameBuffer.

This creates a staging texture, copies the internal texture into it, and maps it for CPU read/write. The returned buffer may include row padding; you can use crate::frame::FrameBuffer::as_nopadding_buffer to obtain a packed representation.

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

Gets a cropped frame buffer of the duplication frame.

pub fn buffer_with<'s>( &'s mut self, staging: &'s mut StagingTexture, ) -> Result<DxgiDuplicationFrameBuffer<'s>, Error>

Advanced: reuse your own CPU staging texture (crate::d3d11::StagingTexture).

This avoids per-frame allocations and lets you manage the texture’s lifetime. The staging texture must be a D3D11_USAGE_STAGING 2D texture with CPU read/write access, matching the frame’s width/height/format.

pub fn buffer_crop_with<'s>( &'s mut self, staging: &'s mut StagingTexture, start_x: u32, start_y: u32, end_x: u32, end_y: u32, ) -> Result<DxgiDuplicationFrameBuffer<'s>, Error>

Advanced: cropped buffer using a preallocated staging texture. The provided staging texture must be a D3D11_USAGE_STAGING 2D texture with CPU read/write access, of the same format as the duplication frame, and large enough to contain the crop region.

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.