wgc 1.0.2

An ergonomic Rust wrapper for Windows.Graphics.Capture API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

use crate::*;
use windows::core::*;
use windows::{Foundation::Metadata::ApiInformation, Graphics::Capture::GraphicsCaptureSession};

/// Checks if the Windows Graphics Capture API is supported.
pub fn is_wgc_supported() -> std::result::Result<bool, WgcError> {
    GraphicsCaptureSession::IsSupported().map_err(|e| e.into())
}

/// Checks if the current Windows version supports configuring the capture border
pub fn is_border_configurable() -> std::result::Result<bool, WgcError> {
    ApiInformation::IsPropertyPresent(
        h!("Windows.Graphics.Capture.GraphicsCaptureSession"),
        h!("IsBorderRequired"),
    )
    .map_err(|e| e.into())
}

/// Checks if the cursor capture setting can be configured on the current Windows version.
pub fn is_cursor_configurable() -> std::result::Result<bool, WgcError> {
    ApiInformation::IsPropertyPresent(
        h!("Windows.Graphics.Capture.GraphicsCaptureSession"),
        h!("IsCursorCaptureEnabled"),
    )
    .map_err(|e| e.into())
}

/// Checks if the "dirty region mode" can be configured on the current Windows version.
pub fn is_dirty_region_mode_configurable() -> std::result::Result<bool, WgcError> {
    ApiInformation::IsPropertyPresent(
        h!("Windows.Graphics.Capture.GraphicsCaptureSession"),
        h!("DirtyRegionMode"),
    )
    .map_err(|e| e.into())
}

/// Checks if the "include secondary windows" setting can be configured on the current Windows version.
pub fn is_include_secondary_windows_configurable() -> std::result::Result<bool, WgcError> {
    ApiInformation::IsPropertyPresent(
        h!("Windows.Graphics.Capture.GraphicsCaptureSession"),
        h!("IncludeSecondaryWindows"),
    )
    .map_err(|e| e.into())
}

/// Checks if the "min update interval" setting can be configured on the current Windows version.
pub fn is_min_update_interval_configurable() -> std::result::Result<bool, WgcError> {
    ApiInformation::IsPropertyPresent(
        h!("Windows.Graphics.Capture.GraphicsCaptureSession"),
        h!("MinUpdateInterval"),
    )
    .map_err(|e| e.into())
}