docs/html/glfw3_8h_source.html

/*************************************************************************

 * GLFW 3.3 - www.glfw.org

 * A library for OpenGL, window and input

 *------------------------------------------------------------------------

 * Copyright (c) 2002-2006 Marcus Geelnard

 * Copyright (c) 2006-2019 Camilla Löwy <elmindreda@glfw.org>

 *

 * This software is provided 'as-is', without any express or implied

 * warranty. In no event will the authors be held liable for any damages

 * arising from the use of this software.

 *

 * Permission is granted to anyone to use this software for any purpose,

 * including commercial applications, and to alter it and redistribute it

 * freely, subject to the following restrictions:

 *

 * 1. The origin of this software must not be misrepresented; you must not

 *    claim that you wrote the original software. If you use this software

 *    in a product, an acknowledgment in the product documentation would

 *    be appreciated but is not required.

 *

 * 2. Altered source versions must be plainly marked as such, and must not

 *    be misrepresented as being the original software.

 *

 * 3. This notice may not be removed or altered from any source

 *    distribution.

 *

 *************************************************************************/


#ifndef _glfw3_h_

#define _glfw3_h_


#ifdef __cplusplus

extern "C" {

#endif


/*************************************************************************

 * Doxygen documentation

 *************************************************************************/


/*************************************************************************

 * Compiler- and platform-specific preprocessor work

 *************************************************************************/


/* If we are we on Windows, we want a single define for it.

 */

#if !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__MINGW32__))

 #define _WIN32

#endif /* _WIN32 */


/* Include because most Windows GLU headers need wchar_t and

 * the macOS OpenGL header blocks the definition of ptrdiff_t by glext.h.

 * Include it unconditionally to avoid surprising side-effects.

 */

#include <stddef.h>


/* Include because it is needed by Vulkan and related functions.

 * Include it unconditionally to avoid surprising side-effects.

 */

#include <stdint.h>


#if defined(GLFW_INCLUDE_VULKAN)

  #include <vulkan/vulkan.h>

#endif /* Vulkan header */


/* The Vulkan header may have indirectly included windows.h (because of

 * VK_USE_PLATFORM_WIN32_KHR) so we offer our replacement symbols after it.

 */


/* It is customary to use APIENTRY for OpenGL function pointer declarations on

 * all platforms.  Additionally, the Windows OpenGL header needs APIENTRY.

 */

#if !defined(APIENTRY)

 #if defined(_WIN32)

  #define APIENTRY __stdcall

 #else

  #define APIENTRY

 #endif

 #define GLFW_APIENTRY_DEFINED

#endif /* APIENTRY */


/* Some Windows OpenGL headers need this.

 */

#if !defined(WINGDIAPI) && defined(_WIN32)

 #define WINGDIAPI __declspec(dllimport)

 #define GLFW_WINGDIAPI_DEFINED

#endif /* WINGDIAPI */


/* Some Windows GLU headers need this.

 */

#if !defined(CALLBACK) && defined(_WIN32)

 #define CALLBACK __stdcall

 #define GLFW_CALLBACK_DEFINED

#endif /* CALLBACK */


/* Include the chosen OpenGL or OpenGL ES headers.

 */

#if defined(GLFW_INCLUDE_ES1)


 #include <GLES/gl.h>

 #if defined(GLFW_INCLUDE_GLEXT)

  #include <GLES/glext.h>

 #endif


#elif defined(GLFW_INCLUDE_ES2)


 #include <GLES2/gl2.h>

 #if defined(GLFW_INCLUDE_GLEXT)

  #include <GLES2/gl2ext.h>

 #endif


#elif defined(GLFW_INCLUDE_ES3)


 #include <GLES3/gl3.h>

 #if defined(GLFW_INCLUDE_GLEXT)

  #include <GLES2/gl2ext.h>

 #endif


#elif defined(GLFW_INCLUDE_ES31)


 #include <GLES3/gl31.h>

 #if defined(GLFW_INCLUDE_GLEXT)

  #include <GLES2/gl2ext.h>

 #endif


#elif defined(GLFW_INCLUDE_ES32)


 #include <GLES3/gl32.h>

 #if defined(GLFW_INCLUDE_GLEXT)

  #include <GLES2/gl2ext.h>

 #endif


#elif defined(GLFW_INCLUDE_GLCOREARB)


 #if defined(__APPLE__)


  #include <OpenGL/gl3.h>

  #if defined(GLFW_INCLUDE_GLEXT)

   #include <OpenGL/gl3ext.h>

  #endif /*GLFW_INCLUDE_GLEXT*/


 #else /*__APPLE__*/


  #include <GL/glcorearb.h>

  #if defined(GLFW_INCLUDE_GLEXT)

   #include <GL/glext.h>

  #endif


 #endif /*__APPLE__*/


#elif defined(GLFW_INCLUDE_GLU)


 #if defined(__APPLE__)


  #if defined(GLFW_INCLUDE_GLU)

   #include <OpenGL/glu.h>

  #endif


 #else /*__APPLE__*/


  #if defined(GLFW_INCLUDE_GLU)

   #include <GL/glu.h>

  #endif


 #endif /*__APPLE__*/


#elif !defined(GLFW_INCLUDE_NONE) && \

      !defined(__gl_h_) && \

      !defined(__gles1_gl_h_) && \

      !defined(__gles2_gl2_h_) && \

      !defined(__gles2_gl3_h_) && \

      !defined(__gles2_gl31_h_) && \

      !defined(__gles2_gl32_h_) && \

      !defined(__gl_glcorearb_h_) && \

      !defined(__gl2_h_) /*legacy*/ && \

      !defined(__gl3_h_) /*legacy*/ && \

      !defined(__gl31_h_) /*legacy*/ && \

      !defined(__gl32_h_) /*legacy*/ && \

      !defined(__glcorearb_h_) /*legacy*/ && \

      !defined(__GL_H__) /*non-standard*/ && \

      !defined(__gltypes_h_) /*non-standard*/ && \

      !defined(__glee_h_) /*non-standard*/


 #if defined(__APPLE__)


  #if !defined(GLFW_INCLUDE_GLEXT)

   #define GL_GLEXT_LEGACY

  #endif

  #include <OpenGL/gl.h>


 #else /*__APPLE__*/


  #include <GL/gl.h>

  #if defined(GLFW_INCLUDE_GLEXT)

   #include <GL/glext.h>

  #endif


 #endif /*__APPLE__*/


#endif /* OpenGL and OpenGL ES headers */


#if defined(GLFW_DLL) && defined(_GLFW_BUILD_DLL)

 /* GLFW_DLL must be defined by applications that are linking against the DLL

  * version of the GLFW library.  _GLFW_BUILD_DLL is defined by the GLFW

  * configuration header when compiling the DLL version of the library.

  */

 #error "You must not have both GLFW_DLL and _GLFW_BUILD_DLL defined"

#endif


/* GLFWAPI is used to declare public API functions for export

 * from the DLL / shared library / dynamic library.

 */

#if defined(_WIN32) && defined(_GLFW_BUILD_DLL)

 /* We are building GLFW as a Win32 DLL */

 #define GLFWAPI __declspec(dllexport)

#elif defined(_WIN32) && defined(GLFW_DLL)

 /* We are calling GLFW as a Win32 DLL */

 #define GLFWAPI __declspec(dllimport)

#elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL)

 /* We are building GLFW as a shared / dynamic library */

 #define GLFWAPI __attribute__((visibility("default")))

#else

 /* We are building or calling GLFW as a static library */

 #define GLFWAPI

#endif


/*************************************************************************

 * GLFW API tokens

 *************************************************************************/


#define GLFW_VERSION_MAJOR          3

#define GLFW_VERSION_MINOR          3

#define GLFW_VERSION_REVISION       5

#define GLFW_TRUE                   1

#define GLFW_FALSE                  0


#define GLFW_RELEASE                0

#define GLFW_PRESS                  1

#define GLFW_REPEAT                 2

#define GLFW_HAT_CENTERED           0

#define GLFW_HAT_UP                 1

#define GLFW_HAT_RIGHT              2

#define GLFW_HAT_DOWN               4

#define GLFW_HAT_LEFT               8

#define GLFW_HAT_RIGHT_UP           (GLFW_HAT_RIGHT | GLFW_HAT_UP)

#define GLFW_HAT_RIGHT_DOWN         (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)

#define GLFW_HAT_LEFT_UP            (GLFW_HAT_LEFT  | GLFW_HAT_UP)

#define GLFW_HAT_LEFT_DOWN          (GLFW_HAT_LEFT  | GLFW_HAT_DOWN)

/* The unknown key */

#define GLFW_KEY_UNKNOWN            -1


/* Printable keys */

#define GLFW_KEY_SPACE              32

#define GLFW_KEY_APOSTROPHE         39  /* ' */

#define GLFW_KEY_COMMA              44  /* , */

#define GLFW_KEY_MINUS              45  /* - */

#define GLFW_KEY_PERIOD             46  /* . */

#define GLFW_KEY_SLASH              47  /* / */

#define GLFW_KEY_0                  48

#define GLFW_KEY_1                  49

#define GLFW_KEY_2                  50

#define GLFW_KEY_3                  51

#define GLFW_KEY_4                  52

#define GLFW_KEY_5                  53

#define GLFW_KEY_6                  54

#define GLFW_KEY_7                  55

#define GLFW_KEY_8                  56

#define GLFW_KEY_9                  57

#define GLFW_KEY_SEMICOLON          59  /* ; */

#define GLFW_KEY_EQUAL              61  /* = */

#define GLFW_KEY_A                  65

#define GLFW_KEY_B                  66

#define GLFW_KEY_C                  67

#define GLFW_KEY_D                  68

#define GLFW_KEY_E                  69

#define GLFW_KEY_F                  70

#define GLFW_KEY_G                  71

#define GLFW_KEY_H                  72

#define GLFW_KEY_I                  73

#define GLFW_KEY_J                  74

#define GLFW_KEY_K                  75

#define GLFW_KEY_L                  76

#define GLFW_KEY_M                  77

#define GLFW_KEY_N                  78

#define GLFW_KEY_O                  79

#define GLFW_KEY_P                  80

#define GLFW_KEY_Q                  81

#define GLFW_KEY_R                  82

#define GLFW_KEY_S                  83

#define GLFW_KEY_T                  84

#define GLFW_KEY_U                  85

#define GLFW_KEY_V                  86

#define GLFW_KEY_W                  87

#define GLFW_KEY_X                  88

#define GLFW_KEY_Y                  89

#define GLFW_KEY_Z                  90

#define GLFW_KEY_LEFT_BRACKET       91  /* [ */

#define GLFW_KEY_BACKSLASH          92  /* \ */

#define GLFW_KEY_RIGHT_BRACKET      93  /* ] */

#define GLFW_KEY_GRAVE_ACCENT       96  /* ` */

#define GLFW_KEY_WORLD_1            161 /* non-US #1 */

#define GLFW_KEY_WORLD_2            162 /* non-US #2 */


/* Function keys */

#define GLFW_KEY_ESCAPE             256

#define GLFW_KEY_ENTER              257

#define GLFW_KEY_TAB                258

#define GLFW_KEY_BACKSPACE          259

#define GLFW_KEY_INSERT             260

#define GLFW_KEY_DELETE             261

#define GLFW_KEY_RIGHT              262

#define GLFW_KEY_LEFT               263

#define GLFW_KEY_DOWN               264

#define GLFW_KEY_UP                 265

#define GLFW_KEY_PAGE_UP            266

#define GLFW_KEY_PAGE_DOWN          267

#define GLFW_KEY_HOME               268

#define GLFW_KEY_END                269

#define GLFW_KEY_CAPS_LOCK          280

#define GLFW_KEY_SCROLL_LOCK        281

#define GLFW_KEY_NUM_LOCK           282

#define GLFW_KEY_PRINT_SCREEN       283

#define GLFW_KEY_PAUSE              284

#define GLFW_KEY_F1                 290

#define GLFW_KEY_F2                 291

#define GLFW_KEY_F3                 292

#define GLFW_KEY_F4                 293

#define GLFW_KEY_F5                 294

#define GLFW_KEY_F6                 295

#define GLFW_KEY_F7                 296

#define GLFW_KEY_F8                 297

#define GLFW_KEY_F9                 298

#define GLFW_KEY_F10                299

#define GLFW_KEY_F11                300

#define GLFW_KEY_F12                301

#define GLFW_KEY_F13                302

#define GLFW_KEY_F14                303

#define GLFW_KEY_F15                304

#define GLFW_KEY_F16                305

#define GLFW_KEY_F17                306

#define GLFW_KEY_F18                307

#define GLFW_KEY_F19                308

#define GLFW_KEY_F20                309

#define GLFW_KEY_F21                310

#define GLFW_KEY_F22                311

#define GLFW_KEY_F23                312

#define GLFW_KEY_F24                313

#define GLFW_KEY_F25                314

#define GLFW_KEY_KP_0               320

#define GLFW_KEY_KP_1               321

#define GLFW_KEY_KP_2               322

#define GLFW_KEY_KP_3               323

#define GLFW_KEY_KP_4               324

#define GLFW_KEY_KP_5               325

#define GLFW_KEY_KP_6               326

#define GLFW_KEY_KP_7               327

#define GLFW_KEY_KP_8               328

#define GLFW_KEY_KP_9               329

#define GLFW_KEY_KP_DECIMAL         330

#define GLFW_KEY_KP_DIVIDE          331

#define GLFW_KEY_KP_MULTIPLY        332

#define GLFW_KEY_KP_SUBTRACT        333

#define GLFW_KEY_KP_ADD             334

#define GLFW_KEY_KP_ENTER           335

#define GLFW_KEY_KP_EQUAL           336

#define GLFW_KEY_LEFT_SHIFT         340

#define GLFW_KEY_LEFT_CONTROL       341

#define GLFW_KEY_LEFT_ALT           342

#define GLFW_KEY_LEFT_SUPER         343

#define GLFW_KEY_RIGHT_SHIFT        344

#define GLFW_KEY_RIGHT_CONTROL      345

#define GLFW_KEY_RIGHT_ALT          346

#define GLFW_KEY_RIGHT_SUPER        347

#define GLFW_KEY_MENU               348


#define GLFW_KEY_LAST               GLFW_KEY_MENU


#define GLFW_MOD_SHIFT           0x0001

#define GLFW_MOD_CONTROL         0x0002

#define GLFW_MOD_ALT             0x0004

#define GLFW_MOD_SUPER           0x0008

#define GLFW_MOD_CAPS_LOCK       0x0010

#define GLFW_MOD_NUM_LOCK        0x0020


#define GLFW_MOUSE_BUTTON_1         0

#define GLFW_MOUSE_BUTTON_2         1

#define GLFW_MOUSE_BUTTON_3         2

#define GLFW_MOUSE_BUTTON_4         3

#define GLFW_MOUSE_BUTTON_5         4

#define GLFW_MOUSE_BUTTON_6         5

#define GLFW_MOUSE_BUTTON_7         6

#define GLFW_MOUSE_BUTTON_8         7

#define GLFW_MOUSE_BUTTON_LAST      GLFW_MOUSE_BUTTON_8

#define GLFW_MOUSE_BUTTON_LEFT      GLFW_MOUSE_BUTTON_1

#define GLFW_MOUSE_BUTTON_RIGHT     GLFW_MOUSE_BUTTON_2

#define GLFW_MOUSE_BUTTON_MIDDLE    GLFW_MOUSE_BUTTON_3

#define GLFW_JOYSTICK_1             0

#define GLFW_JOYSTICK_2             1

#define GLFW_JOYSTICK_3             2

#define GLFW_JOYSTICK_4             3

#define GLFW_JOYSTICK_5             4

#define GLFW_JOYSTICK_6             5

#define GLFW_JOYSTICK_7             6

#define GLFW_JOYSTICK_8             7

#define GLFW_JOYSTICK_9             8

#define GLFW_JOYSTICK_10            9

#define GLFW_JOYSTICK_11            10

#define GLFW_JOYSTICK_12            11

#define GLFW_JOYSTICK_13            12

#define GLFW_JOYSTICK_14            13

#define GLFW_JOYSTICK_15            14

#define GLFW_JOYSTICK_16            15

#define GLFW_JOYSTICK_LAST          GLFW_JOYSTICK_16

#define GLFW_GAMEPAD_BUTTON_A               0

#define GLFW_GAMEPAD_BUTTON_B               1

#define GLFW_GAMEPAD_BUTTON_X               2

#define GLFW_GAMEPAD_BUTTON_Y               3

#define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER     4

#define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER    5

#define GLFW_GAMEPAD_BUTTON_BACK            6

#define GLFW_GAMEPAD_BUTTON_START           7

#define GLFW_GAMEPAD_BUTTON_GUIDE           8

#define GLFW_GAMEPAD_BUTTON_LEFT_THUMB      9

#define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB     10

#define GLFW_GAMEPAD_BUTTON_DPAD_UP         11

#define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT      12

#define GLFW_GAMEPAD_BUTTON_DPAD_DOWN       13

#define GLFW_GAMEPAD_BUTTON_DPAD_LEFT       14

#define GLFW_GAMEPAD_BUTTON_LAST            GLFW_GAMEPAD_BUTTON_DPAD_LEFT


#define GLFW_GAMEPAD_BUTTON_CROSS       GLFW_GAMEPAD_BUTTON_A

#define GLFW_GAMEPAD_BUTTON_CIRCLE      GLFW_GAMEPAD_BUTTON_B

#define GLFW_GAMEPAD_BUTTON_SQUARE      GLFW_GAMEPAD_BUTTON_X

#define GLFW_GAMEPAD_BUTTON_TRIANGLE    GLFW_GAMEPAD_BUTTON_Y

#define GLFW_GAMEPAD_AXIS_LEFT_X        0

#define GLFW_GAMEPAD_AXIS_LEFT_Y        1

#define GLFW_GAMEPAD_AXIS_RIGHT_X       2

#define GLFW_GAMEPAD_AXIS_RIGHT_Y       3

#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER  4

#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5

#define GLFW_GAMEPAD_AXIS_LAST          GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER

#define GLFW_NO_ERROR               0

#define GLFW_NOT_INITIALIZED        0x00010001

#define GLFW_NO_CURRENT_CONTEXT     0x00010002

#define GLFW_INVALID_ENUM           0x00010003

#define GLFW_INVALID_VALUE          0x00010004

#define GLFW_OUT_OF_MEMORY          0x00010005

#define GLFW_API_UNAVAILABLE        0x00010006

#define GLFW_VERSION_UNAVAILABLE    0x00010007

#define GLFW_PLATFORM_ERROR         0x00010008

#define GLFW_FORMAT_UNAVAILABLE     0x00010009

#define GLFW_NO_WINDOW_CONTEXT      0x0001000A

#define GLFW_FOCUSED                0x00020001

#define GLFW_ICONIFIED              0x00020002

#define GLFW_RESIZABLE              0x00020003

#define GLFW_VISIBLE                0x00020004

#define GLFW_DECORATED              0x00020005

#define GLFW_AUTO_ICONIFY           0x00020006

#define GLFW_FLOATING               0x00020007

#define GLFW_MAXIMIZED              0x00020008

#define GLFW_CENTER_CURSOR          0x00020009

#define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A

#define GLFW_HOVERED                0x0002000B

#define GLFW_FOCUS_ON_SHOW          0x0002000C


#define GLFW_RED_BITS               0x00021001

#define GLFW_GREEN_BITS             0x00021002

#define GLFW_BLUE_BITS              0x00021003

#define GLFW_ALPHA_BITS             0x00021004

#define GLFW_DEPTH_BITS             0x00021005

#define GLFW_STENCIL_BITS           0x00021006

#define GLFW_ACCUM_RED_BITS         0x00021007

#define GLFW_ACCUM_GREEN_BITS       0x00021008

#define GLFW_ACCUM_BLUE_BITS        0x00021009

#define GLFW_ACCUM_ALPHA_BITS       0x0002100A

#define GLFW_AUX_BUFFERS            0x0002100B

#define GLFW_STEREO                 0x0002100C

#define GLFW_SAMPLES                0x0002100D

#define GLFW_SRGB_CAPABLE           0x0002100E

#define GLFW_REFRESH_RATE           0x0002100F

#define GLFW_DOUBLEBUFFER           0x00021010


#define GLFW_CLIENT_API             0x00022001

#define GLFW_CONTEXT_VERSION_MAJOR  0x00022002

#define GLFW_CONTEXT_VERSION_MINOR  0x00022003

#define GLFW_CONTEXT_REVISION       0x00022004

#define GLFW_CONTEXT_ROBUSTNESS     0x00022005

#define GLFW_OPENGL_FORWARD_COMPAT  0x00022006

#define GLFW_OPENGL_DEBUG_CONTEXT   0x00022007

#define GLFW_OPENGL_PROFILE         0x00022008

#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009

#define GLFW_CONTEXT_NO_ERROR       0x0002200A

#define GLFW_CONTEXT_CREATION_API   0x0002200B

#define GLFW_SCALE_TO_MONITOR       0x0002200C

#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001

#define GLFW_COCOA_FRAME_NAME         0x00023002

#define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003

#define GLFW_X11_CLASS_NAME         0x00024001

#define GLFW_X11_INSTANCE_NAME      0x00024002

#define GLFW_NO_API                          0

#define GLFW_OPENGL_API             0x00030001

#define GLFW_OPENGL_ES_API          0x00030002


#define GLFW_NO_ROBUSTNESS                   0

#define GLFW_NO_RESET_NOTIFICATION  0x00031001

#define GLFW_LOSE_CONTEXT_ON_RESET  0x00031002


#define GLFW_OPENGL_ANY_PROFILE              0

#define GLFW_OPENGL_CORE_PROFILE    0x00032001

#define GLFW_OPENGL_COMPAT_PROFILE  0x00032002


#define GLFW_CURSOR                 0x00033001

#define GLFW_STICKY_KEYS            0x00033002

#define GLFW_STICKY_MOUSE_BUTTONS   0x00033003

#define GLFW_LOCK_KEY_MODS          0x00033004

#define GLFW_RAW_MOUSE_MOTION       0x00033005


#define GLFW_CURSOR_NORMAL          0x00034001

#define GLFW_CURSOR_HIDDEN          0x00034002

#define GLFW_CURSOR_DISABLED        0x00034003


#define GLFW_ANY_RELEASE_BEHAVIOR            0

#define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001

#define GLFW_RELEASE_BEHAVIOR_NONE  0x00035002


#define GLFW_NATIVE_CONTEXT_API     0x00036001

#define GLFW_EGL_CONTEXT_API        0x00036002

#define GLFW_OSMESA_CONTEXT_API     0x00036003


#define GLFW_ARROW_CURSOR           0x00036001

#define GLFW_IBEAM_CURSOR           0x00036002

#define GLFW_CROSSHAIR_CURSOR       0x00036003

#define GLFW_HAND_CURSOR            0x00036004

#define GLFW_HRESIZE_CURSOR         0x00036005

#define GLFW_VRESIZE_CURSOR         0x00036006

#define GLFW_CONNECTED              0x00040001

#define GLFW_DISCONNECTED           0x00040002


#define GLFW_JOYSTICK_HAT_BUTTONS   0x00050001

#define GLFW_COCOA_CHDIR_RESOURCES  0x00051001

#define GLFW_COCOA_MENUBAR          0x00051002

#define GLFW_DONT_CARE              -1


/*************************************************************************

 * GLFW API types

 *************************************************************************/


typedef void (*GLFWglproc)(void);


typedef void (*GLFWvkproc)(void);


typedef struct GLFWmonitor GLFWmonitor;


typedef struct GLFWwindow GLFWwindow;


typedef struct GLFWcursor GLFWcursor;


typedef void (* GLFWerrorfun)(int error_code, const char* description);


typedef void (* GLFWwindowposfun)(GLFWwindow* window, int xpos, int ypos);


typedef void (* GLFWwindowsizefun)(GLFWwindow* window, int width, int height);


typedef void (* GLFWwindowclosefun)(GLFWwindow* window);


typedef void (* GLFWwindowrefreshfun)(GLFWwindow* window);


typedef void (* GLFWwindowfocusfun)(GLFWwindow* window, int focused);


typedef void (* GLFWwindowiconifyfun)(GLFWwindow* window, int iconified);


typedef void (* GLFWwindowmaximizefun)(GLFWwindow* window, int maximized);


typedef void (* GLFWframebuffersizefun)(GLFWwindow* window, int width, int height);


typedef void (* GLFWwindowcontentscalefun)(GLFWwindow* window, float xscale, float yscale);


typedef void (* GLFWmousebuttonfun)(GLFWwindow* window, int button, int action, int mods);


typedef void (* GLFWcursorposfun)(GLFWwindow* window, double xpos, double ypos);


typedef void (* GLFWcursorenterfun)(GLFWwindow* window, int entered);


typedef void (* GLFWscrollfun)(GLFWwindow* window, double xoffset, double yoffset);


typedef void (* GLFWkeyfun)(GLFWwindow* window, int key, int scancode, int action, int mods);


typedef void (* GLFWcharfun)(GLFWwindow* window, unsigned int codepoint);


typedef void (* GLFWcharmodsfun)(GLFWwindow* window, unsigned int codepoint, int mods);


typedef void (* GLFWdropfun)(GLFWwindow* window, int path_count, const char* paths[]);


typedef void (* GLFWmonitorfun)(GLFWmonitor* monitor, int event);


typedef void (* GLFWjoystickfun)(int jid, int event);


typedef struct GLFWvidmode

{

    int width;

    int height;

    int redBits;

    int greenBits;

    int blueBits;

    int refreshRate;

} GLFWvidmode;


typedef struct GLFWgammaramp

{

    unsigned short* red;

    unsigned short* green;

    unsigned short* blue;

    unsigned int size;

} GLFWgammaramp;


typedef struct GLFWimage

{

    int width;

    int height;

    unsigned char* pixels;

} GLFWimage;


typedef struct GLFWgamepadstate

{

    unsigned char buttons[15];

    float axes[6];

} GLFWgamepadstate;


/*************************************************************************

 * GLFW API functions

 *************************************************************************/


GLFWAPI int glfwInit(void);


GLFWAPI void glfwTerminate(void);


GLFWAPI void glfwInitHint(int hint, int value);


GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);


