Struct winit::monitor::MonitorHandle

pub struct MonitorHandle {
    pub(crate) inner: MonitorHandle,
}

Handle to a monitor.

Allows you to retrieve information about a given monitor and can be used in Window creation.

Fields

inner: MonitorHandle

Implementations

impl MonitorHandle

pub fn name(&self) -> Option<String>

Returns a human-readable name of the monitor.

Returns None if the monitor doesn’t exist anymore.

pub fn size(&self) -> PhysicalSize<u32>

Returns the monitor’s resolution.

pub fn position(&self) -> PhysicalPosition<i32>

Returns the top-left corner position of the monitor relative to the larger full screen area.

pub fn refresh_rate_millihertz(&self) -> Option<u32>

The monitor refresh rate used by the system.

Return Some if succeed, or None if failed, which usually happens when the monitor the window is on is removed.

When using exclusive fullscreen, the refresh rate of the VideoModeHandle that was used to enter fullscreen should be used instead.

pub fn scale_factor(&self) -> f64

Returns the scale factor of the underlying monitor. To map logical pixels to physical pixels and vice versa, use Window::scale_factor.

See the dpi module for more information.

Platform-specific

• X11: Can be overridden using the WINIT_X11_SCALE_FACTOR environment variable.
• Wayland: May differ from Window::scale_factor.
• Android: Always returns 1.0.

pub fn video_modes(&self) -> impl Iterator<Item = VideoModeHandle>

Returns all fullscreen video modes supported by this monitor.

Platform-specific

• Web: Always returns an empty iterator

Trait Implementations

impl Clone for MonitorHandle

fn clone(&self) -> MonitorHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MonitorHandle

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

Formats the value using the given formatter.

impl MonitorHandleExtWayland for MonitorHandle

fn native_id(&self) -> u32

Returns the inner identifier of the monitor.

impl MonitorHandleExtX11 for MonitorHandle

fn native_id(&self) -> u32

Returns the inner identifier of the monitor.

impl Ord for MonitorHandle

fn cmp(&self, other: &MonitorHandle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MonitorHandle

fn eq(&self, other: &MonitorHandle) -> 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 PartialOrd for MonitorHandle

fn partial_cmp(&self, other: &MonitorHandle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for MonitorHandle

impl StructuralPartialEq for MonitorHandle