glfw3.h
Go to the documentation of this file.
1 /*************************************************************************
2  * GLFW 3.4 - www.glfw.org
3  * A library for OpenGL, window and input
4  *------------------------------------------------------------------------
5  * Copyright (c) 2002-2006 Marcus Geelnard
6  * Copyright (c) 2006-2019 Camilla Löwy <elmindreda@glfw.org>
7  *
8  * This software is provided 'as-is', without any express or implied
9  * warranty. In no event will the authors be held liable for any damages
10  * arising from the use of this software.
11  *
12  * Permission is granted to anyone to use this software for any purpose,
13  * including commercial applications, and to alter it and redistribute it
14  * freely, subject to the following restrictions:
15  *
16  * 1. The origin of this software must not be misrepresented; you must not
17  * claim that you wrote the original software. If you use this software
18  * in a product, an acknowledgment in the product documentation would
19  * be appreciated but is not required.
20  *
21  * 2. Altered source versions must be plainly marked as such, and must not
22  * be misrepresented as being the original software.
23  *
24  * 3. This notice may not be removed or altered from any source
25  * distribution.
26  *
27  *************************************************************************/
28 
29 #ifndef _glfw3_h_
30 #define _glfw3_h_
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
37 /*************************************************************************
38  * Doxygen documentation
39  *************************************************************************/
40 
89 /*************************************************************************
90  * Compiler- and platform-specific preprocessor work
91  *************************************************************************/
92 
93 /* If we are we on Windows, we want a single define for it.
94  */
95 #if !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__MINGW32__))
96  #define _WIN32
97 #endif /* _WIN32 */
98 
99 /* Include because most Windows GLU headers need wchar_t and
100  * the macOS OpenGL header blocks the definition of ptrdiff_t by glext.h.
101  * Include it unconditionally to avoid surprising side-effects.
102  */
103 #include <stddef.h>
104 
105 /* Include because it is needed by Vulkan and related functions.
106  * Include it unconditionally to avoid surprising side-effects.
107  */
108 #include <stdint.h>
109 
110 #if defined(GLFW_INCLUDE_VULKAN)
111  #include <vulkan/vulkan.h>
112 #endif /* Vulkan header */
113 
114 /* The Vulkan header may have indirectly included windows.h (because of
115  * VK_USE_PLATFORM_WIN32_KHR) so we offer our replacement symbols after it.
116  */
117 
118 /* It is customary to use APIENTRY for OpenGL function pointer declarations on
119  * all platforms. Additionally, the Windows OpenGL header needs APIENTRY.
120  */
121 #if !defined(APIENTRY)
122  #if defined(_WIN32)
123  #define APIENTRY __stdcall
124  #else
125  #define APIENTRY
126  #endif
127  #define GLFW_APIENTRY_DEFINED
128 #endif /* APIENTRY */
129 
130 /* Some Windows OpenGL headers need this.
131  */
132 #if !defined(WINGDIAPI) && defined(_WIN32)
133  #define WINGDIAPI __declspec(dllimport)
134  #define GLFW_WINGDIAPI_DEFINED
135 #endif /* WINGDIAPI */
136 
137 /* Some Windows GLU headers need this.
138  */
139 #if !defined(CALLBACK) && defined(_WIN32)
140  #define CALLBACK __stdcall
141  #define GLFW_CALLBACK_DEFINED
142 #endif /* CALLBACK */
143 
144 /* Include the chosen OpenGL or OpenGL ES headers.
145  */
146 #if defined(GLFW_INCLUDE_ES1)
147 
148  #include <GLES/gl.h>
149  #if defined(GLFW_INCLUDE_GLEXT)
150  #include <GLES/glext.h>
151  #endif
152 
153 #elif defined(GLFW_INCLUDE_ES2)
154 
155  #include <GLES2/gl2.h>
156  #if defined(GLFW_INCLUDE_GLEXT)
157  #include <GLES2/gl2ext.h>
158  #endif
159 
160 #elif defined(GLFW_INCLUDE_ES3)
161 
162  #include <GLES3/gl3.h>
163  #if defined(GLFW_INCLUDE_GLEXT)
164  #include <GLES2/gl2ext.h>
165  #endif
166 
167 #elif defined(GLFW_INCLUDE_ES31)
168 
169  #include <GLES3/gl31.h>
170  #if defined(GLFW_INCLUDE_GLEXT)
171  #include <GLES2/gl2ext.h>
172  #endif
173 
174 #elif defined(GLFW_INCLUDE_ES32)
175 
176  #include <GLES3/gl32.h>
177  #if defined(GLFW_INCLUDE_GLEXT)
178  #include <GLES2/gl2ext.h>
179  #endif
180 
181 #elif defined(GLFW_INCLUDE_GLCOREARB)
182 
183  #if defined(__APPLE__)
184 
185  #include <OpenGL/gl3.h>
186  #if defined(GLFW_INCLUDE_GLEXT)
187  #include <OpenGL/gl3ext.h>
188  #endif /*GLFW_INCLUDE_GLEXT*/
189 
190  #else /*__APPLE__*/
191 
192  #include <GL/glcorearb.h>
193 
194  #endif /*__APPLE__*/
195 
196 #elif !defined(GLFW_INCLUDE_NONE)
197 
198  #if defined(__APPLE__)
199 
200  #if !defined(GLFW_INCLUDE_GLEXT)
201  #define GL_GLEXT_LEGACY
202  #endif
203  #include <OpenGL/gl.h>
204  #if defined(GLFW_INCLUDE_GLU)
205  #include <OpenGL/glu.h>
206  #endif
207 
208  #else /*__APPLE__*/
209 
210  #include <GL/gl.h>
211  #if defined(GLFW_INCLUDE_GLEXT)
212  #include <GL/glext.h>
213  #endif
214  #if defined(GLFW_INCLUDE_GLU)
215  #include <GL/glu.h>
216  #endif
217 
218  #endif /*__APPLE__*/
219 
220 #endif /* OpenGL and OpenGL ES headers */
221 
222 #if defined(GLFW_DLL) && defined(_GLFW_BUILD_DLL)
223  /* GLFW_DLL must be defined by applications that are linking against the DLL
224  * version of the GLFW library. _GLFW_BUILD_DLL is defined by the GLFW
225  * configuration header when compiling the DLL version of the library.
226  */
227  #error "You must not have both GLFW_DLL and _GLFW_BUILD_DLL defined"
228 #endif
229 
230 /* GLFWAPI is used to declare public API functions for export
231  * from the DLL / shared library / dynamic library.
232  */
233 #if defined(_WIN32) && defined(_GLFW_BUILD_DLL)
234  /* We are building GLFW as a Win32 DLL */
235  #define GLFWAPI __declspec(dllexport)
236 #elif defined(_WIN32) && defined(GLFW_DLL)
237  /* We are calling GLFW as a Win32 DLL */
238  #define GLFWAPI __declspec(dllimport)
239 #elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL)
240  /* We are building GLFW as a shared / dynamic library */
241  #define GLFWAPI __attribute__((visibility("default")))
242 #else
243  /* We are building or calling GLFW as a static library */
244  #define GLFWAPI
245 #endif
246 
247 
248 /*************************************************************************
249  * GLFW API tokens
250  *************************************************************************/
251 
259 #define GLFW_VERSION_MAJOR 3
260 
266 #define GLFW_VERSION_MINOR 4
267 
273 #define GLFW_VERSION_REVISION 0
274 
284 #define GLFW_TRUE 1
285 
293 #define GLFW_FALSE 0
294 
303 #define GLFW_RELEASE 0
304 
310 #define GLFW_PRESS 1
311 
317 #define GLFW_REPEAT 2
318 
327 #define GLFW_HAT_CENTERED 0
328 #define GLFW_HAT_UP 1
329 #define GLFW_HAT_RIGHT 2
330 #define GLFW_HAT_DOWN 4
331 #define GLFW_HAT_LEFT 8
332 #define GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP)
333 #define GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)
334 #define GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP)
335 #define GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN)
336 
362 /* The unknown key */
363 #define GLFW_KEY_UNKNOWN -1
364 
365 /* Printable keys */
366 #define GLFW_KEY_SPACE 32
367 #define GLFW_KEY_APOSTROPHE 39 /* ' */
368 #define GLFW_KEY_COMMA 44 /* , */
369 #define GLFW_KEY_MINUS 45 /* - */
370 #define GLFW_KEY_PERIOD 46 /* . */
371 #define GLFW_KEY_SLASH 47 /* / */
372 #define GLFW_KEY_0 48
373 #define GLFW_KEY_1 49
374 #define GLFW_KEY_2 50
375 #define GLFW_KEY_3 51
376 #define GLFW_KEY_4 52
377 #define GLFW_KEY_5 53
378 #define GLFW_KEY_6 54
379 #define GLFW_KEY_7 55
380 #define GLFW_KEY_8 56
381 #define GLFW_KEY_9 57
382 #define GLFW_KEY_SEMICOLON 59 /* ; */
383 #define GLFW_KEY_EQUAL 61 /* = */
384 #define GLFW_KEY_A 65
385 #define GLFW_KEY_B 66
386 #define GLFW_KEY_C 67
387 #define GLFW_KEY_D 68
388 #define GLFW_KEY_E 69
389 #define GLFW_KEY_F 70
390 #define GLFW_KEY_G 71
391 #define GLFW_KEY_H 72
392 #define GLFW_KEY_I 73
393 #define GLFW_KEY_J 74
394 #define GLFW_KEY_K 75
395 #define GLFW_KEY_L 76
396 #define GLFW_KEY_M 77
397 #define GLFW_KEY_N 78
398 #define GLFW_KEY_O 79
399 #define GLFW_KEY_P 80
400 #define GLFW_KEY_Q 81
401 #define GLFW_KEY_R 82
402 #define GLFW_KEY_S 83
403 #define GLFW_KEY_T 84
404 #define GLFW_KEY_U 85
405 #define GLFW_KEY_V 86
406 #define GLFW_KEY_W 87
407 #define GLFW_KEY_X 88
408 #define GLFW_KEY_Y 89
409 #define GLFW_KEY_Z 90
410 #define GLFW_KEY_LEFT_BRACKET 91 /* [ */
411 #define GLFW_KEY_BACKSLASH 92 /* \ */
412 #define GLFW_KEY_RIGHT_BRACKET 93 /* ] */
413 #define GLFW_KEY_GRAVE_ACCENT 96 /* ` */
414 #define GLFW_KEY_WORLD_1 161 /* non-US #1 */
415 #define GLFW_KEY_WORLD_2 162 /* non-US #2 */
416 
417 /* Function keys */
418 #define GLFW_KEY_ESCAPE 256
419 #define GLFW_KEY_ENTER 257
420 #define GLFW_KEY_TAB 258
421 #define GLFW_KEY_BACKSPACE 259
422 #define GLFW_KEY_INSERT 260
423 #define GLFW_KEY_DELETE 261
424 #define GLFW_KEY_RIGHT 262
425 #define GLFW_KEY_LEFT 263
426 #define GLFW_KEY_DOWN 264
427 #define GLFW_KEY_UP 265
428 #define GLFW_KEY_PAGE_UP 266
429 #define GLFW_KEY_PAGE_DOWN 267
430 #define GLFW_KEY_HOME 268
431 #define GLFW_KEY_END 269
432 #define GLFW_KEY_CAPS_LOCK 280
433 #define GLFW_KEY_SCROLL_LOCK 281
434 #define GLFW_KEY_NUM_LOCK 282
435 #define GLFW_KEY_PRINT_SCREEN 283
436 #define GLFW_KEY_PAUSE 284
437 #define GLFW_KEY_F1 290
438 #define GLFW_KEY_F2 291
439 #define GLFW_KEY_F3 292
440 #define GLFW_KEY_F4 293
441 #define GLFW_KEY_F5 294
442 #define GLFW_KEY_F6 295
443 #define GLFW_KEY_F7 296
444 #define GLFW_KEY_F8 297
445 #define GLFW_KEY_F9 298
446 #define GLFW_KEY_F10 299
447 #define GLFW_KEY_F11 300
448 #define GLFW_KEY_F12 301
449 #define GLFW_KEY_F13 302
450 #define GLFW_KEY_F14 303
451 #define GLFW_KEY_F15 304
452 #define GLFW_KEY_F16 305
453 #define GLFW_KEY_F17 306
454 #define GLFW_KEY_F18 307
455 #define GLFW_KEY_F19 308
456 #define GLFW_KEY_F20 309
457 #define GLFW_KEY_F21 310
458 #define GLFW_KEY_F22 311
459 #define GLFW_KEY_F23 312
460 #define GLFW_KEY_F24 313
461 #define GLFW_KEY_F25 314
462 #define GLFW_KEY_KP_0 320
463 #define GLFW_KEY_KP_1 321
464 #define GLFW_KEY_KP_2 322
465 #define GLFW_KEY_KP_3 323
466 #define GLFW_KEY_KP_4 324
467 #define GLFW_KEY_KP_5 325
468 #define GLFW_KEY_KP_6 326
469 #define GLFW_KEY_KP_7 327
470 #define GLFW_KEY_KP_8 328
471 #define GLFW_KEY_KP_9 329
472 #define GLFW_KEY_KP_DECIMAL 330
473 #define GLFW_KEY_KP_DIVIDE 331
474 #define GLFW_KEY_KP_MULTIPLY 332
475 #define GLFW_KEY_KP_SUBTRACT 333
476 #define GLFW_KEY_KP_ADD 334
477 #define GLFW_KEY_KP_ENTER 335
478 #define GLFW_KEY_KP_EQUAL 336
479 #define GLFW_KEY_LEFT_SHIFT 340
480 #define GLFW_KEY_LEFT_CONTROL 341
481 #define GLFW_KEY_LEFT_ALT 342
482 #define GLFW_KEY_LEFT_SUPER 343
483 #define GLFW_KEY_RIGHT_SHIFT 344
484 #define GLFW_KEY_RIGHT_CONTROL 345
485 #define GLFW_KEY_RIGHT_ALT 346
486 #define GLFW_KEY_RIGHT_SUPER 347
487 #define GLFW_KEY_MENU 348
488 
489 #define GLFW_KEY_LAST GLFW_KEY_MENU
490 
505 #define GLFW_MOD_SHIFT 0x0001
506 
510 #define GLFW_MOD_CONTROL 0x0002
511 
515 #define GLFW_MOD_ALT 0x0004
516 
520 #define GLFW_MOD_SUPER 0x0008
521 
526 #define GLFW_MOD_CAPS_LOCK 0x0010
527 
532 #define GLFW_MOD_NUM_LOCK 0x0020
533 
543 #define GLFW_MOUSE_BUTTON_1 0
544 #define GLFW_MOUSE_BUTTON_2 1
545 #define GLFW_MOUSE_BUTTON_3 2
546 #define GLFW_MOUSE_BUTTON_4 3
547 #define GLFW_MOUSE_BUTTON_5 4
548 #define GLFW_MOUSE_BUTTON_6 5
549 #define GLFW_MOUSE_BUTTON_7 6
550 #define GLFW_MOUSE_BUTTON_8 7
551 #define GLFW_MOUSE_BUTTON_LAST GLFW_MOUSE_BUTTON_8
552 #define GLFW_MOUSE_BUTTON_LEFT GLFW_MOUSE_BUTTON_1
553 #define GLFW_MOUSE_BUTTON_RIGHT GLFW_MOUSE_BUTTON_2
554 #define GLFW_MOUSE_BUTTON_MIDDLE GLFW_MOUSE_BUTTON_3
555 
564 #define GLFW_JOYSTICK_1 0
565 #define GLFW_JOYSTICK_2 1
566 #define GLFW_JOYSTICK_3 2
567 #define GLFW_JOYSTICK_4 3
568 #define GLFW_JOYSTICK_5 4
569 #define GLFW_JOYSTICK_6 5
570 #define GLFW_JOYSTICK_7 6
571 #define GLFW_JOYSTICK_8 7
572 #define GLFW_JOYSTICK_9 8
573 #define GLFW_JOYSTICK_10 9
574 #define GLFW_JOYSTICK_11 10
575 #define GLFW_JOYSTICK_12 11
576 #define GLFW_JOYSTICK_13 12
577 #define GLFW_JOYSTICK_14 13
578 #define GLFW_JOYSTICK_15 14
579 #define GLFW_JOYSTICK_16 15
580 #define GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16
581 
590 #define GLFW_GAMEPAD_BUTTON_A 0
591 #define GLFW_GAMEPAD_BUTTON_B 1
592 #define GLFW_GAMEPAD_BUTTON_X 2
593 #define GLFW_GAMEPAD_BUTTON_Y 3
594 #define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4
595 #define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5
596 #define GLFW_GAMEPAD_BUTTON_BACK 6
597 #define GLFW_GAMEPAD_BUTTON_START 7
598 #define GLFW_GAMEPAD_BUTTON_GUIDE 8
599 #define GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9
600 #define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10
601 #define GLFW_GAMEPAD_BUTTON_DPAD_UP 11
602 #define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12
603 #define GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13
604 #define GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14
605 #define GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT
606 
607 #define GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A
608 #define GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B
609 #define GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X
610 #define GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y
611 
620 #define GLFW_GAMEPAD_AXIS_LEFT_X 0
621 #define GLFW_GAMEPAD_AXIS_LEFT_Y 1
622 #define GLFW_GAMEPAD_AXIS_RIGHT_X 2
623 #define GLFW_GAMEPAD_AXIS_RIGHT_Y 3
624 #define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4
625 #define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5
626 #define GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
627 
642 #define GLFW_NO_ERROR 0
643 
651 #define GLFW_NOT_INITIALIZED 0x00010001
652 
661 #define GLFW_NO_CURRENT_CONTEXT 0x00010002
662 
669 #define GLFW_INVALID_ENUM 0x00010003
670 
680 #define GLFW_INVALID_VALUE 0x00010004
681 
688 #define GLFW_OUT_OF_MEMORY 0x00010005
689 
704 #define GLFW_API_UNAVAILABLE 0x00010006
705 
721 #define GLFW_VERSION_UNAVAILABLE 0x00010007
722 
732 #define GLFW_PLATFORM_ERROR 0x00010008
733 
751 #define GLFW_FORMAT_UNAVAILABLE 0x00010009
752 
759 #define GLFW_NO_WINDOW_CONTEXT 0x0001000A
760 
770 #define GLFW_CURSOR_UNAVAILABLE 0x0001000B
771 
780 #define GLFW_FOCUSED 0x00020001
781 
785 #define GLFW_ICONIFIED 0x00020002
786 
791 #define GLFW_RESIZABLE 0x00020003
792 
797 #define GLFW_VISIBLE 0x00020004
798 
803 #define GLFW_DECORATED 0x00020005
804 
809 #define GLFW_AUTO_ICONIFY 0x00020006
810 
815 #define GLFW_FLOATING 0x00020007
816 
821 #define GLFW_MAXIMIZED 0x00020008
822 
826 #define GLFW_CENTER_CURSOR 0x00020009
827 
833 #define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A
834 
838 #define GLFW_HOVERED 0x0002000B
839 
844 #define GLFW_FOCUS_ON_SHOW 0x0002000C
845 
850 #define GLFW_RED_BITS 0x00021001
851 
855 #define GLFW_GREEN_BITS 0x00021002
856 
860 #define GLFW_BLUE_BITS 0x00021003
861 
865 #define GLFW_ALPHA_BITS 0x00021004
866 
870 #define GLFW_DEPTH_BITS 0x00021005
871 
875 #define GLFW_STENCIL_BITS 0x00021006
876 
880 #define GLFW_ACCUM_RED_BITS 0x00021007
881 
885 #define GLFW_ACCUM_GREEN_BITS 0x00021008
886 
890 #define GLFW_ACCUM_BLUE_BITS 0x00021009
891 
895 #define GLFW_ACCUM_ALPHA_BITS 0x0002100A
896 
900 #define GLFW_AUX_BUFFERS 0x0002100B
901 
905 #define GLFW_STEREO 0x0002100C
906 
910 #define GLFW_SAMPLES 0x0002100D
911 
915 #define GLFW_SRGB_CAPABLE 0x0002100E
916 
920 #define GLFW_REFRESH_RATE 0x0002100F
921 
925 #define GLFW_DOUBLEBUFFER 0x00021010
926 
932 #define GLFW_CLIENT_API 0x00022001
933 
938 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
939 
944 #define GLFW_CONTEXT_VERSION_MINOR 0x00022003
945 
950 #define GLFW_CONTEXT_REVISION 0x00022004
951 
956 #define GLFW_CONTEXT_ROBUSTNESS 0x00022005
957 
962 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
963 
968 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
969 
974 #define GLFW_OPENGL_PROFILE 0x00022008
975 
980 #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
981 
986 #define GLFW_CONTEXT_NO_ERROR 0x0002200A
987 
992 #define GLFW_CONTEXT_CREATION_API 0x0002200B
993 
996 #define GLFW_SCALE_TO_MONITOR 0x0002200C
997 
1000 #define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
1001 
1004 #define GLFW_COCOA_FRAME_NAME 0x00023002
1005 
1008 #define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
1009 
1012 #define GLFW_X11_CLASS_NAME 0x00024001
1016 #define GLFW_X11_INSTANCE_NAME 0x00024002
1017 #define GLFW_WIN32_KEYBOARD_MENU 0x00025001
1020 #define GLFW_NO_API 0
1021 #define GLFW_OPENGL_API 0x00030001
1022 #define GLFW_OPENGL_ES_API 0x00030002
1023 
1024 #define GLFW_NO_ROBUSTNESS 0
1025 #define GLFW_NO_RESET_NOTIFICATION 0x00031001
1026 #define GLFW_LOSE_CONTEXT_ON_RESET 0x00031002
1027 
1028 #define GLFW_OPENGL_ANY_PROFILE 0
1029 #define GLFW_OPENGL_CORE_PROFILE 0x00032001
1030 #define GLFW_OPENGL_COMPAT_PROFILE 0x00032002
1032 #define GLFW_CURSOR 0x00033001
1033 #define GLFW_STICKY_KEYS 0x00033002
1034 #define GLFW_STICKY_MOUSE_BUTTONS 0x00033003
1035 #define GLFW_LOCK_KEY_MODS 0x00033004
1036 #define GLFW_RAW_MOUSE_MOTION 0x00033005
1037 
1038 #define GLFW_CURSOR_NORMAL 0x00034001
1039 #define GLFW_CURSOR_HIDDEN 0x00034002
1040 #define GLFW_CURSOR_DISABLED 0x00034003
1041 
1042 #define GLFW_ANY_RELEASE_BEHAVIOR 0
1043 #define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001
1044 #define GLFW_RELEASE_BEHAVIOR_NONE 0x00035002
1045 
1046 #define GLFW_NATIVE_CONTEXT_API 0x00036001
1047 #define GLFW_EGL_CONTEXT_API 0x00036002
1048 #define GLFW_OSMESA_CONTEXT_API 0x00036003
1049 
1063 #define GLFW_ARROW_CURSOR 0x00036001
1068 #define GLFW_IBEAM_CURSOR 0x00036002
1073 #define GLFW_CROSSHAIR_CURSOR 0x00036003
1078 #define GLFW_POINTING_HAND_CURSOR 0x00036004
1079 
1084 #define GLFW_RESIZE_EW_CURSOR 0x00036005
1085 
1090 #define GLFW_RESIZE_NS_CURSOR 0x00036006
1091 
1105 #define GLFW_RESIZE_NWSE_CURSOR 0x00036007
1106 
1120 #define GLFW_RESIZE_NESW_CURSOR 0x00036008
1121 
1126 #define GLFW_RESIZE_ALL_CURSOR 0x00036009
1127 
1138 #define GLFW_NOT_ALLOWED_CURSOR 0x0003600A
1143 #define GLFW_HRESIZE_CURSOR GLFW_RESIZE_EW_CURSOR
1148 #define GLFW_VRESIZE_CURSOR GLFW_RESIZE_NS_CURSOR
1153 #define GLFW_HAND_CURSOR GLFW_POINTING_HAND_CURSOR
1154 
1156 #define GLFW_CONNECTED 0x00040001
1157 #define GLFW_DISCONNECTED 0x00040002
1158 
1165 #define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001
1170 #define GLFW_COCOA_CHDIR_RESOURCES 0x00051001
1175 #define GLFW_COCOA_MENUBAR 0x00051002
1176 
1178 #define GLFW_DONT_CARE -1
1179 
1180 
1181 /*************************************************************************
1182  * GLFW API types
1183  *************************************************************************/
1184 
1197 typedef void (*GLFWglproc)(void);
1198 
1211 typedef void (*GLFWvkproc)(void);
1212 
1223 typedef struct GLFWmonitor GLFWmonitor;
1224 
1235 typedef struct GLFWwindow GLFWwindow;
1236 
1247 typedef struct GLFWcursor GLFWcursor;
1248 
1271 typedef void (* GLFWerrorfun)(int,const char*);
1272 
1294 typedef void (* GLFWwindowposfun)(GLFWwindow*,int,int);
1295 
1316 typedef void (* GLFWwindowsizefun)(GLFWwindow*,int,int);
1317 
1336 typedef void (* GLFWwindowclosefun)(GLFWwindow*);
1337 
1356 typedef void (* GLFWwindowrefreshfun)(GLFWwindow*);
1357 
1377 typedef void (* GLFWwindowfocusfun)(GLFWwindow*,int);
1378 
1398 typedef void (* GLFWwindowiconifyfun)(GLFWwindow*,int);
1399 
1419 typedef void (* GLFWwindowmaximizefun)(GLFWwindow*,int);
1420 
1440 typedef void (* GLFWframebuffersizefun)(GLFWwindow*,int,int);
1441 
1461 typedef void (* GLFWwindowcontentscalefun)(GLFWwindow*,float,float);
1462 
1487 typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int);
1488 
1510 typedef void (* GLFWcursorposfun)(GLFWwindow*,double,double);
1511 
1531 typedef void (* GLFWcursorenterfun)(GLFWwindow*,int);
1532 
1552 typedef void (* GLFWscrollfun)(GLFWwindow*,double,double);
1553 
1578 typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int,int);
1579 
1599 typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int);
1600 
1626 typedef void (* GLFWcharmodsfun)(GLFWwindow*,unsigned int,int);
1627 
1650 typedef void (* GLFWdropfun)(GLFWwindow*,int,const char*[]);
1651 
1671 typedef void (* GLFWmonitorfun)(GLFWmonitor*,int);
1672 
1692 typedef void (* GLFWjoystickfun)(int,int);
1693 
1707 typedef struct GLFWvidmode
1708 {
1711  int width;
1714  int height;
1717  int redBits;
1720  int greenBits;
1723  int blueBits;
1726  int refreshRate;
1727 } GLFWvidmode;
1728 
1741 typedef struct GLFWgammaramp
1742 {
1745  unsigned short* red;
1748  unsigned short* green;
1751  unsigned short* blue;
1754  unsigned int size;
1755 } GLFWgammaramp;
1756 
1770 typedef struct GLFWimage
1771 {
1774  int width;
1777  int height;
1780  unsigned char* pixels;
1781 } GLFWimage;
1782 
1794 typedef struct GLFWgamepadstate
1795 {
1799  unsigned char buttons[15];
1803  float axes[6];
1805 
1806 
1807 /*************************************************************************
1808  * GLFW API functions
1809  *************************************************************************/
1810 
1843 GLFWAPI int glfwInit(void);
1844 
1875 GLFWAPI void glfwTerminate(void);
1876 
1907 GLFWAPI void glfwInitHint(int hint, int value);
1908 
1934 GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
1935 
1965 GLFWAPI const char* glfwGetVersionString(void);
1966 
1996 GLFWAPI int glfwGetError(const char** description);
1997 
2043 
2071 GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
2072 
2095 GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
2096 
2120 GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
2121 
2151 GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
2152 
2185 GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
2186 
2217 GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
2218 
2243 GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
2244 
2269 GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
2270 
2293 GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
2294 
2324 
2356 GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
2357 
2384 GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
2385 
2417 GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
2418 
2447 GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
2448 
2488 GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
2489 
2507 GLFWAPI void glfwDefaultWindowHints(void);
2508 
2542 GLFWAPI void glfwWindowHint(int hint, int value);
2543 
2580 GLFWAPI void glfwWindowHintString(int hint, const char* value);
2581 
2733 GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
2734 
2762 GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
2763 
2782 GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
2783 
2804 GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
2805 
2829 GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
2830 
2876 GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);
2877 
2908 GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
2909 
2943 GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
2944 
2973 GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
2974 
3016 GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);
3017 
3059 GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);
3060 
3100 GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
3101 
3129 GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
3130 
3166 GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
3167 
3199 GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);
3200 
3226 GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);
3227 
3255 GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
3256 
3286 GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
3287 
3313 GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
3314 
3338 GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);
3339 
3365 GLFWAPI void glfwShowWindow(GLFWwindow* window);
3366 
3387 GLFWAPI void glfwHideWindow(GLFWwindow* window);
3388 
3426 GLFWAPI void glfwFocusWindow(GLFWwindow* window);
3427 
3453 GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);
3454 
3475 GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
3476 
3534 GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);
3535 
3568 GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
3569 
3605 GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);
3606 
3628 GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
3629 
3649 GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
3650 
3685 
3717 
3757 
3793 
3828 
3858 
3888 
3918 
3949 
3986 GLFWAPI void glfwPollEvents(void);
3987 
4031 GLFWAPI void glfwWaitEvents(void);
4032 
4080 GLFWAPI void glfwWaitEventsTimeout(double timeout);
4081 
4100 GLFWAPI void glfwPostEmptyEvent(void);
4101 
4125 GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
4126 
4187 GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
4188 
4216 GLFWAPI int glfwRawMouseMotionSupported(void);
4217 
4284 GLFWAPI const char* glfwGetKeyName(int key, int scancode);
4285 
4308 GLFWAPI int glfwGetKeyScancode(int key);
4309 
4348 GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
4349 
4377 GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
4378 
4415 GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
4416 
4455 GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
4456 
4493 GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
4494 
4541 GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
4542 
4568 GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
4569 
4595 GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
4596 
4645 GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);
4646 
4688 GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);
4689 
4731 
4768 
4800 
4831 
4864 GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);
4865 
4901 GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);
4902 
4925 GLFWAPI int glfwJoystickPresent(int jid);
4926 
4958 GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);
4959 
4999 GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);
5000 
5056 GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);
5057 
5087 GLFWAPI const char* glfwGetJoystickName(int jid);
5088 
5128 GLFWAPI const char* glfwGetJoystickGUID(int jid);
5129 
5154 GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);
5155 
5178 GLFWAPI void* glfwGetJoystickUserPointer(int jid);
5179 
5206 GLFWAPI int glfwJoystickIsGamepad(int jid);
5207 
5243 
5276 GLFWAPI int glfwUpdateGamepadMappings(const char* string);
5277 
5306 GLFWAPI const char* glfwGetGamepadName(int jid);
5307 
5344 GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);
5345 
5369 GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
5370 
5399 GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
5400 
5429 GLFWAPI double glfwGetTime(void);
5430 
5459 GLFWAPI void glfwSetTime(double time);
5460 
5481 GLFWAPI uint64_t glfwGetTimerValue(void);
5482 
5501 GLFWAPI uint64_t glfwGetTimerFrequency(void);
5502 
5539 GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
5540 
5560 GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
5561 
5594 GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
5595 
5640 GLFWAPI void glfwSwapInterval(int interval);
5641 
5678 GLFWAPI int glfwExtensionSupported(const char* extension);
5679 
5720 GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);
5721 
5748 GLFWAPI int glfwVulkanSupported(void);
5749 
5795 GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);
5796 
5797 #if defined(VK_VERSION_1_0)
5798 
5838 GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);
5839 
5875 GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);
5876 
5936 GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);
5937 
5938 #endif /*VK_VERSION_1_0*/
5939 
5940 
5941 /*************************************************************************
5942  * Global definition cleanup
5943  *************************************************************************/
5944 
5945 /* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
5946 
5947 #ifdef GLFW_WINGDIAPI_DEFINED
5948  #undef WINGDIAPI
5949  #undef GLFW_WINGDIAPI_DEFINED
5950 #endif
5951 
5952 #ifdef GLFW_CALLBACK_DEFINED
5953  #undef CALLBACK
5954  #undef GLFW_CALLBACK_DEFINED
5955 #endif
5956 
5957 /* Some OpenGL related headers need GLAPIENTRY, but it is unconditionally
5958  * defined by some gl.h variants (OpenBSD) so define it after if needed.
5959  */
5960 #ifndef GLAPIENTRY
5961  #define GLAPIENTRY APIENTRY
5962 #endif
5963 
5964 /* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
5965 
5966 
5967 #ifdef __cplusplus
5968 }
5969 #endif
5970 
5971 #endif /* _glfw3_h_ */
5972 
glfwGetJoystickUserPointer
void * glfwGetJoystickUserPointer(int jid)
Returns the user pointer of the specified joystick.
glfwGetGamepadState
int glfwGetGamepadState(int jid, GLFWgamepadstate *state)
Retrieves the state of the specified joystick remapped as a gamepad.
glfwGetError
int glfwGetError(const char **description)
Returns and clears the last error for the calling thread.
glfwSetFramebufferSizeCallback
GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow *window, GLFWframebuffersizefun callback)
Sets the framebuffer resize callback for the specified window.
glfwSetWindowSize
void glfwSetWindowSize(GLFWwindow *window, int width, int height)
Sets the size of the content area of the specified window.
GLFWwindowrefreshfun
void(* GLFWwindowrefreshfun)(GLFWwindow *)
The function pointer type for window content refresh callbacks.
Definition: glfw3.h:1351
GLFWmousebuttonfun
void(* GLFWmousebuttonfun)(GLFWwindow *, int, int, int)
The function pointer type for mouse button callbacks.
Definition: glfw3.h:1482
GLFWgammaramp
struct GLFWgammaramp GLFWgammaramp
Gamma ramp.
GLFWimage
struct GLFWimage GLFWimage
Image data.
glfwGetTime
double glfwGetTime(void)
Returns the GLFW time.
glfwSetWindowPos
void glfwSetWindowPos(GLFWwindow *window, int xpos, int ypos)
Sets the position of the content area of the specified window.
glfwSetCursorPos
void glfwSetCursorPos(GLFWwindow *window, double xpos, double ypos)
Sets the position of the cursor, relative to the content area of the window.
glfwUpdateGamepadMappings
int glfwUpdateGamepadMappings(const char *string)
Adds the specified SDL_GameControllerDB gamepad mappings.
glfwGetJoystickName
const char * glfwGetJoystickName(int jid)
Returns the name of the specified joystick.
GLFWcursorposfun
void(* GLFWcursorposfun)(GLFWwindow *, double, double)
The function pointer type for cursor position callbacks.
Definition: glfw3.h:1505
glfwSetWindowAttrib
void glfwSetWindowAttrib(GLFWwindow *window, int attrib, int value)
Sets an attribute of the specified window.
glfwRestoreWindow
void glfwRestoreWindow(GLFWwindow *window)
Restores the specified window.
glfwGetMouseButton
int glfwGetMouseButton(GLFWwindow *window, int button)
Returns the last reported state of a mouse button for the specified window.
glfwGetKeyScancode
int glfwGetKeyScancode(int key)
Returns the platform-specific scancode of the specified key.
glfwGetMonitorContentScale
void glfwGetMonitorContentScale(GLFWmonitor *monitor, float *xscale, float *yscale)
Retrieves the content scale for the specified monitor.
GLFWcharmodsfun
void(* GLFWcharmodsfun)(GLFWwindow *, unsigned int, int)
The function pointer type for Unicode character with modifiers callbacks.
Definition: glfw3.h:1621
glfwCreateCursor
GLFWcursor * glfwCreateCursor(const GLFWimage *image, int xhot, int yhot)
Creates a custom cursor.
glfwGetWindowContentScale
void glfwGetWindowContentScale(GLFWwindow *window, float *xscale, float *yscale)
Retrieves the content scale for the specified window.
glfwGetKeyName
const char * glfwGetKeyName(int key, int scancode)
Returns the layout-specific name of the specified printable key.
glfwSetWindowRefreshCallback
GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow *window, GLFWwindowrefreshfun callback)
Sets the refresh callback for the specified window.
glfwSetMonitorCallback
GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback)
Sets the monitor configuration callback.
GLFWimage::height
int height
Definition: glfw3.h:1772
GLFWgammaramp
Gamma ramp.
Definition: glfw3.h:1736
glfwSetInputMode
void glfwSetInputMode(GLFWwindow *window, int mode, int value)
Sets an input option for the specified window.
GLFWerrorfun
void(* GLFWerrorfun)(int, const char *)
The function pointer type for error callbacks.
Definition: glfw3.h:1266
GLFWkeyfun
void(* GLFWkeyfun)(GLFWwindow *, int, int, int, int)
The function pointer type for keyboard key callbacks.
Definition: glfw3.h:1573
glfwSetWindowSizeCallback
GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow *window, GLFWwindowsizefun callback)
Sets the size callback for the specified window.
GLFWwindowmaximizefun
void(* GLFWwindowmaximizefun)(GLFWwindow *, int)
The function pointer type for window maximize callbacks.
Definition: glfw3.h:1414
glfwGetCurrentContext
GLFWwindow * glfwGetCurrentContext(void)
Returns the window whose context is current on the calling thread.
glfwSetWindowMonitor
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.
glfwGetWindowPos
void glfwGetWindowPos(GLFWwindow *window, int *xpos, int *ypos)
Retrieves the position of the content area of the specified window.
glfwSetWindowMaximizeCallback
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow *window, GLFWwindowmaximizefun callback)
Sets the maximize callback for the specified window.
GLFWcursorenterfun
void(* GLFWcursorenterfun)(GLFWwindow *, int)
The function pointer type for cursor enter/leave callbacks.
Definition: glfw3.h:1526
GLFWvkproc
void(* GLFWvkproc)(void)
Vulkan API function pointer type.
Definition: glfw3.h:1206
glfwGetInputMode
int glfwGetInputMode(GLFWwindow *window, int mode)
Returns the value of an input option for the specified window.
glfwSetWindowTitle
void glfwSetWindowTitle(GLFWwindow *window, const char *title)
Sets the title of the specified window.
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1230
glfwGetMonitorWorkarea
void glfwGetMonitorWorkarea(GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height)
Retrieves the work area of the monitor.
glfwSetJoystickUserPointer
void glfwSetJoystickUserPointer(int jid, void *pointer)
Sets the user pointer of the specified joystick.
glfwTerminate
void glfwTerminate(void)
Terminates the GLFW library.
glfwExtensionSupported
int glfwExtensionSupported(const char *extension)
Returns whether the specified extension is available.
glfwSetMouseButtonCallback
GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow *window, GLFWmousebuttonfun callback)
Sets the mouse button callback.
glfwSwapBuffers
void glfwSwapBuffers(GLFWwindow *window)
Swaps the front and back buffers of the specified window.
glfwMakeContextCurrent
void glfwMakeContextCurrent(GLFWwindow *window)
Makes the context of the specified window current for the calling thread.
glfwSwapInterval
void glfwSwapInterval(int interval)
Sets the swap interval for the current context.
glfwGetJoystickHats
const unsigned char * glfwGetJoystickHats(int jid, int *count)
Returns the state of all hats of the specified joystick.
GLFWvidmode::blueBits
int blueBits
Definition: glfw3.h:1718
glfwGetWindowFrameSize
void glfwGetWindowFrameSize(GLFWwindow *window, int *left, int *top, int *right, int *bottom)
Retrieves the size of the frame of the window.
glfwGetGamepadName
const char * glfwGetGamepadName(int jid)
Returns the human-readable gamepad name for the specified joystick.
glfwWindowShouldClose
int glfwWindowShouldClose(GLFWwindow *window)
Checks the close flag of the specified window.
glfwSetTime
void glfwSetTime(double time)
Sets the GLFW time.
glfwSetGammaRamp
void glfwSetGammaRamp(GLFWmonitor *monitor, const GLFWgammaramp *ramp)
Sets the current gamma ramp for the specified monitor.
glfwGetCursorPos
void glfwGetCursorPos(GLFWwindow *window, double *xpos, double *ypos)
Retrieves the position of the cursor relative to the content area of the window.
glfwInitHint
void glfwInitHint(int hint, int value)
Sets the specified init hint to the desired value.
glfwJoystickIsGamepad
int glfwJoystickIsGamepad(int jid)
Returns whether the specified joystick has a gamepad mapping.
glfwPollEvents
void glfwPollEvents(void)
Processes all pending events.
glfwWaitEvents
void glfwWaitEvents(void)
Waits until events are queued and processes them.
glfwDestroyCursor
void glfwDestroyCursor(GLFWcursor *cursor)
Destroys a cursor.
glfwGetJoystickButtons
const unsigned char * glfwGetJoystickButtons(int jid, int *count)
Returns the state of all buttons of the specified joystick.
GLFWscrollfun
void(* GLFWscrollfun)(GLFWwindow *, double, double)
The function pointer type for scroll callbacks.
Definition: glfw3.h:1547
glfwGetMonitorName
const char * glfwGetMonitorName(GLFWmonitor *monitor)
Returns the name of the specified monitor.
glfwSetCharCallback
GLFWcharfun glfwSetCharCallback(GLFWwindow *window, GLFWcharfun callback)
Sets the Unicode character callback.
glfwSetWindowSizeLimits
void glfwSetWindowSizeLimits(GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
Sets the size limits of the specified window.
glfwGetPrimaryMonitor
GLFWmonitor * glfwGetPrimaryMonitor(void)
Returns the primary monitor.
GLFWmonitorfun
void(* GLFWmonitorfun)(GLFWmonitor *, int)
The function pointer type for monitor configuration callbacks.
Definition: glfw3.h:1666
GLFWjoystickfun
void(* GLFWjoystickfun)(int, int)
The function pointer type for joystick configuration callbacks.
Definition: glfw3.h:1687
glfwGetJoystickGUID
const char * glfwGetJoystickGUID(int jid)
Returns the SDL compatible GUID of the specified joystick.
glfwSetWindowFocusCallback
GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow *window, GLFWwindowfocusfun callback)
Sets the focus callback for the specified window.
glfwGetRequiredInstanceExtensions
const char ** glfwGetRequiredInstanceExtensions(uint32_t *count)
Returns the Vulkan instance extensions required by GLFW.
glfwSetWindowCloseCallback
GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow *window, GLFWwindowclosefun callback)
Sets the close callback for the specified window.
glfwFocusWindow
void glfwFocusWindow(GLFWwindow *window)
Brings the specified window to front and sets input focus.
GLFWglproc
void(* GLFWglproc)(void)
Client API function pointer type.
Definition: glfw3.h:1192
glfwGetClipboardString
const char * glfwGetClipboardString(GLFWwindow *window)
Returns the contents of the clipboard as a string.
GLFWvidmode::height
int height
Definition: glfw3.h:1709
glfwSetWindowContentScaleCallback
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow *window, GLFWwindowcontentscalefun callback)
Sets the window content scale callback for the specified window.
glfwSetWindowPosCallback
GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow *window, GLFWwindowposfun callback)
Sets the position callback for the specified window.
glfwSetCursorEnterCallback
GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow *window, GLFWcursorenterfun callback)
Sets the cursor enter/leave callback.
glfwSetCursor
void glfwSetCursor(GLFWwindow *window, GLFWcursor *cursor)
Sets the cursor for the window.
GLFWframebuffersizefun
void(* GLFWframebuffersizefun)(GLFWwindow *, int, int)
The function pointer type for framebuffer size callbacks.
Definition: glfw3.h:1435
glfwGetMonitors
GLFWmonitor ** glfwGetMonitors(int *count)
Returns the currently connected monitors.
glfwRawMouseMotionSupported
int glfwRawMouseMotionSupported(void)
Returns whether raw mouse motion is supported.
glfwSetMonitorUserPointer
void glfwSetMonitorUserPointer(GLFWmonitor *monitor, void *pointer)
Sets the user pointer of the specified monitor.
GLFWimage::pixels
unsigned char * pixels
Definition: glfw3.h:1775
glfwGetVideoModes
const GLFWvidmode * glfwGetVideoModes(GLFWmonitor *monitor, int *count)
Returns the available video modes for the specified monitor.
glfwShowWindow
void glfwShowWindow(GLFWwindow *window)
Makes the specified window visible.
GLFWgammaramp::green
unsigned short * green
Definition: glfw3.h:1743
GLFWgamepadstate
struct GLFWgamepadstate GLFWgamepadstate
Gamepad input state.
glfwRequestWindowAttention
void glfwRequestWindowAttention(GLFWwindow *window)
Requests user attention to the specified window.
glfwJoystickPresent
int glfwJoystickPresent(int jid)
Returns whether the specified joystick is present.
GLFWgamepadstate::buttons
unsigned char buttons[15]
Definition: glfw3.h:1794
glfwVulkanSupported
int glfwVulkanSupported(void)
Returns whether the Vulkan loader and an ICD have been found.
glfwGetMonitorPos
void glfwGetMonitorPos(GLFWmonitor *monitor, int *xpos, int *ypos)
Returns the position of the monitor's viewport on the virtual screen.
glfwHideWindow
void glfwHideWindow(GLFWwindow *window)
Hides the specified window.
GLFWvidmode::width
int width
Definition: glfw3.h:1706
glfwMaximizeWindow
void glfwMaximizeWindow(GLFWwindow *window)
Maximizes the specified window.
GLFWgammaramp::size
unsigned int size
Definition: glfw3.h:1749
glfwCreateWindowSurface
VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
Creates a Vulkan surface for the specified window.
GLFWcharfun
void(* GLFWcharfun)(GLFWwindow *, unsigned int)
The function pointer type for Unicode character callbacks.
Definition: glfw3.h:1594
GLFWwindowcontentscalefun
void(* GLFWwindowcontentscalefun)(GLFWwindow *, float, float)
The function pointer type for window content scale callbacks.
Definition: glfw3.h:1456
glfwGetTimerValue
uint64_t glfwGetTimerValue(void)
Returns the current value of the raw timer.
GLFWgammaramp::red
unsigned short * red
Definition: glfw3.h:1740
glfwDefaultWindowHints
void glfwDefaultWindowHints(void)
Resets all window hints to their default values.
glfwSetCursorPosCallback
GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow *window, GLFWcursorposfun callback)
Sets the cursor position callback.
glfwGetTimerFrequency
uint64_t glfwGetTimerFrequency(void)
Returns the frequency, in Hz, of the raw timer.
glfwSetWindowIcon
void glfwSetWindowIcon(GLFWwindow *window, int count, const GLFWimage *images)
Sets the icon for the specified window.
GLFWimage::width
int width
Definition: glfw3.h:1769
glfwCreateWindow
GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
Creates a window and its associated context.
glfwSetCharModsCallback
GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow *window, GLFWcharmodsfun callback)
Sets the Unicode character with modifiers callback.
glfwSetWindowShouldClose
void glfwSetWindowShouldClose(GLFWwindow *window, int value)
Sets the close flag of the specified window.
glfwSetWindowAspectRatio
void glfwSetWindowAspectRatio(GLFWwindow *window, int numer, int denom)
Sets the aspect ratio of the specified window.
glfwGetMonitorUserPointer
void * glfwGetMonitorUserPointer(GLFWmonitor *monitor)
Returns the user pointer of the specified monitor.
glfwWaitEventsTimeout
void glfwWaitEventsTimeout(double timeout)
Waits with timeout until events are queued and processes them.
GLFWvidmode::greenBits
int greenBits
Definition: glfw3.h:1715
glfwGetMonitorPhysicalSize
void glfwGetMonitorPhysicalSize(GLFWmonitor *monitor, int *widthMM, int *heightMM)
Returns the physical size of the monitor.
glfwSetJoystickCallback
GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback)
Sets the joystick configuration callback.
GLFWwindowiconifyfun
void(* GLFWwindowiconifyfun)(GLFWwindow *, int)
The function pointer type for window iconify callbacks.
Definition: glfw3.h:1393
GLFWgamepadstate
Gamepad input state.
Definition: glfw3.h:1789
GLFWvidmode
struct GLFWvidmode GLFWvidmode
Video mode type.
GLFWdropfun
void(* GLFWdropfun)(GLFWwindow *, int, const char *[])
The function pointer type for path drop callbacks.
Definition: glfw3.h:1645
GLFWcursor
struct GLFWcursor GLFWcursor
Opaque cursor object.
Definition: glfw3.h:1242
glfwCreateStandardCursor
GLFWcursor * glfwCreateStandardCursor(int shape)
Creates a cursor with a standard shape.
glfwInit
int glfwInit(void)
Initializes the GLFW library.
GLFWgamepadstate::axes
float axes[6]
Definition: glfw3.h:1798
glfwWindowHintString
void glfwWindowHintString(int hint, const char *value)
Sets the specified window hint to the desired value.
glfwGetWindowOpacity
float glfwGetWindowOpacity(GLFWwindow *window)
Returns the opacity of the whole window.
GLFWimage
Image data.
Definition: glfw3.h:1765
glfwSetWindowOpacity
void glfwSetWindowOpacity(GLFWwindow *window, float opacity)
Sets the opacity of the whole window.
glfwGetProcAddress
GLFWglproc glfwGetProcAddress(const char *procname)
Returns the address of the specified function for the current context.
glfwGetGammaRamp
const GLFWgammaramp * glfwGetGammaRamp(GLFWmonitor *monitor)
Returns the current gamma ramp for the specified monitor.
glfwSetDropCallback
GLFWdropfun glfwSetDropCallback(GLFWwindow *window, GLFWdropfun callback)
Sets the path drop callback.
GLFWwindowsizefun
void(* GLFWwindowsizefun)(GLFWwindow *, int, int)
The function pointer type for window size callbacks.
Definition: glfw3.h:1311
GLFWgammaramp::blue
unsigned short * blue
Definition: glfw3.h:1746
glfwGetWindowMonitor
GLFWmonitor * glfwGetWindowMonitor(GLFWwindow *window)
Returns the monitor that the window uses for full screen mode.
glfwSetKeyCallback
GLFWkeyfun glfwSetKeyCallback(GLFWwindow *window, GLFWkeyfun callback)
Sets the key callback.
glfwIconifyWindow
void glfwIconifyWindow(GLFWwindow *window)
Iconifies the specified window.
glfwGetVersionString
const char * glfwGetVersionString(void)
Returns a string describing the compile-time configuration.
glfwSetWindowUserPointer
void glfwSetWindowUserPointer(GLFWwindow *window, void *pointer)
Sets the user pointer of the specified window.
glfwPostEmptyEvent
void glfwPostEmptyEvent(void)
Posts an empty event to the event queue.
glfwGetWindowAttrib
int glfwGetWindowAttrib(GLFWwindow *window, int attrib)
Returns an attribute of the specified window.
GLFWwindowfocusfun
void(* GLFWwindowfocusfun)(GLFWwindow *, int)
The function pointer type for window focus callbacks.
Definition: glfw3.h:1372
glfwSetWindowIconifyCallback
GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow *window, GLFWwindowiconifyfun callback)
Sets the iconify callback for the specified window.
glfwSetScrollCallback
GLFWscrollfun glfwSetScrollCallback(GLFWwindow *window, GLFWscrollfun callback)
Sets the scroll callback.
glfwGetKey
int glfwGetKey(GLFWwindow *window, int key)
Returns the last reported state of a keyboard key for the specified window.
glfwGetWindowSize
void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the content area of the specified window.
glfwGetJoystickAxes
const float * glfwGetJoystickAxes(int jid, int *count)
Returns the values of all axes of the specified joystick.
GLFWvidmode
Video mode type.
Definition: glfw3.h:1702
glfwSetErrorCallback
GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback)
Sets the error callback.
glfwGetFramebufferSize
void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the framebuffer of the specified window.
GLFWwindowclosefun
void(* GLFWwindowclosefun)(GLFWwindow *)
The function pointer type for window close callbacks.
Definition: glfw3.h:1331
GLFWvidmode::redBits
int redBits
Definition: glfw3.h:1712
glfwWindowHint
void glfwWindowHint(int hint, int value)
Sets the specified window hint to the desired value.
glfwGetVersion
void glfwGetVersion(int *major, int *minor, int *rev)
Retrieves the version of the GLFW library.
glfwGetPhysicalDevicePresentationSupport
int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
Returns whether the specified queue family can present images.
glfwSetGamma
void glfwSetGamma(GLFWmonitor *monitor, float gamma)
Generates a gamma ramp and sets it for the specified monitor.
GLFWwindowposfun
void(* GLFWwindowposfun)(GLFWwindow *, int, int)
The function pointer type for window position callbacks.
Definition: glfw3.h:1289
glfwGetVideoMode
const GLFWvidmode * glfwGetVideoMode(GLFWmonitor *monitor)
Returns the current mode of the specified monitor.
glfwSetClipboardString
void glfwSetClipboardString(GLFWwindow *window, const char *string)
Sets the clipboard to the specified string.
glfwDestroyWindow
void glfwDestroyWindow(GLFWwindow *window)
Destroys the specified window and its context.
GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1218
GLFWvidmode::refreshRate
int refreshRate
Definition: glfw3.h:1721
glfwGetWindowUserPointer
void * glfwGetWindowUserPointer(GLFWwindow *window)
Returns the user pointer of the specified window.
glfwGetInstanceProcAddress
GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char *procname)
Returns the address of the specified Vulkan instance function.