glfw/README.md

252 lines
7.4 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)
2016-06-23 14:09:55 +00:00
[![Coverity Scan](https://scan.coverity.com/projects/4884/badge.svg)](https://scan.coverity.com/projects/glfw-glfw)
2015-04-14 21:47:17 +00:00
## 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.
2016-06-05 17:35:39 +00:00
The current stable release is version 3.2. See the
[downloads](http://www.glfw.org/download.html) 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_.
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
2016-02-27 20:58:09 +00:00
[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
2016-07-14 16:32:30 +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
rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them.
2016-07-14 16:29:39 +00:00
GLFW supports compilation on Windows with Visual C++ 2010 and later, MinGW and
MinGW-w64, on OS X with Clang and on Linux and other Unix-like systems with GCC
and Clang. It will likely compile in other environments as well, but this is
not regularly tested.
2016-07-14 16:11:17 +00:00
There are also [pre-compiled Windows
2016-07-14 16:29:39 +00:00
binaries](http://www.glfw.org/download.html) available for all compilers
supported on that platform.
2016-07-14 16:11:17 +00:00
See the [compilation guide](http://www.glfw.org/docs/latest/compile.html) in the
2016-07-14 16:19:46 +00:00
documentation for more information.
2016-07-14 16:02:44 +00:00
2016-07-14 16:11:17 +00:00
## Using GLFW
2016-07-14 16:02:44 +00:00
2016-07-14 16:11:17 +00:00
See the [building application guide](http://www.glfw.org/docs/latest/build.html)
2016-07-14 16:19:46 +00:00
guide in the documentation for more information.
2016-07-14 16:02:44 +00:00
2016-07-14 16:11:17 +00:00
## System requirements
2016-07-14 16:02:44 +00:00
GLFW supports Windows XP and later, OS X 10.7 Lion and later, and Linux and
2016-07-14 16:29:39 +00:00
other Unix-like systems with the X Window System. Experimental implementations
for the Wayland protocol and the Mir display server are available but not yet
officially supported.
2016-07-14 16:02:44 +00:00
See the [compatibility guide](http://www.glfw.org/docs/latest/compat.html)
2016-07-14 16:19:46 +00:00
in the documentation for more information.
2016-07-14 16:02:44 +00:00
2014-01-12 04:40:36 +00:00
## Dependencies
2016-02-08 15:23:44 +00:00
The examples and test programs depend on a number of tiny libraries. These are
located in the `deps/` directory.
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
- [Vulkan headers](https://www.khronos.org/registry/vulkan/) for Vulkan tests
2014-01-12 04:40:36 +00:00
The Vulkan example additionally requires the Vulkan SDK to be installed, or it
will not be included in the build.
2016-02-08 15:23:44 +00:00
The documentation is generated with [Doxygen](http://doxygen.org/). If CMake
does not find Doxygen, the documentation will not be generated.
2014-01-12 04:40:36 +00:00
2016-07-14 16:32:30 +00:00
## Reporting bugs
Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues).
Please check the [contribution
guide](https://github.com/glfw/glfw/blob/master/.github/CONTRIBUTING.md) for
information on what to include when reporting a bug.
2013-06-13 13:09:10 +00:00
## Changelog
2016-07-20 13:50:07 +00:00
- Added on-demand loading of Vulkan and context creation API libraries
2016-07-12 14:14:39 +00:00
- Bugfix: Single compilation unit builds failed due to naming conflicts (#783)
- Bugfix: The range checks for `glfwSetCursorPos` used the wrong minimum (#773)
2016-07-14 16:02:44 +00:00
- [Win32] Bugfix: `glfwSetClipboardString` created an unnecessary intermediate
2016-07-12 14:14:39 +00:00
copy of the string
2016-07-12 14:14:39 +00:00
- [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)
- [X11] Bugfix: Window size limits were ignored if the minimum or maximum size
was set to `GLFW_DONT_CARE` (#805)
- [WGL] Added reporting of errors from `WGL_ARB_create_context` extension
2016-07-12 14:14:39 +00:00
- [GLX] Bugfix: Dynamically loaded entry points were not verified
2016-07-20 13:50:07 +00:00
- [EGL] Added `lib` prefix matching between EGL and OpenGL ES library binaries
2016-07-12 14:14:39 +00:00
- [EGL] Bugfix: Dynamically loaded entry points were not verified
2016-06-05 17:36:03 +00:00
## Contact
2016-08-02 13:58:58 +00:00
On [glfw.org](http://www.glfw.org/) 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
2016-04-20 10:40:56 +00:00
[support forum](http://discourse.glfw.org/), 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
- Роман Донченко
- Mario Dorn
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
- Warren Hu
2016-03-29 12:00:44 +00:00
- IntellectualKitty
- 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
- Christoph Kubisch
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
- Orson Peters
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
- Yoshiki Shibukawa
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
2016-07-14 10:49:46 +00:00
- Arthur Tombs
- Ioannis Tsakpinis
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
- Xo Wang
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