GLFWAPI const char* glfwGetVersionString(void);


GLFWAPI int glfwGetError(const char** description);


GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback);


GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);


GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);


GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);


GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);


GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);


GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);


GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);


GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);


GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);


GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback);


GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);


GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);


GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);


GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);


GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);


GLFWAPI void glfwDefaultWindowHints(void);


GLFWAPI void glfwWindowHint(int hint, int value);


GLFWAPI void glfwWindowHintString(int hint, const char* value);


GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);


GLFWAPI void glfwDestroyWindow(GLFWwindow* window);


GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);


GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);


GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);


GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);


GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);


GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);


GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);


GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);


GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);


GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);


GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);


GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);


GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);


GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);


GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);


GLFWAPI void glfwIconifyWindow(GLFWwindow* window);


GLFWAPI void glfwRestoreWindow(GLFWwindow* window);


GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);


GLFWAPI void glfwShowWindow(GLFWwindow* window);


GLFWAPI void glfwHideWindow(GLFWwindow* window);


GLFWAPI void glfwFocusWindow(GLFWwindow* window);


GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);


GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);


GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);


GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);


GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);


GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);


GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);


GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun callback);


GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun callback);


GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);


GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);


GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);


GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);


GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);


GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);


GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);


GLFWAPI void glfwPollEvents(void);


