winit-sonoma-fix/src/window.rs

360 lines
11 KiB
Rust
Raw Normal View History

use std::collections::vec_deque::IntoIter as VecDequeIter;
use CreationError;
use CursorState;
2017-01-29 01:00:17 +11:00
use EventsLoop;
use MouseCursor;
use Window;
use WindowBuilder;
2017-02-03 19:13:11 +11:00
use WindowId;
use native_monitor::NativeMonitorId;
use libc;
2015-04-02 17:27:32 +11:00
use platform;
impl WindowBuilder {
/// Initializes a new `WindowBuilder` with default values.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn new() -> WindowBuilder {
WindowBuilder {
2015-09-21 21:15:43 +10:00
window: Default::default(),
2016-01-08 02:01:18 +11:00
platform_specific: Default::default(),
}
}
/// Requests the window to be of specific dimensions.
///
/// Width and height are in pixels.
2015-09-21 22:42:05 +10:00
#[inline]
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));
self
}
/// Sets a minimum dimension size for the window
///
/// Width and height are in pixels.
#[inline]
pub fn with_min_dimensions(mut self, width: u32, height: u32) -> WindowBuilder {
self.window.min_dimensions = Some((width, height));
self
}
/// Sets a maximum dimension size for the window
///
/// Width and height are in pixels.
#[inline]
pub fn with_max_dimensions(mut self, width: u32, height: u32) -> WindowBuilder {
self.window.max_dimensions = Some((width, height));
self
}
/// Requests a specific title for the window.
2015-09-21 22:42:05 +10:00
#[inline]
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();
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]
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);
self
}
/// Sets whether the window will be initially hidden or visible.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn with_visibility(mut self, visible: bool) -> WindowBuilder {
2015-09-21 21:15:43 +10:00
self.window.visible = visible;
self
}
/// Sets whether the background of the window should be transparent.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn with_transparency(mut self, transparent: bool) -> WindowBuilder {
2015-09-21 21:15:43 +10:00
self.window.transparent = transparent;
self
}
/// Sets whether the window should have a border, a title bar, etc.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn with_decorations(mut self, decorations: bool) -> WindowBuilder {
2015-09-21 21:15:43 +10:00
self.window.decorations = decorations;
self
}
2015-06-05 23:38:21 +10:00
/// Enables multitouch
2015-09-21 22:42:05 +10:00
#[inline]
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
}
/// Builds the window.
///
/// Error should be very rare and only occur in case of permission denied, incompatible system,
/// out of memory, etc.
2017-01-29 01:00:17 +11:00
pub fn build(mut self, events_loop: &EventsLoop) -> Result<Window, CreationError> {
// 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())
}
// default dimensions
2015-09-21 21:15:43 +10:00
if self.window.dimensions.is_none() {
self.window.dimensions = Some((1024, 768));
}
// building
2017-01-29 01:00:17 +11:00
let w = try!(platform::Window2::new(events_loop.events_loop.clone(), &self.window, &self.platform_specific));
Ok(Window { window: w })
}
}
impl Window {
2017-05-11 10:10:07 +10:00
/// Creates a new Window for platforms where this is appropriate.
///
2017-01-29 01:33:54 +11:00
/// This function is equivalent to `WindowBuilder::new().build(events_loop)`.
///
/// 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> {
let builder = WindowBuilder::new();
2017-01-29 01:00:17 +11:00
builder.build(events_loop)
}
/// 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
/// 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)
}
/// 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()
}
/// 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.
#[inline]
pub fn get_inner_size_points(&self) -> Option<(u32, u32)> {
self.window.get_inner_size()
}
/// 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)
})
}
/// 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)
}
/// DEPRECATED. Gets the native platform specific display for this window.
/// This is typically only required when integrating with
/// other libraries that need this information.
2016-11-03 19:49:19 +11:00
#[deprecated]
#[inline]
pub unsafe fn platform_display(&self) -> *mut libc::c_void {
self.window.platform_display()
}
/// DEPRECATED. Gets the native platform specific window handle. This is
/// typically only required when integrating with other libraries
/// that need this information.
2016-11-03 19:49:19 +11:00
#[deprecated]
#[inline]
pub unsafe fn platform_window(&self) -> *mut libc::c_void {
self.window.platform_window()
}
/// 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]
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)
}
2017-05-11 10:10:07 +10:00
/// Sets how winit handles the cursor. See the documentation of `CursorState` for details.
///
/// Has no effect on Android.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn set_cursor_state(&self, state: CursorState) -> Result<(), String> {
self.window.set_cursor_state(state)
}
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
}
}
/// 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>,
}
impl Iterator for AvailableMonitorsIter {
2015-09-24 17:11:59 +10:00
type Item = MonitorId;
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-09-21 22:42:05 +10:00
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
self.data.size_hint()
}
}
/// Returns the list of all available monitors.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn get_available_monitors() -> AvailableMonitorsIter {
2015-04-02 17:27:32 +11:00
let data = platform::get_available_monitors();
AvailableMonitorsIter{ data: data.into_iter() }
}
/// Returns the primary monitor of the system.
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())
}
/// Identifier for a monitor.
2015-09-24 17:11:59 +10:00
pub struct MonitorId(platform::MonitorId);
2015-09-24 17:11:59 +10:00
impl MonitorId {
/// Returns a human-readable name of the monitor.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn get_name(&self) -> Option<String> {
2015-09-24 17:11:59 +10:00
let &MonitorId(ref id) = self;
id.get_name()
}
/// Returns the native platform identifier for this monitor.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn get_native_identifier(&self) -> NativeMonitorId {
2015-09-24 17:11:59 +10:00
let &MonitorId(ref id) = self;
id.get_native_identifier()
}
/// Returns the number of pixels currently displayed on the monitor.
2015-09-21 22:42:05 +10:00
#[inline]
pub fn get_dimensions(&self) -> (u32, u32) {
2015-09-24 17:11:59 +10:00
let &MonitorId(ref id) = self;
id.get_dimensions()
}
}