Struct GraphicsCaptureApi 

pub struct GraphicsCaptureApi { /* private fields */ }

Manages a graphics capture session using the Windows Graphics Capture API.

Implementations

impl GraphicsCaptureApi

pub fn new<T: GraphicsCaptureApiHandler<Error = E> + Send + 'static, E: Send + Sync + 'static>( d3d_device: ID3D11Device, d3d_device_context: ID3D11DeviceContext, item_with_details: GraphicsCaptureItemType, callback: Arc<Mutex<T>>, cursor_capture_settings: CursorCaptureSettings, draw_border_settings: DrawBorderSettings, secondary_window_settings: SecondaryWindowSettings, minimum_update_interval_settings: MinimumUpdateIntervalSettings, dirty_region_settings: DirtyRegionSettings, color_format: ColorFormat, thread_id: u32, result: Arc<Mutex<Option<E>>>, ) -> Result<Self, Error>

Constructs a new GraphicsCaptureApi instance.

For parameter details, see the type names in the signature; complex behavior is documented inline below where relevant.

pub fn start_capture(&mut self) -> Result<(), Error>

Starts the capture.

Errors

• Error::AlreadyStarted when called more than once
• Error::WindowsError for failures starting the capture session

pub fn stop_capture(self)

Stops the capture session and cleans up resources.

pub fn halt_handle(&self) -> Arc<AtomicBool>

Gets the halt handle.

Returns

Returns an Arc<AtomicBool> that can be used to check if the capture is halted.

pub fn is_supported() -> Result<bool, Error>

Checks if the Windows Graphics Capture API is supported.

pub fn is_cursor_settings_supported() -> Result<bool, Error>

Checks if the cursor capture settings can be changed.

pub fn is_border_settings_supported() -> Result<bool, Error>

Checks if the capture border settings can be changed.

pub fn is_secondary_windows_supported() -> Result<bool, Error>

Checks if capturing secondary windows is supported.

pub fn is_minimum_update_interval_supported() -> Result<bool, Error>

Checks if setting a minimum update interval is supported.

pub fn is_dirty_region_supported() -> Result<bool, Error>

Checks if dirty region tracking is supported.

Trait Implementations

impl Drop for GraphicsCaptureApi

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.