GLFWAPI void glfwWaitEvents(void);


GLFWAPI void glfwWaitEventsTimeout(double timeout);


GLFWAPI void glfwPostEmptyEvent(void);


GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);


GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);


GLFWAPI int glfwRawMouseMotionSupported(void);


GLFWAPI const char* glfwGetKeyName(int key, int scancode);


GLFWAPI int glfwGetKeyScancode(int key);


GLFWAPI int glfwGetKey(GLFWwindow* window, int key);


GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);


GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);


GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);


GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);


GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);


GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);


GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);


GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);


GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);


GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun callback);


GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun callback);


GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun callback);


GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun callback);


GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);


GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);


GLFWAPI int glfwJoystickPresent(int jid);


GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);


GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);


GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);


GLFWAPI const char* glfwGetJoystickName(int jid);


GLFWAPI const char* glfwGetJoystickGUID(int jid);


GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);


GLFWAPI void* glfwGetJoystickUserPointer(int jid);


GLFWAPI int glfwJoystickIsGamepad(int jid);


GLFWAPI GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback);


GLFWAPI int glfwUpdateGamepadMappings(const char* string);


GLFWAPI const char* glfwGetGamepadName(int jid);


GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);


GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);


GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);


GLFWAPI double glfwGetTime(void);


GLFWAPI void glfwSetTime(double time);


