0df436901a
* First name consistency pass. More to come! * Remove multitouch variable (hopefully this compiles!) * Remove CreationError::NotSupported * Add new error handling types * Remove `get_` prefix from getters. This is as per the Rust naming conventions recommended in https://rust-lang-nursery.github.io/api-guidelines/naming.html#getter-names-follow-rust-convention-c-getter * Make changes to Window position and size function signatures * Remove CreationError in favor of OsError * Begin updating iOS backend * Change MonitorHandle::outer_position to just position * Fix build on Windows and Linux * Add Display and Error implementations to Error types * Attempt to fix iOS build. I can't actually check that this works since I can't cross-compile to iOS on a Windows machine (thanks apple :/) but this should be one of several commits to get it working. * Attempt to fix iOS errors, and muck up Travis to make debugging easier * More iOS fixins * Add Debug and Display impls to OsError * Fix Display impl * Fix unused code warnings and travis * Rename set_ime_spot to set_ime_position * Add CHANGELOG entry * Rename set_cursor to set_cursor_icon and MouseCursor to CursorIcon * Organize Window functions into multiple, categorized impls * Improve clarity of function ordering and docs in EventLoop
91 lines
2.9 KiB
Rust
91 lines
2.9 KiB
Rust
//! Types useful for interacting with a user's monitors.
|
|
//!
|
|
//! If you want to get basic information about a monitor, you can use the [`MonitorHandle`][monitor_id]
|
|
//! type. This is retreived from an [`AvailableMonitorsIter`][monitor_iter], which can be acquired
|
|
//! with:
|
|
//! - [`EventLoop::available_monitors`][loop_get]
|
|
//! - [`Window::available_monitors`][window_get].
|
|
//!
|
|
//! [monitor_id]: ./struct.MonitorHandle.html
|
|
//! [monitor_iter]: ./struct.AvailableMonitorsIter.html
|
|
//! [loop_get]: ../event_loop/struct.EventLoop.html#method.available_monitors
|
|
//! [window_get]: ../window/struct.Window.html#method.available_monitors
|
|
use std::collections::vec_deque::IntoIter as VecDequeIter;
|
|
|
|
use platform_impl;
|
|
use dpi::{PhysicalPosition, PhysicalSize};
|
|
|
|
/// An iterator over all available monitors.
|
|
///
|
|
/// Can be acquired with:
|
|
/// - [`EventLoop::available_monitors`][loop_get]
|
|
/// - [`Window::available_monitors`][window_get].
|
|
///
|
|
/// [loop_get]: ../event_loop/struct.EventLoop.html#method.available_monitors
|
|
/// [window_get]: ../window/struct.Window.html#method.available_monitors
|
|
// Implementation note: we retrieve the list once, then serve each element by one by one.
|
|
// This may change in the future.
|
|
#[derive(Debug)]
|
|
pub struct AvailableMonitorsIter {
|
|
pub(crate) data: VecDequeIter<platform_impl::MonitorHandle>,
|
|
}
|
|
|
|
impl Iterator for AvailableMonitorsIter {
|
|
type Item = MonitorHandle;
|
|
|
|
#[inline]
|
|
fn next(&mut self) -> Option<MonitorHandle> {
|
|
self.data.next().map(|id| MonitorHandle { inner: id })
|
|
}
|
|
|
|
#[inline]
|
|
fn size_hint(&self) -> (usize, Option<usize>) {
|
|
self.data.size_hint()
|
|
}
|
|
}
|
|
|
|
/// Handle to a monitor.
|
|
///
|
|
/// Allows you to retrieve information about a given monitor and can be used in [`Window`] creation.
|
|
///
|
|
/// [`Window`]: ../window/struct.Window.html
|
|
#[derive(Debug, Clone)]
|
|
pub struct MonitorHandle {
|
|
pub(crate) inner: platform_impl::MonitorHandle
|
|
}
|
|
|
|
impl MonitorHandle {
|
|
/// Returns a human-readable name of the monitor.
|
|
///
|
|
/// Returns `None` if the monitor doesn't exist anymore.
|
|
#[inline]
|
|
pub fn name(&self) -> Option<String> {
|
|
self.inner.name()
|
|
}
|
|
|
|
/// Returns the monitor's resolution.
|
|
#[inline]
|
|
pub fn dimensions(&self) -> PhysicalSize {
|
|
self.inner.dimensions()
|
|
}
|
|
|
|
/// Returns the top-left corner position of the monitor relative to the larger full
|
|
/// screen area.
|
|
#[inline]
|
|
pub fn position(&self) -> PhysicalPosition {
|
|
self.inner.position()
|
|
}
|
|
|
|
/// Returns the DPI factor that can be used to map logical pixels to physical pixels, and vice versa.
|
|
///
|
|
/// See the [`dpi`](dpi/index.html) module for more information.
|
|
///
|
|
/// ## Platform-specific
|
|
///
|
|
/// - **X11:** Can be overridden using the `WINIT_HIDPI_FACTOR` environment variable.
|
|
/// - **Android:** Always returns 1.0.
|
|
#[inline]
|
|
pub fn hidpi_factor(&self) -> f64 {
|
|
self.inner.hidpi_factor()
|
|
}
|
|
}
|