[][src]Struct glutin::GlWindow

pub struct GlWindow { /* fields omitted */ }

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));
}

Methods

impl GlWindow
[src]

Builds the given window along with the associated GL context, returning the pair as a GlWindow.

The context made can be shared with:

  • headless contexts made with the shareable_with_windowed_contexts flag set to true; and
  • contexts made when creating a GlWindow.

You are not guaranteed to receive an error if you share a context with an other context which you're not permitted to share it with, as according to:

  • the restrictions stated by us above; and
  • the restrictions imposed on you by the platform your application runs on. (Please refer to README-SHARING.md)

Failing to follow all the context sharing restrictions imposed on you may result in unsafe behavior.

This safe variant of new_shared will panic if you try to share it with an existing context.

Error should be very rare and only occur in case of permission denied, incompatible system out of memory, etc.

Builds the given window along with the associated GL context, returning the pair as a GlWindow.

The context made can be shared with:

  • headless contexts made with the shareable_with_windowed_contexts flag set to true; and
  • contexts made when creating a GlWindow.

You are not guaranteed to receive an error if you share a context with an other context which you're not permitted to share it with, as according to:

  • the restrictions stated by us above; and
  • the restrictions imposed on you by the platform your application runs on. (Please refer to README-SHARING.md)

Failing to follow all the context sharing restrictions imposed on you may result in unsafe behavior.

Error should be very rare and only occur in case of permission denied, incompatible system out of memory, etc.

Borrow the inner Window.

Borrow the inner GL Context.

Swaps the buffers in case of double or triple buffering.

You should call this function every time you have finished rendering, or the image may not be displayed on the screen.

Warning: if you enabled vsync, this function will block until the next time the screen is refreshed. However drivers can choose to override your vsync settings, which means that you can't know in advance whether swap_buffers will block or not.

Returns the pixel format of the main framebuffer of the context.

Resize the context.

Some platforms (macOS, Wayland) require being manually updated when their window or surface is resized.

The easiest way of doing this is to take every Resized window event that is received with a LogicalSize and convert it to a PhysicalSize and pass it into this function.

Methods from Deref<Target = Window>

Modifies the title of the window.

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

Shows the window if it was hidden.

Platform-specific

  • Has no effect on Android

Hides the window if it was visible.

Platform-specific

  • Has no effect on Android

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.

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.

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.

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.

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.

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.

Sets a minimum dimension size for the window.

Sets a maximum dimension size for the window.

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.

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.

Note that this value can change depending on user action (for example if the window is moved to another screen); as such, tracking WindowEvent::HiDpiFactorChanged events is the most robust way to track the DPI you need to use to draw.

Platform-specific

  • X11: Can be overridden using the WINIT_HIDPI_FACTOR environment variable.
  • Android: Always returns 1.0.

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

Changes the position of the cursor in window coordinates.

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.

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.

Sets the window to maximized or back

Sets the window to fullscreen or back

Turn window decorations on or off.

Change whether or not the window will always be on top of other windows.

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.

Sets location of IME candidate box in client area coordinates relative to the top left.

Returns the monitor on which the window currently resides

Important traits for 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.

Returns the primary monitor of the system.

This is the same as EventsLoop::get_primary_monitor, and is provided for convenience.

Trait Implementations

impl GlContext for GlWindow
[src]

Sets the context as the current context.

Returns true if this context is the current one in this thread.

Returns the address of an OpenGL function.

Returns the OpenGL API being used.

impl Deref for GlWindow
[src]

The resulting type after dereferencing.

Dereferences the value.

Auto Trait Implementations

impl Send for GlWindow

impl Sync for GlWindow

Blanket Implementations

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

impl<T> SetParameter for T

Sets value as a parameter of self.

impl<T> Erased for T