pub struct GlWindow { /* private fields */ }
Expand description
Represents an OpenGL context and a Window with which it is associated.
Example
let mut events_loop = glutin::EventsLoop::new();
let window = glutin::WindowBuilder::new();
let context = glutin::ContextBuilder::new();
let gl_window = glutin::GlWindow::new(window, context, &events_loop).unwrap();
unsafe { gl_window.make_current().unwrap() };
loop {
events_loop.poll_events(|event| {
match event {
// process events here
_ => ()
}
});
// draw everything here
gl_window.swap_buffers();
std::thread::sleep(std::time::Duration::from_millis(17));
}
Implementations§
source§impl GlWindow
impl GlWindow
sourcepub fn new(
window_builder: WindowBuilder,
context_builder: ContextBuilder<'_>,
events_loop: &EventsLoop
) -> Result<Self, CreationError>
pub fn new( window_builder: WindowBuilder, context_builder: ContextBuilder<'_>, events_loop: &EventsLoop ) -> Result<Self, CreationError>
Builds the given window along with the associated GL context, returning the pair as a
GlWindow
.
Error should be very rare and only occur in case of permission denied, incompatible system, out of memory, etc.
Methods from Deref<Target = Window>§
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<LogicalPosition>
pub fn get_position(&self) -> Option<LogicalPosition>
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<LogicalPosition>
pub fn get_inner_position(&self) -> Option<LogicalPosition>
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, position: LogicalPosition)
pub fn set_position(&self, position: LogicalPosition)
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<LogicalSize>
pub fn get_inner_size(&self) -> Option<LogicalSize>
Returns the logical size of the window’s client area.
The client area is the content of the window, excluding the title bar and borders.
Converting the returned LogicalSize
to PhysicalSize
produces the size your framebuffer should be.
Returns None
if the window no longer exists.
sourcepub fn get_outer_size(&self) -> Option<LogicalSize>
pub fn get_outer_size(&self) -> Option<LogicalSize>
Returns the logical size of the entire window.
These dimensions include the title bar and borders. If you don’t want that (and you usually don’t),
use get_inner_size
instead.
Returns None
if the window no longer exists.
sourcepub fn set_inner_size(&self, size: LogicalSize)
pub fn set_inner_size(&self, size: LogicalSize)
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<LogicalSize>)
pub fn set_min_dimensions(&self, dimensions: Option<LogicalSize>)
Sets a minimum dimension size for the window.
sourcepub fn set_max_dimensions(&self, dimensions: Option<LogicalSize>)
pub fn set_max_dimensions(&self, dimensions: Option<LogicalSize>)
Sets a maximum dimension size for the window.
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 fn get_hidpi_factor(&self) -> f64
pub fn get_hidpi_factor(&self) -> f64
Returns the DPI factor that can be used to map logical pixels to physical pixels, and vice versa.
See the dpi
module for more information.
Platform-specific
- X11: Can be overridden using the
WINIT_HIDPI_FACTOR
environment variable. - Android: Always returns 1.0.
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 set_cursor_position(
&self,
position: LogicalPosition
) -> Result<(), String>
pub fn set_cursor_position( &self, position: LogicalPosition ) -> Result<(), String>
Changes the position of the cursor in window coordinates.
sourcepub fn grab_cursor(&self, grab: bool) -> Result<(), String>
pub fn grab_cursor(&self, grab: bool) -> Result<(), String>
Grabs the cursor, preventing it from leaving the window.
Platform-specific
On macOS, this presently merely locks the cursor in a fixed location, which looks visually awkward.
This has no effect on Android or iOS.
sourcepub fn hide_cursor(&self, hide: bool)
pub fn hide_cursor(&self, hide: bool)
Hides the cursor, making it invisible but still usable.
Platform-specific
On Windows and X11, the cursor is only hidden within the confines of the window.
On macOS, the cursor is hidden as long as the window has input focus, even if the cursor is outside of the window.
This has no effect on Android or iOS.
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, position: LogicalPosition)
pub fn set_ime_spot(&self, position: LogicalPosition)
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
sourcepub fn get_available_monitors(&self) -> AvailableMonitorsIter ⓘ
pub fn get_available_monitors(&self) -> AvailableMonitorsIter ⓘ
Returns the list of all the monitors available on the system.
This is the same as EventsLoop::get_available_monitors
, and is provided for convenience.
sourcepub fn get_primary_monitor(&self) -> MonitorId
pub fn get_primary_monitor(&self) -> MonitorId
Returns the primary monitor of the system.
This is the same as EventsLoop::get_primary_monitor
, and is provided for convenience.
pub fn id(&self) -> WindowId
Trait Implementations§
source§impl GlContext for GlWindow
impl GlContext for GlWindow
source§unsafe fn make_current(&self) -> Result<(), ContextError>
unsafe fn make_current(&self) -> Result<(), ContextError>
source§fn is_current(&self) -> bool
fn is_current(&self) -> bool
source§fn get_proc_address(&self, addr: &str) -> *const ()
fn get_proc_address(&self, addr: &str) -> *const ()
source§fn swap_buffers(&self) -> Result<(), ContextError>
fn swap_buffers(&self) -> Result<(), ContextError>
source§fn get_pixel_format(&self) -> PixelFormat
fn get_pixel_format(&self) -> PixelFormat
source§fn resize(&self, size: PhysicalSize)
fn resize(&self, size: PhysicalSize)
Auto Trait Implementations§
impl !RefUnwindSafe for GlWindow
impl Send for GlWindow
impl Sync for GlWindow
impl Unpin for GlWindow
impl !UnwindSafe for GlWindow
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.