GLFW

Introduction

GLFW is an Open Source, multi-platform library for OpenGL, OpenGL ES and Vulkan application development. It provides a simple, platform-independent API for creating windows, contexts and surfaces, reading input, handling events, etc.

GLFW natively supports Windows, macOS and Linux and other Unix-like systems. On Linux both X11 and Wayland is supported.

GLFW is licensed under the zlib/libpng license.

You can download the latest stable release as source or Windows binaries, or fetch the latest branch from GitHub. Each release starting with 3.0 also has a corresponding annotated tag with source and binary archives.

The documentation is available online and is included in all source and binary archives. See the release notes for new features, caveats and deprecations in the latest release. For more details see the version history.

The master branch is the stable integration branch and should always compile and run on all supported platforms, although details of newly added features may change until they have been included in a release. New features and many bug fixes live in other branches until they are stable enough to merge.

If you are new to GLFW, you may find the tutorial for GLFW 3 useful. If you have used GLFW 2 in the past, there is a transition guide for moving to the GLFW 3 API.

Compiling GLFW

GLFW itself requires only the headers and libraries for your OS and window system. It does not need the headers for any context creation API (WGL, GLX, EGL, NSGL, OSMesa) or rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them.

GLFW supports compilation on Windows with Visual C++ 2010 and later, MinGW and MinGW-w64, on macOS with Clang and on Linux and other Unix-like systems with GCC and Clang. It will likely compile in other environments as well, but this is not regularly tested.

There are pre-compiled Windows binaries available for all supported compilers.

See the compilation guide for more information about how to compile GLFW yourself.

Using GLFW

See the documentation for tutorials, guides and the API reference.

Contributing to GLFW

See the contribution guide for more information.

System requirements

GLFW supports Windows XP and later and macOS 10.8 and later. Linux and other Unix-like systems running the X Window System are supported even without a desktop environment or modern extensions, although some features require a running window or clipboard manager. The OSMesa backend requires Mesa 6.3.

See the compatibility guide in the documentation for more information.

Dependencies

GLFW itself depends only on the headers and libraries for your window system.

The (experimental) Wayland backend also depends on the extra-cmake-modules package, which is used to generated Wayland protocol headers.

The examples and test programs depend on a number of tiny libraries. These are located in the deps/ directory.

• getopt_port for examples with command-line options
• TinyCThread for threaded examples
• glad2 for loading OpenGL and Vulkan functions
• linmath.h for linear algebra in examples
• Nuklear for test and example UI
• stb_image_write for writing images to disk

The documentation is generated with Doxygen if CMake can find that tool.

Reporting bugs

Bugs are reported to our issue tracker. Please check the contribution guide for information on what to include when reporting a bug.

Changelog

