glfw mirror
Go to file
Stephen Gutekanst 6281424988 X11: Fix undefined behavior in glfwSetWindowIcon
The conversion of window icon image data involves unsigned char color
values being promoted to int and then shifted to the left by 24.  For
32-bit ints this is just far enough to trigger undefined behavior.

It worked by accident because of how current compilers translate this
piece of code.

This was caught by @slimsag while working on [Zig bindings for GLFW][1],
and diagnosed together with @Andoryuuta, as described [in an
article][2].  Zig has UBSan enabled by default, which caught this
undefined behavior.

[1]: https://github.com/hexops/mach-glfw
[2]: https://devlog.hexops.com/2021/perfecting-glfw-for-zig-and-finding-undefined-behavior#finding-lurking-undefined-behavior-in-6-year-old-glfw-code

Thanks to Maato, martinhath, dcousens, drfuchs and Validark for helping
to refine the solution.

This commit message was rewritten by @elmindreda to hopefully reflect
the conclusions of the pull request thread.

Related to hexops/mach#20
Closes #1986

(cherry picked from commit 9cd4d2fa20)
2021-12-08 19:58:12 +01:00
.github/workflows Add 'latest' branch to all CI builds 2021-06-25 00:23:10 +02:00
CMake Remove truism from end of gamepad mapping regexp 2021-08-27 17:22:05 +02:00
deps Correct sign in mat4x4_rotate_Y 2020-05-19 14:33:27 +02:00
docs Remove Doxyfile tags obsoleted by Doxygen 1.9.2 2021-10-17 20:34:05 +02:00
examples Fix source comment typo 2021-11-30 19:04:14 +01:00
include/GLFW Fix docs calling GLFW_CONTEXT_REVISION a hint 2021-11-30 19:04:56 +01:00
src X11: Fix undefined behavior in glfwSetWindowIcon 2021-12-08 19:58:12 +01:00
tests Win32: Fix compilation with standalone LLVM 2021-06-09 18:31:39 +02:00
.appveyor.yml Add 'latest' branch to all CI builds 2021-06-25 00:23:10 +02:00
.gitattributes Exclude CI and Git dotfiles from Git export 2019-04-01 17:41:04 +02:00
.gitignore Fix .gitignore entries for VS with CMake 2019-12-19 06:39:27 +01:00
.mailmap Add initial .mailmap file 2019-11-14 21:34:10 +01:00
cmake_uninstall.cmake.in Formatting. 2012-08-19 02:33:43 +02:00
CMakeLists.txt Start 3.3.6 2021-10-28 22:16:41 +02:00
CONTRIBUTORS.md Add credit 2021-11-30 19:04:04 +01:00
LICENSE.md Fix license copyright year and formatting 2019-09-23 15:26:13 +02:00
README.md Fix mappings for gamepads present at init 2021-11-24 23:09:24 +01:00

GLFW

Build status Build status Coverity Scan

Introduction

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.

GLFW natively supports Windows, macOS and Linux and other Unix-like systems. On Linux both X11 and Wayland are supported.

GLFW is licensed under the zlib/libpng license.

You can download the latest stable release as source or Windows binaries, or fetch the latest branch from GitHub. Each release starting with 3.0 also has a corresponding annotated tag with source and binary archives.

The documentation is available online and is included in all source and binary archives. See the release notes for new features, caveats and deprecations in the latest release. For more details see the version history.

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 until they are stable enough to merge.

If you are new to GLFW, you may find the 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.

GLFW exists because of the contributions of many people around the world, whether by reporting bugs, providing community support, adding features, reviewing or testing code, debugging, proofreading docs, suggesting features or fixing bugs.

Compiling GLFW

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.

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 and Clang. It will likely compile in other environments as well, but this is not regularly tested.

There are pre-compiled Windows binaries available for all supported compilers.

See the compilation guide for more information about how to compile GLFW yourself.

Using GLFW

See the documentation for tutorials, guides and the API reference.

Contributing to GLFW

See the contribution guide for more information.

System requirements

GLFW supports Windows XP and later and macOS 10.8 and later. Linux and other 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.

See the compatibility guide in the documentation for more information.

Dependencies

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.

The examples and test programs depend on a number of tiny libraries. These are located in the deps/ directory.

The documentation is generated with Doxygen if CMake can find that tool.

Reporting bugs

Bugs are reported to our issue tracker. Please check the contribution guide for information on what to include when reporting a bug.

Changelog

  • Bugfix: Joysticks connected before init did not get gamepad mappings (#1996)
  • [Cocoa] Bugfix: A dependency on an external constant caused crashes on macOS 11 and earlier (#1985,#1994)

Contact

On 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 forum, and the #glfw IRC channel on Libera.Chat.

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, join us on the forum, GitHub or IRC.