Struct GraphicsCaptureApi

pub struct GraphicsCaptureApi { /* private fields */ }

Represents the GraphicsCaptureApi struct.

Implementations

impl GraphicsCaptureApi

pub fn new<T: GraphicsCaptureApiHandler<Error = E> + Send + 'static, E: Send + Sync + 'static>( d3d_device: ID3D11Device, d3d_device_context: ID3D11DeviceContext, item: GraphicsCaptureItem, callback: Arc<Mutex<T>>, cursor_capture: CursorCaptureSettings, draw_border: DrawBorderSettings, color_format: ColorFormat, thread_id: u32, result: Arc<Mutex<Option<E>>>, ) -> Result<Self, Error>

Create a new Graphics Capture API struct.

Arguments

• d3d_device - The ID3D11Device to use for the capture.
• d3d_device_context - The ID3D11DeviceContext to use for the capture.
• item - The graphics capture item to capture.
• callback - The callback handler for capturing frames.
• capture_cursor - Optional flag to capture the cursor.
• draw_border - Optional flag to draw a border around the captured region.
• color_format - The color format for the captured frames.
• thread_id - The ID of the thread where the capture is running.
• result - The result of the capture operation.

Returns

Returns a Result containing the new GraphicsCaptureApi struct if successful, or an Error if an error occurred.

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

Start the capture.

Returns

Returns Ok(()) if the capture started successfully, or an Error if an error occurred.

pub fn stop_capture(self)

Stop the capture.

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

Get the halt handle.

Returns

Returns an Arc<AtomicBool> representing the halt handle.

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

Check if the Windows Graphics Capture API is supported.

Returns

Returns Ok(true) if the API is supported, Ok(false) if the API is not supported, or an Error if an error occurred.

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

Check if you can change the cursor capture setting.

Returns

Returns true if toggling the cursor capture is supported, false otherwise.

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

Check if you can change the border capture setting.

Returns

Returns true if toggling the border capture is supported, false otherwise.

Trait Implementations

impl Drop for GraphicsCaptureApi

fn drop(&mut self)

Executes the destructor for this type.