| tag | 99ab656443ffd83f6a6ee2027ecb8de5f6814cce | |
|---|---|---|
| tagger | Camilla Berglund <elmindreda@elmindreda.org> | Thu Jun 02 16:57:18 2016 +0200 |
| object | f6ec835599123c3c970d34534ed7ddc69a1fc6af |
Tag 3.2 release
| commit | f6ec835599123c3c970d34534ed7ddc69a1fc6af | [log] [tgz] |
|---|---|---|
| author | Camilla Berglund <elmindreda@glfw.org> | Thu Jun 02 16:13:47 2016 +0200 |
| committer | Camilla Berglund <elmindreda@glfw.org> | Thu Jun 02 16:13:47 2016 +0200 |
| tree | 8294da4610f2031b6e1402e2867794f4552b1676 | |
| parent | 5f17b61ff2a74ac2efc426fa885c37b92b36ebc3 [diff] |
Fix documentation for timer thread safety
GLFW is a free, 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.
Version 3.2 adds support for Vulkan surface creation, window mode switching, window maximization, window input focus control, window size and aspect ratio limits, human-readable key names, window icons, joystick connection events, XInput and DirectInput joystick input, event waiting with timeout, 64-bit integer raw timer, context-less window creation, error-less contexts via GL_KHR_no_error (where available), run-time context creation API selection, Windows 8.1 per-monitor DPI and the CMake config-file package system, adds simpler build-time configuration, improved documentation and fixes for a large number of bugs that together affect all supported platforms.
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.
See the Compiling GLFW guide in the GLFW documentation.
See the Building programs that use GLFW guide in the GLFW documentation.
Bugs are reported to our issue tracker. Please always include the name and version of the OS where the bug occurs and the version of GLFW used. If you have cloned it, include the commit ID used.
If it's a build issue, please also include the build log and the name and version of your development environment.
If it's a context creation issue, please also include the make and model of your graphics card and the version of your driver.
This will help both us and other people experiencing the same bug.
GLFW itself needs only the headers and libraries for your window system. It does not need the headers for any context creation API (WGL, GLX, EGL, NSGL) or rendering API (OpenGL, OpenGL ES, Vulkan) to enable support for them.
The examples and test programs depend on a number of tiny libraries. These are located in the deps/ directory.
The Vulkan example additionally requires the Vulkan SDK to be installed, or it will not be included in the build.
The documentation is generated with Doxygen. If CMake does not find Doxygen, the documentation will not be generated.
glfwVulkanSupported, glfwGetRequiredInstanceExtensions, glfwGetInstanceProcAddress, glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface for platform independent Vulkan supportglfwSetWindowMonitor for switching between windowed and full screen modes and updating the monitor and desired video mode of full screen windowsglfwMaximizeWindow and GLFW_MAXIMIZED for window maximizationglfwFocusWindow for giving windows input focusglfwSetWindowSizeLimits and glfwSetWindowAspectRatio for setting absolute and relative window size limitsglfwGetKeyName for querying the layout-specific name of printable keysglfwWaitEventsTimeout for waiting for events for a set amount of timeglfwSetWindowIcon for setting the icon of a windowglfwGetTimerValue and glfwGetTimerFrequency for raw timer accessglfwSetJoystickCallback and GLFWjoystickfun for joystick connection and disconnection eventsGLFW_NO_API for creating window without contextsGLFW_INCLUDE_VULKAN for including the Vulkan headerGLFW_CONTEXT_CREATION_API, GLFW_NATIVE_CONTEXT_API and GLFW_EGL_CONTEXT_API for run-time context creation API selectionGLFW_CONTEXT_NO_ERROR context hint for GL_KHR_no_error supportGLFW_TRUE and GLFW_FALSE as client API independent boolean values_GLFW_USE_OPENGL, _GLFW_USE_GLESV1, _GLFW_USE_GLESV2, _GLFW_WGL, _GLFW_NSGL, _GLFW_GLX and _GLFW_EGL configuration macroslib prefixGLFW_KEY_UNKNOWNglfwInitXI_Motion events interfered with the Steam overlayglfwTerminateglfwGetGLXWindow to query the GLXWindow of a windowGLXWindowlibGL.so.1_GLFW_USE_EGLPLATFORM_H configuration macro for controlling whether to use an existing EGL/eglplatform.h headerThe official website for GLFW is glfw.org. There 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 support forum, and the IRC channel #glfw on Freenode.
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 GitHub or IRC.
GLFW exists because people around the world donated their time and lent their skills.