A multi-platform library for OpenGL, OpenGL ES, Vulkan, window and input

c linux macos opengl opengl-es unix vulkan windows

Go to file

Camilla Berglund 9c5b994369 Make readme reference contribution guide		2016-07-12 16:29:59 +02:00
.github	Add question section to contribution guide	2016-07-12 01:03:08 +02:00
CMake	Add check for VULKAN_SDK envvar on Windows	2016-03-05 23:56:46 +01:00
deps	Remove trailing whitespace	2016-07-12 15:35:06 +02:00
docs	Start 3.2.1	2016-06-15 01:35:05 +02:00
examples	Update email address	2016-06-01 21:25:20 +02:00
include/GLFW	Documentation work	2016-07-06 13:06:59 +02:00
src	Win32: Fix GLFW_MAXIMIZED ignored by first window	2016-07-12 16:04:02 +02:00
tests	Fix test program line endings	2016-06-15 01:35:07 +02:00
.appveyor.yml	Remove CRLF line endings	2016-02-18 14:22:11 +01:00
.gitignore	Add Xcode CMake output patterns to .gitignore	2016-03-06 13:57:19 +01:00
.travis.yml	Add build directory for CI	2016-02-04 15:51:20 +01:00
cmake_uninstall.cmake.in	Formatting.	2012-08-19 02:33:43 +02:00
CMakeLists.txt	Start 3.2.1	2016-06-15 01:35:05 +02:00
COPYING.txt	Update email address	2016-06-01 21:25:20 +02:00
README.md	Make readme reference contribution guide	2016-07-12 16:29:59 +02:00

README.md

GLFW

Introduction

GLFW is a free, 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.

The current stable release is version 3.2. See the downloads page for details and files, or fetch the latest branch, which always points to the latest stable release. Each release starting with 3.0 also has a corresponding annotated tag.

This is version 3.2.1, which is not yet described.

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

See the Compiling GLFW guide in the GLFW documentation.

Using GLFW

See the Building programs that use GLFW guide in the GLFW documentation.

Reporting bugs

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

Dependencies

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

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
An OpenGL 3.2 core loader generated by glad for examples using modern OpenGL
linmath.h for linear algebra in examples
Vulkan headers for Vulkan tests

The Vulkan example additionally requires the Vulkan SDK to be installed, or it will not be included in the build.

The documentation is generated with Doxygen. If CMake does not find Doxygen, the documentation will not be generated.

Changelog

Bugfix: Single compilation unit builds failed due to naming conflicts (#783)
Bugfix: The range checks for glfwSetCursorPos used the wrong minimum (#773)
[Win32] Bugfix: Examples failed to build on Visual C++ 2010 due to C99 in linmath.h (#785)
[Win32] Bugfix: The first shown window ignored the GLFW_MAXIMIZED hint when the process was provided a STARTUPINFO (#780)
[GLX] Bugfix: Dynamically loaded entry points were not verified
[EGL] Bugfix: Dynamically loaded entry points were not verified

Contact

The official website for GLFW is glfw.org. There 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 support forum, and the IRC channel #glfw 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 GitHub or IRC.

Acknowledgements

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

Bobyshev Alexander
artblanc
arturo
Matt Arsenault
Keith Bauer
John Bartholomew
Niklas Behrens
Niklas Bergström
Doug Binks
blanco
Martin Capitanio
Chi-kwan Chan
Lambert Clara
Andrew Corrigan
Noel Cower
Jarrod Davis
Olivier Delannoy
Paul R. Deppe
Michael Dickens
Роман Донченко
Mario Dorn
Jonathan Dummer
Ralph Eastwood
Siavash Eliasi
Michael Fogleman
Gerald Franz
GeO4d
Marcus Geelnard
Eloi Marín Gratacós
Stefan Gustavson
Sylvain Hellegouarch
Matthew Henry
heromyth
Lucas Hinderberger
Paul Holden
IntellectualKitty
Aaron Jacobs
Toni Jovanoski
Arseny Kapoulkine
Osman Keskin
Cameron King
Peter Knut
Christoph Kubisch
Eric Larson
Robin Leffmann
Glenn Lewis
Shane Liesegang
Eyal Lotem
Дмитри Малышев
Martins Mozeiko
Tristam MacDonald
Hans Mackowiak
Zbigniew Mandziejewicz
Kyle McDonald
David Medlock
Bryce Mehring
Jonathan Mercier
Marcel Metz
Jonathan Miller
Kenneth Miller
Bruce Mitchener
Jack Moffitt
Jeff Molofee
Jon Morton
Pierre Moulon
Julian Møller
Kamil Nowakowski
Ozzy
Andri Pálsson
Peoro
Braden Pellett
Arturo J. Pérez
Orson Peters
Emmanuel Gil Peyrot
Cyril Pichard
Pieroman
Jorge Rodriguez
Ed Ropple
Aleksey Rybalkin
Riku Salminen
Brandon Schaefer
Sebastian Schuberth
Matt Sealey
SephiRok
Steve Sexton
Systemcluster
Yoshiki Shibukawa
Dmitri Shuralyov
Daniel Skorupski
Bradley Smith
Julian Squires
Johannes Stein
Justin Stoecker
Elviss Strazdins
Nathan Sweet
TTK-Bandit
Sergey Tikhomirov
A. Tombs
Ioannis Tsakpinis
Samuli Tuomola
urraka
Jari Vetoniemi
Ricardo Vieira
Nicholas Vitovitch
Simon Voordouw
Torsten Walluhn
Patrick Walton
Xo Wang
Jay Weisskopf
Frank Wille
yuriks
Santi Zupancic
Jonas Ådahl
Lasse Öörni
All the unmentioned and anonymous contributors in the GLFW community, for bug reports, patches, feedback, testing and encouragement