• Disabled tests and examples by default when built as a CMake subdirectory
• Bugfix: The CMake config-file package used an absolute path and was not relocatable (#1470)
• Bugfix: Video modes with a duplicate screen area were discarded (#1555,#1556)
• [Win32] Bugfix: GLFW_INCLUDE_VULKAN plus VK_USE_PLATFORM_WIN32_KHR caused symbol redefinition (#1524)
• [Win32] Bugfix: The cursor position event was emitted before its cursor enter event (#1490)
• [Win32] Bugfix: The window hint GLFW_MAXIMIZED did not move or resize the window (#1499)
• [Cocoa] Bugfix: glfwSetWindowSize used a bottom-left anchor point (#1553)
• [X11] Bugfix: The CMake files did not check for the XInput headers (#1480)
• [X11] Bugfix: Key names were not updated when the keyboard layout changed (#1462,#1528)
• [NSGL] Removed enforcement of forward-compatible flag for core contexts

Contact

On glfw.org you can find the latest version of GLFW, as well as news, documentation and other information about the project.

If you have questions related to the use of GLFW, we have a forum, and the #glfw IRC channel on Freenode.

If you have a bug to report, a patch to submit or a feature you'd like to request, please file it in the issue tracker on GitHub.

Finally, if you're interested in helping out with the development of GLFW or porting it to your favorite platform, join us on the forum, GitHub or IRC.

Acknowledgements

GLFW exists because people around the world donated their time and lent their skills.

• Bobyshev Alexander
• Matt Arsenault
• David Avedissian
• Keith Bauer
• John Bartholomew
• Coşku Baş
• Niklas Behrens
• Andrew Belt
• Niklas Bergström
• Denis Bernard
• Doug Binks
• blanco
• Kyle Brenneman
• Rok Breulj
• Kai Burjack
• Martin Capitanio
• David Carlier
• Arturo Castro
• Chi-kwan Chan
• Ian Clarkson
• Michał Cichoń
• Lambert Clara
• Anna Clarke
• Yaron Cohen-Tal
• Omar Cornut
• Andrew Corrigan
• Bailey Cosier
• Noel Cower
• Jason Daly
• Jarrod Davis
• Olivier Delannoy
• Paul R. Deppe
• Michael Dickens
• Роман Донченко
• Mario Dorn
• Wolfgang Draxinger
• Jonathan Dummer
• Ralph Eastwood
• Fredrik Ehnbom
• Robin Eklind
• Siavash Eliasi
• Felipe Ferreira
• Michael Fogleman
• Gerald Franz
• Mário Freitas
• GeO4d
• Marcus Geelnard
• Charles Giessen
• Stephen Gowen
• Kovid Goyal
• Eloi Marín Gratacós
• Stefan Gustavson
• Jonathan Hale
• Sylvain Hellegouarch
• Matthew Henry
• heromyth
• Lucas Hinderberger
• Paul Holden
• Warren Hu
• Charles Huber
• IntellectualKitty
• Aaron Jacobs
• Erik S. V. Jansson
• Toni Jovanoski
• Arseny Kapoulkine
• Cem Karan
• Osman Keskin
• Josh Kilmer
• Cameron King
• Peter Knut
• Christoph Kubisch
• Yuri Kunde Schlesner
• Rokas Kupstys
• Konstantin Käfer
• Eric Larson
• Robin Leffmann
• Glenn Lewis
• Shane Liesegang
• Anders Lindqvist
• Leon Linhart
• Eyal Lotem
• Aaron Loucks
• Luflosi
• Tristam MacDonald
• Hans Mackowiak
• Дмитри Малышев
• Zbigniew Mandziejewicz
• Adam Marcus
• Célestin Marot
• Kyle McDonald
• David Medlock
• Bryce Mehring
• Jonathan Mercier
• Marcel Metz
• Liam Middlebrook
• Ave Milia
• Jonathan Miller
• Kenneth Miller
• Bruce Mitchener
• Jack Moffitt
• Jeff Molofee
• Alexander Monakov
• Pierre Morel
• Jon Morton
• Pierre Moulon
• Martins Mozeiko
• Julian Møller
• ndogxj
• Kristian Nielsen
• Kamil Nowakowski
• Denis Ovod
• Ozzy
• Andri Pálsson
• Peoro
• Braden Pellett
• Christopher Pelloux
• Arturo J. Pérez
• Anthony Pesch
• Orson Peters
• Emmanuel Gil Peyrot
• Cyril Pichard
• Keith Pitt
• Stanislav Podgorskiy
• Konstantin Podsvirov
• Nathan Poirier
• Alexandre Pretyman
• przemekmirek
• Philip Rideout
• Eddie Ringle
• Max Risuhin
• Jorge Rodriguez
• Ed Ropple
• Aleksey Rybalkin
• Riku Salminen
• Brandon Schaefer
• Sebastian Schuberth
• Christian Sdunek
• Matt Sealey
• Steve Sexton
• Arkady Shapkin
• Yoshiki Shibukawa
• Dmitri Shuralyov
• Daniel Skorupski
• Bradley Smith
• Cliff Smolinsky
• Patrick Snape
• Erlend Sogge Heggen
• Julian Squires
• Johannes Stein
• Pontus Stenetorp
• Michael Stocker
• Justin Stoecker
• Elviss Strazdins
• Paul Sultana
• Nathan Sweet
• TTK-Bandit
• Sergey Tikhomirov
• Arthur Tombs
• Ioannis Tsakpinis
• Samuli Tuomola
• Matthew Turner
• urraka
• Elias Vanderstuyft
• Stef Velzel
• Jari Vetoniemi
• Ricardo Vieira
• Nicholas Vitovitch
• Simon Voordouw
• Corentin Wallez
• Torsten Walluhn
• Patrick Walton
• Xo Wang
• Jay Weisskopf
• Frank Wille
• Ryogo Yoshimura
• Lukas Zanner
• Andrey Zholos
• Santi Zupancic
• Jonas Ådahl
• Lasse Öörni
• All the unmentioned and anonymous contributors in the GLFW community, for bug reports, patches, feedback, testing and encouragement