mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-10 00:51:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
3af1a1f514
glfw/README.md

149 lines
6.0 KiB
Markdown
Raw Normal View History

Removed version noise.
2013-06-13 13:07:28 +00:00
# GLFW
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Migrate from Travis CI to GitHub Actions The old Travis CI .org service has been throttled for a while now and is said to be shutting down completely next week. This migrates the Travis CI build jobs to GitHub Actions, with minor changes. - The trailing whitespace detection has been removed for now. - The libegl1-mesa-dev dependency for Wayland has been removed as it appears to no longer be necessary for building. (cherry picked from commit 5a6001a83be1c788e7795d891b6a9dd5931e460e)
2021-06-07 20:21:23 +00:00
[![Build status](https://github.com/glfw/glfw/actions/workflows/build.yml/badge.svg)](https://github.com/glfw/glfw/actions)
CI file fixes
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)
Add Coverity badge, I guess
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)
Add initial Travis CI file
2015-04-14 21:47:17 +00:00
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
## Introduction
Documentation work
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.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Documentation work
2019-04-15 23:36:49 +00:00
GLFW natively supports Windows, macOS and Linux and other Unix-like systems. On
Fix typo Fixes #1601. (cherry picked from commit ac30ef3e0c6cac8bbd54b142eadfedd8dd3fe91b)
2019-08-28 19:28:23 +00:00
Linux both X11 and Wayland are supported.
Documentation work
2017-01-29 19:10:53 +00:00
Documentation work
2016-08-17 14:48:22 +00:00
GLFW is licensed under the [zlib/libpng
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
license](https://www.glfw.org/license.html).
Start 3.2.1
2016-06-05 17:35:39 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
You can [download](https://www.glfw.org/download.html) the latest stable release
Documentation work
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
Documentation work
2016-08-17 14:48:22 +00:00
tag](https://github.com/glfw/glfw/releases) with source and binary archives.
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
The [documentation](https://www.glfw.org/docs/latest/) is available online and is
Documentation work
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
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
history](https://www.glfw.org/changelog.html).
Documentation work
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.
Start 3.3
2016-08-18 21:42:15 +00:00
Updated readme links to guides.
2013-04-07 11:26:06 +00:00
If you are new to GLFW, you may find the
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
[tutorial](https://www.glfw.org/docs/latest/quick.html) for GLFW 3 useful. If
Documentation work
2017-07-11 22:21:17 +00:00
you have used GLFW 2 in the past, there is a [transition
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
guide](https://www.glfw.org/docs/latest/moving.html) for moving to the GLFW
Documentation work
2017-07-11 22:21:17 +00:00
3 API.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Move list of contributors to separate file Fixes #1839 (cherry picked from commit 53d7622a3a78757d5297ecafa235fac64a62b0a9)
2021-07-19 16:25:50 +00:00
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.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Moved GLFW compilation guide to docs.
2013-10-27 11:50:33 +00:00
## Compiling GLFW
Cross-linked build guides.
2013-10-21 20:23:15 +00:00
Documentation work
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.
Documentation work [ci skip]
2016-07-14 16:32:30 +00:00
Documentation work [ci skip]
2016-07-14 16:29:39 +00:00
GLFW supports compilation on Windows with Visual C++ 2010 and later, MinGW and
Update default name from OS X to macOS Note that earlier releases are still referred to by their proper names; OS X <version> or Mac OS X <version>.
2016-10-19 22:50:54 +00:00
MinGW-w64, on macOS with Clang and on Linux and other Unix-like systems with GCC
Documentation work [ci skip]
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.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
There are [pre-compiled Windows binaries](https://www.glfw.org/download.html)
Documentation work
2017-07-11 22:21:17 +00:00
available for all supported compilers.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
See the [compilation guide](https://www.glfw.org/docs/latest/compile.html) for
Documentation work
2017-07-11 22:21:17 +00:00
more information about how to compile GLFW yourself.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Documentation work
2016-07-14 16:02:44 +00:00
Documentation work [ci skip]
2016-07-14 16:11:17 +00:00
## Using GLFW
Documentation work
2016-07-14 16:02:44 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
See the [documentation](https://www.glfw.org/docs/latest/) for tutorials, guides
Documentation work
2017-01-29 19:10:53 +00:00
and the API reference.
## Contributing to GLFW
See the [contribution
Move contribution guide to visible directory
2017-11-20 17:55:43 +00:00
guide](https://github.com/glfw/glfw/blob/master/docs/CONTRIBUTING.md) for
Documentation work
2017-01-29 19:10:53 +00:00
more information.
Documentation work
2016-07-14 16:02:44 +00:00
Documentation work [ci skip]
2016-07-14 16:11:17 +00:00
## System requirements
Documentation work
2016-07-14 16:02:44 +00:00
Cocoa: Move slightly towards modern Objective-C
2019-01-03 18:32:45 +00:00
GLFW supports Windows XP and later and macOS 10.8 and later. Linux and other
Documentation work
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.
Documentation work
2016-07-14 16:02:44 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
See the [compatibility guide](https://www.glfw.org/docs/latest/compat.html)
Documentation work [ci skip]
2016-07-14 16:19:46 +00:00
in the documentation for more information.
Documentation work
2016-07-14 16:02:44 +00:00
Added dependency section to readme.
2014-01-12 04:40:36 +00:00
## Dependencies
Documentation work
2016-08-08 23:34:56 +00:00
GLFW itself depends only on the headers and libraries for your window system.
Add note on extra-cmake-modules dependency The Wayland backend requires this package to generate headers from XML protocol descriptions. Although this package was created by the KDE project, it does not depend on any part of KDE. Fixes #1013. [ci skip]
2017-06-09 14:32:24 +00:00
The (experimental) Wayland backend also depends on the `extra-cmake-modules`
Fix typo (cherry picked from commit 7e03bce1387696918bef4a7022cb5cc3db39e2ea)
2019-12-10 19:10:12 +00:00
package, which is used to generate Wayland protocol headers.
Add note on extra-cmake-modules dependency The Wayland backend requires this package to generate headers from XML protocol descriptions. Although this package was created by the KDE project, it does not depend on any part of KDE. Fixes #1013. [ci skip]
2017-06-09 14:32:24 +00:00
Documentation work [ci skip]
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.
Added dependency section to readme.
2014-01-12 04:40:36 +00:00
Clarified dependency list.
2014-06-18 14:13:49 +00:00
- [getopt\_port](https://github.com/kimgr/getopt_port/) for examples
with command-line options
Updated TinyCThread URL.
2014-10-15 01:55:25 +00:00
- [TinyCThread](https://github.com/tinycthread/tinycthread) for threaded
Clarified dependency list.
2014-06-18 14:13:49 +00:00
examples
Replace glad and the Vulkan SDK with glad2 This removes all dependencies from the GLFW test programs on the Vulkan SDK. It also removes support for linking the GLFW shared library (dynamic library, DLL) against the Vulkan loader static library.
2019-04-14 15:34:38 +00:00
- [glad2](https://github.com/Dav1dde/glad) for loading OpenGL and Vulkan
functions
Add linmath.h to readme dependency list
2015-08-09 14:58:25 +00:00
- [linmath.h](https://github.com/datenwolf/linmath.h) for linear algebra in
examples
Update repo URL for Nuklear Fixes #1826. (cherry picked from commit 5d1d1a01e3a05c068289487831940896d9a5902e)
2021-01-03 20:13:02 +00:00
- [Nuklear](https://github.com/Immediate-Mode-UI/Nuklear) for test and example UI
Add stb_image_write
2016-10-13 15:42:44 +00:00
- [stb\_image\_write](https://github.com/nothings/stb) for writing images to disk
Add basic Vulkan support Added GLFW_INCLUDE_VULKAN. Added glfwVulkanSupported, glfwGetRequiredInstanceExtensions, glfwGetInstanceProcAddress, glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface. Added port of LunarG SDK tri example.
2015-08-10 18:19:04 +00:00
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
The documentation is generated with [Doxygen](https://doxygen.org/) if CMake can
Documentation work
2017-07-11 22:21:17 +00:00
find that tool.
Documentation work [ci skip]
2016-02-08 15:23:44 +00:00
Added dependency section to readme.
2014-01-12 04:40:36 +00:00
Documentation work [ci skip]
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
Move contribution guide to visible directory
2017-11-20 17:55:43 +00:00
guide](https://github.com/glfw/glfw/blob/master/docs/CONTRIBUTING.md) for
Documentation work [ci skip]
2016-07-14 16:32:30 +00:00
information on what to include when reporting a bug.
Removed more version noise.
2013-06-13 13:09:10 +00:00
## Changelog
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Fix glfwGetKeyName incorrectly emitting error glfwGetKeyName emitted GLFW_INVALID_VALUE when passed GLFW_KEY_UNKNOWN and any scancode not associated with a key token on that platform. This causes physical keys with no associated key token to emit GLFW_INVALID_VALUE when the key and scancode are passed directly from the key event to glfwGetKeyName. This breaks the promise made in the reference documentation for glfwGetKeyName. This commit removes that error for the whole range of valid scancodes. Fixes #1785 Fixes #2214 This was adapted to 3.3-stable from 86bf5698ecfdbe783135ffaf72972a8c562c0fdf.
2023-12-13 14:27:30 +00:00
- Bugfix: `glfwGetKeyName` emitted `GLFW_INVALID_VALUE` for scancodes with no
key token (#1785,#2214)
Wayland: Fix segfault on termination A segfault could occur during termination if libdecor was found but no windows were created between initialization and termination. The wait for libdecor to finish its initialization was only performed before window creation, not at termination. Regression introduced by 9fdc425931888ea70bc095e53cc006fca8ccb703. This was adapted to 3.3-stable from 4e8c4901e9985765a3951423ff9174459339a62b.
2024-01-03 17:01:29 +00:00
- [Wayland] Bugfix: Terminating the library before showing a window could segfault
Wayland: Fix compilation on FreeBSD The list of compile-time dependencies on FreeBSD lacked evdev-proto. Unlike on Linux, the input-event-codes.h header file was not implicitly included on FreeBSD. Fixes #2445 This was adapted to 3.3-stable from 51920ede6827962ca2fbcad38d1beed1165400af.
2024-01-24 15:54:52 +00:00
- [Wayland] Bugfix: Compilation failed on FreeBSD (#2445)
Linux: Fix regfree being called on invalid data This was caused by a careless merge that did not take the differences between the branches into account. Regression introduced by 7c7cc59889883fa0c19daee122373271670e3b26. Fixes #2464
2024-01-14 22:30:32 +00:00
- [Linux] Bugfix: `regfree´ was called on invalid data (#2464)
WGL: Fix pixel format count in a Parallels VM In a Parallels VM wglGetPixelFormatAttribivARB returns fewer pixel formats than DescribePixelFormat. This broke context creation on Windows in Parallels since the changes in 2c0f34b60f7c7a07183ed71754b0156ece3b6c1b. The previous version of the code worked accidentally. This adds a workaround by iterating through the minimum of both counts. It should have no effect when running on conforming implementations. Tested on Parallels by @ dougbinks. Closes #2191 Fixes #2406 Fixes #2467 This was adapted to 3.3-stable from 00e86d4b733103a23278fe53ce58a0d14dd47d32.
2024-01-30 17:21:33 +00:00
- [WGL] Bugfix: Context creation failed in Parallels VM (#2191,#2406,#2467)
Fix glfwMaximizeWindow not checking window mode
2016-06-16 10:52:22 +00:00
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
## Contact
Fix some documentation URLs still using http: Some URLs in the documentation were overlooked during the switch to https: for the GLFW website. This updates those and a few third-party URLs. (cherry picked from commit 787295b3aff950abd45bee3495ac1200eb6bc5e1)
2021-06-09 20:43:27 +00:00
On [glfw.org](https://www.glfw.org/) you can find the latest version of GLFW, as
Documentation work
2016-08-02 13:58:58 +00:00
well as news, documentation and other information about the project.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
If you have questions related to the use of GLFW, we have a
Remove further traces of IRC channel (cherry picked from commit 23962c9dc7e0aa59199211b03a6fbb5700c01c30)
2024-01-25 15:30:56 +00:00
[forum](https://discourse.glfw.org/).
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
If you have a bug to report, a patch to submit or a feature you'd like to
Updated contact information.
2013-06-24 12:28:42 +00:00
request, please file it in the
[issue tracker](https://github.com/glfw/glfw/issues) on GitHub.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Finally, if you're interested in helping out with the development of GLFW or
Remove further traces of IRC channel (cherry picked from commit 23962c9dc7e0aa59199211b03a6fbb5700c01c30)
2024-01-25 15:30:56 +00:00
porting it to your favorite platform, join us on the forum or GitHub.
Replaced readme.html with README.md. Removed historic changelog, updated build and use documentation, reformatted contributor list, removed structure table, etc.
2013-02-04 09:46:02 +00:00
Reference in New Issue Copy Permalink