Struct winit::Window

pub struct Window { /* fields omitted */ }

Represents a window.

Example

use winit::{Event, EventsLoop, Window, WindowEvent, ControlFlow};

let mut events_loop = EventsLoop::new();
let window = Window::new(&events_loop).unwrap();

events_loop.run_forever(|event| {
    match event {
        Event::WindowEvent { event: WindowEvent::Closed, .. } => {
            ControlFlow::Break
        },
        _ => ControlFlow::Continue,
    }
});

Methods

impl Window

fn new(events_loop: &EventsLoop) -> Result<Window, CreationError>

Creates a new Window for platforms where this is appropriate.

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.

fn set_title(&self, title: &str)

Modifies the title of the window.

This is a no-op if the window has already been closed.

fn show(&self)

Shows the window if it was hidden.

Platform-specific

• Has no effect on Android

fn hide(&self)

Hides the window if it was visible.

Platform-specific

• Has no effect on Android

fn get_position(&self) -> Option<(i32, i32)>

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.

fn set_position(&self, x: i32, y: i32)

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.

fn get_inner_size(&self) -> Option<(u32, u32)>

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

fn get_inner_size_points(&self) -> Option<(u32, u32)>

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.

fn get_inner_size_pixels(&self) -> Option<(u32, u32)>

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.

fn get_outer_size(&self) -> Option<(u32, 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.

fn set_inner_size(&self, x: u32, y: u32)

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.

unsafe fn platform_display(&self) -> *mut c_void

Deprecated

DEPRECATED. Gets the native platform specific display for this window. This is typically only required when integrating with other libraries that need this information.

unsafe fn platform_window(&self) -> *mut c_void

Deprecated

DEPRECATED. Gets the native platform specific window handle. This is typically only required when integrating with other libraries that need this information.

fn set_cursor(&self, cursor: MouseCursor)

Modifies the mouse cursor of the window. Has no effect on Android.

fn hidpi_factor(&self) -> f32

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.

fn set_cursor_position(&self, x: i32, y: i32) -> Result<(), ()>

Changes the position of the cursor in window coordinates.

fn set_cursor_state(&self, state: CursorState) -> Result<(), String>

Sets how winit handles the cursor. See the documentation of CursorState for details.

Has no effect on Android.

fn id(&self) -> WindowId

Trait Implementations

impl WindowExt for Window

fn get_xlib_window(&self) -> Option<*mut c_void>

Returns a pointer to the Window object of xlib that is used by this window.

fn get_xlib_display(&self) -> Option<*mut c_void>

Returns a pointer to the Display object of xlib that is used by this window.

fn get_xlib_screen_id(&self) -> Option<*mut c_void>

fn get_xlib_xconnection(&self) -> Option<Arc<XConnection>>

fn get_xcb_connection(&self) -> Option<*mut c_void>

This function returns the underlying xcb_connection_t of an xlib Display.

fn send_xim_spot(&self, x: i16, y: i16)

fn get_wayland_surface(&self) -> Option<*mut c_void>

Returns a pointer to the wl_surface object of wayland that is used by this window.

fn get_wayland_display(&self) -> Option<*mut c_void>

Returns a pointer to the wl_display object of wayland that is used by this window.