Struct winit::Window
[−]
[src]
pub struct Window { /* fields omitted */ }
Represents an OpenGL context and the Window or environment around it.
Example
let window = Window::new().unwrap(); unsafe { window.make_current() }; loop { for event in window.poll_events() { match(event) { // process events here _ => () } } // draw everything here window.swap_buffers(); std::old_io::timer::sleep(17); }
Methods
impl Window
[src]
pub fn new() -> Result<Window, CreationError>
[src]
Creates a new OpenGL context, and a Window for platforms where this is appropriate.
This function is equivalent to WindowBuilder::new().build()
.
Error should be very rare and only occur in case of permission denied, incompatible system, out of memory, etc.
pub fn set_title(&self, title: &str)
[src]
Modifies the title of the window.
This is a no-op if the window has already been closed.
pub fn show(&self)
[src]
pub fn hide(&self)
[src]
pub fn get_position(&self) -> Option<(i32, i32)>
[src]
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 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.
pub fn set_position(&self, x: i32, y: i32)
[src]
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.
pub fn get_inner_size(&self) -> Option<(u32, u32)>
[src]
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
pub fn get_inner_size_points(&self) -> Option<(u32, u32)>
[src]
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.
pub fn get_inner_size_pixels(&self) -> Option<(u32, u32)>
[src]
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.
pub fn get_outer_size(&self) -> Option<(u32, u32)>
[src]
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.
pub fn set_inner_size(&self, x: u32, y: u32)
[src]
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.
ⓘImportant traits for PollEventsIterator<'a>pub fn poll_events(&self) -> PollEventsIterator
[src]
Returns an iterator that poll for the next event in the window's events queue.
Returns None
if there is no event in the queue.
Contrary to wait_events
, this function never blocks.
ⓘImportant traits for WaitEventsIterator<'a>pub fn wait_events(&self) -> WaitEventsIterator
[src]
Returns an iterator that returns events one by one, blocking if necessary until one is available.
The iterator never returns None
.
pub unsafe fn platform_display(&self) -> *mut c_void
[src]
DEPRECATED. Gets the native platform specific display for this window. This is typically only required when integrating with other libraries that need this information.
pub unsafe fn platform_window(&self) -> *mut c_void
[src]
DEPRECATED. Gets the native platform specific window handle. This is typically only required when integrating with other libraries that need this information.
pub fn create_window_proxy(&self) -> WindowProxy
[src]
Create a window proxy for this window, that can be freely passed to different threads.
pub fn set_window_resize_callback(
&mut self,
callback: Option<fn(_: u32, _: u32)>
)
[src]
&mut self,
callback: Option<fn(_: u32, _: u32)>
)
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.
pub fn set_cursor(&self, cursor: MouseCursor)
[src]
Modifies the mouse cursor of the window. Has no effect on Android.
pub fn hidpi_factor(&self) -> f32
[src]
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.
pub fn set_cursor_position(&self, x: i32, y: i32) -> Result<(), ()>
[src]
Changes the position of the cursor in window coordinates.
pub fn set_cursor_state(&self, state: CursorState) -> Result<(), String>
[src]
Sets how glutin handles the cursor. See the documentation of CursorState
for details.
Has no effect on Android.
Trait Implementations
impl Default for Window
[src]
impl WindowExt for Window
[src]
fn get_xlib_window(&self) -> Option<*mut c_void>
[src]
Returns a pointer to the Window
object of xlib that is used by this window. Read more
fn get_xlib_display(&self) -> Option<*mut c_void>
[src]
Returns a pointer to the Display
object of xlib that is used by this window. Read more
fn get_xlib_screen_id(&self) -> Option<*mut c_void>
[src]
fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>>
[src]
fn get_xcb_connection(&self) -> Option<*mut c_void>
[src]
This function returns the underlying xcb_connection_t
of an xlib Display
. Read more
fn get_wayland_surface(&self) -> Option<*mut c_void>
[src]
Returns a pointer to the wl_surface
object of wayland that is used by this window. Read more
fn get_wayland_display(&self) -> Option<*mut c_void>
[src]
Returns a pointer to the wl_display
object of wayland that is used by this window. Read more
fn get_wayland_client_surface(&self) -> Option<&WlSurface>
[src]
Returns a reference to the WlSurface
object of wayland that is used by this window. Read more
fn get_wayland_client_display(&self) -> Option<&WlDisplay>
[src]
Returns a pointer to the WlDisplay
object of wayland that is used by this window. Read more