/************************************************************************* * GLFW - An OpenGL library * API version: 3.0 * WWW: http://www.glfw.org/ *------------------------------------------------------------------------ * Copyright (c) 2002-2006 Marcus Geelnard * Copyright (c) 2006-2010 Camilla Berglund * * 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_h_ #define _glfw3_h_ #ifdef __cplusplus extern "C" { #endif /************************************************************************* * Doxygen documentation *************************************************************************/ /*! @defgroup clipboard Clipboard support */ /*! @defgroup context Context handling */ /*! @defgroup error Error handling */ /*! @defgroup gamma Gamma ramp support */ /*! @defgroup init Initialization and version information */ /*! @defgroup input Input handling */ /*! @defgroup monitor Monitor handling */ /*! @defgroup time Time input */ /*! @defgroup window Window handling * * This is the reference documentation for the window handling API, including * creation, deletion and event polling. For more information, see the * [article on window handling](@ref window). */ /************************************************************************* * Global definitions *************************************************************************/ /* ------------------- 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 !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__CYGWIN__)) #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 ) */ #ifndef APIENTRY #ifdef _WIN32 #define APIENTRY __stdcall #else #define APIENTRY #endif #endif /* APIENTRY */ /* The following three defines are here solely to make some Windows-based * files happy. Theoretically we could include , but * it has the major drawback of severely polluting our namespace. */ /* 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 GLFW_WINGDIAPI_DEFINED #endif /* WINGDIAPI */ /* Some files also need CALLBACK defined */ #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 GLFW_CALLBACK_DEFINED #endif /* CALLBACK */ /* Most variants on Windows need wchar_t */ #if defined(_WIN32) #include #endif /* ---------------- GLFW related system specific defines ----------------- */ #if defined(GLFW_DLL) && defined(_GLFW_BUILD_DLL) #error "You must not have both GLFW_DLL and _GLFW_BUILD_DLL defined" #endif #if defined(_WIN32) && defined(_GLFW_BUILD_DLL) /* We are building 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 #elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL) #define GLFWAPI __attribute__((visibility("default"))) #else /* We are either building/calling a static lib or we are non-win32 */ #define GLFWAPI #endif /* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */ /* Include the chosen client API headers. */ #if defined(__APPLE_CC__) #if defined(GLFW_INCLUDE_GLCOREARB) #include #elif !defined(GLFW_INCLUDE_NONE) #define GL_GLEXT_LEGACY #include #endif #if defined(GLFW_INCLUDE_GLU) #include #endif #else #if defined(GLFW_INCLUDE_GLCOREARB) #include #elif defined(GLFW_INCLUDE_ES1) #include #elif defined(GLFW_INCLUDE_ES2) #include #elif defined(GLFW_INCLUDE_ES3) #include #elif !defined(GLFW_INCLUDE_NONE) #include #endif #if defined(GLFW_INCLUDE_GLU) #include #endif #endif /************************************************************************* * GLFW API tokens *************************************************************************/ /*! @name GLFW version macros * @{ */ /*! @brief The major version number of the GLFW library. * * This is incremented when the API is changed in non-compatible ways. * @ingroup init */ #define GLFW_VERSION_MAJOR 3 /*! @brief The minor version number of the GLFW library. * * This is incremented when features are added to the API but it remains * backward-compatible. * @ingroup init */ #define GLFW_VERSION_MINOR 0 /*! @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 0 /*! @} */ /*! @name Key and button actions * @{ */ /*! @brief The key or button was released. * @ingroup input */ #define GLFW_RELEASE 0 /*! @brief The key or button was pressed. * @ingroup input */ #define GLFW_PRESS 1 /*! @brief The key was held down until it repeated. * @ingroup input */ #define GLFW_REPEAT 2 /*! @} */ /*! @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). * * 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 * @{ */ /* Printable keys */ #define GLFW_KEY_SPACE 32 #define GLFW_KEY_APOSTROPHE 39 /* ' */ #define GLFW_KEY_COMMA 44 /* , */ #define GLFW_KEY_MINUS 45 /* - */ #define GLFW_KEY_PERIOD 46 /* . */ #define GLFW_KEY_SLASH 47 /* / */ #define GLFW_KEY_0 48 #define GLFW_KEY_1 49 #define GLFW_KEY_2 50 #define GLFW_KEY_3 51 #define GLFW_KEY_4 52 #define GLFW_KEY_5 53 #define GLFW_KEY_6 54 #define GLFW_KEY_7 55 #define GLFW_KEY_8 56 #define GLFW_KEY_9 57 #define GLFW_KEY_SEMICOLON 59 /* ; */ #define GLFW_KEY_EQUAL 61 /* = */ #define GLFW_KEY_A 65 #define GLFW_KEY_B 66 #define GLFW_KEY_C 67 #define GLFW_KEY_D 68 #define GLFW_KEY_E 69 #define GLFW_KEY_F 70 #define GLFW_KEY_G 71 #define GLFW_KEY_H 72 #define GLFW_KEY_I 73 #define GLFW_KEY_J 74 #define GLFW_KEY_K 75 #define GLFW_KEY_L 76 #define GLFW_KEY_M 77 #define GLFW_KEY_N 78 #define GLFW_KEY_O 79 #define GLFW_KEY_P 80 #define GLFW_KEY_Q 81 #define GLFW_KEY_R 82 #define GLFW_KEY_S 83 #define GLFW_KEY_T 84 #define GLFW_KEY_U 85 #define GLFW_KEY_V 86 #define GLFW_KEY_W 87 #define GLFW_KEY_X 88 #define GLFW_KEY_Y 89 #define GLFW_KEY_Z 90 #define GLFW_KEY_LEFT_BRACKET 91 /* [ */ #define GLFW_KEY_BACKSLASH 92 /* \ */ #define GLFW_KEY_RIGHT_BRACKET 93 /* ] */ #define GLFW_KEY_GRAVE_ACCENT 96 /* ` */ #define GLFW_KEY_WORLD_1 161 /* non-US #1 */ #define GLFW_KEY_WORLD_2 162 /* non-US #2 */ /* Function keys */ #define GLFW_KEY_ESCAPE 256 #define GLFW_KEY_ENTER 257 #define GLFW_KEY_TAB 258 #define GLFW_KEY_BACKSPACE 259 #define GLFW_KEY_INSERT 260 #define GLFW_KEY_DELETE 261 #define GLFW_KEY_RIGHT 262 #define GLFW_KEY_LEFT 263 #define GLFW_KEY_DOWN 264 #define GLFW_KEY_UP 265 #define GLFW_KEY_PAGE_UP 266 #define GLFW_KEY_PAGE_DOWN 267 #define GLFW_KEY_HOME 268 #define GLFW_KEY_END 269 #define GLFW_KEY_CAPS_LOCK 280 #define GLFW_KEY_SCROLL_LOCK 281 #define GLFW_KEY_NUM_LOCK 282 #define GLFW_KEY_PRINT_SCREEN 283 #define GLFW_KEY_PAUSE 284 #define GLFW_KEY_F1 290 #define GLFW_KEY_F2 291 #define GLFW_KEY_F3 292 #define GLFW_KEY_F4 293 #define GLFW_KEY_F5 294 #define GLFW_KEY_F6 295 #define GLFW_KEY_F7 296 #define GLFW_KEY_F8 297 #define GLFW_KEY_F9 298 #define GLFW_KEY_F10 299 #define GLFW_KEY_F11 300 #define GLFW_KEY_F12 301 #define GLFW_KEY_F13 302 #define GLFW_KEY_F14 303 #define GLFW_KEY_F15 304 #define GLFW_KEY_F16 305 #define GLFW_KEY_F17 306 #define GLFW_KEY_F18 307 #define GLFW_KEY_F19 308 #define GLFW_KEY_F20 309 #define GLFW_KEY_F21 310 #define GLFW_KEY_F22 311 #define GLFW_KEY_F23 312 #define GLFW_KEY_F24 313 #define GLFW_KEY_F25 314 #define GLFW_KEY_KP_0 320 #define GLFW_KEY_KP_1 321 #define GLFW_KEY_KP_2 322 #define GLFW_KEY_KP_3 323 #define GLFW_KEY_KP_4 324 #define GLFW_KEY_KP_5 325 #define GLFW_KEY_KP_6 326 #define GLFW_KEY_KP_7 327 #define GLFW_KEY_KP_8 328 #define GLFW_KEY_KP_9 329 #define GLFW_KEY_KP_DECIMAL 330 #define GLFW_KEY_KP_DIVIDE 331 #define GLFW_KEY_KP_MULTIPLY 332 #define GLFW_KEY_KP_SUBTRACT 333 #define GLFW_KEY_KP_ADD 334 #define GLFW_KEY_KP_ENTER 335 #define GLFW_KEY_KP_EQUAL 336 #define GLFW_KEY_LEFT_SHIFT 340 #define GLFW_KEY_LEFT_CONTROL 341 #define GLFW_KEY_LEFT_ALT 342 #define GLFW_KEY_LEFT_SUPER 343 #define GLFW_KEY_RIGHT_SHIFT 344 #define GLFW_KEY_RIGHT_CONTROL 345 #define GLFW_KEY_RIGHT_ALT 346 #define GLFW_KEY_RIGHT_SUPER 347 #define GLFW_KEY_MENU 348 #define GLFW_KEY_LAST GLFW_KEY_MENU /* GLFW 2.x key name aliases (deprecated) */ #define GLFW_KEY_ESC GLFW_KEY_ESCAPE #define GLFW_KEY_DEL GLFW_KEY_DELETE #define GLFW_KEY_PAGEUP GLFW_KEY_PAGE_UP #define GLFW_KEY_PAGEDOWN GLFW_KEY_PAGE_DOWN #define GLFW_KEY_KP_NUM_LOCK GLFW_KEY_NUM_LOCK #define GLFW_KEY_LCTRL GLFW_KEY_LEFT_CONTROL #define GLFW_KEY_LSHIFT GLFW_KEY_LEFT_SHIFT #define GLFW_KEY_LALT GLFW_KEY_LEFT_ALT #define GLFW_KEY_LSUPER GLFW_KEY_LEFT_SUPER #define GLFW_KEY_RCTRL GLFW_KEY_RIGHT_CONTROL #define GLFW_KEY_RSHIFT GLFW_KEY_RIGHT_SHIFT #define GLFW_KEY_RALT GLFW_KEY_RIGHT_ALT #define GLFW_KEY_RSUPER GLFW_KEY_RIGHT_SUPER /*! @} */ /*! @defgroup mods Modifier key flags * @ingroup input * @{ */ /*! @brief If this bit is set one or more Shift keys were held down. */ #define GLFW_MOD_SHIFT 0x0001 /*! @brief If this bit is set one or more Control keys were held down. */ #define GLFW_MOD_CONTROL 0x0002 /*! @brief If this bit is set one or more Alt keys were held down. */ #define GLFW_MOD_ALT 0x0004 /*! @brief If this bit is set one or more Super keys were held down. */ #define GLFW_MOD_SUPER 0x0008 /*! @} */ /*! @defgroup buttons Mouse buttons * @ingroup input * @{ */ #define GLFW_MOUSE_BUTTON_1 0 #define GLFW_MOUSE_BUTTON_2 1 #define GLFW_MOUSE_BUTTON_3 2 #define GLFW_MOUSE_BUTTON_4 3 #define GLFW_MOUSE_BUTTON_5 4 #define GLFW_MOUSE_BUTTON_6 5 #define GLFW_MOUSE_BUTTON_7 6 #define GLFW_MOUSE_BUTTON_8 7 #define GLFW_MOUSE_BUTTON_LAST GLFW_MOUSE_BUTTON_8 #define GLFW_MOUSE_BUTTON_LEFT GLFW_MOUSE_BUTTON_1 #define GLFW_MOUSE_BUTTON_RIGHT GLFW_MOUSE_BUTTON_2 #define GLFW_MOUSE_BUTTON_MIDDLE GLFW_MOUSE_BUTTON_3 /*! @} */ /*! @defgroup joysticks Joysticks * @ingroup input * @{ */ #define GLFW_JOYSTICK_1 0 #define GLFW_JOYSTICK_2 1 #define GLFW_JOYSTICK_3 2 #define GLFW_JOYSTICK_4 3 #define GLFW_JOYSTICK_5 4 #define GLFW_JOYSTICK_6 5 #define GLFW_JOYSTICK_7 6 #define GLFW_JOYSTICK_8 7 #define GLFW_JOYSTICK_9 8 #define GLFW_JOYSTICK_10 9 #define GLFW_JOYSTICK_11 10 #define GLFW_JOYSTICK_12 11 #define GLFW_JOYSTICK_13 12 #define GLFW_JOYSTICK_14 13 #define GLFW_JOYSTICK_15 14 #define GLFW_JOYSTICK_16 15 #define GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16 /*! @} */ /*! @defgroup errors Error codes * @ingroup error * @{ */ /*! @brief GLFW has not been initialized. */ #define GLFW_NOT_INITIALIZED 0x00010001 /*! @brief No context is current for this thread. */ #define GLFW_NO_CURRENT_CONTEXT 0x00010002 /*! @brief One of the enum parameters for the function was given an invalid * enum. */ #define GLFW_INVALID_ENUM 0x00010003 /*! @brief One of the parameters for the function was given an invalid value. */ #define GLFW_INVALID_VALUE 0x00010004 /*! @brief A memory allocation failed. */ #define GLFW_OUT_OF_MEMORY 0x00010005 /*! @brief GLFW could not find support for the requested client API on the * system. */ #define GLFW_API_UNAVAILABLE 0x00010006 /*! @brief The requested client API version is not available. */ #define GLFW_VERSION_UNAVAILABLE 0x00010007 /*! @brief A platform-specific error occurred that does not match any of the * more specific categories. */ #define GLFW_PLATFORM_ERROR 0x00010008 /*! @brief The clipboard did not contain data in the requested format. */ #define GLFW_FORMAT_UNAVAILABLE 0x00010009 /*! @} */ #define GLFW_FOCUSED 0x00020001 #define GLFW_ICONIFIED 0x00020002 #define GLFW_RESIZABLE 0x00020003 #define GLFW_VISIBLE 0x00020004 #define GLFW_DECORATED 0x00020005 #define GLFW_CONTEXT_REVISION 0x00021001 #define GLFW_RED_BITS 0x00021002 #define GLFW_GREEN_BITS 0x00021003 #define GLFW_BLUE_BITS 0x00021004 #define GLFW_ALPHA_BITS 0x00021005 #define GLFW_DEPTH_BITS 0x00021006 #define GLFW_STENCIL_BITS 0x00021007 #define GLFW_ACCUM_RED_BITS 0x00021008 #define GLFW_ACCUM_GREEN_BITS 0x00021009 #define GLFW_ACCUM_BLUE_BITS 0x0002100A #define GLFW_ACCUM_ALPHA_BITS 0x0002100B #define GLFW_AUX_BUFFERS 0x0002100C #define GLFW_STEREO 0x0002100D #define GLFW_SAMPLES 0x0002100E #define GLFW_SRGB_CAPABLE 0x0002100F #define GLFW_CLIENT_API 0x00022000 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022001 #define GLFW_CONTEXT_VERSION_MINOR 0x00022002 #define GLFW_CONTEXT_ROBUSTNESS 0x00022003 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022004 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022005 #define GLFW_OPENGL_PROFILE 0x00022006 #define GLFW_OPENGL_API 0x00030001 #define GLFW_OPENGL_ES_API 0x00030002 #define GLFW_NO_ROBUSTNESS 0 #define GLFW_NO_RESET_NOTIFICATION 0x00031001 #define GLFW_LOSE_CONTEXT_ON_RESET 0x00031002 #define GLFW_OPENGL_NO_PROFILE 0 #define GLFW_OPENGL_CORE_PROFILE 0x00032001 #define GLFW_OPENGL_COMPAT_PROFILE 0x00032002 #define GLFW_CURSOR 0x00033001 #define GLFW_STICKY_KEYS 0x00033002 #define GLFW_STICKY_MOUSE_BUTTONS 0x00033003 #define GLFW_CURSOR_NORMAL 0x00034001 #define GLFW_CURSOR_HIDDEN 0x00034002 #define GLFW_CURSOR_DISABLED 0x00034003 #define GLFW_CONNECTED 0x00040001 #define GLFW_DISCONNECTED 0x00040002 /************************************************************************* * GLFW API types *************************************************************************/ /*! @brief Client API function pointer type. * * Generic function pointer used for returning client API function pointers * without forcing a cast from a regular pointer. * * @ingroup context */ typedef void (*GLFWglproc)(void); /*! @brief Opaque monitor object. * * Opaque monitor object. * * @ingroup monitor */ typedef struct GLFWmonitor GLFWmonitor; /*! @brief Opaque window object. * * Opaque window object. * * @ingroup window */ typedef struct GLFWwindow GLFWwindow; /*! @brief The function signature for error callbacks. * * This is the function signature for error callback functions. * * @param[in] error An [error code](@ref errors). * @param[in] description A UTF-8 encoded string describing the error. * * @sa glfwSetErrorCallback * * @ingroup error */ typedef void (* GLFWerrorfun)(int,const char*); /*! @brief The function signature for window position callbacks. * * This is the function signature for window position callback functions. * * @param[in] window The window that the user 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 * upper-left corner of the client area of the window. * * @sa glfwSetWindowPosCallback * * @ingroup window */ typedef void (* GLFWwindowposfun)(GLFWwindow*,int,int); /*! @brief The function signature for window resize callbacks. * * This is the function signature for window size callback functions. * * @param[in] window The window that the user 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. * * @sa glfwSetWindowSizeCallback * * @ingroup window */ typedef void (* GLFWwindowsizefun)(GLFWwindow*,int,int); /*! @brief The function signature for window close callbacks. * * This is the function signature for window close callback functions. * * @param[in] window The window that the user attempted to close. * * @sa glfwSetWindowCloseCallback * * @ingroup window */ typedef void (* GLFWwindowclosefun)(GLFWwindow*); /*! @brief The function signature for window content refresh callbacks. * * This is the function signature for window refresh callback functions. * * @param[in] window The window whose content needs to be refreshed. * * @sa glfwSetWindowRefreshCallback * * @ingroup window */ typedef void (* GLFWwindowrefreshfun)(GLFWwindow*); /*! @brief The function signature for window focus/defocus callbacks. * * 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. * * @sa glfwSetWindowFocusCallback * * @ingroup window */ typedef void (* GLFWwindowfocusfun)(GLFWwindow*,int); /*! @brief The function signature for window iconify/restore callbacks. * * This is the function signature for window iconify/restore callback * functions. * * @param[in] window The window that was iconified or restored. * @param[in] iconified `GL_TRUE` if the window was iconified, or `GL_FALSE` * if it was restored. * * @sa glfwSetWindowIconifyCallback * * @ingroup window */ typedef void (* GLFWwindowiconifyfun)(GLFWwindow*,int); /*! @brief The function signature for mouse button callbacks. * * This is the function signature for mouse button callback functions. * * @param[in] window The window that received the event. * @param[in] button The [mouse button](@ref buttons) that was pressed or * released. * @param[in] action One of `GLFW_PRESS` or `GLFW_RELEASE`. * @param[in] mods Bit field describing which [modifier keys](@ref mods) were * held down. * * @sa glfwSetMouseButtonCallback * * @ingroup input */ typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int); /*! @brief The function signature for cursor position callbacks. * * This is the function signature for cursor position callback functions. * * @param[in] window The window that received the event. * @param[in] xpos The new x-coordinate of the cursor. * @param[in] ypos The new y-coordinate of the cursor. * * @sa glfwSetCursorPosCallback * * @ingroup input */ typedef void (* GLFWcursorposfun)(GLFWwindow*,double,double); /*! @brief The function signature for cursor enter/leave callbacks. * * This is the function signature for cursor enter/leave callback functions. * * @param[in] window The window that received the event. * @param[in] entered `GL_TRUE` if the cursor entered the window's client * area, or `GL_FALSE` if it left it. * * @sa glfwSetCursorEnterCallback * * @ingroup input */ typedef void (* GLFWcursorenterfun)(GLFWwindow*,int); /*! @brief The function signature for scroll callbacks. * * This is the function signature for scroll callback functions. * * @param[in] window The window that received the event. * @param[in] xpos The scroll offset along the x-axis. * @param[in] ypos The scroll offset along the y-axis. * * @sa glfwSetScrollCallback * * @ingroup input */ typedef void (* GLFWscrollfun)(GLFWwindow*,double,double); /*! @brief The function signature for keyboard key callbacks. * * This is the function signature for keyboard key callback functions. * * @param[in] window The window that received the event. * @param[in] key The [keyboard key](@ref keys) that was pressed or released. * @param[in] action @ref GLFW_PRESS, @ref GLFW_RELEASE or @ref GLFW_REPEAT. * @param[in] mods Bit field describing which [modifier keys](@ref mods) were * held down. * * @sa glfwSetKeyCallback * * @ingroup input */ typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int); /*! @brief The function signature for Unicode character callbacks. * * This is the function signature for Unicode character callback functions. * * @param[in] window The window that received the event. * @param[in] character The Unicode code point of the character. * * @sa glfwSetCharCallback * * @ingroup input */ typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int); /*! @brief The function signature for monitor configuration callbacks. * * This is the function signature for monitor configuration callback functions. * * @param[in] monitor The monitor that was connected or disconnected. * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. * * @sa glfwSetMonitorCallback * * @ingroup monitor */ typedef void (* GLFWmonitorfun)(GLFWmonitor*,int); /*! @brief Video mode type. * * This describes a single video mode. * * @ingroup monitor */ typedef struct { /*! The width, in pixels, of the video mode. */ int width; /*! The height, in pixels, of the video mode. */ int height; /*! The bit depth of the red channel of the video mode. */ int redBits; /*! The bit depth of the green channel of the video mode. */ int greenBits; /*! The bit depth of the blue channel of the video mode. */ int blueBits; } GLFWvidmode; /*! @brief Gamma ramp. * * This describes the gamma ramp for a monitor. * * @sa glfwGetGammaRamp glfwSetGammaRamp * * @ingroup gamma */ typedef struct { /*! An array of value describing the response of the red channel. */ unsigned short* red; /*! An array of value describing the response of the green channel. */ unsigned short* green; /*! An array of value describing the response of the blue channel. */ unsigned short* blue; /*! The number of elements in each array. */ unsigned int size; } GLFWgammaramp; /************************************************************************* * GLFW API functions *************************************************************************/ /*! @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 * 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. * * Additional calls to this function after successful initialization but before * termination will succeed but will do nothing. * * @return `GL_TRUE` if successful, or `GL_FALSE` if an error 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 This function may take several seconds to complete on some systems, * while on other systems it may take only a fraction of a second to complete. * * @note **Mac OS X:** This function will change the current directory of the * application to the `Contents/Resources` subdirectory of the application's * bundle, if present. * * @sa glfwTerminate * * @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. * * 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. * * @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. * * @sa glfwInit * * @ingroup init */ GLFWAPI void glfwTerminate(void); /*! @brief Retrieves the version of the GLFW library. * * This function retrieves the major, minor and revision numbers of the GLFW * 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. * * @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. * * @sa glfwGetVersionString * * @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. * * 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 * * 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 * * @return The GLFW version string. * * @remarks This function may be called before @ref glfwInit. * * @remarks This function may be called from any thread. * * @sa glfwGetVersion * * @ingroup init */ GLFWAPI const char* glfwGetVersionString(void); /*! @brief Sets the error callback. * * This function sets the error callback, which is called with an error code * and a human-readable description each time a GLFW error occurs. * * @param[in] cbfun The new callback, or `NULL` to remove the currently set * callback. * * @return The previously set callback, or `NULL` if an error occurred. * * @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. * * @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. * * @ingroup error */ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun cbfun); /*! @brief Returns the currently connected monitors. * * This function returns an array of handles for all currently connected * monitors. * * @param[out] count The size of the returned array, or zero if an error * occurred. * @return An array of monitor handles, or `NULL` if an error occurred. * * @note The returned array is valid only until the monitor configuration * changes. See @ref glfwSetMonitorCallback to receive notifications of * configuration changes. * * @sa glfwGetPrimaryMonitor * * @ingroup monitor */ GLFWAPI GLFWmonitor** glfwGetMonitors(int* count); /*! @brief Returns the primary monitor. * * 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. * * @sa glfwGetMonitors * * @ingroup monitor */ GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void); /*! @brief Returns the position of the monitor's viewport on the virtual screen. * * This function returns the position, in screen coordinates, of the upper-left * corner of the specified monitor. * * @param[in] monitor The monitor to query. * @param[out] xpos The monitor x-coordinate. * @param[out] ypos The monitor y-coordinate. * * @ingroup monitor */ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos); /*! @brief Returns the physical size of the monitor. * * 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 The width, in mm, of the monitor's display * @param[out] height The height, in mm, of the monitor's display. * * @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. * * @ingroup monitor */ GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* width, int* height); /*! @brief Returns the name of the specified monitor. * * This function returns a human-readable name, encoded as UTF-8, of the * specified monitor. * * @param[in] monitor The monitor to query. * @return The UTF-8 encoded name of the monitor, or `NULL` if an error * occurred. * * @ingroup monitor */ GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor); /*! @brief Sets the monitor configuration callback. * * This function sets the monitor configuration callback, or removes the * currently set callback. This is called when a monitor is connected to or * disconnected from the system. * * @param[in] cbfun The new callback, or `NULL` to remove the currently set * callback. * @return The previously set callback, or `NULL` if an error occurred. * * @bug This callback is not yet called on monitor configuration changes. * * @ingroup monitor */ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun cbfun); /*! @brief Returns the available video modes for the specified monitor. * * This function returns an array of all video modes supported by the specified * monitor. The returned array is sorted in ascending order, first by color * bit depth (the sum of all channel depths) and then by resolution area (the * product of width and height). * * @param[in] monitor The monitor to query. * @param[out] count The number of video modes in the returned array, or zero * if an error occurred. * @return An array of video modes, or `NULL` if an error occurred. * * @note The returned array is valid only until this function is called again * for the specified monitor. * * @sa glfwGetVideoMode * * @ingroup monitor */ 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. * * @param[in] monitor The monitor to query. * @return The current mode of the monitor, or `NULL` if an error occurred. * * @sa glfwGetVideoModes * * @ingroup monitor */ 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 glfwSetGamma with it. * * @param[in] monitor The monitor whose gamma ramp to set. * @param[in] gamma The desired exponent. * * @ingroup gamma */ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma); /*! @brief Retrieves the current gamma ramp for the specified monitor. * * This function retrieves the current gamma ramp of the specified monitor. * * @param[in] monitor The monitor to query. * @return The current gamma ramp. * * @ingroup gamma */ 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. * * @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. * * @ingroup gamma */ GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp); /*! @brief Resets all window hints to their default values. * * 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. * * @sa glfwWindowHint * * @ingroup window */ GLFWAPI void glfwDefaultWindowHints(void); /*! @brief Sets the specified window hint to the desired value. * * 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. * * @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. * * @sa glfwDefaultWindowHints * * @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. * * 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. * * Note that the created window 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 * glfwGetWindowAttrib and @ref glfwGetWindowSize. * * @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. * This must be greater than zero. * @param[in] title The initial, UTF-8 encoded window title. * @param[in] monitor The monitor to use for full screen mode, or `NULL` to use * 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. * * @remarks 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. * * @remarks If a fullscreen window is active, the screensaver is prohibited * from starting. * * @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 **Mac 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. * * @note This function may only be called from the main thread. * * @sa glfwDestroyWindow * * @ingroup window */ GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share); /*! @brief Destroys the specified window and its context. * * 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 * detached before being destroyed. * * @warning The window's context must not be current on any other thread. * * @sa glfwCreateWindow * * @ingroup window */ GLFWAPI void glfwDestroyWindow(GLFWwindow* window); /*! @brief Checks the close flag of the specified window. * * This function returns the value of the close flag of the specified window. * * @param[in] window The window to query. * @return The value of the close flag. * * @ingroup window */ GLFWAPI int glfwWindowShouldClose(GLFWwindow* window); /*! @brief Sets the close flag of the specified window. * * This function sets the value of the close flag of the specified window. * This can be used to override the user's attempt to close the window, or * to signal that it should be closed. * * @param[in] window The window whose flag to change. * @param[in] value The new value. * * @ingroup window */ GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value); /*! @brief Sets the title of the specified window. * * This function sets the window title, encoded as UTF-8, of the specified * window. * * @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. * * @ingroup window */ GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title); /*! @brief Retrieves the position of the client area of the specified window. * * This function retrieves the position, in screen coordinates, of the * upper-left corner of the client area of the specified window. * * @param[in] window The window to query. * @param[out] xpos The x-coordinate of the upper-left corner of the client area. * @param[out] ypos The y-coordinate of the upper-left corner of the client area. * * @remarks Either or both coordinate arguments may be `NULL`. * * @sa glfwSetWindowPos * * @ingroup window */ 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. * * If it is a full screen window, this function does nothing. * * @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. * * @remarks 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. * * @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. * * @bug **X11:** Some window managers ignore the set position of hidden (i.e. * unmapped) windows, instead placing them where it thinks is appropriate once * they are shown. * * @sa glfwGetWindowPos * * @ingroup window */ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos); /*! @brief Retrieves the size of the client area of the specified window. * * This function retrieves the size, in screen coordinates, of the client area * of the specified window. * * @param[in] window The window whose size to retrieve. * @param[out] width The width of the client area. * @param[out] height The height of the client area. * * @sa glfwSetWindowSize * * @ingroup window */ GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height); /*! @brief Sets the size of the client area of the specified window. * * This function sets the size, in screen coordinates, of the client area of * the specified window. * * For full screen windows, this function selects and switches to the resolution * closest to the specified size, without affecting the window's context. As * the context is unaffected, the bit depths of the framebuffer remain * unchanged. * * @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. * * @sa glfwGetWindowSize * * @ingroup window */ GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height); /*! @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. * * @param[in] window The window to iconify. * * @note This function may only be called from the main thread. * * @sa glfwRestoreWindow * * @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. * * @param[in] window The window to restore. * * @note This function may only be called from the main thread. * * @sa glfwIconifyWindow * * @ingroup window */ GLFWAPI void glfwRestoreWindow(GLFWwindow* window); /*! @brief Makes the specified window visible. * * 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. * * @sa glfwHideWindow * * @ingroup window */ GLFWAPI void glfwShowWindow(GLFWwindow* window); /*! @brief Hides the specified window. * * 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. * * @sa glfwShowWindow * * @ingroup window */ GLFWAPI void glfwHideWindow(GLFWwindow* window); /*! @brief Returns the monitor that the window uses for full screen mode. * * This function returns the handle of the monitor that the specified window is * in full screen on. * * @param[in] window The window to query. * @return The monitor, or `NULL` if the window is in windowed mode. * * @ingroup window */ 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. * * @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. * * @ingroup window */ GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib); /*! @brief Sets the user pointer of the specified window. * * This function sets the user-defined pointer of the specified window. The * current value is retained until the window is destroyed. The initial value * is `NULL`. * * @param[in] window The window whose pointer to set. * @param[in] pointer The new value. * * @sa glfwGetWindowUserPointer * * @ingroup window */ GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer); /*! @brief Returns the user pointer of the specified window. * * This function returns the current value of the user-defined pointer of the * specified window. The initial value is `NULL`. * * @param[in] window The window whose pointer to return. * * @sa glfwSetWindowUserPointer * * @ingroup window */ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window); /*! @brief Sets the position callback for the specified window. * * This function sets the position callback of the specified window, which is * called when the window is moved. The callback is provided with the screen * position of the upper-left corner of the client area of the 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 an error occurred. * * @ingroup window */ GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun cbfun); /*! @brief Sets the size callback for the specified window. * * This function sets the size callback of the specified window, which is * called when the window is resized. The callback is provided with the size, * in screen coordinates, of the client area of the 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 an error occurred. * * @ingroup window */ GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun cbfun); /*! @brief Sets the close callback for the specified window. * * This function sets the close callback of the specified window, which is * called when the user attempts to close the window, for example by clicking * the close widget in the title bar. * * The close flag is set before this callback is called, but you can modify it * at any time with @ref glfwSetWindowShouldClose. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new callback, or `NULL` to remove the currently set * callback. * * @remarks Calling @ref glfwDestroyWindow does not cause this callback to be * called. * * @return The previously set callback, or `NULL` if an error occurred. * * @remarks **Mac OS X:** Selecting Quit from the application menu will * trigger the close callback for all windows. * * @ingroup window */ GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun cbfun); /*! @brief Sets the refresh callback for the specified window. * * This function sets the refresh callback of the specified window, which is * called when the client area of the window needs to be redrawn, for example * if the window has been exposed after having been covered by another window. * * 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. * * @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 an error occurred. * * @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. * * @ingroup window */ GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun cbfun); /*! @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. * * 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. * * @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 an error occurred. * * @ingroup window */ GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun cbfun); /*! @brief Sets the iconify callback for the specified window. * * This function sets the iconification callback of the specified window, which * is called when the window is iconified or restored. * * @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 an error occurred. * * @ingroup window */ GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun cbfun); /*! @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. * * @par New in GLFW 3 * This function is no longer called by @ref glfwSwapBuffers. You need to call * it or @ref glfwWaitEvents yourself. * * @remarks This function is not required for joystick input to work. * * @note This function may only be called from the main thread. * * @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. * * @sa glfwWaitEvents * * @ingroup window */ GLFWAPI void glfwPollEvents(void); /*! @brief Waits until events are pending 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 recevied, 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. * * 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. * * @remarks This function is not required for joystick input to work. * * @note This function may only be called from the main thread. * * @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. * * @sa glfwPollEvents * * @ingroup window */ GLFWAPI void glfwWaitEvents(void); /*! @brief Returns the value of an input option for the specified window. * * @param[in] window The window to query. * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS` or * `GLFW_STICKY_MOUSE_BUTTONS`. * * @sa glfwSetInputMode * * @ingroup input */ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode); /*! @brief Sets an input option for the specified window. * @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. * - `GLFW_CURSOR_DISABLED` disables the cursor and removes any limitations on * cursor movement. * * 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. * * 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. * * @sa glfwGetInputMode * * @ingroup input */ GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value); /*! @brief Returns the last reported state of a keyboard key for the specified * window. * * 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 * 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. * * 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. * * @param[in] window The desired window. * @param[in] key The desired [keyboard key](@ref keys). * @return One of `GLFW_PRESS` or `GLFW_RELEASE`. * * @ingroup input */ GLFWAPI int glfwGetKey(GLFWwindow* window, int key); /*! @brief Returns the last reported state of a mouse button for the specified * window. * * This function returns the last state reported for the specified mouse button * to the specified window. * * 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. * * @param[in] window The desired window. * @param[in] button The desired [mouse button](@ref buttons). * @return One of `GLFW_PRESS` or `GLFW_RELEASE`. * * @ingroup input */ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button); /*! @brief Retrieves the last reported cursor position, relative to the client * area of the window. * * This function returns the last reported position of the cursor to 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 * a `double`. * * The coordinate can be converted to their integer equivalents with the * `floor` function. Casting directly to an integer type works for positive * coordinates, but fails for negative ones. * * @param[in] window The desired window. * @param[out] xpos The cursor x-coordinate, relative to the left edge of the * client area, or `NULL`. * @param[out] ypos The cursor y-coordinate, relative to the to top edge of the * client area, or `NULL`. * * @sa glfwSetCursorPos * * @ingroup input */ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos); /*! @brief Sets the position of the cursor, relative to the client area of the window. * * This function sets the position of the cursor. The specified window must be * focused. If the window does not have 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 * a `double`. * * @param[in] window The desired window. * @param[in] xpos The desired x-coordinate, relative to the left edge of the * client area, or `NULL`. * @param[in] ypos The desired y-coordinate, relative to the top edge of the * client area, or `NULL`. * * @sa glfwGetCursorPos * * @ingroup input */ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos); /*! @brief Sets the key callback. * * This function sets the key callback of the specific window, which is called * when a key is pressed, repeated or released. * * The key functions deal with physical keys, with layout independent * [key tokens](@ref keys) named after their values in the standard US keyboard * 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. * * @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 an error occurred. * * @ingroup input */ 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 * 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 * [key callback](@ref glfwSetKeyCallback) instead. * * @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 an error occurred. * * @ingroup input */ GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun 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. * * @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 an error occurred. * * @ingroup input */ GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun cbfun); /*! @brief Sets the cursor position callback. * * This function sets the cursor position callback of the specified window, * which is called when the cursor is moved. The callback is provided with the * position relative to the upper-left corner of the client area of the 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 an error occurred. * * @ingroup input */ GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun cbfun); /*! @brief Sets the cursor enter/exit callback. * * This function sets the cursor boundary crossing callback of the specified * window, which is called when the cursor enters or leaves the client area of * the 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 an error occurred. * * @ingroup input */ GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun cbfun); /*! @brief Sets the scroll callback. * * This function sets the scroll callback of the specified window, which is * called when a scrolling device is used, such as a mouse wheel or scrolling * area of a touchpad. * * @param[in] window The window whose callback to set. * @param[in] cbfun The new scroll callback, or `NULL` to remove the currently * set callback. * * @remarks This receives all scrolling input, like that from a mouse wheel or * a touchpad scrolling area. * * @return The previously set callback, or `NULL` if an error occurred. * * @ingroup input */ GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun 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. * @return `GL_TRUE` if the joystick is present, or `GL_FALSE` otherwise. * * @ingroup input */ GLFWAPI int glfwJoystickPresent(int joy); /*! @brief Returns the values of all axes of the specified joystick. * @param[in] joy The joystick to query. * @param[out] count The size of the returned array. * @return An array of axis values, or @c NULL if the joystick is not present. * * @note The returned array is valid only until the next call to @ref * glfwGetJoystickAxes for that joystick. * * @ingroup input */ GLFWAPI float* glfwGetJoystickAxes(int joy, int* count); /*! @brief Returns the values of all buttons of the specified joystick. * @param[in] joy The joystick to query. * @param[out] count The size of the returned array. * @return An array of axis values, or @c NULL if the joystick is not present. * * @note The returned array is valid only until the next call to @ref * glfwGetJoystickButtons for that joystick. * * @ingroup input */ GLFWAPI 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. * * @param[in] joy The joystick to query. * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick * is not present. * * @note The returned string is valid only until the next call to @ref * glfwGetJoystickName for that joystick. * * @ingroup input */ 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. * * @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. * * @sa glfwGetClipboardString * * @ingroup clipboard */ GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string); /*! @brief Retrieves 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. * * @note This function may only be called from the main thread. * * @note The returned string is valid only until the next call to @ref * glfwGetClipboardString or @ref glfwSetClipboardString. * * @sa glfwSetClipboardString * * @ingroup clipboard */ GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window); /*! @brief Returns the value of the GLFW timer. * * This function returns the value of the GLFW timer. Unless the timer has * 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. * * @remarks This function may be called from secondary threads. * * @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. * * @ingroup time */ 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. * * @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. * * @ingroup time */ 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. * * @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. * * @sa glfwGetCurrentContext * * @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. * * @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. * * @sa glfwMakeContextCurrent * * @ingroup context */ GLFWAPI GLFWwindow* glfwGetCurrentContext(void); /*! @brief Swaps the front and back buffers of the specified window. * * This function swaps the front and back buffers of the specified window. If * the swap interval is greater than zero, the GPU driver waits the specified * number of screen updates before swapping the buffers. * * @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. * * @sa glfwSwapInterval * * @ingroup context */ 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'. * * @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. * * @remarks Contexts that support either of the `WGL_EXT_swap_control_tear` and * `GLX_EXT_swap_control_tear` extensions also accept negative swap intervals, * which allow the driver to swap even if a frame arrives a little bit late. * You can check for the presence of these extensions using @ref * glfwExtensionSupported. For more information about swap tearing, see the * extension specifications. * * @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. * * @sa glfwSwapBuffers * * @ingroup context */ 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. * * @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. * * @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. * * @ingroup context */ GLFWAPI int glfwExtensionSupported(const char* extension); /*! @brief Returns the address of the specified function for the current * context. * * This function returns the address of the specified * [client API or extension function](@ref context_glext), if it is supported * by the current context. * * @param[in] procname The ASCII encoded name of the function. * @return The address of the function, or `NULL` if the function is * unavailable. * * @remarks This function may be called from secondary threads. * * @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. * * @ingroup context */ GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname); /************************************************************************* * Global definition cleanup *************************************************************************/ /* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */ #ifdef GLFW_WINGDIAPI_DEFINED #undef WINGDIAPI #undef GLFW_WINGDIAPI_DEFINED #endif #ifdef GLFW_CALLBACK_DEFINED #undef CALLBACK #undef GLFW_CALLBACK_DEFINED #endif /* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */ #ifdef __cplusplus } #endif #endif /* _glfw3_h_ */