diff --git a/CMakeLists.txt b/CMakeLists.txt
index fc742317c0..9fb311b115 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -107,7 +107,7 @@ if (ENABLE_GLFW)
set(TMP_TOOLSET "mingw-${TMP_ARCH}")
endif()
- set(GLFW_PREFIX "${CMAKE_CURRENT_SOURCE_DIR}/externals/glfw-3.0.4.bin")
+ set(GLFW_PREFIX "${CMAKE_CURRENT_SOURCE_DIR}/externals/glfw-3.1.1.bin")
set(GLFW_INCLUDE_DIRS "${GLFW_PREFIX}/include" CACHE PATH "Path to GLFW3 headers")
set(GLFW_LIBRARY_DIRS "${GLFW_PREFIX}/lib-${TMP_TOOLSET}" CACHE PATH "Path to GLFW3 libraries")
diff --git a/externals/glfw-3.0.4.bin/include/GLFW/glfw3native.h b/externals/glfw-3.0.4.bin/include/GLFW/glfw3native.h
deleted file mode 100644
index d570f58762..0000000000
--- a/externals/glfw-3.0.4.bin/include/GLFW/glfw3native.h
+++ /dev/null
@@ -1,180 +0,0 @@
-/*************************************************************************
- * GLFW 3.0 - www.glfw.org
- * A library for OpenGL, window and input
- *------------------------------------------------------------------------
- * Copyright (c) 2002-2006 Marcus Geelnard
- * Copyright (c) 2006-2010 Camilla Berglund <elmindreda@elmindreda.org>
- *
- * This software is provided 'as-is', without any express or implied
- * warranty. In no event will the authors be held liable for any damages
- * arising from the use of this software.
- *
- * Permission is granted to anyone to use this software for any purpose,
- * including commercial applications, and to alter it and redistribute it
- * freely, subject to the following restrictions:
- *
- * 1. The origin of this software must not be misrepresented; you must not
- * claim that you wrote the original software. If you use this software
- * in a product, an acknowledgment in the product documentation would
- * be appreciated but is not required.
- *
- * 2. Altered source versions must be plainly marked as such, and must not
- * be misrepresented as being the original software.
- *
- * 3. This notice may not be removed or altered from any source
- * distribution.
- *
- *************************************************************************/
-
-#ifndef _glfw3_native_h_
-#define _glfw3_native_h_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-/*************************************************************************
- * Doxygen documentation
- *************************************************************************/
-
-/*! @defgroup native Native access
- *
- * **By using the native API, you assert that you know what you're doing and
- * how to fix problems caused by using it. If you don't, you shouldn't be
- * using it.**
- *
- * Before the inclusion of @ref glfw3native.h, you must define exactly one
- * window API macro and exactly one context API macro. Failure to do this
- * will cause a compile-time error.
- *
- * The available window API macros are:
- * * `GLFW_EXPOSE_NATIVE_WIN32`
- * * `GLFW_EXPOSE_NATIVE_COCOA`
- * * `GLFW_EXPOSE_NATIVE_X11`
- *
- * The available context API macros are:
- * * `GLFW_EXPOSE_NATIVE_WGL`
- * * `GLFW_EXPOSE_NATIVE_NSGL`
- * * `GLFW_EXPOSE_NATIVE_GLX`
- * * `GLFW_EXPOSE_NATIVE_EGL`
- *
- * These macros select which of the native access functions that are declared
- * and which platform-specific headers to include. It is then up your (by
- * definition platform-specific) code to handle which of these should be
- * defined.
- */
-
-
-/*************************************************************************
- * System headers and types
- *************************************************************************/
-
-#if defined(GLFW_EXPOSE_NATIVE_WIN32)
- #include <windows.h>
-#elif defined(GLFW_EXPOSE_NATIVE_COCOA)
- #if defined(__OBJC__)
- #import <Cocoa/Cocoa.h>
- #else
- typedef void* id;
- #endif
-#elif defined(GLFW_EXPOSE_NATIVE_X11)
- #include <X11/Xlib.h>
-#else
- #error "No window API specified"
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_WGL)
- /* WGL is declared by windows.h */
-#elif defined(GLFW_EXPOSE_NATIVE_NSGL)
- /* NSGL is declared by Cocoa.h */
-#elif defined(GLFW_EXPOSE_NATIVE_GLX)
- #include <GL/glx.h>
-#elif defined(GLFW_EXPOSE_NATIVE_EGL)
- #include <EGL/egl.h>
-#else
- #error "No context API specified"
-#endif
-
-
-/*************************************************************************
- * Functions
- *************************************************************************/
-
-#if defined(GLFW_EXPOSE_NATIVE_WIN32)
-/*! @brief Returns the `HWND` of the specified window.
- * @return The `HWND` of the specified window.
- * @ingroup native
- */
-GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_WGL)
-/*! @brief Returns the `HGLRC` of the specified window.
- * @return The `HGLRC` of the specified window.
- * @ingroup native
- */
-GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_COCOA)
-/*! @brief Returns the `NSWindow` of the specified window.
- * @return The `NSWindow` of the specified window.
- * @ingroup native
- */
-GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_NSGL)
-/*! @brief Returns the `NSOpenGLContext` of the specified window.
- * @return The `NSOpenGLContext` of the specified window.
- * @ingroup native
- */
-GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_X11)
-/*! @brief Returns the `Display` used by GLFW.
- * @return The `Display` used by GLFW.
- * @ingroup native
- */
-GLFWAPI Display* glfwGetX11Display(void);
-/*! @brief Returns the `Window` of the specified window.
- * @return The `Window` of the specified window.
- * @ingroup native
- */
-GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_GLX)
-/*! @brief Returns the `GLXContext` of the specified window.
- * @return The `GLXContext` of the specified window.
- * @ingroup native
- */
-GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
-#endif
-
-#if defined(GLFW_EXPOSE_NATIVE_EGL)
-/*! @brief Returns the `EGLDisplay` used by GLFW.
- * @return The `EGLDisplay` used by GLFW.
- * @ingroup native
- */
-GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
-/*! @brief Returns the `EGLContext` of the specified window.
- * @return The `EGLContext` of the specified window.
- * @ingroup native
- */
-GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
-/*! @brief Returns the `EGLSurface` of the specified window.
- * @return The `EGLSurface` of the specified window.
- * @ingroup native
- */
-GLFWAPI EGLSurface glfwGetEGLSurface(GLFWwindow* window);
-#endif
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* _glfw3_native_h_ */
-
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3.dll b/externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3.dll
deleted file mode 100644
index 5941d1a0af..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-i686/libglfw3.a b/externals/glfw-3.0.4.bin/lib-mingw-i686/libglfw3.a
deleted file mode 100644
index 7138ee9b5c..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-i686/libglfw3.a and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3.dll b/externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3.dll
deleted file mode 100644
index 49cf94a80b..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/libglfw3.a b/externals/glfw-3.0.4.bin/lib-mingw-x86_64/libglfw3.a
deleted file mode 100644
index d1ca9a42a9..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/libglfw3.a and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.dll b/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.dll
deleted file mode 100644
index d66c5dd89f..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.lib b/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.lib
deleted file mode 100644
index 2f972ab1ad..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3dll.lib b/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3dll.lib
deleted file mode 100644
index 365cdbafb4..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-Win32/glfw3dll.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.dll b/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.dll
deleted file mode 100644
index 44e6d49e41..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.lib b/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.lib
deleted file mode 100644
index 77757999e6..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3dll.lib b/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3dll.lib
deleted file mode 100644
index 20b5484068..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v110-x64/glfw3dll.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.dll b/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.dll
deleted file mode 100644
index e15fc43b45..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.lib b/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.lib
deleted file mode 100644
index 071a0ab843..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3dll.lib b/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3dll.lib
deleted file mode 100644
index d0c5ff5e15..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-Win32/glfw3dll.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.dll b/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.dll
deleted file mode 100644
index 9da042a6b3..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.dll and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.lib b/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.lib
deleted file mode 100644
index e2b495ff56..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3dll.lib b/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3dll.lib
deleted file mode 100644
index 3d6e86418b..0000000000
Binary files a/externals/glfw-3.0.4.bin/lib-msvc_v120-x64/glfw3dll.lib and /dev/null differ
diff --git a/externals/glfw-3.0.4.bin/COPYING.txt b/externals/glfw-3.1.1.bin/COPYING.txt
similarity index 100%
rename from externals/glfw-3.0.4.bin/COPYING.txt
rename to externals/glfw-3.1.1.bin/COPYING.txt
diff --git a/externals/glfw-3.0.4.bin/include/GLFW/glfw3.h b/externals/glfw-3.1.1.bin/include/GLFW/glfw3.h
similarity index 50%
rename from externals/glfw-3.0.4.bin/include/GLFW/glfw3.h
rename to externals/glfw-3.1.1.bin/include/GLFW/glfw3.h
index 0f97738c71..009fa755fd 100644
--- a/externals/glfw-3.0.4.bin/include/GLFW/glfw3.h
+++ b/externals/glfw-3.1.1.bin/include/GLFW/glfw3.h
@@ -1,5 +1,5 @@
/*************************************************************************
- * GLFW 3.0 - www.glfw.org
+ * GLFW 3.1 - www.glfw.org
* A library for OpenGL, window and input
*------------------------------------------------------------------------
* Copyright (c) 2002-2006 Marcus Geelnard
@@ -38,23 +38,27 @@ extern "C" {
* Doxygen documentation
*************************************************************************/
-/*! @defgroup clipboard Clipboard support
- */
/*! @defgroup context Context handling
+ *
+ * This is the reference documentation for context related functions. For more
+ * information, see the @ref context.
*/
-/*! @defgroup error Error handling
- */
-/*! @defgroup init Initialization and version information
+/*! @defgroup init Initialization, version and errors
+ *
+ * This is the reference documentation for initialization and termination of
+ * the library, version management and error handling. For more information,
+ * see the @ref intro.
*/
/*! @defgroup input Input handling
+ *
+ * This is the reference documentation for input related functions and types.
+ * For more information, see the @ref input.
*/
/*! @defgroup monitor Monitor handling
*
* This is the reference documentation for monitor related functions and types.
* For more information, see the @ref monitor.
*/
-/*! @defgroup time Time input
- */
/*! @defgroup window Window handling
*
* This is the reference documentation for window related functions and types,
@@ -64,28 +68,17 @@ extern "C" {
/*************************************************************************
- * Global definitions
+ * Compiler- and platform-specific preprocessor work
*************************************************************************/
-/* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
-
-/* Please report any problems that you find with your compiler, which may
- * be solved in this section! There are several compilers that I have not
- * been able to test this file with yet.
- *
- * First: If we are we on Windows, we want a single define for it (_WIN32)
- * (Note: For Cygwin the compiler flag -mwin32 should be used, but to
- * make sure that things run smoothly for Cygwin users, we add __CYGWIN__
- * to the list of "valid Win32 identifiers", which removes the need for
- * -mwin32)
+/* If we are we on Windows, we want a single define for it.
*/
-#if !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__CYGWIN__))
+#if !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__MINGW32__))
#define _WIN32
#endif /* _WIN32 */
-/* In order for extension support to be portable, we need to define an
- * OpenGL function call method. We use the keyword APIENTRY, which is
- * defined for Win32. (Note: Windows also needs this for <GL/gl.h>)
+/* It is customary to use APIENTRY for OpenGL function pointer declarations on
+ * all platforms. Additionally, the Windows OpenGL header needs APIENTRY.
*/
#ifndef APIENTRY
#ifdef _WIN32
@@ -95,44 +88,23 @@ extern "C" {
#endif
#endif /* APIENTRY */
-/* The following three defines are here solely to make some Windows-based
- * <GL/gl.h> files happy. Theoretically we could include <windows.h>, but
- * it has the major drawback of severely polluting our namespace.
+/* Some Windows OpenGL headers need this.
*/
-
-/* Under Windows, we need WINGDIAPI defined */
#if !defined(WINGDIAPI) && defined(_WIN32)
- #if defined(_MSC_VER) || defined(__BORLANDC__) || defined(__POCC__)
- /* Microsoft Visual C++, Borland C++ Builder and Pelles C */
- #define WINGDIAPI __declspec(dllimport)
- #elif defined(__LCC__)
- /* LCC-Win32 */
- #define WINGDIAPI __stdcall
- #else
- /* Others (e.g. MinGW, Cygwin) */
- #define WINGDIAPI extern
- #endif
+ #define WINGDIAPI __declspec(dllimport)
#define GLFW_WINGDIAPI_DEFINED
#endif /* WINGDIAPI */
-/* Some <GL/glu.h> files also need CALLBACK defined */
+/* Some Windows GLU headers need this.
+ */
#if !defined(CALLBACK) && defined(_WIN32)
- #if defined(_MSC_VER)
- /* Microsoft Visual C++ */
- #if (defined(_M_MRX000) || defined(_M_IX86) || defined(_M_ALPHA) || defined(_M_PPC)) && !defined(MIDL_PASS)
- #define CALLBACK __stdcall
- #else
- #define CALLBACK
- #endif
- #else
- /* Other Windows compilers */
- #define CALLBACK __stdcall
- #endif
+ #define CALLBACK __stdcall
#define GLFW_CALLBACK_DEFINED
#endif /* CALLBACK */
-/* Most GL/glu.h variants on Windows need wchar_t
- * OpenGL/gl.h blocks the definition of ptrdiff_t by glext.h on OS X */
+/* Most Windows GLU headers need wchar_t.
+ * The OS X OpenGL header blocks the definition of ptrdiff_t by glext.h.
+ */
#if !defined(GLFW_INCLUDE_NONE)
#include <stddef.h>
#endif
@@ -140,67 +112,79 @@ extern "C" {
/* Include the chosen client API headers.
*/
#if defined(__APPLE_CC__)
- #if defined(GLFW_INCLUDE_GLCOREARB)
- #include <OpenGL/gl3.h>
- #elif !defined(GLFW_INCLUDE_NONE)
- #define GL_GLEXT_LEGACY
- #include <OpenGL/gl.h>
+ #if defined(GLFW_INCLUDE_GLCOREARB)
+ #include <OpenGL/gl3.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <OpenGL/gl3ext.h>
#endif
- #if defined(GLFW_INCLUDE_GLU)
- #include <OpenGL/glu.h>
+ #elif !defined(GLFW_INCLUDE_NONE)
+ #if !defined(GLFW_INCLUDE_GLEXT)
+ #define GL_GLEXT_LEGACY
#endif
+ #include <OpenGL/gl.h>
+ #endif
+ #if defined(GLFW_INCLUDE_GLU)
+ #include <OpenGL/glu.h>
+ #endif
#else
- #if defined(GLFW_INCLUDE_GLCOREARB)
- #include <GL/glcorearb.h>
- #elif defined(GLFW_INCLUDE_ES1)
- #include <GLES/gl.h>
- #elif defined(GLFW_INCLUDE_ES2)
- #include <GLES2/gl2.h>
- #elif defined(GLFW_INCLUDE_ES3)
- #include <GLES3/gl3.h>
- #elif !defined(GLFW_INCLUDE_NONE)
- #include <GL/gl.h>
+ #if defined(GLFW_INCLUDE_GLCOREARB)
+ #include <GL/glcorearb.h>
+ #elif defined(GLFW_INCLUDE_ES1)
+ #include <GLES/gl.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <GLES/glext.h>
#endif
- #if defined(GLFW_INCLUDE_GLU)
- #include <GL/glu.h>
+ #elif defined(GLFW_INCLUDE_ES2)
+ #include <GLES2/gl2.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <GLES2/gl2ext.h>
#endif
+ #elif defined(GLFW_INCLUDE_ES3)
+ #include <GLES3/gl3.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <GLES3/gl2ext.h>
+ #endif
+ #elif defined(GLFW_INCLUDE_ES31)
+ #include <GLES3/gl31.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <GLES3/gl2ext.h>
+ #endif
+ #elif !defined(GLFW_INCLUDE_NONE)
+ #include <GL/gl.h>
+ #if defined(GLFW_INCLUDE_GLEXT)
+ #include <GL/glext.h>
+ #endif
+ #endif
+ #if defined(GLFW_INCLUDE_GLU)
+ #include <GL/glu.h>
+ #endif
#endif
#if defined(GLFW_DLL) && defined(_GLFW_BUILD_DLL)
- /* GLFW_DLL is defined by users of GLFW when compiling programs that will link
- * to the DLL version of the GLFW library. _GLFW_BUILD_DLL is defined by the
- * GLFW configuration header when compiling the DLL version of the library.
+ /* GLFW_DLL must be defined by applications that are linking against the DLL
+ * version of the GLFW library. _GLFW_BUILD_DLL is defined by the GLFW
+ * configuration header when compiling the DLL version of the library.
*/
- #error "You must not have both GLFW_DLL and _GLFW_BUILD_DLL defined"
+ #error "You may not have both GLFW_DLL and _GLFW_BUILD_DLL defined"
#endif
+/* GLFWAPI is used to declare public API functions for export
+ * from the DLL / shared library / dynamic library.
+ */
#if defined(_WIN32) && defined(_GLFW_BUILD_DLL)
-
- /* We are building a Win32 DLL */
+ /* We are building GLFW as a Win32 DLL */
#define GLFWAPI __declspec(dllexport)
-
#elif defined(_WIN32) && defined(GLFW_DLL)
-
- /* We are calling a Win32 DLL */
- #if defined(__LCC__)
- #define GLFWAPI extern
- #else
- #define GLFWAPI __declspec(dllimport)
- #endif
-
+ /* We are calling GLFW as a Win32 DLL */
+ #define GLFWAPI __declspec(dllimport)
#elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL)
-
+ /* We are building GLFW as a shared / dynamic library */
#define GLFWAPI __attribute__((visibility("default")))
-
#else
-
- /* We are either building/calling a static lib or we are non-win32 */
+ /* We are building or calling GLFW as a static library */
#define GLFWAPI
-
#endif
-/* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
-
/*************************************************************************
* GLFW API tokens
@@ -220,27 +204,36 @@ extern "C" {
* backward-compatible.
* @ingroup init
*/
-#define GLFW_VERSION_MINOR 0
+#define GLFW_VERSION_MINOR 1
/*! @brief The revision number of the GLFW library.
*
* This is incremented when a bug fix release is made that does not contain any
* API changes.
* @ingroup init
*/
-#define GLFW_VERSION_REVISION 4
+#define GLFW_VERSION_REVISION 1
/*! @} */
/*! @name Key and button actions
* @{ */
-/*! @brief The key or button was released.
+/*! @brief The key or mouse button was released.
+ *
+ * The key or mouse button was released.
+ *
* @ingroup input
*/
#define GLFW_RELEASE 0
-/*! @brief The key or button was pressed.
+/*! @brief The key or mouse button was pressed.
+ *
+ * The key or mouse button was pressed.
+ *
* @ingroup input
*/
#define GLFW_PRESS 1
/*! @brief The key was held down until it repeated.
+ *
+ * The key was held down until it repeated.
+ *
* @ingroup input
*/
#define GLFW_REPEAT 2
@@ -248,20 +241,22 @@ extern "C" {
/*! @defgroup keys Keyboard keys
*
- * These key codes are inspired by the *USB HID Usage Tables v1.12* (p. 53-60),
- * but re-arranged to map to 7-bit ASCII for printable keys (function keys are
- * put in the 256+ range).
+ * See [key input](@ref input_key) for how these are used.
*
- * The naming of the key codes follow these rules:
- * - The US keyboard layout is used
- * - Names of printable alpha-numeric characters are used (e.g. "A", "R",
- * "3", etc.)
- * - For non-alphanumeric characters, Unicode:ish names are used (e.g.
- * "COMMA", "LEFT_SQUARE_BRACKET", etc.). Note that some names do not
- * correspond to the Unicode standard (usually for brevity)
- * - Keys that lack a clear US mapping are named "WORLD_x"
- * - For non-printable keys, custom names are used (e.g. "F4",
- * "BACKSPACE", etc.)
+ * These key codes are inspired by the _USB HID Usage Tables v1.12_ (p. 53-60),
+ * but re-arranged to map to 7-bit ASCII for printable keys (function keys are
+ * put in the 256+ range).
+ *
+ * The naming of the key codes follow these rules:
+ * - The US keyboard layout is used
+ * - Names of printable alpha-numeric characters are used (e.g. "A", "R",
+ * "3", etc.)
+ * - For non-alphanumeric characters, Unicode:ish names are used (e.g.
+ * "COMMA", "LEFT_SQUARE_BRACKET", etc.). Note that some names do not
+ * correspond to the Unicode standard (usually for brevity)
+ * - Keys that lack a clear US mapping are named "WORLD_x"
+ * - For non-printable keys, custom names are used (e.g. "F4",
+ * "BACKSPACE", etc.)
*
* @ingroup input
* @{
@@ -398,6 +393,9 @@ extern "C" {
/*! @} */
/*! @defgroup mods Modifier key flags
+ *
+ * See [key input](@ref input_key) for how these are used.
+ *
* @ingroup input
* @{ */
@@ -417,6 +415,9 @@ extern "C" {
/*! @} */
/*! @defgroup buttons Mouse buttons
+ *
+ * See [mouse button input](@ref input_mouse_button) for how these are used.
+ *
* @ingroup input
* @{ */
#define GLFW_MOUSE_BUTTON_1 0
@@ -434,6 +435,9 @@ extern "C" {
/*! @} */
/*! @defgroup joysticks Joysticks
+ *
+ * See [joystick input](@ref joystick) for how these are used.
+ *
* @ingroup input
* @{ */
#define GLFW_JOYSTICK_1 0
@@ -456,36 +460,131 @@ extern "C" {
/*! @} */
/*! @defgroup errors Error codes
- * @ingroup error
+ *
+ * See [error handling](@ref error_handling) for how these are used.
+ *
+ * @ingroup init
* @{ */
/*! @brief GLFW has not been initialized.
+ *
+ * This occurs if a GLFW function was called that may not be called unless the
+ * library is [initialized](@ref intro_init).
+ *
+ * @par Analysis
+ * Application programmer error. Initialize GLFW before calling any function
+ * that requires initialization.
*/
#define GLFW_NOT_INITIALIZED 0x00010001
/*! @brief No context is current for this thread.
+ *
+ * This occurs if a GLFW function was called that needs and operates on the
+ * current OpenGL or OpenGL ES context but no context is current on the calling
+ * thread. One such function is @ref glfwSwapInterval.
+ *
+ * @par Analysis
+ * Application programmer error. Ensure a context is current before calling
+ * functions that require a current context.
*/
#define GLFW_NO_CURRENT_CONTEXT 0x00010002
-/*! @brief One of the enum parameters for the function was given an invalid
- * enum.
+/*! @brief One of the arguments to the function was an invalid enum value.
+ *
+ * One of the arguments to the function was an invalid enum value, for example
+ * requesting [GLFW_RED_BITS](@ref window_hints_fb) with @ref
+ * glfwGetWindowAttrib.
+ *
+ * @par Analysis
+ * Application programmer error. Fix the offending call.
*/
#define GLFW_INVALID_ENUM 0x00010003
-/*! @brief One of the parameters for the function was given an invalid value.
+/*! @brief One of the arguments to the function was an invalid value.
+ *
+ * One of the arguments to the function was an invalid value, for example
+ * requesting a non-existent OpenGL or OpenGL ES version like 2.7.
+ *
+ * Requesting a valid but unavailable OpenGL or OpenGL ES version will instead
+ * result in a @ref GLFW_VERSION_UNAVAILABLE error.
+ *
+ * @par Analysis
+ * Application programmer error. Fix the offending call.
*/
#define GLFW_INVALID_VALUE 0x00010004
/*! @brief A memory allocation failed.
+ *
+ * A memory allocation failed.
+ *
+ * @par Analysis
+ * A bug in GLFW or the underlying operating system. Report the bug to our
+ * [issue tracker](https://github.com/glfw/glfw/issues).
*/
#define GLFW_OUT_OF_MEMORY 0x00010005
/*! @brief GLFW could not find support for the requested client API on the
* system.
+ *
+ * GLFW could not find support for the requested client API on the system. If
+ * emitted by functions other than @ref glfwCreateWindow, no supported client
+ * API was found.
+ *
+ * @par Analysis
+ * The installed graphics driver does not support the requested client API, or
+ * does not support it via the chosen context creation backend. Below are
+ * a few examples.
+ *
+ * @par
+ * Some pre-installed Windows graphics drivers do not support OpenGL. AMD only
+ * supports OpenGL ES via EGL, while Nvidia and Intel only supports it via
+ * a WGL or GLX extension. OS X does not provide OpenGL ES at all. The Mesa
+ * EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary
+ * driver.
*/
#define GLFW_API_UNAVAILABLE 0x00010006
-/*! @brief The requested client API version is not available.
+/*! @brief The requested OpenGL or OpenGL ES version is not available.
+ *
+ * The requested OpenGL or OpenGL ES version (including any requested context
+ * or framebuffer hints) is not available on this machine.
+ *
+ * @par Analysis
+ * The machine does not support your requirements. If your application is
+ * sufficiently flexible, downgrade your requirements and try again.
+ * Otherwise, inform the user that their machine does not match your
+ * requirements.
+ *
+ * @par
+ * Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if 5.0
+ * comes out before the 4.x series gets that far, also fail with this error and
+ * not @ref GLFW_INVALID_VALUE, because GLFW cannot know what future versions
+ * will exist.
*/
#define GLFW_VERSION_UNAVAILABLE 0x00010007
/*! @brief A platform-specific error occurred that does not match any of the
* more specific categories.
+ *
+ * A platform-specific error occurred that does not match any of the more
+ * specific categories.
+ *
+ * @par Analysis
+ * A bug or configuration error in GLFW, the underlying operating system or
+ * its drivers, or a lack of required resources. Report the issue to our
+ * [issue tracker](https://github.com/glfw/glfw/issues).
*/
#define GLFW_PLATFORM_ERROR 0x00010008
-/*! @brief The clipboard did not contain data in the requested format.
+/*! @brief The requested format is not supported or available.
+ *
+ * If emitted during window creation, the requested pixel format is not
+ * supported.
+ *
+ * If emitted when querying the clipboard, the contents of the clipboard could
+ * not be converted to the requested format.
+ *
+ * @par Analysis
+ * If emitted during window creation, one or more
+ * [hard constraints](@ref window_hints_hard) did not match any of the
+ * available pixel formats. If your application is sufficiently flexible,
+ * downgrade your requirements and try again. Otherwise, inform the user that
+ * their machine does not match your requirements.
+ *
+ * @par
+ * If emitted when querying the clipboard, ignore the error or report it to
+ * the user, as appropriate.
*/
#define GLFW_FORMAT_UNAVAILABLE 0x00010009
/*! @} */
@@ -495,6 +594,8 @@ extern "C" {
#define GLFW_RESIZABLE 0x00020003
#define GLFW_VISIBLE 0x00020004
#define GLFW_DECORATED 0x00020005
+#define GLFW_AUTO_ICONIFY 0x00020006
+#define GLFW_FLOATING 0x00020007
#define GLFW_RED_BITS 0x00021001
#define GLFW_GREEN_BITS 0x00021002
@@ -511,6 +612,7 @@ extern "C" {
#define GLFW_SAMPLES 0x0002100D
#define GLFW_SRGB_CAPABLE 0x0002100E
#define GLFW_REFRESH_RATE 0x0002100F
+#define GLFW_DOUBLEBUFFER 0x00021010
#define GLFW_CLIENT_API 0x00022001
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
@@ -520,6 +622,7 @@ extern "C" {
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
#define GLFW_OPENGL_PROFILE 0x00022008
+#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
#define GLFW_OPENGL_API 0x00030001
#define GLFW_OPENGL_ES_API 0x00030002
@@ -540,9 +643,54 @@ extern "C" {
#define GLFW_CURSOR_HIDDEN 0x00034002
#define GLFW_CURSOR_DISABLED 0x00034003
+#define GLFW_ANY_RELEASE_BEHAVIOR 0
+#define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001
+#define GLFW_RELEASE_BEHAVIOR_NONE 0x00035002
+
+/*! @defgroup shapes Standard cursor shapes
+ *
+ * See [standard cursor creation](@ref cursor_standard) for how these are used.
+ *
+ * @ingroup input
+ * @{ */
+
+/*! @brief The regular arrow cursor shape.
+ *
+ * The regular arrow cursor.
+ */
+#define GLFW_ARROW_CURSOR 0x00036001
+/*! @brief The text input I-beam cursor shape.
+ *
+ * The text input I-beam cursor shape.
+ */
+#define GLFW_IBEAM_CURSOR 0x00036002
+/*! @brief The crosshair shape.
+ *
+ * The crosshair shape.
+ */
+#define GLFW_CROSSHAIR_CURSOR 0x00036003
+/*! @brief The hand shape.
+ *
+ * The hand shape.
+ */
+#define GLFW_HAND_CURSOR 0x00036004
+/*! @brief The horizontal resize arrow shape.
+ *
+ * The horizontal resize arrow shape.
+ */
+#define GLFW_HRESIZE_CURSOR 0x00036005
+/*! @brief The vertical resize arrow shape.
+ *
+ * The vertical resize arrow shape.
+ */
+#define GLFW_VRESIZE_CURSOR 0x00036006
+/*! @} */
+
#define GLFW_CONNECTED 0x00040001
#define GLFW_DISCONNECTED 0x00040002
+#define GLFW_DONT_CARE -1
+
/*************************************************************************
* GLFW API types
@@ -573,6 +721,14 @@ typedef struct GLFWmonitor GLFWmonitor;
*/
typedef struct GLFWwindow GLFWwindow;
+/*! @brief Opaque cursor object.
+ *
+ * Opaque cursor object.
+ *
+ * @ingroup cursor
+ */
+typedef struct GLFWcursor GLFWcursor;
+
/*! @brief The function signature for error callbacks.
*
* This is the function signature for error callback functions.
@@ -582,7 +738,7 @@ typedef struct GLFWwindow GLFWwindow;
*
* @sa glfwSetErrorCallback
*
- * @ingroup error
+ * @ingroup init
*/
typedef void (* GLFWerrorfun)(int,const char*);
@@ -590,7 +746,7 @@ typedef void (* GLFWerrorfun)(int,const char*);
*
* This is the function signature for window position callback functions.
*
- * @param[in] window The window that the user moved.
+ * @param[in] window The window that was moved.
* @param[in] xpos The new x-coordinate, in screen coordinates, of the
* upper-left corner of the client area of the window.
* @param[in] ypos The new y-coordinate, in screen coordinates, of the
@@ -606,7 +762,7 @@ typedef void (* GLFWwindowposfun)(GLFWwindow*,int,int);
*
* This is the function signature for window size callback functions.
*
- * @param[in] window The window that the user resized.
+ * @param[in] window The window that was resized.
* @param[in] width The new width, in screen coordinates, of the window.
* @param[in] height The new height, in screen coordinates, of the window.
*
@@ -644,9 +800,9 @@ typedef void (* GLFWwindowrefreshfun)(GLFWwindow*);
*
* This is the function signature for window focus callback functions.
*
- * @param[in] window The window that was focused or defocused.
- * @param[in] focused `GL_TRUE` if the window was focused, or `GL_FALSE` if
- * it was defocused.
+ * @param[in] window The window that gained or lost input focus.
+ * @param[in] focused `GL_TRUE` if the window was given input focus, or
+ * `GL_FALSE` if it lost it.
*
* @sa glfwSetWindowFocusCallback
*
@@ -750,7 +906,7 @@ typedef void (* GLFWscrollfun)(GLFWwindow*,double,double);
* @param[in] window The window that received the event.
* @param[in] key The [keyboard key](@ref keys) that was pressed or released.
* @param[in] scancode The system-specific scancode of the key.
- * @param[in] action @ref GLFW_PRESS, @ref GLFW_RELEASE or @ref GLFW_REPEAT.
+ * @param[in] action `GLFW_PRESS`, `GLFW_RELEASE` or `GLFW_REPEAT`.
* @param[in] mods Bit field describing which [modifier keys](@ref mods) were
* held down.
*
@@ -773,6 +929,38 @@ typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int,int);
*/
typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int);
+/*! @brief The function signature for Unicode character with modifiers
+ * callbacks.
+ *
+ * This is the function signature for Unicode character with modifiers callback
+ * functions. It is called for each input character, regardless of what
+ * modifier keys are held down.
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] codepoint The Unicode code point of the character.
+ * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
+ * held down.
+ *
+ * @sa glfwSetCharModsCallback
+ *
+ * @ingroup input
+ */
+typedef void (* GLFWcharmodsfun)(GLFWwindow*,unsigned int,int);
+
+/*! @brief The function signature for file drop callbacks.
+ *
+ * This is the function signature for file drop callbacks.
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] count The number of dropped files.
+ * @param[in] paths The UTF-8 encoded file and/or directory path names.
+ *
+ * @sa glfwSetDropCallback
+ *
+ * @ingroup input
+ */
+typedef void (* GLFWdropfun)(GLFWwindow*,int,const char**);
+
/*! @brief The function signature for monitor configuration callbacks.
*
* This is the function signature for monitor configuration callback functions.
@@ -838,6 +1026,21 @@ typedef struct GLFWgammaramp
unsigned int size;
} GLFWgammaramp;
+/*! @brief Image data.
+ */
+typedef struct GLFWimage
+{
+ /*! The width, in pixels, of this image.
+ */
+ int width;
+ /*! The height, in pixels, of this image.
+ */
+ int height;
+ /*! The pixel data of this image, arranged left-to-right, top-to-bottom.
+ */
+ unsigned char* pixels;
+} GLFWimage;
+
/*************************************************************************
* GLFW API functions
@@ -846,53 +1049,70 @@ typedef struct GLFWgammaramp
/*! @brief Initializes the GLFW library.
*
* This function initializes the GLFW library. Before most GLFW functions can
- * be used, GLFW must be initialized, and before a program terminates GLFW
+ * be used, GLFW must be initialized, and before an application terminates GLFW
* should be terminated in order to free any resources allocated during or
* after initialization.
*
* If this function fails, it calls @ref glfwTerminate before returning. If it
- * succeeds, you should call @ref glfwTerminate before the program exits.
+ * succeeds, you should call @ref glfwTerminate before the application exits.
*
* Additional calls to this function after successful initialization but before
- * termination will succeed but will do nothing.
+ * termination will return `GL_TRUE` immediately.
*
- * @return `GL_TRUE` if successful, or `GL_FALSE` if an error occurred.
+ * @return `GL_TRUE` if successful, or `GL_FALSE` if an
+ * [error](@ref error_handling) occurred.
*
- * @par New in GLFW 3
- * This function no longer registers @ref glfwTerminate with `atexit`.
- *
- * @note This function may only be called from the main thread.
- *
- * @note **OS X:** This function will change the current directory of the
+ * @remarks __OS X:__ This function will change the current directory of the
* application to the `Contents/Resources` subdirectory of the application's
- * bundle, if present.
+ * bundle, if present. This can be disabled with a
+ * [compile-time option](@ref compile_options_osx).
*
+ * @remarks __X11:__ If the `LC_CTYPE` category of the current locale is set to
+ * `"C"` then the environment's locale will be applied to that category. This
+ * is done because character input will not function when `LC_CTYPE` is set to
+ * `"C"`. If another locale was set before this function was called, it will
+ * be left untouched.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref intro_init
* @sa glfwTerminate
*
+ * @since Added in GLFW 1.0.
+ *
* @ingroup init
*/
GLFWAPI int glfwInit(void);
/*! @brief Terminates the GLFW library.
*
- * This function destroys all remaining windows, frees any allocated resources
- * and sets the library to an uninitialized state. Once this is called, you
- * must again call @ref glfwInit successfully before you will be able to use
- * most GLFW functions.
+ * This function destroys all remaining windows and cursors, restores any
+ * modified gamma ramps and frees any other allocated resources. Once this
+ * function is called, you must again call @ref glfwInit successfully before
+ * you will be able to use most GLFW functions.
*
* If GLFW has been successfully initialized, this function should be called
- * before the program exits. If initialization fails, there is no need to call
- * this function, as it is called by @ref glfwInit before it returns failure.
+ * before the application exits. If initialization fails, there is no need to
+ * call this function, as it is called by @ref glfwInit before it returns
+ * failure.
*
* @remarks This function may be called before @ref glfwInit.
*
- * @note This function may only be called from the main thread.
- *
* @warning No window's context may be current on another thread when this
* function is called.
*
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref intro_init
* @sa glfwInit
*
+ * @since Added in GLFW 1.0.
+ *
* @ingroup init
*/
GLFWAPI void glfwTerminate(void);
@@ -903,46 +1123,55 @@ GLFWAPI void glfwTerminate(void);
* library. It is intended for when you are using GLFW as a shared library and
* want to ensure that you are using the minimum required version.
*
+ * Any or all of the version arguments may be `NULL`. This function always
+ * succeeds.
+ *
* @param[out] major Where to store the major version number, or `NULL`.
* @param[out] minor Where to store the minor version number, or `NULL`.
* @param[out] rev Where to store the revision number, or `NULL`.
*
* @remarks This function may be called before @ref glfwInit.
*
- * @remarks This function may be called from any thread.
+ * @par Thread Safety
+ * This function may be called from any thread.
*
+ * @sa @ref intro_version
* @sa glfwGetVersionString
*
+ * @since Added in GLFW 1.0.
+ *
* @ingroup init
*/
GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
/*! @brief Returns a string describing the compile-time configuration.
*
- * This function returns a static string generated at compile-time according to
- * which configuration macros were defined. This is intended for use when
- * submitting bug reports, to allow developers to see which code paths are
- * enabled in a binary.
+ * This function returns the compile-time generated
+ * [version string](@ref intro_version_string) of the GLFW library binary. It
+ * describes the version, platform, compiler and any platform-specific
+ * compile-time options.
*
- * The format of the string is as follows:
- * - The version of GLFW
- * - The name of the window system API
- * - The name of the context creation API
- * - Any additional options or APIs
+ * __Do not use the version string__ to parse the GLFW library version. The
+ * @ref glfwGetVersion function already provides the version of the running
+ * library binary.
*
- * For example, when compiling GLFW 3.0 with MinGW using the Win32 and WGL
- * back ends, the version string may look something like this:
- *
- * 3.0.0 Win32 WGL MinGW
+ * This function always succeeds.
*
* @return The GLFW version string.
*
* @remarks This function may be called before @ref glfwInit.
*
- * @remarks This function may be called from any thread.
+ * @par Pointer Lifetime
+ * The returned string is static and compile-time generated.
*
+ * @par Thread Safety
+ * This function may be called from any thread.
+ *
+ * @sa @ref intro_version
* @sa glfwGetVersion
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup init
*/
GLFWAPI const char* glfwGetVersionString(void);
@@ -952,23 +1181,31 @@ GLFWAPI const char* glfwGetVersionString(void);
* This function sets the error callback, which is called with an error code
* and a human-readable description each time a GLFW error occurs.
*
+ * The error callback is called on the thread where the error occurred. If you
+ * are using GLFW from multiple threads, your error callback needs to be
+ * written accordingly.
+ *
+ * Because the description string may have been generated specifically for that
+ * error, it is not guaranteed to be valid after the callback has returned. If
+ * you wish to use it after the callback returns, you need to make a copy.
+ *
+ * Once set, the error callback remains set even after the library has been
+ * terminated.
+ *
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set.
*
* @remarks This function may be called before @ref glfwInit.
*
- * @note The error callback is called by the thread where the error was
- * generated. If you are using GLFW from multiple threads, your error callback
- * needs to be written accordingly.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
- * @note Because the description string provided to the callback may have been
- * generated specifically for that error, it is not guaranteed to be valid
- * after the callback has returned. If you wish to use it after that, you need
- * to make your own copy of it before returning.
+ * @sa @ref error_handling
*
- * @ingroup error
+ * @since Added in GLFW 3.0.
+ *
+ * @ingroup init
*/
GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun);
@@ -977,19 +1214,25 @@ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun);
* This function returns an array of handles for all currently connected
* monitors.
*
- * @param[out] count Where to store the size of the returned array. This is
- * set to zero if an error occurred.
- * @return An array of monitor handles, or `NULL` if an error occurred.
+ * @param[out] count Where to store the number of monitors in the returned
+ * array. This is set to zero if an error occurred.
+ * @return An array of monitor handles, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @note The returned array is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned array is allocated and freed by GLFW. You should not free it
+ * yourself. It is guaranteed to be valid only until the monitor configuration
+ * changes or the library is terminated.
*
- * @note The returned array is valid only until the monitor configuration
- * changes. See @ref glfwSetMonitorCallback to receive notifications of
- * configuration changes.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref monitor_monitors
+ * @sa @ref monitor_event
* @sa glfwGetPrimaryMonitor
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup monitor
*/
GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
@@ -999,10 +1242,17 @@ GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
* This function returns the primary monitor. This is usually the monitor
* where elements like the Windows task bar or the OS X menu bar is located.
*
- * @return The primary monitor, or `NULL` if an error occurred.
+ * @return The primary monitor, or `NULL` if an [error](@ref error_handling)
+ * occurred.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_monitors
* @sa glfwGetMonitors
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup monitor
*/
GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
@@ -1012,10 +1262,20 @@ GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
* This function returns the position, in screen coordinates, of the upper-left
* corner of the specified monitor.
*
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
* @param[in] monitor The monitor to query.
* @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
* @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in GLFW 3.0.
+ *
* @ingroup monitor
*/
GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
@@ -1025,31 +1285,55 @@ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
* This function returns the size, in millimetres, of the display area of the
* specified monitor.
*
- * @param[in] monitor The monitor to query.
- * @param[out] width Where to store the width, in mm, of the monitor's display
- * area, or `NULL`.
- * @param[out] height Where to store the height, in mm, of the monitor's
- * display area, or `NULL`.
+ * Some systems do not provide accurate monitor size information, either
+ * because the monitor
+ * [EDID](https://en.wikipedia.org/wiki/Extended_display_identification_data)
+ * data is incorrect or because the driver does not report it accurately.
*
- * @note Some operating systems do not provide accurate information, either
- * because the monitor's EDID data is incorrect, or because the driver does not
- * report it accurately.
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] widthMM Where to store the width, in millimetres, of the
+ * monitor's display area, or `NULL`.
+ * @param[out] heightMM Where to store the height, in millimetres, of the
+ * monitor's display area, or `NULL`.
+ *
+ * @remarks __Windows:__ The OS calculates the returned physical size from the
+ * current resolution and system DPI instead of querying the monitor EDID data.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup monitor
*/
-GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* width, int* height);
+GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
/*! @brief Returns the name of the specified monitor.
*
* This function returns a human-readable name, encoded as UTF-8, of the
- * specified monitor.
+ * specified monitor. The name typically reflects the make and model of the
+ * monitor and is not guaranteed to be unique among the connected monitors.
*
* @param[in] monitor The monitor to query.
- * @return The UTF-8 encoded name of the monitor, or `NULL` if an error
- * occurred.
+ * @return The UTF-8 encoded name of the monitor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @note The returned string is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned string is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified monitor is disconnected or the
+ * library is terminated.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup monitor
*/
@@ -1063,12 +1347,19 @@ GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
*
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
*
- * @bug **X11:** This callback is not yet called on monitor configuration
+ * @bug __X11:__ This callback is not yet called on monitor configuration
* changes.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_event
+ *
+ * @since Added in GLFW 3.0.
+ *
* @ingroup monitor
*/
GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun);
@@ -1083,16 +1374,25 @@ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun);
* @param[in] monitor The monitor to query.
* @param[out] count Where to store the number of video modes in the returned
* array. This is set to zero if an error occurred.
- * @return An array of video modes, or `NULL` if an error occurred.
+ * @return An array of video modes, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @note The returned array is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned array is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified monitor is disconnected, this
+ * function is called again for that monitor or the library is terminated.
*
- * @note The returned array is valid only until this function is called again
- * for the specified monitor.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref monitor_modes
* @sa glfwGetVideoMode
*
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Changed to return an array of modes for a specific monitor.
+ *
* @ingroup monitor
*/
GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
@@ -1100,17 +1400,26 @@ GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
/*! @brief Returns the current mode of the specified monitor.
*
* This function returns the current video mode of the specified monitor. If
- * you are using a full screen window, the return value will therefore depend
- * on whether it is focused.
+ * you have created a full screen window for that monitor, the return value
+ * will depend on whether that window is iconified.
*
* @param[in] monitor The monitor to query.
- * @return The current mode of the monitor, or `NULL` if an error occurred.
+ * @return The current mode of the monitor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @note The returned struct is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned array is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified monitor is disconnected or the
+ * library is terminated.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_modes
* @sa glfwGetVideoModes
*
+ * @since Added in GLFW 3.0. Replaces `glfwGetDesktopMode`.
+ *
* @ingroup monitor
*/
GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
@@ -1118,24 +1427,43 @@ GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
/*! @brief Generates a gamma ramp and sets it for the specified monitor.
*
* This function generates a 256-element gamma ramp from the specified exponent
- * and then calls @ref glfwSetGammaRamp with it.
+ * and then calls @ref glfwSetGammaRamp with it. The value must be a finite
+ * number greater than zero.
*
* @param[in] monitor The monitor whose gamma ramp to set.
* @param[in] gamma The desired exponent.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in GLFW 3.0.
+ *
* @ingroup monitor
*/
GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
-/*! @brief Retrieves the current gamma ramp for the specified monitor.
+/*! @brief Returns the current gamma ramp for the specified monitor.
*
- * This function retrieves the current gamma ramp of the specified monitor.
+ * This function returns the current gamma ramp of the specified monitor.
*
* @param[in] monitor The monitor to query.
- * @return The current gamma ramp, or `NULL` if an error occurred.
+ * @return The current gamma ramp, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @note The value arrays of the returned ramp are allocated and freed by GLFW.
- * You should not free them yourself.
+ * @par Pointer Lifetime
+ * The returned structure and its arrays are allocated and freed by GLFW. You
+ * should not free them yourself. They are valid until the specified monitor
+ * is disconnected, this function is called again for that monitor or the
+ * library is terminated.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup monitor
*/
@@ -1143,12 +1471,27 @@ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
/*! @brief Sets the current gamma ramp for the specified monitor.
*
- * This function sets the current gamma ramp for the specified monitor.
+ * This function sets the current gamma ramp for the specified monitor. The
+ * original gamma ramp for that monitor is saved by GLFW the first time this
+ * function is called and is restored by @ref glfwTerminate.
*
* @param[in] monitor The monitor whose gamma ramp to set.
* @param[in] ramp The gamma ramp to use.
*
- * @note Gamma ramp sizes other than 256 are not supported by all hardware.
+ * @remarks Gamma ramp sizes other than 256 are not supported by all platforms
+ * or graphics hardware.
+ *
+ * @remarks __Windows:__ The gamma ramp size must be 256.
+ *
+ * @par Pointer Lifetime
+ * The specified gamma ramp is copied before this function returns.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup monitor
*/
@@ -1159,10 +1502,14 @@ GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
* This function resets all window hints to their
* [default values](@ref window_hints_values).
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_hints
* @sa glfwWindowHint
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwDefaultWindowHints(void);
@@ -1172,52 +1519,70 @@ GLFWAPI void glfwDefaultWindowHints(void);
* This function sets hints for the next call to @ref glfwCreateWindow. The
* hints, once set, retain their values until changed by a call to @ref
* glfwWindowHint or @ref glfwDefaultWindowHints, or until the library is
- * terminated with @ref glfwTerminate.
+ * terminated.
*
* @param[in] target The [window hint](@ref window_hints) to set.
* @param[in] hint The new value of the window hint.
*
- * @par New in GLFW 3
- * Hints are no longer reset to their default values on window creation. To
- * set default hint values, use @ref glfwDefaultWindowHints.
- *
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_hints
* @sa glfwDefaultWindowHints
*
+ * @since Added in GLFW 3.0. Replaces `glfwOpenWindowHint`.
+ *
* @ingroup window
*/
GLFWAPI void glfwWindowHint(int target, int hint);
/*! @brief Creates a window and its associated context.
*
- * This function creates a window and its associated context. Most of the
- * options controlling how the window and its context should be created are
- * specified through @ref glfwWindowHint.
+ * This function creates a window and its associated OpenGL or OpenGL ES
+ * context. Most of the options controlling how the window and its context
+ * should be created are specified with [window hints](@ref window_hints).
*
* Successful creation does not change which context is current. Before you
- * can use the newly created context, you need to make it current using @ref
- * glfwMakeContextCurrent.
+ * can use the newly created context, you need to
+ * [make it current](@ref context_current). For information about the `share`
+ * parameter, see @ref context_sharing.
*
- * Note that the created window and context may differ from what you requested,
- * as not all parameters and hints are
+ * The created window, framebuffer and context may differ from what you
+ * requested, as not all parameters and hints are
* [hard constraints](@ref window_hints_hard). This includes the size of the
- * window, especially for full screen windows. To retrieve the actual
- * attributes of the created window and context, use queries like @ref
+ * window, especially for full screen windows. To query the actual attributes
+ * of the created window, framebuffer and context, use queries like @ref
* glfwGetWindowAttrib and @ref glfwGetWindowSize.
*
- * To create a full screen window, you need to specify the monitor to use. If
- * no monitor is specified, windowed mode will be used. Unless you have a way
- * for the user to choose a specific monitor, it is recommended that you pick
- * the primary monitor. For more information on how to retrieve monitors, see
- * @ref monitor_monitors.
+ * To create a full screen window, you need to specify the monitor the window
+ * will cover. If no monitor is specified, windowed mode will be used. Unless
+ * you have a way for the user to choose a specific monitor, it is recommended
+ * that you pick the primary monitor. For more information on how to query
+ * connected monitors, see @ref monitor_monitors.
*
- * To create the window at a specific position, make it initially invisible
- * using the `GLFW_VISIBLE` window hint, set its position and then show it.
+ * For full screen windows, the specified size becomes the resolution of the
+ * window's _desired video mode_. As long as a full screen window has input
+ * focus, the supported video mode most closely matching the desired video mode
+ * is set for the specified monitor. For more information about full screen
+ * windows, including the creation of so called _windowed full screen_ or
+ * _borderless full screen_ windows, see @ref window_windowed_full_screen.
*
- * If a full screen window is active, the screensaver is prohibited from
+ * By default, newly created windows use the placement recommended by the
+ * window system. To create the window at a specific position, make it
+ * initially invisible using the [GLFW_VISIBLE](@ref window_hints_wnd) window
+ * hint, set its [position](@ref window_pos) and then [show](@ref window_hide)
+ * it.
+ *
+ * If a full screen window has input focus, the screensaver is prohibited from
* starting.
*
+ * Window systems put limits on window sizes. Very large or very small window
+ * dimensions may be overridden by the window system on creation. Check the
+ * actual [size](@ref window_size) after creation.
+ *
+ * The [swap interval](@ref buffer_swap) is not set during window creation and
+ * the initial value may vary depending on driver settings and defaults.
+ *
* @param[in] width The desired width, in screen coordinates, of the window.
* This must be greater than zero.
* @param[in] height The desired height, in screen coordinates, of the window.
@@ -1227,32 +1592,54 @@ GLFWAPI void glfwWindowHint(int target, int hint);
* windowed mode.
* @param[in] share The window whose context to share resources with, or `NULL`
* to not share resources.
- * @return The handle of the created window, or `NULL` if an error occurred.
+ * @return The handle of the created window, or `NULL` if an
+ * [error](@ref error_handling) occurred.
*
- * @remarks **Windows:** Window creation will fail if the Microsoft GDI
+ * @remarks __Windows:__ Window creation will fail if the Microsoft GDI
* software OpenGL implementation is the only one available.
*
- * @remarks **Windows:** If the executable has an icon resource named
+ * @remarks __Windows:__ If the executable has an icon resource named
* `GLFW_ICON,` it will be set as the icon for the window. If no such icon is
* present, the `IDI_WINLOGO` icon will be used instead.
*
- * @remarks **OS X:** The GLFW window has no icon, as it is not a document
+ * @remarks __Windows:__ The context to share resources with may not be current
+ * on any other thread.
+ *
+ * @remarks __OS X:__ The GLFW window has no icon, as it is not a document
* window, but the dock icon will be the same as the application bundle's icon.
- * Also, the first time a window is opened the menu bar is populated with
- * common commands like Hide, Quit and About. The (minimal) about dialog uses
- * information from the application's bundle. For more information on bundles,
- * see the Bundle Programming Guide provided by Apple.
+ * For more information on bundles, see the
+ * [Bundle Programming Guide](https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/)
+ * in the Mac Developer Library.
*
- * @remarks **X11:** There is no mechanism for setting the window icon yet.
+ * @remarks __OS X:__ The first time a window is created the menu bar is
+ * populated with common commands like Hide, Quit and About. The About entry
+ * opens a minimal about dialog with information from the application's bundle.
+ * The menu bar can be disabled with a
+ * [compile-time option](@ref compile_options_osx).
*
- * @remarks The swap interval is not set during window creation, but is left at
- * the default value for that platform. For more information, see @ref
- * glfwSwapInterval.
+ * @remarks __OS X:__ On OS X 10.10 and later the window frame will not be
+ * rendered at full resolution on Retina displays unless the
+ * `NSHighResolutionCapable` key is enabled in the application bundle's
+ * `Info.plist`. For more information, see
+ * [High Resolution Guidelines for OS X](https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html)
+ * in the Mac Developer Library.
*
- * @note This function may only be called from the main thread.
+ * @remarks __X11:__ There is no mechanism for setting the window icon yet.
*
+ * @remarks __X11:__ Some window managers will not respect the placement of
+ * initially hidden windows.
+ *
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_creation
* @sa glfwDestroyWindow
*
+ * @since Added in GLFW 3.0. Replaces `glfwOpenWindow`.
+ *
* @ingroup window
*/
GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
@@ -1262,19 +1649,25 @@ GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, G
* This function destroys the specified window and its context. On calling
* this function, no further callbacks will be called for that window.
*
- * @param[in] window The window to destroy.
- *
- * @note This function may only be called from the main thread.
- *
- * @note This function may not be called from a callback.
- *
- * @note If the window's context is current on the main thread, it is
+ * If the context of the specified window is current on the main thread, it is
* detached before being destroyed.
*
- * @warning The window's context must not be current on any other thread.
+ * @param[in] window The window to destroy.
*
+ * @note The context of the specified window must not be current on any other
+ * thread when this function is called.
+ *
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_creation
* @sa glfwCreateWindow
*
+ * @since Added in GLFW 3.0. Replaces `glfwCloseWindow`.
+ *
* @ingroup window
*/
GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
@@ -1286,7 +1679,12 @@ GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
* @param[in] window The window to query.
* @return The value of the close flag.
*
- * @remarks This function may be called from secondary threads.
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1301,7 +1699,12 @@ GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
* @param[in] window The window whose flag to change.
* @param[in] value The new value.
*
- * @remarks This function may be called from secondary threads.
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1315,7 +1718,15 @@ GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
* @param[in] window The window whose title to change.
* @param[in] title The UTF-8 encoded window title.
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_title
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
*
* @ingroup window
*/
@@ -1326,14 +1737,23 @@ GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
* This function retrieves the position, in screen coordinates, of the
* upper-left corner of the client area of the specified window.
*
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
* @param[in] window The window to query.
* @param[out] xpos Where to store the x-coordinate of the upper-left corner of
* the client area, or `NULL`.
* @param[out] ypos Where to store the y-coordinate of the upper-left corner of
* the client area, or `NULL`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_pos
* @sa glfwSetWindowPos
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
@@ -1341,27 +1761,30 @@ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
/*! @brief Sets the position of the client area of the specified window.
*
* This function sets the position, in screen coordinates, of the upper-left
- * corner of the client area of the window.
+ * corner of the client area of the specified windowed mode window. If the
+ * window is a full screen window, this function does nothing.
*
- * If the specified window is a full screen window, this function does nothing.
+ * __Do not use this function__ to move an already visible window unless you
+ * have very good reasons for doing so, as it will confuse and annoy the user.
*
- * If you wish to set an initial window position you should create a hidden
- * window (using @ref glfwWindowHint and `GLFW_VISIBLE`), set its position and
- * then show it.
+ * The window manager may put limits on what positions are allowed. GLFW
+ * cannot and should not override these limits.
*
* @param[in] window The window to query.
* @param[in] xpos The x-coordinate of the upper-left corner of the client area.
* @param[in] ypos The y-coordinate of the upper-left corner of the client area.
*
- * @note It is very rarely a good idea to move an already visible window, as it
- * will confuse and annoy the user.
- *
- * @note This function may only be called from the main thread.
- *
- * @note The window manager may put limits on what positions are allowed.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_pos
* @sa glfwGetWindowPos
*
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup window
*/
GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
@@ -1370,7 +1793,10 @@ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
*
* This function retrieves the size, in screen coordinates, of the client area
* of the specified window. If you wish to retrieve the size of the
- * framebuffer in pixels, see @ref glfwGetFramebufferSize.
+ * framebuffer of the window in pixels, see @ref glfwGetFramebufferSize.
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
*
* @param[in] window The window whose size to retrieve.
* @param[out] width Where to store the width, in screen coordinates, of the
@@ -1378,8 +1804,17 @@ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
* @param[out] height Where to store the height, in screen coordinates, of the
* client area, or `NULL`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_size
* @sa glfwSetWindowSize
*
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup window
*/
GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
@@ -1394,16 +1829,24 @@ GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
* the context is unaffected, the bit depths of the framebuffer remain
* unchanged.
*
+ * The window manager may put limits on what sizes are allowed. GLFW cannot
+ * and should not override these limits.
+ *
* @param[in] window The window to resize.
* @param[in] width The desired width of the specified window.
* @param[in] height The desired height of the specified window.
*
- * @note This function may only be called from the main thread.
- *
- * @note The window manager may put limits on what window sizes are allowed.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_size
* @sa glfwGetWindowSize
*
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup window
*/
GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
@@ -1414,80 +1857,149 @@ GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
* specified window. If you wish to retrieve the size of the window in screen
* coordinates, see @ref glfwGetWindowSize.
*
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
* @param[in] window The window whose framebuffer to query.
* @param[out] width Where to store the width, in pixels, of the framebuffer,
* or `NULL`.
* @param[out] height Where to store the height, in pixels, of the framebuffer,
* or `NULL`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_fbsize
* @sa glfwSetFramebufferSizeCallback
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
+/*! @brief Retrieves the size of the frame of the window.
+ *
+ * This function retrieves the size, in screen coordinates, of each edge of the
+ * frame of the specified window. This size includes the title bar, if the
+ * window has one. The size of the frame may vary depending on the
+ * [window-related hints](@ref window_hints_wnd) used to create it.
+ *
+ * Because this function retrieves the size of each window frame edge and not
+ * the offset along a particular coordinate axis, the retrieved values will
+ * always be zero or positive.
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] window The window whose frame size to query.
+ * @param[out] left Where to store the size, in screen coordinates, of the left
+ * edge of the window frame, or `NULL`.
+ * @param[out] top Where to store the size, in screen coordinates, of the top
+ * edge of the window frame, or `NULL`.
+ * @param[out] right Where to store the size, in screen coordinates, of the
+ * right edge of the window frame, or `NULL`.
+ * @param[out] bottom Where to store the size, in screen coordinates, of the
+ * bottom edge of the window frame, or `NULL`.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_size
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup window
+ */
+GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
+
/*! @brief Iconifies the specified window.
*
- * This function iconifies/minimizes the specified window, if it was previously
- * restored. If it is a full screen window, the original monitor resolution is
- * restored until the window is restored. If the window is already iconified,
- * this function does nothing.
+ * This function iconifies (minimizes) the specified window if it was
+ * previously restored. If the window is already iconified, this function does
+ * nothing.
+ *
+ * If the specified window is a full screen window, the original monitor
+ * resolution is restored until the window is restored.
*
* @param[in] window The window to iconify.
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_iconify
* @sa glfwRestoreWindow
*
+ * @since Added in GLFW 2.1.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup window
*/
GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
/*! @brief Restores the specified window.
*
- * This function restores the specified window, if it was previously
- * iconified/minimized. If it is a full screen window, the resolution chosen
- * for the window is restored on the selected monitor. If the window is
- * already restored, this function does nothing.
+ * This function restores the specified window if it was previously iconified
+ * (minimized). If the window is already restored, this function does nothing.
+ *
+ * If the specified window is a full screen window, the resolution chosen for
+ * the window is restored on the selected monitor.
*
* @param[in] window The window to restore.
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_iconify
* @sa glfwIconifyWindow
*
+ * @since Added in GLFW 2.1.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup window
*/
GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
/*! @brief Makes the specified window visible.
*
- * This function makes the specified window visible, if it was previously
+ * This function makes the specified window visible if it was previously
* hidden. If the window is already visible or is in full screen mode, this
* function does nothing.
*
* @param[in] window The window to make visible.
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_hide
* @sa glfwHideWindow
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwShowWindow(GLFWwindow* window);
/*! @brief Hides the specified window.
*
- * This function hides the specified window, if it was previously visible. If
+ * This function hides the specified window if it was previously visible. If
* the window is already hidden or is in full screen mode, this function does
* nothing.
*
* @param[in] window The window to hide.
*
- * @note This function may only be called from the main thread.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref window_hide
* @sa glfwShowWindow
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwHideWindow(GLFWwindow* window);
@@ -1498,7 +2010,15 @@ GLFWAPI void glfwHideWindow(GLFWwindow* window);
* in full screen on.
*
* @param[in] window The window to query.
- * @return The monitor, or `NULL` if the window is in windowed mode.
+ * @return The monitor, or `NULL` if the window is in windowed mode or an error
+ * occurred.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_monitor
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1506,13 +2026,22 @@ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
/*! @brief Returns an attribute of the specified window.
*
- * This function returns an attribute of the specified window. There are many
- * attributes, some related to the window and others to its context.
+ * This function returns the value of an attribute of the specified window or
+ * its OpenGL or OpenGL ES context.
*
* @param[in] window The window to query.
* @param[in] attrib The [window attribute](@ref window_attribs) whose value to
* return.
- * @return The value of the attribute, or zero if an error occurred.
+ * @return The value of the attribute, or zero if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_attribs
+ *
+ * @since Added in GLFW 3.0. Replaces `glfwGetWindowParam` and
+ * `glfwGetGLVersion`.
*
* @ingroup window
*/
@@ -1527,8 +2056,14 @@ GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
* @param[in] window The window whose pointer to set.
* @param[in] pointer The new value.
*
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @sa @ref window_userptr
* @sa glfwGetWindowUserPointer
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
@@ -1540,8 +2075,14 @@ GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
*
* @param[in] window The window whose pointer to return.
*
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @sa @ref window_userptr
* @sa glfwSetWindowUserPointer
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup window
*/
GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
@@ -1555,8 +2096,15 @@ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_pos
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1571,8 +2119,18 @@ GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindow
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_size
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
*
* @ingroup window
*/
@@ -1592,15 +2150,22 @@ GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwind
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
*
- * @par New in GLFW 3
- * The close callback no longer returns a value.
- *
- * @remarks **OS X:** Selecting Quit from the application menu will
+ * @remarks __OS X:__ Selecting Quit from the application menu will
* trigger the close callback for all windows.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in GLFW 2.5.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
+ *
* @ingroup window
*/
GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun cbfun);
@@ -1618,12 +2183,18 @@ GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwi
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
*
- * @note On compositing window systems such as Aero, Compiz or Aqua, where the
- * window contents are saved off-screen, this callback may be called only very
- * infrequently or never at all.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_refresh
+ *
+ * @since Added in GLFW 2.5.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
*
* @ingroup window
*/
@@ -1632,18 +2203,25 @@ GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GL
/*! @brief Sets the focus callback for the specified window.
*
* This function sets the focus callback of the specified window, which is
- * called when the window gains or loses focus.
+ * called when the window gains or loses input focus.
*
- * After the focus callback is called for a window that lost focus, synthetic
- * key and mouse button release events will be generated for all such that had
- * been pressed. For more information, see @ref glfwSetKeyCallback and @ref
- * glfwSetMouseButtonCallback.
+ * After the focus callback is called for a window that lost input focus,
+ * synthetic key and mouse button release events will be generated for all such
+ * that had been pressed. For more information, see @ref glfwSetKeyCallback
+ * and @ref glfwSetMouseButtonCallback.
*
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_focus
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1657,8 +2235,15 @@ GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwi
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_iconify
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1672,8 +2257,15 @@ GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GL
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_fbsize
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup window
*/
@@ -1681,114 +2273,164 @@ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window
/*! @brief Processes all pending events.
*
- * This function processes only those events that have already been received
- * and then returns immediately. Processing events will cause the window and
- * input callbacks associated with those events to be called.
+ * This function processes only those events that are already in the event
+ * queue and then returns immediately. Processing events will cause the window
+ * and input callbacks associated with those events to be called.
*
- * This function is not required for joystick input to work.
+ * On some platforms, a window move, resize or menu operation will cause event
+ * processing to block. This is due to how event processing is designed on
+ * those platforms. You can use the
+ * [window refresh callback](@ref window_refresh) to redraw the contents of
+ * your window when necessary during such operations.
*
- * @par New in GLFW 3
- * This function is no longer called by @ref glfwSwapBuffers. You need to call
- * it or @ref glfwWaitEvents yourself.
+ * On some platforms, certain events are sent directly to the application
+ * without going through the event queue, causing callbacks to be called
+ * outside of a call to one of the event processing functions.
*
- * @remarks On some platforms, a window move, resize or menu operation will
- * cause event processing to block. This is due to how event processing is
- * designed on those platforms. You can use the
- * [window refresh callback](@ref GLFWwindowrefreshfun) to redraw the contents
- * of your window when necessary during the operation.
+ * Event processing is not required for joystick input to work.
*
- * @note This function may only be called from the main thread.
+ * @par Reentrancy
+ * This function may not be called from a callback.
*
- * @note This function may not be called from a callback.
- *
- * @note On some platforms, certain callbacks may be called outside of a call
- * to one of the event processing functions.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref events
* @sa glfwWaitEvents
*
+ * @since Added in GLFW 1.0.
+ *
* @ingroup window
*/
GLFWAPI void glfwPollEvents(void);
-/*! @brief Waits until events are pending and processes them.
+/*! @brief Waits until events are queued and processes them.
*
- * This function puts the calling thread to sleep until at least one event has
- * been received. Once one or more events have been received, it behaves as if
- * @ref glfwPollEvents was called, i.e. the events are processed and the
- * function then returns immediately. Processing events will cause the window
- * and input callbacks associated with those events to be called.
+ * This function puts the calling thread to sleep until at least one event is
+ * available in the event queue. Once one or more events are available,
+ * it behaves exactly like @ref glfwPollEvents, i.e. the events in the queue
+ * are processed and the function then returns immediately. Processing events
+ * will cause the window and input callbacks associated with those events to be
+ * called.
*
* Since not all events are associated with callbacks, this function may return
* without a callback having been called even if you are monitoring all
* callbacks.
*
- * This function is not required for joystick input to work.
+ * On some platforms, a window move, resize or menu operation will cause event
+ * processing to block. This is due to how event processing is designed on
+ * those platforms. You can use the
+ * [window refresh callback](@ref window_refresh) to redraw the contents of
+ * your window when necessary during such operations.
*
- * @remarks On some platforms, a window move, resize or menu operation will
- * cause event processing to block. This is due to how event processing is
- * designed on those platforms. You can use the
- * [window refresh callback](@ref GLFWwindowrefreshfun) to redraw the contents
- * of your window when necessary during the operation.
+ * On some platforms, certain callbacks may be called outside of a call to one
+ * of the event processing functions.
*
- * @note This function may only be called from the main thread.
+ * If no windows exist, this function returns immediately. For synchronization
+ * of threads in applications that do not create windows, use your threading
+ * library of choice.
*
- * @note This function may not be called from a callback.
+ * Event processing is not required for joystick input to work.
*
- * @note On some platforms, certain callbacks may be called outside of a call
- * to one of the event processing functions.
+ * @par Reentrancy
+ * This function may not be called from a callback.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref events
* @sa glfwPollEvents
*
+ * @since Added in GLFW 2.5.
+ *
* @ingroup window
*/
GLFWAPI void glfwWaitEvents(void);
+/*! @brief Posts an empty event to the event queue.
+ *
+ * This function posts an empty event from the current thread to the event
+ * queue, causing @ref glfwWaitEvents to return.
+ *
+ * If no windows exist, this function returns immediately. For synchronization
+ * of threads in applications that do not create windows, use your threading
+ * library of choice.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread.
+ *
+ * @sa @ref events
+ * @sa glfwWaitEvents
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup window
+ */
+GLFWAPI void glfwPostEmptyEvent(void);
+
/*! @brief Returns the value of an input option for the specified window.
+ *
+ * This function returns the value of an input option for the specified window.
+ * The mode must be one of `GLFW_CURSOR`, `GLFW_STICKY_KEYS` or
+ * `GLFW_STICKY_MOUSE_BUTTONS`.
*
* @param[in] window The window to query.
* @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS` or
* `GLFW_STICKY_MOUSE_BUTTONS`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
* @sa glfwSetInputMode
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup input
*/
GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
/*! @brief Sets an input option for the specified window.
+ *
+ * This function sets an input mode option for the specified window. The mode
+ * must be one of `GLFW_CURSOR`, `GLFW_STICKY_KEYS` or
+ * `GLFW_STICKY_MOUSE_BUTTONS`.
+ *
+ * If the mode is `GLFW_CURSOR`, the value must be one of the following cursor
+ * modes:
+ * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
+ * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the client
+ * area of the window but does not restrict the cursor from leaving.
+ * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual
+ * and unlimited cursor movement. This is useful for implementing for
+ * example 3D camera controls.
+ *
+ * If the mode is `GLFW_STICKY_KEYS`, the value must be either `GL_TRUE` to
+ * enable sticky keys, or `GL_FALSE` to disable it. If sticky keys are
+ * enabled, a key press will ensure that @ref glfwGetKey returns `GLFW_PRESS`
+ * the next time it is called even if the key had been released before the
+ * call. This is useful when you are only interested in whether keys have been
+ * pressed but not when or in which order.
+ *
+ * If the mode is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either
+ * `GL_TRUE` to enable sticky mouse buttons, or `GL_FALSE` to disable it. If
+ * sticky mouse buttons are enabled, a mouse button press will ensure that @ref
+ * glfwGetMouseButton returns `GLFW_PRESS` the next time it is called even if
+ * the mouse button had been released before the call. This is useful when you
+ * are only interested in whether mouse buttons have been pressed but not when
+ * or in which order.
+ *
* @param[in] window The window whose input mode to set.
* @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS` or
* `GLFW_STICKY_MOUSE_BUTTONS`.
* @param[in] value The new value of the specified input mode.
*
- * If `mode` is `GLFW_CURSOR`, the value must be one of the supported input
- * modes:
- * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
- * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the client
- * area of the window but does not restrict the cursor from leaving. This is
- * useful if you wish to render your own cursor or have no visible cursor at
- * all.
- * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual
- * and unlimited cursor movement. This is useful for implementing for
- * example 3D camera controls.
- *
- * If `mode` is `GLFW_STICKY_KEYS`, the value must be either `GL_TRUE` to
- * enable sticky keys, or `GL_FALSE` to disable it. If sticky keys are
- * enabled, a key press will ensure that @ref glfwGetKey returns @ref
- * GLFW_PRESS the next time it is called even if the key had been released
- * before the call. This is useful when you are only interested in whether
- * keys have been pressed but not when or in which order.
- *
- * If `mode` is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either `GL_TRUE`
- * to enable sticky mouse buttons, or `GL_FALSE` to disable it. If sticky
- * mouse buttons are enabled, a mouse button press will ensure that @ref
- * glfwGetMouseButton returns @ref GLFW_PRESS the next time it is called even
- * if the mouse button had been released before the call. This is useful when
- * you are only interested in whether mouse buttons have been pressed but not
- * when or in which order.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
* @sa glfwGetInputMode
*
+ * @since Added in GLFW 3.0. Replaces `glfwEnable` and `glfwDisable`.
+ *
* @ingroup input
*/
GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
@@ -1798,22 +2440,34 @@ GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
*
* This function returns the last state reported for the specified key to the
* specified window. The returned state is one of `GLFW_PRESS` or
- * `GLFW_RELEASE`. The higher-level state `GLFW_REPEAT` is only reported to
+ * `GLFW_RELEASE`. The higher-level action `GLFW_REPEAT` is only reported to
* the key callback.
*
* If the `GLFW_STICKY_KEYS` input mode is enabled, this function returns
- * `GLFW_PRESS` the first time you call this function after a key has been
- * pressed, even if the key has already been released.
+ * `GLFW_PRESS` the first time you call it for a key that was pressed, even if
+ * that key has already been released.
*
* The key functions deal with physical keys, with [key tokens](@ref keys)
* named after their use on the standard US keyboard layout. If you want to
* input text, use the Unicode character callback instead.
*
+ * The [modifier key bit masks](@ref mods) are not key tokens and cannot be
+ * used with this function.
+ *
* @param[in] window The desired window.
- * @param[in] key The desired [keyboard key](@ref keys).
+ * @param[in] key The desired [keyboard key](@ref keys). `GLFW_KEY_UNKNOWN` is
+ * not a valid key for this function.
* @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
*
- * @note `GLFW_KEY_UNKNOWN` is not a valid key for this function.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_key
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
*
* @ingroup input
*/
@@ -1823,26 +2477,37 @@ GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
* window.
*
* This function returns the last state reported for the specified mouse button
- * to the specified window.
+ * to the specified window. The returned state is one of `GLFW_PRESS` or
+ * `GLFW_RELEASE`.
*
* If the `GLFW_STICKY_MOUSE_BUTTONS` input mode is enabled, this function
- * returns `GLFW_PRESS` the first time you call this function after a mouse
- * button has been pressed, even if the mouse button has already been released.
+ * `GLFW_PRESS` the first time you call it for a mouse button that was pressed,
+ * even if that mouse button has already been released.
*
* @param[in] window The desired window.
* @param[in] button The desired [mouse button](@ref buttons).
* @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_mouse_button
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
* @ingroup input
*/
GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
-/*! @brief Retrieves the last reported cursor position, relative to the client
- * area of the window.
+/*! @brief Retrieves the position of the cursor relative to the client area of
+ * the window.
*
- * This function returns the last reported position of the cursor, in screen
- * coordinates, relative to the upper-left corner of the client area of the
- * specified window.
+ * This function returns the position of the cursor, in screen coordinates,
+ * relative to the upper-left corner of the client area of the specified
+ * window.
*
* If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor
* position is unbounded and limited only by the minimum and maximum values of
@@ -1852,14 +2517,23 @@ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
* `floor` function. Casting directly to an integer type works for positive
* coordinates, but fails for negative ones.
*
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
* @param[in] window The desired window.
* @param[out] xpos Where to store the cursor x-coordinate, relative to the
* left edge of the client area, or `NULL`.
* @param[out] ypos Where to store the cursor y-coordinate, relative to the to
* top edge of the client area, or `NULL`.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
* @sa glfwSetCursorPos
*
+ * @since Added in GLFW 3.0. Replaces `glfwGetMousePos`.
+ *
* @ingroup input
*/
GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
@@ -1869,11 +2543,16 @@ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
*
* This function sets the position, in screen coordinates, of the cursor
* relative to the upper-left corner of the client area of the specified
- * window. The window must be focused. If the window does not have focus when
- * this function is called, it fails silently.
+ * window. The window must have input focus. If the window does not have
+ * input focus when this function is called, it fails silently.
*
- * If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor
- * position is unbounded and limited only by the minimum and maximum values of
+ * __Do not use this function__ to implement things like camera controls. GLFW
+ * already provides the `GLFW_CURSOR_DISABLED` cursor mode that hides the
+ * cursor, transparently re-centers it and provides unconstrained cursor
+ * motion. See @ref glfwSetInputMode for more information.
+ *
+ * If the cursor mode is `GLFW_CURSOR_DISABLED` then the cursor position is
+ * unconstrained and limited only by the minimum and maximum values of
* a `double`.
*
* @param[in] window The desired window.
@@ -1882,15 +2561,138 @@ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
* @param[in] ypos The desired y-coordinate, relative to the top edge of the
* client area.
*
+ * @remarks __X11:__ Due to the asynchronous nature of a modern X desktop, it
+ * may take a moment for the window focus event to arrive. This means you will
+ * not be able to set the cursor position directly after window creation.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
* @sa glfwGetCursorPos
*
+ * @since Added in GLFW 3.0. Replaces `glfwSetMousePos`.
+ *
* @ingroup input
*/
GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
+/*! @brief Creates a custom cursor.
+ *
+ * Creates a new custom cursor image that can be set for a window with @ref
+ * glfwSetCursor. The cursor can be destroyed with @ref glfwDestroyCursor.
+ * Any remaining cursors are destroyed by @ref glfwTerminate.
+ *
+ * The pixels are 32-bit little-endian RGBA, i.e. eight bits per channel. They
+ * are arranged canonically as packed sequential rows, starting from the
+ * top-left corner.
+ *
+ * The cursor hotspot is specified in pixels, relative to the upper-left corner
+ * of the cursor image. Like all other coordinate systems in GLFW, the X-axis
+ * points to the right and the Y-axis points down.
+ *
+ * @param[in] image The desired cursor image.
+ * @param[in] xhot The desired x-coordinate, in pixels, of the cursor hotspot.
+ * @param[in] yhot The desired y-coordinate, in pixels, of the cursor hotspot.
+ *
+ * @return The handle of the created cursor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Pointer Lifetime
+ * The specified image data is copied before this function returns.
+ *
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ * @sa glfwDestroyCursor
+ * @sa glfwCreateStandardCursor
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup input
+ */
+GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
+
+/*! @brief Creates a cursor with a standard shape.
+ *
+ * Returns a cursor with a [standard shape](@ref shapes), that can be set for
+ * a window with @ref glfwSetCursor.
+ *
+ * @param[in] shape One of the [standard shapes](@ref shapes).
+ *
+ * @return A new cursor ready to use or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ * @sa glfwCreateCursor
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup input
+ */
+GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
+
+/*! @brief Destroys a cursor.
+ *
+ * This function destroys a cursor previously created with @ref
+ * glfwCreateCursor. Any remaining cursors will be destroyed by @ref
+ * glfwTerminate.
+ *
+ * @param[in] cursor The cursor object to destroy.
+ *
+ * @par Reentrancy
+ * This function may not be called from a callback.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ * @sa glfwCreateCursor
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup input
+ */
+GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
+
+/*! @brief Sets the cursor for the window.
+ *
+ * This function sets the cursor image to be used when the cursor is over the
+ * client area of the specified window. The set cursor will only be visible
+ * when the [cursor mode](@ref cursor_mode) of the window is
+ * `GLFW_CURSOR_NORMAL`.
+ *
+ * On some platforms, the set cursor may not be visible unless the window also
+ * has input focus.
+ *
+ * @param[in] window The window to set the cursor for.
+ * @param[in] cursor The cursor to set, or `NULL` to switch back to the default
+ * arrow cursor.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup input
+ */
+GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
+
/*! @brief Sets the key callback.
*
- * This function sets the key callback of the specific window, which is called
+ * This function sets the key callback of the specified window, which is called
* when a key is pressed, repeated or released.
*
* The key functions deal with physical keys, with layout independent
@@ -1898,16 +2700,16 @@ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
* layout. If you want to input text, use the
* [character callback](@ref glfwSetCharCallback) instead.
*
- * When a window loses focus, it will generate synthetic key release events
- * for all pressed keys. You can tell these events from user-generated events
- * by the fact that the synthetic ones are generated after the window has lost
- * focus, i.e. `GLFW_FOCUSED` will be false and the focus callback will have
- * already been called.
+ * When a window loses input focus, it will generate synthetic key release
+ * events for all pressed keys. You can tell these events from user-generated
+ * events by the fact that the synthetic ones are generated after the focus
+ * loss event has been processed, i.e. after the
+ * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
*
* The scancode of a key is specific to that platform or sometimes even to that
* machine. Scancodes are intended to allow users to bind keys that don't have
* a GLFW key token. Such keys have `key` set to `GLFW_KEY_UNKNOWN`, their
- * state is not saved and so it cannot be retrieved with @ref glfwGetKey.
+ * state is not saved and so it cannot be queried with @ref glfwGetKey.
*
* Sometimes GLFW needs to generate synthetic key events, in which case the
* scancode may be zero.
@@ -1915,8 +2717,18 @@ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new key callback, or `NULL` to remove the currently
* set callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_key
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
*
* @ingroup input
*/
@@ -1924,11 +2736,56 @@ GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun cbfun);
/*! @brief Sets the Unicode character callback.
*
- * This function sets the character callback of the specific window, which is
+ * This function sets the character callback of the specified window, which is
* called when a Unicode character is input.
*
- * The character callback is intended for text input. If you want to know
- * whether a specific key was pressed or released, use the
+ * The character callback is intended for Unicode text input. As it deals with
+ * characters, it is keyboard layout dependent, whereas the
+ * [key callback](@ref glfwSetKeyCallback) is not. Characters do not map 1:1
+ * to physical keys, as a key may produce zero, one or more characters. If you
+ * want to know whether a specific physical key was pressed or released, see
+ * the key callback instead.
+ *
+ * The character callback behaves as system text input normally does and will
+ * not be called if modifier keys are held down that would prevent normal text
+ * input on that platform, for example a Super (Command) key on OS X or Alt key
+ * on Windows. There is a
+ * [character with modifiers callback](@ref glfwSetCharModsCallback) that
+ * receives these events.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] cbfun The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_char
+ *
+ * @since Added in GLFW 2.4.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
+ *
+ * @ingroup input
+ */
+GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun cbfun);
+
+/*! @brief Sets the Unicode character with modifiers callback.
+ *
+ * This function sets the character with modifiers callback of the specified
+ * window, which is called when a Unicode character is input regardless of what
+ * modifier keys are used.
+ *
+ * The character with modifiers callback is intended for implementing custom
+ * Unicode character input. For regular Unicode text input, see the
+ * [character callback](@ref glfwSetCharCallback). Like the character
+ * callback, the character with modifiers callback deals with characters and is
+ * keyboard layout dependent. Characters do not map 1:1 to physical keys, as
+ * a key may produce zero, one or more characters. If you want to know whether
+ * a specific physical key was pressed or released, see the
* [key callback](@ref glfwSetKeyCallback) instead.
*
* @param[in] window The window whose callback to set.
@@ -1937,26 +2794,43 @@ GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun cbfun);
* @return The previously set callback, or `NULL` if no callback was set or an
* error occurred.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_char
+ *
+ * @since Added in GLFW 3.1.
+ *
* @ingroup input
*/
-GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun cbfun);
+GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun cbfun);
/*! @brief Sets the mouse button callback.
*
* This function sets the mouse button callback of the specified window, which
* is called when a mouse button is pressed or released.
*
- * When a window loses focus, it will generate synthetic mouse button release
- * events for all pressed mouse buttons. You can tell these events from
- * user-generated events by the fact that the synthetic ones are generated
- * after the window has lost focus, i.e. `GLFW_FOCUSED` will be false and the
- * focus callback will have already been called.
+ * When a window loses input focus, it will generate synthetic mouse button
+ * release events for all pressed mouse buttons. You can tell these events
+ * from user-generated events by the fact that the synthetic ones are generated
+ * after the focus loss event has been processed, i.e. after the
+ * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
*
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref input_mouse_button
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter. Updated callback signature.
*
* @ingroup input
*/
@@ -1972,8 +2846,15 @@ GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmo
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
+ *
+ * @since Added in GLFW 3.0. Replaces `glfwSetMousePosCallback`.
*
* @ingroup input
*/
@@ -1988,8 +2869,15 @@ GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursor
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new callback, or `NULL` to remove the currently set
* callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref cursor_enter
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup input
*/
@@ -2007,20 +2895,61 @@ GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcu
* @param[in] window The window whose callback to set.
* @param[in] cbfun The new scroll callback, or `NULL` to remove the currently
* set callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * error occurred.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref scrolling
+ *
+ * @since Added in GLFW 3.0. Replaces `glfwSetMouseWheelCallback`.
*
* @ingroup input
*/
GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun cbfun);
+/*! @brief Sets the file drop callback.
+ *
+ * This function sets the file drop callback of the specified window, which is
+ * called when one or more dragged files are dropped on the window.
+ *
+ * Because the path array and its strings may have been generated specifically
+ * for that event, they are not guaranteed to be valid after the callback has
+ * returned. If you wish to use them after the callback returns, you need to
+ * make a deep copy.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] cbfun The new file drop callback, or `NULL` to remove the
+ * currently set callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref path_drop
+ *
+ * @since Added in GLFW 3.1.
+ *
+ * @ingroup input
+ */
+GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun cbfun);
+
/*! @brief Returns whether the specified joystick is present.
*
* This function returns whether the specified joystick is present.
*
- * @param[in] joy The joystick to query.
+ * @param[in] joy The [joystick](@ref joysticks) to query.
* @return `GL_TRUE` if the joystick is present, or `GL_FALSE` otherwise.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref joystick
+ *
+ * @since Added in GLFW 3.0. Replaces `glfwGetJoystickParam`.
+ *
* @ingroup input
*/
GLFWAPI int glfwJoystickPresent(int joy);
@@ -2028,17 +2957,24 @@ GLFWAPI int glfwJoystickPresent(int joy);
/*! @brief Returns the values of all axes of the specified joystick.
*
* This function returns the values of all axes of the specified joystick.
+ * Each element in the array is a value between -1.0 and 1.0.
*
- * @param[in] joy The joystick to query.
- * @param[out] count Where to store the size of the returned array. This is
- * set to zero if an error occurred.
+ * @param[in] joy The [joystick](@ref joysticks) to query.
+ * @param[out] count Where to store the number of axis values in the returned
+ * array. This is set to zero if an error occurred.
* @return An array of axis values, or `NULL` if the joystick is not present.
*
- * @note The returned array is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned array is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified joystick is disconnected, this
+ * function is called again for that joystick or the library is terminated.
*
- * @note The returned array is valid only until the next call to @ref
- * glfwGetJoystickAxes for that joystick.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref joystick_axis
+ *
+ * @since Added in GLFW 3.0. Replaces `glfwGetJoystickPos`.
*
* @ingroup input
*/
@@ -2047,17 +2983,27 @@ GLFWAPI const float* glfwGetJoystickAxes(int joy, int* count);
/*! @brief Returns the state of all buttons of the specified joystick.
*
* This function returns the state of all buttons of the specified joystick.
+ * Each element in the array is either `GLFW_PRESS` or `GLFW_RELEASE`.
*
- * @param[in] joy The joystick to query.
- * @param[out] count Where to store the size of the returned array. This is
- * set to zero if an error occurred.
+ * @param[in] joy The [joystick](@ref joysticks) to query.
+ * @param[out] count Where to store the number of button states in the returned
+ * array. This is set to zero if an error occurred.
* @return An array of button states, or `NULL` if the joystick is not present.
*
- * @note The returned array is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned array is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified joystick is disconnected, this
+ * function is called again for that joystick or the library is terminated.
*
- * @note The returned array is valid only until the next call to @ref
- * glfwGetJoystickButtons for that joystick.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref joystick_button
+ *
+ * @since Added in GLFW 2.2.
+ *
+ * @par
+ * __GLFW 3:__ Changed to return a dynamic array.
*
* @ingroup input
*/
@@ -2066,16 +3012,24 @@ GLFWAPI const unsigned char* glfwGetJoystickButtons(int joy, int* count);
/*! @brief Returns the name of the specified joystick.
*
* This function returns the name, encoded as UTF-8, of the specified joystick.
+ * The returned string is allocated and freed by GLFW. You should not free it
+ * yourself.
*
- * @param[in] joy The joystick to query.
+ * @param[in] joy The [joystick](@ref joysticks) to query.
* @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick
* is not present.
*
- * @note The returned string is allocated and freed by GLFW. You should not
- * free it yourself.
+ * @par Pointer Lifetime
+ * The returned string is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the specified joystick is disconnected, this
+ * function is called again for that joystick or the library is terminated.
*
- * @note The returned string is valid only until the next call to @ref
- * glfwGetJoystickName for that joystick.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref joystick_name
+ *
+ * @since Added in GLFW 3.0.
*
* @ingroup input
*/
@@ -2084,40 +3038,50 @@ GLFWAPI const char* glfwGetJoystickName(int joy);
/*! @brief Sets the clipboard to the specified string.
*
* This function sets the system clipboard to the specified, UTF-8 encoded
- * string. The string is copied before returning, so you don't have to retain
- * it afterwards.
+ * string.
*
* @param[in] window The window that will own the clipboard contents.
* @param[in] string A UTF-8 encoded string.
*
- * @note This function may only be called from the main thread.
+ * @par Pointer Lifetime
+ * The specified string is copied before this function returns.
*
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref clipboard
* @sa glfwGetClipboardString
*
- * @ingroup clipboard
+ * @since Added in GLFW 3.0.
+ *
+ * @ingroup input
*/
GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
-/*! @brief Retrieves the contents of the clipboard as a string.
+/*! @brief Returns the contents of the clipboard as a string.
*
* This function returns the contents of the system clipboard, if it contains
* or is convertible to a UTF-8 encoded string.
*
* @param[in] window The window that will request the clipboard contents.
* @return The contents of the clipboard as a UTF-8 encoded string, or `NULL`
- * if an error occurred.
+ * if an [error](@ref error_handling) occurred.
*
- * @note This function may only be called from the main thread.
+ * @par Pointer Lifetime
+ * The returned string is allocated and freed by GLFW. You should not free it
+ * yourself. It is valid until the next call to @ref
+ * glfwGetClipboardString or @ref glfwSetClipboardString, or until the library
+ * is terminated.
*
- * @note The returned string is allocated and freed by GLFW. You should not
- * free it yourself.
- *
- * @note The returned string is valid only until the next call to @ref
- * glfwGetClipboardString or @ref glfwSetClipboardString.
+ * @par Thread Safety
+ * This function may only be called from the main thread.
*
+ * @sa @ref clipboard
* @sa glfwSetClipboardString
*
- * @ingroup clipboard
+ * @since Added in GLFW 3.0.
+ *
+ * @ingroup input
*/
GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
@@ -2127,63 +3091,91 @@ GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
* been set using @ref glfwSetTime, the timer measures time elapsed since GLFW
* was initialized.
*
- * @return The current value, in seconds, or zero if an error occurred.
+ * The resolution of the timer is system dependent, but is usually on the order
+ * of a few micro- or nanoseconds. It uses the highest-resolution monotonic
+ * time source on each supported platform.
*
- * @remarks This function may be called from secondary threads.
+ * @return The current value, in seconds, or zero if an
+ * [error](@ref error_handling) occurred.
*
- * @note The resolution of the timer is system dependent, but is usually on the
- * order of a few micro- or nanoseconds. It uses the highest-resolution
- * monotonic time source on each supported platform.
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
*
- * @ingroup time
+ * @sa @ref time
+ *
+ * @since Added in GLFW 1.0.
+ *
+ * @ingroup input
*/
GLFWAPI double glfwGetTime(void);
/*! @brief Sets the GLFW timer.
*
* This function sets the value of the GLFW timer. It then continues to count
- * up from that value.
+ * up from that value. The value must be a positive finite number less than
+ * or equal to 18446744073.0, which is approximately 584.5 years.
*
* @param[in] time The new value, in seconds.
*
- * @note The resolution of the timer is system dependent, but is usually on the
- * order of a few micro- or nanoseconds. It uses the highest-resolution
- * monotonic time source on each supported platform.
+ * @remarks The upper limit of the timer is calculated as
+ * floor((2<sup>64</sup> - 1) / 10<sup>9</sup>) and is due to implementations
+ * storing nanoseconds in 64 bits. The limit may be increased in the future.
*
- * @ingroup time
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref time
+ *
+ * @since Added in GLFW 2.2.
+ *
+ * @ingroup input
*/
GLFWAPI void glfwSetTime(double time);
/*! @brief Makes the context of the specified window current for the calling
* thread.
*
- * This function makes the context of the specified window current on the
- * calling thread. A context can only be made current on a single thread at
- * a time and each thread can have only a single current context at a time.
+ * This function makes the OpenGL or OpenGL ES context of the specified window
+ * current on the calling thread. A context can only be made current on
+ * a single thread at a time and each thread can have only a single current
+ * context at a time.
+ *
+ * By default, making a context non-current implicitly forces a pipeline flush.
+ * On machines that support `GL_KHR_context_flush_control`, you can control
+ * whether a context performs this flush by setting the
+ * [GLFW_CONTEXT_RELEASE_BEHAVIOR](@ref window_hints_ctx) window hint.
*
* @param[in] window The window whose context to make current, or `NULL` to
* detach the current context.
*
- * @remarks This function may be called from secondary threads.
+ * @par Thread Safety
+ * This function may be called from any thread.
*
+ * @sa @ref context_current
* @sa glfwGetCurrentContext
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup context
*/
GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
/*! @brief Returns the window whose context is current on the calling thread.
*
- * This function returns the window whose context is current on the calling
- * thread.
+ * This function returns the window whose OpenGL or OpenGL ES context is
+ * current on the calling thread.
*
* @return The window whose context is current, or `NULL` if no window's
* context is current.
*
- * @remarks This function may be called from secondary threads.
+ * @par Thread Safety
+ * This function may be called from any thread.
*
+ * @sa @ref context_current
* @sa glfwMakeContextCurrent
*
+ * @since Added in GLFW 3.0.
+ *
* @ingroup context
*/
GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
@@ -2196,24 +3188,28 @@ GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
*
* @param[in] window The window whose buffers to swap.
*
- * @remarks This function may be called from secondary threads.
- *
- * @par New in GLFW 3
- * This function no longer calls @ref glfwPollEvents. You need to call it or
- * @ref glfwWaitEvents yourself.
+ * @par Thread Safety
+ * This function may be called from any thread.
*
+ * @sa @ref buffer_swap
* @sa glfwSwapInterval
*
- * @ingroup context
+ * @since Added in GLFW 1.0.
+ *
+ * @par
+ * __GLFW 3:__ Added window handle parameter.
+ *
+ * @ingroup window
*/
GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
/*! @brief Sets the swap interval for the current context.
*
* This function sets the swap interval for the current context, i.e. the
- * number of screen updates to wait before swapping the buffers of a window and
- * returning from @ref glfwSwapBuffers. This is sometimes called 'vertical
- * synchronization', 'vertical retrace synchronization' or 'vsync'.
+ * number of screen updates to wait from the time @ref glfwSwapBuffers was
+ * called before swapping the buffers and returning. This is sometimes called
+ * _vertical synchronization_, _vertical retrace synchronization_ or just
+ * _vsync_.
*
* Contexts that support either of the `WGL_EXT_swap_control_tear` and
* `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals,
@@ -2222,22 +3218,29 @@ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
* glfwExtensionSupported. For more information about swap tearing, see the
* extension specifications.
*
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
* @param[in] interval The minimum number of screen updates to wait for
* until the buffers are swapped by @ref glfwSwapBuffers.
*
- * @remarks This function may be called from secondary threads.
- *
- * @note This function is not called during window creation, leaving the swap
- * interval set to whatever is the default on that platform. This is done
+ * @remarks This function is not called during context creation, leaving the
+ * swap interval set to whatever is the default on that platform. This is done
* because some swap interval extensions used by GLFW do not allow the swap
* interval to be reset to zero once it has been set to a non-zero value.
*
- * @note Some GPU drivers do not honor the requested swap interval, either
- * because of user settings that override the request or due to bugs in the
- * driver.
+ * @remarks Some GPU drivers do not honor the requested swap interval, either
+ * because of a user setting that overrides the application's request or due to
+ * bugs in the driver.
*
+ * @par Thread Safety
+ * This function may be called from any thread.
+ *
+ * @sa @ref buffer_swap
* @sa glfwSwapBuffers
*
+ * @since Added in GLFW 1.0.
+ *
* @ingroup context
*/
GLFWAPI void glfwSwapInterval(int interval);
@@ -2245,19 +3248,28 @@ GLFWAPI void glfwSwapInterval(int interval);
/*! @brief Returns whether the specified extension is available.
*
* This function returns whether the specified
- * [OpenGL or context creation API extension](@ref context_glext) is supported
- * by the current context. For example, on Windows both the OpenGL and WGL
- * extension strings are checked.
+ * [client API extension](@ref context_glext) is supported by the current
+ * OpenGL or OpenGL ES context. It searches both for OpenGL and OpenGL ES
+ * extension and platform-specific context creation API extensions.
+ *
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
+ * As this functions retrieves and searches one or more extension strings each
+ * call, it is recommended that you cache its results if it is going to be used
+ * frequently. The extension strings will not change during the lifetime of
+ * a context, so there is no danger in doing this.
*
* @param[in] extension The ASCII encoded name of the extension.
* @return `GL_TRUE` if the extension is available, or `GL_FALSE` otherwise.
*
- * @remarks This function may be called from secondary threads.
+ * @par Thread Safety
+ * This function may be called from any thread.
*
- * @note As this functions searches one or more extension strings on each call,
- * it is recommended that you cache its results if it's going to be used
- * frequently. The extension strings will not change during the lifetime of
- * a context, so there is no danger in doing this.
+ * @sa @ref context_glext
+ * @sa glfwGetProcAddress
+ *
+ * @since Added in GLFW 1.0.
*
* @ingroup context
*/
@@ -2267,18 +3279,34 @@ GLFWAPI int glfwExtensionSupported(const char* extension);
* context.
*
* This function returns the address of the specified
- * [client API or extension function](@ref context_glext), if it is supported
+ * [core or extension function](@ref context_glext), if it is supported
* by the current context.
*
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
* @param[in] procname The ASCII encoded name of the function.
* @return The address of the function, or `NULL` if the function is
- * unavailable.
+ * unavailable or an [error](@ref error_handling) occurred.
*
- * @remarks This function may be called from secondary threads.
+ * @remarks The addresses of a given function is not guaranteed to be the same
+ * between contexts.
*
- * @note The addresses of these functions are not guaranteed to be the same for
- * all contexts, especially if they use different client APIs or even different
- * context creation hints.
+ * @remarks This function may return a non-`NULL` address despite the
+ * associated version or extension not being available. Always check the
+ * context version or extension string presence first.
+ *
+ * @par Pointer Lifetime
+ * The returned function pointer is valid until the context is destroyed or the
+ * library is terminated.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread.
+ *
+ * @sa @ref context_glext
+ * @sa glfwExtensionSupported
+ *
+ * @since Added in GLFW 1.0.
*
* @ingroup context
*/
diff --git a/externals/glfw-3.1.1.bin/include/GLFW/glfw3native.h b/externals/glfw-3.1.1.bin/include/GLFW/glfw3native.h
new file mode 100644
index 0000000000..b3ce7482dd
--- /dev/null
+++ b/externals/glfw-3.1.1.bin/include/GLFW/glfw3native.h
@@ -0,0 +1,356 @@
+/*************************************************************************
+ * GLFW 3.1 - www.glfw.org
+ * A library for OpenGL, window and input
+ *------------------------------------------------------------------------
+ * Copyright (c) 2002-2006 Marcus Geelnard
+ * Copyright (c) 2006-2010 Camilla Berglund <elmindreda@elmindreda.org>
+ *
+ * This software is provided 'as-is', without any express or implied
+ * warranty. In no event will the authors be held liable for any damages
+ * arising from the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software
+ * in a product, an acknowledgment in the product documentation would
+ * be appreciated but is not required.
+ *
+ * 2. Altered source versions must be plainly marked as such, and must not
+ * be misrepresented as being the original software.
+ *
+ * 3. This notice may not be removed or altered from any source
+ * distribution.
+ *
+ *************************************************************************/
+
+#ifndef _glfw3_native_h_
+#define _glfw3_native_h_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/*************************************************************************
+ * Doxygen documentation
+ *************************************************************************/
+
+/*! @defgroup native Native access
+ *
+ * **By using the native access functions you assert that you know what you're
+ * doing and how to fix problems caused by using them. If you don't, you
+ * shouldn't be using them.**
+ *
+ * Before the inclusion of @ref glfw3native.h, you must define exactly one
+ * window system API macro and exactly one context creation API macro. Failure
+ * to do this will cause a compile-time error.
+ *
+ * The available window API macros are:
+ * * `GLFW_EXPOSE_NATIVE_WIN32`
+ * * `GLFW_EXPOSE_NATIVE_COCOA`
+ * * `GLFW_EXPOSE_NATIVE_X11`
+ *
+ * The available context API macros are:
+ * * `GLFW_EXPOSE_NATIVE_WGL`
+ * * `GLFW_EXPOSE_NATIVE_NSGL`
+ * * `GLFW_EXPOSE_NATIVE_GLX`
+ * * `GLFW_EXPOSE_NATIVE_EGL`
+ *
+ * These macros select which of the native access functions that are declared
+ * and which platform-specific headers to include. It is then up your (by
+ * definition platform-specific) code to handle which of these should be
+ * defined.
+ */
+
+
+/*************************************************************************
+ * System headers and types
+ *************************************************************************/
+
+#if defined(GLFW_EXPOSE_NATIVE_WIN32)
+ // This is a workaround for the fact that glfw3.h needs to export APIENTRY (for
+ // example to allow applications to correctly declare a GL_ARB_debug_output
+ // callback) but windows.h assumes no one will define APIENTRY before it does
+ #undef APIENTRY
+ #include <windows.h>
+#elif defined(GLFW_EXPOSE_NATIVE_COCOA)
+ #include <ApplicationServices/ApplicationServices.h>
+ #if defined(__OBJC__)
+ #import <Cocoa/Cocoa.h>
+ #else
+ typedef void* id;
+ #endif
+#elif defined(GLFW_EXPOSE_NATIVE_X11)
+ #include <X11/Xlib.h>
+ #include <X11/extensions/Xrandr.h>
+#else
+ #error "No window API selected"
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_WGL)
+ /* WGL is declared by windows.h */
+#elif defined(GLFW_EXPOSE_NATIVE_NSGL)
+ /* NSGL is declared by Cocoa.h */
+#elif defined(GLFW_EXPOSE_NATIVE_GLX)
+ #include <GL/glx.h>
+#elif defined(GLFW_EXPOSE_NATIVE_EGL)
+ #include <EGL/egl.h>
+#else
+ #error "No context API selected"
+#endif
+
+
+/*************************************************************************
+ * Functions
+ *************************************************************************/
+
+#if defined(GLFW_EXPOSE_NATIVE_WIN32)
+/*! @brief Returns the adapter device name of the specified monitor.
+ *
+ * @return The UTF-8 encoded adapter device name (for example `\\.\DISPLAY1`)
+ * of the specified monitor, or `NULL` if an [error](@ref error_handling)
+ * occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.1.
+ *
+ * @ingroup native
+ */
+GLFWAPI const char* glfwGetWin32Adapter(GLFWmonitor* monitor);
+
+/*! @brief Returns the display device name of the specified monitor.
+ *
+ * @return The UTF-8 encoded display device name (for example
+ * `\\.\DISPLAY1\Monitor0`) of the specified monitor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.1.
+ *
+ * @ingroup native
+ */
+GLFWAPI const char* glfwGetWin32Monitor(GLFWmonitor* monitor);
+
+/*! @brief Returns the `HWND` of the specified window.
+ *
+ * @return The `HWND` of the specified window, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_WGL)
+/*! @brief Returns the `HGLRC` of the specified window.
+ *
+ * @return The `HGLRC` of the specified window, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_COCOA)
+/*! @brief Returns the `CGDirectDisplayID` of the specified monitor.
+ *
+ * @return The `CGDirectDisplayID` of the specified monitor, or
+ * `kCGNullDirectDisplay` if an [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.1.
+ *
+ * @ingroup native
+ */
+GLFWAPI CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor* monitor);
+
+/*! @brief Returns the `NSWindow` of the specified window.
+ *
+ * @return The `NSWindow` of the specified window, or `nil` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_NSGL)
+/*! @brief Returns the `NSOpenGLContext` of the specified window.
+ *
+ * @return The `NSOpenGLContext` of the specified window, or `nil` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_X11)
+/*! @brief Returns the `Display` used by GLFW.
+ *
+ * @return The `Display` used by GLFW, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI Display* glfwGetX11Display(void);
+
+/*! @brief Returns the `RRCrtc` of the specified monitor.
+ *
+ * @return The `RRCrtc` of the specified monitor, or `None` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.1.
+ *
+ * @ingroup native
+ */
+GLFWAPI RRCrtc glfwGetX11Adapter(GLFWmonitor* monitor);
+
+/*! @brief Returns the `RROutput` of the specified monitor.
+ *
+ * @return The `RROutput` of the specified monitor, or `None` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.1.
+ *
+ * @ingroup native
+ */
+GLFWAPI RROutput glfwGetX11Monitor(GLFWmonitor* monitor);
+
+/*! @brief Returns the `Window` of the specified window.
+ *
+ * @return The `Window` of the specified window, or `None` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_GLX)
+/*! @brief Returns the `GLXContext` of the specified window.
+ *
+ * @return The `GLXContext` of the specified window, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
+#endif
+
+#if defined(GLFW_EXPOSE_NATIVE_EGL)
+/*! @brief Returns the `EGLDisplay` used by GLFW.
+ *
+ * @return The `EGLDisplay` used by GLFW, or `EGL_NO_DISPLAY` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
+
+/*! @brief Returns the `EGLContext` of the specified window.
+ *
+ * @return The `EGLContext` of the specified window, or `EGL_NO_CONTEXT` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
+
+/*! @brief Returns the `EGLSurface` of the specified window.
+ *
+ * @return The `EGLSurface` of the specified window, or `EGL_NO_SURFACE` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @par Thread Safety
+ * This function may be called from any thread. Access is not synchronized.
+ *
+ * @par History
+ * Added in GLFW 3.0.
+ *
+ * @ingroup native
+ */
+GLFWAPI EGLSurface glfwGetEGLSurface(GLFWwindow* window);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* _glfw3_native_h_ */
+
diff --git a/externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3.dll b/externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3.dll
new file mode 100644
index 0000000000..84c2e1bc2d
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3.dll differ
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3dll.a b/externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3dll.a
similarity index 62%
rename from externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3dll.a
rename to externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3dll.a
index 415d85630c..dc593d062a 100644
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-i686/glfw3dll.a and b/externals/glfw-3.1.1.bin/lib-mingw-i686/glfw3dll.a differ
diff --git a/externals/glfw-3.1.1.bin/lib-mingw-i686/libglfw3.a b/externals/glfw-3.1.1.bin/lib-mingw-i686/libglfw3.a
new file mode 100644
index 0000000000..59eae08686
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-mingw-i686/libglfw3.a differ
diff --git a/externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3.dll b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3.dll
new file mode 100644
index 0000000000..437918eda9
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3.dll differ
diff --git a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3dll.a b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3dll.a
similarity index 62%
rename from externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3dll.a
rename to externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3dll.a
index d71c653772..be08358abd 100644
Binary files a/externals/glfw-3.0.4.bin/lib-mingw-x86_64/glfw3dll.a and b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/glfw3dll.a differ
diff --git a/externals/glfw-3.1.1.bin/lib-mingw-x86_64/libglfw3.a b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/libglfw3.a
new file mode 100644
index 0000000000..e9e7be933b
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-mingw-x86_64/libglfw3.a differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.dll b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.dll
new file mode 100644
index 0000000000..f15748d7a7
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.dll differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.lib b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.lib
new file mode 100644
index 0000000000..6a5a85a1db
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3.lib differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3dll.lib b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3dll.lib
new file mode 100644
index 0000000000..248a5cadf9
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-Win32/glfw3dll.lib differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.dll b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.dll
new file mode 100644
index 0000000000..cba172f645
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.dll differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.lib b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.lib
new file mode 100644
index 0000000000..efdd643327
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3.lib differ
diff --git a/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3dll.lib b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3dll.lib
new file mode 100644
index 0000000000..49ed2bb67d
Binary files /dev/null and b/externals/glfw-3.1.1.bin/lib-msvc_v120-x64/glfw3dll.lib differ