Version is represented by (major, minor, revision), used in gettable variable version.

Bit depth of GL display buffers, used in openWindow.

Window or Fullscreen mode, used in openWindow.

Video modes used in gettable variables videoModes and desktopMode.

Key or button state.

Key is represented by either a character key or a special key.

Special key is a key not represented in the 32 - 127 printable ASCII range.

Mouse button is represented by left, right, middle or a number from 0 to 7. Differs from the C API.

Joystick is represent a number from 0 to 15. Differs from the C API.

Joystick parameters

Special features used in enableSpecial and disableSpecial.

Texture flag used in loadTexture2D and loadMemoryTexture2D.

Built-in bitmap font used in renderString.

Callback type for windowCloseCallback. The callback should return True to close the window, and False otherwise.

Callback type for windowSizeCallback.

Callback type for windowRefreshCallback.

Callback type for keyCallback.

Callback type for charCallback.

Callback type for mouseButtonCallback.

Callback type for mousePosCallback.

Callback type for mouseWheelCallback.

Initialize GLFW library. Returns True if successful, False otherwise. Must be called before any other GLFW functions.

Terminate GLFW library after use. Before a program terminates, GLFW has to be terminated in order to free up resources, etc.

Returns the GLFW C library version numbers.

Open a window. Returns True if successful, False otherwise. GLFW applications can only open one window.

If width is zero and height is not, width will be calculated as width = 4/3 height.

If height is zero and width is not, height will be calculated as height = 3/4 width.

If both width and height are zero, width is set to 640 and height to 480.

Display bits default to 0 if no value is specified, meaning that particular buffer is not created.

In fullscreen mode a resolution that best matches the given window dimensions will be chosen.

In fullscreen mode the mouse cursor is hidden by default. To change the visibility of the mouse cursor, see, enableSpecial and disableSpecial.

Close the open window and destroy the associated OpenGL context.

Set the title of the opened window.

Get or set the size of the opened window.

The dimensions denote the size of the client area of the window (i.e. excluding any window borders and decorations).

If the window is in fullscreen mode when setting new dimensions, the video mode will be changed to a resolution that closest matches the given dimensions.

The setter has no effect if the window is iconified.

The OpenGL context is guaranteed to be preserved when the window is resized.

Set the position of the opened window.

The setter has no effect in fullscreen mode or if the window is iconified.

On multi-monitor systems, the behavior of the setter is ill-defined.

Iconify the window.

Restore the window after iconification.

Swap the back and front color buffers of the window. If AutoPollEvent is enabled by enableSpecial (which is the default), it also polls for new events before the swapping.

Set the minimum number of monitor retraces between each each buffer swap performed by swapBuffers. If set to zero, buffer swaps will not be synchronized to the vertical refresh of the monitor.

Get a list of detected VideoModes, the max number of which is limited to 256 for now.

Get the VideoMode of current desktop.

Poll events, such as user input and window events. Upon calling this function, all window states, keyboard states and mouse states are updated. If any related callback functions are registered, these are called during the call of pollEvents.

pollEvents is called implicitly from swapBuffers if AutoPollEvent is enabled (as it is by default).

Wait for events, such as user input and window events. The calling thread will be put to sleep until any event appears in the event queue. When events are ready, the events will be processed just as they are processed by pollEvents.

Return a KeyButtonState, either Release or Press, of the indicated key.

A window must be opened for the function to have any effect, and pollEvents, waitEvents or swapBuffers (with AutoPollEvent enabled) must be called before any keyboard events are recorded and reported by getKey.

Return a KeyButtonState, either Release or Press, of the indicated mouse button.

A window must be opened for the function to have any effect, and pollEvents, waitEvents or swapBuffers (with AutoPollEvent enabled) must be called before any mouse events are recorded and reported by getMouseButton.

Set or get the mouse position.

A window must be opened for the getter to have any effect, and pollEvents, waitEvents or swapBuffers (with AutoPollEvent enabled) must be called before any mouse movements are recorded and reported by mousePos.

When setting the mouse position, if the cursor is visible (not disabled), the cursor will be moved to the specified position, relative to the upper left corner of the window client area and with the Y-axis down. If the cursor is hidden (disabled), only the mouse position that is reported by the getter is changed.

Set or get the mouse wheel position.

A window must be opened for the getter to have any effect, and pollEvents, waitEvents or swapBuffers (with AutoPollEvent enabled) must be called before any wheel movements are recorded and reported by mouseWheel.

