glfw/README.md
2015-02-22 19:22:48 +01:00

5.1 KiB

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.1.1 is not yet described.

If you are new to GLFW, you may find the introductory tutorial for GLFW 3 useful. If you have used GLFW 2 in the past, there is a transition guide for moving to the GLFW 3 API.

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.

Compiling GLFW

See the Compiling GLFW guide in the GLFW documentation.

Using GLFW

See the Building programs that use GLFW guide in the GLFW documentation.

Reporting bugs

Bugs are reported to our issue tracker. 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.

Changelog

  • Bugfix: glfwSetTime silently accepted invalid values
  • [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: Mouse button GLFW_MOUSE_BUTTON_4 was never used
  • [X11] Bugfix: glfwTerminate could close an unrelated file descriptor
  • [X11] Bugfix: Some WMs did not respect cursor redefinition

Contact

The official website for GLFW is 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, and the IRC channel #glfw on Freenode.

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 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, 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
  • Martin Capitanio
  • Lambert Clara
  • Andrew Corrigan
  • Noel Cower
  • Jarrod Davis
  • Olivier Delannoy
  • Paul R. Deppe
  • Michael Dickens
  • Jonathan Dummer
  • Ralph Eastwood
  • Michael Fogleman
  • Gerald Franz
  • GeO4d
  • Marcus Geelnard
  • Eloi Marín Gratacós
  • Stefan Gustavson
  • Sylvain Hellegouarch
  • Matthew Henry
  • heromyth
  • Lucas Hinderberger
  • Paul Holden
  • Toni Jovanoski
  • Arseny Kapoulkine
  • Osman Keskin
  • Cameron King
  • Peter Knut
  • Robin Leffmann
  • Glenn Lewis
  • Shane Liesegang
  • Дмитри Малышев
  • Martins Mozeiko
  • Tristam MacDonald
  • Hans Mackowiak
  • Kyle McDonald
  • David Medlock
  • 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
  • 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
  • Nathan Sweet
  • TTK-Bandit
  • Sergey Tikhomirov
  • 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