GLFW: glfw3.h Source File

GLFW

- Documentation
- Download
- Community

glfw3.h
Go to the documentation of this file.
1 /*************************************************************************
2 * GLFW 3.3 - 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 3
267
273 #define GLFW_VERSION_REVISION 2
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
769 #define GLFW_FOCUSED 0x00020001
770
774 #define GLFW_ICONIFIED 0x00020002
775
780 #define GLFW_RESIZABLE 0x00020003
781
786 #define GLFW_VISIBLE 0x00020004
787
792 #define GLFW_DECORATED 0x00020005
793
798 #define GLFW_AUTO_ICONIFY 0x00020006
799
804 #define GLFW_FLOATING 0x00020007
805
810 #define GLFW_MAXIMIZED 0x00020008
811
815 #define GLFW_CENTER_CURSOR 0x00020009
816
822 #define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A
823
827 #define GLFW_HOVERED 0x0002000B
828
833 #define GLFW_FOCUS_ON_SHOW 0x0002000C
834
839 #define GLFW_RED_BITS 0x00021001
840
844 #define GLFW_GREEN_BITS 0x00021002
845
849 #define GLFW_BLUE_BITS 0x00021003
850
854 #define GLFW_ALPHA_BITS 0x00021004
855
859 #define GLFW_DEPTH_BITS 0x00021005
860
864 #define GLFW_STENCIL_BITS 0x00021006
865
869 #define GLFW_ACCUM_RED_BITS 0x00021007
870
874 #define GLFW_ACCUM_GREEN_BITS 0x00021008
875
879 #define GLFW_ACCUM_BLUE_BITS 0x00021009
880
884 #define GLFW_ACCUM_ALPHA_BITS 0x0002100A
885
889 #define GLFW_AUX_BUFFERS 0x0002100B
890
894 #define GLFW_STEREO 0x0002100C
895
899 #define GLFW_SAMPLES 0x0002100D
900
904 #define GLFW_SRGB_CAPABLE 0x0002100E
905
909 #define GLFW_REFRESH_RATE 0x0002100F
910
914 #define GLFW_DOUBLEBUFFER 0x00021010
915
921 #define GLFW_CLIENT_API 0x00022001
922
927 #define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
928
933 #define GLFW_CONTEXT_VERSION_MINOR 0x00022003
934
939 #define GLFW_CONTEXT_REVISION 0x00022004
940
945 #define GLFW_CONTEXT_ROBUSTNESS 0x00022005
946
951 #define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
952
957 #define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
958
963 #define GLFW_OPENGL_PROFILE 0x00022008
964
969 #define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
970
975 #define GLFW_CONTEXT_NO_ERROR 0x0002200A
976
981 #define GLFW_CONTEXT_CREATION_API 0x0002200B
982
985 #define GLFW_SCALE_TO_MONITOR 0x0002200C
986
989 #define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
990
993 #define GLFW_COCOA_FRAME_NAME 0x00023002
994
997 #define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
998
1001 #define GLFW_X11_CLASS_NAME 0x00024001
1002
1005 #define GLFW_X11_INSTANCE_NAME 0x00024002
1006
1008 #define GLFW_NO_API 0
1009 #define GLFW_OPENGL_API 0x00030001
1010 #define GLFW_OPENGL_ES_API 0x00030002
1011
1012 #define GLFW_NO_ROBUSTNESS 0
1013 #define GLFW_NO_RESET_NOTIFICATION 0x00031001
1014 #define GLFW_LOSE_CONTEXT_ON_RESET 0x00031002
1015
1016 #define GLFW_OPENGL_ANY_PROFILE 0
1017 #define GLFW_OPENGL_CORE_PROFILE 0x00032001
1018 #define GLFW_OPENGL_COMPAT_PROFILE 0x00032002
1019
1020 #define GLFW_CURSOR 0x00033001
1021 #define GLFW_STICKY_KEYS 0x00033002
1022 #define GLFW_STICKY_MOUSE_BUTTONS 0x00033003
1023 #define GLFW_LOCK_KEY_MODS 0x00033004
1024 #define GLFW_RAW_MOUSE_MOTION 0x00033005
1025
1026 #define GLFW_CURSOR_NORMAL 0x00034001
1027 #define GLFW_CURSOR_HIDDEN 0x00034002
1028 #define GLFW_CURSOR_DISABLED 0x00034003
1029
1030 #define GLFW_ANY_RELEASE_BEHAVIOR 0
1031 #define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001
1032 #define GLFW_RELEASE_BEHAVIOR_NONE 0x00035002
1033
1034 #define GLFW_NATIVE_CONTEXT_API 0x00036001
1035 #define GLFW_EGL_CONTEXT_API 0x00036002
1036 #define GLFW_OSMESA_CONTEXT_API 0x00036003
1037
1050 #define GLFW_ARROW_CURSOR 0x00036001
1051
1055 #define GLFW_IBEAM_CURSOR 0x00036002
1056
1060 #define GLFW_CROSSHAIR_CURSOR 0x00036003
1061
1065 #define GLFW_HAND_CURSOR 0x00036004
1066
1070 #define GLFW_HRESIZE_CURSOR 0x00036005
1071
1075 #define GLFW_VRESIZE_CURSOR 0x00036006
1076
1078 #define GLFW_CONNECTED 0x00040001
1079 #define GLFW_DISCONNECTED 0x00040002
1080
1087 #define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001
1088
1092 #define GLFW_COCOA_CHDIR_RESOURCES 0x00051001
1093
1097 #define GLFW_COCOA_MENUBAR 0x00051002
1098
1100 #define GLFW_DONT_CARE -1
1101
1102
1103 /*************************************************************************
1104 * GLFW API types
1105 *************************************************************************/
1106
1119 typedef void (*GLFWglproc)(void);
1120
1133 typedef void (*GLFWvkproc)(void);
1134
1145 typedef struct GLFWmonitor GLFWmonitor;
1146
1157 typedef struct GLFWwindow GLFWwindow;
1158
1169 typedef struct GLFWcursor GLFWcursor;
1170
1193 typedef void (* GLFWerrorfun)(int,const char*);
1194
1216 typedef void (* GLFWwindowposfun)(GLFWwindow*,int,int);
1217
1238 typedef void (* GLFWwindowsizefun)(GLFWwindow*,int,int);
1239
1258 typedef void (* GLFWwindowclosefun)(GLFWwindow*);
1259
1278 typedef void (* GLFWwindowrefreshfun)(GLFWwindow*);
1279
1299 typedef void (* GLFWwindowfocusfun)(GLFWwindow*,int);
1300
1320 typedef void (* GLFWwindowiconifyfun)(GLFWwindow*,int);
1321
1341 typedef void (* GLFWwindowmaximizefun)(GLFWwindow*,int);
1342
1362 typedef void (* GLFWframebuffersizefun)(GLFWwindow*,int,int);
1363
1383 typedef void (* GLFWwindowcontentscalefun)(GLFWwindow*,float,float);
1384
1409 typedef void (* GLFWmousebuttonfun)(GLFWwindow*,int,int,int);
1410
1432 typedef void (* GLFWcursorposfun)(GLFWwindow*,double,double);
1433
1453 typedef void (* GLFWcursorenterfun)(GLFWwindow*,int);
1454
1474 typedef void (* GLFWscrollfun)(GLFWwindow*,double,double);
1475
1500 typedef void (* GLFWkeyfun)(GLFWwindow*,int,int,int,int);
1501
1521 typedef void (* GLFWcharfun)(GLFWwindow*,unsigned int);
1522
1548 typedef void (* GLFWcharmodsfun)(GLFWwindow*,unsigned int,int);
1549
1572 typedef void (* GLFWdropfun)(GLFWwindow*,int,const char*[]);
1573
1593 typedef void (* GLFWmonitorfun)(GLFWmonitor*,int);
1594
1614 typedef void (* GLFWjoystickfun)(int,int);
1615
1629 typedef struct GLFWvidmode
1630 {
1633 int width;
1636 int height;
1639 int redBits;
1642 int greenBits;
1645 int blueBits;
1648 int refreshRate;
1649 } GLFWvidmode;
1650
1663 typedef struct GLFWgammaramp
1664 {
1667 unsigned short* red;
1670 unsigned short* green;
1673 unsigned short* blue;
1676 unsigned int size;
1677 } GLFWgammaramp;
1678
1692 typedef struct GLFWimage
1693 {
1696 int width;
1699 int height;
1702 unsigned char* pixels;
1703 } GLFWimage;
1704
1716 typedef struct GLFWgamepadstate
1717 {
1721 unsigned char buttons[15];
1725 float axes[6];
1726 } GLFWgamepadstate;
1727
1728
1729 /*************************************************************************
1730 * GLFW API functions
1731 *************************************************************************/
1732
1765 GLFWAPI int glfwInit(void);
1766
1797 GLFWAPI void glfwTerminate(void);
1798
1829 GLFWAPI void glfwInitHint(int hint, int value);
1830
1856 GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
1857
1887 GLFWAPI const char* glfwGetVersionString(void);
1888
1918 GLFWAPI int glfwGetError(const char** description);
1919
1964 GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback);
1965
1993 GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
1994
2017 GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
2018
2042 GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
2043
2073 GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
2074
2107 GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
2108
2139 GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
2140
2165 GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
2166
2191 GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
2192
2215 GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
2216
2245 GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback);
2246
2278 GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
2279
2306 GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
2307
2339 GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
2340
2369 GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
2370
2410 GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
2411
2429 GLFWAPI void glfwDefaultWindowHints(void);
2430
2464 GLFWAPI void glfwWindowHint(int hint, int value);
2465
2502 GLFWAPI void glfwWindowHintString(int hint, const char* value);
2503
2656 GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
2657
2685 GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
2686
2705 GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
2706
2727 GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
2728
2752 GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
2753
2799 GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);
2800
2831 GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
2832
2866 GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
2867
2896 GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
2897
2939 GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);
2940
2982 GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);
2983
3023 GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
3024
3052 GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
3053
3089 GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
3090
3122 GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);
3123
3149 GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);
3150
3178 GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
3179
3209 GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
3210
3236 GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
3237
3261 GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);
3262
3288 GLFWAPI void glfwShowWindow(GLFWwindow* window);
3289
3310 GLFWAPI void glfwHideWindow(GLFWwindow* window);
3311
3349 GLFWAPI void glfwFocusWindow(GLFWwindow* window);
3350
3376 GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);
3377
3398 GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
3399
3457 GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);
3458
3491 GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
3492
3528 GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);
3529
3551 GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
3552
3572 GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
3573
3607 GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun callback);
3608
3639 GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun callback);
3640
3679 GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);
3680
3715 GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);
3716
3750 GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);
3751
3783 GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);
3784
3813 GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);
3814
3843 GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);
3844
3874 GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);
3875
3912 GLFWAPI void glfwPollEvents(void);
3913
3957 GLFWAPI void glfwWaitEvents(void);
3958
4006 GLFWAPI void glfwWaitEventsTimeout(double timeout);
4007
4026 GLFWAPI void glfwPostEmptyEvent(void);
4027
4051 GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
4052
4113 GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
4114
4142 GLFWAPI int glfwRawMouseMotionSupported(void);
4143
4210 GLFWAPI const char* glfwGetKeyName(int key, int scancode);
4211
4234 GLFWAPI int glfwGetKeyScancode(int key);
4235
4274 GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
4275
4303 GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
4304
4341 GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
4342
4381 GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
4382
4419 GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
4420
4442 GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
4443
4469 GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
4470
4496 GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
4497
4546 GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);
4547
4589 GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);
4590
4631 GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun callback);
4632
4668 GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun callback);
4669
4700 GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun callback);
4701
4731 GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun callback);
4732
4765 GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);
4766
4802 GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);
4803
4826 GLFWAPI int glfwJoystickPresent(int jid);
4827
4859 GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);
4860
4900 GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);
4901
4957 GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);
4958
4988 GLFWAPI const char* glfwGetJoystickName(int jid);
4989
5029 GLFWAPI const char* glfwGetJoystickGUID(int jid);
5030
5055 GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);
5056
5079 GLFWAPI void* glfwGetJoystickUserPointer(int jid);
5080
5107 GLFWAPI int glfwJoystickIsGamepad(int jid);
5108
5143 GLFWAPI GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback);
5144
5177 GLFWAPI int glfwUpdateGamepadMappings(const char* string);
5178
5207 GLFWAPI const char* glfwGetGamepadName(int jid);
5208
5245 GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);
5246
5270 GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
5271
5300 GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
5301
5330 GLFWAPI double glfwGetTime(void);
5331
5360 GLFWAPI void glfwSetTime(double time);
5361
5382 GLFWAPI uint64_t glfwGetTimerValue(void);
5383
5402 GLFWAPI uint64_t glfwGetTimerFrequency(void);
5403
5440 GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
5441
5461 GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
5462
5495 GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
5496
5541 GLFWAPI void glfwSwapInterval(int interval);
5542
5579 GLFWAPI int glfwExtensionSupported(const char* extension);
5580
5621 GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);
5622
5649 GLFWAPI int glfwVulkanSupported(void);
5650
5697 GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);
5698
5699 #if defined(VK_VERSION_1_0)
5700
5740 GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);
5741
5777 GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);
5778
5838 GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);
5839
5840 #endif /*VK_VERSION_1_0*/
5841
5842
5843 /*************************************************************************
5844 * Global definition cleanup
5845 *************************************************************************/
5846
5847 /* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
5848
5849 #ifdef GLFW_WINGDIAPI_DEFINED
5850 #undef WINGDIAPI
5851 #undef GLFW_WINGDIAPI_DEFINED
5852 #endif
5853
5854 #ifdef GLFW_CALLBACK_DEFINED
5855 #undef CALLBACK
5856 #undef GLFW_CALLBACK_DEFINED
5857 #endif
5858
5859 /* Some OpenGL related headers need GLAPIENTRY, but it is unconditionally
5860 * defined by some gl.h variants (OpenBSD) so define it after if needed.
5861 */
5862 #ifndef GLAPIENTRY
5863 #define GLAPIENTRY APIENTRY
5864 #endif
5865
5866 /* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
5867
5868
5869 #ifdef __cplusplus
5870 }
5871 #endif
5872
5873 #endif /* _glfw3_h_ */
5874
GLFWwindowclosefun
void(* GLFWwindowclosefun)(GLFWwindow *)
The function pointer type for window close callbacks.
Definition: glfw3.h:1258
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:1278
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.
glfwSetWindowAttrib
void glfwSetWindowAttrib(GLFWwindow *window, int attrib, int value)
Sets an attribute of the specified window.
GLFWvidmode
struct GLFWvidmode GLFWvidmode
Video mode type.
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.
GLFWmonitorfun
void(* GLFWmonitorfun)(GLFWmonitor *, int)
The function pointer type for monitor configuration callbacks.
Definition: glfw3.h:1593
glfwGetMonitorContentScale
void glfwGetMonitorContentScale(GLFWmonitor *monitor, float *xscale, float *yscale)
Retrieves the content scale for the specified monitor.
GLFWmousebuttonfun
void(* GLFWmousebuttonfun)(GLFWwindow *, int, int, int)
The function pointer type for mouse button callbacks.
Definition: glfw3.h:1409
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.
GLFWdropfun
void(* GLFWdropfun)(GLFWwindow *, int, const char *[])
The function pointer type for path drop callbacks.
Definition: glfw3.h:1572
GLFWimage
struct GLFWimage GLFWimage
Image data.
GLFWerrorfun
void(* GLFWerrorfun)(int, const char *)
The function pointer type for error callbacks.
Definition: glfw3.h:1193
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:1699
GLFWgammaramp
Gamma ramp.
Definition: glfw3.h:1663
glfwSetInputMode
void glfwSetInputMode(GLFWwindow *window, int mode, int value)
Sets an input option for the specified window.
GLFWkeyfun
void(* GLFWkeyfun)(GLFWwindow *, int, int, int, int)
The function pointer type for keyboard key callbacks.
Definition: glfw3.h:1500
glfwSetWindowSizeCallback
GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow *window, GLFWwindowsizefun callback)
Sets the size callback for the specified window.
GLFWgamepadstate
struct GLFWgamepadstate GLFWgamepadstate
Gamepad input state.
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.
GLFWvkproc
void(* GLFWvkproc)(void)
Vulkan API function pointer type.
Definition: glfw3.h:1133
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.
GLFWwindowiconifyfun
void(* GLFWwindowiconifyfun)(GLFWwindow *, int)
The function pointer type for window iconify callbacks.
Definition: glfw3.h:1320
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1157
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.
GLFWwindowsizefun
void(* GLFWwindowsizefun)(GLFWwindow *, int, int)
The function pointer type for window size callbacks.
Definition: glfw3.h:1238
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:1645
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.
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.
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.
GLFWscrollfun
void(* GLFWscrollfun)(GLFWwindow *, double, double)
The function pointer type for scroll callbacks.
Definition: glfw3.h:1474
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:1119
glfwGetClipboardString
const char * glfwGetClipboardString(GLFWwindow *window)
Returns the contents of the clipboard as a string.
GLFWvidmode::height
int height
Definition: glfw3.h:1636
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.
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:1702
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:1670
GLFWwindowmaximizefun
void(* GLFWwindowmaximizefun)(GLFWwindow *, int)
The function pointer type for window maximize callbacks.
Definition: glfw3.h:1341
GLFWframebuffersizefun
void(* GLFWframebuffersizefun)(GLFWwindow *, int, int)
The function pointer type for framebuffer size callbacks.
Definition: glfw3.h:1362
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:1721
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:1633
glfwMaximizeWindow
void glfwMaximizeWindow(GLFWwindow *window)
Maximizes the specified window.
GLFWgammaramp::size
unsigned int size
Definition: glfw3.h:1676
glfwCreateWindowSurface
VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
Creates a Vulkan surface for the specified window.
GLFWgammaramp
struct GLFWgammaramp GLFWgammaramp
Gamma ramp.
glfwGetTimerValue
uint64_t glfwGetTimerValue(void)
Returns the current value of the raw timer.
GLFWgammaramp::red
unsigned short * red
Definition: glfw3.h:1667
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.
GLFWwindowcontentscalefun
void(* GLFWwindowcontentscalefun)(GLFWwindow *, float, float)
The function pointer type for window content scale callbacks.
Definition: glfw3.h:1383
glfwSetWindowIcon
void glfwSetWindowIcon(GLFWwindow *window, int count, const GLFWimage *images)
Sets the icon for the specified window.
GLFWimage::width
int width
Definition: glfw3.h:1696
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.
GLFWwindowfocusfun
void(* GLFWwindowfocusfun)(GLFWwindow *, int)
The function pointer type for window focus callbacks.
Definition: glfw3.h:1299
glfwWaitEventsTimeout
void glfwWaitEventsTimeout(double timeout)
Waits with timeout until events are queued and processes them.
GLFWvidmode::greenBits
int greenBits
Definition: glfw3.h:1642
GLFWwindowposfun
void(* GLFWwindowposfun)(GLFWwindow *, int, int)
The function pointer type for window position callbacks.
Definition: glfw3.h:1216
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.
GLFWgamepadstate
Gamepad input state.
Definition: glfw3.h:1716
GLFWcursor
struct GLFWcursor GLFWcursor
Opaque cursor object.
Definition: glfw3.h:1169
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:1725
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:1692
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.
GLFWcharmodsfun
void(* GLFWcharmodsfun)(GLFWwindow *, unsigned int, int)
The function pointer type for Unicode character with modifiers callbacks.
Definition: glfw3.h:1548
GLFWcursorenterfun
void(* GLFWcursorenterfun)(GLFWwindow *, int)
The function pointer type for cursor enter/leave callbacks.
Definition: glfw3.h:1453
glfwSetDropCallback
GLFWdropfun glfwSetDropCallback(GLFWwindow *window, GLFWdropfun callback)
Sets the path drop callback.
GLFWgammaramp::blue
unsigned short * blue
Definition: glfw3.h:1673
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.
GLFWcharfun
void(* GLFWcharfun)(GLFWwindow *, unsigned int)
The function pointer type for Unicode character callbacks.
Definition: glfw3.h:1521
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.
GLFWjoystickfun
void(* GLFWjoystickfun)(int, int)
The function pointer type for joystick configuration callbacks.
Definition: glfw3.h:1614
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.
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.
GLFWcursorposfun
void(* GLFWcursorposfun)(GLFWwindow *, double, double)
The function pointer type for cursor position callbacks.
Definition: glfw3.h:1432
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:1629
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.
GLFWvidmode::redBits
int redBits
Definition: glfw3.h:1639
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.
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:1145
GLFWvidmode::refreshRate
int refreshRate
Definition: glfw3.h:1648
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.