GLFWAPI uint64_t glfwGetTimerValue(void);


GLFWAPI uint64_t glfwGetTimerFrequency(void);


GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);


GLFWAPI GLFWwindow* glfwGetCurrentContext(void);


GLFWAPI void glfwSwapBuffers(GLFWwindow* window);


GLFWAPI void glfwSwapInterval(int interval);


GLFWAPI int glfwExtensionSupported(const char* extension);


GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);


GLFWAPI int glfwVulkanSupported(void);


GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);


#if defined(VK_VERSION_1_0)


GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);


GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);


GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);


#endif /*VK_VERSION_1_0*/


/*************************************************************************

 * Global definition cleanup

 *************************************************************************/


/* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */


#ifdef GLFW_WINGDIAPI_DEFINED

 #undef WINGDIAPI

 #undef GLFW_WINGDIAPI_DEFINED

#endif


#ifdef GLFW_CALLBACK_DEFINED

 #undef CALLBACK

 #undef GLFW_CALLBACK_DEFINED

#endif


/* Some OpenGL related headers need GLAPIENTRY, but it is unconditionally

 * defined by some gl.h variants (OpenBSD) so define it after if needed.

 */

#ifndef GLAPIENTRY

 #define GLAPIENTRY APIENTRY

#endif


/* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */


