glfw/README.md

# GLFW

## Introduction

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

Version 3.2 is _not yet described_.

If you are new to GLFW, you may find the
[introductory tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW
3 useful.  If you have used GLFW 2 in the past, there is a
[transition guide](http://www.glfw.org/docs/latest/moving.html) for moving to
the GLFW 3 API.


## Compiling GLFW

See the [Compiling GLFW](http://www.glfw.org/docs/latest/compile.html) guide in
the GLFW documentation.


## Using GLFW

See the
[Building programs that use GLFW](http://www.glfw.org/docs/latest/build.html)
guide in the GLFW documentation.


## Reporting bugs

Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues).
Please always include the name and version of the OS where the bug occurs and
the version of GLFW used.  If you have cloned it, include the commit ID used.

If it's a build issue, please also include the build log and the name and
version of your development environment.

If it's a context creation issue, please also include the make and model of your
graphics card and the version of your driver.

This will help both us and other people experiencing the same bug.


## Dependencies

GLFW bundles a number of dependencies in the `deps/` directory.

 - [Khronos extension headers](https://www.opengl.org/registry/) for API
   extension symbols used by GLFW
 - [getopt\_port](https://github.com/kimgr/getopt_port/) for examples
   with command-line options
 - [TinyCThread](https://github.com/tinycthread/tinycthread) for threaded
   examples
 - An OpenGL 3.2 core loader generated by
   [glad](https://github.com/Dav1dde/glad) for examples using modern OpenGL
 - [linmath.h](https://github.com/datenwolf/linmath.h) for linear algebra in
   examples


## Changelog

   - Added `GLFW_TRUE` and `GLFW_FALSE` as client API independent boolean values
   - Removed dependency on external OpenGL or OpenGL ES headers
   - [WGL] Removed dependency on external WGL headers
   - [GLX] Removed dependency on external GLX headers
   - [EGL] Removed dependency on external EGL headers


## Contact

The official website for GLFW is [glfw.org](http://www.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](https://sourceforge.net/p/glfw/discussion/247562/), and the IRC
channel `#glfw` on [Freenode](http://freenode.net/).

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](https://github.com/glfw/glfw/issues) 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
 - 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
 - Aaron Jacobs
 - Toni Jovanoski
 - Arseny Kapoulkine
 - Osman Keskin
 - Cameron King
 - Peter Knut
 - Eric Larson
 - Robin Leffmann
 - Glenn Lewis
 - Shane Liesegang
 - Eyal Lotem
 - Дмитри Малышев
 - Martins Mozeiko
 - Tristam MacDonald
 - Hans Mackowiak
 - 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
 - Emmanuel Gil Peyrot
 - Cyril Pichard
 - Pieroman
 - Jorge Rodriguez
 - Ed Ropple
 - Aleksey Rybalkin
 - Riku Salminen
 - Brandon Schaefer
 - Sebastian Schuberth
 - Matt Sealey
 - SephiRok
 - Steve Sexton
 - Systemcluster
 - Dmitri Shuralyov
 - Daniel Skorupski
 - Bradley Smith
 - Julian Squires
 - Johannes Stein
 - Justin Stoecker
 - Elviss Strazdins
 - Nathan Sweet
 - TTK-Bandit
 - Sergey Tikhomirov
 - A. Tombs
 - Samuli Tuomola
 - urraka
 - Jari Vetoniemi
 - Ricardo Vieira
 - Simon Voordouw
 - Torsten Walluhn
 - Patrick Walton
 - 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
Removed version noise. 2013-06-13 09:07:28 -04:00			`# GLFW`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00
			`## Introduction`

Blurb nomenclature fix. 2014-02-10 09:33:41 -05:00			`GLFW is a free, Open Source, multi-platform library for OpenGL and OpenGL ES`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00			`application development. It provides a simple, platform-independent API for`
			`creating windows and contexts, reading input, handling events, etc.`

Start 3.2 2015-06-01 16:55:06 -04:00			`Version 3.2 is _not yet described_.`
Added repository URL to readme. 2013-04-18 18:19:22 -04:00
Updated readme links to guides. 2013-04-07 07:26:06 -04:00			`If you are new to GLFW, you may find the`
Moved to auto-updated docs URLs. 2013-07-10 09:51:10 -04:00			`[introductory tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW`
Cleanup. 2013-06-17 05:58:46 -04:00			`3 useful. If you have used GLFW 2 in the past, there is a`
Moved to auto-updated docs URLs. 2013-07-10 09:51:10 -04:00			`[transition guide](http://www.glfw.org/docs/latest/moving.html) for moving to`
			`the GLFW 3 API.`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00

Moved GLFW compilation guide to docs. 2013-10-27 07:50:33 -04:00			`## Compiling GLFW`
Cross-linked build guides. 2013-10-21 16:23:15 -04:00
Moved GLFW compilation guide to docs. 2013-10-27 07:50:33 -04:00			`See the [Compiling GLFW](http://www.glfw.org/docs/latest/compile.html) guide in`
			`the GLFW documentation.`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00

			`## Using GLFW`

Moved GLFW compilation guide to docs. 2013-10-27 07:50:33 -04:00			`See the`
			`[Building programs that use GLFW](http://www.glfw.org/docs/latest/build.html)`
			`guide in the GLFW documentation.`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00

Added readme paragraph on bug reporting. 2014-10-12 09:47:38 -04:00			`## Reporting bugs`

			`Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues).`
			`Please always include the name and version of the OS where the bug occurs and`
			`the version of GLFW used. If you have cloned it, include the commit ID used.`

			`If it's a build issue, please also include the build log and the name and`
			`version of your development environment.`

			`If it's a context creation issue, please also include the make and model of your`
			`graphics card and the version of your driver.`

			`This will help both us and other people experiencing the same bug.`


Added dependency section to readme. 2014-01-11 23:40:36 -05:00			`## Dependencies`

			GLFW bundles a number of dependencies in the `deps/` directory.

Clarified dependency list. 2014-06-18 10:13:49 -04:00			`- [Khronos extension headers](https://www.opengl.org/registry/) for API`
			`extension symbols used by GLFW`
			`- [getopt\_port](https://github.com/kimgr/getopt_port/) for examples`
			`with command-line options`
Updated TinyCThread URL. 2014-10-14 21:55:25 -04:00			`- [TinyCThread](https://github.com/tinycthread/tinycthread) for threaded`
Clarified dependency list. 2014-06-18 10:13:49 -04:00			`examples`
			`- An OpenGL 3.2 core loader generated by`
			`[glad](https://github.com/Dav1dde/glad) for examples using modern OpenGL`
Add linmath.h to readme dependency list 2015-08-09 10:58:25 -04:00			`- [linmath.h](https://github.com/datenwolf/linmath.h) for linear algebra in`
			`examples`
Added dependency section to readme. 2014-01-11 23:40:36 -05:00

Removed more version noise. 2013-06-13 09:09:10 -04:00			`## Changelog`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00
Replace GL booleans with public macros 2015-08-23 13:30:04 -04:00			- Added `GLFW_TRUE` and `GLFW_FALSE` as client API independent boolean values
Replace external context and client API headers 2015-08-23 19:27:20 -04:00			`- Removed dependency on external OpenGL or OpenGL ES headers`
			`- [WGL] Removed dependency on external WGL headers`
			`- [GLX] Removed dependency on external GLX headers`
			`- [EGL] Removed dependency on external EGL headers`
Replace GL booleans with public macros 2015-08-23 13:30:04 -04:00
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00
			`## Contact`

			`The official website for GLFW is [glfw.org](http://www.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](https://sourceforge.net/p/glfw/discussion/247562/), and the IRC`
			channel `#glfw` on [Freenode](http://freenode.net/).

			`If you have a bug to report, a patch to submit or a feature you'd like to`
Updated contact information. 2013-06-24 08:28:42 -04:00			`request, please file it in the`
			`[issue tracker](https://github.com/glfw/glfw/issues) on GitHub.`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00
			`Finally, if you're interested in helping out with the development of GLFW or`
Stop making it worse. 2015-05-14 11:14:30 -04:00			`porting it to your favorite platform, join us on GitHub or IRC.`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00

			`## Acknowledgements`

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

Formatting. 2013-06-09 06:49:13 -04:00			`- Bobyshev Alexander`
			`- artblanc`
Fixed window position being incorrect on some WMs. 2013-07-30 09:52:23 -04:00			`- arturo`
Formatting. 2013-06-09 06:49:13 -04:00			`- Matt Arsenault`
			`- Keith Bauer`
			`- John Bartholomew`
Updated credits and changelog. 2013-06-16 06:35:46 -04:00			`- Niklas Behrens`
Formatting. 2013-06-09 06:49:13 -04:00			`- Niklas Bergström`
Fixed keypad 5 release events. 2013-08-16 11:48:11 -04:00			`- Doug Binks`
Formatting. 2013-06-09 06:49:13 -04:00			`- blanco`
Fixed video modes not being rotated to match CRTC. Fixes #284. 2014-08-10 10:35:09 -04:00			`- Martin Capitanio`
Cleanup of #493. 2015-04-09 10:09:39 -04:00			`- Chi-kwan Chan`
Formatting. 2013-06-09 06:49:13 -04:00			`- Lambert Clara`
Added credit. 2013-10-06 05:37:16 -04:00			`- Andrew Corrigan`
Formatting. 2013-06-09 06:49:13 -04:00			`- Noel Cower`
			`- Jarrod Davis`
			`- Olivier Delannoy`
			`- Paul R. Deppe`
Added credit. 2014-02-13 18:45:27 -05:00			`- Michael Dickens`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jonathan Dummer`
			`- Ralph Eastwood`
Header option macro fixes and documentation work. This adds compile-time checks and documentation warning about defining header option macros during compilation of GLFW. Fixes #445. 2015-03-17 11:33:21 -04:00			`- Siavash Eliasi`
Added credit. 2013-12-10 07:45:21 -05:00			`- Michael Fogleman`
Formatting. 2013-12-11 08:41:51 -05:00			`- Gerald Franz`
Formatting. 2013-06-09 06:49:13 -04:00			`- GeO4d`
			`- Marcus Geelnard`
Made queries use XRRGetScreenResourcesCurrent. Fixes #347. Closes #351. 2014-09-09 17:15:52 -04:00			`- Eloi Marín Gratacós`
Formatting. 2013-06-09 06:49:13 -04:00			`- Stefan Gustavson`
			`- Sylvain Hellegouarch`
Cleanup of CGDisplayIOServicePort replacement. 2014-03-10 11:50:20 -04:00			`- Matthew Henry`
Formatting. 2013-06-09 06:49:13 -04:00			`- heromyth`
Cleanup of basic XIM support. Shortened and simplified the code. Removed reporting of XIM sentinel key press event. Added credit. Updated changelog. Closes #151. 2014-09-20 20:13:41 -04:00			`- Lucas Hinderberger`
Fixed glfwGetFramebufferSize on OS X. 2013-06-16 12:32:16 -04:00			`- Paul Holden`
Updated changelog and credits, formatting. Fixes #17. Closes #536. 2015-06-26 07:31:37 -04:00			`- Aaron Jacobs`
Formatting. 2013-06-09 06:49:13 -04:00			`- Toni Jovanoski`
Optimize _glfwInitJoysticks on OS X. This function used to enumerate all devices and capture all properties of every device into a dictionary. This takes 180 ms on a MacBook Pro without external devices and 280 ms with an external keyboard/mouse attached. Since we're only interested in a few properties, we can just get them one by one - this reduces the time to <1 ms. Note that we still use the dictionary to get the joystick elements. For unknown reason this is required to get all axes/buttons - without doing this we don't get any joystick elements in addJoystickElement. Closes #332. 2014-05-02 01:39:21 -04:00			`- Arseny Kapoulkine`
Formatting. 2013-06-09 06:49:13 -04:00			`- Osman Keskin`
			`- Cameron King`
			`- Peter Knut`
Added credit. 2015-04-14 15:15:50 -04:00			`- Eric Larson`
Formatting. 2013-06-09 06:49:13 -04:00			`- Robin Leffmann`
			`- Glenn Lewis`
			`- Shane Liesegang`
Fix EINTR not being handled for select on X11 Closes #580. 2015-08-14 07:49:52 -04:00			`- Eyal Lotem`
Formatting. 2013-06-09 06:49:13 -04:00			`- Дмитри Малышев`
			`- Martins Mozeiko`
			`- Tristam MacDonald`
			`- Hans Mackowiak`
Restored support for Mac OS X 10.6. Modified during merge. 2013-06-16 12:40:10 -04:00			`- Kyle McDonald`
Formatting. 2013-06-09 06:49:13 -04:00			`- David Medlock`
Fixed X11 mouse button mismatch. Bug introduced by 4d146cb39d. Closes #449. 2015-02-22 23:14:24 -05:00			`- Bryce Mehring`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jonathan Mercier`
			`- Marcel Metz`
Fixed close being used instead of inotify_rm_watch. Closes #432. Fixes #440. 2015-01-23 16:53:41 -05:00			`- Jonathan Miller`
Formatting. 2013-06-09 06:49:13 -04:00			`- Kenneth Miller`
Added credit. 2013-07-01 07:18:05 -04:00			`- Bruce Mitchener`
Added credit. 2013-10-28 08:22:34 -04:00			`- Jack Moffitt`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jeff Molofee`
			`- Jon Morton`
Workaround for libXi and CMake 2.8.7. 2013-09-13 08:41:13 -04:00			`- Pierre Moulon`
Formatting. 2013-06-09 06:49:13 -04:00			`- Julian Møller`
Added credit. 2013-11-13 06:59:49 -05:00			`- Kamil Nowakowski`
Cleanup. 2013-06-17 05:58:46 -04:00			`- Ozzy`
Fixed hidden cursor positioning corner case. 2013-10-09 13:03:47 -04:00			`- Andri Pálsson`
Formatting. 2013-06-09 06:49:13 -04:00			`- Peoro`
			`- Braden Pellett`
			`- Arturo J. Pérez`
Added credit. 2015-04-19 07:27:27 -04:00			`- Emmanuel Gil Peyrot`
Updated changelog and credits, formatting. Closes #384. 2014-11-27 09:39:24 -05:00			`- Cyril Pichard`
Cleanup and change log update. 2013-10-09 17:58:43 -04:00			`- Pieroman`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jorge Rodriguez`
			`- Ed Ropple`
Added workaround for cursor hiding on some WMs. Closes #431. Fixes #309. 2015-01-23 12:38:12 -05:00			`- Aleksey Rybalkin`
Formatting. 2013-06-09 06:49:13 -04:00			`- Riku Salminen`
Updated credits and changelog. Closes #380. 2014-11-06 17:57:53 -05:00			`- Brandon Schaefer`
Formatting. 2013-06-09 06:49:13 -04:00			`- Sebastian Schuberth`
			`- Matt Sealey`
			`- SephiRok`
			`- Steve Sexton`
Fixed zero refresh rate on some monitors. 2013-10-09 13:45:39 -04:00			`- Systemcluster`
Formatting. 2013-06-09 06:49:13 -04:00			`- Dmitri Shuralyov`
			`- Daniel Skorupski`
			`- Bradley Smith`
			`- Julian Squires`
			`- Johannes Stein`
Fixed incorrect hint default. The default for the GLFW_ALPHA_BITS hint was zero instead of 8. 2013-06-17 11:42:22 -04:00			`- Justin Stoecker`
Cleanup of #487. 2015-04-09 08:03:26 -04:00			`- Elviss Strazdins`
Formatting. 2013-06-09 06:49:13 -04:00			`- Nathan Sweet`
			`- TTK-Bandit`
			`- Sergey Tikhomirov`
Fixed test for invalid timer values. Fixes #436 (properly). 2015-03-10 07:01:38 -04:00			`- A. Tombs`
Formatting. 2013-06-09 06:49:13 -04:00			`- Samuli Tuomola`
Fixed clip rect being set for unfocused windows. 2013-10-07 09:30:57 -04:00			`- urraka`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jari Vetoniemi`
Added credit. 2014-07-01 04:49:50 -04:00			`- Ricardo Vieira`
Formatting. 2013-06-09 06:49:13 -04:00			`- Simon Voordouw`
			`- Torsten Walluhn`
Create an autorelease pool in glfwPostEmptyEvent. This prevents leaking NSEvent objects. Closes #372. 2014-10-21 01:41:58 -04:00			`- Patrick Walton`
Formatting. 2013-06-09 06:49:13 -04:00			`- Jay Weisskopf`
			`- Frank Wille`
			`- yuriks`
			`- Santi Zupancic`
Added credit. 2014-03-18 16:43:24 -04:00			`- Jonas Ådahl`
Formatting. 2013-06-09 06:49:13 -04:00			`- Lasse Öörni`
			`- All the unmentioned and anonymous contributors in the GLFW community, for bug`
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc. 2013-02-04 04:46:02 -05:00			`reports, patches, feedback, testing and encouragement`