Saxum/extern/glfw/README.md

214 lines
6.0 KiB
Markdown
Raw Normal View History

2014-10-20 15:31:26 +00:00
# GLFW
## Introduction
2015-03-12 11:55:54 +00:00
GLFW is a free, Open Source, multi-platform library for OpenGL and OpenGL ES
2014-10-20 15:31:26 +00:00
application development. It provides a simple, platform-independent API for
creating windows and contexts, reading input, handling events, etc.
2015-06-03 21:15:52 +00:00
Version 3.1.1 adds fixes for a number of bugs that together affect all supported
platforms, most notably workarounds for bugs in some popular window managers.
2014-10-20 15:31:26 +00:00
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.
2015-03-12 11:55:54 +00: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.
2014-10-20 15:31:26 +00:00
2014-12-01 11:32:04 +00:00
## Compiling GLFW
2014-10-20 15:31:26 +00:00
2014-12-01 11:53:19 +00:00
See the [Compiling GLFW](http://www.glfw.org/docs/latest/compile.html) guide in
the GLFW documentation.
## Using GLFW
2014-10-20 15:31:26 +00:00
2014-12-01 11:53:19 +00:00
See the
[Building programs that use GLFW](http://www.glfw.org/docs/latest/build.html)
guide in the GLFW documentation.
2014-10-20 15:31:26 +00:00
2015-03-12 11:55:54 +00: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.
## 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
2014-10-20 15:31:26 +00:00
## Changelog
2015-06-03 21:15:52 +00:00
- Made library compilation fail if any header option macros are defined
- Removed support for LCC and Borland C++
- Bugfix: `glfwSetTime` silently accepted invalid values
- [Cocoa] Bugfix: `NSHighResolutionCapable` was not enabled for test and
example programs
- [Cocoa] Bugfix: Sleeping monitors were not included in the monitor list
- [Cocoa] Bugfix: `glfwSetWindowSize` did not change the video mode for full
screen windows
- [X11] Added support for Cygwin-X
- [X11] Made XInput2 optional at compile-time
- [X11] Made Xxf86vm optional at compile-time
- [X11] Bugfix: Moved `_NET_REQUEST_FRAME_EXTENTS` request to
`glfwGetWindowFrameSize` and added protocol-breaking timeout
as a workaround for broken support in Unity, Fluxbox and Xfwm
- [X11] Bugfix: Mouse button `GLFW_MOUSE_BUTTON_4` was never used
- [X11] Bugfix: `glfwTerminate` could close an unrelated file descriptor
- [X11] Bugfix: Some WMs (KWM, Fluxbox) did not respect cursor redefinition
- [WGL] Bugfix: The context flags debug bit was not set for OpenGL ES
- [GLX] Bugfix: The context flags debug bit was not set for OpenGL ES
- [EGL] Bugfix: The context flags debug bit was not set for OpenGL ES
2014-10-20 15:31:26 +00: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
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, we have an occasionally active
[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.
- Bobyshev Alexander
- artblanc
- arturo
- Matt Arsenault
- Keith Bauer
- John Bartholomew
- Niklas Behrens
- Niklas Bergström
- Doug Binks
- blanco
2015-03-12 11:55:54 +00:00
- Martin Capitanio
2014-10-20 15:31:26 +00:00
- Lambert Clara
2014-12-01 11:53:19 +00:00
- Andrew Corrigan
2014-10-20 15:31:26 +00:00
- Noel Cower
- Jarrod Davis
- Olivier Delannoy
- Paul R. Deppe
2015-03-12 11:55:54 +00:00
- Michael Dickens
2014-10-20 15:31:26 +00:00
- Jonathan Dummer
- Ralph Eastwood
2015-06-03 21:15:52 +00:00
- Siavash Eliasi
2014-12-01 11:53:19 +00:00
- Michael Fogleman
2014-10-20 15:31:26 +00:00
- Gerald Franz
- GeO4d
- Marcus Geelnard
2015-03-12 11:55:54 +00:00
- Eloi Marín Gratacós
2014-10-20 15:31:26 +00:00
- Stefan Gustavson
- Sylvain Hellegouarch
2015-03-12 11:55:54 +00:00
- Matthew Henry
2014-10-20 15:31:26 +00:00
- heromyth
2015-03-12 11:55:54 +00:00
- Lucas Hinderberger
2014-10-20 15:31:26 +00:00
- Paul Holden
- Toni Jovanoski
2015-03-12 11:55:54 +00:00
- Arseny Kapoulkine
2014-10-20 15:31:26 +00:00
- Osman Keskin
- Cameron King
- Peter Knut
- Robin Leffmann
- Glenn Lewis
- Shane Liesegang
- Дмитри Малышев
- Martins Mozeiko
- Tristam MacDonald
- Hans Mackowiak
- Kyle McDonald
- David Medlock
2015-06-03 21:15:52 +00:00
- Bryce Mehring
2014-10-20 15:31:26 +00:00
- Jonathan Mercier
- Marcel Metz
2015-06-03 21:15:52 +00:00
- Jonathan Miller
2014-10-20 15:31:26 +00:00
- Kenneth Miller
- Bruce Mitchener
2014-12-01 11:53:19 +00:00
- Jack Moffitt
2014-10-20 15:31:26 +00:00
- Jeff Molofee
- Jon Morton
2014-12-01 11:53:19 +00:00
- Pierre Moulon
2014-10-20 15:31:26 +00:00
- Julian Møller
2014-12-01 11:53:19 +00:00
- Kamil Nowakowski
2014-10-20 15:31:26 +00:00
- Ozzy
2014-12-01 11:53:19 +00:00
- Andri Pálsson
2014-10-20 15:31:26 +00:00
- Peoro
- Braden Pellett
- Arturo J. Pérez
2015-03-12 11:55:54 +00:00
- Cyril Pichard
2014-12-01 11:53:19 +00:00
- Pieroman
2014-10-20 15:31:26 +00:00
- Jorge Rodriguez
- Ed Ropple
2015-06-03 21:15:52 +00:00
- Aleksey Rybalkin
2014-10-20 15:31:26 +00:00
- Riku Salminen
2015-03-12 11:55:54 +00:00
- Brandon Schaefer
2014-10-20 15:31:26 +00:00
- Sebastian Schuberth
- Matt Sealey
- SephiRok
- Steve Sexton
2014-12-01 11:53:19 +00:00
- Systemcluster
2014-10-20 15:31:26 +00:00
- Dmitri Shuralyov
- Daniel Skorupski
- Bradley Smith
- Julian Squires
- Johannes Stein
- Justin Stoecker
- Nathan Sweet
- TTK-Bandit
- Sergey Tikhomirov
2015-06-03 21:15:52 +00:00
- A. Tombs
2014-10-20 15:31:26 +00:00
- Samuli Tuomola
2014-12-01 11:53:19 +00:00
- urraka
2014-10-20 15:31:26 +00:00
- Jari Vetoniemi
2015-03-12 11:55:54 +00:00
- Ricardo Vieira
2014-10-20 15:31:26 +00:00
- Simon Voordouw
- Torsten Walluhn
2015-03-12 11:55:54 +00:00
- Patrick Walton
2014-10-20 15:31:26 +00:00
- Jay Weisskopf
- Frank Wille
- yuriks
- Santi Zupancic
2015-03-12 11:55:54 +00:00
- Jonas Ådahl
2014-10-20 15:31:26 +00:00
- Lasse Öörni
- All the unmentioned and anonymous contributors in the GLFW community, for bug
reports, patches, feedback, testing and encouragement