2014-07-27 18:55:37 +10:00
|
|
|
#![feature(unsafe_destructor)]
|
2014-07-30 22:13:42 +10:00
|
|
|
#![unstable]
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-08-03 04:49:48 +10:00
|
|
|
//! The purpose of this library is to provide an OpenGL context on as many
|
|
|
|
//! platforms as possible.
|
|
|
|
//!
|
|
|
|
//! # Building a window
|
2014-09-04 19:38:33 +10:00
|
|
|
//!
|
2014-08-03 04:49:48 +10:00
|
|
|
//! There are two ways to create a window:
|
2014-09-04 19:38:33 +10:00
|
|
|
//!
|
2014-08-03 04:49:48 +10:00
|
|
|
//! - Calling `Window::new()`.
|
|
|
|
//! - Calling `let builder = WindowBuilder::new()` then `builder.build()`.
|
|
|
|
//!
|
|
|
|
//! The first way is the simpliest way and will give you default values.
|
|
|
|
//!
|
|
|
|
//! The second way allows you to customize the way your window and GL context
|
|
|
|
//! will look and behave.
|
2014-10-05 04:17:02 +11:00
|
|
|
//!
|
|
|
|
//! # Features
|
|
|
|
//!
|
|
|
|
//! This crate has two Cargo features: `window` and `headless`.
|
|
|
|
//!
|
|
|
|
//! - `window` allows you to create regular windows and enables the `WindowBuilder` object.
|
|
|
|
//! - `headless` allows you to do headless rendering, and enables
|
|
|
|
//! the `HeadlessRendererBuilder` object.
|
|
|
|
//!
|
|
|
|
//! By default only `window` is enabled.
|
2014-08-03 04:49:48 +10:00
|
|
|
|
2014-11-06 01:22:21 +11:00
|
|
|
extern crate gl_common;
|
2014-07-27 18:55:37 +10:00
|
|
|
extern crate libc;
|
|
|
|
|
2014-12-02 04:24:15 +11:00
|
|
|
#[cfg(target_os = "windows")]
|
|
|
|
extern crate winapi;
|
2014-10-04 23:49:39 +10:00
|
|
|
#[cfg(target_os = "macos")]
|
|
|
|
extern crate cocoa;
|
|
|
|
#[cfg(target_os = "macos")]
|
|
|
|
extern crate core_foundation;
|
2014-11-05 04:03:38 +11:00
|
|
|
#[cfg(target_os = "macos")]
|
|
|
|
extern crate core_graphics;
|
2014-10-04 23:49:39 +10:00
|
|
|
|
2014-07-30 21:11:49 +10:00
|
|
|
pub use events::*;
|
2014-07-27 20:59:45 +10:00
|
|
|
|
2014-08-13 22:52:12 +10:00
|
|
|
use std::default::Default;
|
2015-01-02 18:09:16 +11:00
|
|
|
use std::collections::ring_buf::IntoIter as RingBufIter;
|
2014-08-13 22:52:12 +10:00
|
|
|
|
2014-12-05 06:44:12 +11:00
|
|
|
#[cfg(all(not(target_os = "windows"), not(target_os = "linux"), not(target_os = "macos"), not(target_os = "android")))]
|
|
|
|
use this_platform_is_not_supported;
|
|
|
|
|
2014-08-16 00:12:40 +10:00
|
|
|
#[cfg(target_os = "windows")]
|
2014-10-11 20:06:21 +11:00
|
|
|
#[path="win32/mod.rs"]
|
|
|
|
mod winimpl;
|
2014-08-04 02:30:31 +10:00
|
|
|
#[cfg(target_os = "linux")]
|
2014-10-11 20:06:21 +11:00
|
|
|
#[path="x11/mod.rs"]
|
|
|
|
mod winimpl;
|
2014-08-04 02:30:31 +10:00
|
|
|
#[cfg(target_os = "macos")]
|
2014-10-11 20:06:21 +11:00
|
|
|
#[path="osx/mod.rs"]
|
|
|
|
mod winimpl;
|
2014-09-12 02:13:50 +10:00
|
|
|
#[cfg(target_os = "android")]
|
2014-10-11 20:06:21 +11:00
|
|
|
#[path="android/mod.rs"]
|
|
|
|
mod winimpl;
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-27 20:59:45 +10:00
|
|
|
mod events;
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-31 17:42:50 +10:00
|
|
|
/// Identifier for a monitor.
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-31 17:42:50 +10:00
|
|
|
pub struct MonitorID(winimpl::MonitorID);
|
2014-07-28 04:38:27 +10:00
|
|
|
|
2014-11-06 02:42:18 +11:00
|
|
|
/// Error that can happen while creating a window or a headless renderer.
|
2015-01-04 09:11:59 +11:00
|
|
|
#[derive(Clone, Show, PartialEq, Eq)]
|
2014-11-06 02:42:18 +11:00
|
|
|
pub enum CreationError {
|
|
|
|
OsError(String),
|
2014-12-29 01:53:24 +11:00
|
|
|
NotSupported,
|
2014-11-06 02:42:18 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
impl std::error::Error for CreationError {
|
|
|
|
fn description(&self) -> &str {
|
|
|
|
match self {
|
2014-11-19 16:09:54 +11:00
|
|
|
&CreationError::OsError(ref text) => text.as_slice(),
|
2014-12-29 01:53:24 +11:00
|
|
|
&CreationError::NotSupported => "Some of the requested attributes are not supported",
|
2014-11-06 02:42:18 +11:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-11-19 03:55:26 +11:00
|
|
|
/// All APIs related to OpenGL that you can possibly get while using glutin.
|
2015-01-04 09:11:59 +11:00
|
|
|
#[derive(Show, Clone, Copy, PartialEq, Eq)]
|
2014-11-19 03:55:26 +11:00
|
|
|
pub enum Api {
|
|
|
|
/// The classical OpenGL. Available on Windows, Linux, OS/X.
|
|
|
|
OpenGl,
|
|
|
|
/// OpenGL embedded system. Available on Linux, Android.
|
|
|
|
OpenGlEs,
|
|
|
|
}
|
|
|
|
|
2015-01-13 11:22:37 +11:00
|
|
|
#[derive(Show, Copy)]
|
|
|
|
pub enum MouseCursor {
|
|
|
|
/// The platform-dependent default cursor.
|
|
|
|
Default,
|
|
|
|
/// A simple crosshair.
|
|
|
|
Crosshair,
|
|
|
|
/// A hand (often used to indicate links in web browsers).
|
|
|
|
Hand,
|
|
|
|
/// Self explanatory.
|
|
|
|
Arrow,
|
|
|
|
/// Indicates something is to be moved.
|
|
|
|
Move,
|
|
|
|
/// Indicates text that may be selected or edited.
|
|
|
|
Text,
|
|
|
|
/// Program busy indicator.
|
|
|
|
Wait,
|
|
|
|
/// Help indicator (often rendered as a "?")
|
|
|
|
Help,
|
|
|
|
/// Progress indicator. Shows that processing is being done. But in contrast
|
|
|
|
/// with "Wait" the user may still interact with the program. Often rendered
|
|
|
|
/// as a spinning beach ball, or an arrow with a watch or hourglass.
|
|
|
|
Progress,
|
|
|
|
|
|
|
|
/// Cursor showing that something cannot be done.
|
|
|
|
NotAllowed,
|
|
|
|
ContextMenu,
|
|
|
|
NoneCursor,
|
|
|
|
Cell,
|
|
|
|
VerticalText,
|
|
|
|
Alias,
|
|
|
|
Copy,
|
|
|
|
NoDrop,
|
|
|
|
Grab,
|
|
|
|
Grabbing,
|
|
|
|
AllScroll,
|
|
|
|
ZoomIn,
|
|
|
|
ZoomOut,
|
|
|
|
|
|
|
|
/// Indicate that some edge is to be moved. For example, the 'SeResize' cursor
|
|
|
|
/// is used when the movement starts from the south-east corner of the box.
|
|
|
|
EResize,
|
|
|
|
NResize,
|
|
|
|
NeResize,
|
|
|
|
NwResize,
|
|
|
|
SResize,
|
|
|
|
SeResize,
|
|
|
|
SwResize,
|
|
|
|
WResize,
|
|
|
|
EwResize,
|
|
|
|
NsResize,
|
|
|
|
NeswResize,
|
|
|
|
NwseResize,
|
|
|
|
ColResize,
|
|
|
|
RowResize,
|
|
|
|
}
|
|
|
|
|
2014-08-02 16:24:30 +10:00
|
|
|
/// Object that allows you to build windows.
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-11-25 06:13:32 +11:00
|
|
|
pub struct WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
attribs: BuilderAttribs<'a>
|
|
|
|
}
|
|
|
|
|
2015-01-02 18:09:16 +11:00
|
|
|
/// Attributes
|
2014-12-29 01:08:41 +11:00
|
|
|
struct BuilderAttribs<'a> {
|
|
|
|
headless: bool,
|
|
|
|
strict: bool,
|
|
|
|
sharing: Option<&'a winimpl::Window>,
|
2015-01-13 23:21:36 +11:00
|
|
|
dimensions: Option<(u32, u32)>,
|
2014-08-02 16:24:30 +10:00
|
|
|
title: String,
|
|
|
|
monitor: Option<winimpl::MonitorID>,
|
2015-01-13 23:21:36 +11:00
|
|
|
gl_version: Option<(u32, u32)>,
|
2014-11-10 02:07:58 +11:00
|
|
|
gl_debug: bool,
|
2014-10-26 20:32:51 +11:00
|
|
|
vsync: bool,
|
2014-11-01 19:02:01 +11:00
|
|
|
visible: bool,
|
2014-11-25 05:35:31 +11:00
|
|
|
multisampling: Option<u16>,
|
2014-12-29 02:09:28 +11:00
|
|
|
depth_bits: Option<u8>,
|
|
|
|
stencil_bits: Option<u8>,
|
|
|
|
color_bits: Option<u8>,
|
|
|
|
alpha_bits: Option<u8>,
|
|
|
|
stereoscopy: bool,
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
|
2014-12-29 01:08:41 +11:00
|
|
|
impl BuilderAttribs<'static> {
|
|
|
|
fn new() -> BuilderAttribs<'static> {
|
|
|
|
BuilderAttribs {
|
|
|
|
headless: false,
|
|
|
|
strict: false,
|
2014-11-25 06:13:32 +11:00
|
|
|
sharing: None,
|
2014-08-02 19:23:32 +10:00
|
|
|
dimensions: None,
|
2014-10-27 23:10:10 +11:00
|
|
|
title: "glutin window".to_string(),
|
2014-08-02 16:24:30 +10:00
|
|
|
monitor: None,
|
2014-08-02 19:03:09 +10:00
|
|
|
gl_version: None,
|
2014-11-10 02:07:58 +11:00
|
|
|
gl_debug: cfg!(ndebug),
|
2014-10-26 20:32:51 +11:00
|
|
|
vsync: false,
|
2014-11-01 19:02:01 +11:00
|
|
|
visible: true,
|
2014-11-25 05:35:31 +11:00
|
|
|
multisampling: None,
|
2014-12-29 02:09:28 +11:00
|
|
|
depth_bits: None,
|
|
|
|
stencil_bits: None,
|
|
|
|
color_bits: None,
|
|
|
|
alpha_bits: None,
|
|
|
|
stereoscopy: false,
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
}
|
2014-12-29 01:08:41 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(feature = "window")]
|
|
|
|
impl<'a> WindowBuilder<'a> {
|
|
|
|
/// Initializes a new `WindowBuilder` with default values.
|
|
|
|
pub fn new() -> WindowBuilder<'a> {
|
|
|
|
WindowBuilder {
|
|
|
|
attribs: BuilderAttribs::new(),
|
|
|
|
}
|
|
|
|
}
|
2014-08-02 16:24:30 +10:00
|
|
|
|
2014-08-02 19:04:48 +10:00
|
|
|
/// Requests the window to be of specific dimensions.
|
|
|
|
///
|
|
|
|
/// Width and height are in pixels.
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn with_dimensions(mut self, width: u32, height: u32) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.dimensions = Some((width, height));
|
2014-08-02 16:24:30 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-08-02 19:04:48 +10:00
|
|
|
/// Requests a specific title for the window.
|
2014-11-25 06:13:32 +11:00
|
|
|
pub fn with_title(mut self, title: String) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.title = title;
|
2014-08-02 16:24:30 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-08-02 19:04:48 +10:00
|
|
|
/// Requests fullscreen mode.
|
2014-08-02 19:23:32 +10:00
|
|
|
///
|
|
|
|
/// If you don't specify dimensions for the window, it will match the monitor's.
|
2014-11-25 06:13:32 +11:00
|
|
|
pub fn with_fullscreen(mut self, monitor: MonitorID) -> WindowBuilder<'a> {
|
2014-08-02 16:24:30 +10:00
|
|
|
let MonitorID(monitor) = monitor;
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.monitor = Some(monitor);
|
2014-08-02 16:24:30 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-11-25 06:13:32 +11:00
|
|
|
/// The created window will share all its OpenGL objects with the window in the parameter.
|
|
|
|
///
|
|
|
|
/// There are some exceptions, like FBOs or VAOs. See the OpenGL documentation.
|
|
|
|
pub fn with_shared_lists(mut self, other: &'a Window) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.sharing = Some(&other.window);
|
2014-11-25 06:13:32 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-08-02 19:03:09 +10:00
|
|
|
/// Requests to use a specific OpenGL version.
|
|
|
|
///
|
|
|
|
/// Version is a (major, minor) pair. For example to request OpenGL 3.3
|
|
|
|
/// you would pass `(3, 3)`.
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn with_gl_version(mut self, version: (u32, u32)) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.gl_version = Some(version);
|
2014-08-02 19:03:09 +10:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-11-10 02:07:58 +11:00
|
|
|
/// Sets the *debug* flag for the OpenGL context.
|
|
|
|
///
|
|
|
|
/// The default value for this flag is `cfg!(ndebug)`, which means that it's enabled
|
|
|
|
/// when you run `cargo build` and disabled when you run `cargo build --release`.
|
2014-11-25 06:13:32 +11:00
|
|
|
pub fn with_gl_debug_flag(mut self, flag: bool) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.gl_debug = flag;
|
2014-11-10 02:07:58 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-10-26 20:32:51 +11:00
|
|
|
/// Requests that the window has vsync enabled.
|
2014-11-25 06:13:32 +11:00
|
|
|
pub fn with_vsync(mut self) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.vsync = true;
|
2014-10-26 20:32:51 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-11-01 19:02:01 +11:00
|
|
|
/// Sets whether the window will be initially hidden or visible.
|
2014-11-25 06:13:32 +11:00
|
|
|
pub fn with_visibility(mut self, visible: bool) -> WindowBuilder<'a> {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.visible = visible;
|
2014-11-01 19:02:01 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-11-25 05:35:31 +11:00
|
|
|
/// Sets the multisampling level to request.
|
|
|
|
///
|
|
|
|
/// # Panic
|
|
|
|
///
|
|
|
|
/// Will panic if `samples` is not a power of two.
|
|
|
|
pub fn with_multisampling(mut self, samples: u16) -> WindowBuilder<'a> {
|
|
|
|
use std::num::UnsignedInt;
|
|
|
|
assert!(samples.is_power_of_two());
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.multisampling = Some(samples);
|
2014-11-25 05:35:31 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-12-29 02:09:28 +11:00
|
|
|
/// Sets the number of bits in the depth buffer.
|
|
|
|
pub fn with_depth_buffer(mut self, bits: u8) -> WindowBuilder<'a> {
|
|
|
|
self.attribs.depth_bits = Some(bits);
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets the number of bits in the stencil buffer.
|
|
|
|
pub fn with_stencil_buffer(mut self, bits: u8) -> WindowBuilder<'a> {
|
|
|
|
self.attribs.stencil_bits = Some(bits);
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Sets the number of bits in the color buffer.
|
|
|
|
pub fn with_pixel_format(mut self, color_bits: u8, alpha_bits: u8) -> WindowBuilder<'a> {
|
|
|
|
self.attribs.color_bits = Some(color_bits);
|
|
|
|
self.attribs.alpha_bits = Some(alpha_bits);
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Request the backend to be stereoscopic.
|
|
|
|
pub fn with_stereoscopy(mut self) -> WindowBuilder<'a> {
|
|
|
|
self.attribs.stereoscopy = true;
|
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-08-02 16:24:30 +10:00
|
|
|
/// Builds the window.
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-08-02 16:24:30 +10:00
|
|
|
/// Error should be very rare and only occur in case of permission denied, incompatible system,
|
|
|
|
/// out of memory, etc.
|
2014-11-06 02:42:18 +11:00
|
|
|
pub fn build(mut self) -> Result<Window, CreationError> {
|
2014-08-02 19:23:32 +10:00
|
|
|
// resizing the window to the dimensions of the monitor when fullscreen
|
2014-12-29 01:08:41 +11:00
|
|
|
if self.attribs.dimensions.is_none() && self.attribs.monitor.is_some() {
|
|
|
|
self.attribs.dimensions = Some(self.attribs.monitor.as_ref().unwrap().get_dimensions())
|
2014-08-02 19:23:32 +10:00
|
|
|
}
|
|
|
|
|
|
|
|
// default dimensions
|
2014-12-29 01:08:41 +11:00
|
|
|
if self.attribs.dimensions.is_none() {
|
|
|
|
self.attribs.dimensions = Some((1024, 768));
|
2014-08-02 19:23:32 +10:00
|
|
|
}
|
|
|
|
|
|
|
|
// building
|
2014-12-29 01:08:41 +11:00
|
|
|
winimpl::Window::new(self.attribs).map(|w| Window { window: w })
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
2014-12-29 01:53:24 +11:00
|
|
|
|
|
|
|
/// Builds the window.
|
|
|
|
///
|
|
|
|
/// The context is build in a *strict* way. That means that if the backend couldn't give
|
|
|
|
/// you what you requested, an `Err` will be returned.
|
|
|
|
pub fn build_strict(mut self) -> Result<Window, CreationError> {
|
|
|
|
self.attribs.strict = true;
|
|
|
|
self.build()
|
|
|
|
}
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
/// Object that allows you to build headless contexts.
|
|
|
|
#[cfg(feature = "headless")]
|
|
|
|
pub struct HeadlessRendererBuilder {
|
2014-12-29 01:08:41 +11:00
|
|
|
attribs: BuilderAttribs<'static>,
|
2014-10-05 04:17:02 +11:00
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(feature = "headless")]
|
|
|
|
impl HeadlessRendererBuilder {
|
|
|
|
/// Initializes a new `HeadlessRendererBuilder` with default values.
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn new(width: u32, height: u32) -> HeadlessRendererBuilder {
|
2014-10-05 04:17:02 +11:00
|
|
|
HeadlessRendererBuilder {
|
2014-12-29 01:08:41 +11:00
|
|
|
attribs: BuilderAttribs {
|
|
|
|
headless: true,
|
|
|
|
dimensions: Some((width, height)),
|
|
|
|
.. BuilderAttribs::new()
|
|
|
|
},
|
2014-10-05 04:17:02 +11:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Requests to use a specific OpenGL version.
|
|
|
|
///
|
|
|
|
/// Version is a (major, minor) pair. For example to request OpenGL 3.3
|
|
|
|
/// you would pass `(3, 3)`.
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn with_gl_version(mut self, version: (u32, u32)) -> HeadlessRendererBuilder {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.gl_version = Some(version);
|
2014-10-05 04:17:02 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-11-10 02:07:58 +11:00
|
|
|
/// Sets the *debug* flag for the OpenGL context.
|
|
|
|
///
|
|
|
|
/// The default value for this flag is `cfg!(ndebug)`, which means that it's enabled
|
|
|
|
/// when you run `cargo build` and disabled when you run `cargo build --release`.
|
|
|
|
pub fn with_gl_debug_flag(mut self, flag: bool) -> HeadlessRendererBuilder {
|
2014-12-29 01:08:41 +11:00
|
|
|
self.attribs.gl_debug = flag;
|
2014-11-10 02:07:58 +11:00
|
|
|
self
|
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
/// Builds the headless context.
|
|
|
|
///
|
|
|
|
/// Error should be very rare and only occur in case of permission denied, incompatible system,
|
|
|
|
/// out of memory, etc.
|
2014-11-06 02:42:18 +11:00
|
|
|
pub fn build(self) -> Result<HeadlessContext, CreationError> {
|
2014-12-29 01:08:41 +11:00
|
|
|
winimpl::HeadlessContext::new(self.attribs).map(|w| HeadlessContext { context: w })
|
2014-10-05 04:17:02 +11:00
|
|
|
}
|
2014-12-29 01:53:24 +11:00
|
|
|
|
|
|
|
/// Builds the headless context.
|
|
|
|
///
|
|
|
|
/// The context is build in a *strict* way. That means that if the backend couldn't give
|
|
|
|
/// you what you requested, an `Err` will be returned.
|
|
|
|
pub fn build_strict(mut self) -> Result<HeadlessContext, CreationError> {
|
|
|
|
self.attribs.strict = true;
|
|
|
|
self.build()
|
|
|
|
}
|
2014-10-05 04:17:02 +11:00
|
|
|
}
|
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Represents an OpenGL context and the Window or environment around it.
|
|
|
|
///
|
|
|
|
/// # Example
|
|
|
|
///
|
2014-08-07 17:33:28 +10:00
|
|
|
/// ```ignore
|
2014-08-02 16:24:30 +10:00
|
|
|
/// let window = Window::new().unwrap();
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-07-31 02:12:39 +10:00
|
|
|
/// unsafe { window.make_current() };
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-07-30 22:13:42 +10:00
|
|
|
/// loop {
|
2014-08-02 19:07:29 +10:00
|
|
|
/// for event in window.poll_events() {
|
2014-07-30 22:13:42 +10:00
|
|
|
/// // process events here
|
|
|
|
/// _ => ()
|
|
|
|
/// }
|
|
|
|
/// }
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-07-30 22:13:42 +10:00
|
|
|
/// // draw everything here
|
|
|
|
///
|
|
|
|
/// window.swap_buffers();
|
|
|
|
/// std::io::timer::sleep(17);
|
|
|
|
/// }
|
2014-07-30 22:18:31 +10:00
|
|
|
/// ```
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-30 22:18:31 +10:00
|
|
|
pub struct Window {
|
|
|
|
window: winimpl::Window,
|
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-08-13 22:52:12 +10:00
|
|
|
impl Default for Window {
|
|
|
|
fn default() -> Window {
|
|
|
|
Window::new().unwrap()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-27 20:59:45 +10:00
|
|
|
impl Window {
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Creates a new OpenGL context, and a Window for platforms where this is appropriate.
|
|
|
|
///
|
2014-08-02 16:24:30 +10:00
|
|
|
/// This function is equivalent to `WindowBuilder::new().build()`.
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Error should be very rare and only occur in case of permission denied, incompatible system,
|
|
|
|
/// out of memory, etc.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-11-06 02:42:18 +11:00
|
|
|
pub fn new() -> Result<Window, CreationError> {
|
2014-08-02 16:24:30 +10:00
|
|
|
let builder = WindowBuilder::new();
|
|
|
|
builder.build()
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Returns true if the window has previously been closed by the user.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-07-30 21:29:28 +10:00
|
|
|
pub fn is_closed(&self) -> bool {
|
|
|
|
self.window.is_closed()
|
|
|
|
}
|
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Returns true if the window has previously been closed by the user.
|
2014-07-30 21:29:28 +10:00
|
|
|
#[inline]
|
|
|
|
#[deprecated = "Use is_closed instead"]
|
2014-07-27 20:59:45 +10:00
|
|
|
pub fn should_close(&self) -> bool {
|
2014-07-30 21:29:28 +10:00
|
|
|
self.is_closed()
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-27 20:59:45 +10:00
|
|
|
/// Modifies the title of the window.
|
2014-07-30 22:13:42 +10:00
|
|
|
///
|
|
|
|
/// This is a no-op if the window has already been closed.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
|
|
|
pub fn set_title(&self, title: &str) {
|
|
|
|
self.window.set_title(title)
|
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-11-01 19:02:01 +11:00
|
|
|
/// 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()
|
|
|
|
}
|
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Returns the position of the top-left hand corner of the window relative to the
|
|
|
|
/// top-left hand corner of the desktop.
|
|
|
|
///
|
|
|
|
/// Note that the top-left hand corner of the desktop is not necessarly 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.
|
2014-07-30 21:10:17 +10:00
|
|
|
///
|
|
|
|
/// Returns `None` if the window no longer exists.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn get_position(&self) -> Option<(i32, i32)> {
|
2014-07-27 20:59:45 +10:00
|
|
|
self.window.get_position()
|
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// 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.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn set_position(&self, x: i32, y: i32) {
|
2014-07-27 20:59:45 +10:00
|
|
|
self.window.set_position(x, y)
|
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-30 22:13:42 +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.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn get_inner_size(&self) -> Option<(u32, u32)> {
|
2014-07-28 06:31:00 +10:00
|
|
|
self.window.get_inner_size()
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-30 22:13:42 +10: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.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn get_outer_size(&self) -> Option<(u32, u32)> {
|
2014-07-28 06:31:00 +10:00
|
|
|
self.window.get_outer_size()
|
|
|
|
}
|
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// 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.
|
2014-07-28 06:31:00 +10:00
|
|
|
#[inline]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn set_inner_size(&self, x: u32, y: u32) {
|
2014-07-28 06:31:00 +10:00
|
|
|
self.window.set_inner_size(x, y)
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-08-02 16:24:30 +10:00
|
|
|
/// Returns an iterator to all the events that are currently in the window's events queue.
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Contrary to `wait_events`, this function never blocks.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-08-02 16:24:30 +10:00
|
|
|
pub fn poll_events(&self) -> PollEventsIterator {
|
2015-01-02 18:09:16 +11:00
|
|
|
PollEventsIterator { data: self.window.poll_events().into_iter() }
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-08-02 16:24:30 +10:00
|
|
|
/// Waits for an event, then returns an iterator to all the events that are currently
|
|
|
|
/// in the window's events queue.
|
2014-09-04 19:38:33 +10:00
|
|
|
///
|
2014-08-02 16:24:30 +10:00
|
|
|
/// If there are no events in queue when you call the function,
|
|
|
|
/// this function will block until there is one.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-08-02 16:24:30 +10:00
|
|
|
pub fn wait_events(&self) -> WaitEventsIterator {
|
2015-01-02 18:09:16 +11:00
|
|
|
WaitEventsIterator { data: self.window.wait_events().into_iter() }
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
|
|
|
|
2014-07-31 02:12:39 +10:00
|
|
|
/// Sets the context as the current context.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-07-31 02:12:39 +10:00
|
|
|
pub unsafe fn make_current(&self) {
|
2014-07-27 20:59:45 +10:00
|
|
|
self.window.make_current()
|
|
|
|
}
|
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Returns the address of an OpenGL function.
|
|
|
|
///
|
|
|
|
/// Contrary to `wglGetProcAddress`, all available OpenGL functions return an address.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
2014-08-11 18:32:33 +10:00
|
|
|
pub fn get_proc_address(&self, addr: &str) -> *const libc::c_void {
|
|
|
|
self.window.get_proc_address(addr) as *const libc::c_void
|
2014-07-27 20:59:45 +10:00
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
|
2014-07-30 22:13:42 +10:00
|
|
|
/// Swaps the buffers in case of double or triple buffering.
|
|
|
|
///
|
|
|
|
/// You should call this function every time you have finished rendering, or the image
|
|
|
|
/// may not be displayed on the screen.
|
2014-10-26 20:32:51 +11:00
|
|
|
///
|
|
|
|
/// **Warning**: if you enabled vsync, this function will block until the next time the screen
|
|
|
|
/// is refreshed. However drivers can choose to override your vsync settings, which means that
|
|
|
|
/// you can't know in advance whether `swap_buffers` will block or not.
|
2014-07-27 20:59:45 +10:00
|
|
|
#[inline]
|
|
|
|
pub fn swap_buffers(&self) {
|
|
|
|
self.window.swap_buffers()
|
2014-07-27 18:55:37 +10:00
|
|
|
}
|
2014-10-24 16:20:25 +11:00
|
|
|
|
|
|
|
/// Gets the native platform specific display for this window.
|
|
|
|
/// This is typically only required when integrating with
|
|
|
|
/// other libraries that need this information.
|
|
|
|
#[inline]
|
2014-10-24 19:12:03 +11:00
|
|
|
pub unsafe fn platform_display(&self) -> *mut libc::c_void {
|
2014-10-24 16:20:25 +11:00
|
|
|
self.window.platform_display()
|
|
|
|
}
|
2014-11-19 03:55:26 +11:00
|
|
|
|
|
|
|
/// Returns the API that is currently provided by this window.
|
|
|
|
///
|
|
|
|
/// - On Windows and OS/X, this always returns `OpenGl`.
|
|
|
|
/// - On Android, this always returns `OpenGlEs`.
|
|
|
|
/// - On Linux, it must be checked at runtime.
|
|
|
|
pub fn get_api(&self) -> Api {
|
|
|
|
self.window.get_api()
|
|
|
|
}
|
2014-12-17 15:49:11 +11:00
|
|
|
|
|
|
|
/// Create a window proxy for this window, that can be freely
|
|
|
|
/// passed to different threads.
|
|
|
|
#[inline]
|
|
|
|
pub fn create_window_proxy(&self) -> WindowProxy {
|
|
|
|
WindowProxy {
|
|
|
|
proxy: self.window.create_window_proxy()
|
|
|
|
}
|
|
|
|
}
|
2014-12-16 16:49:22 +11:00
|
|
|
|
|
|
|
/// Sets a resize callback that is called by Mac (and potentially other
|
|
|
|
/// operating systems) during resize operations. This can be used to repaint
|
|
|
|
/// during window resizing.
|
2014-12-19 06:06:56 +11:00
|
|
|
#[experimental]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn set_window_resize_callback(&mut self, callback: Option<fn(u32, u32)>) {
|
2014-12-16 16:49:22 +11:00
|
|
|
self.window.set_window_resize_callback(callback);
|
|
|
|
}
|
2015-01-13 11:22:37 +11:00
|
|
|
|
|
|
|
/// Modifies the mouse cursor of the window.
|
2015-01-13 20:23:34 +11:00
|
|
|
/// Has no effect on Android.
|
2015-01-13 11:22:37 +11:00
|
|
|
pub fn set_cursor(&mut self, cursor: MouseCursor) {
|
|
|
|
self.window.set_cursor(cursor);
|
|
|
|
}
|
2014-07-27 18:55:37 +10:00
|
|
|
}
|
2014-07-31 17:56:53 +10:00
|
|
|
|
2014-11-06 01:22:21 +11:00
|
|
|
#[cfg(feature = "window")]
|
|
|
|
impl gl_common::GlFunctionsSource for Window {
|
|
|
|
fn get_proc_addr(&self, addr: &str) -> *const libc::c_void {
|
|
|
|
self.get_proc_address(addr)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-12-17 15:49:11 +11:00
|
|
|
/// Represents a thread safe subset of operations that can be called
|
|
|
|
/// on a window. This structure can be safely cloned and sent between
|
|
|
|
/// threads.
|
|
|
|
///
|
|
|
|
#[cfg(feature = "window")]
|
2015-01-04 09:11:59 +11:00
|
|
|
#[derive(Clone)]
|
2014-12-17 15:49:11 +11:00
|
|
|
pub struct WindowProxy {
|
|
|
|
proxy: winimpl::WindowProxy,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(feature = "window")]
|
|
|
|
impl WindowProxy {
|
|
|
|
|
|
|
|
/// Triggers a blocked event loop to wake up. This is
|
|
|
|
/// typically called when another thread wants to wake
|
|
|
|
/// up the blocked rendering thread to cause a refresh.
|
|
|
|
#[inline]
|
|
|
|
pub fn wakeup_event_loop(&self) {
|
|
|
|
self.proxy.wakeup_event_loop();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
/// Represents a headless OpenGL context.
|
|
|
|
#[cfg(feature = "headless")]
|
|
|
|
pub struct HeadlessContext {
|
|
|
|
context: winimpl::HeadlessContext,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[cfg(feature = "headless")]
|
|
|
|
impl HeadlessContext {
|
|
|
|
/// Creates a new OpenGL context
|
|
|
|
/// Sets the context as the current context.
|
|
|
|
#[inline]
|
|
|
|
pub unsafe fn make_current(&self) {
|
|
|
|
self.context.make_current()
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the address of an OpenGL function.
|
|
|
|
///
|
|
|
|
/// Contrary to `wglGetProcAddress`, all available OpenGL functions return an address.
|
|
|
|
#[inline]
|
|
|
|
pub fn get_proc_address(&self, addr: &str) -> *const libc::c_void {
|
|
|
|
self.context.get_proc_address(addr) as *const libc::c_void
|
|
|
|
}
|
2014-11-19 03:55:26 +11:00
|
|
|
|
|
|
|
/// Returns the API that is currently provided by this window.
|
|
|
|
///
|
|
|
|
/// See `Window::get_api` for more infos.
|
|
|
|
pub fn get_api(&self) -> Api {
|
|
|
|
self.context.get_api()
|
|
|
|
}
|
2014-12-16 16:49:22 +11:00
|
|
|
|
2014-12-19 06:06:56 +11:00
|
|
|
#[experimental]
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn set_window_resize_callback(&mut self, _: Option<fn(u32, u32)>) {
|
2014-12-16 16:49:22 +11:00
|
|
|
}
|
2014-10-05 04:17:02 +11:00
|
|
|
}
|
|
|
|
|
2014-11-06 01:22:21 +11:00
|
|
|
#[cfg(feature = "headless")]
|
|
|
|
impl gl_common::GlFunctionsSource for HeadlessContext {
|
|
|
|
fn get_proc_addr(&self, addr: &str) -> *const libc::c_void {
|
|
|
|
self.get_proc_address(addr)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-08-02 16:24:30 +10:00
|
|
|
/// An iterator for the `poll_events` function.
|
|
|
|
// Implementation note: we retreive the list once, then serve each element by one by one.
|
|
|
|
// This may change in the future.
|
|
|
|
pub struct PollEventsIterator<'a> {
|
2015-01-02 18:09:16 +11:00
|
|
|
data: RingBufIter<Event>,
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
|
2015-01-05 13:46:46 +11:00
|
|
|
impl<'a> Iterator for PollEventsIterator<'a> {
|
|
|
|
type Item = Event;
|
2014-08-02 16:24:30 +10:00
|
|
|
fn next(&mut self) -> Option<Event> {
|
2015-01-02 18:09:16 +11:00
|
|
|
self.data.next()
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// An iterator for the `wait_events` function.
|
|
|
|
// Implementation note: we retreive the list once, then serve each element by one by one.
|
|
|
|
// This may change in the future.
|
|
|
|
pub struct WaitEventsIterator<'a> {
|
2015-01-02 18:09:16 +11:00
|
|
|
data: RingBufIter<Event>,
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
|
2015-01-05 13:46:46 +11:00
|
|
|
impl<'a> Iterator for WaitEventsIterator<'a> {
|
|
|
|
type Item = Event;
|
2014-08-02 16:24:30 +10:00
|
|
|
fn next(&mut self) -> Option<Event> {
|
2015-01-02 18:09:16 +11:00
|
|
|
self.data.next()
|
2014-08-02 16:24:30 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-07-31 17:56:53 +10: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.
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-31 17:56:53 +10:00
|
|
|
pub struct AvailableMonitorsIter {
|
2015-01-02 18:09:16 +11:00
|
|
|
data: RingBufIter<winimpl::MonitorID>,
|
2014-07-31 17:56:53 +10:00
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2015-01-05 13:46:46 +11:00
|
|
|
impl Iterator for AvailableMonitorsIter {
|
|
|
|
type Item = MonitorID;
|
2014-07-31 17:56:53 +10:00
|
|
|
fn next(&mut self) -> Option<MonitorID> {
|
2015-01-02 18:09:16 +11:00
|
|
|
self.data.next().map(|id| MonitorID(id))
|
2014-07-31 17:56:53 +10:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the list of all available monitors.
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-31 17:56:53 +10:00
|
|
|
pub fn get_available_monitors() -> AvailableMonitorsIter {
|
|
|
|
let data = winimpl::get_available_monitors();
|
2015-01-02 18:09:16 +11:00
|
|
|
AvailableMonitorsIter{ data: data.into_iter() }
|
2014-07-31 17:56:53 +10:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Returns the primary monitor of the system.
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-31 17:56:53 +10:00
|
|
|
pub fn get_primary_monitor() -> MonitorID {
|
|
|
|
MonitorID(winimpl::get_primary_monitor())
|
|
|
|
}
|
|
|
|
|
2014-10-05 04:17:02 +11:00
|
|
|
#[cfg(feature = "window")]
|
2014-07-31 17:56:53 +10:00
|
|
|
impl MonitorID {
|
|
|
|
/// Returns a human-readable name of the monitor.
|
|
|
|
pub fn get_name(&self) -> Option<String> {
|
2014-07-31 18:52:05 +10:00
|
|
|
let &MonitorID(ref id) = self;
|
|
|
|
id.get_name()
|
2014-07-31 17:56:53 +10:00
|
|
|
}
|
2014-08-02 19:17:49 +10:00
|
|
|
|
|
|
|
/// Returns the number of pixels currently displayed on the monitor.
|
2015-01-13 23:21:36 +11:00
|
|
|
pub fn get_dimensions(&self) -> (u32, u32) {
|
2014-08-02 19:17:49 +10:00
|
|
|
let &MonitorID(ref id) = self;
|
|
|
|
id.get_dimensions()
|
|
|
|
}
|
2014-07-31 17:56:53 +10:00
|
|
|
}
|