Get joystick parameters.

The joystick information is updated every time the getter is queried.

No window has to be opened for joystick information to be available.

Get a certain number of axis positions for the given joystick. If the number of positions requested is is greater than the number available, the unavailable positions will be 0.

The joystick state is updated every time the getter is queried.

No window has to be opened for joystick input to be available.

Get joystick positions. The returned list contains the positions for all available axes for the given joystick.

The joystick state is updated every time the getter is queried.

No window has to be opened for joystick input to be available.

Get joystick button states. The returned list contains the states for all available buttons for the given joystick.

The joystick state is updated every time the getter is queried.

No window has to be opened for joystick input to be available.

Set the function that will be called every time the window size changes.

Set the function that will be called when the window is closed.

Set the function that will be called when the window client area needs to be refreshed, which occurs when any part of the window client area is damaged and needs to be repainted (for instance, if a part of the window that was previously occluded by another window has become visible).

Set the function that will be called when there is a key event, i.e., every time the state of a single key is changed. The reported keys are unaffected by any modifiers (such as SHIFT or ALT).

Set the function that will be called when there is a character event, i.e., every time a key that results in a printable Unicode character is pressed or released. Characters are affected by modifiers (such as SHIFT or ALT).

Set the function that will be called when there is a mouse button event, i.e., every time a mouse button is pressed or released.

Set the function that will be called when there is a mouse motion event, i.e., every time they mouse is moved.

Set the function that will be called when there is a mouse wheel event, i.e., every time the mouse wheel is turned.

Get or set the value of the high precision timer. The time is measured in seconds as a double precision floating point number.

Unless the timer has been set by the programmer, the time is measured as the number of seconds that have passed since initialize was called.

The resolution of the timer depends on which system the program is running on.

Put the calling thread to sleep for the requested period of time in seconds.

The minimum amount of time it is possible to sleep is generally in the range 1ms to 20ms.

Return True if the extension is supported, False otherwise.

Returns the version numbers for the currently used OpenGL implementation.

Read an image from a file specified by the given string and upload the image to OpenGL texture memory.

If BuildMipMaps flag is given, all mipmap levels for the loaded texture are generated and uploaded to texture memory.

Unless the OriginUL flag is given, the origin of the texture is the lower left corner of the loaded image. If OriginUL is given, however, the first pixel is the upper left corner.

For single component images (i.e. gray scale), the texture is uploaded as an alpha mask if the flag AlphaMap is set, otherwise it's uploaded as a luminance texture.

It only supports the Truevision Targa verson 1 file (.tga). Supported pixel formats are: 8-bit gray scale, 8-bit paletted (24/32-bit color), 24-bit true color and 32-bit true color + alpha.

Paletted images are translated into true color or true color + alpha pixel formats.

The read texture is always rescaled to the nearest larger 2^m x 2^n resolution using bilinear interpolation if necessary.

Read an image from the memory buffer (the given byte string) and upload the image to OpenGL texture memory. The rest is similar to loadTexture2D.

Render a text string using the given BitmapFont. Text is rendered through texture, and is only possible with alpha enabled.

Enable a SpecialFeature.

Disable a SpecialFeature.

We use type families to organize Window params that can be retrieved using getParam of the Param class. The value of a param a is of type ParamVal a, where ParamVal is a type family defined as follows:

ParamVal Opened      = Bool
ParamVal Active      = Bool
ParamVal Iconified   = Bool
ParamVal Accelerated = Bool
ParamVal RedBits     = Int
ParamVal GreenBits   = Int
ParamVal BlueBits    = Int
ParamVal AlphaBits   = Int
ParamVal DepthBits   = Int
ParamVal StencilBits = Int

The following are both params and hints that can be set using openWindowHint of the Hint class.

ParamVal RefreshRate         = Int
ParamVal AccumRedBits        = Int
ParamVal AccumGreenBits      = Int
ParamVal AccumBlueBits       = Int
ParamVal AccumAlphaBits      = Int
ParamVal AuxBuffers          = Int
ParamVal Stereo              = Bool
ParamVal NoResize            = Bool
ParamVal FSAASamples         = Int
ParamVal OpenGLVersionMajor  = Int
ParamVal OpenGLVersionMinor  = Int
ParamVal OpenGLForwardCompat = Bool
ParamVal OpenGLDebugContext  = Bool
ParamVal OpenGLProfile       = Profile

OpenGL profiles, used in openWindowHint with OpenGLProfile.