2015-02-21 23:59:37 +11:00
|
|
|
use std::collections::vec_deque::IntoIter as VecDequeIter;
|
2015-02-16 19:29:37 +11:00
|
|
|
|
|
|
|
use CreationError;
|
2015-03-27 03:04:01 +11:00
|
|
|
use CursorState;
|
2017-01-29 01:00:17 +11:00
|
|
|
use EventsLoop;
|
2015-02-16 19:29:37 +11:00
|
|
|
use MouseCursor;
|
2015-09-26 02:04:55 +10:00
|
|
|
use Window;
|
2016-04-29 09:30:44 +10:00
|
|
|
use WindowBuilder;
|
2017-02-03 19:13:11 +11:00
|
|
|
use WindowId;
|
2015-03-19 08:16:35 +11:00
|
|
|
use native_monitor::NativeMonitorId;
|
2015-02-16 19:29:37 +11:00
|
|
|
|
|
|
|
use libc;
|
2015-04-02 17:27:32 +11:00
|
|
|
use platform;
|
2015-02-16 19:29:37 +11:00
|
|
|
|
2016-02-23 22:56:23 +11:00
|
|
|
impl WindowBuilder {
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Initializes a new `WindowBuilder` with default values.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn new() -> WindowBuilder {
|
2015-02-16 19:29:37 +11:00
|
|
|
WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
window: Default::default(),
|
2016-01-08 02:01:18 +11:00
|
|
|
platform_specific: Default::default(),
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Requests the window to be of specific dimensions.
|
|
|
|
///
|
|
|
|
/// Width and height are in pixels.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_dimensions(mut self, width: u32, height: u32) -> WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.dimensions = Some((width, height));
|
2015-02-16 19:29:37 +11:00
|
|
|
self
|
|
|
|
}
|
2017-06-22 05:10:23 +10:00
|
|
|
|
2015-11-09 20:42:54 +11:00
|
|
|
/// Sets a minimum dimension size for the window
|
|
|
|
///
|
|
|
|
/// Width and height are in pixels.
|
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_min_dimensions(mut self, width: u32, height: u32) -> WindowBuilder {
|
2015-11-09 20:42:54 +11:00
|
|
|
self.window.min_dimensions = Some((width, height));
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets a maximum dimension size for the window
|
|
|
|
///
|
|
|
|
/// Width and height are in pixels.
|
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_max_dimensions(mut self, width: u32, height: u32) -> WindowBuilder {
|
2015-11-09 20:42:54 +11:00
|
|
|
self.window.max_dimensions = Some((width, height));
|
|
|
|
self
|
|
|
|
}
|
2015-02-16 19:29:37 +11:00
|
|
|
|
|
|
|
/// Requests a specific title for the window.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-09-20 02:53:28 +10:00
|
|
|
pub fn with_title<T: Into<String>>(mut self, title: T) -> WindowBuilder {
|
2016-05-08 17:28:42 +10:00
|
|
|
self.window.title = title.into();
|
2015-02-16 19:29:37 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Requests fullscreen mode.
|
|
|
|
///
|
|
|
|
/// If you don't specify dimensions for the window, it will match the monitor's.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_fullscreen(mut self, monitor: MonitorId) -> WindowBuilder {
|
2015-09-24 17:11:59 +10:00
|
|
|
let MonitorId(monitor) = monitor;
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.monitor = Some(monitor);
|
2015-02-16 19:29:37 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets whether the window will be initially hidden or visible.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_visibility(mut self, visible: bool) -> WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.visible = visible;
|
2015-02-16 19:29:37 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2015-05-15 23:19:33 +10:00
|
|
|
/// Sets whether the background of the window should be transparent.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_transparency(mut self, transparent: bool) -> WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.transparent = transparent;
|
2015-05-15 23:19:33 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets whether the window should have a border, a title bar, etc.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_decorations(mut self, decorations: bool) -> WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.decorations = decorations;
|
2015-05-15 23:19:33 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2015-06-05 23:38:21 +10:00
|
|
|
/// Enables multitouch
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2016-02-23 22:56:23 +11:00
|
|
|
pub fn with_multitouch(mut self) -> WindowBuilder {
|
2015-09-21 21:15:43 +10:00
|
|
|
self.window.multitouch = true;
|
2015-06-05 23:38:21 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Builds the window.
|
|
|
|
///
|
|
|
|
/// Error should be very rare and only occur in case of permission denied, incompatible system,
|
2015-05-15 23:19:33 +10:00
|
|
|
/// out of memory, etc.
|
2017-01-29 01:00:17 +11:00
|
|
|
pub fn build(mut self, events_loop: &EventsLoop) -> Result<Window, CreationError> {
|
2015-02-16 19:29:37 +11:00
|
|
|
// resizing the window to the dimensions of the monitor when fullscreen
|
2015-09-21 21:15:43 +10:00
|
|
|
if self.window.dimensions.is_none() && self.window.monitor.is_some() {
|
|
|
|
self.window.dimensions = Some(self.window.monitor.as_ref().unwrap().get_dimensions())
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
// default dimensions
|
2015-09-21 21:15:43 +10:00
|
|
|
if self.window.dimensions.is_none() {
|
|
|
|
self.window.dimensions = Some((1024, 768));
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
// building
|
2017-06-02 21:19:45 +10:00
|
|
|
let w = try!(platform::Window2::new(&events_loop.events_loop, &self.window, &self.platform_specific));
|
2016-11-11 22:08:46 +11:00
|
|
|
|
|
|
|
Ok(Window { window: w })
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Window {
|
2017-05-11 10:10:07 +10:00
|
|
|
/// Creates a new Window for platforms where this is appropriate.
|
2015-02-16 19:29:37 +11:00
|
|
|
///
|
2017-01-29 01:33:54 +11:00
|
|
|
/// This function is equivalent to `WindowBuilder::new().build(events_loop)`.
|
2015-02-16 19:29:37 +11:00
|
|
|
///
|
|
|
|
/// Error should be very rare and only occur in case of permission denied, incompatible system,
|
|
|
|
/// out of memory, etc.
|
|
|
|
#[inline]
|
2017-01-29 01:00:17 +11:00
|
|
|
pub fn new(events_loop: &EventsLoop) -> Result<Window, CreationError> {
|
2015-02-16 19:29:37 +11:00
|
|
|
let builder = WindowBuilder::new();
|
2017-01-29 01:00:17 +11:00
|
|
|
builder.build(events_loop)
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Modifies the title of the window.
|
|
|
|
///
|
|
|
|
/// This is a no-op if the window has already been closed.
|
|
|
|
#[inline]
|
|
|
|
pub fn set_title(&self, title: &str) {
|
|
|
|
self.window.set_title(title)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Shows the window if it was hidden.
|
|
|
|
///
|
|
|
|
/// ## Platform-specific
|
|
|
|
///
|
|
|
|
/// - Has no effect on Android
|
|
|
|
///
|
|
|
|
#[inline]
|
|
|
|
pub fn show(&self) {
|
|
|
|
self.window.show()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Hides the window if it was visible.
|
|
|
|
///
|
|
|
|
/// ## Platform-specific
|
|
|
|
///
|
|
|
|
/// - Has no effect on Android
|
|
|
|
///
|
|
|
|
#[inline]
|
|
|
|
pub fn hide(&self) {
|
|
|
|
self.window.hide()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the position of the top-left hand corner of the window relative to the
|
|
|
|
/// top-left hand corner of the desktop.
|
|
|
|
///
|
2015-03-26 14:44:21 +11:00
|
|
|
/// Note that the top-left hand corner of the desktop is not necessarily the same as
|
2015-02-16 19:29:37 +11:00
|
|
|
/// the screen. If the user uses a desktop with multiple monitors, the top-left hand corner
|
|
|
|
/// of the desktop is the top-left hand corner of the monitor at the top-left of the desktop.
|
|
|
|
///
|
|
|
|
/// The coordinates can be negative if the top-left hand corner of the window is outside
|
|
|
|
/// of the visible screen region.
|
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
|
|
|
#[inline]
|
|
|
|
pub fn get_position(&self) -> Option<(i32, i32)> {
|
|
|
|
self.window.get_position()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Modifies the position of the window.
|
|
|
|
///
|
|
|
|
/// See `get_position` for more informations about the coordinates.
|
|
|
|
///
|
|
|
|
/// This is a no-op if the window has already been closed.
|
|
|
|
#[inline]
|
|
|
|
pub fn set_position(&self, x: i32, y: i32) {
|
|
|
|
self.window.set_position(x, y)
|
|
|
|
}
|
|
|
|
|
2015-07-25 21:57:52 +10:00
|
|
|
/// Returns the size in points of the client area of the window.
|
|
|
|
///
|
|
|
|
/// The client area is the content of the window, excluding the title bar and borders.
|
|
|
|
/// To get the dimensions of the frame buffer when calling `glViewport`, multiply with hidpi factor.
|
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
|
|
|
///
|
|
|
|
/// DEPRECATED
|
|
|
|
#[inline]
|
|
|
|
pub fn get_inner_size(&self) -> Option<(u32, u32)> {
|
|
|
|
self.window.get_inner_size()
|
|
|
|
}
|
2017-06-22 05:10:23 +10:00
|
|
|
|
2015-07-25 20:01:20 +10:00
|
|
|
/// Returns the size in points of the client area of the window.
|
2015-02-16 19:29:37 +11:00
|
|
|
///
|
|
|
|
/// The client area is the content of the window, excluding the title bar and borders.
|
2015-07-25 20:01:20 +10:00
|
|
|
/// To get the dimensions of the frame buffer when calling `glViewport`, multiply with hidpi factor.
|
2015-02-16 19:29:37 +11:00
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
|
|
|
#[inline]
|
2015-07-25 21:40:33 +10:00
|
|
|
pub fn get_inner_size_points(&self) -> Option<(u32, u32)> {
|
2015-02-16 19:29:37 +11:00
|
|
|
self.window.get_inner_size()
|
|
|
|
}
|
|
|
|
|
2015-07-25 21:57:52 +10:00
|
|
|
|
2015-07-25 21:40:33 +10:00
|
|
|
/// Returns the size in pixels of the client area of the window.
|
|
|
|
///
|
|
|
|
/// The client area is the content of the window, excluding the title bar and borders.
|
|
|
|
/// These are the dimensions of the frame buffer, and the dimensions that you should use
|
|
|
|
/// when you call `glViewport`.
|
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
|
|
|
#[inline]
|
|
|
|
pub fn get_inner_size_pixels(&self) -> Option<(u32, u32)> {
|
|
|
|
self.window.get_inner_size().map(|(x, y)| {
|
|
|
|
let hidpi = self.hidpi_factor();
|
|
|
|
((x as f32 * hidpi) as u32, (y as f32 * hidpi) as u32)
|
|
|
|
})
|
|
|
|
}
|
|
|
|
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Returns the size in pixels of the window.
|
|
|
|
///
|
|
|
|
/// These dimensions include title bar and borders. If you don't want these, you should use
|
|
|
|
/// use `get_inner_size` instead.
|
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
|
|
|
#[inline]
|
|
|
|
pub fn get_outer_size(&self) -> Option<(u32, u32)> {
|
|
|
|
self.window.get_outer_size()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Modifies the inner size of the window.
|
|
|
|
///
|
|
|
|
/// See `get_inner_size` for more informations about the values.
|
|
|
|
///
|
|
|
|
/// This is a no-op if the window has already been closed.
|
|
|
|
#[inline]
|
|
|
|
pub fn set_inner_size(&self, x: u32, y: u32) {
|
|
|
|
self.window.set_inner_size(x, y)
|
|
|
|
}
|
|
|
|
|
2015-09-26 02:04:55 +10:00
|
|
|
/// DEPRECATED. Gets the native platform specific display for this window.
|
2015-02-16 19:29:37 +11:00
|
|
|
/// This is typically only required when integrating with
|
|
|
|
/// other libraries that need this information.
|
2016-11-03 19:49:19 +11:00
|
|
|
#[deprecated]
|
2015-02-16 19:29:37 +11:00
|
|
|
#[inline]
|
|
|
|
pub unsafe fn platform_display(&self) -> *mut libc::c_void {
|
|
|
|
self.window.platform_display()
|
|
|
|
}
|
|
|
|
|
2015-09-26 02:04:55 +10:00
|
|
|
/// DEPRECATED. Gets the native platform specific window handle. This is
|
2015-02-21 07:32:40 +11:00
|
|
|
/// typically only required when integrating with other libraries
|
|
|
|
/// that need this information.
|
2016-11-03 19:49:19 +11:00
|
|
|
#[deprecated]
|
2015-02-21 07:32:40 +11:00
|
|
|
#[inline]
|
|
|
|
pub unsafe fn platform_window(&self) -> *mut libc::c_void {
|
|
|
|
self.window.platform_window()
|
|
|
|
}
|
|
|
|
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Modifies the mouse cursor of the window.
|
|
|
|
/// Has no effect on Android.
|
|
|
|
pub fn set_cursor(&self, cursor: MouseCursor) {
|
|
|
|
self.window.set_cursor(cursor);
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the ratio between the backing framebuffer resolution and the
|
|
|
|
/// window size in screen pixels. This is typically one for a normal display
|
|
|
|
/// and two for a retina display.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-02-16 19:29:37 +11:00
|
|
|
pub fn hidpi_factor(&self) -> f32 {
|
|
|
|
self.window.hidpi_factor()
|
|
|
|
}
|
2015-03-10 20:29:07 +11:00
|
|
|
|
|
|
|
/// Changes the position of the cursor in window coordinates.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-03-10 20:29:07 +11:00
|
|
|
pub fn set_cursor_position(&self, x: i32, y: i32) -> Result<(), ()> {
|
|
|
|
self.window.set_cursor_position(x, y)
|
|
|
|
}
|
2015-01-25 22:06:50 +11:00
|
|
|
|
2017-05-11 10:10:07 +10:00
|
|
|
/// Sets how winit handles the cursor. See the documentation of `CursorState` for details.
|
2015-03-27 03:04:01 +11:00
|
|
|
///
|
2015-01-25 22:06:50 +11:00
|
|
|
/// Has no effect on Android.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-03-27 03:04:01 +11:00
|
|
|
pub fn set_cursor_state(&self, state: CursorState) -> Result<(), String> {
|
|
|
|
self.window.set_cursor_state(state)
|
2015-01-25 22:06:50 +11:00
|
|
|
}
|
2017-01-29 01:05:36 +11:00
|
|
|
|
|
|
|
#[inline]
|
2017-02-03 19:13:11 +11:00
|
|
|
pub fn id(&self) -> WindowId {
|
|
|
|
WindowId(self.window.id())
|
2017-01-29 01:05:36 +11:00
|
|
|
}
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// An iterator for the list of available monitors.
|
|
|
|
// Implementation note: we retreive the list once, then serve each element by one by one.
|
|
|
|
// This may change in the future.
|
|
|
|
pub struct AvailableMonitorsIter {
|
2015-09-24 17:11:59 +10:00
|
|
|
data: VecDequeIter<platform::MonitorId>,
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Iterator for AvailableMonitorsIter {
|
2015-09-24 17:11:59 +10:00
|
|
|
type Item = MonitorId;
|
2015-03-16 23:50:23 +11:00
|
|
|
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-09-24 17:11:59 +10:00
|
|
|
fn next(&mut self) -> Option<MonitorId> {
|
|
|
|
self.data.next().map(|id| MonitorId(id))
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
2015-03-16 23:50:23 +11:00
|
|
|
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-03-16 23:50:23 +11:00
|
|
|
fn size_hint(&self) -> (usize, Option<usize>) {
|
|
|
|
self.data.size_hint()
|
|
|
|
}
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the list of all available monitors.
|
2017-06-22 05:10:23 +10:00
|
|
|
///
|
|
|
|
/// Usage will result in display backend initialisation, this can be controlled on linux
|
|
|
|
/// using an environment variable `WINIT_UNIX_BACKEND`.
|
|
|
|
/// > Legal values are `x11` and `wayland`. If this variable is set only the named backend
|
|
|
|
/// > will be tried by winit. If it is not set, winit will try to connect to a wayland connection,
|
|
|
|
/// > and if it fails will fallback on x11.
|
|
|
|
/// >
|
|
|
|
/// > If this variable is set with any other value, winit will panic.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-02-16 19:29:37 +11:00
|
|
|
pub fn get_available_monitors() -> AvailableMonitorsIter {
|
2015-04-02 17:27:32 +11:00
|
|
|
let data = platform::get_available_monitors();
|
2015-02-16 19:29:37 +11:00
|
|
|
AvailableMonitorsIter{ data: data.into_iter() }
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the primary monitor of the system.
|
2017-06-22 05:10:23 +10:00
|
|
|
///
|
|
|
|
/// Usage will result in display backend initialisation, this can be controlled on linux
|
|
|
|
/// using an environment variable `WINIT_UNIX_BACKEND`.
|
|
|
|
/// > Legal values are `x11` and `wayland`. If this variable is set only the named backend
|
|
|
|
/// > will be tried by winit. If it is not set, winit will try to connect to a wayland connection,
|
|
|
|
/// > and if it fails will fallback on x11.
|
|
|
|
/// >
|
|
|
|
/// > If this variable is set with any other value, winit will panic.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-09-24 17:11:59 +10:00
|
|
|
pub fn get_primary_monitor() -> MonitorId {
|
|
|
|
MonitorId(platform::get_primary_monitor())
|
2015-02-16 19:29:37 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Identifier for a monitor.
|
2015-09-24 17:11:59 +10:00
|
|
|
pub struct MonitorId(platform::MonitorId);
|
2015-02-16 19:29:37 +11:00
|
|
|
|
2015-09-24 17:11:59 +10:00
|
|
|
impl MonitorId {
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Returns a human-readable name of the monitor.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-02-16 19:29:37 +11:00
|
|
|
pub fn get_name(&self) -> Option<String> {
|
2015-09-24 17:11:59 +10:00
|
|
|
let &MonitorId(ref id) = self;
|
2015-02-16 19:29:37 +11:00
|
|
|
id.get_name()
|
|
|
|
}
|
|
|
|
|
2015-03-17 07:52:58 +11:00
|
|
|
/// Returns the native platform identifier for this monitor.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-03-19 08:16:35 +11:00
|
|
|
pub fn get_native_identifier(&self) -> NativeMonitorId {
|
2015-09-24 17:11:59 +10:00
|
|
|
let &MonitorId(ref id) = self;
|
2015-03-17 07:52:58 +11:00
|
|
|
id.get_native_identifier()
|
|
|
|
}
|
|
|
|
|
2015-02-16 19:29:37 +11:00
|
|
|
/// Returns the number of pixels currently displayed on the monitor.
|
2015-09-21 22:42:05 +10:00
|
|
|
#[inline]
|
2015-02-16 19:29:37 +11:00
|
|
|
pub fn get_dimensions(&self) -> (u32, u32) {
|
2015-09-24 17:11:59 +10:00
|
|
|
let &MonitorId(ref id) = self;
|
2015-02-16 19:29:37 +11:00
|
|
|
id.get_dimensions()
|
|
|
|
}
|
|
|
|
}
|