| commit | bb3b3452f36eb43efce999d751a4d2e8b94a6fcf | [log] [tgz] |
|---|---|---|
| author | Camilla Berglund <elmindreda@elmindreda.org> | Mon Feb 22 12:29:52 2016 +0100 |
| committer | Camilla Berglund <elmindreda@elmindreda.org> | Mon Feb 22 12:29:52 2016 +0100 |
| tree | 6eb98b87129747eeaa13e914c5ea5cd46e5d8907 | |
| parent | 70ffae74303028c6f7748152e6e2ba67bb386b98 [diff] |
Cleanup
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 is not yet described.
If you are new to GLFW, you may find the introductory 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 supportglfwMaximizeWindow and GLFW_MAXIMIZED for window maximizationglfwSetWindowSizeLimits and glfwSetWindowAspectRatio for setting absolute and relative window size limitsglfwGetKeyName for querying the layout-specific name of printable keysGLFW_NO_API for creating window without contextsGLFW_CONTEXT_NO_ERROR context hint for GL_KHR_no_error supportGLFW_INCLUDE_VULKAN for including the Vulkan headerGLFW_TRUE and GLFW_FALSE as client API independent boolean valuesglfwGetGLXWindow to query the GLXWindow of a window_GLFW_USE_OPENGL, _GLFW_USE_GLESV1 and _GLFW_USE_GLESV2 configuration macroslib prefixglfwInitXI_Motion events interfered with the Steam overlayglfwTerminateGLXWindowlibGL.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.