Struct Monitor 

pub struct Monitor { /* private fields */ }

Represents a display monitor.

Examples

use windows_capture::monitor::Monitor;

// Primary monitor
let primary = Monitor::primary().unwrap();
println!("Primary: {}", primary.name().unwrap());

use windows_capture::monitor::Monitor;

// Enumerate all active monitors
let monitors = Monitor::enumerate().unwrap();
for (i, m) in monitors.iter().enumerate() {
    println!("Monitor #{}: {}", i + 1, m.name().unwrap_or_default());
}

use windows_capture::monitor::Monitor;

// Select by one-based index (e.g., 2nd monitor)
let m2 = Monitor::from_index(2).unwrap();
println!("Second monitor size: {}x{}", m2.width().unwrap(), m2.height().unwrap());

See also: [crate::settings::TryIntoCaptureItemWithDetails].

Implementations

impl Monitor

pub fn primary() -> Result<Self, Error>

Returns the primary monitor.

Errors

• Error::NotFound when no primary monitor can be found

pub fn from_index(index: usize) -> Result<Self, Error>

Returns the monitor at the specified index.

Errors

• Error::IndexIsLowerThanOne when index is less than 1
• Error::NotFound when no monitor exists at the specified index
• Error::WindowsError when monitor enumeration fails

pub fn index(&self) -> Result<usize, Error>

Returns the one-based index of the monitor.

Errors

• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails
• Error::FailedToConvertWindowsString when converting the device name from UTF-16 fails
• Error::FailedToParseMonitorIndex when parsing the numeric index from the device name fails

pub fn name(&self) -> Result<String, Error>

Returns the friendly name of the monitor.

Errors

• Error::WindowsError when Display Configuration API calls fail
• Error::FailedToConvertWindowsString when converting wide strings to String fails
• Error::NameNotFound when no matching path/device name is found for this monitor

pub fn device_name(&self) -> Result<String, Error>

Returns the device name of the monitor (for example, \\.\DISPLAY1).

Errors

• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails
• Error::FailedToConvertWindowsString when converting the device name from UTF-16 fails

pub fn device_string(&self) -> Result<String, Error>

Returns the device string of the monitor (for example, NVIDIA GeForce RTX 4090).

Errors

• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails
• Error::FailedToGetMonitorName when EnumDisplayDevicesW fails
• Error::FailedToConvertWindowsString when converting the device string from UTF-16 fails

pub fn refresh_rate(&self) -> Result<u32, Error>

Returns the refresh rate of the monitor in hertz (Hz).

Errors

• Error::FailedToGetMonitorSettings when EnumDisplaySettingsW fails
• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails while resolving the device name
• Error::FailedToConvertWindowsString when converting the device name from UTF-16 fails

pub fn width(&self) -> Result<u32, Error>

Returns the width of the monitor in pixels.

Errors

• Error::FailedToGetMonitorSettings when EnumDisplaySettingsW fails
• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails while resolving the device name
• Error::FailedToConvertWindowsString when converting the device name from UTF-16 fails

pub fn height(&self) -> Result<u32, Error>

Returns the height of the monitor in pixels.

Errors

• Error::FailedToGetMonitorSettings when EnumDisplaySettingsW fails
• Error::FailedToGetMonitorInfo when GetMonitorInfoW fails while resolving the device name
• Error::FailedToConvertWindowsString when converting the device name from UTF-16 fails

pub fn enumerate() -> Result<Vec<Self>, Error>

Returns a list of all available monitors.

Errors

• Error::WindowsError when EnumDisplayMonitors fails

pub const fn from_raw_hmonitor(monitor: *mut c_void) -> Self

Constructs a Monitor instance from a raw HMONITOR handle.

pub const fn as_raw_hmonitor(&self) -> *mut c_void

Returns the raw HMONITOR handle of the monitor.

Trait Implementations

impl Clone for Monitor

fn clone(&self) -> Monitor

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Monitor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Monitor

fn eq(&self, other: &Monitor) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryInto<GraphicsCaptureItemType> for Monitor

type Error = Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<GraphicsCaptureItemType, Self::Error>

Performs the conversion.

impl Copy for Monitor

impl Eq for Monitor

impl Send for Monitor

impl StructuralPartialEq for Monitor