#ifdef __cplusplus

}

#endif


#endif /* _glfw3_h_ */


glfwMakeContextCurrent
void glfwMakeContextCurrent(GLFWwindow *window)
Makes the context of the specified window current for the calling thread.

glfwGetProcAddress
GLFWglproc glfwGetProcAddress(const char *procname)
Returns the address of the specified function for the current context.

GLFWglproc
void(* GLFWglproc)(void)
Client API function pointer type.
Definition: glfw3.h:1148

glfwSwapInterval
void glfwSwapInterval(int interval)
Sets the swap interval for the current context.

glfwExtensionSupported
int glfwExtensionSupported(const char *extension)
Returns whether the specified extension is available.

glfwGetCurrentContext
GLFWwindow * glfwGetCurrentContext(void)
Returns the window whose context is current on the calling thread.

glfwGetVersionString
const char * glfwGetVersionString(void)
Returns a string describing the compile-time configuration.

glfwInitHint
void glfwInitHint(int hint, int value)
Sets the specified init hint to the desired value.

glfwInit
int glfwInit(void)
Initializes the GLFW library.

GLFWerrorfun
void(* GLFWerrorfun)(int error_code, const char *description)
The function pointer type for error callbacks.
Definition: glfw3.h:1222

glfwGetError
int glfwGetError(const char **description)
Returns and clears the last error for the calling thread.

glfwGetVersion
void glfwGetVersion(int *major, int *minor, int *rev)
Retrieves the version of the GLFW library.

glfwTerminate
void glfwTerminate(void)
Terminates the GLFW library.

glfwSetErrorCallback
GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback)
Sets the error callback.

GLFWmousebuttonfun
void(* GLFWmousebuttonfun)(GLFWwindow *window, int button, int action, int mods)
The function pointer type for mouse button callbacks.
Definition: glfw3.h:1438

