Struct MainWindow

pub struct MainWindow { /* private fields */ }

This type represents a winit window and an OpenGL context.

Implementations

impl MainWindow

pub fn new( event_loop: &ActiveEventLoop, wattr: WindowAttributes, ) -> Result<MainWindow>

Creates a MainWindow with default values.

pub fn with_gl_chooser( event_loop: &ActiveEventLoop, wattr: WindowAttributes, f_choose_cfg: impl FnMut(Config, Config) -> Config, ) -> Result<MainWindow>

Creates a MainWindow with your own OpenGL context chooser.

If you don’t have specific OpenGL needs, prefer using MainWindow::new. If you do, consider using a FramebufferObject and do an offscreen rendering instead.

pub fn set_matrix(&mut self, matrix: Option<Matrix3<f32>>)

Sets a custom matrix that converts physical mouse coordinates into logical ones.

pub unsafe fn into_pieces( self, ) -> (PossiblyCurrentContext, Surface<WindowSurface>, Window)

Splits this window into its parts.

Safety

Do not drop the window without dropping the surface first.

pub fn glutin_context(&self) -> &PossiblyCurrentContext

Returns the glutin context.

pub fn create_gl_context(&self) -> Context

Creates a new glow OpenGL context for this window and the selected configuration.

pub fn window(&self) -> &Window

Gets a reference to the winit window.

pub fn surface(&self) -> &Surface<WindowSurface>

Returns the glutin surface.

pub fn to_logical_size<X: Pixel, Y: Pixel>( &self, size: PhysicalSize<X>, ) -> LogicalSize<Y>

Converts the given physical size to a logical size, using the window scale factor.

pub fn to_physical_size<X: Pixel, Y: Pixel>( &self, size: LogicalSize<X>, ) -> PhysicalSize<Y>

Converts the given logical size to a physical size, using the window scale factor.

pub fn to_logical_pos<X: Pixel, Y: Pixel>( &self, pos: PhysicalPosition<X>, ) -> LogicalPosition<Y>

Converts the given physical position to a logical position, using the window scale factor.

pub fn to_physical_pos<X: Pixel, Y: Pixel>( &self, pos: LogicalPosition<X>, ) -> PhysicalPosition<Y>

Converts the given logical position to a physical position, using the window scale factor.

Trait Implementations

impl MainWindowRef for MainWindow

Main implementation of the MainWindowRef trait for an owned MainWindow.

fn window(&self) -> &Window

Gets the Window.

fn pre_render(&mut self)

This runs just before rendering.

fn post_render(&mut self)

This runs just after rendering.

fn resize(&mut self, size: PhysicalSize<u32>) -> LogicalSize<f32>

The window has been resized.

fn ping_user_input(&mut self)

Notifies of a user interaction, for idling purposes.

fn about_to_wait(&mut self, pinged: bool)

There are no more messages, going to idle.

fn transform_position(&self, pos: Vector2) -> Vector2

Transform the given pos by using the current scale factor.

fn scale_factor(&self) -> f32

Gets the scale factor of the window, (HiDPI).

fn set_scale_factor(&self, scale: f32) -> f32

Changes the scale factor.

fn set_cursor(&mut self, cursor: Option<CursorIcon>)

Changes the mouse cursor.