Struct Monitor 

pub struct Monitor { /* private fields */ }

Represents a display monitor.

Example

use windows_capture::monitor::Monitor;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let monitor = Monitor::primary()?;
    println!("Primary Monitor: {}", monitor.name()?);

    Ok(())
}

Implementations

impl Monitor

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

Returns the primary monitor.

Errors

Returns Error::NotFound if the primary monitor cannot be found.

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

Returns the monitor at the specified index.

Arguments

• index - The one-based index of the monitor to retrieve.

Errors

• Error::IndexIsLowerThanOne - If the index is less than 1.
• Error::NotFound - If no monitor is found at the specified index.

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

Returns the one-based index of the monitor.

Errors

Returns an Error if the monitor’s device name cannot be parsed to determine the index.

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

Returns the friendly name of the monitor.

Errors

Returns an Error if the monitor’s name cannot be retrieved.

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

Returns the device name of the monitor (e.g., \\.\DISPLAY1).

Errors

Returns an Error if the monitor’s device name cannot be retrieved.

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

Returns the device string of the monitor (e.g., NVIDIA GeForce RTX 4090).

Errors

Returns an Error if the monitor’s device string cannot be retrieved.

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

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

Errors

Returns an Error if the monitor’s refresh rate cannot be retrieved.

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

Returns the width of the monitor in pixels.

Errors

Returns an Error if the monitor’s width cannot be retrieved.

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

Returns the height of the monitor in pixels.

Errors

Returns an Error if the monitor’s height cannot be retrieved.

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

Returns a list of all available monitors.

Errors

Returns an Error if the monitor enumeration fails.

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

Creates a Monitor instance from a raw HMONITOR handle.

Arguments

• hmonitor - The 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 TryIntoCaptureItemWithType for Monitor

fn try_into_capture_item( self, ) -> Result<(GraphicsCaptureItem, CaptureItemTypes), Error>

Attempts to convert the object into a GraphicsCaptureItem and its corresponding CaptureItemTypes variant.

impl Copy for Monitor

impl Eq for Monitor

impl Send for Monitor

impl StructuralPartialEq for Monitor