glfwGetCursorPos
void glfwGetCursorPos(GLFWwindow *window, double *xpos, double *ypos)
Retrieves the position of the cursor relative to the content area of the window.

glfwSetCursorPos
void glfwSetCursorPos(GLFWwindow *window, double xpos, double ypos)
Sets the position of the cursor, relative to the content area of the window.

glfwGetJoystickHats
const unsigned char * glfwGetJoystickHats(int jid, int *count)
Returns the state of all hats of the specified joystick.

glfwGetTimerValue
uint64_t glfwGetTimerValue(void)
Returns the current value of the raw timer.

glfwSetCharModsCallback
GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow *window, GLFWcharmodsfun callback)
Sets the Unicode character with modifiers callback.

glfwGetJoystickUserPointer
void * glfwGetJoystickUserPointer(int jid)
Returns the user pointer of the specified joystick.

GLFWcharfun
void(* GLFWcharfun)(GLFWwindow *window, unsigned int codepoint)
The function pointer type for Unicode character callbacks.
Definition: glfw3.h:1550

glfwSetKeyCallback
GLFWkeyfun glfwSetKeyCallback(GLFWwindow *window, GLFWkeyfun callback)
Sets the key callback.

glfwSetJoystickCallback
GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback)
Sets the joystick configuration callback.

glfwGetTimerFrequency
uint64_t glfwGetTimerFrequency(void)
Returns the frequency, in Hz, of the raw timer.

glfwCreateCursor
GLFWcursor * glfwCreateCursor(const GLFWimage *image, int xhot, int yhot)
Creates a custom cursor.

glfwSetScrollCallback
GLFWscrollfun glfwSetScrollCallback(GLFWwindow *window, GLFWscrollfun callback)
Sets the scroll callback.

GLFWkeyfun
void(* GLFWkeyfun)(GLFWwindow *window, int key, int scancode, int action, int mods)
The function pointer type for keyboard key callbacks.
Definition: glfw3.h:1529

glfwGetJoystickButtons
const unsigned char * glfwGetJoystickButtons(int jid, int *count)
Returns the state of all buttons of the specified joystick.

GLFWgamepadstate
struct GLFWgamepadstate GLFWgamepadstate
Gamepad input state.

glfwGetJoystickGUID
const char * glfwGetJoystickGUID(int jid)
Returns the SDL compatible GUID of the specified joystick.

glfwGetKeyScancode
int glfwGetKeyScancode(int key)
Returns the platform-specific scancode of the specified key.

glfwSetMouseButtonCallback
GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow *window, GLFWmousebuttonfun callback)
Sets the mouse button callback.

glfwSetJoystickUserPointer
void glfwSetJoystickUserPointer(int jid, void *pointer)
Sets the user pointer of the specified joystick.

glfwGetClipboardString
const char * glfwGetClipboardString(GLFWwindow *window)
Returns the contents of the clipboard as a string.

glfwDestroyCursor
void glfwDestroyCursor(GLFWcursor *cursor)
Destroys a cursor.

GLFWcursor
struct GLFWcursor GLFWcursor
Opaque cursor object.
Definition: glfw3.h:1198

glfwGetGamepadName
const char * glfwGetGamepadName(int jid)
Returns the human-readable gamepad name for the specified joystick.

GLFWjoystickfun
void(* GLFWjoystickfun)(int jid, int event)
The function pointer type for joystick configuration callbacks.
Definition: glfw3.h:1643

glfwGetTime
double glfwGetTime(void)
Returns the GLFW time.

glfwSetInputMode
void glfwSetInputMode(GLFWwindow *window, int mode, int value)
Sets an input option for the specified window.

GLFWcursorenterfun
void(* GLFWcursorenterfun)(GLFWwindow *window, int entered)
The function pointer type for cursor enter/leave callbacks.
Definition: glfw3.h:1482

GLFWdropfun
void(* GLFWdropfun)(GLFWwindow *window, int path_count, const char *paths[])
The function pointer type for path drop callbacks.
Definition: glfw3.h:1601

glfwSetCharCallback
GLFWcharfun glfwSetCharCallback(GLFWwindow *window, GLFWcharfun callback)
Sets the Unicode character callback.

glfwSetDropCallback
GLFWdropfun glfwSetDropCallback(GLFWwindow *window, GLFWdropfun callback)
Sets the path drop callback.

glfwSetClipboardString
void glfwSetClipboardString(GLFWwindow *window, const char *string)
Sets the clipboard to the specified string.

glfwGetMouseButton
int glfwGetMouseButton(GLFWwindow *window, int button)
Returns the last reported state of a mouse button for the specified window.

glfwSetCursorPosCallback
GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow *window, GLFWcursorposfun callback)
Sets the cursor position callback.

GLFWcharmodsfun
void(* GLFWcharmodsfun)(GLFWwindow *window, unsigned int codepoint, int mods)
The function pointer type for Unicode character with modifiers callbacks.
Definition: glfw3.h:1577

glfwGetJoystickName
const char * glfwGetJoystickName(int jid)
Returns the name of the specified joystick.

glfwJoystickIsGamepad
int glfwJoystickIsGamepad(int jid)
Returns whether the specified joystick has a gamepad mapping.

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.

GLFWcursorposfun
void(* GLFWcursorposfun)(GLFWwindow *window, double xpos, double ypos)
The function pointer type for cursor position callbacks.
Definition: glfw3.h:1461

glfwGetGamepadState
int glfwGetGamepadState(int jid, GLFWgamepadstate *state)
Retrieves the state of the specified joystick remapped as a gamepad.

glfwGetKey
int glfwGetKey(GLFWwindow *window, int key)
Returns the last reported state of a keyboard key for the specified window.

glfwRawMouseMotionSupported
int glfwRawMouseMotionSupported(void)
Returns whether raw mouse motion is supported.

glfwGetKeyName
const char * glfwGetKeyName(int key, int scancode)
Returns the layout-specific name of the specified printable key.

glfwGetJoystickAxes
const float * glfwGetJoystickAxes(int jid, int *count)
Returns the values of all axes of the specified joystick.

glfwJoystickPresent
int glfwJoystickPresent(int jid)
Returns whether the specified joystick is present.

glfwUpdateGamepadMappings
int glfwUpdateGamepadMappings(const char *string)
Adds the specified SDL_GameControllerDB gamepad mappings.

glfwCreateStandardCursor
GLFWcursor * glfwCreateStandardCursor(int shape)
Creates a cursor with a standard shape.

