mirror/glfw
1
0
Fork 0
mirror of https://github.com/glfw/glfw.git synced 2024-11-15 02:34:36 +00:00
Code Issues Packages Projects Releases Wiki Activity
ed65906282
glfw/README.md

149 lines
6.3 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.
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 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
Wayland related documentation work
2024-02-19 14:06:59 +00:00
Linux both Wayland and X11 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.
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.
2021-06-09 20:43:27 +00:00
You can [download](https://www.glfw.org/download.html) the latest stable release
Documentation updates for 3.4 release
2024-02-22 21:22:47 +00:00
as source or Windows binaries. Each release starting with 3.0 also has
a corresponding [annotated tag](https://github.com/glfw/glfw/releases) with
source and binary archives.
Documentation work
2016-08-17 14:48:22 +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.
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.
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.
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.
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
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
Update compilation-related parts of README
2024-01-29 21:47:04 +00:00
GLFW is written primarily in C99, with parts of macOS support being written in
Objective-C. GLFW itself requires only the headers and libraries for your OS
and window system. It does not need any additional headers for context creation
APIs (WGL, GLX, EGL, NSGL, OSMesa) or rendering APIs (OpenGL, OpenGL ES, Vulkan)
to enable support for them.
Documentation work [ci skip]
2016-07-14 16:32:30 +00:00
Update compilation-related parts of README
2024-01-29 21:47:04 +00:00
GLFW supports compilation on Windows with Visual C++ 2013 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
Update compilation-related parts of README
2024-01-29 21:47:04 +00:00
There are [pre-compiled binaries](https://www.glfw.org/download.html) available
for all supported compilers on Windows and macOS.
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.
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.
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.
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
Fix minimum CMake version in README
2024-02-29 14:39:21 +00:00
GLFW itself needs only CMake 3.4 or later and the headers and libraries for your
Update minimum required CMake version to 3.1
2019-11-26 17:09:22 +00:00
OS and window system.
Documentation work
2016-08-08 23:34:56 +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.
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.
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.
Start 3.5
2024-02-29 14:28:46 +00:00
## Changelog since 3.4
Fix glfwMaximizeWindow not checking window mode
2016-06-16 10:52:22 +00:00
Unlimited mouse button input mode This adds the GLFW_UNLIMITED_MOUSE_BUTTONS input mode which permits mouse buttons over GLFW_MOUSE_BUTTON_LAST to be reported to the mouse button callback. Closes #2423
2024-02-29 15:50:50 +00:00
- Added `GLFW_UNLIMITED_MOUSE_BUTTONS` input mode that allows mouse buttons beyond
the limit of the mouse button tokens to be reported (#2423)
Wayland: Fix leak of surface scaling objects
2024-03-08 14:22:36 +00:00
- [Wayland] Bugfix: The fractional scaling related objects were not destroyed
Wayland: Fix segfault when there is no seat Bug encountered running on a headless instance of Weston. Fixes #2517
2024-03-25 20:00:08 +00:00
- [Wayland] Bugfix: `glfwInit` would segfault on compositor with no seat (#2517)
Null: Add Vulkan 'window' surface creation This adds support for Vulkan 'window' surface creation on the Null platform via the VK_EXT_headless_surface extension, where available. Tested with MoltenVK.
2024-03-11 10:33:51 +00:00
- [Null] Added Vulkan 'window' surface creation via `VK_EXT_headless_surface`
Null: Add limited EGL context creation on Mesa This provides very limited support for context creation via EGL on the Null platform. It supports Unix-like systems with a version of Mesa that provides EGL_MESA_platform_surfaceless. Even then, the actual framebuffer provided is not resized along with the 'window'. That will hopefully change once context and framebuffer creation are separated, but this commit should at least allow more applications than before to run on the Null platform.
2024-03-11 13:29:07 +00:00
- [Null] Added EGL context creation on Mesa via `EGL_MESA_platform_surfaceless`
EGL: Allow native access with defaults on Wayland The intent of enforcing GLFW_EGL_CONTEXT_API for EGL native access functions was to ensure that the application had requested the same context creation API at window creation time that it then attempted native access for. With the 3.4 ABI this both isn't true anymore, as a single binary may have multiple meanings of GLFW_NATIVE_CONTEXT_API, and is no longer necessary, since glfwGetPlatform provides enough information to disambiguate even without knowing what GLFW_PLATFORM was set to. This all leaves the requirement that the context creation API be GLFW_EGL_CONTEXT_API as just an unnecessary annoyance. Fixes #2518
2024-03-25 20:02:10 +00:00
- [EGL] Allowed native access on Wayland with `GLFW_CONTEXT_CREATION_API` set to
`GLFW_NATIVE_CONTEXT_API` (#2518)
Update docs, readme, news, and contributors
2024-04-10 17:39:41 +00:00
- Added `GLFWgamepadstatefun`, `glfwSetGamepadStateCallback`, `GLFWjoystickbuttonfun`,`glfwSetJoystickButtonCallback`, `GLFWjoystickaxisfun`, `glfwSetJoystickAxisCallback`, `GLFWjoystickhatfun`, and `glfwSetJoystickHatCallback` for event-based joystick/gamepad input.
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.
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
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
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