glfw/README.md

147 lines
5.8 KiB
Markdown
Raw Normal View History

2013-06-13 13:07:28 +00:00
# GLFW
[![Build status](https://github.com/glfw/glfw/actions/workflows/build.yml/badge.svg)](https://github.com/glfw/glfw/actions)
2016-02-04 13:58:44 +00:00
[![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
2016-08-08 23:34:56 +00:00
GLFW is an 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.
2019-04-15 23:36:49 +00:00
GLFW natively supports Windows, macOS and Linux and other Unix-like systems. On
Linux both X11 and Wayland are supported.
2017-01-29 19:10:53 +00:00
2016-08-17 14:48:22 +00:00
GLFW is licensed under the [zlib/libpng
license](https://www.glfw.org/license.html).
2016-06-05 17:35:39 +00:00
You can [download](https://www.glfw.org/download.html) the latest stable release
2019-04-15 23:36:49 +00:00
as source or Windows binaries, or fetch the `latest` branch from GitHub. Each
release starting with 3.0 also has a corresponding [annotated
2016-08-17 14:48:22 +00:00
tag](https://github.com/glfw/glfw/releases) with source and binary archives.
The [documentation](https://www.glfw.org/docs/latest/) is available online and is
2019-04-15 23:36:49 +00:00
included in all source and binary archives. See the [release
notes](https://www.glfw.org/docs/latest/news.html) for new features, caveats and
deprecations in the latest release. For more details see the [version
history](https://www.glfw.org/changelog.html).
2017-01-29 19:10:53 +00:00
The `master` branch is the stable integration branch and _should_ always compile
and run on all supported platforms, although details of newly added features may
change until they have been included in a release. New features and many bug
fixes live in [other branches](https://github.com/glfw/glfw/branches/all) until
they are stable enough to merge.
2016-08-18 21:42:15 +00:00
2013-04-07 11:26:06 +00:00
If you are new to GLFW, you may find the
[tutorial](https://www.glfw.org/docs/latest/quick.html) for GLFW 3 useful. If
2017-07-11 22:21:17 +00:00
you have used GLFW 2 in the past, there is a [transition
guide](https://www.glfw.org/docs/latest/moving.html) for moving to the GLFW
2017-07-11 22:21:17 +00:00
3 API.
GLFW exists because of the contributions of [many people](CONTRIBUTORS.md)
around the world, whether by reporting bugs, providing community support, adding
features, reviewing or testing code, debugging, proofreading docs, suggesting
features or fixing bugs.
2013-10-27 11:50:33 +00:00
## Compiling GLFW
2013-10-21 20:23:15 +00:00
2019-04-15 23:36:49 +00:00
GLFW itself requires only the headers and libraries for your OS and window
system. It does not need the headers for any context creation API (WGL, GLX,
EGL, NSGL, OSMesa) or rendering API (OpenGL, OpenGL ES, Vulkan) to enable
support for them.
2016-07-14 16:32:30 +00:00
2016-07-14 16:29:39 +00:00
GLFW supports compilation on Windows with Visual C++ 2010 and later, MinGW and
MinGW-w64, on macOS with Clang and on Linux and other Unix-like systems with GCC
2016-07-14 16:29:39 +00:00
and Clang. It will likely compile in other environments as well, but this is
not regularly tested.
There are [pre-compiled Windows binaries](https://www.glfw.org/download.html)
2017-07-11 22:21:17 +00:00
available for all supported compilers.
See the [compilation guide](https://www.glfw.org/docs/latest/compile.html) for
2017-07-11 22:21:17 +00:00
more information about how to compile GLFW yourself.
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
See the [documentation](https://www.glfw.org/docs/latest/) for tutorials, guides
2017-01-29 19:10:53 +00:00
and the API reference.
## Contributing to GLFW
See the [contribution
guide](https://github.com/glfw/glfw/blob/master/docs/CONTRIBUTING.md) for
2017-01-29 19:10:53 +00:00
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 and macOS 10.8 and later. Linux and other
2017-01-29 19:10:53 +00:00
Unix-like systems running the X Window System are supported even without
a desktop environment or modern extensions, although some features require
a running window or clipboard manager. The OSMesa backend requires Mesa 6.3.
2016-07-14 16:02:44 +00:00
See the [compatibility guide](https://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-08-08 23:34:56 +00:00
GLFW itself depends only on the headers and libraries for your window system.
The (experimental) Wayland backend also depends on the `extra-cmake-modules`
package, which is used to generate Wayland protocol headers.
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
- [glad2](https://github.com/Dav1dde/glad) for loading OpenGL and Vulkan
functions
- [linmath.h](https://github.com/datenwolf/linmath.h) for linear algebra in
examples
- [Nuklear](https://github.com/Immediate-Mode-UI/Nuklear) for test and example UI
2016-10-13 15:42:44 +00:00
- [stb\_image\_write](https://github.com/nothings/stb) for writing images to disk
The documentation is generated with [Doxygen](https://doxygen.org/) if CMake can
2017-07-11 22:21:17 +00:00
find that tool.
2016-02-08 15:23:44 +00:00
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/docs/CONTRIBUTING.md) for
2016-07-14 16:32:30 +00:00
information on what to include when reporting a bug.
2013-06-13 13:09:10 +00:00
## Changelog
- Bugfix: Joysticks connected before init did not get gamepad mappings (#1996)
2021-11-24 22:08:49 +00:00
- [Cocoa] Bugfix: A dependency on an external constant caused crashes on macOS
11 and earlier (#1985,#1994)
## Contact
On [glfw.org](https://www.glfw.org/) you can find the latest version of GLFW, as
2016-08-02 13:58:58 +00:00
well as news, documentation and other information about the project.
If you have questions related to the use of GLFW, we have a
[forum](https://discourse.glfw.org/), and the `#glfw` IRC channel on
[Libera.Chat](https://libera.chat/).
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
2016-08-17 14:48:22 +00:00
porting it to your favorite platform, join us on the forum, GitHub or IRC.