glfwSetTime
void glfwSetTime(double time)
Sets the GLFW time.

glfwGetInputMode
int glfwGetInputMode(GLFWwindow *window, int mode)
Returns the value of an input option for the specified window.

GLFWscrollfun
void(* GLFWscrollfun)(GLFWwindow *window, double xoffset, double yoffset)
The function pointer type for scroll callbacks.
Definition: glfw3.h:1503

glfwGetMonitorPos
void glfwGetMonitorPos(GLFWmonitor *monitor, int *xpos, int *ypos)
Returns the position of the monitor's viewport on the virtual screen.

glfwGetMonitorUserPointer
void * glfwGetMonitorUserPointer(GLFWmonitor *monitor)
Returns the user pointer of the specified monitor.

glfwSetGammaRamp
void glfwSetGammaRamp(GLFWmonitor *monitor, const GLFWgammaramp *ramp)
Sets the current gamma ramp for the specified monitor.

glfwSetGamma
void glfwSetGamma(GLFWmonitor *monitor, float gamma)
Generates a gamma ramp and sets it for the specified monitor.

glfwSetMonitorUserPointer
void glfwSetMonitorUserPointer(GLFWmonitor *monitor, void *pointer)
Sets the user pointer of the specified monitor.

glfwGetMonitors
GLFWmonitor ** glfwGetMonitors(int *count)
Returns the currently connected monitors.

glfwGetMonitorWorkarea
void glfwGetMonitorWorkarea(GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height)
Retrieves the work area of the monitor.

glfwGetGammaRamp
const GLFWgammaramp * glfwGetGammaRamp(GLFWmonitor *monitor)
Returns the current gamma ramp for the specified monitor.

glfwGetMonitorName
const char * glfwGetMonitorName(GLFWmonitor *monitor)
Returns the name of the specified monitor.

glfwGetMonitorPhysicalSize
void glfwGetMonitorPhysicalSize(GLFWmonitor *monitor, int *widthMM, int *heightMM)
Returns the physical size of the monitor.

GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1174

GLFWvidmode
struct GLFWvidmode GLFWvidmode
Video mode type.

GLFWgammaramp
struct GLFWgammaramp GLFWgammaramp
Gamma ramp.

GLFWmonitorfun
void(* GLFWmonitorfun)(GLFWmonitor *monitor, int event)
The function pointer type for monitor configuration callbacks.
Definition: glfw3.h:1622

glfwSetMonitorCallback
GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback)
Sets the monitor configuration callback.

glfwGetVideoMode
const GLFWvidmode * glfwGetVideoMode(GLFWmonitor *monitor)
Returns the current mode of the specified monitor.

glfwGetPrimaryMonitor
GLFWmonitor * glfwGetPrimaryMonitor(void)
Returns the primary monitor.

glfwGetVideoModes
const GLFWvidmode * glfwGetVideoModes(GLFWmonitor *monitor, int *count)
Returns the available video modes for the specified monitor.

glfwGetMonitorContentScale
void glfwGetMonitorContentScale(GLFWmonitor *monitor, float *xscale, float *yscale)
Retrieves the content scale for the specified monitor.

glfwCreateWindowSurface
VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
Creates a Vulkan surface for the specified window.

glfwVulkanSupported
int glfwVulkanSupported(void)
Returns whether the Vulkan loader and an ICD have been found.

GLFWvkproc
void(* GLFWvkproc)(void)
Vulkan API function pointer type.
Definition: glfw3.h:1162

glfwGetRequiredInstanceExtensions
const char ** glfwGetRequiredInstanceExtensions(uint32_t *count)
Returns the Vulkan instance extensions required by GLFW.

glfwGetInstanceProcAddress
GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char *procname)
Returns the address of the specified Vulkan instance function.

glfwGetPhysicalDevicePresentationSupport
int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
Returns whether the specified queue family can present images.

glfwSetWindowPosCallback
GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow *window, GLFWwindowposfun callback)
Sets the position callback for the specified window.

glfwGetFramebufferSize
void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the framebuffer of the specified window.

glfwSwapBuffers
void glfwSwapBuffers(GLFWwindow *window)
Swaps the front and back buffers of the specified window.

glfwGetWindowFrameSize
void glfwGetWindowFrameSize(GLFWwindow *window, int *left, int *top, int *right, int *bottom)
Retrieves the size of the frame of the window.

glfwSetWindowPos
void glfwSetWindowPos(GLFWwindow *window, int xpos, int ypos)
Sets the position of the content area of the specified window.

glfwIconifyWindow
void glfwIconifyWindow(GLFWwindow *window)
Iconifies the specified window.

glfwSetWindowRefreshCallback
GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow *window, GLFWwindowrefreshfun callback)
Sets the refresh callback for the specified window.

glfwWindowShouldClose
int glfwWindowShouldClose(GLFWwindow *window)
Checks the close flag of the specified window.

glfwRequestWindowAttention
void glfwRequestWindowAttention(GLFWwindow *window)
Requests user attention to the specified window.

GLFWwindowmaximizefun
void(* GLFWwindowmaximizefun)(GLFWwindow *window, int maximized)
The function pointer type for window maximize callbacks.
Definition: glfw3.h:1370

glfwCreateWindow
GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
Creates a window and its associated context.

GLFWwindowiconifyfun
void(* GLFWwindowiconifyfun)(GLFWwindow *window, int iconified)
The function pointer type for window iconify callbacks.
Definition: glfw3.h:1349

glfwSetWindowSize
void glfwSetWindowSize(GLFWwindow *window, int width, int height)
Sets the size of the content area of the specified window.

glfwPollEvents
void glfwPollEvents(void)
Processes all pending events.

GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1186

glfwSetWindowUserPointer
void glfwSetWindowUserPointer(GLFWwindow *window, void *pointer)
Sets the user pointer of the specified window.

glfwMaximizeWindow
void glfwMaximizeWindow(GLFWwindow *window)
Maximizes the specified window.

GLFWwindowrefreshfun
void(* GLFWwindowrefreshfun)(GLFWwindow *window)
The function pointer type for window content refresh callbacks.
Definition: glfw3.h:1307

glfwHideWindow
void glfwHideWindow(GLFWwindow *window)
Hides the specified window.

glfwSetWindowShouldClose
void glfwSetWindowShouldClose(GLFWwindow *window, int value)
Sets the close flag of the specified window.

glfwGetWindowMonitor
GLFWmonitor * glfwGetWindowMonitor(GLFWwindow *window)
Returns the monitor that the window uses for full screen mode.

