2013-06-13 15:07:28 +02:00
|
|
|
# GLFW
|
2013-02-04 10:46:02 +01:00
|
|
|
|
|
|
|
|
## Introduction
|
|
|
|
|
|
2014-02-10 15:33:41 +01:00
|
|
|
GLFW is a free, Open Source, multi-platform library for OpenGL and OpenGL ES
|
2013-02-04 10:46:02 +01:00
|
|
|
application development. It provides a simple, platform-independent API for
|
|
|
|
|
creating windows and contexts, reading input, handling events, etc.
|
|
|
|
|
|
2015-03-20 00:12:00 +01:00
|
|
|
Version 3.1.2 is _not yet described_.
|
2013-04-19 00:19:22 +02:00
|
|
|
|
2013-04-07 13:26:06 +02:00
|
|
|
If you are new to GLFW, you may find the
|
2013-07-10 15:51:10 +02:00
|
|
|
[introductory tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW
|
2013-06-17 11:58:46 +02:00
|
|
|
3 useful. If you have used GLFW 2 in the past, there is a
|
2013-07-10 15:51:10 +02:00
|
|
|
[transition guide](http://www.glfw.org/docs/latest/moving.html) for moving to
|
|
|
|
|
the GLFW 3 API.
|
2013-02-04 10:46:02 +01:00
|
|
|
|
2014-04-08 17:45:04 +02:00
|
|
|
Note that a number of source files have been added or renamed in 3.1, which may
|
|
|
|
|
require you to update any custom build files you have.
|
|
|
|
|
|
2013-02-04 10:46:02 +01:00
|
|
|
|
2013-10-27 12:50:33 +01:00
|
|
|
## Compiling GLFW
|
2013-10-21 22:23:15 +02:00
|
|
|
|
2013-10-27 12:50:33 +01:00
|
|
|
See the [Compiling GLFW](http://www.glfw.org/docs/latest/compile.html) guide in
|
|
|
|
|
the GLFW documentation.
|
2013-02-04 10:46:02 +01:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Using GLFW
|
|
|
|
|
|
2013-10-27 12:50:33 +01:00
|
|
|
See the
|
|
|
|
|
[Building programs that use GLFW](http://www.glfw.org/docs/latest/build.html)
|
|
|
|
|
guide in the GLFW documentation.
|
2013-02-04 10:46:02 +01:00
|
|
|
|
|
|
|
|
|
2014-10-12 15:47:38 +02: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.
|
|
|
|
|
|
|
|
|
|
|
2014-01-12 05:40:36 +01:00
|
|
|
## Dependencies
|
|
|
|
|
|
|
|
|
|
GLFW bundles a number of dependencies in the `deps/` directory.
|
|
|
|
|
|
2014-06-18 16:13:49 +02: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
|
2014-10-15 03:55:25 +02:00
|
|
|
- [TinyCThread](https://github.com/tinycthread/tinycthread) for threaded
|
2014-06-18 16:13:49 +02:00
|
|
|
examples
|
|
|
|
|
- An OpenGL 3.2 core loader generated by
|
|
|
|
|
[glad](https://github.com/Dav1dde/glad) for examples using modern OpenGL
|
2014-01-12 05:40:36 +01:00
|
|
|
|
|
|
|
|
|
2013-06-13 15:09:10 +02:00
|
|
|
## Changelog
|
2013-02-04 10:46:02 +01:00
|
|
|
|
2015-05-14 16:29:54 +02:00
|
|
|
- Minimum required CMake version updated to 2.8.12
|
2015-03-29 13:46:21 +02:00
|
|
|
- Bugfix: Initialization failed on headless systems
|
2015-04-09 14:03:26 +02:00
|
|
|
- Bugfix: The cached current context could get out of sync
|
2015-04-09 16:09:39 +02:00
|
|
|
- [Cocoa] Bugfix: The cached `NSScreen` for a monitor could get out of sync
|
2015-05-06 23:52:39 +02:00
|
|
|
- [Cocoa] Bugfix: The `GLFW_AUTO_ICONIFY` window hint was ignored
|
2015-05-14 16:29:54 +02:00
|
|
|
- [X11] Bugfix: `glfwInit` would segfault on systems without RandR
|
2015-03-29 13:46:21 +02:00
|
|
|
|
2013-02-04 10:46:02 +01: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
|
2013-06-24 14:28:42 +02:00
|
|
|
request, please file it in the
|
|
|
|
|
[issue tracker](https://github.com/glfw/glfw/issues) on GitHub.
|
2013-02-04 10:46:02 +01:00
|
|
|
|
|
|
|
|
Finally, if you're interested in helping out with the development of GLFW or
|
2013-06-24 14:28:42 +02:00
|
|
|
porting it to your favorite platform, we have an occasionally active
|
2013-02-04 10:46:02 +01:00
|
|
|
[developer's mailing list](https://lists.stacken.kth.se/mailman/listinfo/glfw-dev),
|
|
|
|
|
or you could join us on `#glfw`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Acknowledgements
|
|
|
|
|
|
|
|
|
|
GLFW exists because people around the world donated their time and lent their
|
|
|
|
|
skills.
|
|
|
|
|
|
2013-06-09 12:49:13 +02:00
|
|
|
- Bobyshev Alexander
|
|
|
|
|
- artblanc
|
2013-07-30 15:52:23 +02:00
|
|
|
- arturo
|
2013-06-09 12:49:13 +02:00
|
|
|
- Matt Arsenault
|
|
|
|
|
- Keith Bauer
|
|
|
|
|
- John Bartholomew
|
2013-06-16 12:35:46 +02:00
|
|
|
- Niklas Behrens
|
2013-06-09 12:49:13 +02:00
|
|
|
- Niklas Bergström
|
2013-08-16 17:48:11 +02:00
|
|
|
- Doug Binks
|
2013-06-09 12:49:13 +02:00
|
|
|
- blanco
|
2014-08-10 16:35:09 +02:00
|
|
|
- Martin Capitanio
|
2015-04-09 16:09:39 +02:00
|
|
|
- Chi-kwan Chan
|
2013-06-09 12:49:13 +02:00
|
|
|
- Lambert Clara
|
2013-10-06 11:37:16 +02:00
|
|
|
- Andrew Corrigan
|
2013-06-09 12:49:13 +02:00
|
|
|
- Noel Cower
|
|
|
|
|
- Jarrod Davis
|
|
|
|
|
- Olivier Delannoy
|
|
|
|
|
- Paul R. Deppe
|
2014-02-14 00:45:27 +01:00
|
|
|
- Michael Dickens
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jonathan Dummer
|
|
|
|
|
- Ralph Eastwood
|
2015-03-17 16:33:21 +01:00
|
|
|
- Siavash Eliasi
|
2013-12-10 13:45:21 +01:00
|
|
|
- Michael Fogleman
|
2013-12-11 14:41:51 +01:00
|
|
|
- Gerald Franz
|
2013-06-09 12:49:13 +02:00
|
|
|
- GeO4d
|
|
|
|
|
- Marcus Geelnard
|
2014-09-09 23:15:52 +02:00
|
|
|
- Eloi Marín Gratacós
|
2013-06-09 12:49:13 +02:00
|
|
|
- Stefan Gustavson
|
|
|
|
|
- Sylvain Hellegouarch
|
2014-03-10 16:50:20 +01:00
|
|
|
- Matthew Henry
|
2013-06-09 12:49:13 +02:00
|
|
|
- heromyth
|
2014-09-21 02:13:41 +02:00
|
|
|
- Lucas Hinderberger
|
2013-06-16 18:32:16 +02:00
|
|
|
- Paul Holden
|
2013-06-09 12:49:13 +02:00
|
|
|
- Toni Jovanoski
|
2014-05-02 07:39:21 +02:00
|
|
|
- Arseny Kapoulkine
|
2013-06-09 12:49:13 +02:00
|
|
|
- Osman Keskin
|
|
|
|
|
- Cameron King
|
|
|
|
|
- Peter Knut
|
2015-04-14 21:15:50 +02:00
|
|
|
- Eric Larson
|
2013-06-09 12:49:13 +02:00
|
|
|
- Robin Leffmann
|
|
|
|
|
- Glenn Lewis
|
|
|
|
|
- Shane Liesegang
|
|
|
|
|
- Дмитри Малышев
|
|
|
|
|
- Martins Mozeiko
|
|
|
|
|
- Tristam MacDonald
|
|
|
|
|
- Hans Mackowiak
|
2013-06-16 18:40:10 +02:00
|
|
|
- Kyle McDonald
|
2013-06-09 12:49:13 +02:00
|
|
|
- David Medlock
|
2015-02-23 05:14:24 +01:00
|
|
|
- Bryce Mehring
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jonathan Mercier
|
|
|
|
|
- Marcel Metz
|
2015-01-23 22:53:41 +01:00
|
|
|
- Jonathan Miller
|
2013-06-09 12:49:13 +02:00
|
|
|
- Kenneth Miller
|
2013-07-01 13:18:05 +02:00
|
|
|
- Bruce Mitchener
|
2013-10-28 13:22:34 +01:00
|
|
|
- Jack Moffitt
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jeff Molofee
|
|
|
|
|
- Jon Morton
|
2013-09-13 14:41:13 +02:00
|
|
|
- Pierre Moulon
|
2013-06-09 12:49:13 +02:00
|
|
|
- Julian Møller
|
2013-11-13 12:59:49 +01:00
|
|
|
- Kamil Nowakowski
|
2013-06-17 11:58:46 +02:00
|
|
|
- Ozzy
|
2013-10-09 19:03:47 +02:00
|
|
|
- Andri Pálsson
|
2013-06-09 12:49:13 +02:00
|
|
|
- Peoro
|
|
|
|
|
- Braden Pellett
|
|
|
|
|
- Arturo J. Pérez
|
2015-04-19 13:27:27 +02:00
|
|
|
- Emmanuel Gil Peyrot
|
2014-11-27 15:39:24 +01:00
|
|
|
- Cyril Pichard
|
2013-10-09 23:58:43 +02:00
|
|
|
- Pieroman
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jorge Rodriguez
|
|
|
|
|
- Ed Ropple
|
2015-01-23 18:38:12 +01:00
|
|
|
- Aleksey Rybalkin
|
2013-06-09 12:49:13 +02:00
|
|
|
- Riku Salminen
|
2014-11-06 23:57:53 +01:00
|
|
|
- Brandon Schaefer
|
2013-06-09 12:49:13 +02:00
|
|
|
- Sebastian Schuberth
|
|
|
|
|
- Matt Sealey
|
|
|
|
|
- SephiRok
|
|
|
|
|
- Steve Sexton
|
2013-10-09 19:45:39 +02:00
|
|
|
- Systemcluster
|
2013-06-09 12:49:13 +02:00
|
|
|
- Dmitri Shuralyov
|
|
|
|
|
- Daniel Skorupski
|
|
|
|
|
- Bradley Smith
|
|
|
|
|
- Julian Squires
|
|
|
|
|
- Johannes Stein
|
2013-06-17 17:42:22 +02:00
|
|
|
- Justin Stoecker
|
2015-04-09 14:03:26 +02:00
|
|
|
- Elviss Strazdins
|
2013-06-09 12:49:13 +02:00
|
|
|
- Nathan Sweet
|
|
|
|
|
- TTK-Bandit
|
|
|
|
|
- Sergey Tikhomirov
|
2015-03-10 12:01:38 +01:00
|
|
|
- A. Tombs
|
2013-06-09 12:49:13 +02:00
|
|
|
- Samuli Tuomola
|
2013-10-07 15:30:57 +02:00
|
|
|
- urraka
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jari Vetoniemi
|
2014-07-01 10:49:50 +02:00
|
|
|
- Ricardo Vieira
|
2013-06-09 12:49:13 +02:00
|
|
|
- Simon Voordouw
|
|
|
|
|
- Torsten Walluhn
|
2014-10-21 07:41:58 +02:00
|
|
|
- Patrick Walton
|
2013-06-09 12:49:13 +02:00
|
|
|
- Jay Weisskopf
|
|
|
|
|
- Frank Wille
|
|
|
|
|
- yuriks
|
|
|
|
|
- Santi Zupancic
|
2014-03-18 21:43:24 +01:00
|
|
|
- Jonas Ådahl
|
2013-06-09 12:49:13 +02:00
|
|
|
- Lasse Öörni
|
|
|
|
|
- All the unmentioned and anonymous contributors in the GLFW community, for bug
|
2013-02-04 10:46:02 +01:00
|
|
|
reports, patches, feedback, testing and encouragement
|
|
|
|
|
|
