Crate glutin [] [src]

The purpose of this library is to provide an OpenGL context on as many platforms as possible.

Building a window

There are two ways to create a window:

  • Calling Window::new().
  • Calling let builder = WindowBuilder::new() then builder.build().

The first way is the simpliest way and will give you default values.

The second way allows you to customize the way your window and GL context will look and behave.

Features

This crate has two Cargo features: window and headless.

  • window allows you to create regular windows and enables the WindowBuilder object.
  • headless allows you to do headless rendering, and enables the HeadlessRendererBuilder object.

By default only window is enabled.

Modules

os

Contains traits with platform-specific methods in them.

Structs

AvailableMonitorsIter

An iterator for the list of available monitors.

EventsLoop

Provides a way to retreive events from the windows that are registered to it.

GlAttributes

Attributes to use when creating an OpenGL context.

HeadlessContext

Represents a headless OpenGL context.

HeadlessRendererBuilder

Object that allows you to build headless contexts.

MonitorId

Identifier for a monitor.

PixelFormat

Describes a possible format. Unused.

PixelFormatRequirements

Describes how the backend should choose a pixel format.

Touch

Represents touch event

Window

Represents an OpenGL context and the Window or environment around it.

WindowAttributes

Attributes to use when creating a window.

WindowBuilder

Object that allows you to build windows.

WindowId

Identifier of a window. Unique for each window.

Enums

Api

All APIs related to OpenGL that you can possibly get while using glutin.

ContextError

Error that can happen when manipulating an OpenGL context.

CreationError

Error that can happen while creating a window or a headless renderer.

CursorState

Describes how glutin handles the cursor.

ElementState
Event
GlProfile

Describes the requested OpenGL context profiles.

GlRequest

Describes the OpenGL API and version that are being requested when a context is created.

MouseButton
MouseCursor
MouseScrollDelta
NativeMonitorId

Native platform identifier for a monitor. Different platforms use fundamentally different types to represent a monitor ID.

ReleaseBehavior

The behavior of the driver when you change the current context.

Robustness

Specifies the tolerance of the OpenGL context to faults. If you accept raw OpenGL commands and/or raw shader code from an untrusted source, you should definitely care about this.

TouchPhase
VirtualKeyCode
WindowEvent

Statics

GL_CORE

The minimum core profile GL context. Useful for getting the minimum required GL version while still running on OSX, which often forbids the compatibility profile features.

Traits

GlContext

Trait that describes objects that have access to an OpenGL context.

Functions

get_available_monitors

Returns the list of all available monitors.

get_primary_monitor

Returns the primary monitor of the system.

Type Definitions

ScanCode