commit | 9959dc69cadd1f7790060846ffbc44e7da56fc56 | [log] [tgz] |
---|---|---|
author | Camilla Löwy <elmindreda@elmindreda.org> | Mon Dec 04 20:06:10 2023 +0100 |
committer | Camilla Löwy <elmindreda@elmindreda.org> | Tue Dec 05 19:10:06 2023 +0100 |
tree | 4de2453f2eee58153d980e6d85e3d51d5834a756 | |
parent | 557a633b2d926431090367e9536cd5ba661a276d [diff] |
Improve documentation relating to key tokens Shifted the documentation away from the term 'named keys' as something different than keys that glfwGetKeyName will return a name for. The already existing term 'key token' should now be used to refer to the GLFW_KEY_* constants. The associated term 'named mouse button' was also replaced with 'supported mouse button'. The parts explaining which key tokens will return a valid scancode from glfwGetKeyScancode have hopefully been clarified. This issue was reported in #2055. The GLFW_KEY_UNKNOWN constant has been moved out of the list of key tokens to simplify and hopefully clarify the related documentation. Various other keyboard key related edits were made, hopefully resulting in improvements. Related to #2055
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.
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.
See the documentation for tutorials, guides and the API reference.
See the contribution guide for more information.
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.
GLFW itself needs only CMake 3.1 or later and the headers and libraries for your OS and window system.
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.
Bugs are reported to our issue tracker. Please check the contribution guide for information on what to include when reporting a bug.
GLFW_PLATFORM
init hint for runtime platform selection (#1958)GLFW_ANY_PLATFORM
, GLFW_PLATFORM_WIN32
, GLFW_PLATFORM_COCOA
, GLFW_PLATFORM_WAYLAND
, GLFW_PLATFORM_X11
and GLFW_PLATFORM_NULL
symbols to specify the desired platform (#1958)glfwGetPlatform
function to query what platform was selected (#1655,#1958)glfwPlatformSupported
function to query if a platform is supported (#1655,#1958)glfwInitAllocator
for setting a custom memory allocator (#544,#1628,#1947)GLFWallocator
struct and GLFWallocatefun
, GLFWreallocatefun
and GLFWdeallocatefun
types (#544,#1628,#1947)glfwInitVulkanLoader
for using a non-default Vulkan loader (#1374,#1890)GLFW_RESIZE_NWSE_CURSOR
, GLFW_RESIZE_NESW_CURSOR
, GLFW_RESIZE_ALL_CURSOR
and GLFW_NOT_ALLOWED_CURSOR
cursor shapes (#427)GLFW_RESIZE_EW_CURSOR
alias for GLFW_HRESIZE_CURSOR
(#427)GLFW_RESIZE_NS_CURSOR
alias for GLFW_VRESIZE_CURSOR
(#427)GLFW_POINTING_HAND_CURSOR
alias for GLFW_HAND_CURSOR
(#427)GLFW_MOUSE_PASSTHROUGH
window hint for letting mouse input pass through the window (#1236,#1568)GLFW_CURSOR_CAPTURED
cursor mode to confine the cursor to the window content area (#58)GLFW_POSITION_X
and GLFW_POSITION_Y
window hints for initial position (#1603,#1747)GLFW_ANY_POSITION
hint value for letting the window manager choose (#1603,#1747)GLFW_PLATFORM_UNAVAILABLE
error for platform detection failures (#1958)GLFW_FEATURE_UNAVAILABLE
error for platform limitations (#1692)GLFW_FEATURE_UNIMPLEMENTED
error for incomplete backends (#1692)GLFW_WAYLAND_APP_ID
window hint string for Wayland app_id selection (#2121,#2122)GLFW_ANGLE_PLATFORM_TYPE
init hint and GLFW_ANGLE_PLATFORM_TYPE_*
values to select ANGLE backend (#1380)GLFW_X11_XCB_VULKAN_SURFACE
init hint for selecting X11 Vulkan surface extension (#1793)GLFW_NATIVE_INCLUDE_NONE
for disabling inclusion of native headers (#1348)GLFW_BUILD_WIN32
CMake option for enabling Win32 support (#1958)GLFW_BUILD_COCOA
CMake option for enabling Cocoa support (#1958)GLFW_BUILD_X11
CMake option for enabling X11 support (#1958)GLFW_LIBRARY_TYPE
CMake variable for overriding the library type (#279,#1307,#1497,#1574,#1928)GLFW_PKG_CONFIG_REQUIRES_PRIVATE
and GLFW_PKG_CONFIG_LIBS_PRIVATE
CMake variables exposing pkg-config dependencies (#1307)GLFW_DOUBLEBUFFER
a read-only window attributeGLFW_USE_WAYLAND
CMake option to GLFW_BUILD_WAYLAND
(#1958)GLFW_USE_OSMESA
CMake option enabling the Null platform (#1958)GLFW_INVALID_VALUE
due to incompatible controllers sharing hardware ID (#1763)glfwMakeContextCurrent
would access TLS slot before initializationglfwSetGammaRamp
could emit GLFW_INVALID_VALUE
before initializationglfwGetJoystickUserPointer
returned NULL
during disconnection (#2092)glfwGetKeyScancode
returned 0
on error when initialized instead of -1
GLFW_WIN32_KEYBOARD_MENU
window hint for enabling access to the window menuGLFW_INCLUDE_VULKAN
plus VK_USE_PLATFORM_WIN32_KHR
caused symbol redefinition (#1524)GLFW_MAXIMIZED
did not move or resize the window (#1499)glfwGetKeyName
could access out of bounds and return an invalid pointerGLFW_KEY_UNKNOWN
(#1623)GLFW_SCALE_TO_MONITOR
had no effect on systems older than Windows 10 version 1703 (#1511)USE_MSVC_RUNTIME_LIBRARY_DLL
had no effect on CMake 3.15 or later (#1783,#1796)glfwMaximizeWindow
would make a hidden window visibleAlt+PrtSc
would emit GLFW_KEY_UNKNOWN
and a different scancode than PrtSc
(#1993)GLFW_KEY_PAUSE
scancode from glfwGetKeyScancode
did not match event scancode (#1993)GLFW_KEY_UNKNOWN
when using a CJK IME (#2050)glfwWaitEventsTimeout
did not return for some sent messages (#2408)VK_EXT_metal_surface
(#1619)EGLNativeWindowType
from NSView
to CALayer
(#1169)GLFW_RESIZABLE
is falseglfwSetWindowSize
used a bottom-left anchor point (#1553)kIOMasterPortDefault
was deprecated in macOS 12.0 (#1980)kUTTypeURL
was deprecated in macOS 12.0 (#2003)GLFW_MAXIMIZED
was always true when GLFW_RESIZABLE
was falseGLFW_DECORATED
in macOS fullscreen would abort application (#1886)Frameworks
bundle subdirectory (#2113,#2120)glfwMaximizeWindow
had no effect on hidden windowsGLFW_FLOATING
on a hidden window caused invalid readGLFW_FLOATING
on a hidden window could silently failglfwFocusWindow
could terminate on older WMs or without a WMBadWindow
error (#1633)GLFW_KEY_UNKNOWN
for some layout combinations (#1598)GLFW_FLOATING
could leak memoryglfwWaitEvents*
did not continue for joystick eventsglfwPostEmptyEvent
could be ignored due to race condition (#379,#1281,#1285,#2033)EGL_EXT_present_opaque
(#1895)wl_shell
(#1443)GLFW_HAND_CURSOR
shape used the wrong image (#1432)CLOCK_MONOTONIC
was not correctly enabledNULL
window (#1704)O_CLOEXEC
flag was not defined on FreeBSDGLFW_VISIBLE
GLFW_KEY_UNKNOWN
glfwPostEmptyEvent
sometimes had no effect (#1520,#1521)glfwSetClipboardString
would fail if set to result of glfwGetClipboardString
glfwCreateWindow
could emit GLFW_FEATURE_UNAVAILABLE
glfwSetWindowMonitor
did not update windowed mode sizeglfwRestoreWindow
would make a full screen window windowedglfwRestoreWindow
assumed it was always in windowed modeglfwSetWindowSize
would resize a full screen windowglfwInit
failed it would close stdinGLFW_DECORATED
had no effect on server-side decorationsglfwTerminate
would segfault if any monitor had changed scaleglfwSetWindowAspectRatio
reported an error instead of applying the specified ratioGLFW_MAXIMIZED
window hint had no effectglfwRestoreWindow
had no effect before first showGLFW_DECORATED
was ignored when showing a window with XDG decorationsglfwInit
would segfault (#1450)glfwInit
were not detected (#2198)GLFW_CURSOR_UNAVAILABLE
errorsgettimeofday
CLOCK_MONOTONIC
was not correctly tested for or enabledGLFW_COCOA_RETINA_FRAMEBUFFER
had no effect on newer macOS versions (#1442)GL_SILENCE_DEPRECATION
externally caused a duplicate definition warning (#1840)EGL_EXT_platform_base
extension (#442)EGL_ANGLE_platform_angle
extension (#1380) [EGL] Added loading of glvnd libOpenGL.so.0
where available for OpenGLGLFW_DOUBLEBUFFER
context attribute was ignored (#1843)libGLX.so.0
where availableOn 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.