The header of the GLFW 3 API. More...
Include dependency graph for glfw3.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | GLFWgamepadstate |
| Gamepad input state. More... | |
| struct | GLFWgammaramp |
| Gamma ramp. More... | |
| struct | GLFWimage |
| Image data. More... | |
| struct | GLFWvidmode |
| Video mode type. More... | |
Macros | |
| #define | APIENTRY |
| #define | GLAPIENTRY APIENTRY |
| #define | GLFW_ACCUM_ALPHA_BITS 0x0002100A |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_BLUE_BITS 0x00021009 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_GREEN_BITS 0x00021008 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ACCUM_RED_BITS 0x00021007 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ALPHA_BITS 0x00021004 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_ANY_RELEASE_BEHAVIOR 0 |
| #define | GLFW_API_UNAVAILABLE 0x00010006 |
| GLFW could not find support for the requested API on the system. More... | |
| #define | GLFW_APIENTRY_DEFINED |
| #define | GLFW_ARROW_CURSOR 0x00036001 |
| The regular arrow cursor shape. More... | |
| #define | GLFW_AUTO_ICONIFY 0x00020006 |
| Window auto-iconification window hint and attribute. More... | |
| #define | GLFW_AUX_BUFFERS 0x0002100B |
| Framebuffer auxiliary buffer hint. More... | |
| #define | GLFW_BLUE_BITS 0x00021003 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_CENTER_CURSOR 0x00020009 |
| Cursor centering window hint. More... | |
| #define | GLFW_CLIENT_API 0x00022001 |
| Context client API hint and attribute. More... | |
| #define | GLFW_COCOA_CHDIR_RESOURCES 0x00051001 |
| macOS specific init hint. More... | |
| #define | GLFW_COCOA_FRAME_NAME 0x00023002 |
| #define | GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003 |
| #define | GLFW_COCOA_MENUBAR 0x00051002 |
| macOS specific init hint. More... | |
| #define | GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001 |
| #define | GLFW_CONNECTED 0x00040001 |
| #define | GLFW_CONTEXT_CREATION_API 0x0002200B |
| Context creation API hint and attribute. More... | |
| #define | GLFW_CONTEXT_NO_ERROR 0x0002200A |
| Context error suppression hint and attribute. More... | |
| #define | GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009 |
| Context flush-on-release hint and attribute. More... | |
| #define | GLFW_CONTEXT_REVISION 0x00022004 |
| Context client API revision number hint and attribute. More... | |
| #define | GLFW_CONTEXT_ROBUSTNESS 0x00022005 |
| Context robustness hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MAJOR 0x00022002 |
| Context client API major version hint and attribute. More... | |
| #define | GLFW_CONTEXT_VERSION_MINOR 0x00022003 |
| Context client API minor version hint and attribute. More... | |
| #define | GLFW_CROSSHAIR_CURSOR 0x00036003 |
| The crosshair shape. More... | |
| #define | GLFW_CURSOR 0x00033001 |
| #define | GLFW_CURSOR_DISABLED 0x00034003 |
| #define | GLFW_CURSOR_HIDDEN 0x00034002 |
| #define | GLFW_CURSOR_NORMAL 0x00034001 |
| #define | GLFW_DECORATED 0x00020005 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_DEPTH_BITS 0x00021005 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_DISCONNECTED 0x00040002 |
| #define | GLFW_DONT_CARE -1 |
| #define | GLFW_DOUBLEBUFFER 0x00021010 |
| Framebuffer double buffering hint. More... | |
| #define | GLFW_EGL_CONTEXT_API 0x00036002 |
| #define | GLFW_FALSE 0 |
| Zero. More... | |
| #define | GLFW_FLOATING 0x00020007 |
| Window decoration window hint and attribute. More... | |
| #define | GLFW_FOCUS_ON_SHOW 0x0002000C |
| Input focus on calling show window hint and attribute. More... | |
| #define | GLFW_FOCUSED 0x00020001 |
| Input focus window hint and attribute. More... | |
| #define | GLFW_FORMAT_UNAVAILABLE 0x00010009 |
| The requested format is not supported or available. More... | |
| #define | GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER |
| #define | GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_X 0 |
| #define | GLFW_GAMEPAD_AXIS_LEFT_Y 1 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_X 2 |
| #define | GLFW_GAMEPAD_AXIS_RIGHT_Y 3 |
| #define | GLFW_GAMEPAD_BUTTON_A 0 |
| #define | GLFW_GAMEPAD_BUTTON_B 1 |
| #define | GLFW_GAMEPAD_BUTTON_BACK 6 |
| #define | GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B |
| #define | GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12 |
| #define | GLFW_GAMEPAD_BUTTON_DPAD_UP 11 |
| #define | GLFW_GAMEPAD_BUTTON_GUIDE 8 |
| #define | GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4 |
| #define | GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5 |
| #define | GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10 |
| #define | GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X |
| #define | GLFW_GAMEPAD_BUTTON_START 7 |
| #define | GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y |
| #define | GLFW_GAMEPAD_BUTTON_X 2 |
| #define | GLFW_GAMEPAD_BUTTON_Y 3 |
| #define | GLFW_GREEN_BITS 0x00021002 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_HAND_CURSOR 0x00036004 |
| The hand shape. More... | |
| #define | GLFW_HAT_CENTERED 0 |
| #define | GLFW_HAT_DOWN 4 |
| #define | GLFW_HAT_LEFT 8 |
| #define | GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN) |
| #define | GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP) |
| #define | GLFW_HAT_RIGHT 2 |
| #define | GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN) |
| #define | GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP) |
| #define | GLFW_HAT_UP 1 |
| #define | GLFW_HOVERED 0x0002000B |
| Mouse cursor hover window attribute. More... | |
| #define | GLFW_HRESIZE_CURSOR 0x00036005 |
| The horizontal resize arrow shape. More... | |
| #define | GLFW_IBEAM_CURSOR 0x00036002 |
| The text input I-beam cursor shape. More... | |
| #define | GLFW_ICONIFIED 0x00020002 |
| Window iconification window attribute. More... | |
| #define | GLFW_INVALID_ENUM 0x00010003 |
| One of the arguments to the function was an invalid enum value. More... | |
| #define | GLFW_INVALID_VALUE 0x00010004 |
| One of the arguments to the function was an invalid value. More... | |
| #define | GLFW_JOYSTICK_1 0 |
| #define | GLFW_JOYSTICK_10 9 |
| #define | GLFW_JOYSTICK_11 10 |
| #define | GLFW_JOYSTICK_12 11 |
| #define | GLFW_JOYSTICK_13 12 |
| #define | GLFW_JOYSTICK_14 13 |
| #define | GLFW_JOYSTICK_15 14 |
| #define | GLFW_JOYSTICK_16 15 |
| #define | GLFW_JOYSTICK_2 1 |
| #define | GLFW_JOYSTICK_3 2 |
| #define | GLFW_JOYSTICK_4 3 |
| #define | GLFW_JOYSTICK_5 4 |
| #define | GLFW_JOYSTICK_6 5 |
| #define | GLFW_JOYSTICK_7 6 |
| #define | GLFW_JOYSTICK_8 7 |
| #define | GLFW_JOYSTICK_9 8 |
| #define | GLFW_JOYSTICK_HAT_BUTTONS 0x00050001 |
| Joystick hat buttons init hint. More... | |
| #define | GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16 |
| #define | GLFW_KEY_0 48 |
| #define | GLFW_KEY_1 49 |
| #define | GLFW_KEY_2 50 |
| #define | GLFW_KEY_3 51 |
| #define | GLFW_KEY_4 52 |
| #define | GLFW_KEY_5 53 |
| #define | GLFW_KEY_6 54 |
| #define | GLFW_KEY_7 55 |
| #define | GLFW_KEY_8 56 |
| #define | GLFW_KEY_9 57 |
| #define | GLFW_KEY_A 65 |
| #define | GLFW_KEY_APOSTROPHE 39 /* ' */ |
| #define | GLFW_KEY_B 66 |
| #define | GLFW_KEY_BACKSLASH 92 /* \ */ |
| #define | GLFW_KEY_BACKSPACE 259 |
| #define | GLFW_KEY_C 67 |
| #define | GLFW_KEY_CAPS_LOCK 280 |
| #define | GLFW_KEY_COMMA 44 /* , */ |
| #define | GLFW_KEY_D 68 |
| #define | GLFW_KEY_DELETE 261 |
| #define | GLFW_KEY_DOWN 264 |
| #define | GLFW_KEY_E 69 |
| #define | GLFW_KEY_END 269 |
| #define | GLFW_KEY_ENTER 257 |
| #define | GLFW_KEY_EQUAL 61 /* = */ |
| #define | GLFW_KEY_ESCAPE 256 |
| #define | GLFW_KEY_F 70 |
| #define | GLFW_KEY_F1 290 |
| #define | GLFW_KEY_F10 299 |
| #define | GLFW_KEY_F11 300 |
| #define | GLFW_KEY_F12 301 |
| #define | GLFW_KEY_F13 302 |
| #define | GLFW_KEY_F14 303 |
| #define | GLFW_KEY_F15 304 |
| #define | GLFW_KEY_F16 305 |
| #define | GLFW_KEY_F17 306 |
| #define | GLFW_KEY_F18 307 |
| #define | GLFW_KEY_F19 308 |
| #define | GLFW_KEY_F2 291 |
| #define | GLFW_KEY_F20 309 |
| #define | GLFW_KEY_F21 310 |
| #define | GLFW_KEY_F22 311 |
| #define | GLFW_KEY_F23 312 |
| #define | GLFW_KEY_F24 313 |
| #define | GLFW_KEY_F25 314 |
| #define | GLFW_KEY_F3 292 |
| #define | GLFW_KEY_F4 293 |
| #define | GLFW_KEY_F5 294 |
| #define | GLFW_KEY_F6 295 |
| #define | GLFW_KEY_F7 296 |
| #define | GLFW_KEY_F8 297 |
| #define | GLFW_KEY_F9 298 |
| #define | GLFW_KEY_G 71 |
| #define | GLFW_KEY_GRAVE_ACCENT 96 /* ` */ |
| #define | GLFW_KEY_H 72 |
| #define | GLFW_KEY_HOME 268 |
| #define | GLFW_KEY_I 73 |
| #define | GLFW_KEY_INSERT 260 |
| #define | GLFW_KEY_J 74 |
| #define | GLFW_KEY_K 75 |
| #define | GLFW_KEY_KP_0 320 |
| #define | GLFW_KEY_KP_1 321 |
| #define | GLFW_KEY_KP_2 322 |
| #define | GLFW_KEY_KP_3 323 |
| #define | GLFW_KEY_KP_4 324 |
| #define | GLFW_KEY_KP_5 325 |
| #define | GLFW_KEY_KP_6 326 |
| #define | GLFW_KEY_KP_7 327 |
| #define | GLFW_KEY_KP_8 328 |
| #define | GLFW_KEY_KP_9 329 |
| #define | GLFW_KEY_KP_ADD 334 |
| #define | GLFW_KEY_KP_DECIMAL 330 |
| #define | GLFW_KEY_KP_DIVIDE 331 |
| #define | GLFW_KEY_KP_ENTER 335 |
| #define | GLFW_KEY_KP_EQUAL 336 |
| #define | GLFW_KEY_KP_MULTIPLY 332 |
| #define | GLFW_KEY_KP_SUBTRACT 333 |
| #define | GLFW_KEY_L 76 |
| #define | GLFW_KEY_LAST GLFW_KEY_MENU |
| #define | GLFW_KEY_LEFT 263 |
| #define | GLFW_KEY_LEFT_ALT 342 |
| #define | GLFW_KEY_LEFT_BRACKET 91 /* [ */ |
| #define | GLFW_KEY_LEFT_CONTROL 341 |
| #define | GLFW_KEY_LEFT_SHIFT 340 |
| #define | GLFW_KEY_LEFT_SUPER 343 |
| #define | GLFW_KEY_M 77 |
| #define | GLFW_KEY_MENU 348 |
| #define | GLFW_KEY_MINUS 45 /* - */ |
| #define | GLFW_KEY_N 78 |
| #define | GLFW_KEY_NUM_LOCK 282 |
| #define | GLFW_KEY_O 79 |
| #define | GLFW_KEY_P 80 |
| #define | GLFW_KEY_PAGE_DOWN 267 |
| #define | GLFW_KEY_PAGE_UP 266 |
| #define | GLFW_KEY_PAUSE 284 |
| #define | GLFW_KEY_PERIOD 46 /* . */ |
| #define | GLFW_KEY_PRINT_SCREEN 283 |
| #define | GLFW_KEY_Q 81 |
| #define | GLFW_KEY_R 82 |
| #define | GLFW_KEY_RIGHT 262 |
| #define | GLFW_KEY_RIGHT_ALT 346 |
| #define | GLFW_KEY_RIGHT_BRACKET 93 /* ] */ |
| #define | GLFW_KEY_RIGHT_CONTROL 345 |
| #define | GLFW_KEY_RIGHT_SHIFT 344 |
| #define | GLFW_KEY_RIGHT_SUPER 347 |
| #define | GLFW_KEY_S 83 |
| #define | GLFW_KEY_SCROLL_LOCK 281 |
| #define | GLFW_KEY_SEMICOLON 59 /* ; */ |
| #define | GLFW_KEY_SLASH 47 /* / */ |
| #define | GLFW_KEY_SPACE 32 |
| #define | GLFW_KEY_T 84 |
| #define | GLFW_KEY_TAB 258 |
| #define | GLFW_KEY_U 85 |
| #define | GLFW_KEY_UNKNOWN -1 |
| #define | GLFW_KEY_UP 265 |
| #define | GLFW_KEY_V 86 |
| #define | GLFW_KEY_W 87 |
| #define | GLFW_KEY_WORLD_1 161 /* non-US #1 */ |
| #define | GLFW_KEY_WORLD_2 162 /* non-US #2 */ |
| #define | GLFW_KEY_X 88 |
| #define | GLFW_KEY_Y 89 |
| #define | GLFW_KEY_Z 90 |
| #define | GLFW_LOCK_KEY_MODS 0x00033004 |
| #define | GLFW_LOSE_CONTEXT_ON_RESET 0x00031002 |
| #define | GLFW_MAXIMIZED 0x00020008 |
| Window maximization window hint and attribute. More... | |
| #define | GLFW_MOD_ALT 0x0004 |
| If this bit is set one or more Alt keys were held down. More... | |
| #define | GLFW_MOD_CAPS_LOCK 0x0010 |
| If this bit is set the Caps Lock key is enabled. More... | |
| #define | GLFW_MOD_CONTROL 0x0002 |
| If this bit is set one or more Control keys were held down. More... | |
| #define | GLFW_MOD_NUM_LOCK 0x0020 |
| If this bit is set the Num Lock key is enabled. More... | |
| #define | GLFW_MOD_SHIFT 0x0001 |
| If this bit is set one or more Shift keys were held down. More... | |
| #define | GLFW_MOD_SUPER 0x0008 |
| If this bit is set one or more Super keys were held down. More... | |
| #define | GLFW_MOUSE_BUTTON_1 0 |
| #define | GLFW_MOUSE_BUTTON_2 1 |
| #define | GLFW_MOUSE_BUTTON_3 2 |
| #define | GLFW_MOUSE_BUTTON_4 3 |
| #define | GLFW_MOUSE_BUTTON_5 4 |
| #define | GLFW_MOUSE_BUTTON_6 5 |
| #define | GLFW_MOUSE_BUTTON_7 6 |
| #define | GLFW_MOUSE_BUTTON_8 7 |
| #define | GLFW_MOUSE_BUTTON_LAST GLFW_MOUSE_BUTTON_8 |
| #define | GLFW_MOUSE_BUTTON_LEFT GLFW_MOUSE_BUTTON_1 |
| #define | GLFW_MOUSE_BUTTON_MIDDLE GLFW_MOUSE_BUTTON_3 |
| #define | GLFW_MOUSE_BUTTON_RIGHT GLFW_MOUSE_BUTTON_2 |
| #define | GLFW_NATIVE_CONTEXT_API 0x00036001 |
| #define | GLFW_NO_API 0 |
| #define | GLFW_NO_CURRENT_CONTEXT 0x00010002 |
| No context is current for this thread. More... | |
| #define | GLFW_NO_ERROR 0 |
| No error has occurred. More... | |
| #define | GLFW_NO_RESET_NOTIFICATION 0x00031001 |
| #define | GLFW_NO_ROBUSTNESS 0 |
| #define | GLFW_NO_WINDOW_CONTEXT 0x0001000A |
| The specified window does not have an OpenGL or OpenGL ES context. More... | |
| #define | GLFW_NOT_INITIALIZED 0x00010001 |
| GLFW has not been initialized. More... | |
| #define | GLFW_OPENGL_ANY_PROFILE 0 |
| #define | GLFW_OPENGL_API 0x00030001 |
| #define | GLFW_OPENGL_COMPAT_PROFILE 0x00032002 |
| #define | GLFW_OPENGL_CORE_PROFILE 0x00032001 |
| #define | GLFW_OPENGL_DEBUG_CONTEXT 0x00022007 |
| OpenGL debug context hint and attribute. More... | |
| #define | GLFW_OPENGL_ES_API 0x00030002 |
| #define | GLFW_OPENGL_FORWARD_COMPAT 0x00022006 |
| OpenGL forward-compatibility hint and attribute. More... | |
| #define | GLFW_OPENGL_PROFILE 0x00022008 |
| OpenGL profile hint and attribute. More... | |
| #define | GLFW_OSMESA_CONTEXT_API 0x00036003 |
| #define | GLFW_OUT_OF_MEMORY 0x00010005 |
| A memory allocation failed. More... | |
| #define | GLFW_PLATFORM_ERROR 0x00010008 |
| A platform-specific error occurred that does not match any of the more specific categories. More... | |
| #define | GLFW_RED_BITS 0x00021001 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_REFRESH_RATE 0x0002100F |
| Monitor refresh rate hint. More... | |
| #define | GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001 |
| #define | GLFW_RELEASE_BEHAVIOR_NONE 0x00035002 |
| #define | GLFW_RESIZABLE 0x00020003 |
| Window resize-ability window hint and attribute. More... | |
| #define | GLFW_SAMPLES 0x0002100D |
| Framebuffer MSAA samples hint. More... | |
| #define | GLFW_SCALE_TO_MONITOR 0x0002200C |
| Window content area scaling window window hint. More... | |
| #define | GLFW_SRGB_CAPABLE 0x0002100E |
| Framebuffer sRGB hint. More... | |
| #define | GLFW_STENCIL_BITS 0x00021006 |
| Framebuffer bit depth hint. More... | |
| #define | GLFW_STEREO 0x0002100C |
| OpenGL stereoscopic rendering hint. More... | |
| #define | GLFW_STICKY_KEYS 0x00033002 |
| #define | GLFW_STICKY_MOUSE_BUTTONS 0x00033003 |
| #define | GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A |
| Window framebuffer transparency hint and attribute. More... | |
| #define | GLFW_TRUE 1 |
| One. More... | |
| #define | GLFW_VERSION_UNAVAILABLE 0x00010007 |
| The requested OpenGL or OpenGL ES version is not available. More... | |
| #define | GLFW_VISIBLE 0x00020004 |
| Window visibility window hint and attribute. More... | |
| #define | GLFW_VRESIZE_CURSOR 0x00036006 |
| The vertical resize arrow shape. More... | |
| #define | GLFW_X11_CLASS_NAME 0x00024001 |
| #define | GLFW_X11_INSTANCE_NAME 0x00024002 |
| #define | GLFWAPI |
GLFW version macros | |
| #define | GLFW_VERSION_MAJOR 3 |
| The major version number of the GLFW library. More... | |
| #define | GLFW_VERSION_MINOR 3 |
| The minor version number of the GLFW library. More... | |
| #define | GLFW_VERSION_REVISION 0 |
| The revision number of the GLFW library. More... | |
Key and button actions | |
| #define | GLFW_RELEASE 0 |
| The key or mouse button was released. More... | |
| #define | GLFW_PRESS 1 |
| The key or mouse button was pressed. More... | |
| #define | GLFW_REPEAT 2 |
| The key was held down until it repeated. More... | |
Typedefs | |
| typedef void(* | GLFWcharfun) (GLFWwindow *, unsigned int) |
| The function signature for Unicode character callbacks. More... | |
| typedef void(* | GLFWcharmodsfun) (GLFWwindow *, unsigned int, int) |
| The function signature for Unicode character with modifiers callbacks. More... | |
| typedef struct GLFWcursor | GLFWcursor |
| Opaque cursor object. More... | |
| typedef void(* | GLFWcursorenterfun) (GLFWwindow *, int) |
| The function signature for cursor enter/leave callbacks. More... | |
| typedef void(* | GLFWcursorposfun) (GLFWwindow *, double, double) |
| The function signature for cursor position callbacks. More... | |
| typedef void(* | GLFWdropfun) (GLFWwindow *, int, const char **) |
| The function signature for file drop callbacks. More... | |
| typedef void(* | GLFWerrorfun) (int, const char *) |
| The function signature for error callbacks. More... | |
| typedef void(* | GLFWframebuffersizefun) (GLFWwindow *, int, int) |
| The function signature for framebuffer resize callbacks. More... | |
| typedef struct GLFWgamepadstate | GLFWgamepadstate |
| Gamepad input state. More... | |
| typedef struct GLFWgammaramp | GLFWgammaramp |
| Gamma ramp. More... | |
| typedef void(* | GLFWglproc) (void) |
| Client API function pointer type. More... | |
| typedef struct GLFWimage | GLFWimage |
| Image data. More... | |
| typedef void(* | GLFWjoystickfun) (int, int) |
| The function signature for joystick configuration callbacks. More... | |
| typedef void(* | GLFWkeyfun) (GLFWwindow *, int, int, int, int) |
| The function signature for keyboard key callbacks. More... | |
| typedef struct GLFWmonitor | GLFWmonitor |
| Opaque monitor object. More... | |
| typedef void(* | GLFWmonitorfun) (GLFWmonitor *, int) |
| The function signature for monitor configuration callbacks. More... | |
| typedef void(* | GLFWmousebuttonfun) (GLFWwindow *, int, int, int) |
| The function signature for mouse button callbacks. More... | |
| typedef void(* | GLFWscrollfun) (GLFWwindow *, double, double) |
| The function signature for scroll callbacks. More... | |
| typedef struct GLFWvidmode | GLFWvidmode |
| Video mode type. More... | |
| typedef void(* | GLFWvkproc) (void) |
| Vulkan API function pointer type. More... | |
| typedef struct GLFWwindow | GLFWwindow |
| Opaque window object. More... | |
| typedef void(* | GLFWwindowclosefun) (GLFWwindow *) |
| The function signature for window close callbacks. More... | |
| typedef void(* | GLFWwindowcontentscalefun) (GLFWwindow *, float, float) |
| The function signature for window content scale callbacks. More... | |
| typedef void(* | GLFWwindowfocusfun) (GLFWwindow *, int) |
| The function signature for window focus/defocus callbacks. More... | |
| typedef void(* | GLFWwindowiconifyfun) (GLFWwindow *, int) |
| The function signature for window iconify/restore callbacks. More... | |
| typedef void(* | GLFWwindowmaximizefun) (GLFWwindow *, int) |
| The function signature for window maximize/restore callbacks. More... | |
| typedef void(* | GLFWwindowposfun) (GLFWwindow *, int, int) |
| The function signature for window position callbacks. More... | |
| typedef void(* | GLFWwindowrefreshfun) (GLFWwindow *) |
| The function signature for window content refresh callbacks. More... | |
| typedef void(* | GLFWwindowsizefun) (GLFWwindow *, int, int) |
| The function signature for window resize callbacks. More... | |
Functions | |
| GLFWAPI GLFWcursor * | glfwCreateCursor (const GLFWimage *image, int xhot, int yhot) |
| Creates a custom cursor. More... | |
| GLFWAPI GLFWcursor * | glfwCreateStandardCursor (int shape) |
| Creates a cursor with a standard shape. More... | |
| GLFWAPI GLFWwindow * | glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share) |
| Creates a window and its associated context. More... | |
| GLFWAPI void | glfwDefaultWindowHints (void) |
| Resets all window hints to their default values. More... | |
| GLFWAPI void | glfwDestroyCursor (GLFWcursor *cursor) |
| Destroys a cursor. More... | |
| GLFWAPI void | glfwDestroyWindow (GLFWwindow *window) |
| Destroys the specified window and its context. More... | |
| GLFWAPI int | glfwExtensionSupported (const char *extension) |
| Returns whether the specified extension is available. More... | |
| GLFWAPI void | glfwFocusWindow (GLFWwindow *window) |
| Brings the specified window to front and sets input focus. More... | |
| GLFWAPI const char * | glfwGetClipboardString (GLFWwindow *window) |
| Returns the contents of the clipboard as a string. More... | |
| GLFWAPI GLFWwindow * | glfwGetCurrentContext (void) |
| Returns the window whose context is current on the calling thread. More... | |
| GLFWAPI void | glfwGetCursorPos (GLFWwindow *window, double *xpos, double *ypos) |
| Retrieves the position of the cursor relative to the client area of the window. More... | |
| GLFWAPI int | glfwGetError (const char **description) |
| Returns and clears the last error for the calling thread. More... | |
| GLFWAPI void | glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the framebuffer of the specified window. More... | |
| GLFWAPI const char * | glfwGetGamepadName (int jid) |
| Returns the human-readable gamepad name for the specified joystick. More... | |
| GLFWAPI int | glfwGetGamepadState (int jid, GLFWgamepadstate *state) |
| Retrieves the state of the specified joystick remapped as a gamepad. More... | |
| GLFWAPI const GLFWgammaramp * | glfwGetGammaRamp (GLFWmonitor *monitor) |
| Returns the current gamma ramp for the specified monitor. More... | |
| GLFWAPI int | glfwGetInputMode (GLFWwindow *window, int mode) |
| Returns the value of an input option for the specified window. More... | |
| GLFWAPI const float * | glfwGetJoystickAxes (int jid, int *count) |
| Returns the values of all axes of the specified joystick. More... | |
| GLFWAPI const unsigned char * | glfwGetJoystickButtons (int jid, int *count) |
| Returns the state of all buttons of the specified joystick. More... | |
| GLFWAPI const char * | glfwGetJoystickGUID (int jid) |
| Returns the SDL comaptible GUID of the specified joystick. More... | |
| GLFWAPI const unsigned char * | glfwGetJoystickHats (int jid, int *count) |
| Returns the state of all hats of the specified joystick. More... | |
| GLFWAPI const char * | glfwGetJoystickName (int jid) |
| Returns the name of the specified joystick. More... | |
| GLFWAPI void * | glfwGetJoystickUserPointer (int jid) |
| Returns the user pointer of the specified joystick. More... | |
| GLFWAPI int | glfwGetKey (GLFWwindow *window, int key) |
| Returns the last reported state of a keyboard key for the specified window. More... | |
| GLFWAPI const char * | glfwGetKeyName (int key, int scancode) |
| Returns the layout-specific name of the specified printable key. More... | |
| GLFWAPI int | glfwGetKeyScancode (int key) |
| Returns the platform-specific scancode of the specified key. More... | |
| GLFWAPI void | glfwGetMonitorContentScale (GLFWmonitor *monitor, float *xscale, float *yscale) |
| Retrieves the content scale for the specified monitor. More... | |
| GLFWAPI const char * | glfwGetMonitorName (GLFWmonitor *monitor) |
| Returns the name of the specified monitor. More... | |
| GLFWAPI void | glfwGetMonitorPhysicalSize (GLFWmonitor *monitor, int *widthMM, int *heightMM) |
| Returns the physical size of the monitor. More... | |
| GLFWAPI void | glfwGetMonitorPos (GLFWmonitor *monitor, int *xpos, int *ypos) |
| Returns the position of the monitor's viewport on the virtual screen. More... | |
| GLFWAPI GLFWmonitor ** | glfwGetMonitors (int *count) |
| Returns the currently connected monitors. More... | |
| GLFWAPI void * | glfwGetMonitorUserPointer (GLFWmonitor *monitor) |
| Returns the user pointer of the specified monitor. More... | |
| GLFWAPI int | glfwGetMouseButton (GLFWwindow *window, int button) |
| Returns the last reported state of a mouse button for the specified window. More... | |
| GLFWAPI GLFWmonitor * | glfwGetPrimaryMonitor (void) |
| Returns the primary monitor. More... | |
| GLFWAPI GLFWglproc | glfwGetProcAddress (const char *procname) |
| Returns the address of the specified function for the current context. More... | |
| GLFWAPI const char ** | glfwGetRequiredInstanceExtensions (uint32_t *count) |
| Returns the Vulkan instance extensions required by GLFW. More... | |
| GLFWAPI double | glfwGetTime (void) |
| Returns the value of the GLFW timer. More... | |
| GLFWAPI uint64_t | glfwGetTimerFrequency (void) |
| Returns the frequency, in Hz, of the raw timer. More... | |
| GLFWAPI uint64_t | glfwGetTimerValue (void) |
| Returns the current value of the raw timer. More... | |
| GLFWAPI void | glfwGetVersion (int *major, int *minor, int *rev) |
| Retrieves the version of the GLFW library. More... | |
| GLFWAPI const char * | glfwGetVersionString (void) |
| Returns a string describing the compile-time configuration. More... | |
| GLFWAPI const GLFWvidmode * | glfwGetVideoMode (GLFWmonitor *monitor) |
| Returns the current mode of the specified monitor. More... | |
| GLFWAPI const GLFWvidmode * | glfwGetVideoModes (GLFWmonitor *monitor, int *count) |
| Returns the available video modes for the specified monitor. More... | |
| GLFWAPI int | glfwGetWindowAttrib (GLFWwindow *window, int attrib) |
| Returns an attribute of the specified window. More... | |
| GLFWAPI void | glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale) |
| Retrieves the content scale for the specified window. More... | |
| GLFWAPI void | glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom) |
| Retrieves the size of the frame of the window. More... | |
| GLFWAPI GLFWmonitor * | glfwGetWindowMonitor (GLFWwindow *window) |
| Returns the monitor that the window uses for full screen mode. More... | |
| GLFWAPI float | glfwGetWindowOpacity (GLFWwindow *window) |
| Returns the opacity of the whole window. More... | |
| GLFWAPI void | glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos) |
| Retrieves the position of the client area of the specified window. More... | |
| GLFWAPI void | glfwGetWindowSize (GLFWwindow *window, int *width, int *height) |
| Retrieves the size of the client area of the specified window. More... | |
| GLFWAPI void * | glfwGetWindowUserPointer (GLFWwindow *window) |
| Returns the user pointer of the specified window. More... | |
| GLFWAPI void | glfwHideWindow (GLFWwindow *window) |
| Hides the specified window. More... | |
| GLFWAPI void | glfwIconifyWindow (GLFWwindow *window) |
| Iconifies the specified window. More... | |
| GLFWAPI int | glfwInit (void) |
| Initializes the GLFW library. More... | |
| GLFWAPI void | glfwInitHint (int hint, int value) |
| Sets the specified init hint to the desired value. More... | |
| GLFWAPI int | glfwJoystickIsGamepad (int jid) |
| Returns whether the specified joystick has a gamepad mapping. More... | |
| GLFWAPI int | glfwJoystickPresent (int jid) |
| Returns whether the specified joystick is present. More... | |
| GLFWAPI void | glfwMakeContextCurrent (GLFWwindow *window) |
| Makes the context of the specified window current for the calling thread. More... | |
| GLFWAPI void | glfwMaximizeWindow (GLFWwindow *window) |
| Maximizes the specified window. More... | |
| GLFWAPI void | glfwPollEvents (void) |
| Processes all pending events. More... | |
| GLFWAPI void | glfwPostEmptyEvent (void) |
| Posts an empty event to the event queue. More... | |
| GLFWAPI void | glfwRequestWindowAttention (GLFWwindow *window) |
| Requests user attention to the specified window. More... | |
| GLFWAPI void | glfwRestoreWindow (GLFWwindow *window) |
| Restores the specified window. More... | |
| GLFWAPI GLFWcharfun | glfwSetCharCallback (GLFWwindow *window, GLFWcharfun cbfun) |
| Sets the Unicode character callback. More... | |
| GLFWAPI GLFWcharmodsfun | glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun cbfun) |
| Sets the Unicode character with modifiers callback. More... | |
| GLFWAPI void | glfwSetClipboardString (GLFWwindow *window, const char *string) |
| Sets the clipboard to the specified string. More... | |
| GLFWAPI void | glfwSetCursor (GLFWwindow *window, GLFWcursor *cursor) |
| Sets the cursor for the window. More... | |
| GLFWAPI GLFWcursorenterfun | glfwSetCursorEnterCallback (GLFWwindow *window, GLFWcursorenterfun cbfun) |
| Sets the cursor enter/exit callback. More... | |
| GLFWAPI void | glfwSetCursorPos (GLFWwindow *window, double xpos, double ypos) |
| Sets the position of the cursor, relative to the client area of the window. More... | |
| GLFWAPI GLFWcursorposfun | glfwSetCursorPosCallback (GLFWwindow *window, GLFWcursorposfun cbfun) |
| Sets the cursor position callback. More... | |
| GLFWAPI GLFWdropfun | glfwSetDropCallback (GLFWwindow *window, GLFWdropfun cbfun) |
| Sets the file drop callback. More... | |
| GLFWAPI GLFWerrorfun | glfwSetErrorCallback (GLFWerrorfun cbfun) |
| Sets the error callback. More... | |
| GLFWAPI GLFWframebuffersizefun | glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun cbfun) |
| Sets the framebuffer resize callback for the specified window. More... | |
| GLFWAPI void | glfwSetGamma (GLFWmonitor *monitor, float gamma) |
| Generates a gamma ramp and sets it for the specified monitor. More... | |
| GLFWAPI void | glfwSetGammaRamp (GLFWmonitor *monitor, const GLFWgammaramp *ramp) |
| Sets the current gamma ramp for the specified monitor. More... | |
| GLFWAPI void | glfwSetInputMode (GLFWwindow *window, int mode, int value) |
| Sets an input option for the specified window. More... | |
| GLFWAPI GLFWjoystickfun | glfwSetJoystickCallback (GLFWjoystickfun cbfun) |
| Sets the joystick configuration callback. More... | |
| GLFWAPI void | glfwSetJoystickUserPointer (int jid, void *pointer) |
| Sets the user pointer of the specified joystick. More... | |
| GLFWAPI GLFWkeyfun | glfwSetKeyCallback (GLFWwindow *window, GLFWkeyfun cbfun) |
| Sets the key callback. More... | |
| GLFWAPI GLFWmonitorfun | glfwSetMonitorCallback (GLFWmonitorfun cbfun) |
| Sets the monitor configuration callback. More... | |
| GLFWAPI void | glfwSetMonitorUserPointer (GLFWmonitor *monitor, void *pointer) |
| Sets the user pointer of the specified monitor. More... | |
| GLFWAPI GLFWmousebuttonfun | glfwSetMouseButtonCallback (GLFWwindow *window, GLFWmousebuttonfun cbfun) |
| Sets the mouse button callback. More... | |
| GLFWAPI GLFWscrollfun | glfwSetScrollCallback (GLFWwindow *window, GLFWscrollfun cbfun) |
| Sets the scroll callback. More... | |
| GLFWAPI void | glfwSetTime (double time) |
| Sets the GLFW timer. More... | |
| GLFWAPI void | glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom) |
| Sets the aspect ratio of the specified window. More... | |
| GLFWAPI void | glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value) |
| Sets an attribute of the specified window. More... | |
| GLFWAPI GLFWwindowclosefun | glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun cbfun) |
| Sets the close callback for the specified window. More... | |
| GLFWAPI GLFWwindowcontentscalefun | glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun cbfun) |
| Sets the window content scale callback for the specified window. More... | |
| GLFWAPI GLFWwindowfocusfun | glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun cbfun) |
| Sets the focus callback for the specified window. More... | |
| GLFWAPI void | glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images) |
| Sets the icon for the specified window. More... | |
| GLFWAPI GLFWwindowiconifyfun | glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun cbfun) |
| Sets the iconify callback for the specified window. More... | |
| GLFWAPI GLFWwindowmaximizefun | glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun cbfun) |
| Sets the maximize callback for the specified window. More... | |
| GLFWAPI void | glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate) |
| Sets the mode, monitor, video mode and placement of a window. More... | |
| GLFWAPI void | glfwSetWindowOpacity (GLFWwindow *window, float opacity) |
| Sets the opacity of the whole window. More... | |
| GLFWAPI void | glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos) |
| Sets the position of the client area of the specified window. More... | |
| GLFWAPI GLFWwindowposfun | glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun cbfun) |
| Sets the position callback for the specified window. More... | |
| GLFWAPI GLFWwindowrefreshfun | glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun cbfun) |
| Sets the refresh callback for the specified window. More... | |
| GLFWAPI void | glfwSetWindowShouldClose (GLFWwindow *window, int value) |
| Sets the close flag of the specified window. More... | |
| GLFWAPI void | glfwSetWindowSize (GLFWwindow *window, int width, int height) |
| Sets the size of the client area of the specified window. More... | |
| GLFWAPI GLFWwindowsizefun | glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun cbfun) |
| Sets the size callback for the specified window. More... | |
| GLFWAPI void | glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight) |
| Sets the size limits of the specified window. More... | |
| GLFWAPI void | glfwSetWindowTitle (GLFWwindow *window, const char *title) |
| Sets the title of the specified window. More... | |
| GLFWAPI void | glfwSetWindowUserPointer (GLFWwindow *window, void *pointer) |
| Sets the user pointer of the specified window. More... | |
| GLFWAPI void | glfwShowWindow (GLFWwindow *window) |
| Makes the specified window visible. More... | |
| GLFWAPI void | glfwSwapBuffers (GLFWwindow *window) |
| Swaps the front and back buffers of the specified window. More... | |
| GLFWAPI void | glfwSwapInterval (int interval) |
| Sets the swap interval for the current context. More... | |
| GLFWAPI void | glfwTerminate (void) |
| Terminates the GLFW library. More... | |
| GLFWAPI int | glfwUpdateGamepadMappings (const char *string) |
| Adds the specified SDL_GameControllerDB gamepad mappings. More... | |
| GLFWAPI int | glfwVulkanSupported (void) |
| Returns whether the Vulkan loader and an ICD have been found. More... | |
| GLFWAPI void | glfwWaitEvents (void) |
| Waits until events are queued and processes them. More... | |
| GLFWAPI void | glfwWaitEventsTimeout (double timeout) |
| Waits with timeout until events are queued and processes them. More... | |
| GLFWAPI void | glfwWindowHint (int hint, int value) |
| Sets the specified window hint to the desired value. More... | |
| GLFWAPI void | glfwWindowHintString (int hint, const char *value) |
| Sets the specified window hint to the desired value. More... | |
| GLFWAPI int | glfwWindowShouldClose (GLFWwindow *window) |
| Checks the close flag of the specified window. More... | |
Detailed Description
The header of the GLFW 3 API.
This is the header file of the GLFW 3 API. It defines all its types and declares all its functions.
For more information about how to use this file, see Including the GLFW header file.
Definition in file glfw3.h.