Struct Monitor

pub struct Monitor { /* private fields */ }

Represents A Monitor Device

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 an Error::NotFound if there is no primary monitor.

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

Returns the monitor at the specified index.

Arguments

• index - The index of the monitor to retrieve. The index starts from 1.

Errors

Returns an Error::IndexIsLowerThanOne if the index is less than 1. Returns an Error::NotFound if the monitor at the specified index is not found.

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

Returns the index of the monitor.

Errors

Returns an Error if there is an error retrieving the monitor index.

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

Returns the name of the monitor.

Errors

Returns an Error if there is an error retrieving the monitor name.

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

Returns the device name of the monitor.

Errors

Returns an Error if there is an error retrieving the monitor device name.

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

Returns the device string of the monitor.

Errors

Returns an Error if there is an error retrieving the monitor device string.

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

Returns the refresh rate of the monitor in hertz.

Errors

Returns an Error if there is an error retrieving the monitor refresh rate.

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

Returns the width of the monitor in pixels.

Errors

Returns an Error if there is an error retrieving the monitor width.

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

Returns the height of the monitor in pixels.

Errors

Returns an Error if there is an error retrieving the monitor height.

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

Returns a list of all monitors.

Errors

Returns an Error if there is an error enumerating the monitors.

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

Creates a Monitor instance from a raw HMONITOR.

Arguments

• hmonitor - The raw HMONITOR.

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

Returns the raw HMONITOR of the monitor.

Trait Implementations

impl Clone for Monitor

fn clone(&self) -> Monitor

Returns a copy 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 TryFrom<Monitor> for GraphicsCaptureItem

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Monitor) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Monitor

impl Eq for Monitor

impl Send for Monitor

impl StructuralPartialEq for Monitor