glfwRestoreWindow
void glfwRestoreWindow(GLFWwindow *window)
Restores the specified window.

glfwWaitEvents
void glfwWaitEvents(void)
Waits until events are queued and processes them.

glfwSetWindowTitle
void glfwSetWindowTitle(GLFWwindow *window, const char *title)
Sets the title of the specified window.

glfwWaitEventsTimeout
void glfwWaitEventsTimeout(double timeout)
Waits with timeout until events are queued and processes them.

glfwShowWindow
void glfwShowWindow(GLFWwindow *window)
Makes the specified window visible.

glfwSetWindowAspectRatio
void glfwSetWindowAspectRatio(GLFWwindow *window, int numer, int denom)
Sets the aspect ratio of the specified window.

glfwGetWindowPos
void glfwGetWindowPos(GLFWwindow *window, int *xpos, int *ypos)
Retrieves the position of the content area of the specified window.

GLFWwindowcontentscalefun
void(* GLFWwindowcontentscalefun)(GLFWwindow *window, float xscale, float yscale)
The function pointer type for window content scale callbacks.
Definition: glfw3.h:1412

GLFWimage
struct GLFWimage GLFWimage
Image data.

glfwWindowHint
void glfwWindowHint(int hint, int value)
Sets the specified window hint to the desired value.

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.

glfwFocusWindow
void glfwFocusWindow(GLFWwindow *window)
Brings the specified window to front and sets input focus.

glfwWindowHintString
void glfwWindowHintString(int hint, const char *value)
Sets the specified window hint to the desired value.

glfwDefaultWindowHints
void glfwDefaultWindowHints(void)
Resets all window hints to their default values.

glfwSetFramebufferSizeCallback
GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow *window, GLFWframebuffersizefun callback)
Sets the framebuffer resize callback for the specified window.

glfwPostEmptyEvent
void glfwPostEmptyEvent(void)
Posts an empty event to the event queue.

GLFWwindowfocusfun
void(* GLFWwindowfocusfun)(GLFWwindow *window, int focused)
The function pointer type for window focus callbacks.
Definition: glfw3.h:1328

GLFWwindowposfun
void(* GLFWwindowposfun)(GLFWwindow *window, int xpos, int ypos)
The function pointer type for window position callbacks.
Definition: glfw3.h:1245

GLFWwindowclosefun
void(* GLFWwindowclosefun)(GLFWwindow *window)
The function pointer type for window close callbacks.
Definition: glfw3.h:1287

glfwSetWindowFocusCallback
GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow *window, GLFWwindowfocusfun callback)
Sets the focus callback for the specified window.

glfwSetWindowSizeLimits
void glfwSetWindowSizeLimits(GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
Sets the size limits of the specified window.

glfwSetWindowOpacity
void glfwSetWindowOpacity(GLFWwindow *window, float opacity)
Sets the opacity of the whole window.

glfwSetWindowIconifyCallback
GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow *window, GLFWwindowiconifyfun callback)
Sets the iconify callback for the specified window.

glfwSetWindowMaximizeCallback
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow *window, GLFWwindowmaximizefun callback)
Sets the maximize callback for the specified window.

glfwGetWindowAttrib
int glfwGetWindowAttrib(GLFWwindow *window, int attrib)
Returns an attribute of the specified window.

glfwDestroyWindow
void glfwDestroyWindow(GLFWwindow *window)
Destroys the specified window and its context.

glfwSetWindowAttrib
void glfwSetWindowAttrib(GLFWwindow *window, int attrib, int value)
Sets an attribute of the specified window.

glfwGetWindowOpacity
float glfwGetWindowOpacity(GLFWwindow *window)
Returns the opacity of the whole window.

glfwSetWindowSizeCallback
GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow *window, GLFWwindowsizefun callback)
Sets the size callback for the specified window.

glfwSetWindowCloseCallback
GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow *window, GLFWwindowclosefun callback)
Sets the close callback for the specified window.

glfwSetWindowIcon
void glfwSetWindowIcon(GLFWwindow *window, int count, const GLFWimage *images)
Sets the icon for the specified window.

GLFWframebuffersizefun
void(* GLFWframebuffersizefun)(GLFWwindow *window, int width, int height)
The function pointer type for framebuffer size callbacks.
Definition: glfw3.h:1391

glfwGetWindowUserPointer
void * glfwGetWindowUserPointer(GLFWwindow *window)
Returns the user pointer of the specified window.

GLFWwindowsizefun
void(* GLFWwindowsizefun)(GLFWwindow *window, int width, int height)
The function pointer type for window size callbacks.
Definition: glfw3.h:1267

glfwGetWindowSize
void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the content area of the specified window.

glfwSetWindowContentScaleCallback
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow *window, GLFWwindowcontentscalefun callback)
Sets the window content scale callback for the specified window.

glfwGetWindowContentScale
void glfwGetWindowContentScale(GLFWwindow *window, float *xscale, float *yscale)
Retrieves the content scale for the specified window.

GLFWgamepadstate
Gamepad input state.
Definition: glfw3.h:1746

GLFWgamepadstate::buttons
unsigned char buttons[15]
Definition: glfw3.h:1750

GLFWgamepadstate::axes
float axes[6]
Definition: glfw3.h:1754

GLFWgammaramp
Gamma ramp.
Definition: glfw3.h:1693

GLFWgammaramp::red
unsigned short * red
Definition: glfw3.h:1696

GLFWgammaramp::blue
unsigned short * blue
Definition: glfw3.h:1702

GLFWgammaramp::size
unsigned int size
Definition: glfw3.h:1705

GLFWgammaramp::green
unsigned short * green
Definition: glfw3.h:1699

GLFWimage
Image data.
Definition: glfw3.h:1722

GLFWimage::height
int height
Definition: glfw3.h:1728

GLFWimage::pixels
unsigned char * pixels
Definition: glfw3.h:1731

GLFWimage::width
int width
Definition: glfw3.h:1725

GLFWvidmode
Video mode type.
Definition: glfw3.h:1659

GLFWvidmode::greenBits
int greenBits
Definition: glfw3.h:1671

GLFWvidmode::redBits
int redBits
Definition: glfw3.h:1668

GLFWvidmode::width
int width
Definition: glfw3.h:1662

GLFWvidmode::refreshRate
int refreshRate
Definition: glfw3.h:1677

GLFWvidmode::height
int height
Definition: glfw3.h:1665

GLFWvidmode::blueBits
int blueBits
Definition: glfw3.h:1674