glfw/README.md

240 lines
7.2 KiB
Markdown
Raw Normal View History

2013-06-13 13:07:28 +00:00
# GLFW
2016-02-04 13:58:44 +00:00
[![Build status](https://travis-ci.org/glfw/glfw.svg?branch=master)](https://travis-ci.org/glfw/glfw)
[![Build status](https://ci.appveyor.com/api/projects/status/0kf0ct9831i5l6sp/branch/master?svg=true)](https://ci.appveyor.com/project/elmindreda/glfw)
2015-04-14 21:47:17 +00:00
## Introduction
2014-02-10 14:33:41 +00:00
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.
2015-06-01 20:55:06 +00:00
Version 3.2 is _not yet described_.
2013-04-18 22:19:22 +00:00
2013-04-07 11:26:06 +00:00
If you are new to GLFW, you may find the
2013-07-10 13:51:10 +00:00
[introductory tutorial](http://www.glfw.org/docs/latest/quick.html) for GLFW
2013-06-17 09:58:46 +00:00
3 useful. If you have used GLFW 2 in the past, there is a
2013-07-10 13:51:10 +00:00
[transition guide](http://www.glfw.org/docs/latest/moving.html) for moving to
the GLFW 3 API.
2013-10-27 11:50:33 +00:00
## Compiling GLFW
2013-10-21 20:23:15 +00:00
2013-10-27 11:50:33 +00:00
See the [Compiling GLFW](http://www.glfw.org/docs/latest/compile.html) guide in
the GLFW documentation.
## Using GLFW
2013-10-27 11:50:33 +00:00
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.
2014-01-12 04:40:36 +00:00
## Dependencies
2015-10-24 19:46:19 +00:00
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
client API (OpenGL, OpenGL ES) to enable support for them.
GLFW bundles a number of dependencies in the `deps/` directory. These are only
used by the tests and examples and are not required to build the library.
2014-01-12 04:40:36 +00:00
2014-06-18 14:13:49 +00:00
- [getopt\_port](https://github.com/kimgr/getopt_port/) for examples
with command-line options
2014-10-15 01:55:25 +00:00
- [TinyCThread](https://github.com/tinycthread/tinycthread) for threaded
2014-06-18 14:13:49 +00:00
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
2014-01-12 04:40:36 +00:00
2013-06-13 13:09:10 +00:00
## Changelog
- Added `glfwSetWindowSizeLimits` and `glfwSetWindowAspectRatio` for setting
absolute and relative window size limits
2015-07-02 12:24:50 +00:00
- Added `glfwGetKeyName` for querying the layout-specific name of printable
keys
- Added `GLFW_NO_API` for creating window without contexts
- Added `GLFW_CONTEXT_NO_ERROR` context hint for `GL_KHR_no_error` support
2015-10-17 23:20:31 +00:00
- Added `GLFW_TRUE` and `GLFW_FALSE` as client API independent boolean values
2015-11-09 22:32:35 +00:00
- Added `glfwGetGLXWindow` to query the `GLXWindow` of a window
2015-12-12 19:35:26 +00:00
- Added icons to examples on Windows and OS X
2015-11-10 13:57:30 +00:00
- Relaxed rules for native access header macros
2015-10-17 23:20:31 +00:00
- Removed dependency on external OpenGL or OpenGL ES headers
2015-12-12 19:35:26 +00:00
- Removed `_GLFW_USE_OPENGL`, `_GLFW_USE_GLESV1` and `_GLFW_USE_GLESV2`
configuration macros
- [Win32] Added support for Windows 8.1 per-monitor DPI
- [Win32] Bugfix: Window creation would segfault if video mode setting required
the system to be restarted
- [Win32] Bugfix: MinGW import library lacked the `lib` prefix
2015-12-12 19:35:26 +00:00
- [Win32] Bugfix: Monitor connection and disconnection events were not reported
when no windows existed
- [Cocoa] Removed support for OS X 10.6
- [Cocoa] Bugfix: Full screen windows on secondary monitors were mispositioned
- [X11] Bugfix: Monitor connection and disconnection events were not reported
2015-10-27 22:01:02 +00:00
- [X11] Bugfix: Decoding of UTF-8 text from XIM could continue past the end
2016-01-31 17:00:22 +00:00
- [X11] Bugfix: An XKB structure was leaked during `glfwInit`
2015-10-28 21:57:57 +00:00
- [POSIX] Bugfix: An unrelated TLS key could be deleted by `glfwTerminate`
2015-12-12 19:35:26 +00:00
- [WGL] Changed extension loading to only be performed once
2015-10-17 23:20:31 +00:00
- [WGL] Removed dependency on external WGL headers
- [GLX] Replaced legacy renderable with `GLXWindow`
2015-10-17 23:20:31 +00:00
- [GLX] Removed dependency on external GLX headers
- [GLX] Bugfix: NetBSD does not provide `libGL.so.1`
2015-12-12 19:35:26 +00:00
- [EGL] Added `_GLFW_USE_EGLPLATFORM_H` configuration macro for controlling
whether to use an existing `EGL/eglplatform.h` header
- [EGL] Added and documented test for if the context is current on the calling
thread during buffer swap
2015-10-17 23:20:31 +00:00
- [EGL] Removed dependency on external EGL headers
2015-08-23 17:30:04 +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
2013-06-24 12:28:42 +00:00
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
2015-05-14 15:14:30 +00:00
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.
2013-06-09 10:49:13 +00:00
- Bobyshev Alexander
- artblanc
- arturo
2013-06-09 10:49:13 +00:00
- Matt Arsenault
- Keith Bauer
- John Bartholomew
2013-06-16 10:35:46 +00:00
- Niklas Behrens
2013-06-09 10:49:13 +00:00
- Niklas Bergström
2013-08-16 15:48:11 +00:00
- Doug Binks
2013-06-09 10:49:13 +00:00
- blanco
- Martin Capitanio
2015-04-09 14:09:39 +00:00
- Chi-kwan Chan
2013-06-09 10:49:13 +00:00
- Lambert Clara
2013-10-06 09:37:16 +00:00
- Andrew Corrigan
2013-06-09 10:49:13 +00:00
- Noel Cower
- Jarrod Davis
- Olivier Delannoy
- Paul R. Deppe
2014-02-13 23:45:27 +00:00
- Michael Dickens
2015-10-28 21:57:57 +00:00
- Роман Донченко
2013-06-09 10:49:13 +00:00
- Jonathan Dummer
- Ralph Eastwood
- Siavash Eliasi
2013-12-10 12:45:21 +00:00
- Michael Fogleman
2013-12-11 13:41:51 +00:00
- Gerald Franz
2013-06-09 10:49:13 +00:00
- GeO4d
- Marcus Geelnard
- Eloi Marín Gratacós
2013-06-09 10:49:13 +00:00
- Stefan Gustavson
- Sylvain Hellegouarch
- Matthew Henry
2013-06-09 10:49:13 +00:00
- heromyth
- Lucas Hinderberger
2013-06-16 16:32:16 +00:00
- Paul Holden
- Aaron Jacobs
2013-06-09 10:49:13 +00:00
- Toni Jovanoski
- Arseny Kapoulkine
2013-06-09 10:49:13 +00:00
- Osman Keskin
- Cameron King
- Peter Knut
2015-04-14 19:15:50 +00:00
- Eric Larson
2013-06-09 10:49:13 +00:00
- Robin Leffmann
- Glenn Lewis
- Shane Liesegang
- Eyal Lotem
2013-06-09 10:49:13 +00:00
- Дмитри Малышев
- Martins Mozeiko
- Tristam MacDonald
- Hans Mackowiak
- Zbigniew Mandziejewicz
- Kyle McDonald
2013-06-09 10:49:13 +00:00
- David Medlock
- Bryce Mehring
2013-06-09 10:49:13 +00:00
- Jonathan Mercier
- Marcel Metz
- Jonathan Miller
2013-06-09 10:49:13 +00:00
- Kenneth Miller
2013-07-01 11:18:05 +00:00
- Bruce Mitchener
2013-10-28 12:22:34 +00:00
- Jack Moffitt
2013-06-09 10:49:13 +00:00
- Jeff Molofee
- Jon Morton
2013-09-13 12:41:13 +00:00
- Pierre Moulon
2013-06-09 10:49:13 +00:00
- Julian Møller
2013-11-13 11:59:49 +00:00
- Kamil Nowakowski
2013-06-17 09:58:46 +00:00
- Ozzy
- Andri Pálsson
2013-06-09 10:49:13 +00:00
- Peoro
- Braden Pellett
- Arturo J. Pérez
2015-04-19 11:27:27 +00:00
- Emmanuel Gil Peyrot
- Cyril Pichard
2013-10-09 21:58:43 +00:00
- Pieroman
2013-06-09 10:49:13 +00:00
- Jorge Rodriguez
- Ed Ropple
- Aleksey Rybalkin
2013-06-09 10:49:13 +00:00
- Riku Salminen
- Brandon Schaefer
2013-06-09 10:49:13 +00:00
- Sebastian Schuberth
- Matt Sealey
- SephiRok
- Steve Sexton
- Systemcluster
2013-06-09 10:49:13 +00:00
- Dmitri Shuralyov
- Daniel Skorupski
- Bradley Smith
- Julian Squires
- Johannes Stein
- Justin Stoecker
2015-04-09 12:03:26 +00:00
- Elviss Strazdins
2013-06-09 10:49:13 +00:00
- Nathan Sweet
- TTK-Bandit
- Sergey Tikhomirov
- A. Tombs
2013-06-09 10:49:13 +00:00
- Samuli Tuomola
- urraka
2013-06-09 10:49:13 +00:00
- Jari Vetoniemi
2014-07-01 08:49:50 +00:00
- Ricardo Vieira
- Nicholas Vitovitch
2013-06-09 10:49:13 +00:00
- Simon Voordouw
- Torsten Walluhn
- Patrick Walton
2013-06-09 10:49:13 +00:00
- Jay Weisskopf
- Frank Wille
- yuriks
- Santi Zupancic
2014-03-18 20:43:24 +00:00
- Jonas Ådahl
2013-06-09 10:49:13 +00:00
- Lasse Öörni
- All the unmentioned and anonymous contributors in the GLFW community, for bug
reports, patches, feedback, testing and encouragement