| ▼ glfw-3.3.8 | |
| docs | |
| ▼ include | |
| ▼ GLFW | |
| glfw3.h | The header of the GLFW 3 API |
| glfw3native.h | The header of the native access functions |
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/folderclosed.png b/deps/glfw-3.3.8/docs/html/folderclosed.png new file mode 100644 index 0000000..bb8ab35 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/folderclosed.png differ diff --git a/deps/glfw-3.3.8/docs/html/folderopen.png b/deps/glfw-3.3.8/docs/html/folderopen.png new file mode 100644 index 0000000..d6c7f67 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/folderopen.png differ diff --git a/deps/glfw-3.3.8/docs/html/glfw3_8h.html b/deps/glfw-3.3.8/docs/html/glfw3_8h.html new file mode 100644 index 0000000..b01a690 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3_8h.html @@ -0,0 +1,1619 @@ + + + + + + + +Description
+This is the header file of the GLFW 3 API. It defines all its types and declares all its functions.
+For more information about how to use this file, see Including the GLFW header file.
+Go to the source code of this file.
++Macros | |
| #define | GLFW_APIENTRY_DEFINED |
| #define | GLFW_TRUE 1 |
| One. More... | |
| #define | GLFW_FALSE 0 |
| Zero. More... | |
| #define | GLFW_HAT_CENTERED 0 |
| #define | GLFW_HAT_UP 1 |
| #define | GLFW_HAT_RIGHT 2 |
| #define | GLFW_HAT_DOWN 4 |
| #define | GLFW_HAT_LEFT 8 |
| #define | GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP) |
| #define | GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN) |
| #define | GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP) |
| #define | GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN) |
| #define | GLFW_KEY_UNKNOWN -1 |
| #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 */ |
| #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 |
| #define | GLFW_MOD_SHIFT 0x0001 |
| If this bit is set one or more Shift keys were held down. More... | |
| #define | GLFW_MOD_CONTROL 0x0002 |
| If this bit is set one or more Control keys were held down. More... | |
| #define | GLFW_MOD_ALT 0x0004 |
| If this bit is set one or more Alt keys were held down. More... | |
| #define | GLFW_MOD_SUPER 0x0008 |
| If this bit is set one or more Super keys were held down. More... | |
| #define | GLFW_MOD_CAPS_LOCK 0x0010 |
| If this bit is set the Caps Lock key is enabled. More... | |
| #define | GLFW_MOD_NUM_LOCK 0x0020 |
| If this bit is set the Num Lock key is enabled. More... | |
| #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 |
| #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 |
| #define | GLFW_GAMEPAD_BUTTON_A 0 |
| #define | GLFW_GAMEPAD_BUTTON_B 1 |
| #define | GLFW_GAMEPAD_BUTTON_X 2 |
| #define | GLFW_GAMEPAD_BUTTON_Y 3 |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5 |
| #define | GLFW_GAMEPAD_BUTTON_BACK 6 |
| #define | GLFW_GAMEPAD_BUTTON_START 7 |
| #define | GLFW_GAMEPAD_BUTTON_GUIDE 8 |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_UP 11 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14 |
| #define | GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT |
| #define | GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A |
| #define | GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B |
| #define | GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X |
| #define | GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y |
| #define | GLFW_GAMEPAD_AXIS_LEFT_X 0 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_Y 1 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_X 2 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_Y 3 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5 |
| #define | GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER |
| #define | GLFW_NO_ERROR 0 |
| No error has occurred. More... | |
| #define | GLFW_NOT_INITIALIZED 0x00010001 |
| GLFW has not been initialized. More... | |
| #define | GLFW_NO_CURRENT_CONTEXT 0x00010002 |
| No context is current for this thread. More... | |
| #define | GLFW_INVALID_ENUM 0x00010003 |
| One of the arguments to the function was an invalid enum value. More... | |
| #define | GLFW_INVALID_VALUE 0x00010004 |
| One of the arguments to the function was an invalid value. More... | |
| #define | GLFW_OUT_OF_MEMORY 0x00010005 |
| A memory allocation failed. More... | |
| #define | GLFW_API_UNAVAILABLE 0x00010006 |
| GLFW could not find support for the requested API on the system. More... | |
| #define | GLFW_VERSION_UNAVAILABLE 0x00010007 |
| The requested OpenGL or OpenGL ES version is not available. More... | |
| #define | GLFW_PLATFORM_ERROR 0x00010008 |
| A platform-specific error occurred that does not match any of the more specific categories. More... | |
| #define | GLFW_FORMAT_UNAVAILABLE 0x00010009 |
| The requested format is not supported or available. More... | |
| #define | GLFW_NO_WINDOW_CONTEXT 0x0001000A |
| The specified window does not have an OpenGL or OpenGL ES context. More... | |
| #define | GLFW_FOCUSED 0x00020001 |
| Input focus window hint and attribute. More... | |
| #define | GLFW_ICONIFIED 0x00020002 |
| Window iconification window attribute. More... | |
| #define | GLFW_RESIZABLE 0x00020003 |
| Window resize-ability window hint and attribute. More... | |
| #define | GLFW_VISIBLE 0x00020004 |
| Window visibility window hint and attribute. More... | |
| #define | GLFW_DECORATED 0x00020005 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_AUTO_ICONIFY 0x00020006 |
| Window auto-iconification window hint and attribute. More... | |
| #define | GLFW_FLOATING 0x00020007 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_MAXIMIZED 0x00020008 |
| Window maximization window hint and attribute. More... | |
| #define | GLFW_CENTER_CURSOR 0x00020009 |
| Cursor centering window hint. More... | |
| #define | GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A |
| Window framebuffer transparency hint and attribute. More... | |
| #define | GLFW_HOVERED 0x0002000B |
| Mouse cursor hover window attribute. More... | |
| #define | GLFW_FOCUS_ON_SHOW 0x0002000C |
| Input focus on calling show window hint and attribute. More... | |
| #define | GLFW_RED_BITS 0x00021001 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_GREEN_BITS 0x00021002 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_BLUE_BITS 0x00021003 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ALPHA_BITS 0x00021004 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_DEPTH_BITS 0x00021005 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_STENCIL_BITS 0x00021006 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_RED_BITS 0x00021007 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_GREEN_BITS 0x00021008 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_BLUE_BITS 0x00021009 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_ALPHA_BITS 0x0002100A |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_AUX_BUFFERS 0x0002100B |
| Framebuffer auxiliary buffer hint. More... | |
| #define | GLFW_STEREO 0x0002100C |
| OpenGL stereoscopic rendering hint. More... | |
| #define | GLFW_SAMPLES 0x0002100D |
| Framebuffer MSAA samples hint. More... | |
| #define | GLFW_SRGB_CAPABLE 0x0002100E |
| Framebuffer sRGB hint. More... | |
| #define | GLFW_REFRESH_RATE 0x0002100F |
| Monitor refresh rate hint. More... | |
| #define | GLFW_DOUBLEBUFFER 0x00021010 |
| Framebuffer double buffering hint. More... | |
| #define | GLFW_CLIENT_API 0x00022001 |
| Context client API hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MAJOR 0x00022002 |
| Context client API major version hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MINOR 0x00022003 |
| Context client API minor version hint and attribute. More... | |
| #define | GLFW_CONTEXT_REVISION 0x00022004 |
| Context client API revision number attribute. More... | |
| #define | GLFW_CONTEXT_ROBUSTNESS 0x00022005 |
| Context robustness hint and attribute. More... | |
| #define | GLFW_OPENGL_FORWARD_COMPAT 0x00022006 |
| OpenGL forward-compatibility hint and attribute. More... | |
| #define | GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 |
| Debug mode context hint and attribute. More... | |
| #define | GLFW_OPENGL_PROFILE 0x00022008 |
| OpenGL profile hint and attribute. More... | |
| #define | GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 |
| Context flush-on-release hint and attribute. More... | |
| #define | GLFW_CONTEXT_NO_ERROR 0x0002200A |
| Context error suppression hint and attribute. More... | |
| #define | GLFW_CONTEXT_CREATION_API 0x0002200B |
| Context creation API hint and attribute. More... | |
| #define | GLFW_SCALE_TO_MONITOR 0x0002200C |
| Window content area scaling window window hint. More... | |
| #define | GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001 |
| macOS specific window hint. More... | |
| #define | GLFW_COCOA_FRAME_NAME 0x00023002 |
| macOS specific window hint. More... | |
| #define | GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003 |
| macOS specific window hint. More... | |
| #define | GLFW_X11_CLASS_NAME 0x00024001 |
| X11 specific window hint. More... | |
| #define | GLFW_X11_INSTANCE_NAME 0x00024002 |
| X11 specific window hint. More... | |
| #define | GLFW_NO_API 0 |
| #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_ANY_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_LOCK_KEY_MODS 0x00033004 |
| #define | GLFW_RAW_MOUSE_MOTION 0x00033005 |
| #define | GLFW_CURSOR_NORMAL 0x00034001 |
| #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 |
| #define | GLFW_NATIVE_CONTEXT_API 0x00036001 |
| #define | GLFW_EGL_CONTEXT_API 0x00036002 |
| #define | GLFW_OSMESA_CONTEXT_API 0x00036003 |
| #define | GLFW_ARROW_CURSOR 0x00036001 |
| The regular arrow cursor shape. More... | |
| #define | GLFW_IBEAM_CURSOR 0x00036002 |
| The text input I-beam cursor shape. More... | |
| #define | GLFW_CROSSHAIR_CURSOR 0x00036003 |
| The crosshair shape. More... | |
| #define | GLFW_HAND_CURSOR 0x00036004 |
| The hand shape. More... | |
| #define | GLFW_HRESIZE_CURSOR 0x00036005 |
| The horizontal resize arrow shape. More... | |
| #define | GLFW_VRESIZE_CURSOR 0x00036006 |
| The vertical resize arrow shape. More... | |
| #define | GLFW_CONNECTED 0x00040001 |
| #define | GLFW_DISCONNECTED 0x00040002 |
| #define | GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 |
| Joystick hat buttons init hint. More... | |
| #define | GLFW_COCOA_CHDIR_RESOURCES 0x00051001 |
| macOS specific init hint. More... | |
| #define | GLFW_COCOA_MENUBAR 0x00051002 |
| macOS specific init hint. More... | |
| #define | GLFW_DONT_CARE -1 |
| #define | GLAPIENTRY APIENTRY |
| #define | GLFW_GLAPIENTRY_DEFINED |
GLFW version macros | |
| #define | GLFW_VERSION_MAJOR 3 |
| The major version number of the GLFW header. More... | |
| #define | GLFW_VERSION_MINOR 3 |
| The minor version number of the GLFW header. More... | |
| #define | GLFW_VERSION_REVISION 8 |
| The revision number of the GLFW header. More... | |
Key and button actions | |
| #define | GLFW_RELEASE 0 |
| The key or mouse button was released. More... | |
| #define | GLFW_PRESS 1 |
| The key or mouse button was pressed. More... | |
| #define | GLFW_REPEAT 2 |
| The key was held down until it repeated. More... | |
+Typedefs | |
| typedef void(* | GLFWglproc) (void) |
| Client API function pointer type. More... | |
| typedef void(* | GLFWvkproc) (void) |
| Vulkan API function pointer type. More... | |
| typedef struct GLFWmonitor | GLFWmonitor |
| Opaque monitor object. More... | |
| typedef struct GLFWwindow | GLFWwindow |
| Opaque window object. More... | |
| typedef struct GLFWcursor | GLFWcursor |
| Opaque cursor object. More... | |
| typedef void(* | GLFWerrorfun) (int error_code, const char *description) |
| The function pointer type for error callbacks. More... | |
| typedef void(* | GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos) |
| The function pointer type for window position callbacks. More... | |
| typedef void(* | GLFWwindowsizefun) (GLFWwindow *window, int width, int height) |
| The function pointer type for window size callbacks. More... | |
| typedef void(* | GLFWwindowclosefun) (GLFWwindow *window) |
| The function pointer type for window close callbacks. More... | |
| typedef void(* | GLFWwindowrefreshfun) (GLFWwindow *window) |
| The function pointer type for window content refresh callbacks. More... | |
| typedef void(* | GLFWwindowfocusfun) (GLFWwindow *window, int focused) |
| The function pointer type for window focus callbacks. More... | |
| typedef void(* | GLFWwindowiconifyfun) (GLFWwindow *window, int iconified) |
| The function pointer type for window iconify callbacks. More... | |
| typedef void(* | GLFWwindowmaximizefun) (GLFWwindow *window, int maximized) |
| The function pointer type for window maximize callbacks. More... | |
| typedef void(* | GLFWframebuffersizefun) (GLFWwindow *window, int width, int height) |
| The function pointer type for framebuffer size callbacks. More... | |
| typedef void(* | GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale) |
| The function pointer type for window content scale callbacks. More... | |
| typedef void(* | GLFWmousebuttonfun) (GLFWwindow *window, int button, int action, int mods) |
| The function pointer type for mouse button callbacks. More... | |
| typedef void(* | GLFWcursorposfun) (GLFWwindow *window, double xpos, double ypos) |
| The function pointer type for cursor position callbacks. More... | |
| typedef void(* | GLFWcursorenterfun) (GLFWwindow *window, int entered) |
| The function pointer type for cursor enter/leave callbacks. More... | |
| typedef void(* | GLFWscrollfun) (GLFWwindow *window, double xoffset, double yoffset) |
| The function pointer type for scroll callbacks. More... | |
| typedef void(* | GLFWkeyfun) (GLFWwindow *window, int key, int scancode, int action, int mods) |
| The function pointer type for keyboard key callbacks. More... | |
| typedef void(* | GLFWcharfun) (GLFWwindow *window, unsigned int codepoint) |
| The function pointer type for Unicode character callbacks. More... | |
| typedef void(* | GLFWcharmodsfun) (GLFWwindow *window, unsigned int codepoint, int mods) |
| The function pointer type for Unicode character with modifiers callbacks. More... | |
| typedef void(* | GLFWdropfun) (GLFWwindow *window, int path_count, const char *paths[]) |
| The function pointer type for path drop callbacks. More... | |
| typedef void(* | GLFWmonitorfun) (GLFWmonitor *monitor, int event) |
| The function pointer type for monitor configuration callbacks. More... | |
| typedef void(* | GLFWjoystickfun) (int jid, int event) |
| The function pointer type for joystick configuration callbacks. More... | |
| typedef struct GLFWvidmode | GLFWvidmode |
| Video mode type. More... | |
| typedef struct GLFWgammaramp | GLFWgammaramp |
| Gamma ramp. More... | |
| typedef struct GLFWimage | GLFWimage |
| Image data. More... | |
| typedef struct GLFWgamepadstate | GLFWgamepadstate |
| Gamepad input state. More... | |
+Functions | |
| int | glfwInit (void) |
| Initializes the GLFW library. More... | |
| void | glfwTerminate (void) |
| Terminates the GLFW library. More... | |
| void | glfwInitHint (int hint, int value) |
| Sets the specified init hint to the desired value. More... | |
| void | glfwGetVersion (int *major, int *minor, int *rev) |
| Retrieves the version of the GLFW library. More... | |
| const char * | glfwGetVersionString (void) |
| Returns a string describing the compile-time configuration. More... | |
| int | glfwGetError (const char **description) |
| Returns and clears the last error for the calling thread. More... | |
| GLFWerrorfun | glfwSetErrorCallback (GLFWerrorfun callback) |
| Sets the error callback. More... | |
| GLFWmonitor ** | glfwGetMonitors (int *count) |
| Returns the currently connected monitors. More... | |
| GLFWmonitor * | glfwGetPrimaryMonitor (void) |
| Returns the primary monitor. More... | |
| void | glfwGetMonitorPos (GLFWmonitor *monitor, int *xpos, int *ypos) |
| Returns the position of the monitor's viewport on the virtual screen. More... | |
| void | glfwGetMonitorWorkarea (GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height) |
| Retrieves the work area of the monitor. More... | |
| void | glfwGetMonitorPhysicalSize (GLFWmonitor *monitor, int *widthMM, int *heightMM) |
| Returns the physical size of the monitor. More... | |
| void | glfwGetMonitorContentScale (GLFWmonitor *monitor, float *xscale, float *yscale) |
| Retrieves the content scale for the specified monitor. More... | |
| const char * | glfwGetMonitorName (GLFWmonitor *monitor) |
| Returns the name of the specified monitor. More... | |
| void | glfwSetMonitorUserPointer (GLFWmonitor *monitor, void *pointer) |
| Sets the user pointer of the specified monitor. More... | |
| void * | glfwGetMonitorUserPointer (GLFWmonitor *monitor) |
| Returns the user pointer of the specified monitor. More... | |
| GLFWmonitorfun | glfwSetMonitorCallback (GLFWmonitorfun callback) |
| Sets the monitor configuration callback. More... | |
| const GLFWvidmode * | glfwGetVideoModes (GLFWmonitor *monitor, int *count) |
| Returns the available video modes for the specified monitor. More... | |
| const GLFWvidmode * | glfwGetVideoMode (GLFWmonitor *monitor) |
| Returns the current mode of the specified monitor. More... | |
| void | glfwSetGamma (GLFWmonitor *monitor, float gamma) |
| Generates a gamma ramp and sets it for the specified monitor. More... | |
| const GLFWgammaramp * | glfwGetGammaRamp (GLFWmonitor *monitor) |
| Returns the current gamma ramp for the specified monitor. More... | |
| void | glfwSetGammaRamp (GLFWmonitor *monitor, const GLFWgammaramp *ramp) |
| Sets the current gamma ramp for the specified monitor. More... | |
| void | glfwDefaultWindowHints (void) |
| Resets all window hints to their default values. More... | |
| void | glfwWindowHint (int hint, int value) |
| Sets the specified window hint to the desired value. More... | |
| void | glfwWindowHintString (int hint, const char *value) |
| Sets the specified window hint to the desired value. More... | |
| GLFWwindow * | glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share) |
| Creates a window and its associated context. More... | |
| void | glfwDestroyWindow (GLFWwindow *window) |
| Destroys the specified window and its context. More... | |
| int | glfwWindowShouldClose (GLFWwindow *window) |
| Checks the close flag of the specified window. More... | |
| void | glfwSetWindowShouldClose (GLFWwindow *window, int value) |
| Sets the close flag of the specified window. More... | |
| void | glfwSetWindowTitle (GLFWwindow *window, const char *title) |
| Sets the title of the specified window. More... | |
| void | glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images) |
| Sets the icon for the specified window. More... | |
| void | glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos) |
| Retrieves the position of the content area of the specified window. More... | |
| void | glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos) |
| Sets the position of the content area of the specified window. More... | |
| void | glfwGetWindowSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the content area of the specified window. More... | |
| void | glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight) |
| Sets the size limits of the specified window. More... | |
| void | glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom) |
| Sets the aspect ratio of the specified window. More... | |
| void | glfwSetWindowSize (GLFWwindow *window, int width, int height) |
| Sets the size of the content area of the specified window. More... | |
| void | glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the framebuffer of the specified window. More... | |
| void | glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom) |
| Retrieves the size of the frame of the window. More... | |
| void | glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale) |
| Retrieves the content scale for the specified window. More... | |
| float | glfwGetWindowOpacity (GLFWwindow *window) |
| Returns the opacity of the whole window. More... | |
| void | glfwSetWindowOpacity (GLFWwindow *window, float opacity) |
| Sets the opacity of the whole window. More... | |
| void | glfwIconifyWindow (GLFWwindow *window) |
| Iconifies the specified window. More... | |
| void | glfwRestoreWindow (GLFWwindow *window) |
| Restores the specified window. More... | |
| void | glfwMaximizeWindow (GLFWwindow *window) |
| Maximizes the specified window. More... | |
| void | glfwShowWindow (GLFWwindow *window) |
| Makes the specified window visible. More... | |
| void | glfwHideWindow (GLFWwindow *window) |
| Hides the specified window. More... | |
| void | glfwFocusWindow (GLFWwindow *window) |
| Brings the specified window to front and sets input focus. More... | |
| void | glfwRequestWindowAttention (GLFWwindow *window) |
| Requests user attention to the specified window. More... | |
| GLFWmonitor * | glfwGetWindowMonitor (GLFWwindow *window) |
| Returns the monitor that the window uses for full screen mode. More... | |
| void | glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate) |
| Sets the mode, monitor, video mode and placement of a window. More... | |
| int | glfwGetWindowAttrib (GLFWwindow *window, int attrib) |
| Returns an attribute of the specified window. More... | |
| void | glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value) |
| Sets an attribute of the specified window. More... | |
| void | glfwSetWindowUserPointer (GLFWwindow *window, void *pointer) |
| Sets the user pointer of the specified window. More... | |
| void * | glfwGetWindowUserPointer (GLFWwindow *window) |
| Returns the user pointer of the specified window. More... | |
| GLFWwindowposfun | glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun callback) |
| Sets the position callback for the specified window. More... | |
| GLFWwindowsizefun | glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun callback) |
| Sets the size callback for the specified window. More... | |
| GLFWwindowclosefun | glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun callback) |
| Sets the close callback for the specified window. More... | |
| GLFWwindowrefreshfun | glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun callback) |
| Sets the refresh callback for the specified window. More... | |
| GLFWwindowfocusfun | glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun callback) |
| Sets the focus callback for the specified window. More... | |
| GLFWwindowiconifyfun | glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun callback) |
| Sets the iconify callback for the specified window. More... | |
| GLFWwindowmaximizefun | glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun callback) |
| Sets the maximize callback for the specified window. More... | |
| GLFWframebuffersizefun | glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun callback) |
| Sets the framebuffer resize callback for the specified window. More... | |
| GLFWwindowcontentscalefun | glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun callback) |
| Sets the window content scale callback for the specified window. More... | |
| void | glfwPollEvents (void) |
| Processes all pending events. More... | |
| void | glfwWaitEvents (void) |
| Waits until events are queued and processes them. More... | |
| void | glfwWaitEventsTimeout (double timeout) |
| Waits with timeout until events are queued and processes them. More... | |
| void | glfwPostEmptyEvent (void) |
| Posts an empty event to the event queue. More... | |
| int | glfwGetInputMode (GLFWwindow *window, int mode) |
| Returns the value of an input option for the specified window. More... | |
| void | glfwSetInputMode (GLFWwindow *window, int mode, int value) |
| Sets an input option for the specified window. More... | |
| int | glfwRawMouseMotionSupported (void) |
| Returns whether raw mouse motion is supported. More... | |
| const char * | glfwGetKeyName (int key, int scancode) |
| Returns the layout-specific name of the specified printable key. More... | |
| int | glfwGetKeyScancode (int key) |
| Returns the platform-specific scancode of the specified key. More... | |
| int | glfwGetKey (GLFWwindow *window, int key) |
| Returns the last reported state of a keyboard key for the specified window. More... | |
| int | glfwGetMouseButton (GLFWwindow *window, int button) |
| Returns the last reported state of a mouse button for the specified window. More... | |
| void | glfwGetCursorPos (GLFWwindow *window, double *xpos, double *ypos) |
| Retrieves the position of the cursor relative to the content area of the window. More... | |
| void | glfwSetCursorPos (GLFWwindow *window, double xpos, double ypos) |
| Sets the position of the cursor, relative to the content area of the window. More... | |
| GLFWcursor * | glfwCreateCursor (const GLFWimage *image, int xhot, int yhot) |
| Creates a custom cursor. More... | |
| GLFWcursor * | glfwCreateStandardCursor (int shape) |
| Creates a cursor with a standard shape. More... | |
| void | glfwDestroyCursor (GLFWcursor *cursor) |
| Destroys a cursor. More... | |
| void | glfwSetCursor (GLFWwindow *window, GLFWcursor *cursor) |
| Sets the cursor for the window. More... | |
| GLFWkeyfun | glfwSetKeyCallback (GLFWwindow *window, GLFWkeyfun callback) |
| Sets the key callback. More... | |
| GLFWcharfun | glfwSetCharCallback (GLFWwindow *window, GLFWcharfun callback) |
| Sets the Unicode character callback. More... | |
| GLFWcharmodsfun | glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun callback) |
| Sets the Unicode character with modifiers callback. More... | |
| GLFWmousebuttonfun | glfwSetMouseButtonCallback (GLFWwindow *window, GLFWmousebuttonfun callback) |
| Sets the mouse button callback. More... | |
| GLFWcursorposfun | glfwSetCursorPosCallback (GLFWwindow *window, GLFWcursorposfun callback) |
| Sets the cursor position callback. More... | |
| GLFWcursorenterfun | glfwSetCursorEnterCallback (GLFWwindow *window, GLFWcursorenterfun callback) |
| Sets the cursor enter/leave callback. More... | |
| GLFWscrollfun | glfwSetScrollCallback (GLFWwindow *window, GLFWscrollfun callback) |
| Sets the scroll callback. More... | |
| GLFWdropfun | glfwSetDropCallback (GLFWwindow *window, GLFWdropfun callback) |
| Sets the path drop callback. More... | |
| int | glfwJoystickPresent (int jid) |
| Returns whether the specified joystick is present. More... | |
| const float * | glfwGetJoystickAxes (int jid, int *count) |
| Returns the values of all axes of the specified joystick. More... | |
| const unsigned char * | glfwGetJoystickButtons (int jid, int *count) |
| Returns the state of all buttons of the specified joystick. More... | |
| const unsigned char * | glfwGetJoystickHats (int jid, int *count) |
| Returns the state of all hats of the specified joystick. More... | |
| const char * | glfwGetJoystickName (int jid) |
| Returns the name of the specified joystick. More... | |
| const char * | glfwGetJoystickGUID (int jid) |
| Returns the SDL compatible GUID of the specified joystick. More... | |
| void | glfwSetJoystickUserPointer (int jid, void *pointer) |
| Sets the user pointer of the specified joystick. More... | |
| void * | glfwGetJoystickUserPointer (int jid) |
| Returns the user pointer of the specified joystick. More... | |
| int | glfwJoystickIsGamepad (int jid) |
| Returns whether the specified joystick has a gamepad mapping. More... | |
| GLFWjoystickfun | glfwSetJoystickCallback (GLFWjoystickfun callback) |
| Sets the joystick configuration callback. More... | |
| int | glfwUpdateGamepadMappings (const char *string) |
| Adds the specified SDL_GameControllerDB gamepad mappings. More... | |
| const char * | glfwGetGamepadName (int jid) |
| Returns the human-readable gamepad name for the specified joystick. More... | |
| int | glfwGetGamepadState (int jid, GLFWgamepadstate *state) |
| Retrieves the state of the specified joystick remapped as a gamepad. More... | |
| void | glfwSetClipboardString (GLFWwindow *window, const char *string) |
| Sets the clipboard to the specified string. More... | |
| const char * | glfwGetClipboardString (GLFWwindow *window) |
| Returns the contents of the clipboard as a string. More... | |
| double | glfwGetTime (void) |
| Returns the GLFW time. More... | |
| void | glfwSetTime (double time) |
| Sets the GLFW time. More... | |
| uint64_t | glfwGetTimerValue (void) |
| Returns the current value of the raw timer. More... | |
| uint64_t | glfwGetTimerFrequency (void) |
| Returns the frequency, in Hz, of the raw timer. More... | |
| void | glfwMakeContextCurrent (GLFWwindow *window) |
| Makes the context of the specified window current for the calling thread. More... | |
| GLFWwindow * | glfwGetCurrentContext (void) |
| Returns the window whose context is current on the calling thread. More... | |
| void | glfwSwapBuffers (GLFWwindow *window) |
| Swaps the front and back buffers of the specified window. More... | |
| void | glfwSwapInterval (int interval) |
| Sets the swap interval for the current context. More... | |
| int | glfwExtensionSupported (const char *extension) |
| Returns whether the specified extension is available. More... | |
| GLFWglproc | glfwGetProcAddress (const char *procname) |
| Returns the address of the specified function for the current context. More... | |
| int | glfwVulkanSupported (void) |
| Returns whether the Vulkan loader and an ICD have been found. More... | |
| const char ** | glfwGetRequiredInstanceExtensions (uint32_t *count) |
| Returns the Vulkan instance extensions required by GLFW. More... | |
| GLFWvkproc | glfwGetInstanceProcAddress (VkInstance instance, const char *procname) |
| Returns the address of the specified Vulkan instance function. More... | |
| int | glfwGetPhysicalDevicePresentationSupport (VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily) |
| Returns whether the specified queue family can present images. More... | |
| VkResult | glfwCreateWindowSurface (VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface) |
| Creates a Vulkan surface for the specified window. More... | |
Macro Definition Documentation
+ +◆ GLFW_APIENTRY_DEFINED
+ +| #define GLFW_APIENTRY_DEFINED | +
◆ GLFW_NO_API
+ +| #define GLFW_NO_API 0 | +
◆ GLFW_OPENGL_API
+ +| #define GLFW_OPENGL_API 0x00030001 | +
◆ GLFW_OPENGL_ES_API
+ +| #define GLFW_OPENGL_ES_API 0x00030002 | +
◆ GLFW_NO_ROBUSTNESS
+ +| #define GLFW_NO_ROBUSTNESS 0 | +
◆ GLFW_NO_RESET_NOTIFICATION
+ +| #define GLFW_NO_RESET_NOTIFICATION 0x00031001 | +
◆ GLFW_LOSE_CONTEXT_ON_RESET
+ +| #define GLFW_LOSE_CONTEXT_ON_RESET 0x00031002 | +
◆ GLFW_OPENGL_ANY_PROFILE
+ +| #define GLFW_OPENGL_ANY_PROFILE 0 | +
◆ GLFW_OPENGL_CORE_PROFILE
+ +| #define GLFW_OPENGL_CORE_PROFILE 0x00032001 | +
◆ GLFW_OPENGL_COMPAT_PROFILE
+ +| #define GLFW_OPENGL_COMPAT_PROFILE 0x00032002 | +
◆ GLFW_CURSOR
+ +| #define GLFW_CURSOR 0x00033001 | +
◆ GLFW_STICKY_KEYS
+ +| #define GLFW_STICKY_KEYS 0x00033002 | +
◆ GLFW_STICKY_MOUSE_BUTTONS
+ +| #define GLFW_STICKY_MOUSE_BUTTONS 0x00033003 | +
◆ GLFW_LOCK_KEY_MODS
+ +| #define GLFW_LOCK_KEY_MODS 0x00033004 | +
◆ GLFW_RAW_MOUSE_MOTION
+ +| #define GLFW_RAW_MOUSE_MOTION 0x00033005 | +
◆ GLFW_CURSOR_NORMAL
+ +| #define GLFW_CURSOR_NORMAL 0x00034001 | +
◆ GLFW_CURSOR_HIDDEN
+ +| #define GLFW_CURSOR_HIDDEN 0x00034002 | +
◆ GLFW_CURSOR_DISABLED
+ +| #define GLFW_CURSOR_DISABLED 0x00034003 | +
◆ GLFW_ANY_RELEASE_BEHAVIOR
+ +| #define GLFW_ANY_RELEASE_BEHAVIOR 0 | +
◆ GLFW_RELEASE_BEHAVIOR_FLUSH
+ +| #define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001 | +
◆ GLFW_RELEASE_BEHAVIOR_NONE
+ +| #define GLFW_RELEASE_BEHAVIOR_NONE 0x00035002 | +
◆ GLFW_NATIVE_CONTEXT_API
+ +| #define GLFW_NATIVE_CONTEXT_API 0x00036001 | +
◆ GLFW_EGL_CONTEXT_API
+ +| #define GLFW_EGL_CONTEXT_API 0x00036002 | +
◆ GLFW_OSMESA_CONTEXT_API
+ +| #define GLFW_OSMESA_CONTEXT_API 0x00036003 | +
◆ GLFW_CONNECTED
+ +| #define GLFW_CONNECTED 0x00040001 | +
◆ GLFW_DISCONNECTED
+ +| #define GLFW_DISCONNECTED 0x00040002 | +
◆ GLFW_DONT_CARE
+ +| #define GLFW_DONT_CARE -1 | +
◆ GLAPIENTRY
+ +| #define GLAPIENTRY APIENTRY | +
◆ GLFW_GLAPIENTRY_DEFINED
+ +| #define GLFW_GLAPIENTRY_DEFINED | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html b/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html new file mode 100644 index 0000000..be04039 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html @@ -0,0 +1,1155 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/glfw3native_8h.html b/deps/glfw-3.3.8/docs/html/glfw3native_8h.html new file mode 100644 index 0000000..b990f15 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3native_8h.html @@ -0,0 +1,160 @@ + + + + + + + +Description
+This is the header file of the native access functions. See Native access for more information.
+Go to the source code of this file.
++Functions | |
| const char * | glfwGetWin32Adapter (GLFWmonitor *monitor) |
| Returns the adapter device name of the specified monitor. More... | |
| const char * | glfwGetWin32Monitor (GLFWmonitor *monitor) |
| Returns the display device name of the specified monitor. More... | |
| HWND | glfwGetWin32Window (GLFWwindow *window) |
Returns the HWND of the specified window. More... | |
| HGLRC | glfwGetWGLContext (GLFWwindow *window) |
Returns the HGLRC of the specified window. More... | |
| CGDirectDisplayID | glfwGetCocoaMonitor (GLFWmonitor *monitor) |
Returns the CGDirectDisplayID of the specified monitor. More... | |
| id | glfwGetCocoaWindow (GLFWwindow *window) |
Returns the NSWindow of the specified window. More... | |
| id | glfwGetNSGLContext (GLFWwindow *window) |
Returns the NSOpenGLContext of the specified window. More... | |
| Display * | glfwGetX11Display (void) |
Returns the Display used by GLFW. More... | |
| RRCrtc | glfwGetX11Adapter (GLFWmonitor *monitor) |
Returns the RRCrtc of the specified monitor. More... | |
| RROutput | glfwGetX11Monitor (GLFWmonitor *monitor) |
Returns the RROutput of the specified monitor. More... | |
| Window | glfwGetX11Window (GLFWwindow *window) |
Returns the Window of the specified window. More... | |
| void | glfwSetX11SelectionString (const char *string) |
| Sets the current primary selection to the specified string. More... | |
| const char * | glfwGetX11SelectionString (void) |
| Returns the contents of the current primary selection as a string. More... | |
| GLXContext | glfwGetGLXContext (GLFWwindow *window) |
Returns the GLXContext of the specified window. More... | |
| GLXWindow | glfwGetGLXWindow (GLFWwindow *window) |
Returns the GLXWindow of the specified window. More... | |
| struct wl_display * | glfwGetWaylandDisplay (void) |
Returns the struct wl_display* used by GLFW. More... | |
| struct wl_output * | glfwGetWaylandMonitor (GLFWmonitor *monitor) |
Returns the struct wl_output* of the specified monitor. More... | |
| struct wl_surface * | glfwGetWaylandWindow (GLFWwindow *window) |
Returns the main struct wl_surface* of the specified window. More... | |
| EGLDisplay | glfwGetEGLDisplay (void) |
Returns the EGLDisplay used by GLFW. More... | |
| EGLContext | glfwGetEGLContext (GLFWwindow *window) |
Returns the EGLContext of the specified window. More... | |
| EGLSurface | glfwGetEGLSurface (GLFWwindow *window) |
Returns the EGLSurface of the specified window. More... | |
| int | glfwGetOSMesaColorBuffer (GLFWwindow *window, int *width, int *height, int *format, void **buffer) |
| Retrieves the color buffer associated with the specified window. More... | |
| int | glfwGetOSMesaDepthBuffer (GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer) |
| Retrieves the depth buffer associated with the specified window. More... | |
| OSMesaContext | glfwGetOSMesaContext (GLFWwindow *window) |
Returns the OSMesaContext of the specified window. More... | |
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html b/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html new file mode 100644 index 0000000..31a0c40 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html @@ -0,0 +1,285 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__buttons.html b/deps/glfw-3.3.8/docs/html/group__buttons.html new file mode 100644 index 0000000..7f1bb3d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__buttons.html @@ -0,0 +1,275 @@ + + + + + + + +Description
+See mouse button input for how these are used.
++Macros | |
| #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 |
Macro Definition Documentation
+ +◆ GLFW_MOUSE_BUTTON_1
+ +| #define GLFW_MOUSE_BUTTON_1 0 | +
◆ GLFW_MOUSE_BUTTON_2
+ +| #define GLFW_MOUSE_BUTTON_2 1 | +
◆ GLFW_MOUSE_BUTTON_3
+ +| #define GLFW_MOUSE_BUTTON_3 2 | +
◆ GLFW_MOUSE_BUTTON_4
+ +| #define GLFW_MOUSE_BUTTON_4 3 | +
◆ GLFW_MOUSE_BUTTON_5
+ +| #define GLFW_MOUSE_BUTTON_5 4 | +
◆ GLFW_MOUSE_BUTTON_6
+ +| #define GLFW_MOUSE_BUTTON_6 5 | +
◆ GLFW_MOUSE_BUTTON_7
+ +| #define GLFW_MOUSE_BUTTON_7 6 | +
◆ GLFW_MOUSE_BUTTON_8
+ +| #define GLFW_MOUSE_BUTTON_8 7 | +
◆ GLFW_MOUSE_BUTTON_LAST
+ +| #define GLFW_MOUSE_BUTTON_LAST GLFW_MOUSE_BUTTON_8 | +
◆ GLFW_MOUSE_BUTTON_LEFT
+ +| #define GLFW_MOUSE_BUTTON_LEFT GLFW_MOUSE_BUTTON_1 | +
◆ GLFW_MOUSE_BUTTON_RIGHT
+ +| #define GLFW_MOUSE_BUTTON_RIGHT GLFW_MOUSE_BUTTON_2 | +
◆ GLFW_MOUSE_BUTTON_MIDDLE
+ +| #define GLFW_MOUSE_BUTTON_MIDDLE GLFW_MOUSE_BUTTON_3 | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__context.html b/deps/glfw-3.3.8/docs/html/group__context.html new file mode 100644 index 0000000..2913ea0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__context.html @@ -0,0 +1,295 @@ + + + + + + + +Description
+This is the reference documentation for OpenGL and OpenGL ES context related functions. For more task-oriented information, see the Context guide.
++Typedefs | |
| typedef void(* | GLFWglproc) (void) |
| Client API function pointer type. More... | |
+Functions | |
| void | glfwMakeContextCurrent (GLFWwindow *window) |
| Makes the context of the specified window current for the calling thread. More... | |
| GLFWwindow * | glfwGetCurrentContext (void) |
| Returns the window whose context is current on the calling thread. More... | |
| void | glfwSwapInterval (int interval) |
| Sets the swap interval for the current context. More... | |
| int | glfwExtensionSupported (const char *extension) |
| Returns whether the specified extension is available. More... | |
| GLFWglproc | glfwGetProcAddress (const char *procname) |
| Returns the address of the specified function for the current context. More... | |
Typedef Documentation
+ +◆ GLFWglproc
+ +| typedef void(* GLFWglproc) (void) | +
Generic function pointer used for returning client API function pointers without forcing a cast from a regular pointer.
+ +- Since
- Added in version 3.0.
Function Documentation
+ +◆ glfwMakeContextCurrent()
+ +| void glfwMakeContextCurrent | +( | +GLFWwindow * | +window | ) | ++ |
This function makes the OpenGL or OpenGL ES context of the specified window current on the calling thread. A context must only be made current on a single thread at a time and each thread can have only a single current context at a time.
+When moving a context between threads, you must make it non-current on the old thread before making it current on the new one.
+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 hint.
The specified window must have an OpenGL or OpenGL ES context. Specifying a window without a context will generate a GLFW_NO_WINDOW_CONTEXT error.
+- Parameters
-
+
+
+[in] window The window whose context to make current, or NULLto detach the current context.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.
- Thread safety
- This function may be called from any thread.
- See also
- Current context +
- +glfwGetCurrentContext
- Since
- Added in version 3.0.
◆ glfwGetCurrentContext()
+ +| GLFWwindow * glfwGetCurrentContext | +( | +void | +) | ++ |
This function returns the window whose OpenGL or OpenGL ES context is current on the calling thread.
+- Returns
- The window whose context is current, or
NULLif no window's context is current.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread.
- See also
- Current context +
- +glfwMakeContextCurrent
- Since
- Added in version 3.0.
◆ glfwSwapInterval()
+ +| void glfwSwapInterval | +( | +int | +interval | ) | ++ |
This function sets the swap interval for the current OpenGL or OpenGL ES context, i.e. the number of screen updates to wait from the time glfwSwapBuffers was called before swapping the buffers and returning. This is sometimes called vertical synchronization, vertical retrace synchronization or just vsync.
+A context that supports either of the WGL_EXT_swap_control_tear and GLX_EXT_swap_control_tear extensions also accepts negative swap intervals, which allows the driver to swap immediately even if a frame arrives a little bit late. You can check for these extensions with glfwExtensionSupported.
A context must be current on the calling thread. Calling this function without a current context will cause a GLFW_NO_CURRENT_CONTEXT error.
+This function does not apply to Vulkan. If you are rendering with Vulkan, see the present mode of your swapchain instead.
+- Parameters
-
+
+
+[in] interval The minimum number of screen updates to wait for until the buffers are swapped by glfwSwapBuffers.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT and GLFW_PLATFORM_ERROR.
- 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. +
- +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.
- Thread safety
- This function may be called from any thread.
- See also
- Buffer swapping +
- +glfwSwapBuffers
- Since
- Added in version 1.0.
◆ glfwExtensionSupported()
+ +| int glfwExtensionSupported | +( | +const char * | +extension | ) | ++ |
This function returns whether the specified API extension is supported by the current OpenGL or OpenGL ES context. It searches both for client API extension and context creation API extensions.
+A context must be current on the calling thread. Calling this function without a current context will cause a 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.
+This function does not apply to Vulkan. If you are using Vulkan, see glfwGetRequiredInstanceExtensions, vkEnumerateInstanceExtensionProperties and vkEnumerateDeviceExtensionProperties instead.
- Parameters
-
+
+
+[in] extension The ASCII encoded name of the extension.
+
- Returns
GLFW_TRUEif the extension is available, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Thread safety
- This function may be called from any thread.
- Since
- Added in version 1.0.
◆ glfwGetProcAddress()
+ +| GLFWglproc glfwGetProcAddress | +( | +const char * | +procname | ) | ++ |
This function returns the address of the specified OpenGL or OpenGL ES core or extension function, 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 GLFW_NO_CURRENT_CONTEXT error.
+This function does not apply to Vulkan. If you are rendering with Vulkan, see glfwGetInstanceProcAddress, vkGetInstanceProcAddr and vkGetDeviceProcAddr instead.
- Parameters
-
+
+
+[in] procname The ASCII encoded name of the function.
+
- Returns
- The address of the function, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT and GLFW_PLATFORM_ERROR.
- Remarks
- The address of a given function is not guaranteed to be the same between contexts. +
-
+This function may return a non-
NULLaddress despite the associated version or extension not being available. Always check the context version or extension string first.
- Pointer lifetime
- The returned function pointer is valid until the context is destroyed or the library is terminated.
- Thread safety
- This function may be called from any thread.
- Since
- Added in version 1.0.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__errors.html b/deps/glfw-3.3.8/docs/html/group__errors.html new file mode 100644 index 0000000..3def8eb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__errors.html @@ -0,0 +1,297 @@ + + + + + + + +Description
+See error handling for how these are used.
++Macros | |
| #define | GLFW_NO_ERROR 0 |
| No error has occurred. More... | |
| #define | GLFW_NOT_INITIALIZED 0x00010001 |
| GLFW has not been initialized. More... | |
| #define | GLFW_NO_CURRENT_CONTEXT 0x00010002 |
| No context is current for this thread. More... | |
| #define | GLFW_INVALID_ENUM 0x00010003 |
| One of the arguments to the function was an invalid enum value. More... | |
| #define | GLFW_INVALID_VALUE 0x00010004 |
| One of the arguments to the function was an invalid value. More... | |
| #define | GLFW_OUT_OF_MEMORY 0x00010005 |
| A memory allocation failed. More... | |
| #define | GLFW_API_UNAVAILABLE 0x00010006 |
| GLFW could not find support for the requested API on the system. More... | |
| #define | GLFW_VERSION_UNAVAILABLE 0x00010007 |
| The requested OpenGL or OpenGL ES version is not available. More... | |
| #define | GLFW_PLATFORM_ERROR 0x00010008 |
| A platform-specific error occurred that does not match any of the more specific categories. More... | |
| #define | GLFW_FORMAT_UNAVAILABLE 0x00010009 |
| The requested format is not supported or available. More... | |
| #define | GLFW_NO_WINDOW_CONTEXT 0x0001000A |
| The specified window does not have an OpenGL or OpenGL ES context. More... | |
Macro Definition Documentation
+ +◆ GLFW_NO_ERROR
+ +| #define GLFW_NO_ERROR 0 | +
No error has occurred.
+- Analysis
- Yay.
◆ GLFW_NOT_INITIALIZED
+ +| #define GLFW_NOT_INITIALIZED 0x00010001 | +
This occurs if a GLFW function was called that must not be called unless the library is initialized.
+- Analysis
- Application programmer error. Initialize GLFW before calling any function that requires initialization.
◆ GLFW_NO_CURRENT_CONTEXT
+ +| #define GLFW_NO_CURRENT_CONTEXT 0x00010002 | +
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 glfwSwapInterval.
+- Analysis
- Application programmer error. Ensure a context is current before calling functions that require a current context.
◆ GLFW_INVALID_ENUM
+ +| #define GLFW_INVALID_ENUM 0x00010003 | +
One of the arguments to the function was an invalid enum value, for example requesting GLFW_RED_BITS with glfwGetWindowAttrib.
+- Analysis
- Application programmer error. Fix the offending call.
◆ GLFW_INVALID_VALUE
+ +| #define GLFW_INVALID_VALUE 0x00010004 | +
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 GLFW_VERSION_UNAVAILABLE error.
+- Analysis
- Application programmer error. Fix the offending call.
◆ GLFW_OUT_OF_MEMORY
+ +| #define GLFW_OUT_OF_MEMORY 0x00010005 | +
A memory allocation failed.
+- Analysis
- A bug in GLFW or the underlying operating system. Report the bug to our issue tracker.
◆ GLFW_API_UNAVAILABLE
+ +| #define GLFW_API_UNAVAILABLE 0x00010006 | +
GLFW could not find support for the requested API on the system.
+- Analysis
- The installed graphics driver does not support the requested API, or does not support it via the chosen context creation backend. Below are a few examples.
- Some pre-installed Windows graphics drivers do not support OpenGL. AMD only supports OpenGL ES via EGL, while Nvidia and Intel only support it via a WGL or GLX extension. macOS does not provide OpenGL ES at all. The Mesa EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary driver. Older graphics drivers do not support Vulkan.
◆ GLFW_VERSION_UNAVAILABLE
+ +| #define GLFW_VERSION_UNAVAILABLE 0x00010007 | +
The requested OpenGL or OpenGL ES version (including any requested context or framebuffer hints) is not available on this machine.
+- 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.
- 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 GLFW_INVALID_VALUE, because GLFW cannot know what future versions will exist.
◆ GLFW_PLATFORM_ERROR
+ +| #define GLFW_PLATFORM_ERROR 0x00010008 | +
A platform-specific error occurred that does not match any of the more specific categories.
+- 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.
◆ GLFW_FORMAT_UNAVAILABLE
+ +| #define GLFW_FORMAT_UNAVAILABLE 0x00010009 | +
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.
+- Analysis
- If emitted during window creation, one or more hard constraints 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.
- If emitted when querying the clipboard, ignore the error or report it to the user, as appropriate.
◆ GLFW_NO_WINDOW_CONTEXT
+ +| #define GLFW_NO_WINDOW_CONTEXT 0x0001000A | +
A window that does not have an OpenGL or OpenGL ES context was passed to a function that requires it to have one.
+- Analysis
- Application programmer error. Fix the offending call.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html b/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html new file mode 100644 index 0000000..5dc84be --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html @@ -0,0 +1,195 @@ + + + + + + + +Description
+See Gamepad input for how these are used.
++Macros | |
| #define | GLFW_GAMEPAD_AXIS_LEFT_X 0 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_Y 1 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_X 2 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_Y 3 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5 |
| #define | GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER |
Macro Definition Documentation
+ +◆ GLFW_GAMEPAD_AXIS_LEFT_X
+ +| #define GLFW_GAMEPAD_AXIS_LEFT_X 0 | +
◆ GLFW_GAMEPAD_AXIS_LEFT_Y
+ +| #define GLFW_GAMEPAD_AXIS_LEFT_Y 1 | +
◆ GLFW_GAMEPAD_AXIS_RIGHT_X
+ +| #define GLFW_GAMEPAD_AXIS_RIGHT_X 2 | +
◆ GLFW_GAMEPAD_AXIS_RIGHT_Y
+ +| #define GLFW_GAMEPAD_AXIS_RIGHT_Y 3 | +
◆ GLFW_GAMEPAD_AXIS_LEFT_TRIGGER
+ +| #define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4 | +
◆ GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
+ +| #define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5 | +
◆ GLFW_GAMEPAD_AXIS_LAST
+ +| #define GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html b/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html new file mode 100644 index 0000000..51c027d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html @@ -0,0 +1,403 @@ + + + + + + + +Description
+See Gamepad input for how these are used.
++Macros | |
| #define | GLFW_GAMEPAD_BUTTON_A 0 |
| #define | GLFW_GAMEPAD_BUTTON_B 1 |
| #define | GLFW_GAMEPAD_BUTTON_X 2 |
| #define | GLFW_GAMEPAD_BUTTON_Y 3 |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5 |
| #define | GLFW_GAMEPAD_BUTTON_BACK 6 |
| #define | GLFW_GAMEPAD_BUTTON_START 7 |
| #define | GLFW_GAMEPAD_BUTTON_GUIDE 8 |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_UP 11 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14 |
| #define | GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT |
| #define | GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A |
| #define | GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B |
| #define | GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X |
| #define | GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y |
Macro Definition Documentation
+ +◆ GLFW_GAMEPAD_BUTTON_A
+ +| #define GLFW_GAMEPAD_BUTTON_A 0 | +
◆ GLFW_GAMEPAD_BUTTON_B
+ +| #define GLFW_GAMEPAD_BUTTON_B 1 | +
◆ GLFW_GAMEPAD_BUTTON_X
+ +| #define GLFW_GAMEPAD_BUTTON_X 2 | +
◆ GLFW_GAMEPAD_BUTTON_Y
+ +| #define GLFW_GAMEPAD_BUTTON_Y 3 | +
◆ GLFW_GAMEPAD_BUTTON_LEFT_BUMPER
+ +| #define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4 | +
◆ GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER
+ +| #define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5 | +
◆ GLFW_GAMEPAD_BUTTON_BACK
+ +| #define GLFW_GAMEPAD_BUTTON_BACK 6 | +
◆ GLFW_GAMEPAD_BUTTON_START
+ +| #define GLFW_GAMEPAD_BUTTON_START 7 | +
◆ GLFW_GAMEPAD_BUTTON_GUIDE
+ +| #define GLFW_GAMEPAD_BUTTON_GUIDE 8 | +
◆ GLFW_GAMEPAD_BUTTON_LEFT_THUMB
+ +| #define GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9 | +
◆ GLFW_GAMEPAD_BUTTON_RIGHT_THUMB
+ +| #define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10 | +
◆ GLFW_GAMEPAD_BUTTON_DPAD_UP
+ +| #define GLFW_GAMEPAD_BUTTON_DPAD_UP 11 | +
◆ GLFW_GAMEPAD_BUTTON_DPAD_RIGHT
+ +| #define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12 | +
◆ GLFW_GAMEPAD_BUTTON_DPAD_DOWN
+ +| #define GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13 | +
◆ GLFW_GAMEPAD_BUTTON_DPAD_LEFT
+ +| #define GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14 | +
◆ GLFW_GAMEPAD_BUTTON_LAST
+ +| #define GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT | +
◆ GLFW_GAMEPAD_BUTTON_CROSS
+ +| #define GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A | +
◆ GLFW_GAMEPAD_BUTTON_CIRCLE
+ +| #define GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B | +
◆ GLFW_GAMEPAD_BUTTON_SQUARE
+ +| #define GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X | +
◆ GLFW_GAMEPAD_BUTTON_TRIANGLE
+ +| #define GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__hat__state.html b/deps/glfw-3.3.8/docs/html/group__hat__state.html new file mode 100644 index 0000000..d08f541 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__hat__state.html @@ -0,0 +1,227 @@ + + + + + + + +Description
+See joystick hat input for how these are used.
++Macros | |
| #define | GLFW_HAT_CENTERED 0 |
| #define | GLFW_HAT_UP 1 |
| #define | GLFW_HAT_RIGHT 2 |
| #define | GLFW_HAT_DOWN 4 |
| #define | GLFW_HAT_LEFT 8 |
| #define | GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP) |
| #define | GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN) |
| #define | GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP) |
| #define | GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN) |
Macro Definition Documentation
+ +◆ GLFW_HAT_CENTERED
+ +| #define GLFW_HAT_CENTERED 0 | +
◆ GLFW_HAT_UP
+ +| #define GLFW_HAT_UP 1 | +
◆ GLFW_HAT_RIGHT
+ +| #define GLFW_HAT_RIGHT 2 | +
◆ GLFW_HAT_DOWN
+ +| #define GLFW_HAT_DOWN 4 | +
◆ GLFW_HAT_LEFT
+ +| #define GLFW_HAT_LEFT 8 | +
◆ GLFW_HAT_RIGHT_UP
+ +| #define GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP) | +
◆ GLFW_HAT_RIGHT_DOWN
+ +| #define GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN) | +
◆ GLFW_HAT_LEFT_UP
+ +| #define GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP) | +
◆ GLFW_HAT_LEFT_DOWN
+ +| #define GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN) | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__init.html b/deps/glfw-3.3.8/docs/html/group__init.html new file mode 100644 index 0000000..944700b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__init.html @@ -0,0 +1,545 @@ + + + + + + + +Description
+This is the reference documentation for initialization and termination of the library, version management and error handling. For more task-oriented information, see the Introduction to the API.
++Modules | |
| Error codes | |
| Error codes. | |
+Macros | |
| #define | GLFW_TRUE 1 |
| One. More... | |
| #define | GLFW_FALSE 0 |
| Zero. More... | |
| #define | GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 |
| Joystick hat buttons init hint. More... | |
| #define | GLFW_COCOA_CHDIR_RESOURCES 0x00051001 |
| macOS specific init hint. More... | |
| #define | GLFW_COCOA_MENUBAR 0x00051002 |
| macOS specific init hint. More... | |
+Typedefs | |
| typedef void(* | GLFWerrorfun) (int error_code, const char *description) |
| The function pointer type for error callbacks. More... | |
+Functions | |
| int | glfwInit (void) |
| Initializes the GLFW library. More... | |
| void | glfwTerminate (void) |
| Terminates the GLFW library. More... | |
| void | glfwInitHint (int hint, int value) |
| Sets the specified init hint to the desired value. More... | |
| void | glfwGetVersion (int *major, int *minor, int *rev) |
| Retrieves the version of the GLFW library. More... | |
| const char * | glfwGetVersionString (void) |
| Returns a string describing the compile-time configuration. More... | |
| int | glfwGetError (const char **description) |
| Returns and clears the last error for the calling thread. More... | |
| GLFWerrorfun | glfwSetErrorCallback (GLFWerrorfun callback) |
| Sets the error callback. More... | |
Macro Definition Documentation
+ +◆ GLFW_VERSION_MAJOR
+ +| #define GLFW_VERSION_MAJOR 3 | +
The major version number of the GLFW header. This is incremented when the API is changed in non-compatible ways.
+ +◆ GLFW_VERSION_MINOR
+ +| #define GLFW_VERSION_MINOR 3 | +
The minor version number of the GLFW header. This is incremented when features are added to the API but it remains backward-compatible.
+ +◆ GLFW_VERSION_REVISION
+ +| #define GLFW_VERSION_REVISION 8 | +
The revision number of the GLFW header. This is incremented when a bug fix release is made that does not contain any API changes.
+ +◆ GLFW_TRUE
+ +| #define GLFW_TRUE 1 | +
This is only semantic sugar for the number 1. You can instead use 1 or true or _True or GL_TRUE or VK_TRUE or anything else that is equal to one.
◆ GLFW_FALSE
+ +| #define GLFW_FALSE 0 | +
This is only semantic sugar for the number 0. You can instead use 0 or false or _False or GL_FALSE or VK_FALSE or anything else that is equal to zero.
◆ GLFW_JOYSTICK_HAT_BUTTONS
+ +| #define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 | +
Joystick hat buttons init hint.
+ +◆ GLFW_COCOA_CHDIR_RESOURCES
+ +| #define GLFW_COCOA_CHDIR_RESOURCES 0x00051001 | +
macOS specific init hint.
+ +◆ GLFW_COCOA_MENUBAR
+ +| #define GLFW_COCOA_MENUBAR 0x00051002 | +
macOS specific init hint.
+ +Typedef Documentation
+ +◆ GLFWerrorfun
+ +| typedef void(* GLFWerrorfun) (int error_code, const char *description) | +
This is the function pointer type for error callbacks. An error callback function has the following signature:
- Parameters
-
+
+
+[in] error_code An error code. Future releases may add more error codes. [in] description A UTF-8 encoded string describing the error.
+
- Pointer lifetime
- The error description string is valid until the callback function returns.
- See also
- Error handling +
- +glfwSetErrorCallback
- Since
- Added in version 3.0.
Function Documentation
+ +◆ glfwInit()
+ +| int glfwInit | +( | +void | +) | ++ |
This function initializes the GLFW library. Before most GLFW functions can 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 glfwTerminate before returning. If it succeeds, you should call glfwTerminate before the application exits.
+Additional calls to this function after successful initialization but before termination will return GLFW_TRUE immediately.
- Returns
GLFW_TRUEif successful, orGLFW_FALSEif an error occurred.
- Errors
- Possible errors include GLFW_PLATFORM_ERROR.
- Remarks
- macOS: This function will change the current directory of the application to the
Contents/Resourcessubdirectory of the application's bundle, if present. This can be disabled with the GLFW_COCOA_CHDIR_RESOURCES init hint.
+ -
+X11: This function will set the
LC_CTYPEcategory of the application locale according to the current environment if that category is still "C". This is because the "C" locale breaks Unicode text input.
- Thread safety
- This function must only be called from the main thread.
- See also
- Initialization and termination +
- +glfwTerminate
- Since
- Added in version 1.0.
◆ glfwTerminate()
+ +| void glfwTerminate | +( | +void | +) | ++ |
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 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 application exits. If initialization fails, there is no need to call this function, as it is called by glfwInit before it returns failure.
+This function has no effect if GLFW is not initialized.
+- Errors
- Possible errors include GLFW_PLATFORM_ERROR.
- Remarks
- This function may be called before glfwInit.
- Warning
- The contexts of any remaining windows must not be current on any other thread when this function is called.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Initialization and termination +
- +glfwInit
- Since
- Added in version 1.0.
◆ glfwInitHint()
+ +| void glfwInitHint | +( | +int | +hint, | +
| + | + | int | +value | +
| + | ) | ++ |
This function sets hints for the next initialization of GLFW.
+The values you set hints to are never reset by GLFW, but they only take effect during initialization. Once GLFW has been initialized, any values you set will be ignored until the library is terminated and initialized again.
+Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.
+- Parameters
-
+
+
+[in] hint The init hint to set. [in] value The new value of the init hint.
+
- Errors
- Possible errors include GLFW_INVALID_ENUM and GLFW_INVALID_VALUE.
- Remarks
- This function may be called before glfwInit.
- Thread safety
- This function must only be called from the main thread.
- See also
- init_hints +
- +glfwInit
- Since
- Added in version 3.3.
◆ glfwGetVersion()
+ +| void glfwGetVersion | +( | +int * | +major, | +
| + | + | int * | +minor, | +
| + | + | int * | +rev | +
| + | ) | ++ |
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.
+Any or all of the version arguments may be NULL.
- Parameters
-
+
+
+[out] major Where to store the major version number, or NULL.[out] minor Where to store the minor version number, or NULL.[out] rev Where to store the revision number, or NULL.
+
- Errors
- None.
- Remarks
- This function may be called before glfwInit.
- Thread safety
- This function may be called from any thread.
- See also
- Version management +
- +glfwGetVersionString
- Since
- Added in version 1.0.
◆ glfwGetVersionString()
+ +| const char * glfwGetVersionString | +( | +void | +) | ++ |
This function returns the compile-time generated version string of the GLFW library binary. It describes the version, platform, compiler and any platform-specific compile-time options. It should not be confused with the OpenGL or OpenGL ES version string, queried with glGetString.
Do not use the version string to parse the GLFW library version. The glfwGetVersion function provides the version of the running library binary in numerical format.
+- Returns
- The ASCII encoded GLFW version string.
- Errors
- None.
- Remarks
- This function may be called before glfwInit.
- Pointer lifetime
- The returned string is static and compile-time generated.
- Thread safety
- This function may be called from any thread.
- See also
- Version management +
- +glfwGetVersion
- Since
- Added in version 3.0.
◆ glfwGetError()
+ +| int glfwGetError | +( | +const char ** | +description | ) | ++ |
This function returns and clears the error code of the last error that occurred on the calling thread, and optionally a UTF-8 encoded human-readable description of it. If no error has occurred since the last call, it returns GLFW_NO_ERROR (zero) and the description pointer is set to NULL.
- Parameters
-
+
+
+[in] description Where to store the error description pointer, or NULL.
+
- Returns
- The last error code for the calling thread, or GLFW_NO_ERROR (zero).
- Errors
- None.
- Pointer lifetime
- The returned string is allocated and freed by GLFW. You should not free it yourself. It is guaranteed to be valid only until the next error occurs or the library is terminated.
- Remarks
- This function may be called before glfwInit.
- Thread safety
- This function may be called from any thread.
- See also
- Error handling +
- +glfwSetErrorCallback
- Since
- Added in version 3.3.
◆ glfwSetErrorCallback()
+ +| GLFWerrorfun glfwSetErrorCallback | +( | +GLFWerrorfun | +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.
+The error code is set before the callback is called. Calling glfwGetError from the error callback will return the same value as the error code argument.
+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.
+- Parameters
-
+
+
+[in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set.
- Callback signature
- For more information about the callback parameters, see the callback pointer type.void callback_name(int error_code, const char* description)+
- Errors
- None.
- Remarks
- This function may be called before glfwInit.
- Thread safety
- This function must only be called from the main thread.
- See also
- Error handling +
- +glfwGetError
- Since
- Added in version 3.0.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__input.html b/deps/glfw-3.3.8/docs/html/group__input.html new file mode 100644 index 0000000..18cf6f2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__input.html @@ -0,0 +1,2228 @@ + + + + + + + +Description
+This is the reference documentation for input related functions and types. For more task-oriented information, see the Input guide.
++Modules | |
| Gamepad axes | |
| Gamepad axes. | |
| Gamepad buttons | |
| Gamepad buttons. | |
| Joystick hat states | |
| Joystick hat states. | |
| Joysticks | |
| Joystick IDs. | |
| Keyboard keys | |
| Keyboard key IDs. | |
| Modifier key flags | |
| Modifier key flags. | |
| Mouse buttons | |
| Mouse button IDs. | |
| Standard cursor shapes | |
| Standard system cursor shapes. | |
+Typedefs | |
| typedef struct GLFWcursor | GLFWcursor |
| Opaque cursor object. More... | |
| typedef void(* | GLFWmousebuttonfun) (GLFWwindow *window, int button, int action, int mods) |
| The function pointer type for mouse button callbacks. More... | |
| typedef void(* | GLFWcursorposfun) (GLFWwindow *window, double xpos, double ypos) |
| The function pointer type for cursor position callbacks. More... | |
| typedef void(* | GLFWcursorenterfun) (GLFWwindow *window, int entered) |
| The function pointer type for cursor enter/leave callbacks. More... | |
| typedef void(* | GLFWscrollfun) (GLFWwindow *window, double xoffset, double yoffset) |
| The function pointer type for scroll callbacks. More... | |
| typedef void(* | GLFWkeyfun) (GLFWwindow *window, int key, int scancode, int action, int mods) |
| The function pointer type for keyboard key callbacks. More... | |
| typedef void(* | GLFWcharfun) (GLFWwindow *window, unsigned int codepoint) |
| The function pointer type for Unicode character callbacks. More... | |
| typedef void(* | GLFWcharmodsfun) (GLFWwindow *window, unsigned int codepoint, int mods) |
| The function pointer type for Unicode character with modifiers callbacks. More... | |
| typedef void(* | GLFWdropfun) (GLFWwindow *window, int path_count, const char *paths[]) |
| The function pointer type for path drop callbacks. More... | |
| typedef void(* | GLFWjoystickfun) (int jid, int event) |
| The function pointer type for joystick configuration callbacks. More... | |
| typedef struct GLFWgamepadstate | GLFWgamepadstate |
| Gamepad input state. More... | |
+Functions | |
| int | glfwGetInputMode (GLFWwindow *window, int mode) |
| Returns the value of an input option for the specified window. More... | |
| void | glfwSetInputMode (GLFWwindow *window, int mode, int value) |
| Sets an input option for the specified window. More... | |
| int | glfwRawMouseMotionSupported (void) |
| Returns whether raw mouse motion is supported. More... | |
| const char * | glfwGetKeyName (int key, int scancode) |
| Returns the layout-specific name of the specified printable key. More... | |
| int | glfwGetKeyScancode (int key) |
| Returns the platform-specific scancode of the specified key. More... | |
| int | glfwGetKey (GLFWwindow *window, int key) |
| Returns the last reported state of a keyboard key for the specified window. More... | |
| int | glfwGetMouseButton (GLFWwindow *window, int button) |
| Returns the last reported state of a mouse button for the specified window. More... | |
| void | glfwGetCursorPos (GLFWwindow *window, double *xpos, double *ypos) |
| Retrieves the position of the cursor relative to the content area of the window. More... | |
| void | glfwSetCursorPos (GLFWwindow *window, double xpos, double ypos) |
| Sets the position of the cursor, relative to the content area of the window. More... | |
| GLFWcursor * | glfwCreateCursor (const GLFWimage *image, int xhot, int yhot) |
| Creates a custom cursor. More... | |
| GLFWcursor * | glfwCreateStandardCursor (int shape) |
| Creates a cursor with a standard shape. More... | |
| void | glfwDestroyCursor (GLFWcursor *cursor) |
| Destroys a cursor. More... | |
| void | glfwSetCursor (GLFWwindow *window, GLFWcursor *cursor) |
| Sets the cursor for the window. More... | |
| GLFWkeyfun | glfwSetKeyCallback (GLFWwindow *window, GLFWkeyfun callback) |
| Sets the key callback. More... | |
| GLFWcharfun | glfwSetCharCallback (GLFWwindow *window, GLFWcharfun callback) |
| Sets the Unicode character callback. More... | |
| GLFWcharmodsfun | glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun callback) |
| Sets the Unicode character with modifiers callback. More... | |
| GLFWmousebuttonfun | glfwSetMouseButtonCallback (GLFWwindow *window, GLFWmousebuttonfun callback) |
| Sets the mouse button callback. More... | |
| GLFWcursorposfun | glfwSetCursorPosCallback (GLFWwindow *window, GLFWcursorposfun callback) |
| Sets the cursor position callback. More... | |
| GLFWcursorenterfun | glfwSetCursorEnterCallback (GLFWwindow *window, GLFWcursorenterfun callback) |
| Sets the cursor enter/leave callback. More... | |
| GLFWscrollfun | glfwSetScrollCallback (GLFWwindow *window, GLFWscrollfun callback) |
| Sets the scroll callback. More... | |
| GLFWdropfun | glfwSetDropCallback (GLFWwindow *window, GLFWdropfun callback) |
| Sets the path drop callback. More... | |
| int | glfwJoystickPresent (int jid) |
| Returns whether the specified joystick is present. More... | |
| const float * | glfwGetJoystickAxes (int jid, int *count) |
| Returns the values of all axes of the specified joystick. More... | |
| const unsigned char * | glfwGetJoystickButtons (int jid, int *count) |
| Returns the state of all buttons of the specified joystick. More... | |
| const unsigned char * | glfwGetJoystickHats (int jid, int *count) |
| Returns the state of all hats of the specified joystick. More... | |
| const char * | glfwGetJoystickName (int jid) |
| Returns the name of the specified joystick. More... | |
| const char * | glfwGetJoystickGUID (int jid) |
| Returns the SDL compatible GUID of the specified joystick. More... | |
| void | glfwSetJoystickUserPointer (int jid, void *pointer) |
| Sets the user pointer of the specified joystick. More... | |
| void * | glfwGetJoystickUserPointer (int jid) |
| Returns the user pointer of the specified joystick. More... | |
| int | glfwJoystickIsGamepad (int jid) |
| Returns whether the specified joystick has a gamepad mapping. More... | |
| GLFWjoystickfun | glfwSetJoystickCallback (GLFWjoystickfun callback) |
| Sets the joystick configuration callback. More... | |
| int | glfwUpdateGamepadMappings (const char *string) |
| Adds the specified SDL_GameControllerDB gamepad mappings. More... | |
| const char * | glfwGetGamepadName (int jid) |
| Returns the human-readable gamepad name for the specified joystick. More... | |
| int | glfwGetGamepadState (int jid, GLFWgamepadstate *state) |
| Retrieves the state of the specified joystick remapped as a gamepad. More... | |
| void | glfwSetClipboardString (GLFWwindow *window, const char *string) |
| Sets the clipboard to the specified string. More... | |
| const char * | glfwGetClipboardString (GLFWwindow *window) |
| Returns the contents of the clipboard as a string. More... | |
| double | glfwGetTime (void) |
| Returns the GLFW time. More... | |
| void | glfwSetTime (double time) |
| Sets the GLFW time. More... | |
| uint64_t | glfwGetTimerValue (void) |
| Returns the current value of the raw timer. More... | |
| uint64_t | glfwGetTimerFrequency (void) |
| Returns the frequency, in Hz, of the raw timer. More... | |
Macro Definition Documentation
+ +◆ GLFW_RELEASE
+ +| #define GLFW_RELEASE 0 | +
The key or mouse button was released.
+ +◆ GLFW_PRESS
+ +| #define GLFW_PRESS 1 | +
The key or mouse button was pressed.
+ +◆ GLFW_REPEAT
+ +| #define GLFW_REPEAT 2 | +
The key was held down until it repeated.
+ +Typedef Documentation
+ +◆ GLFWcursor
+ +| typedef struct GLFWcursor GLFWcursor | +
◆ GLFWmousebuttonfun
+ +| typedef void(* GLFWmousebuttonfun) (GLFWwindow *window, int button, int action, int mods) | +
This is the function pointer type for mouse button callback functions. A mouse button callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] button The mouse button that was pressed or released. [in] action One of GLFW_PRESSorGLFW_RELEASE. Future releases may add more actions.[in] mods Bit field describing which modifier keys were held down.
+
- See also
- Mouse button input +
- +glfwSetMouseButtonCallback
- Since
- Added in version 1.0. GLFW 3: Added window handle and modifier mask parameters.
◆ GLFWcursorposfun
+ +| typedef void(* GLFWcursorposfun) (GLFWwindow *window, double xpos, double ypos) | +
This is the function pointer type for cursor position callbacks. A cursor position callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] xpos The new cursor x-coordinate, relative to the left edge of the content area. [in] ypos The new cursor y-coordinate, relative to the top edge of the content area.
+
- See also
- Cursor position +
- +glfwSetCursorPosCallback
- Since
- Added in version 3.0. Replaces
GLFWmouseposfun.
◆ GLFWcursorenterfun
+ +| typedef void(* GLFWcursorenterfun) (GLFWwindow *window, int entered) | +
This is the function pointer type for cursor enter/leave callbacks. A cursor enter/leave callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] entered GLFW_TRUEif the cursor entered the window's content area, orGLFW_FALSEif it left it.
+
- Since
- Added in version 3.0.
◆ GLFWscrollfun
+ +| typedef void(* GLFWscrollfun) (GLFWwindow *window, double xoffset, double yoffset) | +
This is the function pointer type for scroll callbacks. A scroll callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] xoffset The scroll offset along the x-axis. [in] yoffset The scroll offset along the y-axis.
+
- See also
- Scroll input +
- +glfwSetScrollCallback
- Since
- Added in version 3.0. Replaces
GLFWmousewheelfun.
◆ GLFWkeyfun
+ +| typedef void(* GLFWkeyfun) (GLFWwindow *window, int key, int scancode, int action, int mods) | +
This is the function pointer type for keyboard key callbacks. A keyboard key callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] key The keyboard key that was pressed or released. [in] scancode The system-specific scancode of the key. [in] action GLFW_PRESS,GLFW_RELEASEorGLFW_REPEAT. Future releases may add more actions.[in] mods Bit field describing which modifier keys were held down.
+
- See also
- Key input +
- +glfwSetKeyCallback
- Since
- Added in version 1.0. GLFW 3: Added window handle, scancode and modifier mask parameters.
◆ GLFWcharfun
+ +| typedef void(* GLFWcharfun) (GLFWwindow *window, unsigned int codepoint) | +
This is the function pointer type for Unicode character callbacks. A Unicode character callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] codepoint The Unicode code point of the character.
+
- See also
- Text input +
- +glfwSetCharCallback
- Since
- Added in version 2.4. GLFW 3: Added window handle parameter.
◆ GLFWcharmodsfun
+ +| typedef void(* GLFWcharmodsfun) (GLFWwindow *window, unsigned int codepoint, int mods) | +
This is the function pointer type for Unicode character with modifiers callbacks. It is called for each input character, regardless of what modifier keys are held down. A Unicode character with modifiers callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] codepoint The Unicode code point of the character. [in] mods Bit field describing which modifier keys were held down.
+
- See also
- Text input +
- +glfwSetCharModsCallback
- Deprecated:
- Scheduled for removal in version 4.0.
- Since
- Added in version 3.1.
◆ GLFWdropfun
+ +| typedef void(* GLFWdropfun) (GLFWwindow *window, int path_count, const char *paths[]) | +
This is the function pointer type for path drop callbacks. A path drop callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that received the event. [in] path_count The number of dropped paths. [in] paths The UTF-8 encoded file and/or directory path names.
+
- Pointer lifetime
- The path array and its strings are valid until the callback function returns.
- See also
- Path drop input +
- +glfwSetDropCallback
- Since
- Added in version 3.1.
◆ GLFWjoystickfun
+ +| typedef void(* GLFWjoystickfun) (int jid, int event) | +
This is the function pointer type for joystick configuration callbacks. A joystick configuration callback function has the following signature:
- Parameters
-
+
+
+[in] jid The joystick that was connected or disconnected. [in] event One of GLFW_CONNECTEDorGLFW_DISCONNECTED. Future releases may add more events.
+
- Since
- Added in version 3.2.
◆ GLFWgamepadstate
+ +| typedef struct GLFWgamepadstate GLFWgamepadstate | +
This describes the input state of a gamepad.
+- See also
- Gamepad input +
- +glfwGetGamepadState
- Since
- Added in version 3.3.
Function Documentation
+ +◆ glfwGetInputMode()
+ +| int glfwGetInputMode | +( | +GLFWwindow * | +window, | +
| + | + | int | +mode | +
| + | ) | ++ |
This function returns the value of an input option for the specified window. The mode must be one of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.
+- Parameters
-
+
+
+[in] window The window to query. [in] mode One of GLFW_CURSOR,GLFW_STICKY_KEYS,GLFW_STICKY_MOUSE_BUTTONS,GLFW_LOCK_KEY_MODSorGLFW_RAW_MOUSE_MOTION.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- glfwSetInputMode
- Since
- Added in version 3.0.
◆ glfwSetInputMode()
+ +| void glfwSetInputMode | +( | +GLFWwindow * | +window, | +
| + | + | int | +mode, | +
| + | + | int | +value | +
| + | ) | ++ |
This function sets an input mode option for the specified window. The mode must be one of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.
+If the mode is GLFW_CURSOR, the value must be one of the following cursor modes:
-
+
GLFW_CURSOR_NORMALmakes the cursor visible and behaving normally.
+GLFW_CURSOR_HIDDENmakes the cursor invisible when it is over the content area of the window but does not restrict the cursor from leaving.
+GLFW_CURSOR_DISABLEDhides 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 GLFW_TRUE to enable sticky keys, or GLFW_FALSE to disable it. If sticky keys are enabled, a key press will ensure that 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 GLFW_TRUE to enable sticky mouse buttons, or GLFW_FALSE to disable it. If sticky mouse buttons are enabled, a mouse button press will ensure that 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.
If the mode is GLFW_LOCK_KEY_MODS, the value must be either GLFW_TRUE to enable lock key modifier bits, or GLFW_FALSE to disable them. If enabled, callbacks that receive modifier bits will also have the GLFW_MOD_CAPS_LOCK bit set when the event was generated with Caps Lock on, and the GLFW_MOD_NUM_LOCK bit when Num Lock was on.
If the mode is GLFW_RAW_MOUSE_MOTION, the value must be either GLFW_TRUE to enable raw (unscaled and unaccelerated) mouse motion when the cursor is disabled, or GLFW_FALSE to disable it. If raw motion is not supported, attempting to set this will emit GLFW_PLATFORM_ERROR. Call glfwRawMouseMotionSupported to check for support.
- Parameters
-
+
+
+[in] window The window whose input mode to set. [in] mode One of GLFW_CURSOR,GLFW_STICKY_KEYS,GLFW_STICKY_MOUSE_BUTTONS,GLFW_LOCK_KEY_MODSorGLFW_RAW_MOUSE_MOTION.[in] value The new value of the specified input mode.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- glfwGetInputMode
- Since
- Added in version 3.0. Replaces
glfwEnableandglfwDisable.
◆ glfwRawMouseMotionSupported()
+ +| int glfwRawMouseMotionSupported | +( | +void | +) | ++ |
This function returns whether raw mouse motion is supported on the current system. This status does not change after GLFW has been initialized so you only need to check this once. If you attempt to enable raw motion on a system that does not support it, GLFW_PLATFORM_ERROR will be emitted.
+Raw mouse motion is closer to the actual motion of the mouse across a surface. It is not affected by the scaling and acceleration applied to the motion of the desktop cursor. That processing is suitable for a cursor while raw motion is better for controlling for example a 3D camera. Because of this, raw mouse motion is only provided when the cursor is disabled.
+- Returns
GLFW_TRUEif raw mouse motion is supported on the current machine, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Raw mouse motion +
- +glfwSetInputMode
- Since
- Added in version 3.3.
◆ glfwGetKeyName()
+ +| const char * glfwGetKeyName | +( | +int | +key, | +
| + | + | int | +scancode | +
| + | ) | ++ |
This function returns the name of the specified printable key, encoded as UTF-8. This is typically the character that key would produce without any modifier keys, intended for displaying key bindings to the user. For dead keys, it is typically the diacritic it would add to a character.
+Do not use this function for text input. You will break text input for many languages even if it happens to work for yours.
+If the key is GLFW_KEY_UNKNOWN, the scancode is used to identify the key, otherwise the scancode is ignored. If you specify a non-printable key, or GLFW_KEY_UNKNOWN and a scancode that maps to a non-printable key, this function returns NULL but does not emit an error.
This behavior allows you to always pass in the arguments in the key callback without modification.
+The printable keys are:
-
+
GLFW_KEY_APOSTROPHE
+GLFW_KEY_COMMA
+GLFW_KEY_MINUS
+GLFW_KEY_PERIOD
+GLFW_KEY_SLASH
+GLFW_KEY_SEMICOLON
+GLFW_KEY_EQUAL
+GLFW_KEY_LEFT_BRACKET
+GLFW_KEY_RIGHT_BRACKET
+GLFW_KEY_BACKSLASH
+GLFW_KEY_WORLD_1
+GLFW_KEY_WORLD_2
+GLFW_KEY_0toGLFW_KEY_9
+GLFW_KEY_AtoGLFW_KEY_Z
+GLFW_KEY_KP_0toGLFW_KEY_KP_9
+GLFW_KEY_KP_DECIMAL
+GLFW_KEY_KP_DIVIDE
+GLFW_KEY_KP_MULTIPLY
+GLFW_KEY_KP_SUBTRACT
+GLFW_KEY_KP_ADD
+GLFW_KEY_KP_EQUAL
+
Names for printable keys depend on keyboard layout, while names for non-printable keys are the same across layouts but depend on the application language and should be localized along with other user interface text.
+- Parameters
-
+
+
+[in] key The key to query, or GLFW_KEY_UNKNOWN.[in] scancode The scancode of the key to query.
+
- Returns
- The UTF-8 encoded, layout-specific name of the key, or
NULL.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- The contents of the returned string may change when a keyboard layout change event is received.
- Pointer lifetime
- The returned string is allocated and freed by GLFW. You should not free it yourself. It is valid until the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Key names
- Since
- Added in version 3.2.
◆ glfwGetKeyScancode()
+ +| int glfwGetKeyScancode | +( | +int | +key | ) | ++ |
This function returns the platform-specific scancode of the specified key.
+If the key is GLFW_KEY_UNKNOWN or does not exist on the keyboard this method will return -1.
- Parameters
-
+
+
+[in] key Any named key.
+
- Returns
- The platform-specific scancode for the key, or
-1if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- Thread safety
- This function may be called from any thread.
- See also
- Key input
- Since
- Added in version 3.3.
◆ glfwGetKey()
+ +| int glfwGetKey | +( | +GLFWwindow * | +window, | +
| + | + | int | +key | +
| + | ) | ++ |
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 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 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 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 are not key tokens and cannot be used with this function.
+Do not use this function to implement text input.
+- Parameters
-
+
+
+[in] window The desired window. [in] key The desired keyboard key. GLFW_KEY_UNKNOWNis not a valid key for this function.
+
- Returns
- One of
GLFW_PRESSorGLFW_RELEASE.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- Key input
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwGetMouseButton()
+ +| int glfwGetMouseButton | +( | +GLFWwindow * | +window, | +
| + | + | int | +button | +
| + | ) | ++ |
This function returns the last state reported for the specified mouse button 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 it for a mouse button that was pressed, even if that mouse button has already been released.
- Parameters
-
+
+
+[in] window The desired window. [in] button The desired mouse button.
+
- Returns
- One of
GLFW_PRESSorGLFW_RELEASE.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- Mouse button input
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwGetCursorPos()
+ +| void glfwGetCursorPos | +( | +GLFWwindow * | +window, | +
| + | + | double * | +xpos, | +
| + | + | double * | +ypos | +
| + | ) | ++ |
This function returns the position of the cursor, in screen coordinates, relative to the upper-left corner of the content 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 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.
Any or all of the position arguments may be NULL. If an error occurs, all non-NULL position arguments will be set to zero.
- Parameters
-
+
+
+[in] window The desired window. [out] xpos Where to store the cursor x-coordinate, relative to the left edge of the content area, or NULL.[out] ypos Where to store the cursor y-coordinate, relative to the to top edge of the content area, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor position +
- +glfwSetCursorPos
- Since
- Added in version 3.0. Replaces
glfwGetMousePos.
◆ glfwSetCursorPos()
+ +| void glfwSetCursorPos | +( | +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 content area of the specified window. The window must have input focus. If the window does not have input focus when this function is called, it fails silently.
+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 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.
- Parameters
-
+
+
+[in] window The desired window. [in] xpos The desired x-coordinate, relative to the left edge of the content area. [in] ypos The desired y-coordinate, relative to the top edge of the content area.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: This function will only work when the cursor mode is
GLFW_CURSOR_DISABLED, otherwise it will do nothing.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor position +
- +glfwGetCursorPos
- Since
- Added in version 3.0. Replaces
glfwSetMousePos.
◆ glfwCreateCursor()
+ +| GLFWcursor * glfwCreateCursor | +( | +const GLFWimage * | +image, | +
| + | + | int | +xhot, | +
| + | + | int | +yhot | +
| + | ) | ++ |
Creates a new custom cursor image that can be set for a window with glfwSetCursor. The cursor can be destroyed with glfwDestroyCursor. Any remaining cursors are destroyed by glfwTerminate.
+The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. 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.
+- Parameters
-
+
+
+[in] image The desired cursor image. [in] xhot The desired x-coordinate, in pixels, of the cursor hotspot. [in] yhot The desired y-coordinate, in pixels, of the cursor hotspot.
+
- Returns
- The handle of the created cursor, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Pointer lifetime
- The specified image data is copied before this function returns.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor objects +
- +glfwDestroyCursor +
- +glfwCreateStandardCursor
- Since
- Added in version 3.1.
◆ glfwCreateStandardCursor()
+ +| GLFWcursor * glfwCreateStandardCursor | +( | +int | +shape | ) | ++ |
Returns a cursor with a standard shape, that can be set for a window with glfwSetCursor.
+- Parameters
-
+
+
+[in] shape One of the standard shapes.
+
- Returns
- A new cursor ready to use or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor objects +
- +glfwCreateCursor
- Since
- Added in version 3.1.
◆ glfwDestroyCursor()
+ +| void glfwDestroyCursor | +( | +GLFWcursor * | +cursor | ) | ++ |
This function destroys a cursor previously created with glfwCreateCursor. Any remaining cursors will be destroyed by glfwTerminate.
+If the specified cursor is current for any window, that window will be reverted to the default cursor. This does not affect the cursor mode.
+- Parameters
-
+
+
+[in] cursor The cursor object to destroy.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor objects +
- +glfwCreateCursor
- Since
- Added in version 3.1.
◆ glfwSetCursor()
+ +| void glfwSetCursor | +( | +GLFWwindow * | +window, | +
| + | + | GLFWcursor * | +cursor | +
| + | ) | ++ |
This function sets the cursor image to be used when the cursor is over the content area of the specified window. The set cursor will only be visible when the 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.
+- Parameters
-
+
+
+[in] window The window to set the cursor for. [in] cursor The cursor to set, or NULLto switch back to the default arrow cursor.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor objects
- Since
- Added in version 3.1.
◆ glfwSetKeyCallback()
+ +| GLFWkeyfun glfwSetKeyCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWkeyfun | +callback | +
| + | ) | ++ |
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 key tokens named after their values in the standard US keyboard layout. If you want to input text, use the character callback instead.
+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 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 queried with glfwGetKey.
Sometimes GLFW needs to generate synthetic key events, in which case the scancode may be zero.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new key callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Key input
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter and return value.
◆ glfwSetCharCallback()
+ +| GLFWcharfun glfwSetCharCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWcharfun | +callback | +
| + | ) | ++ |
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 Unicode text input. As it deals with characters, it is keyboard layout dependent, whereas the key callback 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 macOS or Alt key on Windows.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Text input
- Since
- Added in version 2.4. GLFW 3: Added window handle parameter and return value.
◆ glfwSetCharModsCallback()
+ +| GLFWcharmodsfun glfwSetCharModsCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWcharmodsfun | +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. 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 instead.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or an error occurred.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Deprecated:
- Scheduled for removal in version 4.0.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Text input
- Since
- Added in version 3.1.
◆ glfwSetMouseButtonCallback()
+ +| GLFWmousebuttonfun glfwSetMouseButtonCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWmousebuttonfun | +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 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 has been called.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Mouse button input
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter and return value.
◆ glfwSetCursorPosCallback()
+ +| GLFWcursorposfun glfwSetCursorPosCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWcursorposfun | +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, in screen coordinates, relative to the upper-left corner of the content area of the window.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor position
- Since
- Added in version 3.0. Replaces
glfwSetMousePosCallback.
◆ glfwSetCursorEnterCallback()
+ +| GLFWcursorenterfun glfwSetCursorEnterCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWcursorenterfun | +callback | +
| + | ) | ++ |
This function sets the cursor boundary crossing callback of the specified window, which is called when the cursor enters or leaves the content area of the window.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Cursor enter/leave events
- Since
- Added in version 3.0.
◆ glfwSetScrollCallback()
+ +| GLFWscrollfun glfwSetScrollCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWscrollfun | +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.
+The scroll callback receives all scrolling input, like that from a mouse wheel or a touchpad scrolling area.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new scroll callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Scroll input
- Since
- Added in version 3.0. Replaces
glfwSetMouseWheelCallback.
◆ glfwSetDropCallback()
+ +| GLFWdropfun glfwSetDropCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWdropfun | +callback | +
| + | ) | ++ |
This function sets the path drop callback of the specified window, which is called when one or more dragged paths 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.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new file drop callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- Wayland: File drop is currently unimplemented.
- Thread safety
- This function must only be called from the main thread.
- See also
- Path drop input
- Since
- Added in version 3.1.
◆ glfwJoystickPresent()
+ +| int glfwJoystickPresent | +( | +int | +jid | ) | ++ |
This function returns whether the specified joystick is present.
+There is no need to call this function before other functions that accept a joystick ID, as they all check for presence before performing any other work.
+- Parameters
-
+
+
+[in] jid The joystick to query.
+
- Returns
GLFW_TRUEif the joystick is present, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick input
- Since
- Added in version 3.0. Replaces
glfwGetJoystickParam.
◆ glfwGetJoystickAxes()
+ +| const float * glfwGetJoystickAxes | +( | +int | +jid, | +
| + | + | int * | +count | +
| + | ) | ++ |
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.
+If the specified joystick is not present this function will return NULL but will not generate an error. This can be used instead of first calling glfwJoystickPresent.
- Parameters
-
+
+
+[in] jid The joystick to query. [out] count Where to store the number of axis values in the returned array. This is set to zero if the joystick is not present or an error occurred.
+
- Returns
- An array of axis values, or
NULLif the joystick is not present or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- 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 or the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick axis states
- Since
- Added in version 3.0. Replaces
glfwGetJoystickPos.
◆ glfwGetJoystickButtons()
+ +| const unsigned char * glfwGetJoystickButtons | +( | +int | +jid, | +
| + | + | int * | +count | +
| + | ) | ++ |
This function returns the state of all buttons of the specified joystick. Each element in the array is either GLFW_PRESS or GLFW_RELEASE.
For backward compatibility with earlier versions that did not have glfwGetJoystickHats, the button array also includes all hats, each represented as four buttons. The hats are in the same order as returned by glfwGetJoystickHats and are in the order up, right, down and left. To disable these extra buttons, set the GLFW_JOYSTICK_HAT_BUTTONS init hint before initialization.
+If the specified joystick is not present this function will return NULL but will not generate an error. This can be used instead of first calling glfwJoystickPresent.
- Parameters
-
+
+
+[in] jid The joystick to query. [out] count Where to store the number of button states in the returned array. This is set to zero if the joystick is not present or an error occurred.
+
- Returns
- An array of button states, or
NULLif the joystick is not present or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- 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 or the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick button states
- Since
- Added in version 2.2. GLFW 3: Changed to return a dynamic array.
◆ glfwGetJoystickHats()
+ +| const unsigned char * glfwGetJoystickHats | +( | +int | +jid, | +
| + | + | int * | +count | +
| + | ) | ++ |
This function returns the state of all hats of the specified joystick. Each element in the array is one of the following values:
+| Name | Value |
|---|---|
GLFW_HAT_CENTERED | 0 |
GLFW_HAT_UP | 1 |
GLFW_HAT_RIGHT | 2 |
GLFW_HAT_DOWN | 4 |
GLFW_HAT_LEFT | 8 |
GLFW_HAT_RIGHT_UP | GLFW_HAT_RIGHT | GLFW_HAT_UP |
GLFW_HAT_RIGHT_DOWN | GLFW_HAT_RIGHT | GLFW_HAT_DOWN |
GLFW_HAT_LEFT_UP | GLFW_HAT_LEFT | GLFW_HAT_UP |
GLFW_HAT_LEFT_DOWN | GLFW_HAT_LEFT | GLFW_HAT_DOWN |
The diagonal directions are bitwise combinations of the primary (up, right, down and left) directions and you can test for these individually by ANDing it with the corresponding direction.
+If the specified joystick is not present this function will return NULL but will not generate an error. This can be used instead of first calling glfwJoystickPresent.
- Parameters
-
+
+
+[in] jid The joystick to query. [out] count Where to store the number of hat states in the returned array. This is set to zero if the joystick is not present or an error occurred.
+
- Returns
- An array of hat states, or
NULLif the joystick is not present or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- 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.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick hat states
- Since
- Added in version 3.3.
◆ glfwGetJoystickName()
+ +| const char * glfwGetJoystickName | +( | +int | +jid | ) | ++ |
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.
+If the specified joystick is not present this function will return NULL but will not generate an error. This can be used instead of first calling glfwJoystickPresent.
- Parameters
-
+
+
+[in] jid The joystick to query.
+
- Returns
- The UTF-8 encoded name of the joystick, or
NULLif the joystick is not present or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- 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 or the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick name
- Since
- Added in version 3.0.
◆ glfwGetJoystickGUID()
+ +| const char * glfwGetJoystickGUID | +( | +int | +jid | ) | ++ |
This function returns the SDL compatible GUID, as a UTF-8 encoded hexadecimal string, of the specified joystick. The returned string is allocated and freed by GLFW. You should not free it yourself.
+The GUID is what connects a joystick to a gamepad mapping. A connected joystick will always have a GUID even if there is no gamepad mapping assigned to it.
+If the specified joystick is not present this function will return NULL but will not generate an error. This can be used instead of first calling glfwJoystickPresent.
The GUID uses the format introduced in SDL 2.0.5. This GUID tries to uniquely identify the make and model of a joystick but does not identify a specific unit, e.g. all wired Xbox 360 controllers will have the same GUID on that platform. The GUID for a unit may vary between platforms depending on what hardware information the platform specific APIs provide.
+- Parameters
-
+
+
+[in] jid The joystick to query.
+
- Returns
- The UTF-8 encoded GUID of the joystick, or
NULLif the joystick is not present or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- 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 or the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamepad input
- Since
- Added in version 3.3.
◆ glfwSetJoystickUserPointer()
+ +| void glfwSetJoystickUserPointer | +( | +int | +jid, | +
| + | + | void * | +pointer | +
| + | ) | ++ |
This function sets the user-defined pointer of the specified joystick. The current value is retained until the joystick is disconnected. The initial value is NULL.
This function may be called from the joystick callback, even for a joystick that is being disconnected.
+- Parameters
-
+
+
+[in] jid The joystick whose pointer to set. [in] pointer The new value.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- Joystick user pointer +
- +glfwGetJoystickUserPointer
- Since
- Added in version 3.3.
◆ glfwGetJoystickUserPointer()
+ +| void * glfwGetJoystickUserPointer | +( | +int | +jid | ) | ++ |
This function returns the current value of the user-defined pointer of the specified joystick. The initial value is NULL.
This function may be called from the joystick callback, even for a joystick that is being disconnected.
+- Parameters
-
+
+
+[in] jid The joystick whose pointer to return.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- Joystick user pointer +
- +glfwSetJoystickUserPointer
- Since
- Added in version 3.3.
◆ glfwJoystickIsGamepad()
+ +| int glfwJoystickIsGamepad | +( | +int | +jid | ) | ++ |
This function returns whether the specified joystick is both present and has a gamepad mapping.
+If the specified joystick is present but does not have a gamepad mapping this function will return GLFW_FALSE but will not generate an error. Call glfwJoystickPresent to check if a joystick is present regardless of whether it has a mapping.
- Parameters
-
+
+
+[in] jid The joystick to query.
+
- Returns
GLFW_TRUEif a joystick is both present and has a gamepad mapping, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamepad input +
- +glfwGetGamepadState
- Since
- Added in version 3.3.
◆ glfwSetJoystickCallback()
+ +| GLFWjoystickfun glfwSetJoystickCallback | +( | +GLFWjoystickfun | +callback | ) | ++ |
This function sets the joystick configuration callback, or removes the currently set callback. This is called when a joystick is connected to or disconnected from the system.
+For joystick connection and disconnection events to be delivered on all platforms, you need to call one of the event processing functions. Joystick disconnection may also be detected and the callback called by joystick functions. The function will then return whatever it returns if the joystick is not present.
+- Parameters
-
+
+
+[in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- For more information about the callback parameters, see the function pointer type.void function_name(int jid, int event)+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Joystick configuration changes
- Since
- Added in version 3.2.
◆ glfwUpdateGamepadMappings()
+ +| int glfwUpdateGamepadMappings | +( | +const char * | +string | ) | ++ |
This function parses the specified ASCII encoded string and updates the internal list with any gamepad mappings it finds. This string may contain either a single gamepad mapping or many mappings separated by newlines. The parser supports the full format of the gamecontrollerdb.txt source file including empty lines and comments.
See Gamepad mappings for a description of the format.
+If there is already a gamepad mapping for a given GUID in the internal list, it will be replaced by the one passed to this function. If the library is terminated and re-initialized the internal list will revert to the built-in default.
+- Parameters
-
+
+
+[in] string The string containing the gamepad mappings.
+
- Returns
GLFW_TRUEif successful, orGLFW_FALSEif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_VALUE.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamepad input +
- +glfwJoystickIsGamepad +
- +glfwGetGamepadName
- Since
- Added in version 3.3.
◆ glfwGetGamepadName()
+ +| const char * glfwGetGamepadName | +( | +int | +jid | ) | ++ |
This function returns the human-readable name of the gamepad from the gamepad mapping assigned to the specified joystick.
+If the specified joystick is not present or does not have a gamepad mapping this function will return NULL but will not generate an error. Call glfwJoystickPresent to check whether it is present regardless of whether it has a mapping.
- Parameters
-
+
+
+[in] jid The joystick to query.
+
- Returns
- The UTF-8 encoded name of the gamepad, or
NULLif the joystick is not present, does not have a mapping or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- 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, the gamepad mappings are updated or the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamepad input +
- +glfwJoystickIsGamepad
- Since
- Added in version 3.3.
◆ glfwGetGamepadState()
+ +| int glfwGetGamepadState | +( | +int | +jid, | +
| + | + | GLFWgamepadstate * | +state | +
| + | ) | ++ |
This function retrieves the state of the specified joystick remapped to an Xbox-like gamepad.
+If the specified joystick is not present or does not have a gamepad mapping this function will return GLFW_FALSE but will not generate an error. Call glfwJoystickPresent to check whether it is present regardless of whether it has a mapping.
The Guide button may not be available for input as it is often hooked by the system or the Steam client.
+Not all devices have all the buttons or axes provided by GLFWgamepadstate. Unavailable buttons and axes will always report GLFW_RELEASE and 0.0 respectively.
- Parameters
-
+
+
+[in] jid The joystick to query. [out] state The gamepad input state of the joystick.
+
- Returns
GLFW_TRUEif successful, orGLFW_FALSEif no joystick is connected, it has no gamepad mapping or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamepad input +
- +glfwUpdateGamepadMappings +
- +glfwJoystickIsGamepad
- Since
- Added in version 3.3.
◆ glfwSetClipboardString()
+ +| void glfwSetClipboardString | +( | +GLFWwindow * | +window, | +
| + | + | const char * | +string | +
| + | ) | ++ |
This function sets the system clipboard to the specified, UTF-8 encoded string.
+- Parameters
-
+
+
+[in] window Deprecated. Any valid window or NULL.[in] string A UTF-8 encoded string.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Pointer lifetime
- The specified string is copied before this function returns.
- Thread safety
- This function must only be called from the main thread.
- See also
- Clipboard input and output +
- +glfwGetClipboardString
- Since
- Added in version 3.0.
◆ glfwGetClipboardString()
+ +| const char * glfwGetClipboardString | +( | +GLFWwindow * | +window | ) | ++ |
This function returns the contents of the system clipboard, if it contains or is convertible to a UTF-8 encoded string. If the clipboard is empty or if its contents cannot be converted, NULL is returned and a GLFW_FORMAT_UNAVAILABLE error is generated.
- Parameters
-
+
+
+[in] window Deprecated. Any valid window or NULL.
+
- Returns
- The contents of the clipboard as a UTF-8 encoded string, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_FORMAT_UNAVAILABLE and GLFW_PLATFORM_ERROR.
- 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 glfwGetClipboardString or glfwSetClipboardString, or until the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- See also
- Clipboard input and output +
- +glfwSetClipboardString
- Since
- Added in version 3.0.
◆ glfwGetTime()
+ +| double glfwGetTime | +( | +void | +) | ++ |
This function returns the current GLFW time, in seconds. Unless the time has been set using glfwSetTime it measures time elapsed since GLFW was initialized.
+This function and glfwSetTime are helper functions on top of glfwGetTimerFrequency and glfwGetTimerValue.
+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.
+- Returns
- The current time, in seconds, or zero if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Reading and writing of the internal base time is not atomic, so it needs to be externally synchronized with calls to glfwSetTime.
- See also
- Time input
- Since
- Added in version 1.0.
◆ glfwSetTime()
+ +| void glfwSetTime | +( | +double | +time | ) | ++ |
This function sets the current GLFW time, in seconds. The value must be a positive finite number less than or equal to 18446744073.0, which is approximately 584.5 years.
+This function and glfwGetTime are helper functions on top of glfwGetTimerFrequency and glfwGetTimerValue.
+- Parameters
-
+
+
+[in] time The new value, in seconds.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_VALUE.
- Remarks
- The upper limit of GLFW time is calculated as floor((264 - 1) / 109) and is due to implementations storing nanoseconds in 64 bits. The limit may be increased in the future.
- Thread safety
- This function may be called from any thread. Reading and writing of the internal base time is not atomic, so it needs to be externally synchronized with calls to glfwGetTime.
- See also
- Time input
- Since
- Added in version 2.2.
◆ glfwGetTimerValue()
+ +| uint64_t glfwGetTimerValue | +( | +void | +) | ++ |
This function returns the current value of the raw timer, measured in 1 / frequency seconds. To get the frequency, call glfwGetTimerFrequency.
+- Returns
- The value of the timer, or zero if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread.
- See also
- Time input +
- +glfwGetTimerFrequency
- Since
- Added in version 3.2.
◆ glfwGetTimerFrequency()
+ +| uint64_t glfwGetTimerFrequency | +( | +void | +) | ++ |
This function returns the frequency, in Hz, of the raw timer.
+- Returns
- The frequency of the timer, in Hz, or zero if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread.
- See also
- Time input +
- +glfwGetTimerValue
- Since
- Added in version 3.2.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__joysticks.html b/deps/glfw-3.3.8/docs/html/group__joysticks.html new file mode 100644 index 0000000..34f86b2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__joysticks.html @@ -0,0 +1,355 @@ + + + + + + + +Description
+See joystick input for how these are used.
++Macros | |
| #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 |
Macro Definition Documentation
+ +◆ GLFW_JOYSTICK_1
+ +| #define GLFW_JOYSTICK_1 0 | +
◆ GLFW_JOYSTICK_2
+ +| #define GLFW_JOYSTICK_2 1 | +
◆ GLFW_JOYSTICK_3
+ +| #define GLFW_JOYSTICK_3 2 | +
◆ GLFW_JOYSTICK_4
+ +| #define GLFW_JOYSTICK_4 3 | +
◆ GLFW_JOYSTICK_5
+ +| #define GLFW_JOYSTICK_5 4 | +
◆ GLFW_JOYSTICK_6
+ +| #define GLFW_JOYSTICK_6 5 | +
◆ GLFW_JOYSTICK_7
+ +| #define GLFW_JOYSTICK_7 6 | +
◆ GLFW_JOYSTICK_8
+ +| #define GLFW_JOYSTICK_8 7 | +
◆ GLFW_JOYSTICK_9
+ +| #define GLFW_JOYSTICK_9 8 | +
◆ GLFW_JOYSTICK_10
+ +| #define GLFW_JOYSTICK_10 9 | +
◆ GLFW_JOYSTICK_11
+ +| #define GLFW_JOYSTICK_11 10 | +
◆ GLFW_JOYSTICK_12
+ +| #define GLFW_JOYSTICK_12 11 | +
◆ GLFW_JOYSTICK_13
+ +| #define GLFW_JOYSTICK_13 12 | +
◆ GLFW_JOYSTICK_14
+ +| #define GLFW_JOYSTICK_14 13 | +
◆ GLFW_JOYSTICK_15
+ +| #define GLFW_JOYSTICK_15 14 | +
◆ GLFW_JOYSTICK_16
+ +| #define GLFW_JOYSTICK_16 15 | +
◆ GLFW_JOYSTICK_LAST
+ +| #define GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16 | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__keys.html b/deps/glfw-3.3.8/docs/html/group__keys.html new file mode 100644 index 0000000..f899864 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__keys.html @@ -0,0 +1,2043 @@ + + + + + + + +Description
+See key input for how these are used.
+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.) +
+Macros | |
| #define | GLFW_KEY_UNKNOWN -1 |
| #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 */ |
| #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 |
Macro Definition Documentation
+ +◆ GLFW_KEY_UNKNOWN
+ +| #define GLFW_KEY_UNKNOWN -1 | +
◆ GLFW_KEY_SPACE
+ +| #define GLFW_KEY_SPACE 32 | +
◆ GLFW_KEY_APOSTROPHE
+ +| #define GLFW_KEY_APOSTROPHE 39 /* ' */ | +
◆ GLFW_KEY_COMMA
+ +| #define GLFW_KEY_COMMA 44 /* , */ | +
◆ GLFW_KEY_MINUS
+ +| #define GLFW_KEY_MINUS 45 /* - */ | +
◆ GLFW_KEY_PERIOD
+ +| #define GLFW_KEY_PERIOD 46 /* . */ | +
◆ GLFW_KEY_SLASH
+ +| #define GLFW_KEY_SLASH 47 /* / */ | +
◆ GLFW_KEY_0
+ +| #define GLFW_KEY_0 48 | +
◆ GLFW_KEY_1
+ +| #define GLFW_KEY_1 49 | +
◆ GLFW_KEY_2
+ +| #define GLFW_KEY_2 50 | +
◆ GLFW_KEY_3
+ +| #define GLFW_KEY_3 51 | +
◆ GLFW_KEY_4
+ +| #define GLFW_KEY_4 52 | +
◆ GLFW_KEY_5
+ +| #define GLFW_KEY_5 53 | +
◆ GLFW_KEY_6
+ +| #define GLFW_KEY_6 54 | +
◆ GLFW_KEY_7
+ +| #define GLFW_KEY_7 55 | +
◆ GLFW_KEY_8
+ +| #define GLFW_KEY_8 56 | +
◆ GLFW_KEY_9
+ +| #define GLFW_KEY_9 57 | +
◆ GLFW_KEY_SEMICOLON
+ +| #define GLFW_KEY_SEMICOLON 59 /* ; */ | +
◆ GLFW_KEY_EQUAL
+ +| #define GLFW_KEY_EQUAL 61 /* = */ | +
◆ GLFW_KEY_A
+ +| #define GLFW_KEY_A 65 | +
◆ GLFW_KEY_B
+ +| #define GLFW_KEY_B 66 | +
◆ GLFW_KEY_C
+ +| #define GLFW_KEY_C 67 | +
◆ GLFW_KEY_D
+ +| #define GLFW_KEY_D 68 | +
◆ GLFW_KEY_E
+ +| #define GLFW_KEY_E 69 | +
◆ GLFW_KEY_F
+ +| #define GLFW_KEY_F 70 | +
◆ GLFW_KEY_G
+ +| #define GLFW_KEY_G 71 | +
◆ GLFW_KEY_H
+ +| #define GLFW_KEY_H 72 | +
◆ GLFW_KEY_I
+ +| #define GLFW_KEY_I 73 | +
◆ GLFW_KEY_J
+ +| #define GLFW_KEY_J 74 | +
◆ GLFW_KEY_K
+ +| #define GLFW_KEY_K 75 | +
◆ GLFW_KEY_L
+ +| #define GLFW_KEY_L 76 | +
◆ GLFW_KEY_M
+ +| #define GLFW_KEY_M 77 | +
◆ GLFW_KEY_N
+ +| #define GLFW_KEY_N 78 | +
◆ GLFW_KEY_O
+ +| #define GLFW_KEY_O 79 | +
◆ GLFW_KEY_P
+ +| #define GLFW_KEY_P 80 | +
◆ GLFW_KEY_Q
+ +| #define GLFW_KEY_Q 81 | +
◆ GLFW_KEY_R
+ +| #define GLFW_KEY_R 82 | +
◆ GLFW_KEY_S
+ +| #define GLFW_KEY_S 83 | +
◆ GLFW_KEY_T
+ +| #define GLFW_KEY_T 84 | +
◆ GLFW_KEY_U
+ +| #define GLFW_KEY_U 85 | +
◆ GLFW_KEY_V
+ +| #define GLFW_KEY_V 86 | +
◆ GLFW_KEY_W
+ +| #define GLFW_KEY_W 87 | +
◆ GLFW_KEY_X
+ +| #define GLFW_KEY_X 88 | +
◆ GLFW_KEY_Y
+ +| #define GLFW_KEY_Y 89 | +
◆ GLFW_KEY_Z
+ +| #define GLFW_KEY_Z 90 | +
◆ GLFW_KEY_LEFT_BRACKET
+ +| #define GLFW_KEY_LEFT_BRACKET 91 /* [ */ | +
◆ GLFW_KEY_BACKSLASH
+ +| #define GLFW_KEY_BACKSLASH 92 /* \ */ | +
◆ GLFW_KEY_RIGHT_BRACKET
+ +| #define GLFW_KEY_RIGHT_BRACKET 93 /* ] */ | +
◆ GLFW_KEY_GRAVE_ACCENT
+ +| #define GLFW_KEY_GRAVE_ACCENT 96 /* ` */ | +
◆ GLFW_KEY_WORLD_1
+ +| #define GLFW_KEY_WORLD_1 161 /* non-US #1 */ | +
◆ GLFW_KEY_WORLD_2
+ +| #define GLFW_KEY_WORLD_2 162 /* non-US #2 */ | +
◆ GLFW_KEY_ESCAPE
+ +| #define GLFW_KEY_ESCAPE 256 | +
◆ GLFW_KEY_ENTER
+ +| #define GLFW_KEY_ENTER 257 | +
◆ GLFW_KEY_TAB
+ +| #define GLFW_KEY_TAB 258 | +
◆ GLFW_KEY_BACKSPACE
+ +| #define GLFW_KEY_BACKSPACE 259 | +
◆ GLFW_KEY_INSERT
+ +| #define GLFW_KEY_INSERT 260 | +
◆ GLFW_KEY_DELETE
+ +| #define GLFW_KEY_DELETE 261 | +
◆ GLFW_KEY_RIGHT
+ +| #define GLFW_KEY_RIGHT 262 | +
◆ GLFW_KEY_LEFT
+ +| #define GLFW_KEY_LEFT 263 | +
◆ GLFW_KEY_DOWN
+ +| #define GLFW_KEY_DOWN 264 | +
◆ GLFW_KEY_UP
+ +| #define GLFW_KEY_UP 265 | +
◆ GLFW_KEY_PAGE_UP
+ +| #define GLFW_KEY_PAGE_UP 266 | +
◆ GLFW_KEY_PAGE_DOWN
+ +| #define GLFW_KEY_PAGE_DOWN 267 | +
◆ GLFW_KEY_HOME
+ +| #define GLFW_KEY_HOME 268 | +
◆ GLFW_KEY_END
+ +| #define GLFW_KEY_END 269 | +
◆ GLFW_KEY_CAPS_LOCK
+ +| #define GLFW_KEY_CAPS_LOCK 280 | +
◆ GLFW_KEY_SCROLL_LOCK
+ +| #define GLFW_KEY_SCROLL_LOCK 281 | +
◆ GLFW_KEY_NUM_LOCK
+ +| #define GLFW_KEY_NUM_LOCK 282 | +
◆ GLFW_KEY_PRINT_SCREEN
+ +| #define GLFW_KEY_PRINT_SCREEN 283 | +
◆ GLFW_KEY_PAUSE
+ +| #define GLFW_KEY_PAUSE 284 | +
◆ GLFW_KEY_F1
+ +| #define GLFW_KEY_F1 290 | +
◆ GLFW_KEY_F2
+ +| #define GLFW_KEY_F2 291 | +
◆ GLFW_KEY_F3
+ +| #define GLFW_KEY_F3 292 | +
◆ GLFW_KEY_F4
+ +| #define GLFW_KEY_F4 293 | +
◆ GLFW_KEY_F5
+ +| #define GLFW_KEY_F5 294 | +
◆ GLFW_KEY_F6
+ +| #define GLFW_KEY_F6 295 | +
◆ GLFW_KEY_F7
+ +| #define GLFW_KEY_F7 296 | +
◆ GLFW_KEY_F8
+ +| #define GLFW_KEY_F8 297 | +
◆ GLFW_KEY_F9
+ +| #define GLFW_KEY_F9 298 | +
◆ GLFW_KEY_F10
+ +| #define GLFW_KEY_F10 299 | +
◆ GLFW_KEY_F11
+ +| #define GLFW_KEY_F11 300 | +
◆ GLFW_KEY_F12
+ +| #define GLFW_KEY_F12 301 | +
◆ GLFW_KEY_F13
+ +| #define GLFW_KEY_F13 302 | +
◆ GLFW_KEY_F14
+ +| #define GLFW_KEY_F14 303 | +
◆ GLFW_KEY_F15
+ +| #define GLFW_KEY_F15 304 | +
◆ GLFW_KEY_F16
+ +| #define GLFW_KEY_F16 305 | +
◆ GLFW_KEY_F17
+ +| #define GLFW_KEY_F17 306 | +
◆ GLFW_KEY_F18
+ +| #define GLFW_KEY_F18 307 | +
◆ GLFW_KEY_F19
+ +| #define GLFW_KEY_F19 308 | +
◆ GLFW_KEY_F20
+ +| #define GLFW_KEY_F20 309 | +
◆ GLFW_KEY_F21
+ +| #define GLFW_KEY_F21 310 | +
◆ GLFW_KEY_F22
+ +| #define GLFW_KEY_F22 311 | +
◆ GLFW_KEY_F23
+ +| #define GLFW_KEY_F23 312 | +
◆ GLFW_KEY_F24
+ +| #define GLFW_KEY_F24 313 | +
◆ GLFW_KEY_F25
+ +| #define GLFW_KEY_F25 314 | +
◆ GLFW_KEY_KP_0
+ +| #define GLFW_KEY_KP_0 320 | +
◆ GLFW_KEY_KP_1
+ +| #define GLFW_KEY_KP_1 321 | +
◆ GLFW_KEY_KP_2
+ +| #define GLFW_KEY_KP_2 322 | +
◆ GLFW_KEY_KP_3
+ +| #define GLFW_KEY_KP_3 323 | +
◆ GLFW_KEY_KP_4
+ +| #define GLFW_KEY_KP_4 324 | +
◆ GLFW_KEY_KP_5
+ +| #define GLFW_KEY_KP_5 325 | +
◆ GLFW_KEY_KP_6
+ +| #define GLFW_KEY_KP_6 326 | +
◆ GLFW_KEY_KP_7
+ +| #define GLFW_KEY_KP_7 327 | +
◆ GLFW_KEY_KP_8
+ +| #define GLFW_KEY_KP_8 328 | +
◆ GLFW_KEY_KP_9
+ +| #define GLFW_KEY_KP_9 329 | +
◆ GLFW_KEY_KP_DECIMAL
+ +| #define GLFW_KEY_KP_DECIMAL 330 | +
◆ GLFW_KEY_KP_DIVIDE
+ +| #define GLFW_KEY_KP_DIVIDE 331 | +
◆ GLFW_KEY_KP_MULTIPLY
+ +| #define GLFW_KEY_KP_MULTIPLY 332 | +
◆ GLFW_KEY_KP_SUBTRACT
+ +| #define GLFW_KEY_KP_SUBTRACT 333 | +
◆ GLFW_KEY_KP_ADD
+ +| #define GLFW_KEY_KP_ADD 334 | +
◆ GLFW_KEY_KP_ENTER
+ +| #define GLFW_KEY_KP_ENTER 335 | +
◆ GLFW_KEY_KP_EQUAL
+ +| #define GLFW_KEY_KP_EQUAL 336 | +
◆ GLFW_KEY_LEFT_SHIFT
+ +| #define GLFW_KEY_LEFT_SHIFT 340 | +
◆ GLFW_KEY_LEFT_CONTROL
+ +| #define GLFW_KEY_LEFT_CONTROL 341 | +
◆ GLFW_KEY_LEFT_ALT
+ +| #define GLFW_KEY_LEFT_ALT 342 | +
◆ GLFW_KEY_LEFT_SUPER
+ +| #define GLFW_KEY_LEFT_SUPER 343 | +
◆ GLFW_KEY_RIGHT_SHIFT
+ +| #define GLFW_KEY_RIGHT_SHIFT 344 | +
◆ GLFW_KEY_RIGHT_CONTROL
+ +| #define GLFW_KEY_RIGHT_CONTROL 345 | +
◆ GLFW_KEY_RIGHT_ALT
+ +| #define GLFW_KEY_RIGHT_ALT 346 | +
◆ GLFW_KEY_RIGHT_SUPER
+ +| #define GLFW_KEY_RIGHT_SUPER 347 | +
◆ GLFW_KEY_MENU
+ +| #define GLFW_KEY_MENU 348 | +
◆ GLFW_KEY_LAST
+ +| #define GLFW_KEY_LAST GLFW_KEY_MENU | +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__mods.html b/deps/glfw-3.3.8/docs/html/group__mods.html new file mode 100644 index 0000000..94fc54d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__mods.html @@ -0,0 +1,191 @@ + + + + + + + +Description
+See key input for how these are used.
++Macros | |
| #define | GLFW_MOD_SHIFT 0x0001 |
| If this bit is set one or more Shift keys were held down. More... | |
| #define | GLFW_MOD_CONTROL 0x0002 |
| If this bit is set one or more Control keys were held down. More... | |
| #define | GLFW_MOD_ALT 0x0004 |
| If this bit is set one or more Alt keys were held down. More... | |
| #define | GLFW_MOD_SUPER 0x0008 |
| If this bit is set one or more Super keys were held down. More... | |
| #define | GLFW_MOD_CAPS_LOCK 0x0010 |
| If this bit is set the Caps Lock key is enabled. More... | |
| #define | GLFW_MOD_NUM_LOCK 0x0020 |
| If this bit is set the Num Lock key is enabled. More... | |
Macro Definition Documentation
+ +◆ GLFW_MOD_SHIFT
+ +| #define GLFW_MOD_SHIFT 0x0001 | +
If this bit is set one or more Shift keys were held down.
+ +◆ GLFW_MOD_CONTROL
+ +| #define GLFW_MOD_CONTROL 0x0002 | +
If this bit is set one or more Control keys were held down.
+ +◆ GLFW_MOD_ALT
+ +| #define GLFW_MOD_ALT 0x0004 | +
If this bit is set one or more Alt keys were held down.
+ +◆ GLFW_MOD_SUPER
+ +| #define GLFW_MOD_SUPER 0x0008 | +
If this bit is set one or more Super keys were held down.
+ +◆ GLFW_MOD_CAPS_LOCK
+ +| #define GLFW_MOD_CAPS_LOCK 0x0010 | +
If this bit is set the Caps Lock key is enabled and the GLFW_LOCK_KEY_MODS input mode is set.
+ +◆ GLFW_MOD_NUM_LOCK
+ +| #define GLFW_MOD_NUM_LOCK 0x0020 | +
If this bit is set the Num Lock key is enabled and the GLFW_LOCK_KEY_MODS input mode is set.
+ ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__monitor.html b/deps/glfw-3.3.8/docs/html/group__monitor.html new file mode 100644 index 0000000..4df6209 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__monitor.html @@ -0,0 +1,841 @@ + + + + + + + +Description
+This is the reference documentation for monitor related functions and types. For more task-oriented information, see the Monitor guide.
++Typedefs | |
| typedef struct GLFWmonitor | GLFWmonitor |
| Opaque monitor object. More... | |
| typedef void(* | GLFWmonitorfun) (GLFWmonitor *monitor, int event) |
| The function pointer type for monitor configuration callbacks. More... | |
| typedef struct GLFWvidmode | GLFWvidmode |
| Video mode type. More... | |
| typedef struct GLFWgammaramp | GLFWgammaramp |
| Gamma ramp. More... | |
+Functions | |
| GLFWmonitor ** | glfwGetMonitors (int *count) |
| Returns the currently connected monitors. More... | |
| GLFWmonitor * | glfwGetPrimaryMonitor (void) |
| Returns the primary monitor. More... | |
| void | glfwGetMonitorPos (GLFWmonitor *monitor, int *xpos, int *ypos) |
| Returns the position of the monitor's viewport on the virtual screen. More... | |
| void | glfwGetMonitorWorkarea (GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height) |
| Retrieves the work area of the monitor. More... | |
| void | glfwGetMonitorPhysicalSize (GLFWmonitor *monitor, int *widthMM, int *heightMM) |
| Returns the physical size of the monitor. More... | |
| void | glfwGetMonitorContentScale (GLFWmonitor *monitor, float *xscale, float *yscale) |
| Retrieves the content scale for the specified monitor. More... | |
| const char * | glfwGetMonitorName (GLFWmonitor *monitor) |
| Returns the name of the specified monitor. More... | |
| void | glfwSetMonitorUserPointer (GLFWmonitor *monitor, void *pointer) |
| Sets the user pointer of the specified monitor. More... | |
| void * | glfwGetMonitorUserPointer (GLFWmonitor *monitor) |
| Returns the user pointer of the specified monitor. More... | |
| GLFWmonitorfun | glfwSetMonitorCallback (GLFWmonitorfun callback) |
| Sets the monitor configuration callback. More... | |
| const GLFWvidmode * | glfwGetVideoModes (GLFWmonitor *monitor, int *count) |
| Returns the available video modes for the specified monitor. More... | |
| const GLFWvidmode * | glfwGetVideoMode (GLFWmonitor *monitor) |
| Returns the current mode of the specified monitor. More... | |
| void | glfwSetGamma (GLFWmonitor *monitor, float gamma) |
| Generates a gamma ramp and sets it for the specified monitor. More... | |
| const GLFWgammaramp * | glfwGetGammaRamp (GLFWmonitor *monitor) |
| Returns the current gamma ramp for the specified monitor. More... | |
| void | glfwSetGammaRamp (GLFWmonitor *monitor, const GLFWgammaramp *ramp) |
| Sets the current gamma ramp for the specified monitor. More... | |
Typedef Documentation
+ +◆ GLFWmonitor
+ +| typedef struct GLFWmonitor GLFWmonitor | +
◆ GLFWmonitorfun
+ +| typedef void(* GLFWmonitorfun) (GLFWmonitor *monitor, int event) | +
This is the function pointer type for monitor configuration callbacks. A monitor callback function has the following signature:
- Parameters
-
+
+
+[in] monitor The monitor that was connected or disconnected. [in] event One of GLFW_CONNECTEDorGLFW_DISCONNECTED. Future releases may add more events.
+
- Since
- Added in version 3.0.
◆ GLFWvidmode
+ +| typedef struct GLFWvidmode GLFWvidmode | +
This describes a single video mode.
+- See also
- Video modes +
- +glfwGetVideoMode +
- +glfwGetVideoModes
- Since
- Added in version 1.0. GLFW 3: Added refresh rate member.
◆ GLFWgammaramp
+ +| typedef struct GLFWgammaramp GLFWgammaramp | +
This describes the gamma ramp for a monitor.
+- See also
- Gamma ramp +
- +glfwGetGammaRamp +
- +glfwSetGammaRamp
- Since
- Added in version 3.0.
Function Documentation
+ +◆ glfwGetMonitors()
+ +| GLFWmonitor ** glfwGetMonitors | +( | +int * | +count | ) | ++ |
This function returns an array of handles for all currently connected monitors. The primary monitor is always first in the returned array. If no monitors were found, this function returns NULL.
- Parameters
-
+
+
+[out] count Where to store the number of monitors in the returned array. This is set to zero if an error occurred.
+
- Returns
- An array of monitor handles, or
NULLif no monitors were found or if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- 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.
- Thread safety
- This function must only be called from the main thread.
- Since
- Added in version 3.0.
◆ glfwGetPrimaryMonitor()
+ +| GLFWmonitor * glfwGetPrimaryMonitor | +( | +void | +) | ++ |
This function returns the primary monitor. This is usually the monitor where elements like the task bar or global menu bar are located.
+- Returns
- The primary monitor, or
NULLif no monitors were found or if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- Remarks
- The primary monitor is always first in the array returned by glfwGetMonitors.
- See also
- Retrieving monitors +
- +glfwGetMonitors
- Since
- Added in version 3.0.
◆ glfwGetMonitorPos()
+ +| void glfwGetMonitorPos | +( | +GLFWmonitor * | +monitor, | +
| + | + | int * | +xpos, | +
| + | + | int * | +ypos | +
| + | ) | ++ |
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.
- Parameters
-
+
+
+[in] monitor The monitor to query. [out] xpos Where to store the monitor x-coordinate, or NULL.[out] ypos Where to store the monitor y-coordinate, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Monitor properties
- Since
- Added in version 3.0.
◆ glfwGetMonitorWorkarea()
+ +| void glfwGetMonitorWorkarea | +( | +GLFWmonitor * | +monitor, | +
| + | + | int * | +xpos, | +
| + | + | int * | +ypos, | +
| + | + | int * | +width, | +
| + | + | int * | +height | +
| + | ) | ++ |
This function returns the position, in screen coordinates, of the upper-left corner of the work area of the specified monitor along with the work area size in screen coordinates. The work area is defined as the area of the monitor not occluded by the operating system task bar where present. If no task bar exists then the work area is the monitor resolution in screen coordinates.
+Any or all of the position and size arguments may be NULL. If an error occurs, all non-NULL position and size arguments will be set to zero.
- Parameters
-
+
+
+[in] monitor The monitor to query. [out] xpos Where to store the monitor x-coordinate, or NULL.[out] ypos Where to store the monitor y-coordinate, or NULL.[out] width Where to store the monitor width, or NULL.[out] height Where to store the monitor height, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Work area
- Since
- Added in version 3.3.
◆ glfwGetMonitorPhysicalSize()
+ +| void glfwGetMonitorPhysicalSize | +( | +GLFWmonitor * | +monitor, | +
| + | + | int * | +widthMM, | +
| + | + | int * | +heightMM | +
| + | ) | ++ |
This function returns the size, in millimetres, of the display area of the specified monitor.
+Some systems do not provide accurate monitor size information, either because the monitor 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.
- Parameters
-
+
+
+[in] monitor The monitor to query. [out] widthMM Where to store the width, in millimetres, of the monitor's display area, or NULL.[out] heightMM Where to store the height, in millimetres, of the monitor's display area, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- Windows: On Windows 8 and earlier the physical size is calculated from the current resolution and system DPI instead of querying the monitor EDID data.
- Thread safety
- This function must only be called from the main thread.
- See also
- Monitor properties
- Since
- Added in version 3.0.
◆ glfwGetMonitorContentScale()
+ +| void glfwGetMonitorContentScale | +( | +GLFWmonitor * | +monitor, | +
| + | + | float * | +xscale, | +
| + | + | float * | +yscale | +
| + | ) | ++ |
This function retrieves the content scale for the specified monitor. The content scale is the ratio between the current DPI and the platform's default DPI. This is especially important for text and any UI elements. If the pixel dimensions of your UI scaled by this look appropriate on your machine then it should appear at a reasonable size on other machines regardless of their DPI and scaling settings. This relies on the system DPI and scaling settings being somewhat correct.
+The content scale may depend on both the monitor resolution and pixel density and on user settings. It may be very different from the raw DPI calculated from the physical size and current resolution.
+- Parameters
-
+
+
+[in] monitor The monitor to query. [out] xscale Where to store the x-axis content scale, or NULL.[out] yscale Where to store the y-axis content scale, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Content scale +
- +glfwGetWindowContentScale
- Since
- Added in version 3.3.
◆ glfwGetMonitorName()
+ +| const char * glfwGetMonitorName | +( | +GLFWmonitor * | +monitor | ) | ++ |
This function returns a human-readable name, encoded as UTF-8, of the specified monitor. The name typically reflects the make and model of the monitor and is not guaranteed to be unique among the connected monitors.
+- Parameters
-
+
+
+[in] monitor The monitor to query.
+
- Returns
- The UTF-8 encoded name of the monitor, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- 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.
- Thread safety
- This function must only be called from the main thread.
- See also
- Monitor properties
- Since
- Added in version 3.0.
◆ glfwSetMonitorUserPointer()
+ +| void glfwSetMonitorUserPointer | +( | +GLFWmonitor * | +monitor, | +
| + | + | void * | +pointer | +
| + | ) | ++ |
This function sets the user-defined pointer of the specified monitor. The current value is retained until the monitor is disconnected. The initial value is NULL.
This function may be called from the monitor callback, even for a monitor that is being disconnected.
+- Parameters
-
+
+
+[in] monitor The monitor whose pointer to set. [in] pointer The new value.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- User pointer +
- +glfwGetMonitorUserPointer
- Since
- Added in version 3.3.
◆ glfwGetMonitorUserPointer()
+ +| void * glfwGetMonitorUserPointer | +( | +GLFWmonitor * | +monitor | ) | ++ |
This function returns the current value of the user-defined pointer of the specified monitor. The initial value is NULL.
This function may be called from the monitor callback, even for a monitor that is being disconnected.
+- Parameters
-
+
+
+[in] monitor The monitor whose pointer to return.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- User pointer +
- +glfwSetMonitorUserPointer
- Since
- Added in version 3.3.
◆ glfwSetMonitorCallback()
+ +| GLFWmonitorfun glfwSetMonitorCallback | +( | +GLFWmonitorfun | +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.
+- Parameters
-
+
+
+[in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Monitor configuration changes
- Since
- Added in version 3.0.
◆ glfwGetVideoModes()
+ +| const GLFWvidmode * glfwGetVideoModes | +( | +GLFWmonitor * | +monitor, | +
| + | + | int * | +count | +
| + | ) | ++ |
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), then by resolution area (the product of width and height), then resolution width and finally by refresh rate.
+- Parameters
-
+
+
+[in] monitor The monitor to query. [out] count Where to store the number of video modes in the returned array. This is set to zero if an error occurred.
+
- Returns
- An array of video modes, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- 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.
- Thread safety
- This function must only be called from the main thread.
- See also
- Video modes +
- +glfwGetVideoMode
- Since
- Added in version 1.0. GLFW 3: Changed to return an array of modes for a specific monitor.
◆ glfwGetVideoMode()
+ +| const GLFWvidmode * glfwGetVideoMode | +( | +GLFWmonitor * | +monitor | ) | ++ |
This function returns the current video mode of the specified monitor. If you have created a full screen window for that monitor, the return value will depend on whether that window is iconified.
+- Parameters
-
+
+
+[in] monitor The monitor to query.
+
- Returns
- The current mode of the monitor, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- 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.
- Thread safety
- This function must only be called from the main thread.
- See also
- Video modes +
- +glfwGetVideoModes
- Since
- Added in version 3.0. Replaces
glfwGetDesktopMode.
◆ glfwSetGamma()
+ +| void glfwSetGamma | +( | +GLFWmonitor * | +monitor, | +
| + | + | float | +gamma | +
| + | ) | ++ |
This function generates an appropriately sized gamma ramp from the specified exponent and then calls glfwSetGammaRamp with it. The value must be a finite number greater than zero.
+The software controlled gamma ramp is applied in addition to the hardware gamma correction, which today is usually an approximation of sRGB gamma. This means that setting a perfectly linear ramp, or gamma 1.0, will produce the default (usually sRGB-like) behavior.
+For gamma correct rendering with OpenGL or OpenGL ES, see the GLFW_SRGB_CAPABLE hint.
+- Parameters
-
+
+
+[in] monitor The monitor whose gamma ramp to set. [in] gamma The desired exponent.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamma ramp
- Since
- Added in version 3.0.
◆ glfwGetGammaRamp()
+ +| const GLFWgammaramp * glfwGetGammaRamp | +( | +GLFWmonitor * | +monitor | ) | ++ |
This function returns the current gamma ramp of the specified monitor.
+- Parameters
-
+
+
+[in] monitor The monitor to query.
+
- Returns
- The current gamma ramp, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR while returning
NULL.
- 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.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamma ramp
- Since
- Added in version 3.0.
◆ glfwSetGammaRamp()
+ +| void glfwSetGammaRamp | +( | +GLFWmonitor * | +monitor, | +
| + | + | const GLFWgammaramp * | +ramp | +
| + | ) | ++ |
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 glfwTerminate.
+The software controlled gamma ramp is applied in addition to the hardware gamma correction, which today is usually an approximation of sRGB gamma. This means that setting a perfectly linear ramp, or gamma 1.0, will produce the default (usually sRGB-like) behavior.
+For gamma correct rendering with OpenGL or OpenGL ES, see the GLFW_SRGB_CAPABLE hint.
+- Parameters
-
+
+
+[in] monitor The monitor whose gamma ramp to set. [in] ramp The gamma ramp to use.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- The size of the specified gamma ramp should match the size of the current ramp for that monitor. +
- +Windows: The gamma ramp size must be 256. +
- +Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR.
- Pointer lifetime
- The specified gamma ramp is copied before this function returns.
- Thread safety
- This function must only be called from the main thread.
- See also
- Gamma ramp
- Since
- Added in version 3.0.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__native.html b/deps/glfw-3.3.8/docs/html/group__native.html new file mode 100644 index 0000000..5adef3b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__native.html @@ -0,0 +1,805 @@ + + + + + + + +Description
+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 glfw3native.h, you may define zero or more window system API macro and zero or more context creation API macros.
+The chosen backends must match those the library was compiled for. Failure to do this will cause a link-time error.
+The available window API macros are:
-
+
GLFW_EXPOSE_NATIVE_WIN32
+GLFW_EXPOSE_NATIVE_COCOA
+GLFW_EXPOSE_NATIVE_X11
+GLFW_EXPOSE_NATIVE_WAYLAND
+
The available context API macros are:
-
+
GLFW_EXPOSE_NATIVE_WGL
+GLFW_EXPOSE_NATIVE_NSGL
+GLFW_EXPOSE_NATIVE_GLX
+GLFW_EXPOSE_NATIVE_EGL
+GLFW_EXPOSE_NATIVE_OSMESA
+
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.
+If you do not want the platform-specific headers to be included, define GLFW_NATIVE_INCLUDE_NONE before including the glfw3native.h header.
+Functions | |
| const char * | glfwGetWin32Adapter (GLFWmonitor *monitor) |
| Returns the adapter device name of the specified monitor. More... | |
| const char * | glfwGetWin32Monitor (GLFWmonitor *monitor) |
| Returns the display device name of the specified monitor. More... | |
| HWND | glfwGetWin32Window (GLFWwindow *window) |
Returns the HWND of the specified window. More... | |
| HGLRC | glfwGetWGLContext (GLFWwindow *window) |
Returns the HGLRC of the specified window. More... | |
| CGDirectDisplayID | glfwGetCocoaMonitor (GLFWmonitor *monitor) |
Returns the CGDirectDisplayID of the specified monitor. More... | |
| id | glfwGetCocoaWindow (GLFWwindow *window) |
Returns the NSWindow of the specified window. More... | |
| id | glfwGetNSGLContext (GLFWwindow *window) |
Returns the NSOpenGLContext of the specified window. More... | |
| Display * | glfwGetX11Display (void) |
Returns the Display used by GLFW. More... | |
| RRCrtc | glfwGetX11Adapter (GLFWmonitor *monitor) |
Returns the RRCrtc of the specified monitor. More... | |
| RROutput | glfwGetX11Monitor (GLFWmonitor *monitor) |
Returns the RROutput of the specified monitor. More... | |
| Window | glfwGetX11Window (GLFWwindow *window) |
Returns the Window of the specified window. More... | |
| void | glfwSetX11SelectionString (const char *string) |
| Sets the current primary selection to the specified string. More... | |
| const char * | glfwGetX11SelectionString (void) |
| Returns the contents of the current primary selection as a string. More... | |
| GLXContext | glfwGetGLXContext (GLFWwindow *window) |
Returns the GLXContext of the specified window. More... | |
| GLXWindow | glfwGetGLXWindow (GLFWwindow *window) |
Returns the GLXWindow of the specified window. More... | |
| struct wl_display * | glfwGetWaylandDisplay (void) |
Returns the struct wl_display* used by GLFW. More... | |
| struct wl_output * | glfwGetWaylandMonitor (GLFWmonitor *monitor) |
Returns the struct wl_output* of the specified monitor. More... | |
| struct wl_surface * | glfwGetWaylandWindow (GLFWwindow *window) |
Returns the main struct wl_surface* of the specified window. More... | |
| EGLDisplay | glfwGetEGLDisplay (void) |
Returns the EGLDisplay used by GLFW. More... | |
| EGLContext | glfwGetEGLContext (GLFWwindow *window) |
Returns the EGLContext of the specified window. More... | |
| EGLSurface | glfwGetEGLSurface (GLFWwindow *window) |
Returns the EGLSurface of the specified window. More... | |
| int | glfwGetOSMesaColorBuffer (GLFWwindow *window, int *width, int *height, int *format, void **buffer) |
| Retrieves the color buffer associated with the specified window. More... | |
| int | glfwGetOSMesaDepthBuffer (GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer) |
| Retrieves the depth buffer associated with the specified window. More... | |
| OSMesaContext | glfwGetOSMesaContext (GLFWwindow *window) |
Returns the OSMesaContext of the specified window. More... | |
Function Documentation
+ +◆ glfwGetWin32Adapter()
+ +| const char * glfwGetWin32Adapter | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The UTF-8 encoded adapter device name (for example
\\.\DISPLAY1) of the specified monitor, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.1.
◆ glfwGetWin32Monitor()
+ +| const char * glfwGetWin32Monitor | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The UTF-8 encoded display device name (for example
\\.\DISPLAY1\Monitor0) of the specified monitor, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.1.
◆ glfwGetWin32Window()
+ +| HWND glfwGetWin32Window | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
HWNDof the specified window, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- The
HDCassociated with the window can be queried with the GetDC function.This DC is private and does not need to be released.HDC dc = GetDC(glfwGetWin32Window(window));++HWND glfwGetWin32Window(GLFWwindow *window)Returns the HWND of the specified window.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetWGLContext()
+ +| HGLRC glfwGetWGLContext | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
HGLRCof the specified window, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Remarks
- The
HDCassociated with the window can be queried with the GetDC function.This DC is private and does not need to be released.HDC dc = GetDC(glfwGetWin32Window(window));+
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetCocoaMonitor()
+ +| CGDirectDisplayID glfwGetCocoaMonitor | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The
CGDirectDisplayIDof the specified monitor, orkCGNullDirectDisplayif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.1.
◆ glfwGetCocoaWindow()
+ +| id glfwGetCocoaWindow | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
NSWindowof the specified window, ornilif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetNSGLContext()
+ +| id glfwGetNSGLContext | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
NSOpenGLContextof the specified window, ornilif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetX11Display()
+ +| Display * glfwGetX11Display | +( | +void | +) | ++ |
- Returns
- The
Displayused by GLFW, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetX11Adapter()
+ +| RRCrtc glfwGetX11Adapter | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The
RRCrtcof the specified monitor, orNoneif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.1.
◆ glfwGetX11Monitor()
+ +| RROutput glfwGetX11Monitor | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The
RROutputof the specified monitor, orNoneif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.1.
◆ glfwGetX11Window()
+ +| Window glfwGetX11Window | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
Windowof the specified window, orNoneif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwSetX11SelectionString()
+ +| void glfwSetX11SelectionString | +( | +const char * | +string | ) | ++ |
- Parameters
-
+
+
+[in] string A UTF-8 encoded string.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Pointer lifetime
- The specified string is copied before this function returns.
- Thread safety
- This function must only be called from the main thread.
- Since
- Added in version 3.3.
◆ glfwGetX11SelectionString()
+ +| const char * glfwGetX11SelectionString | +( | +void | +) | ++ |
If the selection is empty or if its contents cannot be converted, NULL is returned and a GLFW_FORMAT_UNAVAILABLE error is generated.
- Returns
- The contents of the selection as a UTF-8 encoded string, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- 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 glfwGetX11SelectionString or glfwSetX11SelectionString, or until the library is terminated.
- Thread safety
- This function must only be called from the main thread.
- Since
- Added in version 3.3.
◆ glfwGetGLXContext()
+ +| GLXContext glfwGetGLXContext | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
GLXContextof the specified window, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetGLXWindow()
+ +| GLXWindow glfwGetGLXWindow | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
GLXWindowof the specified window, orNoneif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.2.
◆ glfwGetWaylandDisplay()
+ +| struct wl_display * glfwGetWaylandDisplay | +( | +void | +) | ++ |
- Returns
- The
struct wl_display*used by GLFW, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.2.
◆ glfwGetWaylandMonitor()
+ +| struct wl_output * glfwGetWaylandMonitor | +( | +GLFWmonitor * | +monitor | ) | ++ |
- Returns
- The
struct wl_output*of the specified monitor, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.2.
◆ glfwGetWaylandWindow()
+ +| struct wl_surface * glfwGetWaylandWindow | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The main
struct wl_surface*of the specified window, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.2.
◆ glfwGetEGLDisplay()
+ +| EGLDisplay glfwGetEGLDisplay | +( | +void | +) | ++ |
- Returns
- The
EGLDisplayused by GLFW, orEGL_NO_DISPLAYif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- Because EGL is initialized on demand, this function will return
EGL_NO_DISPLAYuntil the first context has been created via EGL.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetEGLContext()
+ +| EGLContext glfwGetEGLContext | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
EGLContextof the specified window, orEGL_NO_CONTEXTif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetEGLSurface()
+ +| EGLSurface glfwGetEGLSurface | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
EGLSurfaceof the specified window, orEGL_NO_SURFACEif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.0.
◆ glfwGetOSMesaColorBuffer()
+ +| int glfwGetOSMesaColorBuffer | +( | +GLFWwindow * | +window, | +
| + | + | int * | +width, | +
| + | + | int * | +height, | +
| + | + | int * | +format, | +
| + | + | void ** | +buffer | +
| + | ) | ++ |
- Parameters
-
+
+
+[in] window The window whose color buffer to retrieve. [out] width Where to store the width of the color buffer, or NULL.[out] height Where to store the height of the color buffer, or NULL.[out] format Where to store the OSMesa pixel format of the color buffer, or NULL.[out] buffer Where to store the address of the color buffer, or NULL.
+
- Returns
GLFW_TRUEif successful, orGLFW_FALSEif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.3.
◆ glfwGetOSMesaDepthBuffer()
+ +| int glfwGetOSMesaDepthBuffer | +( | +GLFWwindow * | +window, | +
| + | + | int * | +width, | +
| + | + | int * | +height, | +
| + | + | int * | +bytesPerValue, | +
| + | + | void ** | +buffer | +
| + | ) | ++ |
- Parameters
-
+
+
+[in] window The window whose depth buffer to retrieve. [out] width Where to store the width of the depth buffer, or NULL.[out] height Where to store the height of the depth buffer, or NULL.[out] bytesPerValue Where to store the number of bytes per depth buffer element, or NULL.[out] buffer Where to store the address of the depth buffer, or NULL.
+
- Returns
GLFW_TRUEif successful, orGLFW_FALSEif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.3.
◆ glfwGetOSMesaContext()
+ +| OSMesaContext glfwGetOSMesaContext | +( | +GLFWwindow * | +window | ) | ++ |
- Returns
- The
OSMesaContextof the specified window, orNULLif an error occurred.
- Errors
- Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- Since
- Added in version 3.3.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__shapes.html b/deps/glfw-3.3.8/docs/html/group__shapes.html new file mode 100644 index 0000000..f5c1c20 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__shapes.html @@ -0,0 +1,191 @@ + + + + + + + +Description
+See standard cursor creation for how these are used.
++Macros | |
| #define | GLFW_ARROW_CURSOR 0x00036001 |
| The regular arrow cursor shape. More... | |
| #define | GLFW_IBEAM_CURSOR 0x00036002 |
| The text input I-beam cursor shape. More... | |
| #define | GLFW_CROSSHAIR_CURSOR 0x00036003 |
| The crosshair shape. More... | |
| #define | GLFW_HAND_CURSOR 0x00036004 |
| The hand shape. More... | |
| #define | GLFW_HRESIZE_CURSOR 0x00036005 |
| The horizontal resize arrow shape. More... | |
| #define | GLFW_VRESIZE_CURSOR 0x00036006 |
| The vertical resize arrow shape. More... | |
Macro Definition Documentation
+ +◆ GLFW_ARROW_CURSOR
+ +| #define GLFW_ARROW_CURSOR 0x00036001 | +
The regular arrow cursor.
+ +◆ GLFW_IBEAM_CURSOR
+ +| #define GLFW_IBEAM_CURSOR 0x00036002 | +
The text input I-beam cursor shape.
+ +◆ GLFW_CROSSHAIR_CURSOR
+ +| #define GLFW_CROSSHAIR_CURSOR 0x00036003 | +
The crosshair shape.
+ +◆ GLFW_HAND_CURSOR
+ +| #define GLFW_HAND_CURSOR 0x00036004 | +
The hand shape.
+ +◆ GLFW_HRESIZE_CURSOR
+ +| #define GLFW_HRESIZE_CURSOR 0x00036005 | +
The horizontal resize arrow shape.
+ +◆ GLFW_VRESIZE_CURSOR
+ +| #define GLFW_VRESIZE_CURSOR 0x00036006 | +
The vertical resize arrow shape.
+ ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__vulkan.html b/deps/glfw-3.3.8/docs/html/group__vulkan.html new file mode 100644 index 0000000..f80f4a9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__vulkan.html @@ -0,0 +1,352 @@ + + + + + + + +Description
+This is the reference documentation for Vulkan related functions and types. For more task-oriented information, see the Vulkan guide.
++Typedefs | |
| typedef void(* | GLFWvkproc) (void) |
| Vulkan API function pointer type. More... | |
+Functions | |
| int | glfwVulkanSupported (void) |
| Returns whether the Vulkan loader and an ICD have been found. More... | |
| const char ** | glfwGetRequiredInstanceExtensions (uint32_t *count) |
| Returns the Vulkan instance extensions required by GLFW. More... | |
| GLFWvkproc | glfwGetInstanceProcAddress (VkInstance instance, const char *procname) |
| Returns the address of the specified Vulkan instance function. More... | |
| int | glfwGetPhysicalDevicePresentationSupport (VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily) |
| Returns whether the specified queue family can present images. More... | |
| VkResult | glfwCreateWindowSurface (VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface) |
| Creates a Vulkan surface for the specified window. More... | |
Typedef Documentation
+ +◆ GLFWvkproc
+ +| typedef void(* GLFWvkproc) (void) | +
Generic function pointer used for returning Vulkan API function pointers without forcing a cast from a regular pointer.
+ +- Since
- Added in version 3.2.
Function Documentation
+ +◆ glfwVulkanSupported()
+ +| int glfwVulkanSupported | +( | +void | +) | ++ |
This function returns whether the Vulkan loader and any minimally functional ICD have been found.
+The availability of a Vulkan loader and even an ICD does not by itself guarantee that surface creation or even instance creation is possible. Call glfwGetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan surface creation are available and glfwGetPhysicalDevicePresentationSupport to check whether a queue family of a physical device supports image presentation.
+- Returns
GLFW_TRUEif Vulkan is minimally available, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread.
- See also
- Querying for Vulkan support
- Since
- Added in version 3.2.
◆ glfwGetRequiredInstanceExtensions()
+ +| const char ** glfwGetRequiredInstanceExtensions | +( | +uint32_t * | +count | ) | ++ |
This function returns an array of names of Vulkan instance extensions required by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the list will always contain VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.
If Vulkan is not available on the machine, this function returns NULL and generates a GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is at least minimally available.
If Vulkan is available but no set of extensions allowing window surface creation was found, this function returns NULL. You may still use Vulkan for off-screen rendering and compute work.
- Parameters
-
+
+
+[out] count Where to store the number of extensions in the returned array. This is set to zero if an error occurred.
+
- Returns
- An array of ASCII encoded extension names, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_API_UNAVAILABLE.
- Remarks
- Additional extensions may be required by future versions of GLFW. You should check if any extensions you wish to enable are already in the returned array, as it is an error to specify an extension more than once in the
VkInstanceCreateInfostruct.
- 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 library is terminated.
- Thread safety
- This function may be called from any thread.
- Since
- Added in version 3.2.
◆ glfwGetInstanceProcAddress()
+ +| GLFWvkproc glfwGetInstanceProcAddress | +( | +VkInstance | +instance, | +
| + | + | const char * | +procname | +
| + | ) | ++ |
This function returns the address of the specified Vulkan core or extension function for the specified instance. If instance is set to NULL it can return any function exported from the Vulkan loader, including at least the following functions:
-
+
vkEnumerateInstanceExtensionProperties
+vkEnumerateInstanceLayerProperties
+vkCreateInstance
+vkGetInstanceProcAddr
+
If Vulkan is not available on the machine, this function returns NULL and generates a GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is at least minimally available.
This function is equivalent to calling vkGetInstanceProcAddr with a platform-specific query of the Vulkan loader as a fallback.
- Parameters
-
+
+
+[in] instance The Vulkan instance to query, or NULLto retrieve functions related to instance creation.[in] procname The ASCII encoded name of the function.
+
- Returns
- The address of the function, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_API_UNAVAILABLE.
- Pointer lifetime
- The returned function pointer is valid until the library is terminated.
- Thread safety
- This function may be called from any thread.
- Since
- Added in version 3.2.
◆ glfwGetPhysicalDevicePresentationSupport()
+ +| int glfwGetPhysicalDevicePresentationSupport | +( | +VkInstance | +instance, | +
| + | + | VkPhysicalDevice | +device, | +
| + | + | uint32_t | +queuefamily | +
| + | ) | ++ |
This function returns whether the specified queue family of the specified physical device supports presentation to the platform GLFW was built for.
+If Vulkan or the required window surface creation instance extensions are not available on the machine, or if the specified instance was not created with the required extensions, this function returns GLFW_FALSE and generates a GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is at least minimally available and glfwGetRequiredInstanceExtensions to check what instance extensions are required.
- Parameters
-
+
+
+[in] instance The instance that the physical device belongs to. [in] device The physical device that the queue family belongs to. [in] queuefamily The index of the queue family to query.
+
- Returns
GLFW_TRUEif the queue family supports presentation, orGLFW_FALSEotherwise.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_API_UNAVAILABLE and GLFW_PLATFORM_ERROR.
- Remarks
- macOS: This function currently always returns
GLFW_TRUE, as theVK_MVK_macos_surfaceandVK_EXT_metal_surfaceextensions do not provide avkGetPhysicalDevice*PresentationSupporttype function.
- Thread safety
- This function may be called from any thread. For synchronization details of Vulkan objects, see the Vulkan specification.
- Since
- Added in version 3.2.
◆ glfwCreateWindowSurface()
+ +| VkResult glfwCreateWindowSurface | +( | +VkInstance | +instance, | +
| + | + | GLFWwindow * | +window, | +
| + | + | const VkAllocationCallbacks * | +allocator, | +
| + | + | VkSurfaceKHR * | +surface | +
| + | ) | ++ |
This function creates a Vulkan surface for the specified window.
+If the Vulkan loader or at least one minimally functional ICD were not found, this function returns VK_ERROR_INITIALIZATION_FAILED and generates a GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is at least minimally available.
If the required window surface creation instance extensions are not available or if the specified instance was not created with these extensions enabled, this function returns VK_ERROR_EXTENSION_NOT_PRESENT and generates a GLFW_API_UNAVAILABLE error. Call glfwGetRequiredInstanceExtensions to check what instance extensions are required.
The window surface cannot be shared with another API so the window must have been created with the client api hint set to GLFW_NO_API otherwise it generates a GLFW_INVALID_VALUE error and returns VK_ERROR_NATIVE_WINDOW_IN_USE_KHR.
The window surface must be destroyed before the specified Vulkan instance. It is the responsibility of the caller to destroy the window surface. GLFW does not destroy it for you. Call vkDestroySurfaceKHR to destroy the surface.
- Parameters
-
+
+
+[in] instance The Vulkan instance to create the surface in. [in] window The window to create the surface for. [in] allocator The allocator to use, or NULLto use the default allocator.[out] surface Where to store the handle of the surface. This is set to VK_NULL_HANDLEif an error occurred.
+
- Returns
VK_SUCCESSif successful, or a Vulkan error code if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_API_UNAVAILABLE, GLFW_PLATFORM_ERROR and GLFW_INVALID_VALUE
- Remarks
- If an error occurs before the creation call is made, GLFW returns the Vulkan error code most appropriate for the error. Appropriate use of glfwVulkanSupported and glfwGetRequiredInstanceExtensions should eliminate almost all occurrences of these errors. +
-
+macOS: GLFW prefers the
VK_EXT_metal_surfaceextension, with theVK_MVK_macos_surfaceextension as a fallback. The name of the selected extension, if any, is included in the array returned by glfwGetRequiredInstanceExtensions.
+ -
+macOS: This function creates and sets a
CAMetalLayerinstance for the window content view, which is required for MoltenVK to function.
- Thread safety
- This function may be called from any thread. For synchronization details of Vulkan objects, see the Vulkan specification.
- Since
- Added in version 3.2.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/group__window.html b/deps/glfw-3.3.8/docs/html/group__window.html new file mode 100644 index 0000000..0a44b40 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__window.html @@ -0,0 +1,3427 @@ + + + + + + + +Description
+This is the reference documentation for window related functions and types, including creation, deletion and event polling. For more task-oriented information, see the Window guide.
++Macros | |
| #define | GLFW_FOCUSED 0x00020001 |
| Input focus window hint and attribute. More... | |
| #define | GLFW_ICONIFIED 0x00020002 |
| Window iconification window attribute. More... | |
| #define | GLFW_RESIZABLE 0x00020003 |
| Window resize-ability window hint and attribute. More... | |
| #define | GLFW_VISIBLE 0x00020004 |
| Window visibility window hint and attribute. More... | |
| #define | GLFW_DECORATED 0x00020005 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_AUTO_ICONIFY 0x00020006 |
| Window auto-iconification window hint and attribute. More... | |
| #define | GLFW_FLOATING 0x00020007 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_MAXIMIZED 0x00020008 |
| Window maximization window hint and attribute. More... | |
| #define | GLFW_CENTER_CURSOR 0x00020009 |
| Cursor centering window hint. More... | |
| #define | GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A |
| Window framebuffer transparency hint and attribute. More... | |
| #define | GLFW_HOVERED 0x0002000B |
| Mouse cursor hover window attribute. More... | |
| #define | GLFW_FOCUS_ON_SHOW 0x0002000C |
| Input focus on calling show window hint and attribute. More... | |
| #define | GLFW_RED_BITS 0x00021001 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_GREEN_BITS 0x00021002 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_BLUE_BITS 0x00021003 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ALPHA_BITS 0x00021004 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_DEPTH_BITS 0x00021005 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_STENCIL_BITS 0x00021006 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_RED_BITS 0x00021007 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_GREEN_BITS 0x00021008 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_BLUE_BITS 0x00021009 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_ALPHA_BITS 0x0002100A |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_AUX_BUFFERS 0x0002100B |
| Framebuffer auxiliary buffer hint. More... | |
| #define | GLFW_STEREO 0x0002100C |
| OpenGL stereoscopic rendering hint. More... | |
| #define | GLFW_SAMPLES 0x0002100D |
| Framebuffer MSAA samples hint. More... | |
| #define | GLFW_SRGB_CAPABLE 0x0002100E |
| Framebuffer sRGB hint. More... | |
| #define | GLFW_REFRESH_RATE 0x0002100F |
| Monitor refresh rate hint. More... | |
| #define | GLFW_DOUBLEBUFFER 0x00021010 |
| Framebuffer double buffering hint. More... | |
| #define | GLFW_CLIENT_API 0x00022001 |
| Context client API hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MAJOR 0x00022002 |
| Context client API major version hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MINOR 0x00022003 |
| Context client API minor version hint and attribute. More... | |
| #define | GLFW_CONTEXT_REVISION 0x00022004 |
| Context client API revision number attribute. More... | |
| #define | GLFW_CONTEXT_ROBUSTNESS 0x00022005 |
| Context robustness hint and attribute. More... | |
| #define | GLFW_OPENGL_FORWARD_COMPAT 0x00022006 |
| OpenGL forward-compatibility hint and attribute. More... | |
| #define | GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 |
| Debug mode context hint and attribute. More... | |
| #define | GLFW_OPENGL_PROFILE 0x00022008 |
| OpenGL profile hint and attribute. More... | |
| #define | GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 |
| Context flush-on-release hint and attribute. More... | |
| #define | GLFW_CONTEXT_NO_ERROR 0x0002200A |
| Context error suppression hint and attribute. More... | |
| #define | GLFW_CONTEXT_CREATION_API 0x0002200B |
| Context creation API hint and attribute. More... | |
| #define | GLFW_SCALE_TO_MONITOR 0x0002200C |
| Window content area scaling window window hint. More... | |
| #define | GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001 |
| macOS specific window hint. More... | |
| #define | GLFW_COCOA_FRAME_NAME 0x00023002 |
| macOS specific window hint. More... | |
| #define | GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003 |
| macOS specific window hint. More... | |
| #define | GLFW_X11_CLASS_NAME 0x00024001 |
| X11 specific window hint. More... | |
| #define | GLFW_X11_INSTANCE_NAME 0x00024002 |
| X11 specific window hint. More... | |
+Typedefs | |
| typedef struct GLFWwindow | GLFWwindow |
| Opaque window object. More... | |
| typedef void(* | GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos) |
| The function pointer type for window position callbacks. More... | |
| typedef void(* | GLFWwindowsizefun) (GLFWwindow *window, int width, int height) |
| The function pointer type for window size callbacks. More... | |
| typedef void(* | GLFWwindowclosefun) (GLFWwindow *window) |
| The function pointer type for window close callbacks. More... | |
| typedef void(* | GLFWwindowrefreshfun) (GLFWwindow *window) |
| The function pointer type for window content refresh callbacks. More... | |
| typedef void(* | GLFWwindowfocusfun) (GLFWwindow *window, int focused) |
| The function pointer type for window focus callbacks. More... | |
| typedef void(* | GLFWwindowiconifyfun) (GLFWwindow *window, int iconified) |
| The function pointer type for window iconify callbacks. More... | |
| typedef void(* | GLFWwindowmaximizefun) (GLFWwindow *window, int maximized) |
| The function pointer type for window maximize callbacks. More... | |
| typedef void(* | GLFWframebuffersizefun) (GLFWwindow *window, int width, int height) |
| The function pointer type for framebuffer size callbacks. More... | |
| typedef void(* | GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale) |
| The function pointer type for window content scale callbacks. More... | |
| typedef struct GLFWimage | GLFWimage |
| Image data. More... | |
+Functions | |
| void | glfwDefaultWindowHints (void) |
| Resets all window hints to their default values. More... | |
| void | glfwWindowHint (int hint, int value) |
| Sets the specified window hint to the desired value. More... | |
| void | glfwWindowHintString (int hint, const char *value) |
| Sets the specified window hint to the desired value. More... | |
| GLFWwindow * | glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share) |
| Creates a window and its associated context. More... | |
| void | glfwDestroyWindow (GLFWwindow *window) |
| Destroys the specified window and its context. More... | |
| int | glfwWindowShouldClose (GLFWwindow *window) |
| Checks the close flag of the specified window. More... | |
| void | glfwSetWindowShouldClose (GLFWwindow *window, int value) |
| Sets the close flag of the specified window. More... | |
| void | glfwSetWindowTitle (GLFWwindow *window, const char *title) |
| Sets the title of the specified window. More... | |
| void | glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images) |
| Sets the icon for the specified window. More... | |
| void | glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos) |
| Retrieves the position of the content area of the specified window. More... | |
| void | glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos) |
| Sets the position of the content area of the specified window. More... | |
| void | glfwGetWindowSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the content area of the specified window. More... | |
| void | glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight) |
| Sets the size limits of the specified window. More... | |
| void | glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom) |
| Sets the aspect ratio of the specified window. More... | |
| void | glfwSetWindowSize (GLFWwindow *window, int width, int height) |
| Sets the size of the content area of the specified window. More... | |
| void | glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the framebuffer of the specified window. More... | |
| void | glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom) |
| Retrieves the size of the frame of the window. More... | |
| void | glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale) |
| Retrieves the content scale for the specified window. More... | |
| float | glfwGetWindowOpacity (GLFWwindow *window) |
| Returns the opacity of the whole window. More... | |
| void | glfwSetWindowOpacity (GLFWwindow *window, float opacity) |
| Sets the opacity of the whole window. More... | |
| void | glfwIconifyWindow (GLFWwindow *window) |
| Iconifies the specified window. More... | |
| void | glfwRestoreWindow (GLFWwindow *window) |
| Restores the specified window. More... | |
| void | glfwMaximizeWindow (GLFWwindow *window) |
| Maximizes the specified window. More... | |
| void | glfwShowWindow (GLFWwindow *window) |
| Makes the specified window visible. More... | |
| void | glfwHideWindow (GLFWwindow *window) |
| Hides the specified window. More... | |
| void | glfwFocusWindow (GLFWwindow *window) |
| Brings the specified window to front and sets input focus. More... | |
| void | glfwRequestWindowAttention (GLFWwindow *window) |
| Requests user attention to the specified window. More... | |
| GLFWmonitor * | glfwGetWindowMonitor (GLFWwindow *window) |
| Returns the monitor that the window uses for full screen mode. More... | |
| void | glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate) |
| Sets the mode, monitor, video mode and placement of a window. More... | |
| int | glfwGetWindowAttrib (GLFWwindow *window, int attrib) |
| Returns an attribute of the specified window. More... | |
| void | glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value) |
| Sets an attribute of the specified window. More... | |
| void | glfwSetWindowUserPointer (GLFWwindow *window, void *pointer) |
| Sets the user pointer of the specified window. More... | |
| void * | glfwGetWindowUserPointer (GLFWwindow *window) |
| Returns the user pointer of the specified window. More... | |
| GLFWwindowposfun | glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun callback) |
| Sets the position callback for the specified window. More... | |
| GLFWwindowsizefun | glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun callback) |
| Sets the size callback for the specified window. More... | |
| GLFWwindowclosefun | glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun callback) |
| Sets the close callback for the specified window. More... | |
| GLFWwindowrefreshfun | glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun callback) |
| Sets the refresh callback for the specified window. More... | |
| GLFWwindowfocusfun | glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun callback) |
| Sets the focus callback for the specified window. More... | |
| GLFWwindowiconifyfun | glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun callback) |
| Sets the iconify callback for the specified window. More... | |
| GLFWwindowmaximizefun | glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun callback) |
| Sets the maximize callback for the specified window. More... | |
| GLFWframebuffersizefun | glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun callback) |
| Sets the framebuffer resize callback for the specified window. More... | |
| GLFWwindowcontentscalefun | glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun callback) |
| Sets the window content scale callback for the specified window. More... | |
| void | glfwPollEvents (void) |
| Processes all pending events. More... | |
| void | glfwWaitEvents (void) |
| Waits until events are queued and processes them. More... | |
| void | glfwWaitEventsTimeout (double timeout) |
| Waits with timeout until events are queued and processes them. More... | |
| void | glfwPostEmptyEvent (void) |
| Posts an empty event to the event queue. More... | |
| void | glfwSwapBuffers (GLFWwindow *window) |
| Swaps the front and back buffers of the specified window. More... | |
Macro Definition Documentation
+ +◆ GLFW_FOCUSED
+ +| #define GLFW_FOCUSED 0x00020001 | +
Input focus window hint or window attribute.
+ +◆ GLFW_ICONIFIED
+ +| #define GLFW_ICONIFIED 0x00020002 | +
Window iconification window attribute.
+ +◆ GLFW_RESIZABLE
+ +| #define GLFW_RESIZABLE 0x00020003 | +
Window resize-ability window hint and window attribute.
+ +◆ GLFW_VISIBLE
+ +| #define GLFW_VISIBLE 0x00020004 | +
Window visibility window hint and window attribute.
+ +◆ GLFW_DECORATED
+ +| #define GLFW_DECORATED 0x00020005 | +
Window decoration window hint and window attribute.
+ +◆ GLFW_AUTO_ICONIFY
+ +| #define GLFW_AUTO_ICONIFY 0x00020006 | +
Window auto-iconification window hint and window attribute.
+ +◆ GLFW_FLOATING
+ +| #define GLFW_FLOATING 0x00020007 | +
Window decoration window hint and window attribute.
+ +◆ GLFW_MAXIMIZED
+ +| #define GLFW_MAXIMIZED 0x00020008 | +
Window maximization window hint and window attribute.
+ +◆ GLFW_CENTER_CURSOR
+ +| #define GLFW_CENTER_CURSOR 0x00020009 | +
Cursor centering window hint.
+ +◆ GLFW_TRANSPARENT_FRAMEBUFFER
+ +| #define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A | +
Window framebuffer transparency window hint and window attribute.
+ +◆ GLFW_HOVERED
+ +| #define GLFW_HOVERED 0x0002000B | +
Mouse cursor hover window attribute.
+ +◆ GLFW_FOCUS_ON_SHOW
+ +| #define GLFW_FOCUS_ON_SHOW 0x0002000C | +
Input focus window hint or window attribute.
+ +◆ GLFW_RED_BITS
+ +| #define GLFW_RED_BITS 0x00021001 | +
Framebuffer bit depth hint.
+ +◆ GLFW_GREEN_BITS
+ +| #define GLFW_GREEN_BITS 0x00021002 | +
Framebuffer bit depth hint.
+ +◆ GLFW_BLUE_BITS
+ +| #define GLFW_BLUE_BITS 0x00021003 | +
Framebuffer bit depth hint.
+ +◆ GLFW_ALPHA_BITS
+ +| #define GLFW_ALPHA_BITS 0x00021004 | +
Framebuffer bit depth hint.
+ +◆ GLFW_DEPTH_BITS
+ +| #define GLFW_DEPTH_BITS 0x00021005 | +
Framebuffer bit depth hint.
+ +◆ GLFW_STENCIL_BITS
+ +| #define GLFW_STENCIL_BITS 0x00021006 | +
Framebuffer bit depth hint.
+ +◆ GLFW_ACCUM_RED_BITS
+ +| #define GLFW_ACCUM_RED_BITS 0x00021007 | +
Framebuffer bit depth hint.
+ +◆ GLFW_ACCUM_GREEN_BITS
+ +| #define GLFW_ACCUM_GREEN_BITS 0x00021008 | +
Framebuffer bit depth hint.
+ +◆ GLFW_ACCUM_BLUE_BITS
+ +| #define GLFW_ACCUM_BLUE_BITS 0x00021009 | +
Framebuffer bit depth hint.
+ +◆ GLFW_ACCUM_ALPHA_BITS
+ +| #define GLFW_ACCUM_ALPHA_BITS 0x0002100A | +
Framebuffer bit depth hint.
+ +◆ GLFW_AUX_BUFFERS
+ +| #define GLFW_AUX_BUFFERS 0x0002100B | +
Framebuffer auxiliary buffer hint.
+ +◆ GLFW_STEREO
+ +| #define GLFW_STEREO 0x0002100C | +
OpenGL stereoscopic rendering hint.
+ +◆ GLFW_SAMPLES
+ +| #define GLFW_SAMPLES 0x0002100D | +
Framebuffer MSAA samples hint.
+ +◆ GLFW_SRGB_CAPABLE
+ +| #define GLFW_SRGB_CAPABLE 0x0002100E | +
Framebuffer sRGB hint.
+ +◆ GLFW_REFRESH_RATE
+ +| #define GLFW_REFRESH_RATE 0x0002100F | +
Monitor refresh rate hint.
+ +◆ GLFW_DOUBLEBUFFER
+ +| #define GLFW_DOUBLEBUFFER 0x00021010 | +
Framebuffer double buffering hint.
+ +◆ GLFW_CLIENT_API
+ + + +◆ GLFW_CONTEXT_VERSION_MAJOR
+ +| #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002 | +
◆ GLFW_CONTEXT_VERSION_MINOR
+ +| #define GLFW_CONTEXT_VERSION_MINOR 0x00022003 | +
◆ GLFW_CONTEXT_REVISION
+ +| #define GLFW_CONTEXT_REVISION 0x00022004 | +
Context client API revision number attribute.
+ +◆ GLFW_CONTEXT_ROBUSTNESS
+ +| #define GLFW_CONTEXT_ROBUSTNESS 0x00022005 | +
◆ GLFW_OPENGL_FORWARD_COMPAT
+ +| #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006 | +
◆ GLFW_OPENGL_DEBUG_CONTEXT
+ +| #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 | +
◆ GLFW_OPENGL_PROFILE
+ + + +◆ GLFW_CONTEXT_RELEASE_BEHAVIOR
+ +| #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 | +
◆ GLFW_CONTEXT_NO_ERROR
+ +| #define GLFW_CONTEXT_NO_ERROR 0x0002200A | +
◆ GLFW_CONTEXT_CREATION_API
+ +| #define GLFW_CONTEXT_CREATION_API 0x0002200B | +
◆ GLFW_SCALE_TO_MONITOR
+ +| #define GLFW_SCALE_TO_MONITOR 0x0002200C | +
◆ GLFW_COCOA_RETINA_FRAMEBUFFER
+ +| #define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001 | +
◆ GLFW_COCOA_FRAME_NAME
+ +| #define GLFW_COCOA_FRAME_NAME 0x00023002 | +
◆ GLFW_COCOA_GRAPHICS_SWITCHING
+ +| #define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003 | +
◆ GLFW_X11_CLASS_NAME
+ +| #define GLFW_X11_CLASS_NAME 0x00024001 | +
◆ GLFW_X11_INSTANCE_NAME
+ +| #define GLFW_X11_INSTANCE_NAME 0x00024002 | +
Typedef Documentation
+ +◆ GLFWwindow
+ +| typedef struct GLFWwindow GLFWwindow | +
◆ GLFWwindowposfun
+ +| typedef void(* GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos) | +
This is the function pointer type for window position callbacks. A window position callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that was moved. [in] xpos The new x-coordinate, in screen coordinates, of the upper-left corner of the content area of the window. [in] ypos The new y-coordinate, in screen coordinates, of the upper-left corner of the content area of the window.
+
- See also
- Window position +
- +glfwSetWindowPosCallback
- Since
- Added in version 3.0.
◆ GLFWwindowsizefun
+ +| typedef void(* GLFWwindowsizefun) (GLFWwindow *window, int width, int height) | +
This is the function pointer type for window size callbacks. A window size callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that was resized. [in] width The new width, in screen coordinates, of the window. [in] height The new height, in screen coordinates, of the window.
+
- See also
- Window size +
- +glfwSetWindowSizeCallback
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ GLFWwindowclosefun
+ +| typedef void(* GLFWwindowclosefun) (GLFWwindow *window) | +
This is the function pointer type for window close callbacks. A window close callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that the user attempted to close.
+
- Since
- Added in version 2.5. GLFW 3: Added window handle parameter.
◆ GLFWwindowrefreshfun
+ +| typedef void(* GLFWwindowrefreshfun) (GLFWwindow *window) | +
This is the function pointer type for window content refresh callbacks. A window content refresh callback function has the following signature:
- Parameters
-
+
+
+[in] window The window whose content needs to be refreshed.
+
- Since
- Added in version 2.5. GLFW 3: Added window handle parameter.
◆ GLFWwindowfocusfun
+ +| typedef void(* GLFWwindowfocusfun) (GLFWwindow *window, int focused) | +
This is the function pointer type for window focus callbacks. A window focus callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that gained or lost input focus. [in] focused GLFW_TRUEif the window was given input focus, orGLFW_FALSEif it lost it.
+
- See also
- Window input focus +
- +glfwSetWindowFocusCallback
- Since
- Added in version 3.0.
◆ GLFWwindowiconifyfun
+ +| typedef void(* GLFWwindowiconifyfun) (GLFWwindow *window, int iconified) | +
This is the function pointer type for window iconify callbacks. A window iconify callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that was iconified or restored. [in] iconified GLFW_TRUEif the window was iconified, orGLFW_FALSEif it was restored.
+
- See also
- Window iconification +
- +glfwSetWindowIconifyCallback
- Since
- Added in version 3.0.
◆ GLFWwindowmaximizefun
+ +| typedef void(* GLFWwindowmaximizefun) (GLFWwindow *window, int maximized) | +
This is the function pointer type for window maximize callbacks. A window maximize callback function has the following signature:
- Parameters
-
+
+
+[in] window The window that was maximized or restored. [in] maximized GLFW_TRUEif the window was maximized, orGLFW_FALSEif it was restored.
+
- See also
- Window maximization +
- +glfwSetWindowMaximizeCallback
- Since
- Added in version 3.3.
◆ GLFWframebuffersizefun
+ +| typedef void(* GLFWframebuffersizefun) (GLFWwindow *window, int width, int height) | +
This is the function pointer type for framebuffer size callbacks. A framebuffer size callback function has the following signature:
- Parameters
-
+
+
+[in] window The window whose framebuffer was resized. [in] width The new width, in pixels, of the framebuffer. [in] height The new height, in pixels, of the framebuffer.
+
- See also
- Framebuffer size +
- +glfwSetFramebufferSizeCallback
- Since
- Added in version 3.0.
◆ GLFWwindowcontentscalefun
+ +| typedef void(* GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale) | +
This is the function pointer type for window content scale callbacks. A window content scale callback function has the following signature:
- Parameters
-
+
+
+[in] window The window whose content scale changed. [in] xscale The new x-axis content scale of the window. [in] yscale The new y-axis content scale of the window.
+
- Since
- Added in version 3.3.
◆ GLFWimage
+ +This describes a single 2D image. See the documentation for each related function what the expected pixel format is.
+- See also
- Custom cursor creation +
- +Window icon
- Since
- Added in version 2.1. GLFW 3: Removed format and bytes-per-pixel members.
Function Documentation
+ +◆ glfwDefaultWindowHints()
+ +| void glfwDefaultWindowHints | +( | +void | +) | ++ |
This function resets all window hints to their default values.
+- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window creation hints +
- +glfwWindowHint +
- +glfwWindowHintString
- Since
- Added in version 3.0.
◆ glfwWindowHint()
+ +| void glfwWindowHint | +( | +int | +hint, | +
| + | + | int | +value | +
| + | ) | ++ |
This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.
+Only integer value hints can be set with this function. String value hints are set with glfwWindowHintString.
+This function does not check whether the specified hint values are valid. If you set hints to invalid values this will instead be reported by the next call to glfwCreateWindow.
+Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.
+- Parameters
-
+
+
+[in] hint The window hint to set. [in] value The new value of the window hint.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window creation hints +
- +glfwWindowHintString +
- +glfwDefaultWindowHints
- Since
- Added in version 3.0. Replaces
glfwOpenWindowHint.
◆ glfwWindowHintString()
+ +| void glfwWindowHintString | +( | +int | +hint, | +
| + | + | const char * | +value | +
| + | ) | ++ |
This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.
+Only string type hints can be set with this function. Integer value hints are set with glfwWindowHint.
+This function does not check whether the specified hint values are valid. If you set hints to invalid values this will instead be reported by the next call to glfwCreateWindow.
+Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.
+- Parameters
-
+
+
+[in] hint The window hint to set. [in] value The new value of the window hint.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
- Pointer lifetime
- The specified string is copied before this function returns.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window creation hints +
- +glfwWindowHint +
- +glfwDefaultWindowHints
- Since
- Added in version 3.3.
◆ glfwCreateWindow()
+ +| GLFWwindow * glfwCreateWindow | +( | +int | +width, | +
| + | + | int | +height, | +
| + | + | const char * | +title, | +
| + | + | GLFWmonitor * | +monitor, | +
| + | + | GLFWwindow * | +share | +
| + | ) | ++ |
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.
+Successful creation does not change which context is current. Before you can use the newly created context, you need to make it current. For information about the share parameter, see Context object sharing.
The created window, framebuffer and context may differ from what you requested, as not all parameters and hints are hard constraints. This includes the size of the window, especially for full screen windows. To query the actual attributes of the created window, framebuffer and context, see glfwGetWindowAttrib, glfwGetWindowSize and glfwGetFramebufferSize.
+To create a full screen window, you need to specify the monitor the window will cover. If no monitor is specified, the window will be windowed mode. 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 Retrieving monitors.
+For full screen windows, the specified size becomes the resolution of the window's desired video mode. As long as a full screen window is not iconified, 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 "Windowed full screen" windows.
+Once you have created the window, you can switch it between windowed and full screen mode with glfwSetWindowMonitor. This will not affect its OpenGL or OpenGL ES context.
+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 window hint, set its position and then show it.
+As long as at least one full screen window is not iconified, 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 after creation.
+The swap interval is not set during window creation and the initial value may vary depending on driver settings and defaults.
+- Parameters
-
+
+
+[in] width The desired width, in screen coordinates, of the window. This must be greater than zero. [in] height The desired height, in screen coordinates, of the window. This must be greater than zero. [in] title The initial, UTF-8 encoded window title. [in] monitor The monitor to use for full screen mode, or NULLfor windowed mode.[in] share The window whose context to share resources with, or NULLto not share resources.
+
- Returns
- The handle of the created window, or
NULLif an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE, GLFW_API_UNAVAILABLE, GLFW_VERSION_UNAVAILABLE, GLFW_FORMAT_UNAVAILABLE and GLFW_PLATFORM_ERROR.
- Remarks
- Windows: Window creation will fail if the Microsoft GDI software OpenGL implementation is the only one available. +
-
+Windows: If the executable has an icon resource named
GLFW_ICON,it will be set as the initial icon for the window. If no such icon is present, theIDI_APPLICATIONicon will be used instead. To set a different icon, see glfwSetWindowIcon.
+ - +Windows: The context to share resources with must not be current on any other thread. +
- +macOS: The OS only supports forward-compatible core profile contexts for OpenGL versions 3.2 and later. Before creating an OpenGL context of version 3.2 or later you must set the GLFW_OPENGL_FORWARD_COMPAT and GLFW_OPENGL_PROFILE hints accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all on macOS. +
- +macOS: 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. For more information on bundles, see the Bundle Programming Guide in the Mac Developer Library. +
-
+macOS: The first time a window is created the menu bar is created. If GLFW finds a
MainMenu.nibit is loaded and assumed to contain a menu bar. Otherwise a minimal menu bar is created manually with common commands like Hide, Quit and About. The About entry opens a minimal about dialog with information from the application's bundle. Menu bar creation can be disabled entirely with the GLFW_COCOA_MENUBAR init hint.
+ -
+macOS: On OS X 10.10 and later the window frame will not be rendered at full resolution on Retina displays unless the GLFW_COCOA_RETINA_FRAMEBUFFER hint is
GLFW_TRUEand theNSHighResolutionCapablekey is enabled in the application bundle'sInfo.plist. For more information, see High Resolution Guidelines for OS X in the Mac Developer Library. The GLFW test and example programs use a customInfo.plisttemplate for this, which can be found asCMake/MacOSXBundleInfo.plist.inin the source tree.
+ - +macOS: When activating frame autosaving with GLFW_COCOA_FRAME_NAME, the specified window size and position may be overridden by previously saved values. +
- +X11: Some window managers will not respect the placement of initially hidden windows. +
- +X11: Due to the asynchronous nature of X11, it may take a moment for a window to reach its requested state. This means you may not be able to query the final size, position or other attributes directly after window creation. +
-
+X11: The class part of the
WM_CLASSwindow property will by default be set to the window title passed to this function. The instance part will use the contents of theRESOURCE_NAMEenvironment variable, if present and not empty, or fall back to the window title. Set the GLFW_X11_CLASS_NAME and GLFW_X11_INSTANCE_NAME window hints to override this.
+ - +Wayland: Compositors should implement the xdg-decoration protocol for GLFW to decorate the window properly. If this protocol isn't supported, or if the compositor prefers client-side decorations, a very simple fallback frame will be drawn using the wp_viewporter protocol. A compositor can still emit close, maximize or fullscreen events, using for instance a keybind mechanism. If neither of these protocols is supported, the window won't be decorated. +
- +Wayland: A full screen window will not attempt to change the mode, no matter what the requested size or refresh rate. +
- +Wayland: Screensaver inhibition requires the idle-inhibit protocol to be implemented in the user's compositor.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window creation +
- +glfwDestroyWindow
- Since
- Added in version 3.0. Replaces
glfwOpenWindow.
◆ glfwDestroyWindow()
+ +| void glfwDestroyWindow | +( | +GLFWwindow * | +window | ) | ++ |
This function destroys the specified window and its context. On calling this function, no further callbacks will be called for that window.
+If the context of the specified window is current on the main thread, it is detached before being destroyed.
+- Parameters
-
+
+
+[in] window The window to destroy.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Note
- The context of the specified window must not be current on any other thread when this function is called.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window creation +
- +glfwCreateWindow
- Since
- Added in version 3.0. Replaces
glfwCloseWindow.
◆ glfwWindowShouldClose()
+ +| int glfwWindowShouldClose | +( | +GLFWwindow * | +window | ) | ++ |
This function returns the value of the close flag of the specified window.
+- Parameters
-
+
+
+[in] window The window to query.
+
- Returns
- The value of the close flag.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- Window closing and close flag
- Since
- Added in version 3.0.
◆ glfwSetWindowShouldClose()
+ +| void glfwSetWindowShouldClose | +( | +GLFWwindow * | +window, | +
| + | + | int | +value | +
| + | ) | ++ |
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.
+- Parameters
-
+
+
+[in] window The window whose flag to change. [in] value The new value.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- Window closing and close flag
- Since
- Added in version 3.0.
◆ glfwSetWindowTitle()
+ +| void glfwSetWindowTitle | +( | +GLFWwindow * | +window, | +
| + | + | const char * | +title | +
| + | ) | ++ |
This function sets the window title, encoded as UTF-8, of the specified window.
+- Parameters
-
+
+
+[in] window The window whose title to change. [in] title The UTF-8 encoded window title.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- macOS: The window title will not be updated until the next time you process events.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window title
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwSetWindowIcon()
+ +| void glfwSetWindowIcon | +( | +GLFWwindow * | +window, | +
| + | + | int | +count, | +
| + | + | const GLFWimage * | +images | +
| + | ) | ++ |
This function sets the icon of the specified window. If passed an array of candidate images, those of or closest to the sizes desired by the system are selected. If no images are specified, the window reverts to its default icon.
+The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. They are arranged canonically as packed sequential rows, starting from the top-left corner.
+The desired image sizes varies depending on platform and system settings. The selected images will be rescaled as needed. Good sizes include 16x16, 32x32 and 48x48.
+- Parameters
-
+
+
+[in] window The window whose icon to set. [in] count The number of images in the specified array, or zero to revert to the default window icon. [in] images The images to create the icon from. This is ignored if count is zero.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Pointer lifetime
- The specified image data is copied before this function returns.
- Remarks
- macOS: The GLFW window has no icon, as it is not a document window, so this function does nothing. The dock icon will be the same as the application bundle's icon. For more information on bundles, see the Bundle Programming Guide in the Mac Developer Library. +
- +Wayland: There is no existing protocol to change an icon, the window will thus inherit the one defined in the application's desktop file. This function always emits GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window icon
- Since
- Added in version 3.2.
◆ glfwGetWindowPos()
+ +| void glfwGetWindowPos | +( | +GLFWwindow * | +window, | +
| + | + | int * | +xpos, | +
| + | + | int * | +ypos | +
| + | ) | ++ |
This function retrieves the position, in screen coordinates, of the upper-left corner of the content 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.
- Parameters
-
+
+
+[in] window The window to query. [out] xpos Where to store the x-coordinate of the upper-left corner of the content area, or NULL.[out] ypos Where to store the y-coordinate of the upper-left corner of the content area, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: There is no way for an application to retrieve the global position of its windows, this function will always emit GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window position +
- +glfwSetWindowPos
- Since
- Added in version 3.0.
◆ glfwSetWindowPos()
+ +| void glfwSetWindowPos | +( | +GLFWwindow * | +window, | +
| + | + | int | +xpos, | +
| + | + | int | +ypos | +
| + | ) | ++ |
This function sets the position, in screen coordinates, of the upper-left corner of the content area of the specified windowed mode window. If the 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.
+The window manager may put limits on what positions are allowed. GLFW cannot and should not override these limits.
+- Parameters
-
+
+
+[in] window The window to query. [in] xpos The x-coordinate of the upper-left corner of the content area. [in] ypos The y-coordinate of the upper-left corner of the content area.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: There is no way for an application to set the global position of its windows, this function will always emit GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window position +
- +glfwGetWindowPos
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwGetWindowSize()
+ +| void glfwGetWindowSize | +( | +GLFWwindow * | +window, | +
| + | + | int * | +width, | +
| + | + | int * | +height | +
| + | ) | ++ |
This function retrieves the size, in screen coordinates, of the content area of the specified window. If you wish to retrieve the size of the framebuffer of the window in pixels, see 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.
- Parameters
-
+
+
+[in] window The window whose size to retrieve. [out] width Where to store the width, in screen coordinates, of the content area, or NULL.[out] height Where to store the height, in screen coordinates, of the content area, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size +
- +glfwSetWindowSize
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwSetWindowSizeLimits()
+ +| void glfwSetWindowSizeLimits | +( | +GLFWwindow * | +window, | +
| + | + | int | +minwidth, | +
| + | + | int | +minheight, | +
| + | + | int | +maxwidth, | +
| + | + | int | +maxheight | +
| + | ) | ++ |
This function sets the size limits of the content area of the specified window. If the window is full screen, the size limits only take effect once it is made windowed. If the window is not resizable, this function does nothing.
+The size limits are applied immediately to a windowed mode window and may cause it to be resized.
+The maximum dimensions must be greater than or equal to the minimum dimensions and all must be greater than or equal to zero.
+- Parameters
-
+
+
+[in] window The window to set limits for. [in] minwidth The minimum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.[in] minheight The minimum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.[in] maxwidth The maximum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.[in] maxheight The maximum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Remarks
- If you set size limits and an aspect ratio that conflict, the results are undefined. +
- +Wayland: The size limits will not be applied until the window is actually resized, either by the user or by the compositor.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size limits +
- +glfwSetWindowAspectRatio
- Since
- Added in version 3.2.
◆ glfwSetWindowAspectRatio()
+ +| void glfwSetWindowAspectRatio | +( | +GLFWwindow * | +window, | +
| + | + | int | +numer, | +
| + | + | int | +denom | +
| + | ) | ++ |
This function sets the required aspect ratio of the content area of the specified window. If the window is full screen, the aspect ratio only takes effect once it is made windowed. If the window is not resizable, this function does nothing.
+The aspect ratio is specified as a numerator and a denominator and both values must be greater than zero. For example, the common 16:9 aspect ratio is specified as 16 and 9, respectively.
+If the numerator and denominator is set to GLFW_DONT_CARE then the aspect ratio limit is disabled.
The aspect ratio is applied immediately to a windowed mode window and may cause it to be resized.
+- Parameters
-
+
+
+[in] window The window to set limits for. [in] numer The numerator of the desired aspect ratio, or GLFW_DONT_CARE.[in] denom The denominator of the desired aspect ratio, or GLFW_DONT_CARE.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Remarks
- If you set size limits and an aspect ratio that conflict, the results are undefined. +
- +Wayland: The aspect ratio will not be applied until the window is actually resized, either by the user or by the compositor.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size limits +
- +glfwSetWindowSizeLimits
- Since
- Added in version 3.2.
◆ glfwSetWindowSize()
+ +| void glfwSetWindowSize | +( | +GLFWwindow * | +window, | +
| + | + | int | +width, | +
| + | + | int | +height | +
| + | ) | ++ |
This function sets the size, in screen coordinates, of the content area of the specified window.
+For full screen windows, this function updates the resolution of its desired video mode and switches to the video mode closest to it, without affecting the window's context. As the context is unaffected, the bit depths of the framebuffer remain unchanged.
+If you wish to update the refresh rate of the desired video mode in addition to its resolution, see glfwSetWindowMonitor.
+The window manager may put limits on what sizes are allowed. GLFW cannot and should not override these limits.
+- Parameters
-
+
+
+[in] window The window to resize. [in] width The desired width, in screen coordinates, of the window content area. [in] height The desired height, in screen coordinates, of the window content area.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: A full screen window will not attempt to change the mode, no matter what the requested size.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size +
- +glfwGetWindowSize +
- +glfwSetWindowMonitor
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
◆ glfwGetFramebufferSize()
+ +| void glfwGetFramebufferSize | +( | +GLFWwindow * | +window, | +
| + | + | int * | +width, | +
| + | + | int * | +height | +
| + | ) | ++ |
This function retrieves the size, in pixels, of the framebuffer of the specified window. If you wish to retrieve the size of the window in screen coordinates, see 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.
- Parameters
-
+
+
+[in] window The window whose framebuffer to query. [out] width Where to store the width, in pixels, of the framebuffer, or NULL.[out] height Where to store the height, in pixels, of the framebuffer, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Framebuffer size +
- +glfwSetFramebufferSizeCallback
- Since
- Added in version 3.0.
◆ glfwGetWindowFrameSize()
+ +| void glfwGetWindowFrameSize | +( | +GLFWwindow * | +window, | +
| + | + | int * | +left, | +
| + | + | int * | +top, | +
| + | + | int * | +right, | +
| + | + | int * | +bottom | +
| + | ) | ++ |
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 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.
- Parameters
-
+
+
+[in] window The window whose frame size to query. [out] left Where to store the size, in screen coordinates, of the left edge of the window frame, or NULL.[out] top Where to store the size, in screen coordinates, of the top edge of the window frame, or NULL.[out] right Where to store the size, in screen coordinates, of the right edge of the window frame, or NULL.[out] bottom Where to store the size, in screen coordinates, of the bottom edge of the window frame, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size
- Since
- Added in version 3.1.
◆ glfwGetWindowContentScale()
+ +| void glfwGetWindowContentScale | +( | +GLFWwindow * | +window, | +
| + | + | float * | +xscale, | +
| + | + | float * | +yscale | +
| + | ) | ++ |
This function retrieves the content scale for the specified window. The content scale is the ratio between the current DPI and the platform's default DPI. This is especially important for text and any UI elements. If the pixel dimensions of your UI scaled by this look appropriate on your machine then it should appear at a reasonable size on other machines regardless of their DPI and scaling settings. This relies on the system DPI and scaling settings being somewhat correct.
+On systems where each monitors can have its own content scale, the window content scale will depend on which monitor the system considers the window to be on.
+- Parameters
-
+
+
+[in] window The window to query. [out] xscale Where to store the x-axis content scale, or NULL.[out] yscale Where to store the y-axis content scale, or NULL.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- Since
- Added in version 3.3.
◆ glfwGetWindowOpacity()
+ +| float glfwGetWindowOpacity | +( | +GLFWwindow * | +window | ) | ++ |
This function returns the opacity of the window, including any decorations.
+The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque. If the system does not support whole window transparency, this function always returns one.
+The initial opacity value for newly created windows is one.
+- Parameters
-
+
+
+[in] window The window to query.
+
- Returns
- The opacity value of the specified window.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window transparency +
- +glfwSetWindowOpacity
- Since
- Added in version 3.3.
◆ glfwSetWindowOpacity()
+ +| void glfwSetWindowOpacity | +( | +GLFWwindow * | +window, | +
| + | + | float | +opacity | +
| + | ) | ++ |
This function sets the opacity of the window, including any decorations.
+The opacity (or alpha) value is a positive finite number between zero and one, where zero is fully transparent and one is fully opaque.
+The initial opacity value for newly created windows is one.
+A window created with framebuffer transparency may not use whole window transparency. The results of doing this are undefined.
+- Parameters
-
+
+
+[in] window The window to set the opacity for. [in] opacity The desired opacity of the specified window.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window transparency +
- +glfwGetWindowOpacity
- Since
- Added in version 3.3.
◆ glfwIconifyWindow()
+ +| void glfwIconifyWindow | +( | +GLFWwindow * | +window | ) | ++ |
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, GLFW restores the original video mode of the monitor. The window's desired video mode is set again when the window is restored.
+- Parameters
-
+
+
+[in] window The window to iconify.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window iconification +
- +glfwRestoreWindow +
- +glfwMaximizeWindow
- Since
- Added in version 2.1. GLFW 3: Added window handle parameter.
◆ glfwRestoreWindow()
+ +| void glfwRestoreWindow | +( | +GLFWwindow * | +window | ) | ++ |
This function restores the specified window if it was previously iconified (minimized) or maximized. If the window is already restored, this function does nothing.
+If the specified window is an iconified full screen window, its desired video mode is set again for its monitor when the window is restored.
+- Parameters
-
+
+
+[in] window The window to restore.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window iconification +
- +glfwIconifyWindow +
- +glfwMaximizeWindow
- Since
- Added in version 2.1. GLFW 3: Added window handle parameter.
◆ glfwMaximizeWindow()
+ +| void glfwMaximizeWindow | +( | +GLFWwindow * | +window | ) | ++ |
This function maximizes the specified window if it was previously not maximized. If the window is already maximized, this function does nothing.
+If the specified window is a full screen window, this function does nothing.
+- Parameters
-
+
+
+[in] window The window to maximize.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread Safety
- This function may only be called from the main thread.
- See also
- Window iconification +
- +glfwIconifyWindow +
- +glfwRestoreWindow
- Since
- Added in GLFW 3.2.
◆ glfwShowWindow()
+ +| void glfwShowWindow | +( | +GLFWwindow * | +window | ) | ++ |
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.
+By default, windowed mode windows are focused when shown Set the GLFW_FOCUS_ON_SHOW window hint to change this behavior for all newly created windows, or change the behavior for an existing window with glfwSetWindowAttrib.
+- Parameters
-
+
+
+[in] window The window to make visible.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: Because Wayland wants every frame of the desktop to be complete, this function does not immediately make the window visible. Instead it will become visible the next time the window framebuffer is updated after this call.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window visibility +
- +glfwHideWindow
- Since
- Added in version 3.0.
◆ glfwHideWindow()
+ +| void glfwHideWindow | +( | +GLFWwindow * | +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.
+- Parameters
-
+
+
+[in] window The window to hide.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window visibility +
- +glfwShowWindow
- Since
- Added in version 3.0.
◆ glfwFocusWindow()
+ +| void glfwFocusWindow | +( | +GLFWwindow * | +window | ) | ++ |
This function brings the specified window to front and sets input focus. The window should already be visible and not iconified.
+By default, both windowed and full screen mode windows are focused when initially created. Set the GLFW_FOCUSED to disable this behavior.
+Also by default, windowed mode windows are focused when shown with glfwShowWindow. Set the GLFW_FOCUS_ON_SHOW to disable this behavior.
+Do not use this function to steal focus from other applications unless you are certain that is what the user wants. Focus stealing can be extremely disruptive.
+For a less disruptive way of getting the user's attention, see attention requests.
+- Parameters
-
+
+
+[in] window The window to give input focus.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- Wayland: It is not possible for an application to bring its windows to front, this function will always emit GLFW_PLATFORM_ERROR.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window input focus +
- +Window attention request
- Since
- Added in version 3.2.
◆ glfwRequestWindowAttention()
+ +| void glfwRequestWindowAttention | +( | +GLFWwindow * | +window | ) | ++ |
This function requests user attention to the specified window. On platforms where this is not supported, attention is requested to the application as a whole.
+Once the user has given attention, usually by focusing the window or application, the system will end the request automatically.
+- Parameters
-
+
+
+[in] window The window to request attention to.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- macOS: Attention is requested to the application as a whole, not the specific window.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window attention request
- Since
- Added in version 3.3.
◆ glfwGetWindowMonitor()
+ +| GLFWmonitor * glfwGetWindowMonitor | +( | +GLFWwindow * | +window | ) | ++ |
This function returns the handle of the monitor that the specified window is in full screen on.
+- Parameters
-
+
+
+[in] window The window to query.
+
- Returns
- The monitor, or
NULLif the window is in windowed mode or an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window monitor +
- +glfwSetWindowMonitor
- Since
- Added in version 3.0.
◆ glfwSetWindowMonitor()
+ +| void glfwSetWindowMonitor | +( | +GLFWwindow * | +window, | +
| + | + | GLFWmonitor * | +monitor, | +
| + | + | int | +xpos, | +
| + | + | int | +ypos, | +
| + | + | int | +width, | +
| + | + | int | +height, | +
| + | + | int | +refreshRate | +
| + | ) | ++ |
This function sets the monitor that the window uses for full screen mode or, if the monitor is NULL, makes it windowed mode.
When setting a monitor, this function updates the width, height and refresh rate of the desired video mode and switches to the video mode closest to it. The window position is ignored when setting a monitor.
+When the monitor is NULL, the position, width and height are used to place the window content area. The refresh rate is ignored when no monitor is specified.
If you only wish to update the resolution of a full screen window or the size of a windowed mode window, see glfwSetWindowSize.
+When a window transitions from full screen to windowed mode, this function restores any previous window settings such as whether it is decorated, floating, resizable, has size or aspect ratio limits, etc.
+- Parameters
-
+
+
+[in] window The window whose monitor, size or video mode to set. [in] monitor The desired monitor, or NULLto set windowed mode.[in] xpos The desired x-coordinate of the upper-left corner of the content area. [in] ypos The desired y-coordinate of the upper-left corner of the content area. [in] width The desired with, in screen coordinates, of the content area or video mode. [in] height The desired height, in screen coordinates, of the content area or video mode. [in] refreshRate The desired refresh rate, in Hz, of the video mode, or GLFW_DONT_CARE.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Remarks
- The OpenGL or OpenGL ES context will not be destroyed or otherwise affected by any resizing or mode switching, although you may need to update your viewport if the framebuffer size has changed. +
- +Wayland: The desired window position is ignored, as there is no way for an application to set this property. +
- +Wayland: Setting the window to full screen will not attempt to change the mode, no matter what the requested size or refresh rate.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window monitor +
- +Full screen windows +
- +glfwGetWindowMonitor +
- +glfwSetWindowSize
- Since
- Added in version 3.2.
◆ glfwGetWindowAttrib()
+ +| int glfwGetWindowAttrib | +( | +GLFWwindow * | +window, | +
| + | + | int | +attrib | +
| + | ) | ++ |
This function returns the value of an attribute of the specified window or its OpenGL or OpenGL ES context.
+- Parameters
-
+
+
+[in] window The window to query. [in] attrib The window attribute whose value to return.
+
- Returns
- The value of the attribute, or zero if an error occurred.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
- Remarks
- Framebuffer related hints are not window attributes. See Framebuffer related attributes for more information. +
- +Zero is a valid value for many window and context related attributes so you cannot use a return value of zero as an indication of errors. However, this function should not fail as long as it is passed valid arguments and the library has been initialized. +
-
+Wayland: The Wayland protocol provides no way to check whether a window is iconfied, so GLFW_ICONIFIED always returns
GLFW_FALSE.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window attributes +
- +glfwSetWindowAttrib
- Since
- Added in version 3.0. Replaces
glfwGetWindowParamandglfwGetGLVersion.
◆ glfwSetWindowAttrib()
+ +| void glfwSetWindowAttrib | +( | +GLFWwindow * | +window, | +
| + | + | int | +attrib, | +
| + | + | int | +value | +
| + | ) | ++ |
This function sets the value of an attribute of the specified window.
+The supported attributes are GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW.
+Some of these attributes are ignored for full screen windows. The new value will take effect if the window is later made windowed.
+Some of these attributes are ignored for windowed mode windows. The new value will take effect if the window is later made full screen.
+- Parameters
-
+
+
+[in] window The window to set the attribute for. [in] attrib A supported window attribute. [in] value GLFW_TRUEorGLFW_FALSE.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Remarks
- Calling glfwGetWindowAttrib will always return the latest value, even if that value is ignored by the current mode of the window.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window attributes +
- +glfwGetWindowAttrib
- Since
- Added in version 3.3.
◆ glfwSetWindowUserPointer()
+ +| void glfwSetWindowUserPointer | +( | +GLFWwindow * | +window, | +
| + | + | void * | +pointer | +
| + | ) | ++ |
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.
- Parameters
-
+
+
+[in] window The window whose pointer to set. [in] pointer The new value.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- User pointer +
- +glfwGetWindowUserPointer
- Since
- Added in version 3.0.
◆ glfwGetWindowUserPointer()
+ +| void * glfwGetWindowUserPointer | +( | +GLFWwindow * | +window | ) | ++ |
This function returns the current value of the user-defined pointer of the specified window. The initial value is NULL.
- Parameters
-
+
+
+[in] window The window whose pointer to return.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function may be called from any thread. Access is not synchronized.
- See also
- User pointer +
- +glfwSetWindowUserPointer
- Since
- Added in version 3.0.
◆ glfwSetWindowPosCallback()
+ +| GLFWwindowposfun glfwSetWindowPosCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowposfun | +callback | +
| + | ) | ++ |
This function sets the position callback of the specified window, which is called when the window is moved. The callback is provided with the position, in screen coordinates, of the upper-left corner of the content area of the window.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- Wayland: This callback will never be called, as there is no way for an application to know its global position.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window position
- Since
- Added in version 3.0.
◆ glfwSetWindowSizeCallback()
+ +| GLFWwindowsizefun glfwSetWindowSizeCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowsizefun | +callback | +
| + | ) | ++ |
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 content area of the window.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window size
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter and return value.
◆ glfwSetWindowCloseCallback()
+ +| GLFWwindowclosefun glfwSetWindowCloseCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowclosefun | +callback | +
| + | ) | ++ |
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 glfwSetWindowShouldClose.
+The close callback is not triggered by glfwDestroyWindow.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- For more information about the callback parameters, see the function pointer type.void function_name(GLFWwindow* window)+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- macOS: Selecting Quit from the application menu will trigger the close callback for all windows.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window closing and close flag
- Since
- Added in version 2.5. GLFW 3: Added window handle parameter and return value.
◆ glfwSetWindowRefreshCallback()
+ +| GLFWwindowrefreshfun glfwSetWindowRefreshCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowrefreshfun | +callback | +
| + | ) | ++ |
This function sets the refresh callback of the specified window, which is called when the content 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, Aqua or Wayland, where the window contents are saved off-screen, this callback may be called only very infrequently or never at all.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- For more information about the callback parameters, see the function pointer type.void function_name(GLFWwindow* window);+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window damage and refresh
- Since
- Added in version 2.5. GLFW 3: Added window handle parameter and return value.
◆ glfwSetWindowFocusCallback()
+ +| GLFWwindowfocusfun glfwSetWindowFocusCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowfocusfun | +callback | +
| + | ) | ++ |
This function sets the focus callback of the specified window, which is called when the window gains or loses input focus.
+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 glfwSetKeyCallback and glfwSetMouseButtonCallback.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window input focus
- Since
- Added in version 3.0.
◆ glfwSetWindowIconifyCallback()
+ +| GLFWwindowiconifyfun glfwSetWindowIconifyCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowiconifyfun | +callback | +
| + | ) | ++ |
This function sets the iconification callback of the specified window, which is called when the window is iconified or restored.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Remarks
- Wayland: The XDG-shell protocol has no event for iconification, so this callback will never be called.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window iconification
- Since
- Added in version 3.0.
◆ glfwSetWindowMaximizeCallback()
+ +| GLFWwindowmaximizefun glfwSetWindowMaximizeCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowmaximizefun | +callback | +
| + | ) | ++ |
This function sets the maximization callback of the specified window, which is called when the window is maximized or restored.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window maximization
- Since
- Added in version 3.3.
◆ glfwSetFramebufferSizeCallback()
+ +| GLFWframebuffersizefun glfwSetFramebufferSizeCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWframebuffersizefun | +callback | +
| + | ) | ++ |
This function sets the framebuffer resize callback of the specified window, which is called when the framebuffer of the specified window is resized.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Framebuffer size
- Since
- Added in version 3.0.
◆ glfwSetWindowContentScaleCallback()
+ +| GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback | +( | +GLFWwindow * | +window, | +
| + | + | GLFWwindowcontentscalefun | +callback | +
| + | ) | ++ |
This function sets the window content scale callback of the specified window, which is called when the content scale of the specified window changes.
+- Parameters
-
+
+
+[in] window The window whose callback to set. [in] callback The new callback, or NULLto remove the currently set callback.
+
- Returns
- The previously set callback, or
NULLif no callback was set or the library had not been initialized.
- Callback signature
- +For more information about the callback parameters, see the function pointer type.
- Errors
- Possible errors include GLFW_NOT_INITIALIZED.
- Thread safety
- This function must only be called from the main thread.
- See also
- Window content scale +
- +glfwGetWindowContentScale
- Since
- Added in version 3.3.
◆ glfwPollEvents()
+ +| void glfwPollEvents | +( | +void | +) | ++ |
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.
+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 to redraw the contents of your window when necessary during such operations.
+Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.
+Event processing is not required for joystick input to work.
+- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Event processing +
- +glfwWaitEvents +
- +glfwWaitEventsTimeout
- Since
- Added in version 1.0.
◆ glfwWaitEvents()
+ +| void glfwWaitEvents | +( | +void | +) | ++ |
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 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.
+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 to redraw the contents of your window when necessary during such operations.
+Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.
+Event processing is not required for joystick input to work.
+- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Event processing +
- +glfwPollEvents +
- +glfwWaitEventsTimeout
- Since
- Added in version 2.5.
◆ glfwWaitEventsTimeout()
+ +| void glfwWaitEventsTimeout | +( | +double | +timeout | ) | ++ |
This function puts the calling thread to sleep until at least one event is available in the event queue, or until the specified timeout is reached. If one or more events are available, it behaves exactly like 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.
+The timeout value must be a positive finite number.
+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.
+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 to redraw the contents of your window when necessary during such operations.
+Do not assume that callbacks you set will only be called in response to event processing functions like this one. While it is necessary to poll for events, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.
+Event processing is not required for joystick input to work.
+- Parameters
-
+
+
+[in] timeout The maximum amount of time, in seconds, to wait.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
- Reentrancy
- This function must not be called from a callback.
- Thread safety
- This function must only be called from the main thread.
- See also
- Event processing +
- +glfwPollEvents +
- +glfwWaitEvents
- Since
- Added in version 3.2.
◆ glfwPostEmptyEvent()
+ +| void glfwPostEmptyEvent | +( | +void | +) | ++ |
This function posts an empty event from the current thread to the event queue, causing glfwWaitEvents or glfwWaitEventsTimeout to return.
+- Errors
- Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
- Thread safety
- This function may be called from any thread.
- See also
- Event processing +
- +glfwWaitEvents +
- +glfwWaitEventsTimeout
- Since
- Added in version 3.1.
◆ glfwSwapBuffers()
+ +| void glfwSwapBuffers | +( | +GLFWwindow * | +window | ) | ++ |
This function swaps the front and back buffers of the specified window when rendering with OpenGL or OpenGL ES. If the swap interval is greater than zero, the GPU driver waits the specified number of screen updates before swapping the buffers.
+The specified window must have an OpenGL or OpenGL ES context. Specifying a window without a context will generate a GLFW_NO_WINDOW_CONTEXT error.
+This function does not apply to Vulkan. If you are rendering with Vulkan, see vkQueuePresentKHR instead.
- Parameters
-
+
+
+[in] window The window whose buffers to swap.
+
- Errors
- Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.
- Remarks
- EGL: The context of the specified window must be current on the calling thread.
- Thread safety
- This function may be called from any thread.
- See also
- Buffer swapping +
- +glfwSwapInterval
- Since
- Added in version 1.0. GLFW 3: Added window handle parameter.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/index.html b/deps/glfw-3.3.8/docs/html/index.html new file mode 100644 index 0000000..072fcc5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/index.html @@ -0,0 +1,93 @@ + + + + + + + ++Introduction
+GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and Vulkan application development. It provides a simple, platform-independent API for creating windows, contexts and surfaces, reading input, handling events, etc.
+Release notes for version 3.3 list new features, caveats and deprecations.
+Getting started is a guide for users new to GLFW. It takes you through how to write a small but complete program.
+There are guides for each section of the API:
+-
+
- Introduction to the API – initialization, error handling and high-level design +
- Window guide – creating and working with windows and framebuffers +
- Context guide – working with OpenGL and OpenGL ES contexts +
- Vulkan guide - working with Vulkan objects and extensions +
- Monitor guide – enumerating and working with monitors and video modes +
- Input guide – receiving events, polling and processing input +
Once you have written a program, see Compiling GLFW and Building applications.
+The reference documentation provides more detailed information about specific functions.
+Moving from GLFW 2 to 3 explains what has changed and how to update existing code to use the new API.
+There is a section on Guarantees and limitations for pointer lifetimes, reentrancy, thread safety, event order and backward and forward compatibility.
+The FAQ answers many common questions about the design, implementation and use of GLFW.
+Finally, Standards conformance explains what APIs, standards and protocols GLFW uses and what happens when they are not present on a given machine.
+This documentation was generated with Doxygen. The sources for it are available in both the source distribution and GitHub repository.
++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/input_8dox.html b/deps/glfw-3.3.8/docs/html/input_8dox.html new file mode 100644 index 0000000..3765672 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/input_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/input_guide.html b/deps/glfw-3.3.8/docs/html/input_guide.html new file mode 100644 index 0000000..9c8c25f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/input_guide.html @@ -0,0 +1,562 @@ + + + + + + + +Table of Contents
+ +This guide introduces the input related functions of GLFW. For details on a specific function in this category, see the Input reference. There are also guides for the other areas of GLFW.
+ +GLFW provides many kinds of input. While some can only be polled, like time, or only received via callbacks, like scrolling, many provide both callbacks and polling. Callbacks are more work to use than polling but is less CPU intensive and guarantees that you do not miss state changes.
+All input callbacks receive a window handle. By using the window user pointer, you can access non-global structures or objects from your callbacks.
+To get a better feel for how the various events callbacks behave, run the events test program. It register every callback supported by GLFW and prints out all arguments provided for every event, along with time and sequence information.
+Event processing
+GLFW needs to poll the window system for events both to provide input to the application and to prove to the window system that the application hasn't locked up. Event processing is normally done each frame after buffer swapping. Even when you have no windows, event polling needs to be done in order to receive monitor and joystick connection events.
+There are three functions for processing pending events. glfwPollEvents, processes only those events that have already been received and then returns immediately.
+This is the best choice when rendering continuously, like most games do.
+If you only need to update the contents of the window when you receive new input, glfwWaitEvents is a better choice.
+It puts the thread to sleep until at least one event has been received and then processes all received events. This saves a great deal of CPU cycles and is useful for, for example, editing tools.
+If you want to wait for events but have UI elements or other tasks that need periodic updates, glfwWaitEventsTimeout lets you specify a timeout.
+It puts the thread to sleep until at least one event has been received, or until the specified number of seconds have elapsed. It then processes any received events.
+If the main thread is sleeping in glfwWaitEvents, you can wake it from another thread by posting an empty event to the event queue with glfwPostEmptyEvent.
+Do not assume that callbacks will only be called in response to the above functions. While it is necessary to process events in one or more of the ways above, window systems that require GLFW to register callbacks of its own can pass events to GLFW in response to many window system function calls. GLFW will pass those events on to the application callbacks before returning.
+For example, on Windows the system function that glfwSetWindowSize is implemented with will send window size events directly to the event callback that every window has and that GLFW implements for its windows. If you have set a window size callback GLFW will call it in turn with the new size before everything returns back out of the glfwSetWindowSize call.
++Keyboard input
+GLFW divides keyboard input into two categories; key events and character events. Key events relate to actual physical keyboard keys, whereas character events relate to the Unicode code points generated by pressing some of them.
+Keys and characters do not map 1:1. A single key press may produce several characters, and a single character may require several keys to produce. This may not be the case on your machine, but your users are likely not all using the same keyboard layout, input method or even operating system as you.
++Key input
+If you wish to be notified when a physical key is pressed or released or when it repeats, set a key callback.
+The callback function receives the keyboard key, platform-specific scancode, key action and modifier bits.
+The action is one of GLFW_PRESS, GLFW_REPEAT or GLFW_RELEASE. Events with GLFW_PRESS and GLFW_RELEASE actions are emitted for every key press. Most keys will also emit events with GLFW_REPEAT actions while a key is held down.
Key events with GLFW_REPEAT actions are intended for text input. They are emitted at the rate set in the user's keyboard settings. At most one key is repeated even if several keys are held down. GLFW_REPEAT actions should not be relied on to know which keys are being held down or to drive animation. Instead you should either save the state of relevant keys based on GLFW_PRESS and GLFW_RELEASE actions, or call glfwGetKey, which provides basic cached key state.
The key will be one of the existing key tokens, or GLFW_KEY_UNKNOWN if GLFW lacks a token for it, for example E-mail and Play keys.
The scancode is unique for every key, regardless of whether it has a key token. Scancodes are platform-specific but consistent over time, so keys will have different scancodes depending on the platform but they are safe to save to disk. You can query the scancode for any named key on the current platform with glfwGetKeyScancode.
+The last reported state for every named key is also saved in per-window state arrays that can be polled with glfwGetKey.
+The returned state is one of GLFW_PRESS or GLFW_RELEASE.
This function only returns cached key event state. It does not poll the system for the current physical state of the key.
+Whenever you poll state, you risk missing the state change you are looking for. If a pressed key is released again before you poll its state, you will have missed the key press. The recommended solution for this is to use a key callback, but there is also the GLFW_STICKY_KEYS input mode.
When sticky keys mode is enabled, the pollable state of a key will remain GLFW_PRESS until the state of that key is polled with glfwGetKey. Once it has been polled, if a key release event had been processed in the meantime, the state will reset to GLFW_RELEASE, otherwise it will remain GLFW_PRESS.
If you wish to know what the state of the Caps Lock and Num Lock keys was when input events were generated, set the GLFW_LOCK_KEY_MODS input mode.
When this input mode is enabled, any callback that receives modifier bits will have the GLFW_MOD_CAPS_LOCK bit set if Caps Lock was on when the event occurred and the GLFW_MOD_NUM_LOCK bit set if Num Lock was on.
+The GLFW_KEY_LAST constant holds the highest value of any named key.
+Text input
+GLFW supports text input in the form of a stream of Unicode code points, as produced by the operating system text input system. Unlike key input, text input obeys keyboard layouts and modifier keys and supports composing characters using dead keys. Once received, you can encode the code points into UTF-8 or any other encoding you prefer.
+Because an unsigned int is 32 bits long on all platforms supported by GLFW, you can treat the code point argument as native endian UTF-32.
If you wish to offer regular text input, set a character callback.
+The callback function receives Unicode code points for key events that would have led to regular text input and generally behaves as a standard text field on that platform.
++Key names
+If you wish to refer to keys by name, you can query the keyboard layout dependent name of printable keys with glfwGetKeyName.
+This function can handle both keys and scancodes. If the specified key is GLFW_KEY_UNKNOWN then the scancode is used, otherwise it is ignored. This matches the behavior of the key callback, meaning the callback arguments can always be passed unmodified to this function.
+Mouse input
+Mouse input comes in many forms, including mouse motion, button presses and scrolling offsets. The cursor appearance can also be changed, either to a custom image or a standard cursor shape from the system theme.
++Cursor position
+If you wish to be notified when the cursor moves over the window, set a cursor position callback.
+The callback functions receives the cursor position, measured in screen coordinates but relative to the top-left corner of the window content area. On platforms that provide it, the full sub-pixel cursor position is passed on.
+The cursor position is also saved per-window and can be polled with glfwGetCursorPos.
++Cursor mode
+The GLFW_CURSOR input mode provides several cursor modes for special forms of mouse motion input. By default, the cursor mode is GLFW_CURSOR_NORMAL, meaning the regular arrow cursor (or another cursor set with glfwSetCursor) is used and cursor motion is not limited.
If you wish to implement mouse motion based camera controls or other input schemes that require unlimited mouse movement, set the cursor mode to GLFW_CURSOR_DISABLED.
This will hide the cursor and lock it to the specified window. GLFW will then take care of all the details of cursor re-centering and offset calculation and providing the application with a virtual cursor position. This virtual position is provided normally via both the cursor position callback and through polling.
+- Note
- You should not implement your own version of this functionality using other features of GLFW. It is not supported and will not work as robustly as
GLFW_CURSOR_DISABLED.
If you only wish the cursor to become hidden when it is over a window but still want it to behave normally, set the cursor mode to GLFW_CURSOR_HIDDEN.
This mode puts no limit on the motion of the cursor.
+To exit out of either of these special modes, restore the GLFW_CURSOR_NORMAL cursor mode.
+Raw mouse motion
+When the cursor is disabled, raw (unscaled and unaccelerated) mouse motion can be enabled if available.
+Raw mouse motion is closer to the actual motion of the mouse across a surface. It is not affected by the scaling and acceleration applied to the motion of the desktop cursor. That processing is suitable for a cursor while raw motion is better for controlling for example a 3D camera. Because of this, raw mouse motion is only provided when the cursor is disabled.
+Call glfwRawMouseMotionSupported to check if the current machine provides raw motion and set the GLFW_RAW_MOUSE_MOTION input mode to enable it. It is disabled by default.
If supported, raw mouse motion can be enabled or disabled per-window and at any time but it will only be provided when the cursor is disabled.
++Cursor objects
+GLFW supports creating both custom and system theme cursor images, encapsulated as GLFWcursor objects. They are created with glfwCreateCursor or glfwCreateStandardCursor and destroyed with glfwDestroyCursor, or glfwTerminate, if any remain.
++Custom cursor creation
+A custom cursor is created with glfwCreateCursor, which returns a handle to the created cursor object. For example, this creates a 16x16 white square cursor with the hot-spot in the upper-left corner:
+If cursor creation fails, NULL will be returned, so it is necessary to check the return value.
The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. The pixels are arranged canonically as sequential rows, starting from the top-left corner.
++Standard cursor creation
+A cursor with a standard shape from the current system cursor theme can be can be created with glfwCreateStandardCursor.
+These cursor objects behave in the exact same way as those created with glfwCreateCursor except that the system cursor theme provides the actual image.
++Cursor destruction
+When a cursor is no longer needed, destroy it with glfwDestroyCursor.
+Cursor destruction always succeeds. If the cursor is current for any window, that window will revert to the default cursor. This does not affect the cursor mode. All remaining cursors are destroyed when glfwTerminate is called.
++Cursor setting
+A cursor can be set as current for a window with glfwSetCursor.
+Once set, the cursor image will be used as long as the system cursor is over the content area of the window and the cursor mode is set to GLFW_CURSOR_NORMAL.
A single cursor may be set for any number of windows.
+To revert to the default cursor, set the cursor of that window to NULL.
When a cursor is destroyed, any window that has it set will revert to the default cursor. This does not affect the cursor mode.
++Cursor enter/leave events
+If you wish to be notified when the cursor enters or leaves the content area of a window, set a cursor enter/leave callback.
+The callback function receives the new classification of the cursor.
+You can query whether the cursor is currently inside the content area of the window with the GLFW_HOVERED window attribute.
++Mouse button input
+If you wish to be notified when a mouse button is pressed or released, set a mouse button callback.
+The callback function receives the mouse button, button action and modifier bits.
+The action is one of GLFW_PRESS or GLFW_RELEASE.
Mouse button states for named buttons are also saved in per-window state arrays that can be polled with glfwGetMouseButton.
+The returned state is one of GLFW_PRESS or GLFW_RELEASE.
This function only returns cached mouse button event state. It does not poll the system for the current state of the mouse button.
+Whenever you poll state, you risk missing the state change you are looking for. If a pressed mouse button is released again before you poll its state, you will have missed the button press. The recommended solution for this is to use a mouse button callback, but there is also the GLFW_STICKY_MOUSE_BUTTONS input mode.
When sticky mouse buttons mode is enabled, the pollable state of a mouse button will remain GLFW_PRESS until the state of that button is polled with glfwGetMouseButton. Once it has been polled, if a mouse button release event had been processed in the meantime, the state will reset to GLFW_RELEASE, otherwise it will remain GLFW_PRESS.
The GLFW_MOUSE_BUTTON_LAST constant holds the highest value of any named button.
+Scroll input
+If you wish to be notified when the user scrolls, whether with a mouse wheel or touchpad gesture, set a scroll callback.
+The callback function receives two-dimensional scroll offsets.
+A normal mouse wheel, being vertical, provides offsets along the Y-axis.
++Joystick input
+The joystick functions expose connected joysticks and controllers, with both referred to as joysticks. It supports up to sixteen joysticks, ranging from GLFW_JOYSTICK_1, GLFW_JOYSTICK_2 up to and including GLFW_JOYSTICK_16 or GLFW_JOYSTICK_LAST. You can test whether a joystick is present with glfwJoystickPresent.
Each joystick has zero or more axes, zero or more buttons, zero or more hats, a human-readable name, a user pointer and an SDL compatible GUID.
+When GLFW is initialized, detected joysticks are added to the beginning of the array. Once a joystick is detected, it keeps its assigned ID until it is disconnected or the library is terminated, so as joysticks are connected and disconnected, there may appear gaps in the IDs.
+Joystick axis, button and hat state is updated when polled and does not require a window to be created or events to be processed. However, if you want joystick connection and disconnection events reliably delivered to the joystick callback then you must process events.
+To see all the properties of all connected joysticks in real-time, run the joysticks test program.
+Joystick axis states
+The positions of all axes of a joystick are returned by glfwGetJoystickAxes. See the reference documentation for the lifetime of the returned array.
+Each element in the returned array is a value between -1.0 and 1.0.
++Joystick button states
+The states of all buttons of a joystick are returned by glfwGetJoystickButtons. See the reference documentation for the lifetime of the returned array.
+Each element in the returned array is either GLFW_PRESS or GLFW_RELEASE.
For backward compatibility with earlier versions that did not have glfwGetJoystickHats, the button array by default also includes all hats. See the reference documentation for glfwGetJoystickButtons for details.
++Joystick hat states
+The states of all hats are returned by glfwGetJoystickHats. See the reference documentation for the lifetime of the returned array.
+Each element in the returned array is one of the following:
+| Name | Value |
|---|---|
GLFW_HAT_CENTERED | 0 |
GLFW_HAT_UP | 1 |
GLFW_HAT_RIGHT | 2 |
GLFW_HAT_DOWN | 4 |
GLFW_HAT_LEFT | 8 |
GLFW_HAT_RIGHT_UP | GLFW_HAT_RIGHT | GLFW_HAT_UP |
GLFW_HAT_RIGHT_DOWN | GLFW_HAT_RIGHT | GLFW_HAT_DOWN |
GLFW_HAT_LEFT_UP | GLFW_HAT_LEFT | GLFW_HAT_UP |
GLFW_HAT_LEFT_DOWN | GLFW_HAT_LEFT | GLFW_HAT_DOWN |
The diagonal directions are bitwise combinations of the primary (up, right, down and left) directions and you can test for these individually by ANDing it with the corresponding direction.
+For backward compatibility with earlier versions that did not have glfwGetJoystickHats, all hats are by default also included in the button array. See the reference documentation for glfwGetJoystickButtons for details.
++Joystick name
+The human-readable, UTF-8 encoded name of a joystick is returned by glfwGetJoystickName. See the reference documentation for the lifetime of the returned string.
+Joystick names are not guaranteed to be unique. Two joysticks of the same model and make may have the same name. Only the joystick ID is guaranteed to be unique, and only until that joystick is disconnected.
++Joystick user pointer
+Each joystick has a user pointer that can be set with glfwSetJoystickUserPointer and queried with glfwGetJoystickUserPointer. This can be used for any purpose you need and will not be modified by GLFW. The value will be kept until the joystick is disconnected or until the library is terminated.
+The initial value of the pointer is NULL.
+Joystick configuration changes
+If you wish to be notified when a joystick is connected or disconnected, set a joystick callback.
+The callback function receives the ID of the joystick that has been connected and disconnected and the event that occurred.
+For joystick connection and disconnection events to be delivered on all platforms, you need to call one of the event processing functions. Joystick disconnection may also be detected and the callback called by joystick functions. The function will then return whatever it returns for a disconnected joystick.
+Only glfwGetJoystickName and glfwGetJoystickUserPointer will return useful values for a disconnected joystick and only before the monitor callback returns.
++Gamepad input
+The joystick functions provide unlabeled axes, buttons and hats, with no indication of where they are located on the device. Their order may also vary between platforms even with the same device.
+To solve this problem the SDL community crowdsourced the SDL_GameControllerDB project, a database of mappings from many different devices to an Xbox-like gamepad.
+GLFW supports this mapping format and contains a copy of the mappings available at the time of release. See Gamepad mappings for how to update this at runtime. Mappings will be assigned to joysticks automatically any time a joystick is connected or the mappings are updated.
+You can check whether a joystick is both present and has a gamepad mapping with glfwJoystickIsGamepad.
+If you are only interested in gamepad input you can use this function instead of glfwJoystickPresent.
+You can query the human-readable name provided by the gamepad mapping with glfwGetGamepadName. This may or may not be the same as the joystick name.
+To retrieve the gamepad state of a joystick, call glfwGetGamepadState.
+The GLFWgamepadstate struct has two arrays; one for button states and one for axis states. The values for each button and axis are the same as for the glfwGetJoystickButtons and glfwGetJoystickAxes functions, i.e. GLFW_PRESS or GLFW_RELEASE for buttons and -1.0 to 1.0 inclusive for axes.
The sizes of the arrays and the positions within each array are fixed.
+The button indices are GLFW_GAMEPAD_BUTTON_A, GLFW_GAMEPAD_BUTTON_B, GLFW_GAMEPAD_BUTTON_X, GLFW_GAMEPAD_BUTTON_Y, GLFW_GAMEPAD_BUTTON_LEFT_BUMPER, GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER, GLFW_GAMEPAD_BUTTON_BACK, GLFW_GAMEPAD_BUTTON_START, GLFW_GAMEPAD_BUTTON_GUIDE, GLFW_GAMEPAD_BUTTON_LEFT_THUMB, GLFW_GAMEPAD_BUTTON_RIGHT_THUMB, GLFW_GAMEPAD_BUTTON_DPAD_UP, GLFW_GAMEPAD_BUTTON_DPAD_RIGHT, GLFW_GAMEPAD_BUTTON_DPAD_DOWN and GLFW_GAMEPAD_BUTTON_DPAD_LEFT.
For those who prefer, there are also the GLFW_GAMEPAD_BUTTON_CROSS, GLFW_GAMEPAD_BUTTON_CIRCLE, GLFW_GAMEPAD_BUTTON_SQUARE and GLFW_GAMEPAD_BUTTON_TRIANGLE aliases for the A, B, X and Y button indices.
The axis indices are GLFW_GAMEPAD_AXIS_LEFT_X, GLFW_GAMEPAD_AXIS_LEFT_Y, GLFW_GAMEPAD_AXIS_RIGHT_X, GLFW_GAMEPAD_AXIS_RIGHT_Y, GLFW_GAMEPAD_AXIS_LEFT_TRIGGER and GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER.
The GLFW_GAMEPAD_BUTTON_LAST and GLFW_GAMEPAD_AXIS_LAST constants equal the largest available index for each array.
+Gamepad mappings
+GLFW contains a copy of the mappings available in SDL_GameControllerDB at the time of release. Newer ones can be added at runtime with glfwUpdateGamepadMappings.
+This function supports everything from single lines up to and including the unmodified contents of the whole gamecontrollerdb.txt file.
If you are compiling GLFW from source with CMake you can update the built-in mappings by building the update_mappings target. This runs the GenerateMappings.cmake CMake script, which downloads gamecontrollerdb.txt and regenerates the mappings.h header file.
Below is a description of the mapping format. Please keep in mind that this description is not authoritative. The format is defined by the SDL and SDL_GameControllerDB projects and their documentation and code takes precedence.
+Each mapping is a single line of comma-separated values describing the GUID, name and layout of the gamepad. Lines that do not begin with a hexadecimal digit are ignored.
+The first value is always the gamepad GUID, a 32 character long hexadecimal string that typically identifies its make, model, revision and the type of connection to the computer. When this information is not available, the GUID is generated using the gamepad name. GLFW uses the SDL 2.0.5+ GUID format but can convert from the older formats.
+The second value is always the human-readable name of the gamepad.
+All subsequent values are in the form <field>:<value> and describe the layout of the mapping. These fields may not all be present and may occur in any order.
The button fields are a, b, x, y, back, start, guide, dpup, dpright, dpdown, dpleft, leftshoulder, rightshoulder, leftstick and rightstick.
The axis fields are leftx, lefty, rightx, righty, lefttrigger and righttrigger.
The value of an axis or button field can be a joystick button, a joystick axis, a hat bitmask or empty. Joystick buttons are specified as bN, for example b2 for the third button. Joystick axes are specified as aN, for example a7 for the eighth button. Joystick hat bit masks are specified as hN.N, for example h0.8 for left on the first hat. More than one bit may be set in the mask.
Before an axis there may be a + or - range modifier, for example +a3 for the positive half of the fourth axis. This restricts input to only the positive or negative halves of the joystick axis. After an axis or half-axis there may be the ~ inversion modifier, for example a2~ or -a7~. This negates the values of the gamepad axis.
The hat bit mask match the hat states in the joystick functions.
+There is also the special platform field that specifies which platform the mapping is valid for. Possible values are Windows, Mac OS X and Linux.
Below is an example of what a gamepad mapping might look like. It is the one built into GLFW for Xbox controllers accessed via the XInput API on Windows. This example has been broken into several lines to fit on the page, but real gamepad mappings must be a single line.
+- Note
- GLFW does not yet support the output range and modifiers
+and-that were recently added to SDL. The input modifiers+,-and~are supported and described above.
+Time input
+GLFW provides high-resolution time input, in seconds, with glfwGetTime.
+It returns the number of seconds since the library was initialized with glfwInit. The platform-specific time sources used typically have micro- or nanosecond resolution.
+You can modify the base time with glfwSetTime.
+This sets the time to the specified time, in seconds, and it continues to count from there.
+You can also access the raw timer used to implement the functions above, with glfwGetTimerValue.
+This value is in 1 / frequency seconds. The frequency of the raw timer varies depending on the operating system and hardware. You can query the frequency, in Hz, with glfwGetTimerFrequency.
++Clipboard input and output
+If the system clipboard contains a UTF-8 encoded string or if it can be converted to one, you can retrieve it with glfwGetClipboardString. See the reference documentation for the lifetime of the returned string.
+If the clipboard is empty or if its contents could not be converted, NULL is returned.
The contents of the system clipboard can be set to a UTF-8 encoded string with glfwSetClipboardString.
++Path drop input
+If you wish to receive the paths of files and/or directories dropped on a window, set a file drop callback.
+The callback function receives an array of paths encoded as UTF-8.
+The path array and its strings are only valid until the file drop callback returns, as they may have been generated specifically for that event. You need to make a deep copy of the array if you want to keep the paths.
++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/internal_8dox.html b/deps/glfw-3.3.8/docs/html/internal_8dox.html new file mode 100644 index 0000000..9c401ab --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/internal_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/internals_guide.html b/deps/glfw-3.3.8/docs/html/internals_guide.html new file mode 100644 index 0000000..6d96b4d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/internals_guide.html @@ -0,0 +1,125 @@ + + + + + + + +Table of Contents
+ +There are several interfaces inside GLFW. Each interface has its own area of responsibility and its own naming conventions.
++Public interface
+The most well-known is the public interface, described in the glfw3.h header file. This is implemented in source files shared by all platforms and these files contain no platform-specific code. This code usually ends up calling the platform and internal interfaces to do the actual work.
+The public interface uses the OpenGL naming conventions except with GLFW and glfw instead of GL and gl. For struct members, where OpenGL sets no precedent, it use headless camel case.
+Examples: glfwCreateWindow, GLFWwindow, GLFW_RED_BITS
+Native interface
+The native interface is a small set of publicly available but platform-specific functions, described in the glfw3native.h header file and used to gain access to the underlying window, context and (on some platforms) display handles used by the platform interface.
+The function names of the native interface are similar to those of the public interface, but embeds the name of the interface that the returned handle is from.
+Examples: glfwGetX11Window, glfwGetWGLContext
+Internal interface
+The internal interface consists of utility functions used by all other interfaces. It is shared code implemented in the same shared source files as the public and event interfaces. The internal interface is described in the internal.h header file.
+The internal interface is in charge of GLFW's global data, which it stores in a _GLFWlibrary struct named _glfw.
The internal interface uses the same style as the public interface, except all global names have a leading underscore.
+Examples: _glfwIsValidContextConfig, _GLFWwindow, _glfw.monitorCount
+Platform interface
+The platform interface implements all platform-specific operations as a service to the public interface. This includes event processing. The platform interface is never directly called by application code and never directly calls application-provided callbacks. It is also prohibited from modifying the platform-independent part of the internal structs. Instead, it calls the event interface when events interesting to GLFW are received.
+The platform interface mirrors those parts of the public interface that needs to perform platform-specific operations on some or all platforms. The are also named the same except that the glfw function prefix is replaced by _glfwPlatform.
+Examples: _glfwPlatformCreateWindow
The platform interface also defines structs that contain platform-specific global and per-object state. Their names mirror those of the internal interface, except that an interface-specific suffix is added.
+Examples: _GLFWwindowX11, _GLFWcontextWGL
These structs are incorporated as members into the internal interface structs using special macros that name them after the specific interface used. This prevents shared code from accidentally using these members.
+Examples: window->win32.handle, _glfw.x11.display
+Event interface
+The event interface is implemented in the same shared source files as the public interface and is responsible for delivering the events it receives to the application, either via callbacks, via window state changes or both.
+The function names of the event interface use a _glfwInput prefix and the ObjectEvent pattern.
Examples: _glfwInputWindowFocus, _glfwInputCursorPos
+Static functions
+Static functions may be used by any interface and have no prefixes or suffixes. These use headless camel case.
+Examples: isValidElementForJoystick
+Configuration macros
+GLFW uses a number of configuration macros to select at compile time which interfaces and code paths to use. They are defined in the glfw_config.h header file, which is generated from the glfw_config.h.in file by CMake.
Configuration macros the same style as tokens in the public interface, except with a leading underscore.
+Examples: _GLFW_WIN32, _GLFW_BUILD_DLL
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/intro_8dox.html b/deps/glfw-3.3.8/docs/html/intro_8dox.html new file mode 100644 index 0000000..6bf836e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/intro_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/intro_guide.html b/deps/glfw-3.3.8/docs/html/intro_guide.html new file mode 100644 index 0000000..7ca3f1e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/intro_guide.html @@ -0,0 +1,329 @@ + + + + + + + +Table of Contents
+ +This guide introduces the basic concepts of GLFW and describes initialization, error handling and API guarantees and limitations. For a broad but shallow tutorial, see Getting started instead. For details on a specific function in this category, see the Initialization, version and error reference.
+There are also guides for the other areas of GLFW.
+ ++Initialization and termination
+Before most GLFW functions may be called, the library must be initialized. This initialization checks what features are available on the machine, enumerates monitors and joysticks, initializes the timer and performs any required platform-specific initialization.
+Only the following functions may be called before the library has been successfully initialized, and only from the main thread.
+-
+
- glfwGetVersion +
- glfwGetVersionString +
- glfwGetError +
- glfwSetErrorCallback +
- glfwInitHint +
- glfwInit +
- glfwTerminate +
Calling any other function before successful initialization will cause a GLFW_NOT_INITIALIZED error.
++Initializing GLFW
+The library is initialized with glfwInit, which returns GLFW_FALSE if an error occurred.
If any part of initialization fails, any parts that succeeded are terminated as if glfwTerminate had been called. The library only needs to be initialized once and additional calls to an already initialized library will return GLFW_TRUE immediately.
Once the library has been successfully initialized, it should be terminated before the application exits. Modern systems are very good at freeing resources allocated by programs that exit, but GLFW sometimes has to change global system settings and these might not be restored without termination.
++Initialization hints
+Initialization hints are set before glfwInit and affect how the library behaves until termination. Hints are set with glfwInitHint.
+The values you set hints to are never reset by GLFW, but they only take effect during initialization. Once GLFW has been initialized, any values you set will be ignored until the library is terminated and initialized again.
+Some hints are platform specific. These may be set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or functions.
++Shared init hints
+GLFW_JOYSTICK_HAT_BUTTONS specifies whether to also expose joystick hats as buttons, for compatibility with earlier versions of GLFW that did not have glfwGetJoystickHats. Possible values are GLFW_TRUE and GLFW_FALSE.
+macOS specific init hints
+GLFW_COCOA_CHDIR_RESOURCES specifies whether to set the current directory to the application to the Contents/Resources subdirectory of the application's bundle, if present. Set this with glfwInitHint.
GLFW_COCOA_MENUBAR specifies whether to create a basic menu bar, either from a nib or manually, when the first window is created, which is when AppKit is initialized. Set this with glfwInitHint.
++Supported and default values
+| Initialization hint | Default value | Supported values |
|---|---|---|
| GLFW_JOYSTICK_HAT_BUTTONS | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_COCOA_CHDIR_RESOURCES | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_COCOA_MENUBAR | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
+Terminating GLFW
+Before your application exits, you should terminate the GLFW library if it has been initialized. This is done with glfwTerminate.
+This will destroy any remaining window, monitor and cursor objects, restore any modified gamma ramps, re-enable the screensaver if it had been disabled and free any other resources allocated by GLFW.
+Once the library is terminated, it is as if it had never been initialized and you will need to initialize it again before being able to use GLFW. If the library was not initialized or had already been terminated, it return immediately.
++Error handling
+Some GLFW functions have return values that indicate an error, but this is often not very helpful when trying to figure out what happened or why it occurred. Other functions have no return value reserved for errors, so error notification needs a separate channel. Finally, far from all GLFW functions have return values.
+The last error code for the calling thread can be queried at any time with glfwGetError.
+If no error has occurred since the last call, GLFW_NO_ERROR (zero) is returned. The error is cleared before the function returns.
+The error code indicates the general category of the error. Some error codes, such as GLFW_NOT_INITIALIZED has only a single meaning, whereas others like GLFW_PLATFORM_ERROR are used for many different errors.
+GLFW often has more information about an error than its general category. You can retrieve a UTF-8 encoded human-readable description along with the error code. If no error has occurred since the last call, the description is set to NULL.
The retrieved description string is only valid until the next error occurs. This means you must make a copy of it if you want to keep it.
+You can also set an error callback, which will be called each time an error occurs. It is set with glfwSetErrorCallback.
+The error callback receives the same error code and human-readable description returned by glfwGetError.
+The error callback is called after the error is stored, so calling glfwGetError from within the error callback returns the same values as the callback argument.
+The description string passed to the callback is only valid until the error callback returns. This means you must make a copy of it if you want to keep it.
+Reported errors are never fatal. As long as GLFW was successfully initialized, it will remain initialized and in a safe state until terminated regardless of how many errors occur. If an error occurs during initialization that causes glfwInit to fail, any part of the library that was initialized will be safely terminated.
+Do not rely on a currently invalid call to generate a specific error, as in the future that same call may generate a different error or become valid.
++Coordinate systems
+GLFW has two primary coordinate systems: the virtual screen and the window content area or content area. Both use the same unit: virtual screen coordinates, or just screen coordinates, which don't necessarily correspond to pixels.
+
Both the virtual screen and the content area coordinate systems have the X-axis pointing to the right and the Y-axis pointing down.
+Window and monitor positions are specified as the position of the upper-left corners of their content areas relative to the virtual screen, while cursor positions are specified relative to a window's content area.
+Because the origin of the window's content area coordinate system is also the point from which the window position is specified, you can translate content area coordinates to the virtual screen by adding the window position. The window frame, when present, extends out from the content area but does not affect the window position.
+Almost all positions and sizes in GLFW are measured in screen coordinates relative to one of the two origins above. This includes cursor positions, window positions and sizes, window frame sizes, monitor positions and video mode resolutions.
+Two exceptions are the monitor physical size, which is measured in millimetres, and framebuffer size, which is measured in pixels.
+Pixels and screen coordinates may map 1:1 on your machine, but they won't on every other machine, for example on a Mac with a Retina display. The ratio between screen coordinates and pixels may also change at run-time depending on which monitor the window is currently considered to be on.
++Guarantees and limitations
+This section describes the conditions under which GLFW can be expected to function, barring bugs in the operating system or drivers. Use of GLFW outside of these limits may work on some platforms, or on some machines, or some of the time, or on some versions of GLFW, but it may break at any time and this will not be considered a bug.
++Pointer lifetimes
+GLFW will never free any pointer you provide to it and you must never free any pointer it provides to you.
+Many GLFW functions return pointers to dynamically allocated structures, strings or arrays, and some callbacks are provided with strings or arrays. These are always managed by GLFW and should never be freed by the application. The lifetime of these pointers is documented for each GLFW function and callback. If you need to keep this data, you must copy it before its lifetime expires.
+Many GLFW functions accept pointers to structures or strings allocated by the application. These are never freed by GLFW and are always the responsibility of the application. If GLFW needs to keep the data in these structures or strings, it is copied before the function returns.
+Pointer lifetimes are guaranteed not to be shortened in future minor or patch releases.
++Reentrancy
+GLFW event processing and object destruction are not reentrant. This means that the following functions must not be called from any callback function:
+-
+
- glfwDestroyWindow +
- glfwDestroyCursor +
- glfwPollEvents +
- glfwWaitEvents +
- glfwWaitEventsTimeout +
- glfwTerminate +
These functions may be made reentrant in future minor or patch releases, but functions not on this list will not be made non-reentrant.
++Thread safety
+Most GLFW functions must only be called from the main thread (the thread that calls main), but some may be called from any thread once the library has been initialized. Before initialization the whole library is thread-unsafe.
+The reference documentation for every GLFW function states whether it is limited to the main thread.
+Initialization, termination, event processing and the creation and destruction of windows, cursors and OpenGL and OpenGL ES contexts are all restricted to the main thread due to limitations of one or several platforms.
+Because event processing must be performed on the main thread, all callbacks except for the error callback will only be called on that thread. The error callback may be called on any thread, as any GLFW function may generate errors.
+The error code and description may be queried from any thread.
+-
+
- glfwGetError +
Empty events may be posted from any thread.
+ +The window user pointer and close flag may be read and written from any thread, but this is not synchronized by GLFW.
+-
+
- glfwGetWindowUserPointer +
- glfwSetWindowUserPointer +
- glfwWindowShouldClose +
- glfwSetWindowShouldClose +
These functions for working with OpenGL and OpenGL ES contexts may be called from any thread, but the window object is not synchronized by GLFW.
+-
+
- glfwMakeContextCurrent +
- glfwGetCurrentContext +
- glfwSwapBuffers +
- glfwSwapInterval +
- glfwExtensionSupported +
- glfwGetProcAddress +
The raw timer functions may be called from any thread.
+ +The regular timer may be used from any thread, but reading and writing the timer offset is not synchronized by GLFW.
+ +Library version information may be queried from any thread.
+ +All Vulkan related functions may be called from any thread.
+-
+
- glfwVulkanSupported +
- glfwGetRequiredInstanceExtensions +
- glfwGetInstanceProcAddress +
- glfwGetPhysicalDevicePresentationSupport +
- glfwCreateWindowSurface +
GLFW uses synchronization objects internally only to manage the per-thread context and error states. Additional synchronization is left to the application.
+Functions that may currently be called from any thread will always remain so, but functions that are currently limited to the main thread may be updated to allow calls from any thread in future releases.
++Version compatibility
+GLFW uses Semantic Versioning. This guarantees source and binary backward compatibility with earlier minor versions of the API. This means that you can drop in a newer version of the library and existing programs will continue to compile and existing binaries will continue to run.
+Once a function or constant has been added, the signature of that function or value of that constant will remain unchanged until the next major version of GLFW. No compatibility of any kind is guaranteed between major versions.
+Undocumented behavior, i.e. behavior that is not described in the documentation, may change at any time until it is documented.
+If the reference documentation and the implementation differ, the reference documentation will almost always take precedence and the implementation will be fixed in the next release. The reference documentation will also take precedence over anything stated in a guide.
++Event order
+The order of arrival of related events is not guaranteed to be consistent across platforms. The exception is synthetic key and mouse button release events, which are always delivered after the window defocus event.
++Version management
+GLFW provides mechanisms for identifying what version of GLFW your application was compiled against as well as what version it is currently running against. If you are loading GLFW dynamically (not just linking dynamically), you can use this to verify that the library binary is compatible with your application.
++Compile-time version
+The compile-time version of GLFW is provided by the GLFW header with the GLFW_VERSION_MAJOR, GLFW_VERSION_MINOR and GLFW_VERSION_REVISION macros.
+Run-time version
+The run-time version can be retrieved with glfwGetVersion, a function that may be called regardless of whether GLFW is initialized.
++Version string
+GLFW 3 also provides a compile-time generated version string that describes the version, platform, compiler and any platform-specific compile-time options. This is primarily intended for submitting bug reports, to allow developers to see which code paths are enabled in a binary.
+The version string is returned by glfwGetVersionString, a function that may be called regardless of whether GLFW is initialized.
+Do not use the version string to parse the GLFW library version. The glfwGetVersion function already provides the version of the running library 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:
++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/jquery.js b/deps/glfw-3.3.8/docs/html/jquery.js new file mode 100644 index 0000000..c9ed3d9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/jquery.js @@ -0,0 +1,35 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/menu.js b/deps/glfw-3.3.8/docs/html/menu.js new file mode 100644 index 0000000..818b859 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/menu.js @@ -0,0 +1,135 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+='- ';
+ for (var i in data.children) {
+ var url;
+ var link;
+ link = data.children[i].url;
+ if (link.substring(0,1)=='^') {
+ url = link.substring(1);
+ } else {
+ url = relPath+link;
+ }
+ result+='
- '+ + data.children[i].text+''+ + makeTree(data.children[i],relPath)+' '; + } + result+='
'+
+ ''+
+ ''+
+ ''+
+ '
'
+ ''
+ '| Context reference | Functions and types related to OpenGL and OpenGL ES contexts |
| ▼Initialization, version and error reference | Functions and types related to initialization and error handling |
| Error codes | Error codes |
| ▼Input reference | Functions and types related to input handling |
| Gamepad axes | Gamepad axes |
| Gamepad buttons | Gamepad buttons |
| Joystick hat states | Joystick hat states |
| Joysticks | Joystick IDs |
| Keyboard keys | Keyboard key IDs |
| Modifier key flags | Modifier key flags |
| Mouse buttons | Mouse button IDs |
| Standard cursor shapes | Standard system cursor shapes |
| Monitor reference | Functions and types related to monitors |
| Native access | Functions related to accessing native handles |
| Vulkan support reference | Functions and types related to Vulkan |
| Window reference | Functions and types related to windows |
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/monitor_8dox.html b/deps/glfw-3.3.8/docs/html/monitor_8dox.html new file mode 100644 index 0000000..82aff6b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/monitor_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/monitor_guide.html b/deps/glfw-3.3.8/docs/html/monitor_guide.html new file mode 100644 index 0000000..76f47a5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/monitor_guide.html @@ -0,0 +1,222 @@ + + + + + + + +Table of Contents
+ +This guide introduces the monitor related functions of GLFW. For details on a specific function in this category, see the Monitor reference. There are also guides for the other areas of GLFW.
+ ++Monitor objects
+A monitor object represents a currently connected monitor and is represented as a pointer to the opaque type GLFWmonitor. Monitor objects cannot be created or destroyed by the application and retain their addresses until the monitors they represent are disconnected or until the library is terminated.
+Each monitor has a current video mode, a list of supported video modes, a virtual position, a human-readable name, an estimated physical size and a gamma ramp. One of the monitors is the primary monitor.
+The virtual position of a monitor is in screen coordinates and, together with the current video mode, describes the viewports that the connected monitors provide into the virtual desktop that spans them.
+To see how GLFW views your monitor setup and its available video modes, run the monitors test program.
+Retrieving monitors
+The primary monitor is returned by glfwGetPrimaryMonitor. It is the user's preferred monitor and is usually the one with global UI elements like task bar or menu bar.
+You can retrieve all currently connected monitors with glfwGetMonitors. See the reference documentation for the lifetime of the returned array.
+The primary monitor is always the first monitor in the returned array, but other monitors may be moved to a different index when a monitor is connected or disconnected.
++Monitor configuration changes
+If you wish to be notified when a monitor is connected or disconnected, set a monitor callback.
+The callback function receives the handle for the monitor that has been connected or disconnected and the event that occurred.
+If a monitor is disconnected, all windows that are full screen on it will be switched to windowed mode before the callback is called. Only glfwGetMonitorName and glfwGetMonitorUserPointer will return useful values for a disconnected monitor and only before the monitor callback returns.
++Monitor properties
+Each monitor has a current video mode, a list of supported video modes, a virtual position, a content scale, a human-readable name, a user pointer, an estimated physical size and a gamma ramp.
++Video modes
+GLFW generally does a good job selecting a suitable video mode when you create a full screen window, change its video mode or make a windowed one full screen, but it is sometimes useful to know exactly which video modes are supported.
+Video modes are represented as GLFWvidmode structures. You can get an array of the video modes supported by a monitor with glfwGetVideoModes. See the reference documentation for the lifetime of the returned array.
+To get the current video mode of a monitor call glfwGetVideoMode. See the reference documentation for the lifetime of the returned pointer.
+The resolution of a video mode is specified in screen coordinates, not pixels.
++Physical size
+The physical size of a monitor in millimetres, or an estimation of it, can be retrieved with glfwGetMonitorPhysicalSize. This has no relation to its current resolution, i.e. the width and height of its current video mode.
+While this can be used to calculate the raw DPI of a monitor, this is often not useful. Instead use the monitor content scale and window content scale to scale your content.
++Content scale
+The content scale for a monitor can be retrieved with glfwGetMonitorContentScale.
+The content scale is the ratio between the current DPI and the platform's default DPI. This is especially important for text and any UI elements. If the pixel dimensions of your UI scaled by this look appropriate on your machine then it should appear at a reasonable size on other machines regardless of their DPI and scaling settings. This relies on the system DPI and scaling settings being somewhat correct.
+The content scale may depend on both the monitor resolution and pixel density and on user settings. It may be very different from the raw DPI calculated from the physical size and current resolution.
++Virtual position
+The position of the monitor on the virtual desktop, in screen coordinates, can be retrieved with glfwGetMonitorPos.
++Work area
+The area of a monitor not occupied by global task bars or menu bars is the work area. This is specified in screen coordinates and can be retrieved with glfwGetMonitorWorkarea.
++Human-readable name
+The human-readable, UTF-8 encoded name of a monitor is returned by glfwGetMonitorName. See the reference documentation for the lifetime of the returned string.
+Monitor names are not guaranteed to be unique. Two monitors of the same model and make may have the same name. Only the monitor handle is guaranteed to be unique, and only until that monitor is disconnected.
++User pointer
+Each monitor has a user pointer that can be set with glfwSetMonitorUserPointer and queried with glfwGetMonitorUserPointer. This can be used for any purpose you need and will not be modified by GLFW. The value will be kept until the monitor is disconnected or until the library is terminated.
+The initial value of the pointer is NULL.
+Gamma ramp
+The gamma ramp of a monitor can be set with glfwSetGammaRamp, which accepts a monitor handle and a pointer to a GLFWgammaramp structure.
+The gamma ramp data is copied before the function returns, so there is no need to keep it around once the ramp has been set.
+It is recommended that your gamma ramp have the same size as the current gamma ramp for that monitor.
+The current gamma ramp for a monitor is returned by glfwGetGammaRamp. See the reference documentation for the lifetime of the returned structure.
+If you wish to set a regular gamma ramp, you can have GLFW calculate it for you from the desired exponent with glfwSetGamma, which in turn calls glfwSetGammaRamp with the resulting ramp.
+To experiment with gamma correction via the glfwSetGamma function, run the gamma test program.
- Note
- The software controlled gamma ramp is applied in addition to the hardware gamma correction, which today is usually an approximation of sRGB gamma. This means that setting a perfectly linear ramp, or gamma 1.0, will produce the default (usually sRGB-like) behavior.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/moving_8dox.html b/deps/glfw-3.3.8/docs/html/moving_8dox.html new file mode 100644 index 0000000..4d3a225 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/moving_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/moving_guide.html b/deps/glfw-3.3.8/docs/html/moving_guide.html new file mode 100644 index 0000000..d8b1a2b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/moving_guide.html @@ -0,0 +1,367 @@ + + + + + + + +Table of Contents
+- Changed and removed features
- Renamed library and header file +
- Removal of threading functions +
- Removal of image and texture loading +
- Removal of GLFWCALL macro +
- Window handle parameters +
- Explicit monitor selection +
- Removal of automatic event polling +
- Explicit context management +
- Separation of window and framebuffer sizes +
- Window closing changes +
- Persistent window hints +
- Video mode enumeration +
- Removal of character actions +
- Cursor position changes +
- Wheel position replaced by scroll offsets +
- Key repeat action +
- Physical key input +
- Joystick function changes +
- Win32 MBCS support +
- Support for versions of Windows older than XP +
- Capture of system-wide hotkeys +
- Automatic termination +
- GLU header inclusion +
+ - Name change tables + +
This is a transition guide for moving from GLFW 2 to 3. It describes what has changed or been removed, but does not include new features unless they are required when moving an existing code base onto the new API. For example, the new multi-monitor functions are required to create full screen windows with GLFW 3.
++Changed and removed features
++Renamed library and header file
+The GLFW 3 header is named glfw3.h and moved to the GLFW directory, to avoid collisions with the headers of other major versions. Similarly, the GLFW 3 library is named glfw3, except when it's installed as a shared library on Unix-like systems, where it uses the soname libglfw.so.3.
- Old syntax
- #include <GL/glfw.h>+
- New syntax
- #include <GLFW/glfw3.h>++The header of the GLFW 3 API.
+Removal of threading functions
+The threading functions have been removed, including the per-thread sleep function. They were fairly primitive, under-used, poorly integrated and took time away from the focus of GLFW (i.e. context, input and window). There are better threading libraries available and native threading support is available in both C++11 and C11, both of which are gaining traction.
+If you wish to use the C++11 or C11 facilities but your compiler doesn't yet support them, see the TinyThread++ and TinyCThread projects created by the original author of GLFW. These libraries implement a usable subset of the threading APIs in C++11 and C11, and in fact some GLFW 3 test programs use TinyCThread.
+However, GLFW 3 has better support for use from multiple threads than GLFW 2 had. Contexts can be made current on any thread, although only a single thread at a time, and the documentation explicitly states which functions may be used from any thread and which must only be used from the main thread.
+- Removed functions
glfwSleep,glfwCreateThread,glfwDestroyThread,glfwWaitThread,glfwGetThreadID,glfwCreateMutex,glfwDestroyMutex,glfwLockMutex,glfwUnlockMutex,glfwCreateCond,glfwDestroyCond,glfwWaitCond,glfwSignalCond,glfwBroadcastCondandglfwGetNumberOfProcessors.
- Removed types
GLFWthreadfun
+Removal of image and texture loading
+The image and texture loading functions have been removed. They only supported the Targa image format, making them mostly useful for beginner level examples. To become of sufficiently high quality to warrant keeping them in GLFW 3, they would need not only to support other formats, but also modern extensions to OpenGL texturing. This would either add a number of external dependencies (libjpeg, libpng, etc.), or force GLFW to ship with inline versions of these libraries.
+As there already are libraries doing this, it is unnecessary both to duplicate the work and to tie the duplicate to GLFW. The resulting library would also be platform-independent, as both OpenGL and stdio are available wherever GLFW is.
+- Removed functions
glfwReadImage,glfwReadMemoryImage,glfwFreeImage,glfwLoadTexture2D,glfwLoadMemoryTexture2DandglfwLoadTextureImage2D.
+Removal of GLFWCALL macro
+The GLFWCALL macro, which made callback functions use __stdcall on Windows, has been removed. GLFW is written in C, not Pascal. Removing this macro means there's one less thing for application programmers to remember, i.e. the requirement to mark all callback functions with GLFWCALL. It also simplifies the creation of DLLs and DLL link libraries, as there's no need to explicitly disable @n entry point suffixes.
- Old syntax
- void GLFWCALL callback_function(...);+
- New syntax
- void callback_function(...);+
+Window handle parameters
+Because GLFW 3 supports multiple windows, window handle parameters have been added to all window-related GLFW functions and callbacks. The handle of a newly created window is returned by glfwCreateWindow (formerly glfwOpenWindow). Window handles are pointers to the opaque type GLFWwindow.
- Old syntax
- glfwSetWindowTitle("New Window Title");++void glfwSetWindowTitle(GLFWwindow *window, const char *title)Sets the title of the specified window.
- New syntax
- glfwSetWindowTitle(window, "New Window Title");+
+Explicit monitor selection
+GLFW 3 provides support for multiple monitors. To request a full screen mode window, instead of passing GLFW_FULLSCREEN you specify which monitor you wish the window to use. The glfwGetPrimaryMonitor function returns the monitor that GLFW 2 would have selected, but there are many other monitor functions. Monitor handles are pointers to the opaque type GLFWmonitor.
- Old basic full screen
- glfwOpenWindow(640, 480, 8, 8, 8, 0, 24, 0, GLFW_FULLSCREEN);+
- New basic full screen
- + ++GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)Creates a window and its associated context.
- Note
- The framebuffer bit depth parameters of
glfwOpenWindowhave been turned into window hints, but as they have been given sane defaults you rarely need to set these hints.
+Removal of automatic event polling
+GLFW 3 does not automatically poll for events in glfwSwapBuffers, meaning you need to call glfwPollEvents or glfwWaitEvents yourself. Unlike buffer swap, which acts on a single window, the event processing functions act on all windows at once.
+- Old basic main loop
- while (...)+{+// Process input+// Render output+ +}++void glfwSwapBuffers(GLFWwindow *window)Swaps the front and back buffers of the specified window.
- New basic main loop
+Explicit context management
+Each GLFW 3 window has its own OpenGL context and only you, the application programmer, can know which context should be current on which thread at any given time. Therefore, GLFW 3 leaves that decision to you.
+This means that you need to call glfwMakeContextCurrent after creating a window before you can call any OpenGL functions.
++Separation of window and framebuffer sizes
+Window positions and sizes now use screen coordinates, which may not be the same as pixels on machines with high-DPI monitors. This is important as OpenGL uses pixels, not screen coordinates. For example, the rectangle specified with glViewport needs to use pixels. Therefore, framebuffer size functions have been added. You can retrieve the size of the framebuffer of a window with glfwGetFramebufferSize function. A framebuffer size callback has also been added, which can be set with glfwSetFramebufferSizeCallback.
- Old basic viewport setup
- glfwGetWindowSize(&width, &height);+glViewport(0, 0, width, height);++void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)Retrieves the size of the content area of the specified window.
- New basic viewport setup
- glfwGetFramebufferSize(window, &width, &height);+glViewport(0, 0, width, height);++void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)Retrieves the size of the framebuffer of the specified window.
+Window closing changes
+The GLFW_OPENED window parameter has been removed. As long as the window has not been destroyed, whether through glfwDestroyWindow or glfwTerminate, the window is "open".
A user attempting to close a window is now just an event like any other. Unlike GLFW 2, windows and contexts created with GLFW 3 will never be destroyed unless you choose them to be. Each window now has a close flag that is set to GLFW_TRUE when the user attempts to close that window. By default, nothing else happens and the window stays visible. It is then up to you to either destroy the window, take some other action or ignore the request.
You can query the close flag at any time with glfwWindowShouldClose and set it at any time with glfwSetWindowShouldClose.
+- Old basic main loop
- while (glfwGetWindowParam(GLFW_OPENED))+{+...+}+
- New basic main loop
- while (!glfwWindowShouldClose(window))+{+...+}++int glfwWindowShouldClose(GLFWwindow *window)Checks the close flag of the specified window.
The close callback no longer returns a value. Instead, it is called after the close flag has been set so it can override its value, if it chooses to, before event processing completes. You may however not call glfwDestroyWindow from the close callback (or any other window related callback).
+- Old syntax
- int GLFWCALL window_close_callback(void);+
- New syntax
- void window_close_callback(GLFWwindow* window);+ +
- Note
- GLFW never clears the close flag to
GLFW_FALSE, meaning you can use it for other reasons to close the window as well, for example the user choosing Quit from an in-game menu.
+Persistent window hints
+The glfwOpenWindowHint function has been renamed to glfwWindowHint.
Window hints are no longer reset to their default values on window creation, but instead retain their values until modified by glfwWindowHint or glfwDefaultWindowHints, or until the library is terminated and re-initialized.
++Video mode enumeration
+Video mode enumeration is now per-monitor. The glfwGetVideoModes function now returns all available modes for a specific monitor instead of requiring you to guess how large an array you need. The glfwGetDesktopMode function, which had poorly defined behavior, has been replaced by glfwGetVideoMode, which returns the current mode of a monitor.
+Removal of character actions
+The action parameter of the character callback has been removed. This was an artefact of the origin of GLFW, i.e. being developed in English by a Swede. However, many keyboard layouts require more than one key to produce characters with diacritical marks. Even the Swedish keyboard layout requires this for uncommon cases like ü.
+- Old syntax
- void GLFWCALL character_callback(int character, int action);+
- New syntax
- +
+Cursor position changes
+The glfwGetMousePos function has been renamed to glfwGetCursorPos, glfwSetMousePos to glfwSetCursorPos and glfwSetMousePosCallback to glfwSetCursorPosCallback.
The cursor position is now double instead of int, both for the direct functions and for the callback. Some platforms can provide sub-pixel cursor movement and this data is now passed on to the application where available. On platforms where this is not provided, the decimal part is zero.
GLFW 3 only allows you to position the cursor within a window using glfwSetCursorPos (formerly glfwSetMousePos) when that window is active. Unless the window is active, the function fails silently.
+Wheel position replaced by scroll offsets
+The glfwGetMouseWheel function has been removed. Scrolling is the input of offsets and has no absolute position. The mouse wheel callback has been replaced by a scroll callback that receives two-dimensional floating point scroll offsets. This allows you to receive precise scroll data from for example modern touchpads.
- Old syntax
- void GLFWCALL mouse_wheel_callback(int position);+
- New syntax
- +
- Removed functions
glfwGetMouseWheel
+Key repeat action
+The GLFW_KEY_REPEAT enable has been removed and key repeat is always enabled for both keys and characters. A new key action, GLFW_REPEAT, has been added to allow the key callback to distinguish an initial key press from a repeat. Note that glfwGetKey still returns only GLFW_PRESS or GLFW_RELEASE.
+Physical key input
+GLFW 3 key tokens map to physical keys, unlike in GLFW 2 where they mapped to the values generated by the current keyboard layout. The tokens are named according to the values they would have using the standard US layout, but this is only a convenience, as most programmers are assumed to know that layout. This means that (for example) GLFW_KEY_LEFT_BRACKET is always a single key and is the same key in the same place regardless of what keyboard layouts the users of your program has.
The key input facility was never meant for text input, although using it that way worked slightly better in GLFW 2. If you were using it to input text, you should be using the character callback instead, on both GLFW 2 and 3. This will give you the characters being input, as opposed to the keys being pressed.
+GLFW 3 has key tokens for all keys on a standard 105 key keyboard, so instead of having to remember whether to check for a or A, you now check for GLFW_KEY_A.
+Joystick function changes
+The glfwGetJoystickPos function has been renamed to glfwGetJoystickAxes.
The glfwGetJoystickParam function and the GLFW_PRESENT, GLFW_AXES and GLFW_BUTTONS tokens have been replaced by the glfwJoystickPresent function as well as axis and button counts returned by the glfwGetJoystickAxes and glfwGetJoystickButtons functions.
+Win32 MBCS support
+The Win32 port of GLFW 3 will not compile in MBCS mode. However, because the use of the Unicode version of the Win32 API doesn't affect the process as a whole, but only those windows created using it, it's perfectly possible to call MBCS functions from other parts of the same application. Therefore, even if an application using GLFW has MBCS mode code, there's no need for GLFW itself to support it.
++Support for versions of Windows older than XP
+All explicit support for version of Windows older than XP has been removed. There is no code that actively prevents GLFW 3 from running on these earlier versions, but it uses Win32 functions that those versions lack.
+Windows XP was released in 2001, and by now (January 2015) it has not only replaced almost all earlier versions of Windows, but is itself rapidly being replaced by Windows 7 and 8. The MSDN library doesn't even provide documentation for version older than Windows 2000, making it difficult to maintain compatibility with these versions even if it was deemed worth the effort.
+The Win32 API has also not stood still, and GLFW 3 uses many functions only present on Windows XP or later. Even supporting an OS as new as XP (new from the perspective of GLFW 2, which still supports Windows 95) requires runtime checking for a number of functions that are present only on modern version of Windows.
++Capture of system-wide hotkeys
+The ability to disable and capture system-wide hotkeys like Alt+Tab has been removed. Modern applications, whether they're games, scientific visualisations or something else, are nowadays expected to be good desktop citizens and allow these hotkeys to function even when running in full screen mode.
++Automatic termination
+GLFW 3 does not register glfwTerminate with atexit at initialization, because exit calls registered functions from the calling thread and while it is permitted to call exit from any thread, glfwTerminate must only be called from the main thread.
To release all resources allocated by GLFW, you should call glfwTerminate yourself, from the main thread, before the program terminates. Note that this destroys all windows not already destroyed with glfwDestroyWindow, invalidating any window handles you may still have.
++GLU header inclusion
+GLFW 3 does not by default include the GLU header and GLU itself has been deprecated by Khronos. New projects should not use GLU, but if you need it for legacy code that has been moved to GLFW 3, you can request that the GLFW header includes it by defining GLFW_INCLUDE_GLU before the inclusion of the GLFW header.
+- Old syntax
- #include <GL/glfw.h>+
- New syntax
- #define GLFW_INCLUDE_GLU+#include <GLFW/glfw3.h>+
There are many libraries that offer replacements for the functionality offered by GLU. For the matrix helper functions, see math libraries like GLM (for C++), linmath.h (for C) and others. For the tessellation functions, see for example libtess2.
++Name change tables
++Renamed functions
+| GLFW 2 | GLFW 3 | Notes |
|---|---|---|
glfwOpenWindow | glfwCreateWindow | All channel bit depths are now hints |
glfwCloseWindow | glfwDestroyWindow | |
glfwOpenWindowHint | glfwWindowHint | Now accepts all GLFW_*_BITS tokens |
glfwEnable | glfwSetInputMode | |
glfwDisable | glfwSetInputMode | |
glfwGetMousePos | glfwGetCursorPos | |
glfwSetMousePos | glfwSetCursorPos | |
glfwSetMousePosCallback | glfwSetCursorPosCallback | |
glfwSetMouseWheelCallback | glfwSetScrollCallback | Accepts two-dimensional scroll offsets as doubles |
glfwGetJoystickPos | glfwGetJoystickAxes | |
glfwGetWindowParam | glfwGetWindowAttrib | |
glfwGetGLVersion | glfwGetWindowAttrib | Use GLFW_CONTEXT_VERSION_MAJOR, GLFW_CONTEXT_VERSION_MINOR and GLFW_CONTEXT_REVISION |
glfwGetDesktopMode | glfwGetVideoMode | Returns the current mode of a monitor |
glfwGetJoystickParam | glfwJoystickPresent | The axis and button counts are provided by glfwGetJoystickAxes and glfwGetJoystickButtons |
+Renamed types
+| GLFW 2 | GLFW 3 | Notes |
|---|---|---|
GLFWmousewheelfun | GLFWscrollfun | |
GLFWmouseposfun | GLFWcursorposfun |
+Renamed tokens
+| GLFW 2 | GLFW 3 | Notes |
|---|---|---|
GLFW_OPENGL_VERSION_MAJOR | GLFW_CONTEXT_VERSION_MAJOR | Renamed as it applies to OpenGL ES as well |
GLFW_OPENGL_VERSION_MINOR | GLFW_CONTEXT_VERSION_MINOR | Renamed as it applies to OpenGL ES as well |
GLFW_FSAA_SAMPLES | GLFW_SAMPLES | Renamed to match the OpenGL API |
GLFW_ACTIVE | GLFW_FOCUSED | Renamed to match the window focus callback |
GLFW_WINDOW_NO_RESIZE | GLFW_RESIZABLE | The default has been inverted |
GLFW_MOUSE_CURSOR | GLFW_CURSOR | Used with glfwSetInputMode |
GLFW_KEY_ESC | GLFW_KEY_ESCAPE | |
GLFW_KEY_DEL | GLFW_KEY_DELETE | |
GLFW_KEY_PAGEUP | GLFW_KEY_PAGE_UP | |
GLFW_KEY_PAGEDOWN | GLFW_KEY_PAGE_DOWN | |
GLFW_KEY_KP_NUM_LOCK | GLFW_KEY_NUM_LOCK | |
GLFW_KEY_LCTRL | GLFW_KEY_LEFT_CONTROL | |
GLFW_KEY_LSHIFT | GLFW_KEY_LEFT_SHIFT | |
GLFW_KEY_LALT | GLFW_KEY_LEFT_ALT | |
GLFW_KEY_LSUPER | GLFW_KEY_LEFT_SUPER | |
GLFW_KEY_RCTRL | GLFW_KEY_RIGHT_CONTROL | |
GLFW_KEY_RSHIFT | GLFW_KEY_RIGHT_SHIFT | |
GLFW_KEY_RALT | GLFW_KEY_RIGHT_ALT | |
GLFW_KEY_RSUPER | GLFW_KEY_RIGHT_SUPER |
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/nav_f.png b/deps/glfw-3.3.8/docs/html/nav_f.png new file mode 100644 index 0000000..72a58a5 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_f.png differ diff --git a/deps/glfw-3.3.8/docs/html/nav_g.png b/deps/glfw-3.3.8/docs/html/nav_g.png new file mode 100644 index 0000000..2093a23 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_g.png differ diff --git a/deps/glfw-3.3.8/docs/html/nav_h.png b/deps/glfw-3.3.8/docs/html/nav_h.png new file mode 100644 index 0000000..33389b1 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_h.png differ diff --git a/deps/glfw-3.3.8/docs/html/news.html b/deps/glfw-3.3.8/docs/html/news.html new file mode 100644 index 0000000..0bf7e28 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/news.html @@ -0,0 +1,614 @@ + + + + + + + +Table of Contents
+- Release notes for version 3.3
- New features in version 3.3
- Gamepad input via SDL_GameControllerDB +
- Support for Vulkan on macOS via MoltenVK +
- Content scale queries for DPI-aware rendering +
- Support for updating window attributes +
- Support for raw mouse motion +
- Joystick hats +
- Error query +
- Support for initialization hints +
- User attention request +
- Window maximization callback +
- Query for the monitor work area +
- Transparent windows and framebuffers +
- Query for the scancode of a key +
- Cursor centering window hint +
- Mouse cursor hover window attribute +
- Window hint and attribute for input focus on show +
- Monitor and joystick user pointers +
- macOS menu bar from nib file +
- Support for more context creation extensions +
- OSMesa off-screen context creation support +
+ - Caveats for version 3.3
- Layout of joysticks have changed +
- No window required to wait for events +
- Gamma ramp size of 256 may be rejected +
- Windows XInput deadzone removed +
- X11 clipboard transfer limits +
- X11 extension libraries are loaded dynamically +
- CMake 3.0 or later is required +
- Framebuffer transparency requires DWM transparency +
- Empty events on X11 no longer roundtrip to server +
+ - Deprecations in version 3.3 + +
- Removals in 3.3 + +
- New symbols in version 3.3 + +
+ - New features in version 3.3
- Release notes for 3.2
- New features in version 3.2
- Support for Vulkan +
- Window mode switching +
- Window maxmimization support +
- Window input focus control +
- Window size limit support +
- Localized key names +
- Wait for events with timeout +
- Window icon support +
- Raw timer access +
- Joystick connection callback +
- Context-less windows +
- Run-time context creation API selection +
- Error-free context creation +
- CMake config-file package support +
+
+ - New features in version 3.2
- Release notes for 3.1
- New features in version 3.1
- Custom mouse cursor images +
- Path drop event +
- Main thread wake-up +
- Window frame size query +
- Simultaneous multi-monitor rendering +
- Floating windows +
- Initially unfocused windows +
- Direct access for window attributes and cursor position +
- Character with modifiers callback +
- Single buffered framebuffers +
- Macro for including extension header +
- Context release behaviors +
- (Experimental) Wayland support +
- (Experimental) Mir support +
+
+ - New features in version 3.1
- Release notes for 3.0
- New features in version 3.0
- CMake build system +
- Multi-window support +
- Multi-monitor support +
- Unicode support +
- Clipboard text I/O +
- Gamma ramp support +
- OpenGL ES support +
- (Experimental) EGL support +
- High-DPI support +
- Error callback +
- Per-window user pointer +
- Window iconification callback +
- Window position callback +
- Window position query +
- Window focus callback +
- Cursor enter/leave callback +
- Initial window title +
- Hidden windows +
- Undecorated windows +
- Modifier key bit masks +
- Platform-specific scancodes +
- Joystick names +
- Doxygen documentation +
+
+ - New features in version 3.0
+Release notes for version 3.3
+These are the release notes for version 3.3. For a more detailed view including all fixed bugs see the version history.
+Please review the caveats, deprecations and removals if your project was written against an earlier version of GLFW 3.
++New features in version 3.3
++Gamepad input via SDL_GameControllerDB
+GLFW can now remap game controllers to a standard Xbox-like layout using a built-in copy of SDL_GameControllerDB. Call glfwJoystickIsGamepad to check if a joystick has a mapping, glfwGetGamepadState to retrieve its input state, glfwUpdateGamepadMappings to add newer mappings and glfwGetGamepadName and glfwGetJoystickGUID for mapping related information.
+For more information see Gamepad input.
++Support for Vulkan on macOS via MoltenVK
+GLFW now supports MoltenVK, a Vulkan implementation on top of the Metal API, and its VK_MVK_macos_surface window surface creation extension. MoltenVK is included in the macOS Vulkan SDK.
For more information see Vulkan guide.
++Content scale queries for DPI-aware rendering
+GLFW now provides content scales for windows and monitors, i.e. the ratio between their current DPI and the platform's default DPI, with glfwGetWindowContentScale and glfwGetMonitorContentScale.
+Changes of the content scale of a window can be received with the window content scale callback, set with glfwSetWindowContentScaleCallback.
+The GLFW_SCALE_TO_MONITOR window hint enables automatic resizing of a window by the content scale of the monitor it is placed, on platforms like Windows where this is necessary. This takes effect both on creation and when the window is moved between monitors. It is related to but different from GLFW_COCOA_RETINA_FRAMEBUFFER.
+For more information see Window content scale.
++Support for updating window attributes
+GLFW now supports changing the GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW attributes for existing windows with glfwSetWindowAttrib.
+For more information see Window attributes.
++Support for raw mouse motion
+GLFW now supports raw (unscaled and unaccelerated) mouse motion in disabled cursor mode with the GLFW_RAW_MOUSE_MOTION input mode. Raw mouse motion input is not yet implemented on macOS. Call glfwRawMouseMotionSupported to check if GLFW can provide raw mouse motion on the current system.
+For more information see Raw mouse motion.
++Joystick hats
+GLFW can now return the state of hats (i.e. POVs or D-pads) of a joystick with glfwGetJoystickHats. For compatibility, hats are also exposed as buttons. This can be disabled with the GLFW_JOYSTICK_HAT_BUTTONS initialization hint.
+For more information see Joystick hat states.
++Error query
+GLFW now supports querying the last error code for the calling thread and its human-readable description with glfwGetError. This can be used instead of or together with the error callback.
+For more information see Error handling.
++Support for initialization hints
+GLFW now supports setting library initialization hints with glfwInitHint. These must be set before initialization to take effect. Some of these hints are platform specific but are safe to set on any platform.
+For more information see Initialization hints.
++User attention request
+GLFW now supports requesting user attention with glfwRequestWindowAttention. Where possible this calls attention to the specified window. On platforms like macOS it calls attention to the whole application.
+For more information see Window attention request.
++Window maximization callback
+GLFW now supports notifying the application that the window has been maximized glfwSetWindowMaximizeCallback. This is called both when the window was maximized by the user and when it was done with glfwMaximizeWindow.
+For more information see Window maximization.
++Query for the monitor work area
+GLFW now supports querying the work area of a monitor, i.e. the area not occupied by task bars or global menu bars, with glfwGetMonitorWorkarea. On platforms that lack this concept, the whole area of the monitor is returned.
+For more information see Work area.
++Transparent windows and framebuffers
+GLFW now supports the creation of windows with transparent framebuffers on systems with desktop compositing enabled with the GLFW_TRANSPARENT_FRAMEBUFFER window hint and attribute. This hint must be set before window creation and leaves any window decorations opaque.
+GLFW now also supports whole window transparency with glfwGetWindowOpacity and glfwSetWindowOpacity. This value controls the opacity of the whole window including decorations and unlike framebuffer transparency can be changed at any time after window creation.
+For more information see Window transparency.
++Query for the scancode of a key
+GLFW now supports querying the platform dependent scancode of any physical key with glfwGetKeyScancode.
+For more information see Key input.
++Cursor centering window hint
+GLFW now supports controlling whether the cursor is centered over newly created full screen windows with the GLFW_CENTER_CURSOR window hint. It is enabled by default.
++Mouse cursor hover window attribute
+GLFW now supports polling whether the cursor is hovering over the window content area with the GLFW_HOVERED window attribute. This attribute corresponds to the cursor enter/leave event.
++Window hint and attribute for input focus on show
+GLFW now has the GLFW_FOCUS_ON_SHOW window hint and attribute for controlling whether a window gets input focus when shown. It is enabled by default. It applies both when creating an visible window with glfwCreateWindow and when showing it with glfwShowWindow.
+This is a workaround for GLFW 3.0 lacking glfwFocusWindow and will be corrected in the next major version.
+For more information see Window visibility.
++Monitor and joystick user pointers
+GLFW now supports setting and querying user pointers for connected monitors and joysticks with glfwSetMonitorUserPointer, glfwGetMonitorUserPointer, glfwSetJoystickUserPointer and glfwGetJoystickUserPointer.
+For more information see User pointer and Joystick user pointer.
++macOS menu bar from nib file
+GLFW will now load a MainMenu.nib file if found in the Contents/Resources directory of the application bundle, as a way to replace the GLFW menu bar without recompiling GLFW. This behavior can be disabled with the GLFW_COCOA_MENUBAR initialization hint.
+Support for more context creation extensions
+The context hint GLFW_SRGB_CAPABLE now supports OpenGL ES via WGL_EXT_colorspace, the context hint GLFW_CONTEXT_NO_ERROR now supports WGL_ARB_create_context_no_error and GLX_ARB_create_context_no_error, the context hint GLFW_CONTEXT_RELEASE_BEHAVIOR now supports EGL_KHR_context_flush_control and glfwGetProcAddress now supports EGL_KHR_get_all_proc_addresses.
+OSMesa off-screen context creation support
+GLFW now supports creating off-screen OpenGL contexts using OSMesa by setting GLFW_CONTEXT_CREATION_API to GLFW_OSMESA_CONTEXT_API. Native access function have been added to retrieve the OSMesa color and depth buffers.
There is also a new null backend that uses OSMesa as its native context creation API, intended for automated testing. This backend does not provide input.
++Caveats for version 3.3
++Layout of joysticks have changed
+The way joystick elements are arranged have changed to match SDL2 in order to support SDL_GameControllerDB mappings. The layout of joysticks may change again if required for compatibility with SDL2. If you need a known and stable layout for game controllers, see if you can switch to Gamepad input.
+Existing code that depends on a specific joystick layout will likely have to be updated.
++No window required to wait for events
+The glfwWaitEvents and glfwWaitEventsTimeout functions no longer need a window to be created to wait for events. Before version 3.3 these functions would return immediately if there were no user-created windows. On platforms where only windows can receive events, an internal helper window is used.
+Existing code that depends on the earlier behavior will likely have to be updated.
++Gamma ramp size of 256 may be rejected
+The documentation for versions before 3.3 stated that a gamma ramp size of 256 would always be accepted. This was never the case on X11 and could lead to artifacts on macOS. The glfwSetGamma function has been updated to always generate a ramp of the correct size.
+Existing code that hardcodes a size of 256 should be updated to use the size of the current ramp of a monitor when setting a new ramp for that monitor.
++Windows XInput deadzone removed
+GLFW no longer applies any deadzone to the input state received from the XInput API. This was never done for any other platform joystick API so this change makes the behavior more consistent but you will need to apply your own deadzone if desired.
++X11 clipboard transfer limits
+GLFW now supports reading clipboard text via the INCR method, which removes the limit on how much text can be read with glfwGetClipboardString. However, writing via this method is not yet supported, so you may not be able to write a very large string with glfwSetClipboardString even if you read it from the clipboard earlier.
The exact size limit for writing to the clipboard is negotiated with each receiving application but is at least several tens of kilobytes. Note that only the read limit has changed. Any string that could be written before still can be.
++X11 extension libraries are loaded dynamically
+GLFW now loads all X11 extension libraries at initialization. The only X11 library you need to link against is libX11. The header files for the extension libraries are still required for compilation.
Existing projects and makefiles that link GLFW directly against the extension libraries should still build correctly but will add these libraries as load-time dependencies.
++CMake 3.0 or later is required
+The minimum CMake version has been raised from 2.8.12 to 3.0. This is only a requirement of the GLFW CMake files. The GLFW source files do not depend on CMake.
++Framebuffer transparency requires DWM transparency
+GLFW no longer supports framebuffer transparency enabled via GLFW_TRANSPARENT_FRAMEBUFFER on Windows 7 if DWM transparency is off (the Transparency setting under Personalization > Window Color).
++Empty events on X11 no longer roundtrip to server
+Starting with GLFW 3.3.7, events posted with glfwPostEmptyEvent now use a separate unnamed pipe instead of sending an X11 client event to the helper window.
++Deprecations in version 3.3
++Character with modifiers callback
+The character with modifiers callback set with glfwSetCharModsCallback has been deprecated and should if possible not be used.
+Existing code should still work but further bug fixes will likely not be made. The callback will be removed in the next major version.
++Window parameter to clipboard functions
+The window parameter of the clipboard functions glfwGetClipboardString and glfwSetClipboardString has been deprecated and is no longer used on any platform. On platforms where the clipboard must be owned by a specific window, an internal helper window is used.
+Existing code should still work unless it depends on a specific window owning the clipboard. New code may pass NULL as the window argument. The parameter will be removed in a future release.
+Removals in 3.3
++macOS specific CMake options and macros
+The GLFW_USE_RETINA, GLFW_USE_CHDIR and GLFW_USE_MENUBAR CMake options and the _GLFW_USE_RETINA, _GLFW_USE_CHDIR and _GLFW_USE_MENUBAR compile-time macros have been removed.
These options and macros are replaced by the window hint GLFW_COCOA_RETINA_FRAMEBUFFER and the init hints GLFW_COCOA_CHDIR_RESOURCES and GLFW_COCOA_MENUBAR.
+Existing projects and makefiles that set these options or define these macros during compilation of GLFW will still build but it will have no effect and the default behaviors will be used.
++LunarG Vulkan SDK dependency
+The GLFW test programs that previously depended on the LunarG Vulkan SDK now instead uses a Vulkan loader generated by glad2. This means the GLFW CMake files no longer look for the Vulkan SDK.
+Existing CMake projects that depended on the Vulkan SDK cache variables from GLFW will need to call find_package(Vulkan) themselves. CMake 3.7 and later already comes with a Vulkan find module similar to the one GLFW previously included.
+CMake option LIB_SUFFIX
+The LIB_SUFFIX CMake option has been removed. GLFW now uses the GNUInstallDirs CMake package to handle platform specific details like the library directory suffix and the LIB_SUFFIX CMake option has been removed.
Existing projects and makefiles that set the LIB_SUFFIX option will use the suffix chosen by the GNUInstallDirs package and the option will be ignored.
+Support for the wl_shell protocol
+Support for the wl_shell protocol has been removed and GLFW now only supports the XDG-Shell protocol. If your Wayland compositor does not support XDG-Shell then GLFW will fail to initialize.
++Mir support
+The experimental Mir support has been completely removed as the Mir project has implemented support for the Wayland protocol and is recommending that applications use that instead.
+Existing projects and makefiles that select Mir when compiling GLFW will fail. Use Wayland or X11 instead.
++New symbols in version 3.3
++New functions in version 3.3
+-
+
- glfwInitHint +
- glfwGetError +
- glfwGetMonitorWorkarea +
- glfwGetMonitorContentScale +
- glfwGetMonitorUserPointer +
- glfwSetMonitorUserPointer +
- glfwWindowHintString +
- glfwGetWindowContentScale +
- glfwGetWindowOpacity +
- glfwSetWindowOpacity +
- glfwRequestWindowAttention +
- glfwSetWindowAttrib +
- glfwSetWindowMaximizeCallback +
- glfwSetWindowContentScaleCallback +
- glfwRawMouseMotionSupported +
- glfwGetKeyScancode +
- glfwGetJoystickHats +
- glfwGetJoystickGUID +
- glfwGetJoystickUserPointer +
- glfwSetJoystickUserPointer +
- glfwJoystickIsGamepad +
- glfwUpdateGamepadMappings +
- glfwGetGamepadName +
- glfwGetGamepadState +
+New types in version 3.3
+ ++New constants in version 3.3
+-
+
- GLFW_NO_ERROR +
- GLFW_JOYSTICK_HAT_BUTTONS +
- GLFW_COCOA_CHDIR_RESOURCES +
- GLFW_COCOA_MENUBAR +
- GLFW_CENTER_CURSOR +
- GLFW_TRANSPARENT_FRAMEBUFFER +
- GLFW_HOVERED +
- GLFW_FOCUS_ON_SHOW +
- GLFW_SCALE_TO_MONITOR +
- GLFW_COCOA_RETINA_FRAMEBUFFER +
- GLFW_COCOA_FRAME_NAME +
- GLFW_COCOA_GRAPHICS_SWITCHING +
- GLFW_X11_CLASS_NAME +
- GLFW_X11_INSTANCE_NAME +
- GLFW_OSMESA_CONTEXT_API +
- GLFW_HAT_CENTERED +
- GLFW_HAT_UP +
- GLFW_HAT_RIGHT +
- GLFW_HAT_DOWN +
- GLFW_HAT_LEFT +
- GLFW_HAT_RIGHT_UP +
- GLFW_HAT_RIGHT_DOWN +
- GLFW_HAT_LEFT_UP +
- GLFW_HAT_LEFT_DOWN +
- GLFW_MOD_CAPS_LOCK +
- GLFW_MOD_NUM_LOCK +
- GLFW_LOCK_KEY_MODS +
- GLFW_RAW_MOUSE_MOTION +
- GLFW_GAMEPAD_BUTTON_A +
- GLFW_GAMEPAD_BUTTON_B +
- GLFW_GAMEPAD_BUTTON_X +
- GLFW_GAMEPAD_BUTTON_Y +
- GLFW_GAMEPAD_BUTTON_LEFT_BUMPER +
- GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER +
- GLFW_GAMEPAD_BUTTON_BACK +
- GLFW_GAMEPAD_BUTTON_START +
- GLFW_GAMEPAD_BUTTON_GUIDE +
- GLFW_GAMEPAD_BUTTON_LEFT_THUMB +
- GLFW_GAMEPAD_BUTTON_RIGHT_THUMB +
- GLFW_GAMEPAD_BUTTON_DPAD_UP +
- GLFW_GAMEPAD_BUTTON_DPAD_RIGHT +
- GLFW_GAMEPAD_BUTTON_DPAD_DOWN +
- GLFW_GAMEPAD_BUTTON_DPAD_LEFT +
- GLFW_GAMEPAD_BUTTON_LAST +
- GLFW_GAMEPAD_BUTTON_CROSS +
- GLFW_GAMEPAD_BUTTON_CIRCLE +
- GLFW_GAMEPAD_BUTTON_SQUARE +
- GLFW_GAMEPAD_BUTTON_TRIANGLE +
- GLFW_GAMEPAD_AXIS_LEFT_X +
- GLFW_GAMEPAD_AXIS_LEFT_Y +
- GLFW_GAMEPAD_AXIS_RIGHT_X +
- GLFW_GAMEPAD_AXIS_RIGHT_Y +
- GLFW_GAMEPAD_AXIS_LEFT_TRIGGER +
- GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER +
- GLFW_GAMEPAD_AXIS_LAST +
+Release notes for 3.2
+These are the release notes for version 3.2. For a more detailed view including all fixed bugs see the version history.
++New features in version 3.2
++Support for Vulkan
+GLFW now supports basic integration with Vulkan with glfwVulkanSupported, glfwGetRequiredInstanceExtensions, glfwGetInstanceProcAddress, glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface. Vulkan header inclusion can be selected with GLFW_INCLUDE_VULKAN.
++Window mode switching
+GLFW now supports switching between windowed and full screen modes and updating the monitor and desired resolution and refresh rate of full screen windows with glfwSetWindowMonitor.
++Window maxmimization support
+GLFW now supports window maximization with glfwMaximizeWindow and the GLFW_MAXIMIZED window hint and attribute.
++Window input focus control
+GLFW now supports giving windows input focus with glfwFocusWindow.
++Window size limit support
+GLFW now supports setting both absolute and relative window size limits with glfwSetWindowSizeLimits and glfwSetWindowAspectRatio.
++Localized key names
+GLFW now supports querying the localized name of printable keys with glfwGetKeyName, either by key token or by scancode.
++Wait for events with timeout
+GLFW now supports waiting for events for a set amount of time with glfwWaitEventsTimeout.
++Window icon support
+GLFW now supports setting the icon of windows with glfwSetWindowIcon.
++Raw timer access
+GLFW now supports raw timer values with glfwGetTimerValue and glfwGetTimerFrequency.
++Joystick connection callback
+GLFW now supports notifying when a joystick has been connected or disconnected with glfwSetJoystickCallback.
++Context-less windows
+GLFW now supports creating windows without a OpenGL or OpenGL ES context by setting the GLFW_CLIENT_API hint to GLFW_NO_API.
+Run-time context creation API selection
+GLFW now supports selecting and querying the context creation API at run-time with the GLFW_CONTEXT_CREATION_API hint and attribute.
++Error-free context creation
+GLFW now supports creating and querying OpenGL and OpenGL ES contexts that do not emit errors with the GLFW_CONTEXT_NO_ERROR hint, provided the machine supports the GL_KHR_no_error extension.
+CMake config-file package support
+GLFW now supports being used as a config-file package from other projects for easy linking with the library and its dependencies.
++Release notes for 3.1
+These are the release notes for version 3.1. For a more detailed view including all fixed bugs see the version history.
++New features in version 3.1
++Custom mouse cursor images
+GLFW now supports creating and setting both custom cursor images and standard cursor shapes. They are created with glfwCreateCursor or glfwCreateStandardCursor, set with glfwSetCursor and destroyed with glfwDestroyCursor.
+- See also
- Cursor objects
+Path drop event
+GLFW now provides a callback for receiving the paths of files and directories dropped onto GLFW windows. The callback is set with glfwSetDropCallback.
+- See also
- Path drop input
+Main thread wake-up
+GLFW now provides the glfwPostEmptyEvent function for posting an empty event from another thread to the main thread event queue, causing glfwWaitEvents to return.
+- See also
- Event processing
+Window frame size query
+GLFW now supports querying the size, on each side, of the frame around the content area of a window, with glfwGetWindowFrameSize.
+- See also
- Window size
+Simultaneous multi-monitor rendering
+GLFW now supports disabling auto-iconification of full screen windows with the GLFW_AUTO_ICONIFY window hint. This is intended for people building multi-monitor installations, where you need windows to stay in full screen despite losing input focus.
++Floating windows
+GLFW now supports floating windows, also called topmost or always on top, for easier debugging with the GLFW_FLOATING window hint and attribute.
++Initially unfocused windows
+GLFW now supports preventing a windowed mode window from gaining input focus on creation, with the GLFW_FOCUSED window hint.
++Direct access for window attributes and cursor position
+GLFW now queries the window input focus, visibility and iconification attributes and the cursor position directly instead of returning cached data.
++Character with modifiers callback
+GLFW now provides a callback for character events with modifier key bits. The callback is set with glfwSetCharModsCallback. Unlike the regular character callback, this will report character events that will not result in a character being input, for example if the Control key is held down.
+- See also
- Text input
+Single buffered framebuffers
+GLFW now supports the creation of single buffered windows, with the GLFW_DOUBLEBUFFER hint.
++Macro for including extension header
+GLFW now includes the extension header appropriate for the chosen OpenGL or OpenGL ES header when GLFW_INCLUDE_GLEXT is defined. GLFW does not provide these headers. They must be provided by your development environment or your OpenGL or OpenGL ES SDK.
++Context release behaviors
+GLFW now supports controlling and querying whether the pipeline is flushed when a context is made non-current, with the GLFW_CONTEXT_RELEASE_BEHAVIOR hint and attribute, provided the machine supports the GL_KHR_context_flush_control extension.
+(Experimental) Wayland support
+GLFW now has an experimental Wayland display protocol backend that can be selected on Linux with a CMake option.
++(Experimental) Mir support
+GLFW now has an experimental Mir display server backend that can be selected on Linux with a CMake option.
++Release notes for 3.0
+These are the release notes for version 3.0. For a more detailed view including all fixed bugs see the version history.
++New features in version 3.0
++CMake build system
+GLFW now uses the CMake build system instead of the various makefiles and project files used by earlier versions. CMake is available for all platforms supported by GLFW, is present in most package systems and can generate makefiles and/or project files for most popular development environments.
+For more information on how to use CMake, see the CMake manual.
++Multi-window support
+GLFW now supports the creation of multiple windows, each with their own OpenGL or OpenGL ES context, and all window functions now take a window handle. Event callbacks are now per-window and are provided with the handle of the window that received the event. The glfwMakeContextCurrent function has been added to select which context is current on a given thread.
++Multi-monitor support
+GLFW now explicitly supports multiple monitors. They can be enumerated with glfwGetMonitors, queried with glfwGetVideoModes, glfwGetMonitorPos, glfwGetMonitorName and glfwGetMonitorPhysicalSize, and specified at window creation to make the newly created window full screen on that specific monitor.
++Unicode support
+All string arguments to GLFW functions and all strings returned by GLFW now use the UTF-8 encoding. This includes the window title, error string, clipboard text, monitor and joystick names as well as the extension function arguments (as ASCII is a subset of UTF-8).
++Clipboard text I/O
+GLFW now supports reading and writing plain text to and from the system clipboard, with the glfwGetClipboardString and glfwSetClipboardString functions.
++Gamma ramp support
+GLFW now supports setting and reading back the gamma ramp of monitors, with the glfwGetGammaRamp and glfwSetGammaRamp functions. There is also glfwSetGamma, which generates a ramp from a gamma value and then sets it.
++OpenGL ES support
+GLFW now supports the creation of OpenGL ES contexts, by setting the GLFW_CLIENT_API hint to GLFW_OPENGL_ES_API, where creation of such contexts are supported. Note that GLFW does not implement OpenGL ES, so your driver must provide support in a way usable by GLFW. Modern Nvidia and Intel drivers support creation of OpenGL ES context using the GLX and WGL APIs, while AMD provides an EGL implementation instead.
+(Experimental) EGL support
+GLFW now has an experimental EGL context creation back end that can be selected through CMake options.
++High-DPI support
+GLFW now supports high-DPI monitors on both Windows and macOS, giving windows full resolution framebuffers where other UI elements are scaled up. To achieve this, glfwGetFramebufferSize and glfwSetFramebufferSizeCallback have been added. These work with pixels, while the rest of the GLFW API works with screen coordinates. This is important as OpenGL uses pixels, not screen coordinates.
++Error callback
+GLFW now has an error callback, which can provide your application with much more detailed diagnostics than was previously possible. The callback is passed an error code and a description string.
++Per-window user pointer
+Each window now has a user-defined pointer, retrieved with glfwGetWindowUserPointer and set with glfwSetWindowUserPointer, to make it easier to integrate GLFW into C++ code.
++Window iconification callback
+Each window now has a callback for iconification and restoration events, which is set with glfwSetWindowIconifyCallback.
++Window position callback
+Each window now has a callback for position events, which is set with glfwSetWindowPosCallback.
++Window position query
+The position of a window can now be retrieved using glfwGetWindowPos.
++Window focus callback
+Each windows now has a callback for focus events, which is set with glfwSetWindowFocusCallback.
++Cursor enter/leave callback
+Each window now has a callback for when the mouse cursor enters or leaves its content area, which is set with glfwSetCursorEnterCallback.
++Initial window title
+The title of a window is now specified at creation time, as one of the arguments to glfwCreateWindow.
++Hidden windows
+Windows can now be hidden with glfwHideWindow, shown using glfwShowWindow and created initially hidden with the GLFW_VISIBLE window hint and attribute. This allows for off-screen rendering in a way compatible with most drivers, as well as moving a window to a specific position before showing it.
++Undecorated windows
+Windowed mode windows can now be created without decorations, e.g. things like a frame, a title bar, with the GLFW_DECORATED window hint and attribute. This allows for the creation of things like splash screens.
++Modifier key bit masks
+Modifier key bit mask parameters have been added to the mouse button and key callbacks.
++Platform-specific scancodes
+A scancode parameter has been added to the key callback. Keys that don't have a key token still get passed on with the key parameter set to GLFW_KEY_UNKNOWN. These scancodes will vary between machines and are intended to be used for key bindings.
+Joystick names
+The name of a joystick can now be retrieved using glfwGetJoystickName.
++Doxygen documentation
+You are reading it.
++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/news_8dox.html b/deps/glfw-3.3.8/docs/html/news_8dox.html new file mode 100644 index 0000000..e200170 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/news_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/open.png b/deps/glfw-3.3.8/docs/html/open.png new file mode 100644 index 0000000..30f75c7 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/open.png differ diff --git a/deps/glfw-3.3.8/docs/html/pages.html b/deps/glfw-3.3.8/docs/html/pages.html new file mode 100644 index 0000000..6f2d4eb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/pages.html @@ -0,0 +1,92 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/quick_8dox.html b/deps/glfw-3.3.8/docs/html/quick_8dox.html new file mode 100644 index 0000000..f65bd4c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/quick_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/quick_guide.html b/deps/glfw-3.3.8/docs/html/quick_guide.html new file mode 100644 index 0000000..6a31489 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/quick_guide.html @@ -0,0 +1,391 @@ + + + + + + + +Table of Contents
+ +This guide takes you through writing a simple application using GLFW 3. The application will create a window and OpenGL context, render a rotating triangle and exit when the user closes the window or presses Escape. This guide will introduce a few of the most commonly used functions, but there are many more.
+This guide assumes no experience with earlier versions of GLFW. If you have used GLFW 2 in the past, read Moving from GLFW 2 to 3, as some functions behave differently in GLFW 3.
++Step by step
++Including the GLFW header
+In the source files of your application where you use GLFW, you need to include its header file.
+This header provides all the constants, types and function prototypes of the GLFW API.
+By default it also includes the OpenGL header from your development environment. On some platforms this header only supports older versions of OpenGL. The most extreme case is Windows, where it typically only supports OpenGL 1.2.
+Most programs will instead use an extension loader library and include its header. This example uses files generated by glad. The GLFW header can detect most such headers if they are included first and will then not include the one from your development environment.
+To make sure there will be no header conflicts, you can define GLFW_INCLUDE_NONE before the GLFW header to explicitly disable inclusion of the development environment header. This also allows the two headers to be included in any order.
++Initializing and terminating GLFW
+Before you can use most GLFW functions, the library must be initialized. On successful initialization, GLFW_TRUE is returned. If an error occurred, GLFW_FALSE is returned.
Note that GLFW_TRUE and GLFW_FALSE are and will always be one and zero.
When you are done using GLFW, typically just before the application exits, you need to terminate GLFW.
+This destroys any remaining windows and releases any other resources allocated by GLFW. After this call, you must initialize GLFW again before using any GLFW functions that require it.
++Setting an error callback
+Most events are reported through callbacks, whether it's a key being pressed, a GLFW window being moved, or an error occurring. Callbacks are C functions (or C++ static methods) that are called by GLFW with arguments describing the event.
+In case a GLFW function fails, an error is reported to the GLFW error callback. You can receive these reports with an error callback. This function must have the signature below but may do anything permitted in other callbacks.
+Callback functions must be set, so GLFW knows to call them. The function to set the error callback is one of the few GLFW functions that may be called before initialization, which lets you be notified of errors both during and after initialization.
++Creating a window and context
+The window and its OpenGL context are created with a single call to glfwCreateWindow, which returns a handle to the created combined window and context object
+This creates a 640 by 480 windowed mode window with an OpenGL context. If window or OpenGL context creation fails, NULL will be returned. You should always check the return value. While window creation rarely fails, context creation depends on properly installed drivers and may fail even on machines with the necessary hardware.
By default, the OpenGL context GLFW creates may have any version. You can require a minimum OpenGL version by setting the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints before creation. If the required minimum version is not supported on the machine, context (and window) creation fails.
The window handle is passed to all window related functions and is provided to along to all window related callbacks, so they can tell which window received the event.
+When a window and context is no longer needed, destroy it.
+Once this function is called, no more events will be delivered for that window and its handle becomes invalid.
++Making the OpenGL context current
+Before you can use the OpenGL API, you must have a current OpenGL context.
+The context will remain current until you make another context current or until the window owning the current context is destroyed.
+If you are using an extension loader library to access modern OpenGL then this is when to initialize it, as the loader needs a current context to load from. This example uses glad, but the same rule applies to all such libraries.
++Checking the window close flag
+Each window has a flag indicating whether the window should be closed.
+When the user attempts to close the window, either by pressing the close widget in the title bar or using a key combination like Alt+F4, this flag is set to 1. Note that the window isn't actually closed, so you are expected to monitor this flag and either destroy the window or give some kind of feedback to the user.
+You can be notified when the user is attempting to close the window by setting a close callback with glfwSetWindowCloseCallback. The callback will be called immediately after the close flag has been set.
+You can also set it yourself with glfwSetWindowShouldClose. This can be useful if you want to interpret other kinds of input as closing the window, like for example pressing the Escape key.
++Receiving input events
+Each window has a large number of callbacks that can be set to receive all the various kinds of events. To receive key press and release events, create a key callback function.
+The key callback, like other window related callbacks, are set per-window.
+In order for event callbacks to be called when events occur, you need to process events as described below.
++Rendering with OpenGL
+Once you have a current OpenGL context, you can use OpenGL normally. In this tutorial, a multi-colored rotating triangle will be rendered. The framebuffer size needs to be retrieved for glViewport.
You can also set a framebuffer size callback using glfwSetFramebufferSizeCallback and be notified when the size changes.
+The details of how to render with OpenGL is outside the scope of this tutorial, but there are many excellent resources for learning modern OpenGL. Here are a few of them:
+ +These all happen to use GLFW, but OpenGL itself works the same whatever API you use to create the window and context.
++Reading the timer
+To create smooth animation, a time source is needed. GLFW provides a timer that returns the number of seconds since initialization. The time source used is the most accurate on each platform and generally has micro- or nanosecond resolution.
++Swapping buffers
+GLFW windows by default use double buffering. That means that each window has two rendering buffers; a front buffer and a back buffer. The front buffer is the one being displayed and the back buffer the one you render to.
+When the entire frame has been rendered, the buffers need to be swapped with one another, so the back buffer becomes the front buffer and vice versa.
+The swap interval indicates how many frames to wait until swapping the buffers, commonly known as vsync. By default, the swap interval is zero, meaning buffer swapping will occur immediately. On fast machines, many of those frames will never be seen, as the screen is still only updated typically 60-75 times per second, so this wastes a lot of CPU and GPU cycles.
+Also, because the buffers will be swapped in the middle the screen update, leading to screen tearing.
+For these reasons, applications will typically want to set the swap interval to one. It can be set to higher values, but this is usually not recommended, because of the input latency it leads to.
+This function acts on the current context and will fail unless a context is current.
++Processing events
+GLFW needs to communicate regularly with the window system both in order to receive events and to show that the application hasn't locked up. Event processing must be done regularly while you have visible windows and is normally done each frame after buffer swapping.
+There are two methods for processing pending events; polling and waiting. This example will use event polling, which processes only those events that have already been received and then returns immediately.
+This is the best choice when rendering continually, like most games do. If instead you only need to update your rendering once you have received new input, glfwWaitEvents is a better choice. It waits until at least one event has been received, putting the thread to sleep in the meantime, and then processes all received events. This saves a great deal of CPU cycles and is useful for, for example, many kinds of editing tools.
++Putting it together
+Now that you know how to initialize GLFW, create a window and poll for keyboard input, it's possible to create a simple program.
+This program creates a 640 by 480 windowed mode window and starts a loop that clears the screen, renders a triangle and processes events until the user either presses Escape or closes the window.
+The program above can be found in the source package as examples/simple.c and is compiled along with all other examples when you build GLFW. If you built GLFW from the source package then you already have this as simple.exe on Windows, simple on Linux or simple.app on macOS.
This tutorial used only a few of the many functions GLFW provides. There are guides for each of the areas covered by GLFW. Each guide will introduce all the functions for that category.
+ +You can access reference documentation for any GLFW function by clicking it and the reference for each function links to related functions and guide sections.
+The tutorial ends here. Once you have written a program that uses GLFW, you will need to compile and link it. How to do that depends on the development environment you are using and is best explained by the documentation for that environment. To learn about the details that are specific to GLFW, see Building applications.
++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_0.html b/deps/glfw-3.3.8/docs/html/search/all_0.html new file mode 100644 index 0000000..bb9e364 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_0.html @@ -0,0 +1,37 @@ + + +Gamepad input state. + More...
+ +#include <glfw3.h>
+Data Fields | |
| unsigned char | buttons [15] |
| float | axes [6] |
Detailed Description
+This describes the input state of a gamepad.
+- See also
- Gamepad input +
- +glfwGetGamepadState
- Since
- Added in version 3.3.
Field Documentation
+ +◆ buttons
+ +| unsigned char GLFWgamepadstate::buttons[15] | +
The states of each gamepad button, GLFW_PRESS or GLFW_RELEASE.
◆ axes
+ +| float GLFWgamepadstate::axes[6] | +
The states of each gamepad axis, in the range -1.0 to 1.0 inclusive.
+ +The documentation for this struct was generated from the following file:
-
+
- glfw3.h +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html b/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html new file mode 100644 index 0000000..310d1cc --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html @@ -0,0 +1,165 @@ + + + + + + + +Gamma ramp. + More...
+ +#include <glfw3.h>
+Data Fields | |
| unsigned short * | red |
| unsigned short * | green |
| unsigned short * | blue |
| unsigned int | size |
Detailed Description
+This describes the gamma ramp for a monitor.
+- See also
- Gamma ramp +
- +glfwGetGammaRamp +
- +glfwSetGammaRamp
- Since
- Added in version 3.0.
Field Documentation
+ +◆ red
+ +| unsigned short* GLFWgammaramp::red | +
An array of value describing the response of the red channel.
+ +◆ green
+ +| unsigned short* GLFWgammaramp::green | +
An array of value describing the response of the green channel.
+ +◆ blue
+ +| unsigned short* GLFWgammaramp::blue | +
An array of value describing the response of the blue channel.
+ +◆ size
+ +| unsigned int GLFWgammaramp::size | +
The number of elements in each array.
+ +The documentation for this struct was generated from the following file:
-
+
- glfw3.h +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWimage.html b/deps/glfw-3.3.8/docs/html/structGLFWimage.html new file mode 100644 index 0000000..672209d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWimage.html @@ -0,0 +1,146 @@ + + + + + + + +Image data. + More...
+ +#include <glfw3.h>
+Data Fields | |
| int | width |
| int | height |
| unsigned char * | pixels |
Detailed Description
+This describes a single 2D image. See the documentation for each related function what the expected pixel format is.
+- See also
- Custom cursor creation +
- +Window icon
- Since
- Added in version 2.1. GLFW 3: Removed format and bytes-per-pixel members.
Field Documentation
+ +◆ width
+ +| int GLFWimage::width | +
The width, in pixels, of this image.
+ +◆ height
+ +| int GLFWimage::height | +
The height, in pixels, of this image.
+ +◆ pixels
+ +| unsigned char* GLFWimage::pixels | +
The pixel data of this image, arranged left-to-right, top-to-bottom.
+ +The documentation for this struct was generated from the following file:
-
+
- glfw3.h +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html b/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html new file mode 100644 index 0000000..c367377 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html @@ -0,0 +1,199 @@ + + + + + + + +Video mode type. + More...
+ +#include <glfw3.h>
+Data Fields | |
| int | width |
| int | height |
| int | redBits |
| int | greenBits |
| int | blueBits |
| int | refreshRate |
Detailed Description
+This describes a single video mode.
+- See also
- Video modes +
- +glfwGetVideoMode +
- +glfwGetVideoModes
- Since
- Added in version 1.0. GLFW 3: Added refresh rate member.
Field Documentation
+ +◆ width
+ +| int GLFWvidmode::width | +
The width, in screen coordinates, of the video mode.
+ +◆ height
+ +| int GLFWvidmode::height | +
The height, in screen coordinates, of the video mode.
+ +◆ redBits
+ +| int GLFWvidmode::redBits | +
The bit depth of the red channel of the video mode.
+ +◆ greenBits
+ +| int GLFWvidmode::greenBits | +
The bit depth of the green channel of the video mode.
+ +◆ blueBits
+ +| int GLFWvidmode::blueBits | +
The bit depth of the blue channel of the video mode.
+ +◆ refreshRate
+ +| int GLFWvidmode::refreshRate | +
The refresh rate, in Hz, of the video mode.
+ +The documentation for this struct was generated from the following file:
-
+
- glfw3.h +
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/sync_off.png b/deps/glfw-3.3.8/docs/html/sync_off.png new file mode 100644 index 0000000..3b443fc Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/sync_off.png differ diff --git a/deps/glfw-3.3.8/docs/html/sync_on.png b/deps/glfw-3.3.8/docs/html/sync_on.png new file mode 100644 index 0000000..e08320f Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/sync_on.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_a.png b/deps/glfw-3.3.8/docs/html/tab_a.png new file mode 100644 index 0000000..3b725c4 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_a.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_b.png b/deps/glfw-3.3.8/docs/html/tab_b.png new file mode 100644 index 0000000..e2b4a86 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_b.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_h.png b/deps/glfw-3.3.8/docs/html/tab_h.png new file mode 100644 index 0000000..fd5cb70 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_h.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_s.png b/deps/glfw-3.3.8/docs/html/tab_s.png new file mode 100644 index 0000000..ab478c9 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_s.png differ diff --git a/deps/glfw-3.3.8/docs/html/tabs.css b/deps/glfw-3.3.8/docs/html/tabs.css new file mode 100644 index 0000000..00d1c60 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:#666;-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file diff --git a/deps/glfw-3.3.8/docs/html/vulkan_8dox.html b/deps/glfw-3.3.8/docs/html/vulkan_8dox.html new file mode 100644 index 0000000..a4fb097 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/vulkan_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/vulkan_guide.html b/deps/glfw-3.3.8/docs/html/vulkan_guide.html new file mode 100644 index 0000000..1159aa0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/vulkan_guide.html @@ -0,0 +1,189 @@ + + + + + + + +Table of Contents
+ +This guide is intended to fill the gaps between the official Vulkan resources and the rest of the GLFW documentation and is not a replacement for either. It assumes some familiarity with Vulkan concepts like loaders, devices, queues and surfaces and leaves it to the Vulkan documentation to explain the details of Vulkan functions.
+To develop for Vulkan you should download the LunarG Vulkan SDK for your platform. Apart from headers and link libraries, they also provide the validation layers necessary for development.
+The Vulkan Tutorial has more information on how to use GLFW and Vulkan. The Khronos Vulkan Samples also use GLFW, although with a small framework in between.
+For details on a specific Vulkan support function, see the Vulkan support reference. There are also guides for the other areas of the GLFW API.
+ ++Linking against the Vulkan loader
+By default, GLFW will look for the Vulkan loader on demand at runtime via its standard name (vulkan-1.dll on Windows, libvulkan.so.1 on Linux and other Unix-like systems and libvulkan.1.dylib on macOS). This means that GLFW does not need to be linked against the loader. However, it also means that if you are using the static library form of the Vulkan loader GLFW will either fail to find it or (worse) use the wrong one.
The GLFW_VULKAN_STATIC CMake option makes GLFW call the Vulkan loader directly instead of dynamically loading it at runtime. Not linking against the Vulkan loader will then be a compile-time error.
+macOS: To make your application be redistributable you will need to set up the application bundle according to the LunarG SDK documentation. This is explained in more detail in the SDK documentation for macOS.
++Including the Vulkan and GLFW header files
+To include the Vulkan header, define GLFW_INCLUDE_VULKAN before including the GLFW header.
+If you instead want to include the Vulkan header from a custom location or use your own custom Vulkan header then do this before the GLFW header.
+Unless a Vulkan header is included, either by the GLFW header or above it, any GLFW functions that take or return Vulkan types will not be declared.
+The VK_USE_PLATFORM_*_KHR macros do not need to be defined for the Vulkan part of GLFW to work. Define them only if you are using these extensions directly.
+Querying for Vulkan support
+If you are linking directly against the Vulkan loader then you can skip this section. The canonical desktop loader library exports all Vulkan core and Khronos extension functions, allowing them to be called directly.
+If you are loading the Vulkan loader dynamically instead of linking directly against it, you can check for the availability of a loader and ICD with glfwVulkanSupported.
+This function returns GLFW_TRUE if the Vulkan loader and any minimally functional ICD was found.
If one or both were not found, calling any other Vulkan related GLFW function will generate a GLFW_API_UNAVAILABLE error.
++Querying Vulkan function pointers
+To load any Vulkan core or extension function from the found loader, call glfwGetInstanceProcAddress. To load functions needed for instance creation, pass NULL as the instance.
Once you have created an instance, you can load from it all other Vulkan core functions and functions from any instance extensions you enabled.
+This function in turn calls vkGetInstanceProcAddr. If that fails, the function falls back to a platform-specific query of the Vulkan loader (i.e. dlsym or GetProcAddress). If that also fails, the function returns NULL. For more information about vkGetInstanceProcAddr, see the Vulkan documentation.
Vulkan also provides vkGetDeviceProcAddr for loading device-specific versions of Vulkan function. This function can be retrieved from an instance with glfwGetInstanceProcAddress.
Device-specific functions may execute a little bit faster, due to not having to dispatch internally based on the device passed to them. For more information about vkGetDeviceProcAddr, see the Vulkan documentation.
+Querying required Vulkan extensions
+To do anything useful with Vulkan you need to create an instance. If you want to use Vulkan to render to a window, you must enable the instance extensions GLFW requires to create Vulkan surfaces.
+To query the instance extensions required, call glfwGetRequiredInstanceExtensions.
+These extensions must all be enabled when creating instances that are going to be passed to glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface. The set of extensions will vary depending on platform and may also vary depending on graphics drivers and other factors.
+If it fails it will return NULL and GLFW will not be able to create Vulkan window surfaces. You can still use Vulkan for off-screen rendering and compute work.
If successful the returned array will always include VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.
Additional extensions may be required by future versions of GLFW. You should check whether any extensions you wish to enable are already in the returned array, as it is an error to specify an extension more than once in the VkInstanceCreateInfo struct.
macOS: MoltenVK is (as of July 2022) not yet a fully conformant implementation of Vulkan. As of Vulkan SDK 1.3.216.0, this means you must also enable the VK_KHR_portability_enumeration instance extension and set the VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR bit in the instance creation info flags for MoltenVK to show up in the list of physical devices. For more information, see the Vulkan and MoltenVK documentation.
+Querying for Vulkan presentation support
+Not every queue family of every Vulkan device can present images to surfaces. To check whether a specific queue family of a physical device supports image presentation without first having to create a window and surface, call glfwGetPhysicalDevicePresentationSupport.
+The VK_KHR_surface extension additionally provides the vkGetPhysicalDeviceSurfaceSupportKHR function, which performs the same test on an existing Vulkan surface.
+Creating the window
+Unless you will be using OpenGL or OpenGL ES with the same window as Vulkan, there is no need to create a context. You can disable context creation with the GLFW_CLIENT_API hint.
+See Windows without contexts for more information.
++Creating a Vulkan window surface
+You can create a Vulkan surface (as defined by the VK_KHR_surface extension) for a GLFW window with glfwCreateWindowSurface.
If an OpenGL or OpenGL ES context was created on the window, the context has ownership of the presentation on the window and a Vulkan surface cannot be created.
+It is your responsibility to destroy the surface. GLFW does not destroy it for you. Call vkDestroySurfaceKHR function from the same extension to destroy it.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/window_8dox.html b/deps/glfw-3.3.8/docs/html/window_8dox.html new file mode 100644 index 0000000..3ca2913 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/window_8dox.html @@ -0,0 +1,74 @@ + + + + + + + ++Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + diff --git a/deps/glfw-3.3.8/docs/html/window_guide.html b/deps/glfw-3.3.8/docs/html/window_guide.html new file mode 100644 index 0000000..f7d0c2c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/window_guide.html @@ -0,0 +1,756 @@ + + + + + + + +Table of Contents
+- Window objects + +
- Window event processing +
- Window properties and events
- User pointer +
- Window closing and close flag +
- Window size +
- Framebuffer size +
- Window content scale +
- Window size limits +
- Window position +
- Window title +
- Window icon +
- Window monitor +
- Window iconification +
- Window maximization +
- Window visibility +
- Window input focus +
- Window attention request +
- Window damage and refresh +
- Window transparency +
- Window attributes + +
+ - Buffer swapping +
This guide introduces the window related functions of GLFW. For details on a specific function in this category, see the Window reference. There are also guides for the other areas of GLFW.
+ ++Window objects
+The GLFWwindow object encapsulates both a window and a context. They are created with glfwCreateWindow and destroyed with glfwDestroyWindow, or glfwTerminate, if any remain. As the window and context are inseparably linked, the object pointer is used as both a context and window handle.
+To see the event stream provided to the various window related callbacks, run the events test program.
+Window creation
+A window and its OpenGL or OpenGL ES context are created with glfwCreateWindow, which returns a handle to the created window object. For example, this creates a 640 by 480 windowed mode window:
+If window creation fails, NULL will be returned, so it is necessary to check the return value.
The window handle is passed to all window related functions and is provided to along with all input events, so event handlers can tell which window received the event.
++Full screen windows
+To create a full screen window, you need to specify which monitor the window should use. In most cases, the user's primary monitor is a good choice. For more information about retrieving monitors, see Retrieving monitors.
+Full screen windows cover the entire display area of a monitor, have no border or decorations.
+Windowed mode windows can be made full screen by setting a monitor with glfwSetWindowMonitor, and full screen ones can be made windowed by unsetting it with the same function.
+Each field of the GLFWvidmode structure corresponds to a function parameter or window hint and combine to form the desired video mode for that window. The supported video mode most closely matching the desired video mode will be set for the chosen monitor as long as the window has input focus. For more information about retrieving video modes, see Video modes.
+| Video mode field | Corresponds to |
|---|---|
| GLFWvidmode.width | width parameter of glfwCreateWindow |
| GLFWvidmode.height | height parameter of glfwCreateWindow |
| GLFWvidmode.redBits | GLFW_RED_BITS hint |
| GLFWvidmode.greenBits | GLFW_GREEN_BITS hint |
| GLFWvidmode.blueBits | GLFW_BLUE_BITS hint |
| GLFWvidmode.refreshRate | GLFW_REFRESH_RATE hint |
Once you have a full screen window, you can change its resolution, refresh rate and monitor with glfwSetWindowMonitor. If you only need change its resolution you can also call glfwSetWindowSize. In all cases, the new video mode will be selected the same way as the video mode chosen by glfwCreateWindow. If the window has an OpenGL or OpenGL ES context, it will be unaffected.
+By default, the original video mode of the monitor will be restored and the window iconified if it loses input focus, to allow the user to switch back to the desktop. This behavior can be disabled with the GLFW_AUTO_ICONIFY window hint, for example if you wish to simultaneously cover multiple monitors with full screen windows.
+If a monitor is disconnected, all windows that are full screen on that monitor will be switched to windowed mode. See Monitor configuration changes for more information.
++"Windowed full screen" windows
+If the closest match for the desired video mode is the current one, the video mode will not be changed, making window creation faster and application switching much smoother. This is sometimes called windowed full screen or borderless full screen window and counts as a full screen window. To create such a window, request the current video mode.
+This also works for windowed mode windows that are made full screen.
+Note that glfwGetVideoMode returns the current video mode of a monitor, so if you already have a full screen window on that monitor that you want to make windowed full screen, you need to have saved the desktop resolution before.
++Window destruction
+When a window is no longer needed, destroy it with glfwDestroyWindow.
+Window destruction always succeeds. Before the actual destruction, all callbacks are removed so no further events will be delivered for the window. All windows remaining when glfwTerminate is called are destroyed as well.
+When a full screen window is destroyed, the original video mode of its monitor is restored, but the gamma ramp is left untouched.
++Window creation hints
+There are a number of hints that can be set before the creation of a window and context. Some affect the window itself, others affect the framebuffer or context. These hints are set to their default values each time the library is initialized with glfwInit. Integer value hints can be set individually with glfwWindowHint and string value hints with glfwWindowHintString. You can reset all at once to their defaults with glfwDefaultWindowHints.
+Some hints are platform specific. These are always valid to set on any platform but they will only affect their specific platform. Other platforms will ignore them. Setting these hints requires no platform specific headers or calls.
+- Note
- Window hints need to be set before the creation of the window and context you wish to have the specified attributes. They function as additional arguments to glfwCreateWindow.
+Hard and soft constraints
+Some window hints are hard constraints. These must match the available capabilities exactly for window and context creation to succeed. Hints that are not hard constraints are matched as closely as possible, but the resulting context and framebuffer may differ from what these hints requested.
+The following hints are always hard constraints:
+The following additional hints are hard constraints when requesting an OpenGL context, but are ignored when requesting an OpenGL ES context:
++Window related hints
+GLFW_RESIZABLE specifies whether the windowed mode window will be resizable by the user. The window will still be resizable using the glfwSetWindowSize function. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen and undecorated windows.
GLFW_VISIBLE specifies whether the windowed mode window will be initially visible. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.
GLFW_DECORATED specifies whether the windowed mode window will have window decorations such as a border, a close widget, etc. An undecorated window will not be resizable by the user but will still allow the user to generate close events on some platforms. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.
GLFW_FOCUSED specifies whether the windowed mode window will be given input focus when created. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen and initially hidden windows.
GLFW_AUTO_ICONIFY specifies whether the full screen window will automatically iconify and restore the previous video mode on input focus loss. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for windowed mode windows.
GLFW_FLOATING specifies whether the windowed mode window will be floating above other regular windows, also called topmost or always-on-top. This is intended primarily for debugging purposes and cannot be used to implement proper full screen windows. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.
GLFW_MAXIMIZED specifies whether the windowed mode window will be maximized when created. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.
GLFW_CENTER_CURSOR specifies whether the cursor should be centered over newly created full screen windows. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for windowed mode windows.
GLFW_TRANSPARENT_FRAMEBUFFER specifies whether the window framebuffer will be transparent. If enabled and supported by the system, the window framebuffer alpha channel will be used to combine the framebuffer with the background. This does not affect window decorations. Possible values are GLFW_TRUE and GLFW_FALSE.
GLFW_FOCUS_ON_SHOW specifies whether the window will be given input focus when glfwShowWindow is called. Possible values are GLFW_TRUE and GLFW_FALSE.
GLFW_SCALE_TO_MONITOR specified whether the window content area should be resized based on the monitor content scale of any monitor it is placed on. This includes the initial placement when the window is created. Possible values are GLFW_TRUE and GLFW_FALSE.
This hint only has an effect on platforms where screen coordinates and pixels always map 1:1 such as Windows and X11. On platforms like macOS the resolution of the framebuffer is changed independently of the window size.
++Framebuffer related hints
+GLFW_RED_BITS, GLFW_GREEN_BITS, GLFW_BLUE_BITS, GLFW_ALPHA_BITS, GLFW_DEPTH_BITS and GLFW_STENCIL_BITS specify the desired bit depths of the various components of the default framebuffer. A value of GLFW_DONT_CARE means the application has no preference.
GLFW_ACCUM_RED_BITS, GLFW_ACCUM_GREEN_BITS, GLFW_ACCUM_BLUE_BITS and GLFW_ACCUM_ALPHA_BITS specify the desired bit depths of the various components of the accumulation buffer. A value of GLFW_DONT_CARE means the application has no preference.
Accumulation buffers are a legacy OpenGL feature and should not be used in new code.
+GLFW_AUX_BUFFERS specifies the desired number of auxiliary buffers. A value of GLFW_DONT_CARE means the application has no preference.
Auxiliary buffers are a legacy OpenGL feature and should not be used in new code.
+GLFW_STEREO specifies whether to use OpenGL stereoscopic rendering. Possible values are GLFW_TRUE and GLFW_FALSE. This is a hard constraint.
GLFW_SAMPLES specifies the desired number of samples to use for multisampling. Zero disables multisampling. A value of GLFW_DONT_CARE means the application has no preference.
GLFW_SRGB_CAPABLE specifies whether the framebuffer should be sRGB capable. Possible values are GLFW_TRUE and GLFW_FALSE.
- Note
- OpenGL: If enabled and supported by the system, the
GL_FRAMEBUFFER_SRGBenable will control sRGB rendering. By default, sRGB rendering will be disabled.
+ - +OpenGL ES: If enabled and supported by the system, the context will always have sRGB rendering enabled.
GLFW_DOUBLEBUFFER specifies whether the framebuffer should be double buffered. You nearly always want to use double buffering. This is a hard constraint. Possible values are GLFW_TRUE and GLFW_FALSE.
+Monitor related hints
+GLFW_REFRESH_RATE specifies the desired refresh rate for full screen windows. A value of GLFW_DONT_CARE means the highest available refresh rate will be used. This hint is ignored for windowed mode windows.
+Context related hints
+GLFW_CLIENT_API specifies which client API to create the context for. Possible values are GLFW_OPENGL_API, GLFW_OPENGL_ES_API and GLFW_NO_API. This is a hard constraint.
GLFW_CONTEXT_CREATION_API specifies which context creation API to use to create the context. Possible values are GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API and GLFW_OSMESA_CONTEXT_API. This is a hard constraint. If no client API is requested, this hint is ignored.
An extension loader library that assumes it knows which API was used to create the current context may fail if you change this hint. This can be resolved by having it load functions via glfwGetProcAddress.
+- Note
- Wayland: The EGL API is the native context creation API, so this hint will have no effect. +
- +X11: On some Linux systems, creating contexts via both the native and EGL APIs in a single process will cause the application to segfault. Stick to one API or the other on Linux for now. +
- +OSMesa: As its name implies, an OpenGL context created with OSMesa does not update the window contents when its buffers are swapped. Use OpenGL functions or the OSMesa native access functions glfwGetOSMesaColorBuffer and glfwGetOSMesaDepthBuffer to retrieve the framebuffer contents.
GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR specify the client API version that the created context must be compatible with. The exact behavior of these hints depend on the requested client API.
+While there is no way to ask the driver for a context of the highest supported version, GLFW will attempt to provide this when you ask for a version 1.0 context, which is the default for these hints.
+Do not confuse these hints with GLFW_VERSION_MAJOR and GLFW_VERSION_MINOR, which provide the API version of the GLFW header.
+- Note
- OpenGL: These hints are not hard constraints, but creation will fail if the OpenGL version of the created context is less than the one requested. It is therefore perfectly safe to use the default of version 1.0 for legacy code and you will still get backwards-compatible contexts of version 3.0 and above when available. +
- +OpenGL ES: These hints are not hard constraints, but creation will fail if the OpenGL ES version of the created context is less than the one requested. Additionally, OpenGL ES 1.x cannot be returned if 2.0 or later was requested, and vice versa. This is because OpenGL ES 3.x is backward compatible with 2.0, but OpenGL ES 2.0 is not backward compatible with 1.x. +
- +macOS: The OS only supports forward-compatible core profile contexts for OpenGL versions 3.2 and later. Before creating an OpenGL context of version 3.2 or later you must set the GLFW_OPENGL_FORWARD_COMPAT and GLFW_OPENGL_PROFILE hints accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all on macOS.
GLFW_OPENGL_FORWARD_COMPAT specifies whether the OpenGL context should be forward-compatible, i.e. one where all functionality deprecated in the requested version of OpenGL is removed. This must only be used if the requested OpenGL version is 3.0 or above. If OpenGL ES is requested, this hint is ignored.
+Forward-compatibility is described in detail in the OpenGL Reference Manual.
+GLFW_OPENGL_DEBUG_CONTEXT specifies whether the context should be created in debug mode, which may provide additional error and diagnostic reporting functionality. Possible values are GLFW_TRUE and GLFW_FALSE.
Debug contexts for OpenGL and OpenGL ES are described in detail by the GL_KHR_debug extension.
+GLFW_OPENGL_PROFILE specifies which OpenGL profile to create the context for. Possible values are one of GLFW_OPENGL_CORE_PROFILE or GLFW_OPENGL_COMPAT_PROFILE, or GLFW_OPENGL_ANY_PROFILE to not request a specific profile. If requesting an OpenGL version below 3.2, GLFW_OPENGL_ANY_PROFILE must be used. If OpenGL ES is requested, this hint is ignored.
OpenGL profiles are described in detail in the OpenGL Reference Manual.
+GLFW_CONTEXT_ROBUSTNESS specifies the robustness strategy to be used by the context. This can be one of GLFW_NO_RESET_NOTIFICATION or GLFW_LOSE_CONTEXT_ON_RESET, or GLFW_NO_ROBUSTNESS to not request a robustness strategy.
GLFW_CONTEXT_RELEASE_BEHAVIOR specifies the release behavior to be used by the context. Possible values are one of GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE. If the behavior is GLFW_ANY_RELEASE_BEHAVIOR, the default behavior of the context creation API will be used. If the behavior is GLFW_RELEASE_BEHAVIOR_FLUSH, the pipeline will be flushed whenever the context is released from being the current one. If the behavior is GLFW_RELEASE_BEHAVIOR_NONE, the pipeline will not be flushed on release.
Context release behaviors are described in detail by the GL_KHR_context_flush_control extension.
+GLFW_CONTEXT_NO_ERROR specifies whether errors should be generated by the context. Possible values are GLFW_TRUE and GLFW_FALSE. If enabled, situations that would have generated errors instead cause undefined behavior.
The no error mode for OpenGL and OpenGL ES is described in detail by the GL_KHR_no_error extension.
++macOS specific window hints
+GLFW_COCOA_RETINA_FRAMEBUFFER specifies whether to use full resolution framebuffers on Retina displays. Possible values are GLFW_TRUE and GLFW_FALSE. This is ignored on other platforms.
GLFW_COCOA_FRAME_NAME specifies the UTF-8 encoded name to use for autosaving the window frame, or if empty disables frame autosaving for the window. This is ignored on other platforms. This is set with glfwWindowHintString.
+GLFW_COCOA_GRAPHICS_SWITCHING specifies whether to in Automatic Graphics Switching, i.e. to allow the system to choose the integrated GPU for the OpenGL context and move it between GPUs if necessary or whether to force it to always run on the discrete GPU. This only affects systems with both integrated and discrete GPUs. Possible values are GLFW_TRUE and GLFW_FALSE. This is ignored on other platforms.
Simpler programs and tools may want to enable this to save power, while games and other applications performing advanced rendering will want to leave it disabled.
+A bundled application that wishes to participate in Automatic Graphics Switching should also declare this in its Info.plist by setting the NSSupportsAutomaticGraphicsSwitching key to true.
+X11 specific window hints
+GLFW_X11_CLASS_NAME and GLFW_X11_INSTANCE_NAME specifies the desired ASCII encoded class and instance parts of the ICCCM WM_CLASS window property. These are set with glfwWindowHintString.
+Supported and default values
+| Window hint | Default value | Supported values |
|---|---|---|
| GLFW_RESIZABLE | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_VISIBLE | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_DECORATED | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_FOCUSED | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_AUTO_ICONIFY | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_FLOATING | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_MAXIMIZED | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_CENTER_CURSOR | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_TRANSPARENT_FRAMEBUFFER | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_FOCUS_ON_SHOW | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_SCALE_TO_MONITOR | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_RED_BITS | 8 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_GREEN_BITS | 8 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_BLUE_BITS | 8 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_ALPHA_BITS | 8 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_DEPTH_BITS | 24 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_STENCIL_BITS | 8 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_ACCUM_RED_BITS | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_ACCUM_GREEN_BITS | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_ACCUM_BLUE_BITS | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_ACCUM_ALPHA_BITS | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_AUX_BUFFERS | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_SAMPLES | 0 | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_REFRESH_RATE | GLFW_DONT_CARE | 0 to INT_MAX or GLFW_DONT_CARE |
| GLFW_STEREO | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_SRGB_CAPABLE | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_DOUBLEBUFFER | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_CLIENT_API | GLFW_OPENGL_API | GLFW_OPENGL_API, GLFW_OPENGL_ES_API or GLFW_NO_API |
| GLFW_CONTEXT_CREATION_API | GLFW_NATIVE_CONTEXT_API | GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API or GLFW_OSMESA_CONTEXT_API |
| GLFW_CONTEXT_VERSION_MAJOR | 1 | Any valid major version number of the chosen client API |
| GLFW_CONTEXT_VERSION_MINOR | 0 | Any valid minor version number of the chosen client API |
| GLFW_CONTEXT_ROBUSTNESS | GLFW_NO_ROBUSTNESS | GLFW_NO_ROBUSTNESS, GLFW_NO_RESET_NOTIFICATION or GLFW_LOSE_CONTEXT_ON_RESET |
| GLFW_CONTEXT_RELEASE_BEHAVIOR | GLFW_ANY_RELEASE_BEHAVIOR | GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE |
| GLFW_OPENGL_FORWARD_COMPAT | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_OPENGL_DEBUG_CONTEXT | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_OPENGL_PROFILE | GLFW_OPENGL_ANY_PROFILE | GLFW_OPENGL_ANY_PROFILE, GLFW_OPENGL_COMPAT_PROFILE or GLFW_OPENGL_CORE_PROFILE |
| GLFW_COCOA_RETINA_FRAMEBUFFER | GLFW_TRUE | GLFW_TRUE or GLFW_FALSE |
| GLFW_COCOA_FRAME_NAME | "" | A UTF-8 encoded frame autosave name |
| GLFW_COCOA_GRAPHICS_SWITCHING | GLFW_FALSE | GLFW_TRUE or GLFW_FALSE |
| GLFW_X11_CLASS_NAME | "" | An ASCII encoded WM_CLASS class name |
| GLFW_X11_INSTANCE_NAME | "" | An ASCII encoded WM_CLASS instance name |
+Window event processing
+See Event processing.
++Window properties and events
++User pointer
+Each window has a user pointer that can be set with glfwSetWindowUserPointer and queried with glfwGetWindowUserPointer. This can be used for any purpose you need and will not be modified by GLFW throughout the life-time of the window.
+The initial value of the pointer is NULL.
+Window closing and close flag
+When the user attempts to close the window, for example by clicking the close widget or using a key chord like Alt+F4, the close flag of the window is set. The window is however not actually destroyed and, unless you watch for this state change, nothing further happens.
+The current state of the close flag is returned by glfwWindowShouldClose and can be set or cleared directly with glfwSetWindowShouldClose. A common pattern is to use the close flag as a main loop condition.
+If you wish to be notified when the user attempts to close a window, set a close callback.
+The callback function is called directly after the close flag has been set. It can be used for example to filter close requests and clear the close flag again unless certain conditions are met.
++Window size
+The size of a window can be changed with glfwSetWindowSize. For windowed mode windows, this sets the size, in screen coordinates of the content area or content area of the window. The window system may impose limits on window size.
+For full screen windows, the specified size becomes the new resolution of the window's desired video mode. The video mode most closely matching the new desired video mode is set immediately. The window is resized to fit the resolution of the set video mode.
+If you wish to be notified when a window is resized, whether by the user, the system or your own code, set a size callback.
+The callback function receives the new size, in screen coordinates, of the content area of the window when the window is resized.
+There is also glfwGetWindowSize for directly retrieving the current size of a window.
+- Note
- Do not pass the window size to
glViewportor other pixel-based OpenGL calls. The window size is in screen coordinates, not pixels. Use the framebuffer size, which is in pixels, for pixel-based calls.
The above functions work with the size of the content area, but decorated windows typically have title bars and window frames around this rectangle. You can retrieve the extents of these with glfwGetWindowFrameSize.
+The returned values are the distances, in screen coordinates, from the edges of the content area to the corresponding edges of the full window. As they are distances and not coordinates, they are always zero or positive.
++Framebuffer size
+While the size of a window is measured in screen coordinates, OpenGL works with pixels. The size you pass into glViewport, for example, should be in pixels. On some machines screen coordinates and pixels are the same, but on others they will not be. There is a second set of functions to retrieve the size, in pixels, of the framebuffer of a window.
If you wish to be notified when the framebuffer of a window is resized, whether by the user or the system, set a size callback.
+The callback function receives the new size of the framebuffer when it is resized, which can for example be used to update the OpenGL viewport.
+There is also glfwGetFramebufferSize for directly retrieving the current size of the framebuffer of a window.
+The size of a framebuffer may change independently of the size of a window, for example if the window is dragged between a regular monitor and a high-DPI one.
++Window content scale
+The content scale for a window can be retrieved with glfwGetWindowContentScale.
+The content scale is the ratio between the current DPI and the platform's default DPI. This is especially important for text and any UI elements. If the pixel dimensions of your UI scaled by this look appropriate on your machine then it should appear at a reasonable size on other machines regardless of their DPI and scaling settings. This relies on the system DPI and scaling settings being somewhat correct.
+On systems where each monitors can have its own content scale, the window content scale will depend on which monitor the system considers the window to be on.
+If you wish to be notified when the content scale of a window changes, whether because of a system setting change or because it was moved to a monitor with a different scale, set a content scale callback.
+The callback function receives the new content scale of the window.
+On platforms where pixels and screen coordinates always map 1:1, the window will need to be resized to appear the same size when it is moved to a monitor with a different content scale. To have this done automatically both when the window is created and when its content scale later changes, set the GLFW_SCALE_TO_MONITOR window hint.
++Window size limits
+The minimum and maximum size of the content area of a windowed mode window can be enforced with glfwSetWindowSizeLimits. The user may resize the window to any size and aspect ratio within the specified limits, unless the aspect ratio is also set.
+To specify only a minimum size or only a maximum one, set the other pair to GLFW_DONT_CARE.
To disable size limits for a window, set them all to GLFW_DONT_CARE.
The aspect ratio of the content area of a windowed mode window can be enforced with glfwSetWindowAspectRatio. The user may resize the window freely unless size limits are also set, but the size will be constrained to maintain the aspect ratio.
+The aspect ratio is specified as a numerator and denominator, corresponding to the width and height, respectively. If you want a window to maintain its current aspect ratio, use its current size as the ratio.
+To disable the aspect ratio limit for a window, set both terms to GLFW_DONT_CARE.
You can have both size limits and aspect ratio set for a window, but the results are undefined if they conflict.
++Window position
+The position of a windowed-mode window can be changed with glfwSetWindowPos. This moves the window so that the upper-left corner of its content area has the specified screen coordinates. The window system may put limitations on window placement.
+If you wish to be notified when a window is moved, whether by the user, the system or your own code, set a position callback.
+The callback function receives the new position, in screen coordinates, of the upper-left corner of the content area when the window is moved.
+There is also glfwGetWindowPos for directly retrieving the current position of the content area of the window.
++Window title
+All GLFW windows have a title, although undecorated or full screen windows may not display it or only display it in a task bar or similar interface. You can set a UTF-8 encoded window title with glfwSetWindowTitle.
+The specified string is copied before the function returns, so there is no need to keep it around.
+As long as your source file is encoded as UTF-8, you can use any Unicode characters directly in the source.
+If you are using C++11 or C11, you can use a UTF-8 string literal.
++Window icon
+Decorated windows have icons on some platforms. You can set this icon by specifying a list of candidate images with glfwSetWindowIcon.
+The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. The pixels are arranged canonically as sequential rows, starting from the top-left corner.
+To revert to the default window icon, pass in an empty image array.
++Window monitor
+Full screen windows are associated with a specific monitor. You can get the handle for this monitor with glfwGetWindowMonitor.
+This monitor handle is one of those returned by glfwGetMonitors.
+For windowed mode windows, this function returns NULL. This is how to tell full screen windows from windowed mode windows.
You can move windows between monitors or between full screen and windowed mode with glfwSetWindowMonitor. When making a window full screen on the same or on a different monitor, specify the desired monitor, resolution and refresh rate. The position arguments are ignored.
+When making the window windowed, specify the desired position and size. The refresh rate argument is ignored.
+This restores any previous window settings such as whether it is decorated, floating, resizable, has size or aspect ratio limits, etc.. To restore a window that was originally windowed to its original size and position, save these before making it full screen and then pass them in as above.
++Window iconification
+Windows can be iconified (i.e. minimized) with glfwIconifyWindow.
+When a full screen window is iconified, the original video mode of its monitor is restored until the user or application restores the window.
+Iconified windows can be restored with glfwRestoreWindow. This function also restores windows from maximization.
+When a full screen window is restored, the desired video mode is restored to its monitor as well.
+If you wish to be notified when a window is iconified or restored, whether by the user, system or your own code, set an iconify callback.
+The callback function receives changes in the iconification state of the window.
+You can also get the current iconification state with glfwGetWindowAttrib.
++Window maximization
+Windows can be maximized (i.e. zoomed) with glfwMaximizeWindow.
+Full screen windows cannot be maximized and passing a full screen window to this function does nothing.
+Maximized windows can be restored with glfwRestoreWindow. This function also restores windows from iconification.
+If you wish to be notified when a window is maximized or restored, whether by the user, system or your own code, set a maximize callback.
+The callback function receives changes in the maximization state of the window.
+You can also get the current maximization state with glfwGetWindowAttrib.
+By default, newly created windows are not maximized. You can change this behavior by setting the GLFW_MAXIMIZED window hint before creating the window.
++Window visibility
+Windowed mode windows can be hidden with glfwHideWindow.
+This makes the window completely invisible to the user, including removing it from the task bar, dock or window list. Full screen windows cannot be hidden and calling glfwHideWindow on a full screen window does nothing.
+Hidden windows can be shown with glfwShowWindow.
+By default, this function will also set the input focus to that window. Set the GLFW_FOCUS_ON_SHOW window hint to change this behavior for all newly created windows, or change the behavior for an existing window with glfwSetWindowAttrib.
+You can also get the current visibility state with glfwGetWindowAttrib.
+By default, newly created windows are visible. You can change this behavior by setting the GLFW_VISIBLE window hint before creating the window.
+Windows created hidden are completely invisible to the user until shown. This can be useful if you need to set up your window further before showing it, for example moving it to a specific location.
++Window input focus
+Windows can be given input focus and brought to the front with glfwFocusWindow.
+Keep in mind that it can be very disruptive to the user when a window is forced to the top. For a less disruptive way of getting the user's attention, see attention requests.
+If you wish to be notified when a window gains or loses input focus, whether by the user, system or your own code, set a focus callback.
+The callback function receives changes in the input focus state of the window.
+You can also get the current input focus state with glfwGetWindowAttrib.
+By default, newly created windows are given input focus. You can change this behavior by setting the GLFW_FOCUSED window hint before creating the window.
++Window attention request
+If you wish to notify the user of an event without interrupting, you can request attention with glfwRequestWindowAttention.
+The system will highlight the specified window, or on platforms where this is not supported, the application as a whole. Once the user has given it attention, the system will automatically end the request.
++Window damage and refresh
+If you wish to be notified when the contents of a window is damaged and needs to be refreshed, set a window refresh callback.
+The callback function is called when the contents of the window needs to be refreshed.
+- Note
- On compositing window systems such as Aero, Compiz or Aqua, where the window contents are saved off-screen, this callback might only be called when the window or framebuffer is resized.
+Window transparency
+GLFW supports two kinds of transparency for windows; framebuffer transparency and whole window transparency. A single window may not use both methods. The results of doing this are undefined.
+Both methods require the platform to support it and not every version of every platform GLFW supports does this, so there are mechanisms to check whether the window really is transparent.
+Window framebuffers can be made transparent on a per-pixel per-frame basis with the GLFW_TRANSPARENT_FRAMEBUFFER window hint.
+If supported by the system, the window content area will be composited with the background using the framebuffer per-pixel alpha channel. This requires desktop compositing to be enabled on the system. It does not affect window decorations.
+You can check whether the window framebuffer was successfully made transparent with the GLFW_TRANSPARENT_FRAMEBUFFER window attribute.
+GLFW comes with an example that enabled framebuffer transparency called gears.
The opacity of the whole window, including any decorations, can be set with glfwSetWindowOpacity.
+The opacity (or alpha) value is a positive finite number between zero and one, where 0 (zero) is fully transparent and 1 (one) is fully opaque. The initial opacity value for newly created windows is 1.
+The current opacity of a window can be queried with glfwGetWindowOpacity.
+If the system does not support whole window transparency, this function always returns one.
+GLFW comes with a test program that lets you control whole window transparency at run-time called opacity.
+Window attributes
+Windows have a number of attributes that can be returned using glfwGetWindowAttrib. Some reflect state that may change as a result of user interaction, (e.g. whether it has input focus), while others reflect inherent properties of the window (e.g. what kind of border it has). Some are related to the window and others to its OpenGL or OpenGL ES context.
+The GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW window attributes can be changed with glfwSetWindowAttrib.
++Window related attributes
+GLFW_FOCUSED indicates whether the specified window has input focus. See Window input focus for details.
+GLFW_ICONIFIED indicates whether the specified window is iconified. See Window iconification for details.
+GLFW_MAXIMIZED indicates whether the specified window is maximized. See Window maximization for details.
+GLFW_HOVERED indicates whether the cursor is currently directly over the content area of the window, with no other windows between. See Cursor enter/leave events for details.
+GLFW_VISIBLE indicates whether the specified window is visible. See Window visibility for details.
+GLFW_RESIZABLE indicates whether the specified window is resizable by the user. This can be set before creation with the GLFW_RESIZABLE window hint or after with glfwSetWindowAttrib.
+GLFW_DECORATED indicates whether the specified window has decorations such as a border, a close widget, etc. This can be set before creation with the GLFW_DECORATED window hint or after with glfwSetWindowAttrib.
+GLFW_AUTO_ICONIFY indicates whether the specified full screen window is iconified on focus loss, a close widget, etc. This can be set before creation with the GLFW_AUTO_ICONIFY window hint or after with glfwSetWindowAttrib.
+GLFW_FLOATING indicates whether the specified window is floating, also called topmost or always-on-top. This can be set before creation with the GLFW_FLOATING window hint or after with glfwSetWindowAttrib.
+GLFW_TRANSPARENT_FRAMEBUFFER indicates whether the specified window has a transparent framebuffer, i.e. the window contents is composited with the background using the window framebuffer alpha channel. See Window transparency for details.
+GLFW_FOCUS_ON_SHOW specifies whether the window will be given input focus when glfwShowWindow is called. This can be set before creation with the GLFW_FOCUS_ON_SHOW window hint or after with glfwSetWindowAttrib.
++Context related attributes
+GLFW_CLIENT_API indicates the client API provided by the window's context; either GLFW_OPENGL_API, GLFW_OPENGL_ES_API or GLFW_NO_API.
GLFW_CONTEXT_CREATION_API indicates the context creation API used to create the window's context; either GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API or GLFW_OSMESA_CONTEXT_API.
GLFW_CONTEXT_VERSION_MAJOR, GLFW_CONTEXT_VERSION_MINOR and GLFW_CONTEXT_REVISION indicate the client API version of the window's context.
+- Note
- Do not confuse these attributes with
GLFW_VERSION_MAJOR,GLFW_VERSION_MINORandGLFW_VERSION_REVISIONwhich provide the API version of the GLFW header.
GLFW_OPENGL_FORWARD_COMPAT is GLFW_TRUE if the window's context is an OpenGL forward-compatible one, or GLFW_FALSE otherwise.
GLFW_OPENGL_DEBUG_CONTEXT is GLFW_TRUE if the window's context is in debug mode, or GLFW_FALSE otherwise.
GLFW_OPENGL_PROFILE indicates the OpenGL profile used by the context. This is GLFW_OPENGL_CORE_PROFILE or GLFW_OPENGL_COMPAT_PROFILE if the context uses a known profile, or GLFW_OPENGL_ANY_PROFILE if the OpenGL profile is unknown or the context is an OpenGL ES context. Note that the returned profile may not match the profile bits of the context flags, as GLFW will try other means of detecting the profile when no bits are set.
GLFW_CONTEXT_RELEASE_BEHAVIOR indicates the release used by the context. Possible values are one of GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE. If the behavior is GLFW_ANY_RELEASE_BEHAVIOR, the default behavior of the context creation API will be used. If the behavior is GLFW_RELEASE_BEHAVIOR_FLUSH, the pipeline will be flushed whenever the context is released from being the current one. If the behavior is GLFW_RELEASE_BEHAVIOR_NONE, the pipeline will not be flushed on release.
GLFW_CONTEXT_NO_ERROR indicates whether errors are generated by the context. Possible values are GLFW_TRUE and GLFW_FALSE. If enabled, situations that would have generated errors instead cause undefined behavior.
GLFW_CONTEXT_ROBUSTNESS indicates the robustness strategy used by the context. This is GLFW_LOSE_CONTEXT_ON_RESET or GLFW_NO_RESET_NOTIFICATION if the window's context supports robustness, or GLFW_NO_ROBUSTNESS otherwise.
+Framebuffer related attributes
+GLFW does not expose attributes of the default framebuffer (i.e. the framebuffer attached to the window) as these can be queried directly with either OpenGL, OpenGL ES or Vulkan.
+If you are using version 3.0 or later of OpenGL or OpenGL ES, the glGetFramebufferAttachmentParameteriv function can be used to retrieve the number of bits for the red, green, blue, alpha, depth and stencil buffer channels. Otherwise, the glGetIntegerv function can be used.
The number of MSAA samples are always retrieved with glGetIntegerv. For contexts supporting framebuffer objects, the number of samples of the currently bound framebuffer is returned.
| Attribute | glGetIntegerv | glGetFramebufferAttachmentParameteriv |
|---|---|---|
| Red bits | GL_RED_BITS | GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE |
| Green bits | GL_GREEN_BITS | GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE |
| Blue bits | GL_BLUE_BITS | GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE |
| Alpha bits | GL_ALPHA_BITS | GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE |
| Depth bits | GL_DEPTH_BITS | GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE |
| Stencil bits | GL_STENCIL_BITS | GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE |
| MSAA samples | GL_SAMPLES | Not provided by this function |
When calling glGetFramebufferAttachmentParameteriv, the red, green, blue and alpha sizes are queried from the GL_BACK_LEFT, while the depth and stencil sizes are queried from the GL_DEPTH and GL_STENCIL attachments, respectively.
+Buffer swapping
+GLFW windows are by default double buffered. That means that you have two rendering buffers; a front buffer and a back buffer. The front buffer is the one being displayed and the back buffer the one you render to.
+When the entire frame has been rendered, it is time to swap the back and the front buffers in order to display what has been rendered and begin rendering a new frame. This is done with glfwSwapBuffers.
+Sometimes it can be useful to select when the buffer swap will occur. With the function glfwSwapInterval it is possible to select the minimum number of monitor refreshes the driver should wait from the time glfwSwapBuffers was called before swapping the buffers:
+If the interval is zero, the swap will take place immediately when glfwSwapBuffers is called without waiting for a refresh. Otherwise at least interval retraces will pass between each buffer swap. Using a swap interval of zero can be useful for benchmarking purposes, when it is not desirable to measure the time it takes to wait for the vertical retrace. However, a swap interval of one lets you avoid tearing.
+Note that this may not work on all machines, as some drivers have user-controlled settings that override any swap interval the application requests.
+A context that supports either the WGL_EXT_swap_control_tear or the GLX_EXT_swap_control_tear extension also accepts negative swap intervals, which allows the driver to swap immediately even if a frame arrives a little bit late. This trades the risk of visible tears for greater framerate stability. You can check for these extensions with glfwExtensionSupported.
+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +
+ + + -- cgit v1.2.3-70-g09d2