pub struct Window { /* private fields */ }
Expand description
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::CloseRequested, .. } => {
ControlFlow::Break
},
_ => ControlFlow::Continue,
}
});
Implementations§
source§impl Window
impl Window
sourcepub fn new(events_loop: &EventsLoop) -> Result<Window, CreationError>
pub 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.
sourcepub fn set_title(&self, title: &str)
pub fn set_title(&self, title: &str)
Modifies the title of the window.
This is a no-op if the window has already been closed.
sourcepub fn get_position(&self) -> Option<(i32, i32)>
pub 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.
sourcepub fn get_inner_position(&self) -> Option<(i32, i32)>
pub fn get_inner_position(&self) -> Option<(i32, i32)>
Returns the position of the top-left hand corner of the window’s client area relative to the top-left hand corner of the desktop.
The same conditions that apply to get_position
apply to this method.
sourcepub fn set_position(&self, x: i32, y: i32)
pub fn set_position(&self, x: i32, y: i32)
Modifies the position of the window.
See get_position
for more information about the coordinates.
This is a no-op if the window has already been closed.
sourcepub fn get_inner_size(&self) -> Option<(u32, u32)>
pub fn get_inner_size(&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 that need to be supplied to glViewport
.
Returns None
if the window no longer exists.
sourcepub fn get_inner_size_points(&self) -> Option<(u32, u32)>
👎Deprecated
pub 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.
DEPRECATED
sourcepub fn get_inner_size_pixels(&self) -> Option<(u32, u32)>
👎Deprecated
pub 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.
DEPRECATED
sourcepub fn get_outer_size(&self) -> Option<(u32, u32)>
pub 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.
sourcepub fn set_inner_size(&self, x: u32, y: u32)
pub fn set_inner_size(&self, x: u32, y: u32)
Modifies the inner size of the window.
See get_inner_size
for more information about the values.
This is a no-op if the window has already been closed.
sourcepub fn set_min_dimensions(&self, dimensions: Option<(u32, u32)>)
pub fn set_min_dimensions(&self, dimensions: Option<(u32, u32)>)
Sets a minimum dimension size for the window.
Width and height are in pixels.
sourcepub fn set_max_dimensions(&self, dimensions: Option<(u32, u32)>)
pub fn set_max_dimensions(&self, dimensions: Option<(u32, u32)>)
Sets a maximum dimension size for the window.
Width and height are in pixels.
sourcepub fn set_resizable(&self, resizable: bool)
pub fn set_resizable(&self, resizable: bool)
Sets whether the window is resizable or not.
Note that making the window unresizable doesn’t exempt you from handling Resized
, as that event can still be
triggered by DPI scaling, entering fullscreen mode, etc.
Platform-specific
This only has an effect on desktop platforms.
Due to a bug in XFCE, this has no effect on Xfwm.
sourcepub unsafe fn platform_display(&self) -> *mut c_void
👎Deprecated
pub unsafe fn platform_display(&self) -> *mut c_void
DEPRECATED. Gets the native platform specific display for this window. This is typically only required when integrating with other libraries that need this information.
sourcepub unsafe fn platform_window(&self) -> *mut c_void
👎Deprecated
pub unsafe fn platform_window(&self) -> *mut c_void
DEPRECATED. Gets the native platform specific window handle. This is typically only required when integrating with other libraries that need this information.
sourcepub fn set_cursor(&self, cursor: MouseCursor)
pub fn set_cursor(&self, cursor: MouseCursor)
Modifies the mouse cursor of the window. Has no effect on Android.
sourcepub fn hidpi_factor(&self) -> f32
pub 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.
Platform-specific
On X11 the DPI factor can be overridden using the WINIT_HIDPI_FACTOR
environment
variable.
sourcepub fn set_cursor_position(&self, x: i32, y: i32) -> Result<(), ()>
pub fn set_cursor_position(&self, x: i32, y: i32) -> Result<(), ()>
Changes the position of the cursor in window coordinates.
sourcepub fn set_cursor_state(&self, state: CursorState) -> Result<(), String>
pub 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.
sourcepub fn set_maximized(&self, maximized: bool)
pub fn set_maximized(&self, maximized: bool)
Sets the window to maximized or back
sourcepub fn set_fullscreen(&self, monitor: Option<MonitorId>)
pub fn set_fullscreen(&self, monitor: Option<MonitorId>)
Sets the window to fullscreen or back
sourcepub fn set_decorations(&self, decorations: bool)
pub fn set_decorations(&self, decorations: bool)
Turn window decorations on or off.
sourcepub fn set_always_on_top(&self, always_on_top: bool)
pub fn set_always_on_top(&self, always_on_top: bool)
Change whether or not the window will always be on top of other windows.
sourcepub fn set_window_icon(&self, window_icon: Option<Icon>)
pub fn set_window_icon(&self, window_icon: Option<Icon>)
Sets the window icon. On Windows and X11, this is typically the small icon in the top-left corner of the titlebar.
For more usage notes, see WindowBuilder::with_window_icon
.
Platform-specific
This only has an effect on Windows and X11.
sourcepub fn set_ime_spot(&self, x: i32, y: i32)
pub fn set_ime_spot(&self, x: i32, y: i32)
Sets location of IME candidate box in client area coordinates relative to the top left.
sourcepub fn get_current_monitor(&self) -> MonitorId
pub fn get_current_monitor(&self) -> MonitorId
Returns the monitor on which the window currently resides