summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpryazha <pryadeiniv@mail.ru>2025-01-23 19:39:54 +0500
committerpryazha <pryadeiniv@mail.ru>2025-01-23 19:39:54 +0500
commitbf1c59565096ac9774493846cfb15e259d3b0e66 (patch)
tree82e8182af128580b6f38437feccba8c0f48abdc1
parent1ee094199af9c169e1ccaa53c7b0c186c4a3639e (diff)
restructure
-rw-r--r--advanced_lighting/blinn_phong/.blinn_phong.c.swpbin0 -> 16384 bytes
-rwxr-xr-xadvanced_lighting/blinn_phong/blinn_phongbin0 -> 1278128 bytes
-rw-r--r--advanced_lighting/blinn_phong/blinn_phong.c210
-rwxr-xr-xadvanced_lighting/blinn_phong/build.sh5
-rw-r--r--advanced_lighting/blinn_phong/shaders/.blinn_phong.fs.swpbin0 -> 12288 bytes
-rw-r--r--advanced_lighting/blinn_phong/shaders/blinn_phong.fs62
-rw-r--r--advanced_lighting/blinn_phong/shaders/blinn_phong.vs21
-rwxr-xr-xadvanced_opengl/1.depth/build.sh (renamed from skybox/build.sh)4
-rwxr-xr-xadvanced_opengl/1.depth/depthbin0 -> 1282576 bytes
-rw-r--r--advanced_opengl/1.depth/depth.c (renamed from depth/depth.c)88
-rw-r--r--advanced_opengl/1.depth/shaders/depth.fs (renamed from depth/shaders/depth.fs)0
-rw-r--r--advanced_opengl/1.depth/shaders/depth.vs (renamed from depth/shaders/depth.vs)0
-rwxr-xr-xadvanced_opengl/10.antialiasing/anti_aliasing_msaabin0 -> 1277808 bytes
-rw-r--r--advanced_opengl/10.antialiasing/anti_aliasing_msaa.c (renamed from mesh_loading_test/mesh_loading_test.c)125
-rwxr-xr-xadvanced_opengl/10.antialiasing/anti_aliasing_offscreenbin0 -> 1278840 bytes
-rw-r--r--advanced_opengl/10.antialiasing/anti_aliasing_offscreen.c276
-rwxr-xr-xadvanced_opengl/10.antialiasing/build.sh5
-rw-r--r--advanced_opengl/10.antialiasing/shaders/color.fs (renamed from stencil/shaders/outline.fs)0
-rw-r--r--advanced_opengl/10.antialiasing/shaders/color.vs (renamed from mesh_loading_test/shaders/default.vs)4
-rw-r--r--advanced_opengl/10.antialiasing/shaders/screen.fs122
-rw-r--r--advanced_opengl/10.antialiasing/shaders/screen.vs12
-rwxr-xr-xadvanced_opengl/2.stencil/build.sh (renamed from stencil/build.sh)2
-rw-r--r--advanced_opengl/2.stencil/shaders/outline.fs9
-rw-r--r--advanced_opengl/2.stencil/shaders/stencil.fs (renamed from stencil/shaders/stencil.fs)0
-rw-r--r--advanced_opengl/2.stencil/shaders/stencil.vs (renamed from stencil/shaders/stencil.vs)0
-rwxr-xr-xadvanced_opengl/2.stencil/stencilbin0 -> 1282960 bytes
-rw-r--r--advanced_opengl/2.stencil/stencil.c (renamed from stencil/stencil.c)98
-rwxr-xr-xadvanced_opengl/3.blending/blendingbin0 -> 1287968 bytes
-rw-r--r--advanced_opengl/3.blending/blending.c (renamed from blending/blending.c)154
-rwxr-xr-xadvanced_opengl/3.blending/build.sh (renamed from blending/build.sh)2
-rw-r--r--advanced_opengl/3.blending/shaders/blending.fs (renamed from blending/shaders/blending.fs)0
-rw-r--r--advanced_opengl/3.blending/shaders/blending.vs (renamed from blending/shaders/blending.vs)0
-rw-r--r--advanced_opengl/3.blending/shaders/grass.fs (renamed from blending/shaders/grass.fs)0
-rwxr-xr-xadvanced_opengl/4.face_culling/build.sh (renamed from face_culling/build.sh)2
-rwxr-xr-xadvanced_opengl/4.face_culling/face_cullingbin0 -> 1283048 bytes
-rw-r--r--advanced_opengl/4.face_culling/face_culling.c (renamed from face_culling/face_culling.c)174
-rw-r--r--advanced_opengl/4.face_culling/shaders/face_culling.fs (renamed from face_culling/shaders/face_culling.fs)0
-rw-r--r--advanced_opengl/4.face_culling/shaders/face_culling.vs (renamed from face_culling/shaders/face_culling.vs)0
-rwxr-xr-xadvanced_opengl/5.framebuffers/build.sh (renamed from framebuffers/build.sh)2
-rwxr-xr-xadvanced_opengl/5.framebuffers/framebuffersbin0 -> 1288800 bytes
-rw-r--r--advanced_opengl/5.framebuffers/framebuffers.c (renamed from framebuffers/framebuffers.c)120
-rw-r--r--advanced_opengl/5.framebuffers/shaders/cube.fs (renamed from framebuffers/shaders/cube.fs)0
-rw-r--r--advanced_opengl/5.framebuffers/shaders/cube.vs (renamed from framebuffers/shaders/cube.vs)0
-rw-r--r--advanced_opengl/5.framebuffers/shaders/screen.fs (renamed from framebuffers/shaders/screen.fs)0
-rw-r--r--advanced_opengl/5.framebuffers/shaders/screen.vs (renamed from framebuffers/shaders/screen.vs)0
-rwxr-xr-xadvanced_opengl/6.cubemaps/build.sh5
-rwxr-xr-xadvanced_opengl/6.cubemaps/cubemapsbin0 -> 1288192 bytes
-rw-r--r--advanced_opengl/6.cubemaps/cubemaps.c (renamed from skybox/skybox.c)218
-rw-r--r--advanced_opengl/6.cubemaps/shaders/cube.fs (renamed from skybox/shaders/cube.fs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/cube.vs (renamed from skybox/shaders/cube.vs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/reflection.fs (renamed from skybox/shaders/reflection.fs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/reflection.vs (renamed from skybox/shaders/reflection.vs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/refraction.fs (renamed from skybox/shaders/refraction.fs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/refraction.vs (renamed from skybox/shaders/refraction.vs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/skybox.fs (renamed from skybox/shaders/skybox.fs)0
-rw-r--r--advanced_opengl/6.cubemaps/shaders/skybox.vs (renamed from skybox/shaders/skybox.vs)0
-rwxr-xr-xadvanced_opengl/7.uniform_buffer/build.sh (renamed from uniform_buffer/build.sh)2
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/color_cube.fs (renamed from uniform_buffer/shaders/color_cube.fs)0
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/color_cube.vs (renamed from uniform_buffer/shaders/color_cube.vs)0
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/cube.fs (renamed from uniform_buffer/shaders/cube.fs)0
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/cube.vs (renamed from uniform_buffer/shaders/cube.vs)0
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/skybox.fs (renamed from uniform_buffer/shaders/skybox.fs)0
-rw-r--r--advanced_opengl/7.uniform_buffer/shaders/skybox.vs (renamed from uniform_buffer/shaders/skybox.vs)0
-rwxr-xr-xadvanced_opengl/7.uniform_buffer/uniform_bufferbin0 -> 1288480 bytes
-rw-r--r--advanced_opengl/7.uniform_buffer/uniform_buffer.c (renamed from uniform_buffer/uniform_buffer.c)162
-rwxr-xr-xadvanced_opengl/8.geometry_shader/build.sh (renamed from geometry_shader/build.sh)2
-rwxr-xr-xadvanced_opengl/8.geometry_shader/geometry_shaderbin0 -> 1282800 bytes
-rw-r--r--advanced_opengl/8.geometry_shader/geometry_shader.c (renamed from geometry_shader/geometry_shader.c)158
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/base.fs (renamed from geometry_shader/shaders/base.fs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/base.gs (renamed from geometry_shader/shaders/base.gs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/base.vs (renamed from geometry_shader/shaders/base.vs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/basic.fs (renamed from geometry_shader/shaders/basic.fs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/basic.vs (renamed from geometry_shader/shaders/basic.vs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/explosion.fs (renamed from geometry_shader/shaders/explosion.fs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/explosion.gs (renamed from geometry_shader/shaders/explosion.gs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/explosion.vs (renamed from geometry_shader/shaders/explosion.vs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/normals.fs (renamed from geometry_shader/shaders/normals.fs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/normals.gs (renamed from geometry_shader/shaders/normals.gs)0
-rw-r--r--advanced_opengl/8.geometry_shader/shaders/normals.vs (renamed from geometry_shader/shaders/normals.vs)0
-rwxr-xr-xadvanced_opengl/9.instancing/build.sh (renamed from instancing/build.sh)2
-rwxr-xr-xadvanced_opengl/9.instancing/instancingbin0 -> 1284168 bytes
-rw-r--r--advanced_opengl/9.instancing/instancing.c (renamed from instancing/instancing.c)102
-rw-r--r--advanced_opengl/9.instancing/shaders/default.fs (renamed from instancing/shaders/default.fs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/default.vs (renamed from instancing/shaders/default.vs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instanced_arrays.fs (renamed from instancing/shaders/instanced_arrays.fs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instanced_arrays.vs (renamed from instancing/shaders/instanced_arrays.vs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instanced_mat4.fs (renamed from instancing/shaders/instanced_mat4.fs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instanced_mat4.vs (renamed from instancing/shaders/instanced_mat4.vs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instancing_uniform_array.fs (renamed from instancing/shaders/instancing_uniform_array.fs)0
-rw-r--r--advanced_opengl/9.instancing/shaders/instancing_uniform_array.vs (renamed from instancing/shaders/instancing_uniform_array.vs)0
-rw-r--r--config4
-rw-r--r--data/models/cube.mtl (renamed from mesh_loading_test/what_cube/what_cube.mtl)5
-rw-r--r--data/models/cube.obj40
-rw-r--r--data/textures/oak_veneer_01_diff_4k.jpgbin0 -> 12587069 bytes
-rwxr-xr-xdepth/build.sh4
-rw-r--r--libs/common.h77
-rw-r--r--libs/glfw/include/GLFW/glfw3.h12274
-rw-r--r--libs/pwyazh/mesh.h19
-rw-r--r--libs/pwyazh/pwyazh.h2
-rw-r--r--libs/pwyazh/pwyazh_GL.h8
-rw-r--r--libs/pwyazh/types.h14
-rwxr-xr-xmesh_loading_test/build.sh5
-rw-r--r--mesh_loading_test/shaders/default.fs13
-rw-r--r--mesh_loading_test/what_cube/pryazha.jpgbin26926 -> 0 bytes
-rw-r--r--mesh_loading_test/what_cube/what_cube.obj56
105 files changed, 7715 insertions, 6954 deletions
diff --git a/advanced_lighting/blinn_phong/.blinn_phong.c.swp b/advanced_lighting/blinn_phong/.blinn_phong.c.swp
new file mode 100644
index 0000000..d1ba9b1
--- /dev/null
+++ b/advanced_lighting/blinn_phong/.blinn_phong.c.swp
Binary files differ
diff --git a/advanced_lighting/blinn_phong/blinn_phong b/advanced_lighting/blinn_phong/blinn_phong
new file mode 100755
index 0000000..1c89f59
--- /dev/null
+++ b/advanced_lighting/blinn_phong/blinn_phong
Binary files differ
diff --git a/advanced_lighting/blinn_phong/blinn_phong.c b/advanced_lighting/blinn_phong/blinn_phong.c
new file mode 100644
index 0000000..88bd294
--- /dev/null
+++ b/advanced_lighting/blinn_phong/blinn_phong.c
@@ -0,0 +1,210 @@
+#include "pwyazh.h"
+
+#include "GL/glew.h"
+#include "GLFW/glfw3.h"
+
+#include "pwyazh_GL.h"
+
+#include "common.h"
+
+static S32 global_width = 1024, global_height = 768;
+static Input global_input;
+static V3F camera_dp = (V3F){ 0.0f, 0.0f, 0.0f };
+
+void
+key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
+{
+ switch (action)
+ {
+ case GLFW_PRESS: {
+ switch (key)
+ {
+ case GLFW_KEY_D: {
+ global_input.move_right.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_W: {
+ global_input.move_forward.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_A: {
+ global_input.move_left.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_S: {
+ global_input.move_backward.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_E: {
+ global_input.move_up.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_SPACE: {
+ global_input.jump.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_PRESS;
+ } break;
+ }
+ } break;
+
+ case GLFW_RELEASE: {
+ switch (key)
+ {
+ case GLFW_KEY_D: {
+ global_input.move_right.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_W: {
+ global_input.move_forward.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_A: {
+ global_input.move_left.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_S: {
+ global_input.move_backward.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_E: {
+ global_input.move_up.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_SPACE: {
+ global_input.jump.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_RELEASE;
+ } break;
+ }
+ } break;
+ }
+}
+
+void
+resize_callback(GLFWwindow* window, int width, int height)
+{
+ global_width = width;
+ global_height = height;
+ glViewport(0, 0, global_width, global_height);
+}
+
+void
+error_callback(int error, const char *desc)
+{
+ fprintf(stderr, "[ERROR] GLFW: %s\n", desc);
+}
+
+void
+update(State *state)
+{
+ V3F camera_dv = get_dv_camera_orbital(&global_input, state->camera.pos,
+ v3f_zero(), state->dt, 2.0f);
+ camera_dp = v3f_add(camera_dp, camera_dv);
+ camera_dp = v3f_scalef(camera_dp, 0.8f);
+ state->camera.pos = v3f_add(state->camera.pos, camera_dp);
+
+ input_update_last_state(&global_input);
+}
+
+void
+render(State *state, U32 shader, U32 texture)
+{
+ MAT4 projection, view, model;
+
+ glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
+ glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
+
+ projection = perspective(state->camera.fovx, (F32)global_width/(F32)global_height,
+ state->camera.near, state->camera.far);
+ view = look_at(state->camera.pos, v3f_zero(), v3f(0.0f, 1.0f, 0.0f));
+ model = mat4_identity();
+
+ glUseProgram(shader);
+ shader_set_mat4fv(shader, "projection", projection);
+ shader_set_mat4fv(shader, "view", view);
+ shader_set_mat4fv(shader, "model", model);
+ glBindTexture(GL_TEXTURE_2D, texture);
+ mesh_draw(state->mesh);
+ glBindTexture(GL_TEXTURE_2D, 0);
+ glUseProgram(0);
+}
+
+int
+main(void)
+{
+ GLFWwindow *window;
+ Arena *arena;
+ State state;
+ F64 time, last_time;
+
+ glfwSetErrorCallback(error_callback);
+
+ if (glfwInit() == GLFW_FALSE)
+ return(1);
+
+ glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
+ glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
+ glfwWindowHint(GLFW_SAMPLES, 4);
+ window = glfwCreateWindow(global_width, global_height, "Blinn-Phong shading", 0, 0);
+ if (!window)
+ goto error;
+
+ glfwSetKeyCallback(window, key_callback);
+ glfwSetWindowSizeCallback(window, resize_callback);
+
+ glfwMakeContextCurrent(window);
+
+ if (glewInit() != GLEW_OK)
+ goto error;
+
+ glEnable(GL_DEPTH_TEST);
+ glEnable(GL_MULTISAMPLE);
+
+ glEnable(GL_CULL_FACE);
+
+ /* NOTE(pryazha): init */
+ arena = arena_alloc(Megabytes(64));
+
+ state.camera = (Camera) {v3f(0.0f, 0.0f, 3.0f), 90.0f, 0.1f, 1000.0f };
+
+ U32 blinn_phong_shader = create_shader_program("shaders/blinn_phong.vs",
+ "shaders/blinn_phong.fs");
+ U32 mesh_texture_diffuse = load_texture("../../data/textures/oak_veneer_01_diff_4k.jpg");
+ state.mesh = mesh_load_obj(arena, "../../data/models/cube.obj");
+
+ last_time = glfwGetTime();
+
+ while (!glfwWindowShouldClose(window))
+ {
+ glfwPollEvents();
+ if (key_first_press(global_input.exit))
+ glfwSetWindowShouldClose(window, GLFW_TRUE);
+ update(&state);
+ render(&state, blinn_phong_shader, mesh_texture_diffuse);
+ glfwSwapBuffers(window);
+
+ time = glfwGetTime();
+ state.dt = time-last_time;
+ last_time = time;
+#if 0
+ fprintf(stdout, "[INFO]: dt: %f\n", state.dt);
+#endif
+ }
+
+ glfwTerminate();
+ return(0);
+
+ error:
+ glfwTerminate();
+ return(1);
+}
diff --git a/advanced_lighting/blinn_phong/build.sh b/advanced_lighting/blinn_phong/build.sh
new file mode 100755
index 0000000..21a65b4
--- /dev/null
+++ b/advanced_lighting/blinn_phong/build.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+. ../../config
+TARGET='blinn_phong'
+set -x
+gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_lighting/blinn_phong/shaders/.blinn_phong.fs.swp b/advanced_lighting/blinn_phong/shaders/.blinn_phong.fs.swp
new file mode 100644
index 0000000..cfc93b0
--- /dev/null
+++ b/advanced_lighting/blinn_phong/shaders/.blinn_phong.fs.swp
Binary files differ
diff --git a/advanced_lighting/blinn_phong/shaders/blinn_phong.fs b/advanced_lighting/blinn_phong/shaders/blinn_phong.fs
new file mode 100644
index 0000000..23e2968
--- /dev/null
+++ b/advanced_lighting/blinn_phong/shaders/blinn_phong.fs
@@ -0,0 +1,62 @@
+#version 330 core
+
+in vec2 tex_coords;
+in vec3 normal;
+in vec3 frag_pos;
+
+out vec4 frag_color;
+
+uniform sampler2D texture_diffuse;
+uniform sampler2D texture_specular;
+
+uniform vec3 light_pos;
+uniform vec3 view_pos;
+
+uniform float ambient_strength;
+uniform float specular_strength;
+uniform float shininess;
+
+vec4
+spotlight(vec3 light_dir, vec3 view_dir)
+{
+ vec3 tex_color_diff = texture(texture_diffuse, tex_coords);
+ float ambient_strength = 0.1f;
+ vec4 ambient = tex_color_diff*ambient_strength;
+ vec4 diffuse = tex_color_diff*dot(-light_dir, )
+ return(color);
+}
+
+vec4
+blinn_phong()
+{
+ // Sample the diffuse color from the texture
+ vec3 diffuse_color = texture(texture_diffuse, tex_coords).rgb;
+
+ // Sample the specular color from the texture (if available)
+ vec3 specular_color = texture(texture_specular, tex_coords).rgb;
+
+ // Ambient lighting
+ vec3 ambient = ambient_strength*diffuse_color;
+
+ // Diffuse lighting
+ vec3 norm = normalize(normal);
+ vec3 light_dir = normalize(light_pos-frag_pos);
+ float diff = max(dot(norm, light_dir), 0.0);
+ vec3 diffuse = diff * diffuse_color;
+
+ // Specular lighting
+ vec3 view_dir = normalize(view_pos-frag_pos);
+ vec3 halfway_dir = normalize(light_dir+view_dir); // Halfway vector
+ float spec = pow(max(dot(norm, halfway_dir), 0.0), shininess);
+ vec3 specular = specular_strength*spec*specular_color;
+
+ // Combine all components
+ vec3 result = (ambient+diffuse+specular);
+ return((result, 1.0));
+}
+
+void
+main(void)
+{
+ frag_color = blinn_phong();
+}
diff --git a/advanced_lighting/blinn_phong/shaders/blinn_phong.vs b/advanced_lighting/blinn_phong/shaders/blinn_phong.vs
new file mode 100644
index 0000000..d4e5dbc
--- /dev/null
+++ b/advanced_lighting/blinn_phong/shaders/blinn_phong.vs
@@ -0,0 +1,21 @@
+#version 330 core
+layout(location = 0) in vec3 apos;
+layout(location = 1) in vec3 anormal;
+layout(location = 2) in vec2 atex_coords;
+
+out vec3 frag_pos;
+out vec3 normal;
+out vec2 tex_coords;
+
+uniform mat4 projection;
+uniform mat4 view;
+uniform mat4 model;
+
+void
+main(void)
+{
+ frag_pos = vec3(model*vec4(apos, 1.0f);
+ normal = mat3(transpose(inverse(view*model)))*anormal;
+ tex_coords = atex_coords;
+ gl_Position = projection*view*model*vec4(apos, 1.0f);
+}
diff --git a/skybox/build.sh b/advanced_opengl/1.depth/build.sh
index 64a00ee..837b21c 100755
--- a/skybox/build.sh
+++ b/advanced_opengl/1.depth/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
-TARGET='skybox'
+. ../../config
+TARGET='depth'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/1.depth/depth b/advanced_opengl/1.depth/depth
new file mode 100755
index 0000000..db67630
--- /dev/null
+++ b/advanced_opengl/1.depth/depth
Binary files differ
diff --git a/depth/depth.c b/advanced_opengl/1.depth/depth.c
index b0cea85..eb79c1c 100644
--- a/depth/depth.c
+++ b/advanced_opengl/1.depth/depth.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -42,7 +44,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -73,13 +75,13 @@ int
main(void)
{
GLFWwindow *window;
-
+
if (glfwInit() == GLFW_FALSE)
{
fprintf(stderr, "[ERROR] Failed to initialize glfw.\n");
return(1);
}
-
+
glfwWindowHint(GLFW_RESIZABLE, 0);
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
@@ -91,25 +93,25 @@ main(void)
glfwTerminate();
return(1);
}
-
+
glfwMakeContextCurrent(window);
-
+
glfwSetKeyCallback(window, key_callback);
-
+
if (glewInit() != GLEW_OK)
{
fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
glfwTerminate();
return(1);
}
-
+
glEnable(GL_DEPTH_TEST);
glDepthFunc(GL_LESS);
-
+
U32 shader = create_shader_program("shaders/depth.vs", "shaders/depth.fs");
- U32 marble_texture = load_texture("../data/textures/marble.jpg");
- U32 metal_texture = load_texture("../data/textures/metal.png");
-
+ U32 marble_texture = load_texture("../../data/textures/marble.jpg");
+ U32 metal_texture = load_texture("../../data/textures/metal.png");
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
@@ -118,35 +120,35 @@ main(void)
a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
a, -a, a, 1.0f, 0.0f,
a, a, a, 1.0f, 1.0f,
a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
+
a, a, a, 1.0f, 0.0f,
a, a, -a, 1.0f, 1.0f,
a, -a, -a, 0.0f, 1.0f,
a, -a, -a, 0.0f, 1.0f,
a, -a, a, 0.0f, 0.0f,
a, a, a, 1.0f, 0.0f,
-
+
-a, -a, -a, 0.0f, 1.0f,
a, -a, -a, 1.0f, 1.0f,
a, -a, a, 1.0f, 0.0f,
a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
a, a, -a, 1.0f, 1.0f,
a, a, a, 1.0f, 0.0f,
@@ -154,53 +156,53 @@ main(void)
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform cube_positions[] = {
transform_default(),
transform_make_translate(v3f(a, 0.0f, -4*a))
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 VAO, VBO;
glGenVertexArrays(1, &VAO);
glBindVertexArray(VAO);
-
+
glGenBuffers(1, &VBO);
glBindBuffer(GL_ARRAY_BUFFER, VBO);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
-
+
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
-
+
glBindVertexArray(0);
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 0.0f, 3.0f);
-
+
/* glPolygonMode(GL_FRONT_AND_BACK, GL_LINE); */
-
+
F32 last_time = glfwGetTime();
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
-
+
/* INFO(pryazha): update */
V3F left, up, forward;
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
-
+
forward = v3f_norm(v3f_sub(v3f(0.0f, 0.0f, 0.0f), camera_pos));
left = v3f_norm(v3f_cross(world_up, forward));
up = v3f_cross(forward, left);
-
+
V3F dp = v3f_zero();
-
+
F32 speed = 2.0f;
if (key_is_pressed(input.move_right))
dp = v3f_add(dp, v3f_scalef(left, -speed*dt));
@@ -214,47 +216,47 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, speed*dt));
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
-
+
input_update_last_state(&input);
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
/* INFO(pryazha): render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
glUseProgram(shader);
MAT4 model, view, projection;
-
+
view = look_at(camera_pos, v3f(0.0f, 0.0f, 0.0f), v3f(0.0f, 1.0f, 0.0f));
shader_set_mat4fv(shader, "view", view);
-
+
/* projection = ortho(-5.0f, 5.0f, -5.0f, 5.0f, 0.1f, 100.0f); */
F32 fovx = 90.0f;
F32 near = 0.1f;
F32 far = 100.0f;
projection = perspective(fovx, (F32)WIDTH/(F32)HEIGHT, near, far);
-
+
shader_set_mat4fv(shader, "projection", projection);
-
+
glBindTexture(GL_TEXTURE_2D, marble_texture);
glBindVertexArray(VAO);
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(cube_positions);
++transform_index)
- {
+ {
model = transform_apply(cube_positions[transform_index]);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
glBindTexture(GL_TEXTURE_2D, metal_texture);
model = transform_apply(platform_position);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf) {
U32 sleep_time = (U32)(target_spf-elapsed);
@@ -266,7 +268,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/depth/shaders/depth.fs b/advanced_opengl/1.depth/shaders/depth.fs
index 2f3d9ca..2f3d9ca 100644
--- a/depth/shaders/depth.fs
+++ b/advanced_opengl/1.depth/shaders/depth.fs
diff --git a/depth/shaders/depth.vs b/advanced_opengl/1.depth/shaders/depth.vs
index d3d92d1..d3d92d1 100644
--- a/depth/shaders/depth.vs
+++ b/advanced_opengl/1.depth/shaders/depth.vs
diff --git a/advanced_opengl/10.antialiasing/anti_aliasing_msaa b/advanced_opengl/10.antialiasing/anti_aliasing_msaa
new file mode 100755
index 0000000..d0afd7e
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/anti_aliasing_msaa
Binary files differ
diff --git a/mesh_loading_test/mesh_loading_test.c b/advanced_opengl/10.antialiasing/anti_aliasing_msaa.c
index 5284dd2..9fcb645 100644
--- a/mesh_loading_test/mesh_loading_test.c
+++ b/advanced_opengl/10.antialiasing/anti_aliasing_msaa.c
@@ -3,11 +3,13 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
-#define WIDTH 1024
-#define HEIGHT 768
+#include <unistd.h>
+static S32 global_width = 1024, global_height = 768;
static Input global_input;
void
@@ -30,15 +32,24 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
case GLFW_KEY_S: {
global_input.move_backward.state = KeyState_PRESS;
} break;
- case GLFW_KEY_Q: {
- global_input.move_down.state = KeyState_PRESS;
- } break;
case GLFW_KEY_E: {
global_input.move_up.state = KeyState_PRESS;
} break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_PRESS;
+ } break;
case GLFW_KEY_SPACE: {
global_input.jump.state = KeyState_PRESS;
} break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_PRESS;
+ } break;
}
} break;
@@ -57,24 +68,48 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
case GLFW_KEY_S: {
global_input.move_backward.state = KeyState_RELEASE;
} break;
- case GLFW_KEY_Q: {
- global_input.move_down.state = KeyState_RELEASE;
- } break;
case GLFW_KEY_E: {
global_input.move_up.state = KeyState_RELEASE;
} break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_RELEASE;
+ } break;
case GLFW_KEY_SPACE: {
global_input.jump.state = KeyState_RELEASE;
} break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_RELEASE;
+ } break;
}
} break;
}
}
+void
+window_resize_callback(GLFWwindow* window, int width, int height)
+{
+ global_width = width;
+ global_height = height;
+ glViewport(0, 0, global_width, global_height);
+}
+
int
main(void)
{
GLFWwindow *window;
+ Arena *arena = 0;
+ F32 target_fps, target_spf,
+ last_time, dt;
+ MAT4 projection, view, model;
+ V3F camera_pos;
+ F32 camera_speed, fovx, near, far;
+ U32 color_shader;
if (glfwInit() == GLFW_FALSE)
{
@@ -82,11 +117,11 @@ main(void)
return(1);
}
- glfwWindowHint(GLFW_RESIZABLE, 0);
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ glfwWindowHint(GLFW_SAMPLES, 4);
+ window = glfwCreateWindow(global_width, global_height, "Anti Aliasing (MSAA)", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
@@ -95,7 +130,9 @@ main(void)
}
glfwMakeContextCurrent(window);
+
glfwSetKeyCallback(window, key_callback);
+ glfwSetWindowSizeCallback(window, window_resize_callback);
if (glewInit() != GLEW_OK)
{
@@ -104,67 +141,52 @@ main(void)
return(1);
}
- U32 shader = create_shader_program("shaders/default.vs", "shaders/default.fs");
+ glEnable(GL_DEPTH_TEST);
+ glEnable(GL_MULTISAMPLE);
- Arena *arena = arena_alloc(Megabytes(512));
+ arena = arena_alloc(Megabytes(64));
- Mesh *what_cube_mesh = mesh_load_obj(arena, "what_cube/what_cube.obj");
- U32 what_cube_texture = load_texture("what_cube/pryazha.jpg");
+ Mesh *cube_mesh = mesh_load_obj(arena, "../../data/models/cube.obj");
+ color_shader = create_shader_program("shaders/color.vs",
+ "shaders/color.fs");
- F32 target_fps = 60.0f;
- F32 target_spf = 1.0f/target_fps;
- F32 dt = 0.0f;
- F32 last_time = glfwGetTime();
- F32 time = last_time;
+ target_fps = 60.0f;
+ target_spf = 1.0f/target_fps;
- MAT4 projection, view, model;
- projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
- model = mat4_identity();
+ camera_pos = v3f(0.0f, 0.0f, 3.0f);
+ camera_speed = 2.0f;
+ fovx = 90.0f;
+ near = 0.1f;
+ far = 1000.0f;
- V3F camera_pos = v3f(0.0f, 0.0f, 3.0f);
-
- glEnable(GL_DEPTH_TEST);
+ last_time = glfwGetTime();
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
/* NOTE(pryazha): Update */
- V3F f = v3f_norm(v3f_sub(v3f(0.0f, 0.0f, 0.0f), camera_pos));
- V3F l = v3f_norm(v3f_cross(v3f(0.0f, 1.0f, 0.0f), f));
- V3F u = v3f_cross(f, l);
-
- V3F dp = v3f_zero();
- F32 speed = 2.0f;
- if (key_is_pressed(global_input.move_right))
- dp = v3f_sub(dp, l);
- if (key_is_pressed(global_input.move_forward))
- dp = v3f_add(dp, f);
- if (key_is_pressed(global_input.move_left))
- dp = v3f_add(dp, l);
- if (key_is_pressed(global_input.move_backward))
- dp = v3f_sub(dp, f);
- if (key_is_pressed(global_input.move_up))
- dp = v3f_add(dp, u);
- if (key_is_pressed(global_input.move_down))
- dp = v3f_sub(dp, u);
+ if (key_is_pressed(global_input.exit))
+ glfwSetWindowShouldClose(window, GLFW_TRUE);
- camera_pos = v3f_add(camera_pos, v3f_scalef(dp, speed*dt));
+ camera_pos = update_camera_orbital(global_input,
+ camera_pos, v3f_zero(),
+ dt, camera_speed);
+ projection = perspective(fovx, (F32)global_width/(F32)global_height, near, far);
view = look_at(camera_pos, v3f_zero(), v3f(0.0f, 1.0f, 0.0f));
+ model = mat4_identity();
input_update_last_state(&global_input);
/* NOTE(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
- glUseProgram(shader);
- shader_set_mat4fv(shader, "projection", projection);
- shader_set_mat4fv(shader, "view", view);
- shader_set_mat4fv(shader, "model", model);
- glBindTexture(GL_TEXTURE_2D, what_cube_texture);
- mesh_draw(what_cube_mesh);
+ glUseProgram(color_shader);
+ shader_set_mat4fv(color_shader, "projection", projection);
+ shader_set_mat4fv(color_shader, "view", view);
+ shader_set_mat4fv(color_shader, "model", model);
+ mesh_draw(cube_mesh);
glfwSwapBuffers(window);
@@ -177,7 +199,6 @@ main(void)
}
F32 current_time = glfwGetTime();
dt = current_time-last_time;
- time += dt;
last_time = current_time;
}
diff --git a/advanced_opengl/10.antialiasing/anti_aliasing_offscreen b/advanced_opengl/10.antialiasing/anti_aliasing_offscreen
new file mode 100755
index 0000000..72be7e2
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/anti_aliasing_offscreen
Binary files differ
diff --git a/advanced_opengl/10.antialiasing/anti_aliasing_offscreen.c b/advanced_opengl/10.antialiasing/anti_aliasing_offscreen.c
new file mode 100644
index 0000000..91a26f9
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/anti_aliasing_offscreen.c
@@ -0,0 +1,276 @@
+#include "GL/glew.h"
+#include "GLFW/glfw3.h"
+
+#include "pwyazh.h"
+
+#include "pwyazh_GL.h"
+
+#include "common.h"
+
+#include <unistd.h>
+
+#define WIDTH 1024
+#define HEIGHT 768
+static Input global_input;
+
+void
+key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
+{
+ switch (action)
+ {
+ case GLFW_PRESS: {
+ switch (key)
+ {
+ case GLFW_KEY_D: {
+ global_input.move_right.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_W: {
+ global_input.move_forward.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_A: {
+ global_input.move_left.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_S: {
+ global_input.move_backward.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_E: {
+ global_input.move_up.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_SPACE: {
+ global_input.jump.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_PRESS;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_PRESS;
+ } break;
+ }
+ } break;
+
+ case GLFW_RELEASE: {
+ switch (key)
+ {
+ case GLFW_KEY_D: {
+ global_input.move_right.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_W: {
+ global_input.move_forward.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_A: {
+ global_input.move_left.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_S: {
+ global_input.move_backward.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_E: {
+ global_input.move_up.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_Q: {
+ global_input.move_down.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_SPACE: {
+ global_input.jump.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_RIGHT: {
+ global_input.action_right.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_LEFT: {
+ global_input.action_left.state = KeyState_RELEASE;
+ } break;
+ case GLFW_KEY_ESCAPE: {
+ global_input.exit.state = KeyState_RELEASE;
+ } break;
+ }
+ } break;
+ }
+}
+
+int
+main(void)
+{
+ GLFWwindow *window;
+ Arena *arena = 0;
+ F32 target_fps, target_spf,
+ last_time, dt;
+ MAT4 projection, view, model;
+ V3F camera_pos;
+ F32 camera_speed, fovx, near, far;
+ U32 fbo, intermediate_fbo, color_tex,
+ screen_texture, rbo,
+ quad_vao, vbo,
+ color_shader, screen_shader;
+
+ if (glfwInit() == GLFW_FALSE)
+ {
+ fprintf(stderr, "[ERROR] Failed to initialize glfw.\n");
+ return(1);
+ }
+
+ glfwWindowHint(GLFW_RESIZABLE, GL_FALSE);
+ glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
+ glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
+ glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Anti Aliasing (Off-screen)", 0, 0);
+ if (!window)
+ {
+ fprintf(stderr, "[ERROR] Failed to create window.\n");
+ glfwTerminate();
+ return(1);
+ }
+
+ glfwMakeContextCurrent(window);
+
+ glfwSetKeyCallback(window, key_callback);
+
+ if (glewInit() != GLEW_OK)
+ {
+ fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
+ glfwTerminate();
+ return(1);
+ }
+
+ arena = arena_alloc(Megabytes(64));
+
+ Mesh *cube_mesh = mesh_load_obj(arena, "../../data/models/cube.obj");
+ color_shader = create_shader_program("shaders/color.vs",
+ "shaders/color.fs");
+ screen_shader = create_shader_program("shaders/screen.vs",
+ "shaders/screen.fs");
+ glGenFramebuffers(1, &fbo);
+ glBindFramebuffer(GL_FRAMEBUFFER, fbo);
+ glGenTextures(1, &color_tex);
+ glBindTexture(GL_TEXTURE_2D_MULTISAMPLE, color_tex);
+ glTexImage2DMultisample(GL_TEXTURE_2D_MULTISAMPLE, 4, GL_RGB,
+ WIDTH, HEIGHT, GL_TRUE);
+ glBindTexture(GL_TEXTURE_2D_MULTISAMPLE, 0);
+ glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
+ GL_TEXTURE_2D_MULTISAMPLE, color_tex, 0);
+ glGenRenderbuffers(1, &rbo);
+ glBindRenderbuffer(GL_RENDERBUFFER, rbo);
+ glRenderbufferStorageMultisample(GL_RENDERBUFFER, 4, GL_DEPTH24_STENCIL8,
+ WIDTH, HEIGHT);
+ glBindRenderbuffer(GL_RENDERBUFFER, 0);
+ glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_STENCIL_ATTACHMENT,
+ GL_RENDERBUFFER, rbo);
+ if (glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE)
+ fprintf(stderr, "[ERROR]: Framebuffer is not complete.\n");
+ fprintf(stdout, "[INFO]: Multisample fbo complete.\n");
+ glBindFramebuffer(GL_FRAMEBUFFER, 0);
+
+ glGenFramebuffers(1, &intermediate_fbo);
+ glBindFramebuffer(GL_FRAMEBUFFER, intermediate_fbo);
+ glGenTextures(1, &screen_texture);
+ glBindTexture(GL_TEXTURE_2D, screen_texture);
+ glTexImage2D(GL_TEXTURE_2D, 0, GL_RGB, WIDTH, HEIGHT,
+ 0, GL_RGB, GL_UNSIGNED_BYTE, 0);
+ glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
+ glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
+ glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
+ GL_TEXTURE_2D, screen_texture, 0);
+ if (glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE)
+ fprintf(stderr, "[ERROR]: Framebuffer is not complete.\n");
+ fprintf(stdout, "[INFO]: Intermediate fbo complete.\n");
+ glBindFramebuffer(GL_FRAMEBUFFER, 0);
+
+ F32 quad_vertices[] = {
+ -1.0f, -1.0f, 0.0f, 0.0f, 0.0f,
+ 1.0f, -1.0f, 0.0f, 1.0f, 0.0f,
+ 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
+ -1.0f, -1.0f, 0.0f, 0.0f, 0.0f,
+ 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
+ -1.0f, 1.0f, 0.0f, 0.0f, 1.0f
+ };
+
+ glGenVertexArrays(1, &quad_vao);
+ glBindVertexArray(quad_vao);
+ glGenBuffers(1, &vbo);
+ glBindBuffer(GL_ARRAY_BUFFER, vbo);
+ glBufferData(GL_ARRAY_BUFFER, sizeof(quad_vertices), quad_vertices, GL_STATIC_DRAW);
+ glEnableVertexAttribArray(0);
+ glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
+ glEnableVertexAttribArray(1);
+ glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
+ glBindVertexArray(0);
+
+ target_fps = 60.0f;
+ target_spf = 1.0f/target_fps;
+
+ camera_pos = v3f(0.0f, 0.0f, 3.0f);
+ camera_speed = 2.0f;
+ fovx = 90.0f;
+ near = 0.1f;
+ far = 1000.0f;
+
+ last_time = glfwGetTime();
+
+ while (!glfwWindowShouldClose(window))
+ {
+ glfwPollEvents();
+
+ /* NOTE(pryazha): Update */
+ if (key_is_pressed(global_input.exit))
+ glfwSetWindowShouldClose(window, GLFW_TRUE);
+
+ camera_pos = update_camera_orbital(global_input,
+ camera_pos, v3f_zero(),
+ dt, camera_speed);
+
+ projection = perspective(fovx, (F32)WIDTH/(F32)HEIGHT, near, far);
+ view = look_at(camera_pos, v3f_zero(), v3f(0.0f, 1.0f, 0.0f));
+ model = mat4_identity();
+
+ input_update_last_state(&global_input);
+
+ /* NOTE(pryazha): Render */
+ glBindFramebuffer(GL_FRAMEBUFFER, fbo);
+ glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
+ glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
+ glEnable(GL_DEPTH_TEST);
+ glUseProgram(color_shader);
+ shader_set_mat4fv(color_shader, "projection", projection);
+ shader_set_mat4fv(color_shader, "view", view);
+ shader_set_mat4fv(color_shader, "model", model);
+ mesh_draw(cube_mesh);
+
+ glBindFramebuffer(GL_READ_FRAMEBUFFER, fbo);
+ glBindFramebuffer(GL_DRAW_FRAMEBUFFER, intermediate_fbo);
+ /* TODO(pryazha): Update width and height */
+ glBlitFramebuffer(0, 0, WIDTH, HEIGHT,
+ 0, 0, WIDTH, HEIGHT,
+ GL_COLOR_BUFFER_BIT, GL_NEAREST);
+
+ glBindFramebuffer(GL_FRAMEBUFFER, 0);
+ glClearColor(1.0f, 1.0f, 1.0f, 1.0f);
+ glClear(GL_COLOR_BUFFER_BIT);
+ glUseProgram(screen_shader);
+ glDisable(GL_DEPTH_TEST);
+ glBindTexture(GL_TEXTURE_2D, screen_texture);
+ glBindVertexArray(quad_vao);
+ glDrawArrays(GL_TRIANGLES, 0, 6);
+ glBindVertexArray(0);
+
+ glfwSwapBuffers(window);
+
+ F32 elapsed = glfwGetTime()-last_time;
+ if (elapsed < target_spf)
+ {
+ U32 sleep_time = (U32)(target_spf-elapsed);
+ if (sleep_time > 0)
+ sleep(sleep_time);
+ }
+ F32 current_time = glfwGetTime();
+ dt = current_time-last_time;
+ last_time = current_time;
+ }
+
+ arena_release(arena);
+ glfwTerminate();
+ return(0);
+}
diff --git a/advanced_opengl/10.antialiasing/build.sh b/advanced_opengl/10.antialiasing/build.sh
new file mode 100755
index 0000000..9d1011a
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/build.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+. ../../config
+set -x
+gcc -o anti_aliasing_msaa $CFLAGS $INCLUDE $LFLAGS anti_aliasing_msaa.c $LIBS
+gcc -o anti_aliasing_offscreen $CFLAGS $INCLUDE $LFLAGS anti_aliasing_offscreen.c $LIBS
diff --git a/stencil/shaders/outline.fs b/advanced_opengl/10.antialiasing/shaders/color.fs
index b935555..b935555 100644
--- a/stencil/shaders/outline.fs
+++ b/advanced_opengl/10.antialiasing/shaders/color.fs
diff --git a/mesh_loading_test/shaders/default.vs b/advanced_opengl/10.antialiasing/shaders/color.vs
index 90e883a..ade669b 100644
--- a/mesh_loading_test/shaders/default.vs
+++ b/advanced_opengl/10.antialiasing/shaders/color.vs
@@ -1,8 +1,5 @@
#version 330 core
layout(location = 0) in vec3 apos;
-layout(location = 2) in vec2 atex_coords;
-
-out vec2 tex_coords;
uniform mat4 projection;
uniform mat4 view;
@@ -11,6 +8,5 @@ uniform mat4 model;
void
main(void)
{
- tex_coords = atex_coords;
gl_Position = projection*view*model*vec4(apos, 1.0);
}
diff --git a/advanced_opengl/10.antialiasing/shaders/screen.fs b/advanced_opengl/10.antialiasing/shaders/screen.fs
new file mode 100644
index 0000000..8fefa24
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/shaders/screen.fs
@@ -0,0 +1,122 @@
+#version 330 core
+
+out vec4 frag_color;
+
+in vec2 tex_coords;
+
+uniform sampler2D texture1;
+
+vec4
+inversion()
+{
+ vec4 result = vec4(1.0f-vec3(texture(texture1, tex_coords)), 1.0f);
+ return(result);
+}
+
+vec4
+grayscale_average()
+{
+ vec4 tex_color = texture(texture1, tex_coords);
+ float average = (tex_color.r+tex_color.g+tex_color.b)/3.0f;
+ vec4 result = vec4(average, average, average, 1.0f);
+ return(result);
+}
+
+vec4
+grayscale_weights()
+{
+ vec4 tex_color = texture(texture1, tex_coords);
+ float average = 0.2126*tex_color.r+0.7152*tex_color.g+0.0722f*tex_color.b;
+ vec4 result = vec4(average, average, average, 1.0f);
+ return(result);
+}
+
+const float offset = 1.0f/300.0f;
+
+vec4
+kernel_effect(float[9] kernel)
+{
+ vec2 offsets[9] = vec2[](
+ vec2(-offset, offset), /* top-left */
+ vec2(0.0f, offset), /* top-center */
+ vec2(offset, offset), /* top-right */
+ vec2(-offset, 0.0f), /* center-left */
+ vec2(0.0f, 0.0f), /* center-center */
+ vec2(offset, 0.0f), /* center-right */
+ vec2(-offset, -offset), /* bottom-left */
+ vec2(0.0f, -offset), /* bottom-center */
+ vec2(offset, -offset) /* bottom-right */
+ );
+
+ vec3 sample_texture[9];
+ for (int offset_index = 0;
+ offset_index < 9;
+ ++offset_index)
+ {
+ sample_texture[offset_index] =
+ vec3(texture(texture1, tex_coords+offsets[offset_index]));
+ }
+
+ vec3 color = vec3(0.0f);
+ for (int i = 0; i < 9; ++i)
+ color += sample_texture[i]*kernel[i];
+
+ return(vec4(color, 1.0f));
+}
+
+void
+main(void)
+{
+ float strange_kernel[9] = float[](
+ -1, -1, -1,
+ -1, 9, -1,
+ -1, -1, -1
+ );
+
+ float gaussian_blur_kernel[9] = float[](
+ 1.0f/16.0f, 2.0f/16.0f, 1.0f/16.0f,
+ 2.0f/16.0f, 4.0f/16.0f, 2.0f/16.0f,
+ 1.0f/16.0f, 2.0f/16.0f, 1.0f/16.0f
+ );
+
+ float box_blur_kernel[9] = float[](
+ 1.0f/9.0f, 1.0f/9.0f, 1.0f/9.0f,
+ 1.0f/9.0f, 1.0f/9.0f, 1.0f/9.0f,
+ 1.0f/9.0f, 1.0f/9.0f, 1.0f/9.0f
+ );
+
+ float edge_detection_kernel[9] = float[](
+ 1.0f, 1.0f, 1.0f,
+ 1.0f, -8.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f
+ );
+
+ float sharpening_kernel[9] = float[](
+ 0.0f, -1.0f, 0.0f,
+ -1.0f, 5.0f, -1.0f,
+ 0.0f, -1.0f, 0.0f
+ );
+
+ float sobel_kernel_vertical[9] = float[](
+ -1.0f, 0.0f, 1.0f,
+ -2.0f, 0.0f, 2.0f,
+ -1.0f, 0.0f, 0.0f
+ );
+ float sobel_kernel_horizontal[9] = float[](
+ -1.0f, -2.0f, -1.0f,
+ 0.0f, 0.0f, 0.0f,
+ 1.0f, 2.0f, 1.0f
+ );
+
+ float funny_kernel[9] = float[](
+ 1.0f, 1.0f, 1.0f,
+ 1.0f, -4.0f, 1.0f,
+ 1.0f, 1.0f, 1.0f
+ );
+
+ /*
+ frag_color = kernel_effect(funny_kernel);
+ frag_color *= vec4(0.76f, 0.47f, 0.84f, 1.0f);
+ */
+ frag_color = grayscale_weights();
+}
diff --git a/advanced_opengl/10.antialiasing/shaders/screen.vs b/advanced_opengl/10.antialiasing/shaders/screen.vs
new file mode 100644
index 0000000..0a5213b
--- /dev/null
+++ b/advanced_opengl/10.antialiasing/shaders/screen.vs
@@ -0,0 +1,12 @@
+#version 330 core
+layout(location = 0) in vec3 apos;
+layout(location = 1) in vec2 atex_coords;
+
+out vec2 tex_coords;
+
+void
+main(void)
+{
+ gl_Position = vec4(apos, 1.0f);
+ tex_coords = atex_coords;
+}
diff --git a/stencil/build.sh b/advanced_opengl/2.stencil/build.sh
index 435d0b3..335dd5d 100755
--- a/stencil/build.sh
+++ b/advanced_opengl/2.stencil/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='stencil'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/2.stencil/shaders/outline.fs b/advanced_opengl/2.stencil/shaders/outline.fs
new file mode 100644
index 0000000..b935555
--- /dev/null
+++ b/advanced_opengl/2.stencil/shaders/outline.fs
@@ -0,0 +1,9 @@
+#version 330 core
+
+out vec4 frag_color;
+
+void
+main(void)
+{
+ frag_color = vec4(0.76f, 0.47f, 0.84f, 1.0f);
+}
diff --git a/stencil/shaders/stencil.fs b/advanced_opengl/2.stencil/shaders/stencil.fs
index ff7dd9b..ff7dd9b 100644
--- a/stencil/shaders/stencil.fs
+++ b/advanced_opengl/2.stencil/shaders/stencil.fs
diff --git a/stencil/shaders/stencil.vs b/advanced_opengl/2.stencil/shaders/stencil.vs
index d3d92d1..d3d92d1 100644
--- a/stencil/shaders/stencil.vs
+++ b/advanced_opengl/2.stencil/shaders/stencil.vs
diff --git a/advanced_opengl/2.stencil/stencil b/advanced_opengl/2.stencil/stencil
new file mode 100755
index 0000000..ad0f48c
--- /dev/null
+++ b/advanced_opengl/2.stencil/stencil
Binary files differ
diff --git a/stencil/stencil.c b/advanced_opengl/2.stencil/stencil.c
index a7c58f3..9f45048 100644
--- a/stencil/stencil.c
+++ b/advanced_opengl/2.stencil/stencil.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -42,7 +44,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -73,46 +75,46 @@ int
main(void)
{
GLFWwindow *window;
-
+
if (glfwInit() == GLFW_FALSE)
{
fprintf(stderr, "[ERROR] Failed to initialize glfw.\n");
return(1);
}
-
+
glfwWindowHint(GLFW_RESIZABLE, 0);
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Stencil testing", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
glfwTerminate();
return(1);
}
-
+
glfwMakeContextCurrent(window);
-
+
glfwSetKeyCallback(window, key_callback);
-
+
if (glewInit() != GLEW_OK)
{
fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
glfwTerminate();
return(1);
}
-
+
glEnable(GL_DEPTH_TEST);
-
+
glEnable(GL_STENCIL_TEST);
glStencilOp(GL_KEEP, GL_KEEP, GL_REPLACE);
-
+
U32 shader = create_shader_program("shaders/stencil.vs", "shaders/stencil.fs");
U32 outline_shader = create_shader_program("shaders/stencil.vs", "shaders/outline.fs");
- U32 marble_texture = load_texture("../data/textures/marble.jpg");
- U32 metal_texture = load_texture("../data/textures/metal.png");
-
+ U32 marble_texture = load_texture("../../data/textures/marble.jpg");
+ U32 metal_texture = load_texture("../../data/textures/metal.png");
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
@@ -121,35 +123,35 @@ main(void)
a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
a, -a, a, 1.0f, 0.0f,
a, a, a, 1.0f, 1.0f,
a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
+
a, a, a, 1.0f, 0.0f,
a, a, -a, 1.0f, 1.0f,
a, -a, -a, 0.0f, 1.0f,
a, -a, -a, 0.0f, 1.0f,
a, -a, a, 0.0f, 0.0f,
a, a, a, 1.0f, 0.0f,
-
+
-a, -a, -a, 0.0f, 1.0f,
a, -a, -a, 1.0f, 1.0f,
a, -a, a, 1.0f, 0.0f,
a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
a, a, -a, 1.0f, 1.0f,
a, a, a, 1.0f, 0.0f,
@@ -157,53 +159,53 @@ main(void)
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform cube_positions[] = {
transform_default(),
transform_make_translate(v3f(a, 0.0f, -4*a))
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 VAO, VBO;
glGenVertexArrays(1, &VAO);
glBindVertexArray(VAO);
-
+
glGenBuffers(1, &VBO);
glBindBuffer(GL_ARRAY_BUFFER, VBO);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
-
+
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
-
+
glBindVertexArray(0);
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 0.0f, 3.0f);
-
+
/* glPolygonMode(GL_FRONT_AND_BACK, GL_LINE); */
-
+
F32 last_time = glfwGetTime();
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
-
+
/* INFO(pryazha): update */
V3F left, up, forward;
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
-
+
forward = v3f_norm(v3f_sub(v3f(0.0f, 0.0f, 0.0f), camera_pos));
left = v3f_norm(v3f_cross(world_up, forward));
up = v3f_cross(forward, left);
-
+
V3F dp = v3f_zero();
-
+
F32 speed = 2.0f;
if (key_is_pressed(input.move_right))
dp = v3f_add(dp, v3f_scalef(left, -speed*dt));
@@ -218,52 +220,52 @@ main(void)
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
input_update_last_state(&input);
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
/* INFO(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT | GL_STENCIL_BUFFER_BIT);
-
+
/* NOTE(pryazha): Update stencil buffer with ones while drawing the cubes */
glStencilFunc(GL_ALWAYS, 1, 0xFF);
glStencilMask(0xFF);
-
+
MAT4 model, view, projection;
view = look_at(camera_pos, v3f(0.0f, 0.0f, 0.0f), v3f(0.0f, 1.0f, 0.0f));
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
-
+
glUseProgram(shader);
shader_set_mat4fv(shader, "view", view);
shader_set_mat4fv(shader, "projection", projection);
-
+
glBindTexture(GL_TEXTURE_2D, marble_texture);
glBindVertexArray(VAO);
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(cube_positions);
++transform_index)
- {
+ {
model = transform_apply(cube_positions[transform_index]);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
/* NOTE(pryazha): Don't update stencil buffer while drawing the floor */
glStencilMask(0x00);
-
+
glBindTexture(GL_TEXTURE_2D, metal_texture);
model = transform_apply(platform_position);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
-
+
glStencilFunc(GL_NOTEQUAL, 1, 0xFF);
glStencilMask(0x00);
glDisable(GL_DEPTH_TEST);
-
+
glUseProgram(outline_shader);
shader_set_mat4fv(outline_shader, "view", view);
shader_set_mat4fv(outline_shader, "projection", projection);
-
+
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(cube_positions);
++transform_index)
@@ -273,13 +275,13 @@ main(void)
shader_set_mat4fv(outline_shader, "model", transform_apply(transform));
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
glStencilMask(0xFF);
glStencilFunc(GL_ALWAYS, 1, 0xFF);
glEnable(GL_DEPTH_TEST);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf) {
U32 sleep_time = (U32)(target_spf-elapsed);
@@ -291,7 +293,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/advanced_opengl/3.blending/blending b/advanced_opengl/3.blending/blending
new file mode 100755
index 0000000..063ce51
--- /dev/null
+++ b/advanced_opengl/3.blending/blending
Binary files differ
diff --git a/blending/blending.c b/advanced_opengl/3.blending/blending.c
index 0b2c5a9..9ac92ea 100644
--- a/blending/blending.c
+++ b/advanced_opengl/3.blending/blending.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -42,7 +44,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -73,129 +75,129 @@ int
main(void)
{
GLFWwindow *window;
-
+
if (glfwInit() == GLFW_FALSE)
{
fprintf(stderr, "[ERROR] Failed to initialize glfw.\n");
return(1);
}
-
+
glfwWindowHint(GLFW_RESIZABLE, 0);
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Blending", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
glfwTerminate();
return(1);
}
-
+
glfwMakeContextCurrent(window);
-
+
glfwSetKeyCallback(window, key_callback);
-
+
if (glewInit() != GLEW_OK)
{
fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
glfwTerminate();
return(1);
}
-
+
glEnable(GL_DEPTH_TEST);
glEnable(GL_BLEND);
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
-
+
U32 shader = create_shader_program("shaders/blending.vs", "shaders/blending.fs");
U32 grass_shader = create_shader_program("shaders/blending.vs", "shaders/grass.fs");
- U32 marble_texture = load_texture("../data/textures/marble.jpg");
- U32 metal_texture = load_texture("../data/textures/metal.png");
- U32 grass_texture = load_texture("../data/textures/grass.png");
- U32 window_texture = load_texture("../data/textures/window.png");
-
+ U32 marble_texture = load_texture("../../data/textures/marble.jpg");
+ U32 metal_texture = load_texture("../../data/textures/metal.png");
+ U32 grass_texture = load_texture("../../data/textures/grass.png");
+ U32 window_texture = load_texture("../../data/textures/window.png");
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
- a, -a, -a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 1.0f,
- a, a, a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
- a, a, a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, a, 0.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
-
+
+ a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, a, 0.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
+
-a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 1.0f, 1.0f,
- a, -a, a, 1.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
+ a, -a, -a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform cube_positions[] = {
transform_default(),
transform_make_translate(v3f(a, 0.0f, -4.0f*a))
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 cube_vao, quad_vao, vbo;
-
+
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
-
+
glGenBuffers(1, &vbo);
glBindBuffer(GL_ARRAY_BUFFER, vbo);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
-
+
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
F32 quad_side = 1.0f;
F32 quad_vertices[] = {
/* NOTE(pryazha): left top triangle */
-quad_side/2.0f, 0.0f, 0.0f, 0.0f, 0.0f,
-quad_side/2.0f, quad_side, 0.0f, 0.0f, 1.0f,
- quad_side/2.0f, quad_side, 0.0f, 1.0f, 1.0f,
-
+ quad_side/2.0f, quad_side, 0.0f, 1.0f, 1.0f,
+
/* NOTE(pryazha): right bottom triangle */
-quad_side/2.0f, 0.0f, 0.0f, 0.0f, 0.0f,
- quad_side/2.0f, quad_side, 0.0f, 1.0f, 1.0f,
- quad_side/2.0f, 0.0f, 0.0f, 1.0f, 0.0f
+ quad_side/2.0f, quad_side, 0.0f, 1.0f, 1.0f,
+ quad_side/2.0f, 0.0f, 0.0f, 1.0f, 0.0f
};
-
+
glGenVertexArrays(1, &quad_vao);
glBindVertexArray(quad_vao);
glGenBuffers(1, &vbo);
@@ -206,7 +208,7 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
Transform grass_positions[] = {
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(1.0f, -0.5f, 0.0f)),
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(-1.5f, -0.5f, 2.0f)),
@@ -214,7 +216,7 @@ main(void)
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(3.0f, -0.5f, 1.0f)),
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(-2.0f, -0.5f, -3.0f))
};
-
+
Transform window_transforms[] = {
transform_make_translate(v3f(0.0f, -0.5f, a+0.1f)),
transform_make_translate(v3f(0.0f, -0.5f, 2.0f)),
@@ -223,7 +225,7 @@ main(void)
transform_make_translate(v3f(-3.0f, -0.5f, -3.0f)),
transform_make_translate(v3f(3.0f, -0.5f, 0.2)),
};
-
+
F32 angle = 0.0f;
for (S32 window_index = 0;
window_index < (S32)ArrayCount(window_transforms);
@@ -233,29 +235,29 @@ main(void)
*transform = transform_rotate(*transform, v3f(0.0f, angle, 0.0f));
angle += 30.0f;
}
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 0.0f, 3.0f);
-
+
/* glPolygonMode(GL_FRONT_AND_BACK, GL_LINE); */
-
+
F32 last_time = glfwGetTime();
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
-
+
/* INFO(pryazha): update */
V3F left, up, forward;
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
-
+
forward = v3f_norm(v3f_sub(v3f(0.0f, 0.0f, 0.0f), camera_pos));
left = v3f_norm(v3f_cross(world_up, forward));
up = v3f_cross(forward, left);
-
+
V3F dp = v3f_zero();
-
+
F32 speed = 2.0f;
if (key_is_pressed(input.move_right))
dp = v3f_add(dp, v3f_scalef(left, -speed*dt));
@@ -269,11 +271,11 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, speed*dt));
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
-
+
input_update_last_state(&input);
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
Transform sorted_window_transforms[ArrayCount(window_transforms)];
MemoryCopyArray(sorted_window_transforms, window_transforms);
for (S32 i = 0; i < (S32)ArrayCount(sorted_window_transforms); ++i) {
@@ -290,41 +292,41 @@ main(void)
}
}
}
-
+
/* INFO(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
MAT4 model, view, projection;
view = look_at(camera_pos, v3f(0.0f, 0.0f, 0.0f), v3f(0.0f, 1.0f, 0.0f));
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
-
+
glUseProgram(shader);
shader_set_mat4fv(shader, "view", view);
shader_set_mat4fv(shader, "projection", projection);
-
+
glBindTexture(GL_TEXTURE_2D, marble_texture);
glBindVertexArray(cube_vao);
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(cube_positions);
++transform_index)
- {
+ {
model = transform_apply(cube_positions[transform_index]);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
glBindTexture(GL_TEXTURE_2D, metal_texture);
model = transform_apply(platform_position);
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 36);
-
+
glUseProgram(grass_shader);
glBindTexture(GL_TEXTURE_2D, grass_texture);
shader_set_mat4fv(shader, "view", view);
shader_set_mat4fv(shader, "projection", projection);
glBindVertexArray(quad_vao);
-
+
F32 angle = 0.0f;
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(grass_positions);
@@ -336,7 +338,7 @@ main(void)
glDrawArrays(GL_TRIANGLES, 0, 6);
angle += 30.0f;
}
-
+
glUseProgram(shader);
glBindTexture(GL_TEXTURE_2D, window_texture);
shader_set_mat4fv(shader, "view", view);
@@ -349,11 +351,11 @@ main(void)
shader_set_mat4fv(shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 6);
}
-
+
glBindVertexArray(0);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf) {
U32 sleep_time = (U32)(target_spf-elapsed);
@@ -365,7 +367,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/blending/build.sh b/advanced_opengl/3.blending/build.sh
index 2385b32..1fb5c9c 100755
--- a/blending/build.sh
+++ b/advanced_opengl/3.blending/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='blending'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/blending/shaders/blending.fs b/advanced_opengl/3.blending/shaders/blending.fs
index f58c5d3..f58c5d3 100644
--- a/blending/shaders/blending.fs
+++ b/advanced_opengl/3.blending/shaders/blending.fs
diff --git a/blending/shaders/blending.vs b/advanced_opengl/3.blending/shaders/blending.vs
index d3d92d1..d3d92d1 100644
--- a/blending/shaders/blending.vs
+++ b/advanced_opengl/3.blending/shaders/blending.vs
diff --git a/blending/shaders/grass.fs b/advanced_opengl/3.blending/shaders/grass.fs
index cecb0ce..cecb0ce 100644
--- a/blending/shaders/grass.fs
+++ b/advanced_opengl/3.blending/shaders/grass.fs
diff --git a/face_culling/build.sh b/advanced_opengl/4.face_culling/build.sh
index 571cdc2..e60b2dc 100755
--- a/face_culling/build.sh
+++ b/advanced_opengl/4.face_culling/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='face_culling'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/4.face_culling/face_culling b/advanced_opengl/4.face_culling/face_culling
new file mode 100755
index 0000000..62d75b4
--- /dev/null
+++ b/advanced_opengl/4.face_culling/face_culling
Binary files differ
diff --git a/face_culling/face_culling.c b/advanced_opengl/4.face_culling/face_culling.c
index 01c2325..9769b53 100644
--- a/face_culling/face_culling.c
+++ b/advanced_opengl/4.face_culling/face_culling.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -42,7 +44,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -73,147 +75,147 @@ int
main(void)
{
GLFWwindow *window;
-
+
if (glfwInit() == GLFW_FALSE)
{
fprintf(stderr, "[ERROR] Failed to initialize glfw.\n");
return(1);
}
-
+
glfwWindowHint(GLFW_RESIZABLE, 0);
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Face culling", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
glfwTerminate();
return(1);
}
-
+
glfwMakeContextCurrent(window);
-
+
glfwSetKeyCallback(window, key_callback);
-
+
if (glewInit() != GLEW_OK)
{
fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
glfwTerminate();
return(1);
}
-
+
glEnable(GL_DEPTH_TEST);
glEnable(GL_CULL_FACE);
glFrontFace(GL_CW);
glCullFace(GL_BACK);
-
+
U32 shader = create_shader_program("shaders/face_culling.vs", "shaders/face_culling.fs");
-
- U32 grid_texture = load_texture("../data/textures/grid.png");
-
+
+ U32 grid_texture = load_texture("../../data/textures/grid.png");
+
F32 a = 0.5f;
/* NOTE(pryazha): Counter-clockwise order */
F32 cube_vertices_ccw[] = {
/* NOTE(pryazha): Back face */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, -a, 1.0f, 1.0f, /* top-right */
- a, a, -a, 0.0f, 1.0f, /* top-left */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 0.0f, 1.0f, /* top-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, -a, -a, 1.0f, 0.0f, /* bottom-right */
-a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Front face */
+
+ /* NOTE(pryazha): Front face */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 1.0f, 1.0f, /* top-right */
+ a, a, a, 1.0f, 1.0f, /* top-right */
-a, a, a, 0.0f, 1.0f, /* top-left */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, -a, a, 1.0f, 0.0f, /* bottom-right */
- a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Left face */
+ a, -a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Left face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, a, 1.0f, 1.0f, /* top-right */
-a, a, -a, 0.0f, 1.0f, /* top-left */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, -a, a, 1.0f, 0.0f, /* bottom-right */
-a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Right face */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
- a, a, a, 0.0f, 1.0f, /* top-left */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Top face */
+
+ /* NOTE(pryazha): Right face */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, a, a, 0.0f, 1.0f, /* top-left */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Top face */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
-a, a, -a, 0.0f, 1.0f, /* top-left */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 1.0f, 0.0f, /* bottom-right */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Bottom face */
+ a, a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Bottom face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
-a, -a, a, 0.0f, 1.0f, /* top-left */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
};
-
+
F32 cube_vertices_cw[] = {
/* NOTE(pryazha): Back face */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, -a, 1.0f, 1.0f, /* top-right */
-a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 0.0f, 1.0f, /* top-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 0.0f, 1.0f, /* top-left */
-a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Front face */
+
+ /* NOTE(pryazha): Front face */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 1.0f, 1.0f, /* top-right */
- a, -a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, a, 1.0f, 0.0f, /* bottom-right */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
-a, a, a, 0.0f, 1.0f, /* top-left */
- a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Left face */
+ a, a, a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Left face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, a, 1.0f, 1.0f, /* top-right */
-a, -a, a, 1.0f, 0.0f, /* bottom-right */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, -a, 0.0f, 1.0f, /* top-left */
-a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Right face */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 0.0f, 1.0f, /* top-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Top face */
+
+ /* NOTE(pryazha): Right face */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, a, a, 0.0f, 1.0f, /* top-left */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Top face */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
- a, a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, a, a, 1.0f, 0.0f, /* bottom-right */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
-a, a, -a, 0.0f, 1.0f, /* top-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Bottom face */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Bottom face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, -a, a, 1.0f, 1.0f, /* top-right */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, -a, a, 0.0f, 1.0f, /* top-left */
- a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
};
-
+
U32 cube_vao, vbo;
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
@@ -225,29 +227,29 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
Transform cube_transform = transform_default();
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 1.0f, 3.0f);
-
+
F32 last_time = glfwGetTime();
-
+
F32 d_angle = 45.0f;
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
-
+
/* INFO(pryazha): update */
V3F left, up, forward;
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
-
+
forward = v3f_norm(v3f_sub(v3f(0.0f, 0.0f, 0.0f), camera_pos));
left = v3f_norm(v3f_cross(world_up, forward));
up = v3f_cross(forward, left);
-
+
V3F dp = v3f_zero();
F32 speed = 2.0f;
if (key_is_pressed(input.move_right))
@@ -262,21 +264,21 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, speed*dt));
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
-
+
input_update_last_state(&input);
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
/* INFO(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
MAT4 model, view, projection;
cube_transform = transform_rotate(cube_transform, v3f(0.0f, d_angle*dt, 0.0f));
model = transform_apply(cube_transform);
view = look_at(camera_pos, v3f(0.0f, 0.0f, 0.0f), v3f(0.0f, 1.0f, 0.0f));
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
-
+
glUseProgram(shader);
glBindTexture(GL_TEXTURE_2D, grid_texture);
shader_set_mat4fv(shader, "model", model);
@@ -284,9 +286,9 @@ main(void)
shader_set_mat4fv(shader, "projection", projection);
glBindVertexArray(cube_vao);
glDrawArrays(GL_TRIANGLES, 0, 36);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf) {
U32 sleep_time = (U32)(target_spf-elapsed);
@@ -298,7 +300,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/face_culling/shaders/face_culling.fs b/advanced_opengl/4.face_culling/shaders/face_culling.fs
index f58c5d3..f58c5d3 100644
--- a/face_culling/shaders/face_culling.fs
+++ b/advanced_opengl/4.face_culling/shaders/face_culling.fs
diff --git a/face_culling/shaders/face_culling.vs b/advanced_opengl/4.face_culling/shaders/face_culling.vs
index d3d92d1..d3d92d1 100644
--- a/face_culling/shaders/face_culling.vs
+++ b/advanced_opengl/4.face_culling/shaders/face_culling.vs
diff --git a/framebuffers/build.sh b/advanced_opengl/5.framebuffers/build.sh
index 970a5da..58a1162 100755
--- a/framebuffers/build.sh
+++ b/advanced_opengl/5.framebuffers/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='framebuffers'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/5.framebuffers/framebuffers b/advanced_opengl/5.framebuffers/framebuffers
new file mode 100755
index 0000000..4b2c4c5
--- /dev/null
+++ b/advanced_opengl/5.framebuffers/framebuffers
Binary files differ
diff --git a/framebuffers/framebuffers.c b/advanced_opengl/5.framebuffers/framebuffers.c
index e71c95c..a0523cc 100644
--- a/framebuffers/framebuffers.c
+++ b/advanced_opengl/5.framebuffers/framebuffers.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -42,7 +44,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -84,7 +86,7 @@ main(void)
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Framebuffers", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
@@ -105,14 +107,14 @@ main(void)
U32 screen_shader = create_shader_program("shaders/screen.vs", "shaders/screen.fs");
U32 cube_shader = create_shader_program("shaders/cube.vs", "shaders/cube.fs");
- U32 marble_texture = load_texture("../data/textures/marble.jpg");
- U32 metal_texture = load_texture("../data/textures/metal.png");
- U32 window_texture = load_texture("../data/textures/window.png");
-
+ U32 marble_texture = load_texture("../../data/textures/marble.jpg");
+ U32 metal_texture = load_texture("../../data/textures/metal.png");
+ U32 window_texture = load_texture("../../data/textures/window.png");
+
U32 fbo;
glGenFramebuffers(1, &fbo);
glBindFramebuffer(GL_FRAMEBUFFER, fbo);
-
+
U32 texture_colorbuffer;
glGenTextures(1, &texture_colorbuffer);
glBindTexture(GL_TEXTURE_2D, texture_colorbuffer);
@@ -120,85 +122,85 @@ main(void)
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
glBindTexture(GL_TEXTURE_2D, 0);
-
+
glFramebufferTexture2D(GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D,
texture_colorbuffer, 0);
-
+
U32 rbo;
glGenRenderbuffers(1, &rbo);
glBindRenderbuffer(GL_RENDERBUFFER, rbo);
glRenderbufferStorage(GL_RENDERBUFFER, GL_DEPTH24_STENCIL8, WIDTH, HEIGHT);
glBindRenderbuffer(GL_RENDERBUFFER, 0);
-
+
glFramebufferRenderbuffer(GL_FRAMEBUFFER, GL_DEPTH_STENCIL_ATTACHMENT,
GL_RENDERBUFFER, rbo);
if (glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE)
fprintf(stderr, "[ERROR]: Framebuffer is not complete.\n");
glBindFramebuffer(GL_FRAMEBUFFER, 0);
-
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
- a, -a, -a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 1.0f,
- a, a, a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
- a, a, a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, a, 0.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
-
+
+ a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, a, 0.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
+
-a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 1.0f, 1.0f,
- a, -a, a, 1.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
+ a, -a, -a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform cube_positions[] = {
transform_default(),
transform_make_translate(v3f(a, 0.0f, -4.0f*a))
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 cube_vao, quad_vao, vbo;
-
+
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
-
+
glGenBuffers(1, &vbo);
glBindBuffer(GL_ARRAY_BUFFER, vbo);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
-
+
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
glEnableVertexAttribArray(1);
@@ -207,10 +209,10 @@ main(void)
F32 quad_vertices[] = {
-1.0f, -1.0f, 0.0f, 0.0f, 0.0f,
- 1.0f, -1.0f, 0.0f, 1.0f, 0.0f,
- 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
+ 1.0f, -1.0f, 0.0f, 1.0f, 0.0f,
+ 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
-1.0f, -1.0f, 0.0f, 0.0f, 0.0f,
- 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
+ 1.0f, 1.0f, 0.0f, 1.0f, 1.0f,
-1.0f, 1.0f, 0.0f, 0.0f, 1.0f
};
@@ -224,7 +226,7 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
Transform window_transforms[] = {
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(0.0f, 0.0f, a+0.1f)),
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(0.0f, 0.0f, 2.0f)),
@@ -233,7 +235,7 @@ main(void)
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(-3.0f, 0.0f, -3.0f)),
transform_make_scale_translate(v3f(0.5f, 0.5f, 0.5f), v3f(3.0f, 0.0f, 0.2)),
};
-
+
F32 angle = 0.0f;
for (S32 window_index = 0;
window_index < (S32)ArrayCount(window_transforms);
@@ -249,7 +251,7 @@ main(void)
camera_pos = v3f(0.0f, 1.0f, 3.0f);
F32 last_time = glfwGetTime();
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
@@ -276,11 +278,11 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, speed*dt));
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
-
+
input_update_last_state(&input);
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
Transform sorted_window_transforms[ArrayCount(window_transforms)];
MemoryCopyArray(sorted_window_transforms, window_transforms);
for (S32 i = 0; i < (S32)ArrayCount(sorted_window_transforms); ++i) {
@@ -318,12 +320,12 @@ main(void)
shader_set_mat4fv(cube_shader, "model", transform_apply(cube_positions[transform_index]));
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
glBindTexture(GL_TEXTURE_2D, metal_texture);
shader_set_mat4fv(cube_shader, "model", transform_apply(platform_position));
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glEnable(GL_BLEND);
glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
glUseProgram(cube_shader);
@@ -340,7 +342,7 @@ main(void)
}
glBindVertexArray(0);
glDisable(GL_BLEND);
-
+
glBindFramebuffer(GL_FRAMEBUFFER, 0);
glClearColor(1.0f, 1.0f, 1.0f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT);
@@ -351,7 +353,7 @@ main(void)
shader_set_mat4fv(screen_shader, "model", mat4_identity());
glDrawArrays(GL_TRIANGLES, 0, 6);
glBindVertexArray(0);
-
+
glBindFramebuffer(GL_FRAMEBUFFER, fbo);
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
@@ -370,12 +372,12 @@ main(void)
shader_set_mat4fv(cube_shader, "model", transform_apply(cube_positions[transform_index]));
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
glBindTexture(GL_TEXTURE_2D, metal_texture);
shader_set_mat4fv(cube_shader, "model", transform_apply(platform_position));
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glEnable(GL_BLEND);
glBlendFunc(GL_ONE, GL_ONE_MINUS_SRC_ALPHA);
glUseProgram(cube_shader);
@@ -392,7 +394,7 @@ main(void)
}
glBindVertexArray(0);
glDisable(GL_BLEND);
-
+
glBindFramebuffer(GL_FRAMEBUFFER, 0);
glUseProgram(screen_shader);
glDisable(GL_DEPTH_TEST);
@@ -402,9 +404,9 @@ main(void)
shader_set_mat4fv(screen_shader, "model", model);
glDrawArrays(GL_TRIANGLES, 0, 6);
glBindVertexArray(0);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf)
{
@@ -416,7 +418,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/framebuffers/shaders/cube.fs b/advanced_opengl/5.framebuffers/shaders/cube.fs
index f58c5d3..f58c5d3 100644
--- a/framebuffers/shaders/cube.fs
+++ b/advanced_opengl/5.framebuffers/shaders/cube.fs
diff --git a/framebuffers/shaders/cube.vs b/advanced_opengl/5.framebuffers/shaders/cube.vs
index 3c11932..3c11932 100644
--- a/framebuffers/shaders/cube.vs
+++ b/advanced_opengl/5.framebuffers/shaders/cube.vs
diff --git a/framebuffers/shaders/screen.fs b/advanced_opengl/5.framebuffers/shaders/screen.fs
index 8f0b2da..8f0b2da 100644
--- a/framebuffers/shaders/screen.fs
+++ b/advanced_opengl/5.framebuffers/shaders/screen.fs
diff --git a/framebuffers/shaders/screen.vs b/advanced_opengl/5.framebuffers/shaders/screen.vs
index 157dde2..157dde2 100644
--- a/framebuffers/shaders/screen.vs
+++ b/advanced_opengl/5.framebuffers/shaders/screen.vs
diff --git a/advanced_opengl/6.cubemaps/build.sh b/advanced_opengl/6.cubemaps/build.sh
new file mode 100755
index 0000000..bf1d66c
--- /dev/null
+++ b/advanced_opengl/6.cubemaps/build.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+. ../../config
+TARGET='cubemaps'
+set -x
+gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/6.cubemaps/cubemaps b/advanced_opengl/6.cubemaps/cubemaps
new file mode 100755
index 0000000..661279d
--- /dev/null
+++ b/advanced_opengl/6.cubemaps/cubemaps
Binary files differ
diff --git a/skybox/skybox.c b/advanced_opengl/6.cubemaps/cubemaps.c
index 7919b7a..5ea5300 100644
--- a/skybox/skybox.c
+++ b/advanced_opengl/6.cubemaps/cubemaps.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -43,7 +45,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -98,7 +100,7 @@ main(void)
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Cubemaps", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
@@ -107,7 +109,7 @@ main(void)
}
glfwMakeContextCurrent(window);
-
+
glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_DISABLED);
glfwSetKeyCallback(window, key_callback);
@@ -124,132 +126,132 @@ main(void)
U32 reflection_shader = create_shader_program("shaders/reflection.vs", "shaders/reflection.fs");
U32 refraction_shader = create_shader_program("shaders/refraction.vs", "shaders/refraction.fs");
U32 cube_shader = create_shader_program("shaders/cube.vs", "shaders/cube.fs");
- U32 grid_texture = load_texture("../data/textures/grid.png");
-
+ U32 grid_texture = load_texture("../../data/textures/grid.png");
+
const char *cube_texture_filenames[6] = {
- "../data/textures/skybox/right.jpg",
- "../data/textures/skybox/left.jpg",
- "../data/textures/skybox/top.jpg",
- "../data/textures/skybox/bottom.jpg",
- "../data/textures/skybox/front.jpg",
- "../data/textures/skybox/back.jpg"
+ "../../data/textures/skybox/right.jpg",
+ "../../data/textures/skybox/left.jpg",
+ "../../data/textures/skybox/top.jpg",
+ "../../data/textures/skybox/bottom.jpg",
+ "../../data/textures/skybox/front.jpg",
+ "../../data/textures/skybox/back.jpg"
};
U32 skybox_texture = load_cubemap(cube_texture_filenames);
-
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
- a, -a, -a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 1.0f,
- a, a, a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
- a, a, a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, a, 0.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
-
+
+ a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, a, 0.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
+
-a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 1.0f, 1.0f,
- a, -a, a, 1.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
+ a, -a, -a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform cube_positions[] = {
transform_default(),
transform_make_translate(v3f(a, 0.0f, -4.0f*a))
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 cube_vao, vbo;
-
+
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
-
+
glGenBuffers(1, &vbo);
glBindBuffer(GL_ARRAY_BUFFER, vbo);
glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
-
+
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)0);
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
a = 1.0f;
F32 skybox_cube_vertices[] = {
-a, -a, -a,
- a, -a, -a,
- a, a, -a,
- a, a, -a,
+ a, -a, -a,
+ a, a, -a,
+ a, a, -a,
-a, a, -a,
-a, -a, -a,
-
+
-a, -a, a,
- a, -a, a,
- a, a, a,
- a, a, a,
+ a, -a, a,
+ a, a, a,
+ a, a, a,
-a, a, a,
-a, -a, a,
-
+
-a, a, a,
-a, a, -a,
-a, -a, -a,
-a, -a, -a,
-a, -a, a,
-a, a, a,
-
- a, a, a,
- a, a, -a,
- a, -a, -a,
- a, -a, -a,
- a, -a, a,
- a, a, a,
-
+
+ a, a, a,
+ a, a, -a,
+ a, -a, -a,
+ a, -a, -a,
+ a, -a, a,
+ a, a, a,
+
-a, -a, -a,
- a, -a, -a,
- a, -a, a,
- a, -a, a,
+ a, -a, -a,
+ a, -a, a,
+ a, -a, a,
-a, -a, a,
-a, -a, -a,
-
+
-a, a, -a,
- a, a, -a,
- a, a, a,
- a, a, a,
+ a, a, -a,
+ a, a, a,
+ a, a, a,
-a, a, a,
-a, a, -a,
};
-
+
U32 skybox_cube_vao;
glGenVertexArrays(1, &skybox_cube_vao);
glBindVertexArray(skybox_cube_vao);
@@ -259,47 +261,47 @@ main(void)
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 3*sizeof(F32), (void *)0);
glBindVertexArray(0);
-
+
F32 normals_cube_vertices[] = {
-0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
- 0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
+ 0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
-0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
-0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f,
-
+
-0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
-0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
-0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f,
-
+
-0.5f, 0.5f, 0.5f, -1.0f, 0.0f, 0.0f,
-0.5f, 0.5f, -0.5f, -1.0f, 0.0f, 0.0f,
-0.5f, -0.5f, -0.5f, -1.0f, 0.0f, 0.0f,
-0.5f, -0.5f, -0.5f, -1.0f, 0.0f, 0.0f,
-0.5f, -0.5f, 0.5f, -1.0f, 0.0f, 0.0f,
-0.5f, 0.5f, 0.5f, -1.0f, 0.0f, 0.0f,
-
- 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, 0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, -0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
-
+
+ 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
+ 0.5f, 0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
+ 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
+ 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f,
+ 0.5f, -0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
+
-0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f,
- 0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f,
+ 0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f,
-0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f,
-0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f,
-
+
-0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
-0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
-0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f
};
@@ -314,28 +316,28 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 3, GL_FLOAT, GL_FALSE, 6*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 1.0f, 3.0f);
F32 yaw = 0.0f, pitch = 0.0f;
F32 last_time = glfwGetTime();
-
+
glEnable(GL_DEPTH_TEST);
glDepthFunc(GL_LEQUAL);
-
+
MAT4 view, projection;
view = mat4_make_translate(v3f_negate(camera_pos));
view = mat4_rotate_angles(view, v3f(pitch, yaw, 0.0f));
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
/* INFO(pryazha): update */
-
+
V3F left, up, forward;
left = v3f(-view.m0.x, -view.m1.x, -view.m2.x);
@@ -356,9 +358,9 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, speed*dt));
if (key_is_pressed(input.move_down))
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
-
+
camera_pos = v3f_add(camera_pos, dp);
-
+
/* NOTE(pryazha): Mouse handling */
F32 sensitivity = 0.1f;
input.mouse_offset = v2f_scalef(input.mouse_offset, sensitivity);
@@ -368,21 +370,21 @@ main(void)
pitch = 89.0f;
if (pitch < -89.0f)
pitch = -89.0f;
-
+
view = mat4_make_translate(v3f_negate(camera_pos));
view = mat4_rotate_angles(view, v3f(pitch, yaw, 0.0f));
-
+
input_update_last_state(&input);
/* NOTE(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
glUseProgram(cube_shader);
shader_set_mat4fv(cube_shader, "view", view);
shader_set_mat4fv(cube_shader, "projection", projection);
glBindTexture(GL_TEXTURE_2D, grid_texture);
-
+
glBindVertexArray(cube_vao);
for (S32 transform_index = 0;
transform_index < (S32)ArrayCount(cube_positions);
@@ -391,11 +393,11 @@ main(void)
shader_set_mat4fv(cube_shader, "model", transform_apply(cube_positions[transform_index]));
glDrawArrays(GL_TRIANGLES, 0, 36);
}
-
+
shader_set_mat4fv(cube_shader, "model", transform_apply(platform_position));
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glUseProgram(reflection_shader);
shader_set_mat4fv(reflection_shader, "model", mat4_make_translate(v3f(0.0f, 2.0f, 0.0f)));
shader_set_mat4fv(reflection_shader, "view", view);
@@ -406,7 +408,7 @@ main(void)
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindTexture(GL_TEXTURE_CUBE_MAP, 0);
glBindVertexArray(0);
-
+
glUseProgram(refraction_shader);
shader_set_mat4fv(refraction_shader, "model", mat4_make_translate(v3f(2.0f, 2.0f, 0.0f)));
shader_set_mat4fv(refraction_shader, "view", view);
@@ -417,7 +419,7 @@ main(void)
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindTexture(GL_TEXTURE_CUBE_MAP, 0);
glBindVertexArray(0);
-
+
glUseProgram(skybox_shader);
MAT4 rotate_view = mat4_identity();
rotate_view.m0 = v4f(view.m0.x, view.m0.y, view.m0.z, 0.0f);
@@ -429,9 +431,9 @@ main(void)
glBindTexture(GL_TEXTURE_CUBE_MAP, skybox_texture);
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf)
{
@@ -443,7 +445,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/skybox/shaders/cube.fs b/advanced_opengl/6.cubemaps/shaders/cube.fs
index f58c5d3..f58c5d3 100644
--- a/skybox/shaders/cube.fs
+++ b/advanced_opengl/6.cubemaps/shaders/cube.fs
diff --git a/skybox/shaders/cube.vs b/advanced_opengl/6.cubemaps/shaders/cube.vs
index 3c11932..3c11932 100644
--- a/skybox/shaders/cube.vs
+++ b/advanced_opengl/6.cubemaps/shaders/cube.vs
diff --git a/skybox/shaders/reflection.fs b/advanced_opengl/6.cubemaps/shaders/reflection.fs
index 3723ea9..3723ea9 100644
--- a/skybox/shaders/reflection.fs
+++ b/advanced_opengl/6.cubemaps/shaders/reflection.fs
diff --git a/skybox/shaders/reflection.vs b/advanced_opengl/6.cubemaps/shaders/reflection.vs
index 34ad142..34ad142 100644
--- a/skybox/shaders/reflection.vs
+++ b/advanced_opengl/6.cubemaps/shaders/reflection.vs
diff --git a/skybox/shaders/refraction.fs b/advanced_opengl/6.cubemaps/shaders/refraction.fs
index 8a8a8c5..8a8a8c5 100644
--- a/skybox/shaders/refraction.fs
+++ b/advanced_opengl/6.cubemaps/shaders/refraction.fs
diff --git a/skybox/shaders/refraction.vs b/advanced_opengl/6.cubemaps/shaders/refraction.vs
index 34ad142..34ad142 100644
--- a/skybox/shaders/refraction.vs
+++ b/advanced_opengl/6.cubemaps/shaders/refraction.vs
diff --git a/skybox/shaders/skybox.fs b/advanced_opengl/6.cubemaps/shaders/skybox.fs
index bf69c8b..bf69c8b 100644
--- a/skybox/shaders/skybox.fs
+++ b/advanced_opengl/6.cubemaps/shaders/skybox.fs
diff --git a/skybox/shaders/skybox.vs b/advanced_opengl/6.cubemaps/shaders/skybox.vs
index 4259dc1..4259dc1 100644
--- a/skybox/shaders/skybox.vs
+++ b/advanced_opengl/6.cubemaps/shaders/skybox.vs
diff --git a/uniform_buffer/build.sh b/advanced_opengl/7.uniform_buffer/build.sh
index 69460e4..d5620a3 100755
--- a/uniform_buffer/build.sh
+++ b/advanced_opengl/7.uniform_buffer/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='uniform_buffer'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/uniform_buffer/shaders/color_cube.fs b/advanced_opengl/7.uniform_buffer/shaders/color_cube.fs
index 8aa5add..8aa5add 100644
--- a/uniform_buffer/shaders/color_cube.fs
+++ b/advanced_opengl/7.uniform_buffer/shaders/color_cube.fs
diff --git a/uniform_buffer/shaders/color_cube.vs b/advanced_opengl/7.uniform_buffer/shaders/color_cube.vs
index 630242d..630242d 100644
--- a/uniform_buffer/shaders/color_cube.vs
+++ b/advanced_opengl/7.uniform_buffer/shaders/color_cube.vs
diff --git a/uniform_buffer/shaders/cube.fs b/advanced_opengl/7.uniform_buffer/shaders/cube.fs
index f58c5d3..f58c5d3 100644
--- a/uniform_buffer/shaders/cube.fs
+++ b/advanced_opengl/7.uniform_buffer/shaders/cube.fs
diff --git a/uniform_buffer/shaders/cube.vs b/advanced_opengl/7.uniform_buffer/shaders/cube.vs
index cb0b7bf..cb0b7bf 100644
--- a/uniform_buffer/shaders/cube.vs
+++ b/advanced_opengl/7.uniform_buffer/shaders/cube.vs
diff --git a/uniform_buffer/shaders/skybox.fs b/advanced_opengl/7.uniform_buffer/shaders/skybox.fs
index bf69c8b..bf69c8b 100644
--- a/uniform_buffer/shaders/skybox.fs
+++ b/advanced_opengl/7.uniform_buffer/shaders/skybox.fs
diff --git a/uniform_buffer/shaders/skybox.vs b/advanced_opengl/7.uniform_buffer/shaders/skybox.vs
index 36a07ed..36a07ed 100644
--- a/uniform_buffer/shaders/skybox.vs
+++ b/advanced_opengl/7.uniform_buffer/shaders/skybox.vs
diff --git a/advanced_opengl/7.uniform_buffer/uniform_buffer b/advanced_opengl/7.uniform_buffer/uniform_buffer
new file mode 100755
index 0000000..e2b3e42
--- /dev/null
+++ b/advanced_opengl/7.uniform_buffer/uniform_buffer
Binary files differ
diff --git a/uniform_buffer/uniform_buffer.c b/advanced_opengl/7.uniform_buffer/uniform_buffer.c
index ddd5d33..e67b5c9 100644
--- a/uniform_buffer/uniform_buffer.c
+++ b/advanced_opengl/7.uniform_buffer/uniform_buffer.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -43,7 +45,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -98,7 +100,7 @@ main(void)
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(WIDTH, HEIGHT, "depth testing", 0, 0);
+ window = glfwCreateWindow(WIDTH, HEIGHT, "Advanced data (uniform buffer)", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
@@ -107,7 +109,7 @@ main(void)
}
glfwMakeContextCurrent(window);
-
+
glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_DISABLED);
glfwSetKeyCallback(window, key_callback);
@@ -124,83 +126,83 @@ main(void)
U32 cube_shader = create_shader_program("shaders/cube.vs", "shaders/cube.fs");
U32 color_cube_shader = create_shader_program("shaders/color_cube.vs",
"shaders/color_cube.fs");
-
+
U32 skybox_matrices = glGetUniformBlockIndex(skybox_shader, "Matrices");
U32 cube_matrices = glGetUniformBlockIndex(cube_shader, "Matrices");
U32 color_cube_matrices = glGetUniformBlockIndex(color_cube_shader, "Matrices");
-
+
glUniformBlockBinding(skybox_shader, skybox_matrices, 0);
glUniformBlockBinding(cube_shader, cube_matrices, 0);
glUniformBlockBinding(color_cube_shader, color_cube_matrices, 0);
-
+
U32 matrices_ubo;
glGenBuffers(1, &matrices_ubo);
glBindBuffer(GL_UNIFORM_BUFFER, matrices_ubo);
glBufferData(GL_UNIFORM_BUFFER, 2*sizeof(MAT4), 0, GL_STATIC_DRAW);
glBindBuffer(GL_UNIFORM_BUFFER, 0);
glBindBufferRange(GL_UNIFORM_BUFFER, 0, matrices_ubo, 0, 2*sizeof(MAT4));
-
- U32 grid_texture = load_texture("../data/textures/grid.png");
-
+
+ U32 grid_texture = load_texture("../../data/textures/grid.png");
+
const char *cube_texture_filenames[6] = {
- "../data/textures/skybox/right.jpg",
- "../data/textures/skybox/left.jpg",
- "../data/textures/skybox/top.jpg",
- "../data/textures/skybox/bottom.jpg",
- "../data/textures/skybox/front.jpg",
- "../data/textures/skybox/back.jpg"
+ "../../data/textures/skybox/right.jpg",
+ "../../data/textures/skybox/left.jpg",
+ "../../data/textures/skybox/top.jpg",
+ "../../data/textures/skybox/bottom.jpg",
+ "../../data/textures/skybox/front.jpg",
+ "../../data/textures/skybox/back.jpg"
};
U32 skybox_texture = load_cubemap(cube_texture_filenames);
-
+
F32 a = 0.5f;
F32 vertices[] = {
-a, -a, -a, 0.0f, 0.0f,
- a, -a, -a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, -a, 1.0f, 1.0f,
-a, a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 0.0f,
-
+
-a, -a, a, 0.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 1.0f,
- a, a, a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 1.0f,
-a, a, a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-
+
-a, a, a, 1.0f, 0.0f,
-a, a, -a, 1.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, -a, 0.0f, 1.0f,
-a, -a, a, 0.0f, 0.0f,
-a, a, a, 1.0f, 0.0f,
-
- a, a, a, 1.0f, 0.0f,
- a, a, -a, 1.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 0.0f, 1.0f,
- a, -a, a, 0.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
-
+
+ a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, -a, 0.0f, 1.0f,
+ a, -a, a, 0.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
+
-a, -a, -a, 0.0f, 1.0f,
- a, -a, -a, 1.0f, 1.0f,
- a, -a, a, 1.0f, 0.0f,
- a, -a, a, 1.0f, 0.0f,
+ a, -a, -a, 1.0f, 1.0f,
+ a, -a, a, 1.0f, 0.0f,
+ a, -a, a, 1.0f, 0.0f,
-a, -a, a, 0.0f, 0.0f,
-a, -a, -a, 0.0f, 1.0f,
-
+
-a, a, -a, 0.0f, 1.0f,
- a, a, -a, 1.0f, 1.0f,
- a, a, a, 1.0f, 0.0f,
- a, a, a, 1.0f, 0.0f,
+ a, a, -a, 1.0f, 1.0f,
+ a, a, a, 1.0f, 0.0f,
+ a, a, a, 1.0f, 0.0f,
-a, a, a, 0.0f, 0.0f,
-a, a, -a, 0.0f, 1.0f
};
-
+
Transform platform_position =
transform_make_scale_translate(v3f(10.0f, 0.2f, 10.0f),
v3f(0.0f, -(a+(a*0.2f)+0.01f), 0.0f));
-
+
U32 cube_vao, vbo;
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
@@ -212,52 +214,52 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
a = 1.0f;
F32 skybox_cube_vertices[] = {
-a, -a, -a,
- a, -a, -a,
- a, a, -a,
- a, a, -a,
+ a, -a, -a,
+ a, a, -a,
+ a, a, -a,
-a, a, -a,
-a, -a, -a,
-
+
-a, -a, a,
- a, -a, a,
- a, a, a,
- a, a, a,
+ a, -a, a,
+ a, a, a,
+ a, a, a,
-a, a, a,
-a, -a, a,
-
+
-a, a, a,
-a, a, -a,
-a, -a, -a,
-a, -a, -a,
-a, -a, a,
-a, a, a,
-
- a, a, a,
- a, a, -a,
- a, -a, -a,
- a, -a, -a,
- a, -a, a,
- a, a, a,
-
+
+ a, a, a,
+ a, a, -a,
+ a, -a, -a,
+ a, -a, -a,
+ a, -a, a,
+ a, a, a,
+
-a, -a, -a,
- a, -a, -a,
- a, -a, a,
- a, -a, a,
+ a, -a, -a,
+ a, -a, a,
+ a, -a, a,
-a, -a, a,
-a, -a, -a,
-
+
-a, a, -a,
- a, a, -a,
- a, a, a,
- a, a, a,
+ a, a, -a,
+ a, a, a,
+ a, a, a,
-a, a, a,
-a, a, -a,
};
-
+
U32 skybox_cube_vao;
glGenVertexArrays(1, &skybox_cube_vao);
glBindVertexArray(skybox_cube_vao);
@@ -267,17 +269,17 @@ main(void)
glEnableVertexAttribArray(0);
glVertexAttribPointer(0, 3, GL_FLOAT, GL_FALSE, 3*sizeof(F32), (void *)0);
glBindVertexArray(0);
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
camera_pos = v3f(0.0f, 1.0f, 3.0f);
F32 yaw = 0.0f, pitch = 0.0f;
F32 last_time = glfwGetTime();
-
+
glEnable(GL_DEPTH_TEST);
glDepthFunc(GL_LEQUAL);
-
+
MAT4 view, projection;
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
glBindBuffer(GL_UNIFORM_BUFFER, matrices_ubo);
@@ -285,13 +287,13 @@ main(void)
glBindBuffer(GL_UNIFORM_BUFFER, 0);
view = mat4_make_translate(v3f_negate(camera_pos));
view = mat4_rotate_angles(view, v3f(pitch, yaw, 0.0f));
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
/* INFO(pryazha): update */
-
+
V3F left, up, forward;
left = v3f(-view.m0.x, -view.m1.x, -view.m2.x);
@@ -314,7 +316,7 @@ main(void)
dp = v3f_add(dp, v3f_scalef(up, -speed*dt));
input_update_last_state(&input);
camera_pos = v3f_add(camera_pos, dp);
-
+
/* NOTE(pryazha): Mouse handling */
F32 sensitivity = 0.1f;
input.mouse_offset = v2f_scalef(input.mouse_offset, sensitivity);
@@ -325,7 +327,7 @@ main(void)
if (pitch < -89.0f)
pitch = -89.0f;
input.mouse_offset = v2f_zero();
-
+
view = mat4_make_translate(v3f_negate(camera_pos));
view = mat4_rotate_angles(view, v3f(pitch, yaw, 0.0f));
glBindBuffer(GL_UNIFORM_BUFFER, matrices_ubo);
@@ -335,7 +337,7 @@ main(void)
/* NOTE(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
glUseProgram(cube_shader);
shader_set_mat4fv(cube_shader, "model", mat4_make_translate(v3f(-2.0f, 0.0f, 0.0f)));
glBindTexture(GL_TEXTURE_2D, grid_texture);
@@ -343,7 +345,7 @@ main(void)
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindTexture(GL_TEXTURE_2D, 0);
glBindVertexArray(0);
-
+
glUseProgram(cube_shader);
shader_set_mat4fv(cube_shader, "model", transform_apply(platform_position));
glBindTexture(GL_TEXTURE_2D, grid_texture);
@@ -351,13 +353,13 @@ main(void)
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindTexture(GL_TEXTURE_2D, 0);
glBindVertexArray(0);
-
+
glUseProgram(color_cube_shader);
shader_set_mat4fv(cube_shader, "model", mat4_make_translate(v3f(2.0f, 0.0f, 0.0f)));
glBindVertexArray(cube_vao);
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glUseProgram(skybox_shader);
MAT4 rotate_view = mat4_identity();
rotate_view.m0 = v4f(view.m0.x, view.m0.y, view.m0.z, 0.0f);
@@ -370,9 +372,9 @@ main(void)
glBindTexture(GL_TEXTURE_CUBE_MAP, skybox_texture);
glDrawArrays(GL_TRIANGLES, 0, 36);
glBindVertexArray(0);
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf)
{
@@ -384,7 +386,7 @@ main(void)
dt = current_time-last_time;
last_time = current_time;
}
-
+
glfwTerminate();
return(0);
}
diff --git a/geometry_shader/build.sh b/advanced_opengl/8.geometry_shader/build.sh
index 2d87dc0..fc81331 100755
--- a/geometry_shader/build.sh
+++ b/advanced_opengl/8.geometry_shader/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='geometry_shader'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/8.geometry_shader/geometry_shader b/advanced_opengl/8.geometry_shader/geometry_shader
new file mode 100755
index 0000000..f245068
--- /dev/null
+++ b/advanced_opengl/8.geometry_shader/geometry_shader
Binary files differ
diff --git a/geometry_shader/geometry_shader.c b/advanced_opengl/8.geometry_shader/geometry_shader.c
index af2d494..678708c 100644
--- a/geometry_shader/geometry_shader.c
+++ b/advanced_opengl/8.geometry_shader/geometry_shader.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -26,7 +28,7 @@ key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
} break;
}
} break;
-
+
case GLFW_RELEASE: {
switch (key)
{
@@ -72,16 +74,16 @@ main(void)
}
glfwMakeContextCurrent(window);
-
+
glfwSetKeyCallback(window, key_callback);
-
+
if (glewInit() != GLEW_OK)
{
fprintf(stderr, "[ERROR] Failed to initialize glew.\n");
glfwTerminate();
return(1);
}
-
+
glEnable(GL_DEPTH_TEST);
U32 shader = create_shader_program_geom("shaders/base.vs",
@@ -94,16 +96,16 @@ main(void)
"shaders/normals.fs",
"shaders/normals.gs");
U32 basic_shader = create_shader_program("shaders/basic.vs", "shaders/basic.fs");
-
- U32 grid_texture = load_texture("../data/textures/grid.png");
-
+
+ U32 grid_texture = load_texture("../../data/textures/grid.png");
+
F32 points[] = {
-0.5f, 0.5f, 1.0f, 0.0f, 0.0f,
- 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
- 0.5f, -0.5f, 0.0f, 0.0f, 1.0f,
+ 0.5f, 0.5f, 0.0f, 1.0f, 0.0f,
+ 0.5f, -0.5f, 0.0f, 0.0f, 1.0f,
-0.5f, -0.5f, 1.0f, 1.0f, 0.0f
};
-
+
GLuint points_vao, vbo;
glGenVertexArrays(1, &points_vao);
glBindVertexArray(points_vao);
@@ -115,59 +117,59 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 3, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(2*sizeof(F32)));
glBindVertexArray(0);
-
+
F32 a = 0.5f;
/* NOTE(pryazha): Counter-clockwise order */
F32 cube_vertices[] = {
/* NOTE(pryazha): Back face */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, -a, 1.0f, 1.0f, /* top-right */
- a, a, -a, 0.0f, 1.0f, /* top-left */
- a, -a, -a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 0.0f, 1.0f, /* top-left */
+ a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, -a, -a, 1.0f, 0.0f, /* bottom-right */
-a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Front face */
+
+ /* NOTE(pryazha): Front face */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 1.0f, 1.0f, /* top-right */
+ a, a, a, 1.0f, 1.0f, /* top-right */
-a, a, a, 0.0f, 1.0f, /* top-left */
-a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, -a, a, 1.0f, 0.0f, /* bottom-right */
- a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Left face */
+ a, -a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Left face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, a, a, 1.0f, 1.0f, /* top-right */
-a, a, -a, 0.0f, 1.0f, /* top-left */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
-a, -a, a, 1.0f, 0.0f, /* bottom-right */
-a, a, a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Right face */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
- a, a, a, 0.0f, 1.0f, /* top-left */
- a, -a, a, 0.0f, 0.0f, /* bottom-left */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Top face */
+
+ /* NOTE(pryazha): Right face */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, a, a, 0.0f, 1.0f, /* top-left */
+ a, -a, a, 0.0f, 0.0f, /* bottom-left */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Top face */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, -a, 1.0f, 1.0f, /* top-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
-a, a, -a, 0.0f, 1.0f, /* top-left */
-a, a, a, 0.0f, 0.0f, /* bottom-left */
- a, a, a, 1.0f, 0.0f, /* bottom-right */
- a, a, -a, 1.0f, 1.0f, /* top-right */
-
- /* NOTE(pryazha): Bottom face */
+ a, a, a, 1.0f, 0.0f, /* bottom-right */
+ a, a, -a, 1.0f, 1.0f, /* top-right */
+
+ /* NOTE(pryazha): Bottom face */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
-a, -a, a, 0.0f, 1.0f, /* top-left */
-a, -a, -a, 0.0f, 0.0f, /* bottom-left */
- a, -a, -a, 1.0f, 0.0f, /* bottom-right */
- a, -a, a, 1.0f, 1.0f, /* top-right */
+ a, -a, -a, 1.0f, 0.0f, /* bottom-right */
+ a, -a, a, 1.0f, 1.0f, /* top-right */
};
-
+
U32 cube_vao;
glGenVertexArrays(1, &cube_vao);
glBindVertexArray(cube_vao);
@@ -179,51 +181,51 @@ main(void)
glEnableVertexAttribArray(1);
glVertexAttribPointer(1, 2, GL_FLOAT, GL_FALSE, 5*sizeof(F32), (void *)(3*sizeof(F32)));
glBindVertexArray(0);
-
+
F32 vertices[] = {
-0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 0.0f, 0.0f,
- 0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 1.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 1.0f,
+ 0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 1.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 1.0f, 1.0f,
-0.5f, 0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 0.0f, 1.0f,
-0.5f, -0.5f, -0.5f, 0.0f, 0.0f, -1.0f, 0.0f, 0.0f,
-
+
-0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 1.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 1.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 1.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 1.0f, 1.0f,
-0.5f, 0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 0.0f, 1.0f,
-0.5f, -0.5f, 0.5f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f,
-
+
-0.5f, 0.5f, 0.5f, -1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
-0.5f, 0.5f, -0.5f, -1.0f, 0.0f, 0.0f, 1.0f, 1.0f,
-0.5f, -0.5f, -0.5f, -1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
-0.5f, -0.5f, -0.5f, -1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
-0.5f, -0.5f, 0.5f, -1.0f, 0.0f, 0.0f, 0.0f, 0.0f,
-0.5f, 0.5f, 0.5f, -1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
-
- 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 1.0f,
- 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
- 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
- 0.5f, -0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
-
+
+ 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 1.0f,
+ 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
+ 0.5f, -0.5f, -0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f,
+ 0.5f, -0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 1.0f, 0.0f, 0.0f, 1.0f, 0.0f,
+
-0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f, 0.0f, 1.0f,
- 0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 1.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 0.0f,
- 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 0.0f,
+ 0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 1.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 0.0f,
+ 0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f, 1.0f, 0.0f,
-0.5f, -0.5f, 0.5f, 0.0f, -1.0f, 0.0f, 0.0f, 0.0f,
-0.5f, -0.5f, -0.5f, 0.0f, -1.0f, 0.0f, 0.0f, 1.0f,
-
+
-0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f, 0.0f, 1.0f,
- 0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 1.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 0.0f,
- 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 1.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 0.0f,
+ 0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f, 1.0f, 0.0f,
-0.5f, 0.5f, 0.5f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f,
-0.5f, 0.5f, -0.5f, 0.0f, 1.0f, 0.0f, 0.0f, 1.0f
};
-
+
U32 normals_cube_vao;
glGenVertexArrays(1, &normals_cube_vao);
glBindVertexArray(normals_cube_vao);
@@ -237,32 +239,32 @@ main(void)
glEnableVertexAttribArray(2);
glVertexAttribPointer(2, 2, GL_FLOAT, GL_FALSE, 8*sizeof(F32), (void *)(6*sizeof(F32)));
glBindVertexArray(0);
-
+
F32 target_fps = 60.0f;
F32 target_spf = 1.0f/target_fps;
F32 last_time = glfwGetTime();
F32 time = last_time;
-
+
S32 scene = 0;
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
-
+
/* NOTE(pryazha): Update */
if (key_first_press(input.jump))
{
scene++;
scene %= 3;
}
-
+
input_update_last_state(&input);
/* NOTE(pryazha): Render */
glClearColor(0.15f, 0.15f, 0.15f, 1.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
-
+
if (scene == 0)
{
glUseProgram(shader);
@@ -296,26 +298,26 @@ main(void)
radius = 2.0f;
x = f32_sin(0.5*time)*radius;
z = f32_cos(0.5*time)*radius;
-
+
projection = perspective(90.0f, (F32)WIDTH/(F32)HEIGHT, 0.1f, 100.0f);
view = look_at(v3f(x, 1.0f, z), v3f_zero(), v3f(0.0f, 1.0f, 0.0f));
model = mat4_identity();
-
+
glUseProgram(basic_shader);
shader_set_mat4fv(basic_shader, "projection", projection);
shader_set_mat4fv(basic_shader, "view", view);
shader_set_mat4fv(basic_shader, "model", model);
draw_cube(normals_cube_vao, grid_texture);
-
+
glUseProgram(normals_shader);
shader_set_mat4fv(normals_shader, "projection", projection);
shader_set_mat4fv(normals_shader, "view", view);
shader_set_mat4fv(normals_shader, "model", model);
draw_cube(normals_cube_vao, grid_texture);
}
-
+
glfwSwapBuffers(window);
-
+
F32 elapsed = glfwGetTime()-last_time;
if (elapsed < target_spf)
{
@@ -328,10 +330,10 @@ main(void)
time += dt;
last_time = current_time;
}
-
+
glDeleteBuffers(1, &vbo);
glDeleteVertexArrays(1, &points_vao);
-
+
glfwTerminate();
return(0);
}
diff --git a/geometry_shader/shaders/base.fs b/advanced_opengl/8.geometry_shader/shaders/base.fs
index 283d885..283d885 100644
--- a/geometry_shader/shaders/base.fs
+++ b/advanced_opengl/8.geometry_shader/shaders/base.fs
diff --git a/geometry_shader/shaders/base.gs b/advanced_opengl/8.geometry_shader/shaders/base.gs
index 6b140c5..6b140c5 100644
--- a/geometry_shader/shaders/base.gs
+++ b/advanced_opengl/8.geometry_shader/shaders/base.gs
diff --git a/geometry_shader/shaders/base.vs b/advanced_opengl/8.geometry_shader/shaders/base.vs
index 2924e6c..2924e6c 100644
--- a/geometry_shader/shaders/base.vs
+++ b/advanced_opengl/8.geometry_shader/shaders/base.vs
diff --git a/geometry_shader/shaders/basic.fs b/advanced_opengl/8.geometry_shader/shaders/basic.fs
index bdd4b9a..bdd4b9a 100644
--- a/geometry_shader/shaders/basic.fs
+++ b/advanced_opengl/8.geometry_shader/shaders/basic.fs
diff --git a/geometry_shader/shaders/basic.vs b/advanced_opengl/8.geometry_shader/shaders/basic.vs
index 9a630b6..9a630b6 100644
--- a/geometry_shader/shaders/basic.vs
+++ b/advanced_opengl/8.geometry_shader/shaders/basic.vs
diff --git a/geometry_shader/shaders/explosion.fs b/advanced_opengl/8.geometry_shader/shaders/explosion.fs
index 70e7151..70e7151 100644
--- a/geometry_shader/shaders/explosion.fs
+++ b/advanced_opengl/8.geometry_shader/shaders/explosion.fs
diff --git a/geometry_shader/shaders/explosion.gs b/advanced_opengl/8.geometry_shader/shaders/explosion.gs
index 1883ad2..1883ad2 100644
--- a/geometry_shader/shaders/explosion.gs
+++ b/advanced_opengl/8.geometry_shader/shaders/explosion.gs
diff --git a/geometry_shader/shaders/explosion.vs b/advanced_opengl/8.geometry_shader/shaders/explosion.vs
index 5925b8f..5925b8f 100644
--- a/geometry_shader/shaders/explosion.vs
+++ b/advanced_opengl/8.geometry_shader/shaders/explosion.vs
diff --git a/geometry_shader/shaders/normals.fs b/advanced_opengl/8.geometry_shader/shaders/normals.fs
index fbbafbf..fbbafbf 100644
--- a/geometry_shader/shaders/normals.fs
+++ b/advanced_opengl/8.geometry_shader/shaders/normals.fs
diff --git a/geometry_shader/shaders/normals.gs b/advanced_opengl/8.geometry_shader/shaders/normals.gs
index 3720a5f..3720a5f 100644
--- a/geometry_shader/shaders/normals.gs
+++ b/advanced_opengl/8.geometry_shader/shaders/normals.gs
diff --git a/geometry_shader/shaders/normals.vs b/advanced_opengl/8.geometry_shader/shaders/normals.vs
index 3b728e5..3b728e5 100644
--- a/geometry_shader/shaders/normals.vs
+++ b/advanced_opengl/8.geometry_shader/shaders/normals.vs
diff --git a/instancing/build.sh b/advanced_opengl/9.instancing/build.sh
index f9c9bf0..40b314b 100755
--- a/instancing/build.sh
+++ b/advanced_opengl/9.instancing/build.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-. ../config
+. ../../config
TARGET='instancing'
set -x
gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/advanced_opengl/9.instancing/instancing b/advanced_opengl/9.instancing/instancing
new file mode 100755
index 0000000..08b099d
--- /dev/null
+++ b/advanced_opengl/9.instancing/instancing
Binary files differ
diff --git a/instancing/instancing.c b/advanced_opengl/9.instancing/instancing.c
index b789c51..90647fb 100644
--- a/instancing/instancing.c
+++ b/advanced_opengl/9.instancing/instancing.c
@@ -3,6 +3,8 @@
#include "pwyazh.h"
+#include "pwyazh_GL.h"
+
#include "common.h"
#include <unistd.h>
@@ -113,7 +115,7 @@ main(void)
glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 3);
glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 3);
glfwWindowHint(GLFW_OPENGL_PROFILE, GLFW_OPENGL_CORE_PROFILE);
- window = glfwCreateWindow(global_width, global_height, "depth testing", 0, 0);
+ window = glfwCreateWindow(global_width, global_height, "Instancing", 0, 0);
if (!window)
{
fprintf(stderr, "[ERROR] Failed to create window.\n");
@@ -198,12 +200,12 @@ main(void)
U32 default_shader = create_shader_program("shaders/default.vs", "shaders/default.fs");
U32 instanced_shader = create_shader_program("shaders/instanced_mat4.vs",
"shaders/instanced_mat4.fs");
- Mesh *planet_mesh = mesh_load_obj(arena, "../data/models/planet/planet.obj");
- U32 planet_texture = load_texture("../data/models/planet/mars.png");
- Mesh *rock_mesh = mesh_load_obj(arena, "../data/models/rock/rock.obj");
- U32 rock_texture = load_texture("../data/models/rock/rock.png");
-
- S32 amount = 100000;
+ Mesh *planet_mesh = mesh_load_obj(arena, "../../data/models/planet/planet.obj");
+ U32 planet_texture = load_texture("../../data/models/planet/mars.png");
+ Mesh *rock_mesh = mesh_load_obj(arena, "../../data/models/rock/rock.obj");
+ U32 rock_texture = load_texture("../../data/models/rock/rock.png");
+
+ S32 amount = 80000;
F32 radius = 150.0f;
offset = 25.0f;
MAT4 trns[amount];
@@ -211,13 +213,13 @@ main(void)
{
F32 angle, displacement, x, y, z, scale;
MAT4 model = mat4_identity();
-
+
angle = rand()%360;
model = mat4_rotate_angles(model, v3f(angle, angle, angle));
-
+
scale = (rand()%20)/100.0f+0.05f;
model = mat4_scale(model, v3f(scale, scale, scale));
-
+
angle = ((F32)i/(F32)amount)*360.0f;
displacement = (rand()%(S32)(2.0f*offset))-offset;
x = f32_sin(DEG2RAD*angle)*radius+displacement;
@@ -226,10 +228,10 @@ main(void)
displacement = (rand()%(S32)(2.0f*offset))-offset;
z = f32_cos(DEG2RAD*angle)*radius;
model = mat4_translate(model, v3f(x, y, z));
-
+
trns[i] = model;
}
-
+
U32 buffer;
glGenBuffers(1, &buffer);
glBindBuffer(GL_ARRAY_BUFFER, buffer);
@@ -243,7 +245,7 @@ main(void)
glVertexAttribPointer(5, 4, GL_FLOAT, GL_FALSE, 4*sizeof(V4F), (void *)(2*sizeof(V4F)));
glEnableVertexAttribArray(6);
glVertexAttribPointer(6, 4, GL_FLOAT, GL_FALSE, 4*sizeof(V4F), (void *)(3*sizeof(V4F)));
-
+
glVertexAttribDivisor(3, 1);
glVertexAttribDivisor(4, 1);
glVertexAttribDivisor(5, 1);
@@ -259,15 +261,15 @@ main(void)
S32 scene = 0;
S32 number_scene = 4;
-
+
MAT4 projection, view, model;
-
- V3F camera_pos = v3f(0.0f, 10.0f, 80.0f);
+
+ V3F camera_pos = v3f(0.0f, 50.0f, 220.0f);
F32 camera_speed = 10.0f;
F32 fovx = 90.0f;
F32 near = 0.1f;
F32 far = 1000.0f;
-
+
while (!glfwWindowShouldClose(window))
{
glfwPollEvents();
@@ -297,47 +299,47 @@ main(void)
switch (scene)
{
case 0: {
- glUseProgram(instancing_uniform_array_shader);
- for (S32 translation_index = 0;
- translation_index < 100;
- ++translation_index)
- {
- char temp[256];
- snprintf(temp, 256, "offsets[%d]", translation_index);
- shader_set_2fv(instancing_uniform_array_shader,
- temp, translations[translation_index]);
- }
- glBindVertexArray(quad_vao);
- glDrawArraysInstanced(GL_TRIANGLES, 0, 6, 100);
- glBindVertexArray(0);
+ glUseProgram(instancing_uniform_array_shader);
+ for (S32 translation_index = 0;
+ translation_index < 100;
+ ++translation_index)
+ {
+ char temp[256];
+ snprintf(temp, 256, "offsets[%d]", translation_index);
+ shader_set_2fv(instancing_uniform_array_shader,
+ temp, translations[translation_index]);
+ }
+ glBindVertexArray(quad_vao);
+ glDrawArraysInstanced(GL_TRIANGLES, 0, 6, 100);
+ glBindVertexArray(0);
} break;
-
+
case 1: {
glUseProgram(instanced_arrays_shader);
glBindVertexArray(quad_vao);
glDrawArraysInstanced(GL_TRIANGLES, 0, 6, 100);
glBindVertexArray(0);
} break;
-
+
case 2: {
- camera_pos = update_camera_pos_orbital(global_input,
- camera_pos, v3f_zero(),
- dt, camera_speed);
-
+ camera_pos = update_camera_orbital(global_input,
+ camera_pos, v3f_zero(),
+ dt, camera_speed);
+
projection = perspective(fovx, (F32)global_width/(F32)global_height, near, far);
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
view = look_at(camera_pos, v3f_zero(), world_up);
-
+
glUseProgram(default_shader);
shader_set_mat4fv(default_shader, "projection", projection);
shader_set_mat4fv(default_shader, "view", view);
-
- F32 scale = 4.0f;
+
+ F32 scale = 5.0f;
model = mat4_make_scale(v3f(scale, scale, scale));
shader_set_mat4fv(default_shader, "model", model);
glBindTexture(GL_TEXTURE_2D, planet_texture);
mesh_draw(planet_mesh);
-
+
glBindTexture(GL_TEXTURE_2D, rock_texture);
for (S32 i = 0; i < amount; ++i)
{
@@ -346,26 +348,26 @@ main(void)
mesh_draw(rock_mesh);
}
} break;
-
+
case 3: {
- camera_pos = update_camera_pos_orbital(global_input,
- camera_pos, v3f_zero(),
- dt, camera_speed);
-
+ camera_pos = update_camera_orbital(global_input,
+ camera_pos, v3f_zero(),
+ dt, camera_speed);
+
projection = perspective(fovx, (F32)global_width/(F32)global_height, near, far);
V3F world_up = v3f(0.0f, 1.0f, 0.0f);
view = look_at(camera_pos, v3f_zero(), world_up);
-
+
glUseProgram(default_shader);
shader_set_mat4fv(default_shader, "projection", projection);
shader_set_mat4fv(default_shader, "view", view);
- F32 scale = 4.0f;
+ F32 scale = 5.0f;
model = mat4_make_scale(v3f(scale, scale, scale));
shader_set_mat4fv(default_shader, "model", model);
glBindTexture(GL_TEXTURE_2D, planet_texture);
mesh_draw(planet_mesh);
glBindTexture(GL_TEXTURE_2D, 0);
-
+
glUseProgram(instanced_shader);
shader_set_mat4fv(default_shader, "projection", projection);
shader_set_mat4fv(default_shader, "view", view);
@@ -379,7 +381,7 @@ main(void)
}
input_update_last_state(&global_input);
-
+
glfwSwapBuffers(window);
F32 elapsed = glfwGetTime()-last_time;
@@ -391,8 +393,6 @@ main(void)
}
F32 current_time = glfwGetTime();
dt = current_time-last_time;
- printf("dt: %f\n", dt);
- printf("fps: %f\n\n", 1.0f/dt);
time += dt;
last_time = current_time;
}
diff --git a/instancing/shaders/default.fs b/advanced_opengl/9.instancing/shaders/default.fs
index c655ac8..c655ac8 100644
--- a/instancing/shaders/default.fs
+++ b/advanced_opengl/9.instancing/shaders/default.fs
diff --git a/instancing/shaders/default.vs b/advanced_opengl/9.instancing/shaders/default.vs
index 85d3c19..85d3c19 100644
--- a/instancing/shaders/default.vs
+++ b/advanced_opengl/9.instancing/shaders/default.vs
diff --git a/instancing/shaders/instanced_arrays.fs b/advanced_opengl/9.instancing/shaders/instanced_arrays.fs
index a32e52e..a32e52e 100644
--- a/instancing/shaders/instanced_arrays.fs
+++ b/advanced_opengl/9.instancing/shaders/instanced_arrays.fs
diff --git a/instancing/shaders/instanced_arrays.vs b/advanced_opengl/9.instancing/shaders/instanced_arrays.vs
index e7bbeb7..e7bbeb7 100644
--- a/instancing/shaders/instanced_arrays.vs
+++ b/advanced_opengl/9.instancing/shaders/instanced_arrays.vs
diff --git a/instancing/shaders/instanced_mat4.fs b/advanced_opengl/9.instancing/shaders/instanced_mat4.fs
index ae625b2..ae625b2 100644
--- a/instancing/shaders/instanced_mat4.fs
+++ b/advanced_opengl/9.instancing/shaders/instanced_mat4.fs
diff --git a/instancing/shaders/instanced_mat4.vs b/advanced_opengl/9.instancing/shaders/instanced_mat4.vs
index 5ab3a81..5ab3a81 100644
--- a/instancing/shaders/instanced_mat4.vs
+++ b/advanced_opengl/9.instancing/shaders/instanced_mat4.vs
diff --git a/instancing/shaders/instancing_uniform_array.fs b/advanced_opengl/9.instancing/shaders/instancing_uniform_array.fs
index a32e52e..a32e52e 100644
--- a/instancing/shaders/instancing_uniform_array.fs
+++ b/advanced_opengl/9.instancing/shaders/instancing_uniform_array.fs
diff --git a/instancing/shaders/instancing_uniform_array.vs b/advanced_opengl/9.instancing/shaders/instancing_uniform_array.vs
index a77be31..a77be31 100644
--- a/instancing/shaders/instancing_uniform_array.vs
+++ b/advanced_opengl/9.instancing/shaders/instancing_uniform_array.vs
diff --git a/config b/config
index b1bccb4..4f3976b 100644
--- a/config
+++ b/config
@@ -1,4 +1,4 @@
CFLAGS='-g -Wall -Wextra -Wno-unused-parameter'
-INCLUDE='-I../libs/pwyazh -I../libs/glew/include -I../libs/glfw/include -I../libs -I../libs/tinyobjloader-c'
-LFLAGS='-L../libs/glew/lib -L../libs/glfw/lib'
+INCLUDE='-I../../libs/pwyazh -I../../libs/glew/include -I../../libs/glfw/include -I../../libs -I../../libs/tinyobjloader-c'
+LFLAGS='-L../../libs/glew/lib -L../../libs/glfw/lib'
LIBS='-lm -lGL -l:libGLEW.a -l:libglfw3.a'
diff --git a/mesh_loading_test/what_cube/what_cube.mtl b/data/models/cube.mtl
index f3f61c7..ba7f770 100644
--- a/mesh_loading_test/what_cube/what_cube.mtl
+++ b/data/models/cube.mtl
@@ -1,4 +1,4 @@
-# Blender 4.3.1 MTL File: 'what_cube.blend'
+# Blender 4.3.1 MTL File: 'None'
# www.blender.org
newmtl Material
@@ -7,7 +7,6 @@ Ka 1.000000 1.000000 1.000000
Kd 0.800000 0.800000 0.800000
Ks 0.500000 0.500000 0.500000
Ke 0.000000 0.000000 0.000000
-Ni 1.000000
+Ni 1.450000
d 1.000000
illum 2
-map_Kd pryazha.jpg
diff --git a/data/models/cube.obj b/data/models/cube.obj
new file mode 100644
index 0000000..f40e456
--- /dev/null
+++ b/data/models/cube.obj
@@ -0,0 +1,40 @@
+# Blender 4.3.1
+# www.blender.org
+mtllib cube.mtl
+o Cube
+v 1.000000 1.000000 -1.000000
+v 1.000000 -1.000000 -1.000000
+v 1.000000 1.000000 1.000000
+v 1.000000 -1.000000 1.000000
+v -1.000000 1.000000 -1.000000
+v -1.000000 -1.000000 -1.000000
+v -1.000000 1.000000 1.000000
+v -1.000000 -1.000000 1.000000
+vn -0.0000 1.0000 -0.0000
+vn -0.0000 -0.0000 1.0000
+vn -1.0000 -0.0000 -0.0000
+vn -0.0000 -1.0000 -0.0000
+vn 1.0000 -0.0000 -0.0000
+vn -0.0000 -0.0000 -1.0000
+vt 0.625000 0.500000
+vt 0.875000 0.500000
+vt 0.875000 0.750000
+vt 0.625000 0.750000
+vt 0.375000 0.750000
+vt 0.625000 1.000000
+vt 0.375000 1.000000
+vt 0.375000 0.000000
+vt 0.625000 0.000000
+vt 0.625000 0.250000
+vt 0.375000 0.250000
+vt 0.125000 0.500000
+vt 0.375000 0.500000
+vt 0.125000 0.750000
+s 0
+usemtl Material
+f 1/1/1 5/2/1 7/3/1 3/4/1
+f 4/5/2 3/4/2 7/6/2 8/7/2
+f 8/8/3 7/9/3 5/10/3 6/11/3
+f 6/12/4 2/13/4 4/5/4 8/14/4
+f 2/13/5 1/1/5 3/4/5 4/5/5
+f 6/11/6 5/10/6 1/1/6 2/13/6
diff --git a/data/textures/oak_veneer_01_diff_4k.jpg b/data/textures/oak_veneer_01_diff_4k.jpg
new file mode 100644
index 0000000..5432ab4
--- /dev/null
+++ b/data/textures/oak_veneer_01_diff_4k.jpg
Binary files differ
diff --git a/depth/build.sh b/depth/build.sh
deleted file mode 100755
index 961ce78..0000000
--- a/depth/build.sh
+++ /dev/null
@@ -1,4 +0,0 @@
-#!/bin/sh
-. ../config
-set -x
-gcc -o depth $CFLAGS $INCLUDE $LFLAGS depth.c $LIBS && ./depth
diff --git a/libs/common.h b/libs/common.h
index 098bc9a..481e356 100644
--- a/libs/common.h
+++ b/libs/common.h
@@ -632,35 +632,66 @@ look_at(V3F eye, V3F target, V3F up)
return(result);
}
+typedef struct {
+ V3F pos;
+ F32 fovx;
+ F32 near;
+ F32 far;
+} Camera;
+
V3F
-update_camera_pos_orbital(Input input, V3F pos, V3F target,
- F32 dt, F32 speed)
+get_dv_camera_orbital(Input *input, V3F pos, V3F target,
+ F32 dt, F32 speed)
{
- V3F up, f, l, u, dp, new_pos;
-
+ V3F up, f, l, u, dv;
+
up = v3f(0.0f, 1.0f, 0.0f);
f = v3f_norm(v3f_sub(target, pos));
l = v3f_norm(v3f_cross(up, f));
u = v3f_cross(f, l);
-
- dp = v3f_zero();
-
- if (key_is_pressed(input.move_right))
- dp = v3f_sub(dp, l);
- if (key_is_pressed(input.move_forward))
- dp = v3f_add(dp, f);
- if (key_is_pressed(input.move_left))
- dp = v3f_add(dp, l);
- if (key_is_pressed(input.move_backward))
- dp = v3f_sub(dp, f);
- if (key_is_pressed(input.move_up))
- dp = v3f_add(dp, u);
- if (key_is_pressed(input.move_down))
- dp = v3f_sub(dp, u);
-
- new_pos = v3f_add(pos, v3f_scalef(dp, speed*dt));
-
- return(new_pos);
+
+ dv = v3f_zero();
+
+ /*
+ if (key_is_pressed(input->move_right))
+ dv = v3f_sub(dv, l);
+ if (key_is_pressed(input->move_forward))
+ dv = v3f_add(dv, f);
+ if (key_is_pressed(input->move_left))
+ dv = v3f_add(dv, l);
+ if (key_is_pressed(input->move_backward))
+ dv = v3f_sub(dv, f);
+ if (key_is_pressed(input->move_up))
+ dv = v3f_add(dv, u);
+ if (key_is_pressed(input->move_down))
+ dv = v3f_sub(dv, u);
+ */
+ if (key_is_pressed(input->move_right))
+ {
+ dv = v3f_sub(dv, l);
+ dv = v3f_add(dv, f);
+ dv = v3f_norm(dv);
+ }
+ if (key_is_pressed(input->move_forward))
+ dv = v3f_add(dv, f);
+ if (key_is_pressed(input->move_left))
+ dv = v3f_add(dv, l);
+ if (key_is_pressed(input->move_backward))
+ dv = v3f_sub(dv, f);
+ if (key_is_pressed(input->move_up))
+ dv = v3f_add(dv, u);
+ if (key_is_pressed(input->move_down))
+ dv = v3f_sub(dv, u);
+
+ dv = v3f_scalef(dv, speed*dt);
+
+ return(dv);
}
+typedef struct {
+ Camera camera;
+ Mesh *mesh;
+ F32 dt;
+} State;
+
#endif /* COMMON_H */
diff --git a/libs/glfw/include/GLFW/glfw3.h b/libs/glfw/include/GLFW/glfw3.h
index 79b0628..a077ec9 100644
--- a/libs/glfw/include/GLFW/glfw3.h
+++ b/libs/glfw/include/GLFW/glfw3.h
@@ -32,326 +32,326 @@
#ifdef __cplusplus
extern "C" {
#endif
-
-
-/*************************************************************************
- * Doxygen documentation
- *************************************************************************/
-
-/*! @file glfw3.h
- * @brief 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 @ref build_include.
- */
-/*! @defgroup context Context reference
- * @brief Functions and types related to OpenGL and OpenGL ES contexts.
- *
- * This is the reference documentation for OpenGL and OpenGL ES context related
- * functions. For more task-oriented information, see the @ref context_guide.
- */
-/*! @defgroup vulkan Vulkan support reference
- * @brief Functions and types related to Vulkan.
- *
- * This is the reference documentation for Vulkan related functions and types.
- * For more task-oriented information, see the @ref vulkan_guide.
- */
-/*! @defgroup init Initialization, version and error reference
- * @brief Functions and types related to initialization and error handling.
- *
- * This is the reference documentation for initialization and termination of
- * the library, version management and error handling. For more task-oriented
- * information, see the @ref intro_guide.
- */
-/*! @defgroup input Input reference
- * @brief Functions and types related to input handling.
- *
- * This is the reference documentation for input related functions and types.
- * For more task-oriented information, see the @ref input_guide.
- */
-/*! @defgroup monitor Monitor reference
- * @brief Functions and types related to monitors.
- *
- * This is the reference documentation for monitor related functions and types.
- * For more task-oriented information, see the @ref monitor_guide.
- */
-/*! @defgroup window Window reference
- * @brief Functions and types related to windows.
- *
- * This is the reference documentation for window related functions and types,
- * including creation, deletion and event polling. For more task-oriented
- * information, see the @ref window_guide.
- */
-
-
-/*************************************************************************
- * Compiler- and platform-specific preprocessor work
- *************************************************************************/
-
-/* If we are we on Windows, we want a single define for it.
- */
+
+
+ /*************************************************************************
+ * Doxygen documentation
+ *************************************************************************/
+
+ /*! @file glfw3.h
+ * @brief 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 @ref build_include.
+ */
+ /*! @defgroup context Context reference
+ * @brief Functions and types related to OpenGL and OpenGL ES contexts.
+ *
+ * This is the reference documentation for OpenGL and OpenGL ES context related
+ * functions. For more task-oriented information, see the @ref context_guide.
+ */
+ /*! @defgroup vulkan Vulkan support reference
+ * @brief Functions and types related to Vulkan.
+ *
+ * This is the reference documentation for Vulkan related functions and types.
+ * For more task-oriented information, see the @ref vulkan_guide.
+ */
+ /*! @defgroup init Initialization, version and error reference
+ * @brief Functions and types related to initialization and error handling.
+ *
+ * This is the reference documentation for initialization and termination of
+ * the library, version management and error handling. For more task-oriented
+ * information, see the @ref intro_guide.
+ */
+ /*! @defgroup input Input reference
+ * @brief Functions and types related to input handling.
+ *
+ * This is the reference documentation for input related functions and types.
+ * For more task-oriented information, see the @ref input_guide.
+ */
+ /*! @defgroup monitor Monitor reference
+ * @brief Functions and types related to monitors.
+ *
+ * This is the reference documentation for monitor related functions and types.
+ * For more task-oriented information, see the @ref monitor_guide.
+ */
+ /*! @defgroup window Window reference
+ * @brief Functions and types related to windows.
+ *
+ * This is the reference documentation for window related functions and types,
+ * including creation, deletion and event polling. For more task-oriented
+ * information, see the @ref window_guide.
+ */
+
+
+ /*************************************************************************
+ * 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
+#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 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 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>
+#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.
- */
+
+ /* 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
+#if defined(_WIN32)
+#define APIENTRY __stdcall
+#else
+#define APIENTRY
+#endif
+#define GLFW_APIENTRY_DEFINED
#endif /* APIENTRY */
-
-/* Some Windows OpenGL headers need this.
- */
+
+ /* Some Windows OpenGL headers need this.
+ */
#if !defined(WINGDIAPI) && defined(_WIN32)
- #define WINGDIAPI __declspec(dllimport)
- #define GLFW_WINGDIAPI_DEFINED
+#define WINGDIAPI __declspec(dllimport)
+#define GLFW_WINGDIAPI_DEFINED
#endif /* WINGDIAPI */
-
-/* Some Windows GLU headers need this.
- */
+
+ /* Some Windows GLU headers need this.
+ */
#if !defined(CALLBACK) && defined(_WIN32)
- #define CALLBACK __stdcall
- #define GLFW_CALLBACK_DEFINED
+#define CALLBACK __stdcall
+#define GLFW_CALLBACK_DEFINED
#endif /* CALLBACK */
-
-/* Include the chosen OpenGL or OpenGL ES headers.
- */
+
+ /* 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
-
+
+#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
-
+
+#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
-
+
+#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
-
+
+#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
-
+
+#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__*/
-
+
+#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__*/
-
+
+#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__*/
-
+!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"
+ /* 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.
- */
+
+ /* 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)
+ /* We are building GLFW as a Win32 DLL */
+#define GLFWAPI __declspec(dllexport)
#elif defined(_WIN32) && defined(GLFW_DLL)
- /* We are calling a GLFW Win32 DLL */
- #define GLFWAPI __declspec(dllimport)
+ /* We are calling a GLFW Win32 DLL */
+#define GLFWAPI __declspec(dllimport)
#elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL)
- /* We are building GLFW as a Unix shared library */
- #define GLFWAPI __attribute__((visibility("default")))
+ /* We are building GLFW as a Unix shared library */
+#define GLFWAPI __attribute__((visibility("default")))
#else
- #define GLFWAPI
+#define GLFWAPI
#endif
-
-
-/*************************************************************************
- * GLFW API tokens
- *************************************************************************/
-
-/*! @name GLFW version macros
- * @{ */
-/*! @brief The major version number of the GLFW header.
- *
- * The major version number of the GLFW header. This is incremented when the
- * API is changed in non-compatible ways.
- * @ingroup init
- */
+
+
+ /*************************************************************************
+ * GLFW API tokens
+ *************************************************************************/
+
+ /*! @name GLFW version macros
+ * @{ */
+ /*! @brief The major version number of the GLFW header.
+ *
+ * The major version number of the GLFW header. This is incremented when the
+ * API is changed in non-compatible ways.
+ * @ingroup init
+ */
#define GLFW_VERSION_MAJOR 3
-/*! @brief The minor version number of the GLFW header.
- *
- * The minor version number of the GLFW header. This is incremented when
- * features are added to the API but it remains backward-compatible.
- * @ingroup init
- */
+ /*! @brief The minor version number of the GLFW header.
+ *
+ * The minor version number of the GLFW header. This is incremented when
+ * features are added to the API but it remains backward-compatible.
+ * @ingroup init
+ */
#define GLFW_VERSION_MINOR 5
-/*! @brief The revision number of the GLFW header.
- *
- * The revision number of the GLFW header. This is incremented when a bug fix
- * release is made that does not contain any API changes.
- * @ingroup init
- */
+ /*! @brief The revision number of the GLFW header.
+ *
+ * The revision number of the GLFW header. This is incremented when a bug fix
+ * release is made that does not contain any API changes.
+ * @ingroup init
+ */
#define GLFW_VERSION_REVISION 0
-/*! @} */
-
-/*! @brief One.
- *
- * This is only semantic sugar for the number 1. You can instead use `1` or
- * `true` or `_True` or `GL_TRUE` or `VK_TRUE` or anything else that is equal
- * to one.
- *
- * @ingroup init
- */
+ /*! @} */
+
+ /*! @brief One.
+ *
+ * This is only semantic sugar for the number 1. You can instead use `1` or
+ * `true` or `_True` or `GL_TRUE` or `VK_TRUE` or anything else that is equal
+ * to one.
+ *
+ * @ingroup init
+ */
#define GLFW_TRUE 1
-/*! @brief Zero.
- *
- * This is only semantic sugar for the number 0. You can instead use `0` or
- * `false` or `_False` or `GL_FALSE` or `VK_FALSE` or anything else that is
- * equal to zero.
- *
- * @ingroup init
- */
+ /*! @brief Zero.
+ *
+ * This is only semantic sugar for the number 0. You can instead use `0` or
+ * `false` or `_False` or `GL_FALSE` or `VK_FALSE` or anything else that is
+ * equal to zero.
+ *
+ * @ingroup init
+ */
#define GLFW_FALSE 0
-
-/*! @name Key and button actions
- * @{ */
-/*! @brief The key or mouse button was released.
- *
- * The key or mouse button was released.
- *
- * @ingroup input
- */
+
+ /*! @name Key and button actions
+ * @{ */
+ /*! @brief The key or mouse button was released.
+ *
+ * The key or mouse button was released.
+ *
+ * @ingroup input
+ */
#define GLFW_RELEASE 0
-/*! @brief The key or mouse button was pressed.
- *
- * The key or mouse button was pressed.
- *
- * @ingroup input
- */
+ /*! @brief The key or mouse button was pressed.
+ *
+ * The key or mouse button was pressed.
+ *
+ * @ingroup input
+ */
#define GLFW_PRESS 1
-/*! @brief The key was held down until it repeated.
- *
- * The key was held down until it repeated.
- *
- * @ingroup input
- */
+ /*! @brief The key was held down until it repeated.
+ *
+ * The key was held down until it repeated.
+ *
+ * @ingroup input
+ */
#define GLFW_REPEAT 2
-/*! @} */
-
-/*! @defgroup hat_state Joystick hat states
- * @brief Joystick hat states.
- *
- * See [joystick hat input](@ref joystick_hat) for how these are used.
- *
- * @ingroup input
- * @{ */
+ /*! @} */
+
+ /*! @defgroup hat_state Joystick hat states
+ * @brief Joystick hat states.
+ *
+ * See [joystick hat input](@ref joystick_hat) for how these are used.
+ *
+ * @ingroup input
+ * @{ */
#define GLFW_HAT_CENTERED 0
#define GLFW_HAT_UP 1
#define GLFW_HAT_RIGHT 2
@@ -361,38 +361,38 @@ extern "C" {
#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)
-
-/*! @ingroup input
- */
+
+ /*! @ingroup input
+ */
#define GLFW_KEY_UNKNOWN -1
-
-/*! @} */
-
-/*! @defgroup keys Keyboard key tokens
- * @brief Keyboard key tokens.
- *
- * See [key input](@ref input_key) for how these are used.
- *
- * These key codes are inspired by the _USB HID Usage Tables v1.12_ (p. 53-60),
- * but re-arranged to map to 7-bit ASCII for printable keys (function keys are
- * put in the 256+ range).
- *
- * The naming of the key codes follow these rules:
- * - The US keyboard layout is used
- * - Names of printable alphanumeric characters are used (e.g. "A", "R",
- * "3", etc.)
- * - For non-alphanumeric characters, Unicode:ish names are used (e.g.
- * "COMMA", "LEFT_SQUARE_BRACKET", etc.). Note that some names do not
- * correspond to the Unicode standard (usually for brevity)
- * - Keys that lack a clear US mapping are named "WORLD_x"
- * - For non-printable keys, custom names are used (e.g. "F4",
- * "BACKSPACE", etc.)
- *
- * @ingroup input
- * @{
- */
-
-/* Printable keys */
+
+ /*! @} */
+
+ /*! @defgroup keys Keyboard key tokens
+ * @brief Keyboard key tokens.
+ *
+ * See [key input](@ref input_key) for how these are used.
+ *
+ * These key codes are inspired by the _USB HID Usage Tables v1.12_ (p. 53-60),
+ * but re-arranged to map to 7-bit ASCII for printable keys (function keys are
+ * put in the 256+ range).
+ *
+ * The naming of the key codes follow these rules:
+ * - The US keyboard layout is used
+ * - Names of printable alphanumeric characters are used (e.g. "A", "R",
+ * "3", etc.)
+ * - For non-alphanumeric characters, Unicode:ish names are used (e.g.
+ * "COMMA", "LEFT_SQUARE_BRACKET", etc.). Note that some names do not
+ * correspond to the Unicode standard (usually for brevity)
+ * - Keys that lack a clear US mapping are named "WORLD_x"
+ * - For non-printable keys, custom names are used (e.g. "F4",
+ * "BACKSPACE", etc.)
+ *
+ * @ingroup input
+ * @{
+ */
+
+ /* Printable keys */
#define GLFW_KEY_SPACE 32
#define GLFW_KEY_APOSTROPHE 39 /* ' */
#define GLFW_KEY_COMMA 44 /* , */
@@ -443,8 +443,8 @@ extern "C" {
#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 */
+
+ /* Function keys */
#define GLFW_KEY_ESCAPE 256
#define GLFW_KEY_ENTER 257
#define GLFW_KEY_TAB 258
@@ -515,61 +515,61 @@ extern "C" {
#define GLFW_KEY_RIGHT_ALT 346
#define GLFW_KEY_RIGHT_SUPER 347
#define GLFW_KEY_MENU 348
-
+
#define GLFW_KEY_LAST GLFW_KEY_MENU
-
-/*! @} */
-
-/*! @defgroup mods Modifier key flags
- * @brief Modifier key flags.
- *
- * See [key input](@ref input_key) for how these are used.
- *
- * @ingroup input
- * @{ */
-
-/*! @brief If this bit is set one or more Shift keys were held down.
- *
- * If this bit is set one or more Shift keys were held down.
- */
+
+ /*! @} */
+
+ /*! @defgroup mods Modifier key flags
+ * @brief Modifier key flags.
+ *
+ * See [key input](@ref input_key) for how these are used.
+ *
+ * @ingroup input
+ * @{ */
+
+ /*! @brief If this bit is set one or more Shift keys were held down.
+ *
+ * If this bit is set one or more Shift keys were held down.
+ */
#define GLFW_MOD_SHIFT 0x0001
-/*! @brief If this bit is set one or more Control keys were held down.
- *
- * If this bit is set one or more Control keys were held down.
- */
+ /*! @brief If this bit is set one or more Control keys were held down.
+ *
+ * If this bit is set one or more Control keys were held down.
+ */
#define GLFW_MOD_CONTROL 0x0002
-/*! @brief If this bit is set one or more Alt keys were held down.
- *
- * If this bit is set one or more Alt keys were held down.
- */
+ /*! @brief If this bit is set one or more Alt keys were held down.
+ *
+ * If this bit is set one or more Alt keys were held down.
+ */
#define GLFW_MOD_ALT 0x0004
-/*! @brief If this bit is set one or more Super keys were held down.
- *
- * If this bit is set one or more Super keys were held down.
- */
+ /*! @brief If this bit is set one or more Super keys were held down.
+ *
+ * If this bit is set one or more Super keys were held down.
+ */
#define GLFW_MOD_SUPER 0x0008
-/*! @brief If this bit is set the Caps Lock key is enabled.
- *
- * If this bit is set the Caps Lock key is enabled and the @ref
- * GLFW_LOCK_KEY_MODS input mode is set.
- */
+ /*! @brief If this bit is set the Caps Lock key is enabled.
+ *
+ * If this bit is set the Caps Lock key is enabled and the @ref
+ * GLFW_LOCK_KEY_MODS input mode is set.
+ */
#define GLFW_MOD_CAPS_LOCK 0x0010
-/*! @brief If this bit is set the Num Lock key is enabled.
- *
- * If this bit is set the Num Lock key is enabled and the @ref
- * GLFW_LOCK_KEY_MODS input mode is set.
- */
+ /*! @brief If this bit is set the Num Lock key is enabled.
+ *
+ * If this bit is set the Num Lock key is enabled and the @ref
+ * GLFW_LOCK_KEY_MODS input mode is set.
+ */
#define GLFW_MOD_NUM_LOCK 0x0020
-
-/*! @} */
-
-/*! @defgroup buttons Mouse buttons
- * @brief Mouse button IDs.
- *
- * See [mouse button input](@ref input_mouse_button) for how these are used.
- *
- * @ingroup input
- * @{ */
+
+ /*! @} */
+
+ /*! @defgroup buttons Mouse buttons
+ * @brief Mouse button IDs.
+ *
+ * See [mouse button input](@ref input_mouse_button) for how these are used.
+ *
+ * @ingroup input
+ * @{ */
#define GLFW_MOUSE_BUTTON_1 0
#define GLFW_MOUSE_BUTTON_2 1
#define GLFW_MOUSE_BUTTON_3 2
@@ -582,15 +582,15 @@ extern "C" {
#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
-/*! @} */
-
-/*! @defgroup joysticks Joysticks
- * @brief Joystick IDs.
- *
- * See [joystick input](@ref joystick) for how these are used.
- *
- * @ingroup input
- * @{ */
+ /*! @} */
+
+ /*! @defgroup joysticks Joysticks
+ * @brief Joystick IDs.
+ *
+ * See [joystick input](@ref joystick) for how these are used.
+ *
+ * @ingroup input
+ * @{ */
#define GLFW_JOYSTICK_1 0
#define GLFW_JOYSTICK_2 1
#define GLFW_JOYSTICK_3 2
@@ -608,15 +608,15 @@ extern "C" {
#define GLFW_JOYSTICK_15 14
#define GLFW_JOYSTICK_16 15
#define GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16
-/*! @} */
-
-/*! @defgroup gamepad_buttons Gamepad buttons
- * @brief Gamepad buttons.
- *
- * See @ref gamepad for how these are used.
- *
- * @ingroup input
- * @{ */
+ /*! @} */
+
+ /*! @defgroup gamepad_buttons Gamepad buttons
+ * @brief Gamepad buttons.
+ *
+ * See @ref gamepad for how these are used.
+ *
+ * @ingroup input
+ * @{ */
#define GLFW_GAMEPAD_BUTTON_A 0
#define GLFW_GAMEPAD_BUTTON_B 1
#define GLFW_GAMEPAD_BUTTON_X 2
@@ -633,20 +633,20 @@ extern "C" {
#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
-/*! @} */
-
-/*! @defgroup gamepad_axes Gamepad axes
- * @brief Gamepad axes.
- *
- * See @ref gamepad for how these are used.
- *
- * @ingroup input
- * @{ */
+ /*! @} */
+
+ /*! @defgroup gamepad_axes Gamepad axes
+ * @brief Gamepad axes.
+ *
+ * See @ref gamepad for how these are used.
+ *
+ * @ingroup input
+ * @{ */
#define GLFW_GAMEPAD_AXIS_LEFT_X 0
#define GLFW_GAMEPAD_AXIS_LEFT_Y 1
#define GLFW_GAMEPAD_AXIS_RIGHT_X 2
@@ -654,521 +654,521 @@ extern "C" {
#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4
#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5
#define GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
-/*! @} */
-
-/*! @defgroup errors Error codes
- * @brief Error codes.
- *
- * See [error handling](@ref error_handling) for how these are used.
- *
- * @ingroup init
- * @{ */
-/*! @brief No error has occurred.
- *
- * No error has occurred.
- *
- * @analysis Yay.
- */
+ /*! @} */
+
+ /*! @defgroup errors Error codes
+ * @brief Error codes.
+ *
+ * See [error handling](@ref error_handling) for how these are used.
+ *
+ * @ingroup init
+ * @{ */
+ /*! @brief No error has occurred.
+ *
+ * No error has occurred.
+ *
+ * @analysis Yay.
+ */
#define GLFW_NO_ERROR 0
-/*! @brief GLFW has not been initialized.
- *
- * This occurs if a GLFW function was called that must not be called unless the
- * library is [initialized](@ref intro_init).
- *
- * @analysis Application programmer error. Initialize GLFW before calling any
- * function that requires initialization.
- */
+ /*! @brief GLFW has not been initialized.
+ *
+ * This occurs if a GLFW function was called that must not be called unless the
+ * library is [initialized](@ref intro_init).
+ *
+ * @analysis Application programmer error. Initialize GLFW before calling any
+ * function that requires initialization.
+ */
#define GLFW_NOT_INITIALIZED 0x00010001
-/*! @brief No context is current for this thread.
- *
- * This occurs if a GLFW function was called that needs and operates on the
- * current OpenGL or OpenGL ES context but no context is current on the calling
- * thread. One such function is @ref glfwSwapInterval.
- *
- * @analysis Application programmer error. Ensure a context is current before
- * calling functions that require a current context.
- */
+ /*! @brief No context is current for this thread.
+ *
+ * This occurs if a GLFW function was called that needs and operates on the
+ * current OpenGL or OpenGL ES context but no context is current on the calling
+ * thread. One such function is @ref glfwSwapInterval.
+ *
+ * @analysis Application programmer error. Ensure a context is current before
+ * calling functions that require a current context.
+ */
#define GLFW_NO_CURRENT_CONTEXT 0x00010002
-/*! @brief One of the arguments to the function was an invalid enum value.
- *
- * One of the arguments to the function was an invalid enum value, for example
- * requesting @ref GLFW_RED_BITS with @ref glfwGetWindowAttrib.
- *
- * @analysis Application programmer error. Fix the offending call.
- */
+ /*! @brief One of the arguments to the function was an invalid enum value.
+ *
+ * One of the arguments to the function was an invalid enum value, for example
+ * requesting @ref GLFW_RED_BITS with @ref glfwGetWindowAttrib.
+ *
+ * @analysis Application programmer error. Fix the offending call.
+ */
#define GLFW_INVALID_ENUM 0x00010003
-/*! @brief One of the arguments to the function was an invalid value.
- *
- * One of the arguments to the function was an invalid value, for example
- * requesting a non-existent OpenGL or OpenGL ES version like 2.7.
- *
- * Requesting a valid but unavailable OpenGL or OpenGL ES version will instead
- * result in a @ref GLFW_VERSION_UNAVAILABLE error.
- *
- * @analysis Application programmer error. Fix the offending call.
- */
+ /*! @brief One of the arguments to the function was an invalid value.
+ *
+ * One of the arguments to the function was an invalid value, for example
+ * requesting a non-existent OpenGL or OpenGL ES version like 2.7.
+ *
+ * Requesting a valid but unavailable OpenGL or OpenGL ES version will instead
+ * result in a @ref GLFW_VERSION_UNAVAILABLE error.
+ *
+ * @analysis Application programmer error. Fix the offending call.
+ */
#define GLFW_INVALID_VALUE 0x00010004
-/*! @brief A memory allocation failed.
- *
- * A memory allocation failed.
- *
- * @analysis A bug in GLFW or the underlying operating system. Report the bug
- * to our [issue tracker](https://github.com/glfw/glfw/issues).
- */
+ /*! @brief A memory allocation failed.
+ *
+ * A memory allocation failed.
+ *
+ * @analysis A bug in GLFW or the underlying operating system. Report the bug
+ * to our [issue tracker](https://github.com/glfw/glfw/issues).
+ */
#define GLFW_OUT_OF_MEMORY 0x00010005
-/*! @brief GLFW could not find support for the requested API on the system.
- *
- * GLFW could not find support for the requested API on the system.
- *
- * @analysis The installed graphics driver does not support the requested
- * API, or does not support it via the chosen context creation API.
- * Below are a few examples.
- *
- * @par
- * Some pre-installed Windows graphics drivers do not support OpenGL. AMD only
- * supports OpenGL ES via EGL, while Nvidia and Intel only support it via
- * a WGL or GLX extension. macOS does not provide OpenGL ES at all. The Mesa
- * EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary
- * driver. Older graphics drivers do not support Vulkan.
- */
+ /*! @brief GLFW could not find support for the requested API on the system.
+ *
+ * GLFW could not find support for the requested API on the system.
+ *
+ * @analysis The installed graphics driver does not support the requested
+ * API, or does not support it via the chosen context creation API.
+ * Below are a few examples.
+ *
+ * @par
+ * Some pre-installed Windows graphics drivers do not support OpenGL. AMD only
+ * supports OpenGL ES via EGL, while Nvidia and Intel only support it via
+ * a WGL or GLX extension. macOS does not provide OpenGL ES at all. The Mesa
+ * EGL, OpenGL and OpenGL ES libraries do not interface with the Nvidia binary
+ * driver. Older graphics drivers do not support Vulkan.
+ */
#define GLFW_API_UNAVAILABLE 0x00010006
-/*! @brief The requested OpenGL or OpenGL ES version is not available.
- *
- * The requested OpenGL or OpenGL ES version (including any requested context
- * or framebuffer hints) is not available on this machine.
- *
- * @analysis The machine does not support your requirements. If your
- * application is sufficiently flexible, downgrade your requirements and try
- * again. Otherwise, inform the user that their machine does not match your
- * requirements.
- *
- * @par
- * Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if 5.0
- * comes out before the 4.x series gets that far, also fail with this error and
- * not @ref GLFW_INVALID_VALUE, because GLFW cannot know what future versions
- * will exist.
- */
+ /*! @brief The requested OpenGL or OpenGL ES version is not available.
+ *
+ * The requested OpenGL or OpenGL ES version (including any requested context
+ * or framebuffer hints) is not available on this machine.
+ *
+ * @analysis The machine does not support your requirements. If your
+ * application is sufficiently flexible, downgrade your requirements and try
+ * again. Otherwise, inform the user that their machine does not match your
+ * requirements.
+ *
+ * @par
+ * Future invalid OpenGL and OpenGL ES versions, for example OpenGL 4.8 if 5.0
+ * comes out before the 4.x series gets that far, also fail with this error and
+ * not @ref GLFW_INVALID_VALUE, because GLFW cannot know what future versions
+ * will exist.
+ */
#define GLFW_VERSION_UNAVAILABLE 0x00010007
-/*! @brief A platform-specific error occurred that does not match any of the
- * more specific categories.
- *
- * A platform-specific error occurred that does not match any of the more
- * specific categories.
- *
- * @analysis A bug or configuration error in GLFW, the underlying operating
- * system or its drivers, or a lack of required resources. Report the issue to
- * our [issue tracker](https://github.com/glfw/glfw/issues).
- */
+ /*! @brief A platform-specific error occurred that does not match any of the
+ * more specific categories.
+ *
+ * A platform-specific error occurred that does not match any of the more
+ * specific categories.
+ *
+ * @analysis A bug or configuration error in GLFW, the underlying operating
+ * system or its drivers, or a lack of required resources. Report the issue to
+ * our [issue tracker](https://github.com/glfw/glfw/issues).
+ */
#define GLFW_PLATFORM_ERROR 0x00010008
-/*! @brief The requested format is not supported or available.
- *
- * If emitted during window creation, the requested pixel format is not
- * supported.
- *
- * If emitted when querying the clipboard, the contents of the clipboard could
- * not be converted to the requested format.
- *
- * @analysis If emitted during window creation, one or more
- * [hard constraints](@ref window_hints_hard) did not match any of the
- * available pixel formats. If your application is sufficiently flexible,
- * downgrade your requirements and try again. Otherwise, inform the user that
- * their machine does not match your requirements.
- *
- * @par
- * If emitted when querying the clipboard, ignore the error or report it to
- * the user, as appropriate.
- */
+ /*! @brief The requested format is not supported or available.
+ *
+ * If emitted during window creation, the requested pixel format is not
+ * supported.
+ *
+ * If emitted when querying the clipboard, the contents of the clipboard could
+ * not be converted to the requested format.
+ *
+ * @analysis If emitted during window creation, one or more
+ * [hard constraints](@ref window_hints_hard) did not match any of the
+ * available pixel formats. If your application is sufficiently flexible,
+ * downgrade your requirements and try again. Otherwise, inform the user that
+ * their machine does not match your requirements.
+ *
+ * @par
+ * If emitted when querying the clipboard, ignore the error or report it to
+ * the user, as appropriate.
+ */
#define GLFW_FORMAT_UNAVAILABLE 0x00010009
-/*! @brief The specified window does not have an OpenGL or OpenGL ES context.
- *
- * A window that does not have an OpenGL or OpenGL ES context was passed to
- * a function that requires it to have one.
- *
- * @analysis Application programmer error. Fix the offending call.
- */
+ /*! @brief The specified window does not have an OpenGL or OpenGL ES context.
+ *
+ * A window that does not have an OpenGL or OpenGL ES context was passed to
+ * a function that requires it to have one.
+ *
+ * @analysis Application programmer error. Fix the offending call.
+ */
#define GLFW_NO_WINDOW_CONTEXT 0x0001000A
-/*! @brief The specified cursor shape is not available.
- *
- * The specified standard cursor shape is not available, either because the
- * current platform cursor theme does not provide it or because it is not
- * available on the platform.
- *
- * @analysis Platform or system settings limitation. Pick another
- * [standard cursor shape](@ref shapes) or create a
- * [custom cursor](@ref cursor_custom).
- */
+ /*! @brief The specified cursor shape is not available.
+ *
+ * The specified standard cursor shape is not available, either because the
+ * current platform cursor theme does not provide it or because it is not
+ * available on the platform.
+ *
+ * @analysis Platform or system settings limitation. Pick another
+ * [standard cursor shape](@ref shapes) or create a
+ * [custom cursor](@ref cursor_custom).
+ */
#define GLFW_CURSOR_UNAVAILABLE 0x0001000B
-/*! @brief The requested feature is not provided by the platform.
- *
- * The requested feature is not provided by the platform, so GLFW is unable to
- * implement it. The documentation for each function notes if it could emit
- * this error.
- *
- * @analysis Platform or platform version limitation. The error can be ignored
- * unless the feature is critical to the application.
- *
- * @par
- * A function call that emits this error has no effect other than the error and
- * updating any existing out parameters.
- */
+ /*! @brief The requested feature is not provided by the platform.
+ *
+ * The requested feature is not provided by the platform, so GLFW is unable to
+ * implement it. The documentation for each function notes if it could emit
+ * this error.
+ *
+ * @analysis Platform or platform version limitation. The error can be ignored
+ * unless the feature is critical to the application.
+ *
+ * @par
+ * A function call that emits this error has no effect other than the error and
+ * updating any existing out parameters.
+ */
#define GLFW_FEATURE_UNAVAILABLE 0x0001000C
-/*! @brief The requested feature is not implemented for the platform.
- *
- * The requested feature has not yet been implemented in GLFW for this platform.
- *
- * @analysis An incomplete implementation of GLFW for this platform, hopefully
- * fixed in a future release. The error can be ignored unless the feature is
- * critical to the application.
- *
- * @par
- * A function call that emits this error has no effect other than the error and
- * updating any existing out parameters.
- */
+ /*! @brief The requested feature is not implemented for the platform.
+ *
+ * The requested feature has not yet been implemented in GLFW for this platform.
+ *
+ * @analysis An incomplete implementation of GLFW for this platform, hopefully
+ * fixed in a future release. The error can be ignored unless the feature is
+ * critical to the application.
+ *
+ * @par
+ * A function call that emits this error has no effect other than the error and
+ * updating any existing out parameters.
+ */
#define GLFW_FEATURE_UNIMPLEMENTED 0x0001000D
-/*! @brief Platform unavailable or no matching platform was found.
- *
- * If emitted during initialization, no matching platform was found. If the @ref
- * GLFW_PLATFORM init hint was set to `GLFW_ANY_PLATFORM`, GLFW could not detect any of
- * the platforms supported by this library binary, except for the Null platform. If the
- * init hint was set to a specific platform, it is either not supported by this library
- * binary or GLFW was not able to detect it.
- *
- * If emitted by a native access function, GLFW was initialized for a different platform
- * than the function is for.
- *
- * @analysis Failure to detect any platform usually only happens on non-macOS Unix
- * systems, either when no window system is running or the program was run from
- * a terminal that does not have the necessary environment variables. Fall back to
- * a different platform if possible or notify the user that no usable platform was
- * detected.
- *
- * Failure to detect a specific platform may have the same cause as above or be because
- * support for that platform was not compiled in. Call @ref glfwPlatformSupported to
- * check whether a specific platform is supported by a library binary.
- */
+ /*! @brief Platform unavailable or no matching platform was found.
+ *
+ * If emitted during initialization, no matching platform was found. If the @ref
+ * GLFW_PLATFORM init hint was set to `GLFW_ANY_PLATFORM`, GLFW could not detect any of
+ * the platforms supported by this library binary, except for the Null platform. If the
+ * init hint was set to a specific platform, it is either not supported by this library
+ * binary or GLFW was not able to detect it.
+ *
+ * If emitted by a native access function, GLFW was initialized for a different platform
+ * than the function is for.
+ *
+ * @analysis Failure to detect any platform usually only happens on non-macOS Unix
+ * systems, either when no window system is running or the program was run from
+ * a terminal that does not have the necessary environment variables. Fall back to
+ * a different platform if possible or notify the user that no usable platform was
+ * detected.
+ *
+ * Failure to detect a specific platform may have the same cause as above or be because
+ * support for that platform was not compiled in. Call @ref glfwPlatformSupported to
+ * check whether a specific platform is supported by a library binary.
+ */
#define GLFW_PLATFORM_UNAVAILABLE 0x0001000E
-/*! @} */
-
-/*! @addtogroup window
- * @{ */
-/*! @brief Input focus window hint and attribute
- *
- * Input focus [window hint](@ref GLFW_FOCUSED_hint) or
- * [window attribute](@ref GLFW_FOCUSED_attrib).
- */
+ /*! @} */
+
+ /*! @addtogroup window
+ * @{ */
+ /*! @brief Input focus window hint and attribute
+ *
+ * Input focus [window hint](@ref GLFW_FOCUSED_hint) or
+ * [window attribute](@ref GLFW_FOCUSED_attrib).
+ */
#define GLFW_FOCUSED 0x00020001
-/*! @brief Window iconification window attribute
- *
- * Window iconification [window attribute](@ref GLFW_ICONIFIED_attrib).
- */
+ /*! @brief Window iconification window attribute
+ *
+ * Window iconification [window attribute](@ref GLFW_ICONIFIED_attrib).
+ */
#define GLFW_ICONIFIED 0x00020002
-/*! @brief Window resize-ability window hint and attribute
- *
- * Window resize-ability [window hint](@ref GLFW_RESIZABLE_hint) and
- * [window attribute](@ref GLFW_RESIZABLE_attrib).
- */
+ /*! @brief Window resize-ability window hint and attribute
+ *
+ * Window resize-ability [window hint](@ref GLFW_RESIZABLE_hint) and
+ * [window attribute](@ref GLFW_RESIZABLE_attrib).
+ */
#define GLFW_RESIZABLE 0x00020003
-/*! @brief Window visibility window hint and attribute
- *
- * Window visibility [window hint](@ref GLFW_VISIBLE_hint) and
- * [window attribute](@ref GLFW_VISIBLE_attrib).
- */
+ /*! @brief Window visibility window hint and attribute
+ *
+ * Window visibility [window hint](@ref GLFW_VISIBLE_hint) and
+ * [window attribute](@ref GLFW_VISIBLE_attrib).
+ */
#define GLFW_VISIBLE 0x00020004
-/*! @brief Window decoration window hint and attribute
- *
- * Window decoration [window hint](@ref GLFW_DECORATED_hint) and
- * [window attribute](@ref GLFW_DECORATED_attrib).
- */
+ /*! @brief Window decoration window hint and attribute
+ *
+ * Window decoration [window hint](@ref GLFW_DECORATED_hint) and
+ * [window attribute](@ref GLFW_DECORATED_attrib).
+ */
#define GLFW_DECORATED 0x00020005
-/*! @brief Window auto-iconification window hint and attribute
- *
- * Window auto-iconification [window hint](@ref GLFW_AUTO_ICONIFY_hint) and
- * [window attribute](@ref GLFW_AUTO_ICONIFY_attrib).
- */
+ /*! @brief Window auto-iconification window hint and attribute
+ *
+ * Window auto-iconification [window hint](@ref GLFW_AUTO_ICONIFY_hint) and
+ * [window attribute](@ref GLFW_AUTO_ICONIFY_attrib).
+ */
#define GLFW_AUTO_ICONIFY 0x00020006
-/*! @brief Window decoration window hint and attribute
- *
- * Window decoration [window hint](@ref GLFW_FLOATING_hint) and
- * [window attribute](@ref GLFW_FLOATING_attrib).
- */
+ /*! @brief Window decoration window hint and attribute
+ *
+ * Window decoration [window hint](@ref GLFW_FLOATING_hint) and
+ * [window attribute](@ref GLFW_FLOATING_attrib).
+ */
#define GLFW_FLOATING 0x00020007
-/*! @brief Window maximization window hint and attribute
- *
- * Window maximization [window hint](@ref GLFW_MAXIMIZED_hint) and
- * [window attribute](@ref GLFW_MAXIMIZED_attrib).
- */
+ /*! @brief Window maximization window hint and attribute
+ *
+ * Window maximization [window hint](@ref GLFW_MAXIMIZED_hint) and
+ * [window attribute](@ref GLFW_MAXIMIZED_attrib).
+ */
#define GLFW_MAXIMIZED 0x00020008
-/*! @brief Cursor centering window hint
- *
- * Cursor centering [window hint](@ref GLFW_CENTER_CURSOR_hint).
- */
+ /*! @brief Cursor centering window hint
+ *
+ * Cursor centering [window hint](@ref GLFW_CENTER_CURSOR_hint).
+ */
#define GLFW_CENTER_CURSOR 0x00020009
-/*! @brief Window framebuffer transparency hint and attribute
- *
- * Window framebuffer transparency
- * [window hint](@ref GLFW_TRANSPARENT_FRAMEBUFFER_hint) and
- * [window attribute](@ref GLFW_TRANSPARENT_FRAMEBUFFER_attrib).
- */
+ /*! @brief Window framebuffer transparency hint and attribute
+ *
+ * Window framebuffer transparency
+ * [window hint](@ref GLFW_TRANSPARENT_FRAMEBUFFER_hint) and
+ * [window attribute](@ref GLFW_TRANSPARENT_FRAMEBUFFER_attrib).
+ */
#define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A
-/*! @brief Mouse cursor hover window attribute.
- *
- * Mouse cursor hover [window attribute](@ref GLFW_HOVERED_attrib).
- */
+ /*! @brief Mouse cursor hover window attribute.
+ *
+ * Mouse cursor hover [window attribute](@ref GLFW_HOVERED_attrib).
+ */
#define GLFW_HOVERED 0x0002000B
-/*! @brief Input focus on calling show window hint and attribute
- *
- * Input focus [window hint](@ref GLFW_FOCUS_ON_SHOW_hint) or
- * [window attribute](@ref GLFW_FOCUS_ON_SHOW_attrib).
- */
+ /*! @brief Input focus on calling show window hint and attribute
+ *
+ * Input focus [window hint](@ref GLFW_FOCUS_ON_SHOW_hint) or
+ * [window attribute](@ref GLFW_FOCUS_ON_SHOW_attrib).
+ */
#define GLFW_FOCUS_ON_SHOW 0x0002000C
-
-/*! @brief Mouse input transparency window hint and attribute
- *
- * Mouse input transparency [window hint](@ref GLFW_MOUSE_PASSTHROUGH_hint) or
- * [window attribute](@ref GLFW_MOUSE_PASSTHROUGH_attrib).
- */
+
+ /*! @brief Mouse input transparency window hint and attribute
+ *
+ * Mouse input transparency [window hint](@ref GLFW_MOUSE_PASSTHROUGH_hint) or
+ * [window attribute](@ref GLFW_MOUSE_PASSTHROUGH_attrib).
+ */
#define GLFW_MOUSE_PASSTHROUGH 0x0002000D
-
-/*! @brief Initial position x-coordinate window hint.
- *
- * Initial position x-coordinate [window hint](@ref GLFW_POSITION_X).
- */
+
+ /*! @brief Initial position x-coordinate window hint.
+ *
+ * Initial position x-coordinate [window hint](@ref GLFW_POSITION_X).
+ */
#define GLFW_POSITION_X 0x0002000E
-
-/*! @brief Initial position y-coordinate window hint.
- *
- * Initial position y-coordinate [window hint](@ref GLFW_POSITION_Y).
- */
+
+ /*! @brief Initial position y-coordinate window hint.
+ *
+ * Initial position y-coordinate [window hint](@ref GLFW_POSITION_Y).
+ */
#define GLFW_POSITION_Y 0x0002000F
-
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_RED_BITS).
- */
+
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_RED_BITS).
+ */
#define GLFW_RED_BITS 0x00021001
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_GREEN_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_GREEN_BITS).
+ */
#define GLFW_GREEN_BITS 0x00021002
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_BLUE_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_BLUE_BITS).
+ */
#define GLFW_BLUE_BITS 0x00021003
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_ALPHA_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_ALPHA_BITS).
+ */
#define GLFW_ALPHA_BITS 0x00021004
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_DEPTH_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_DEPTH_BITS).
+ */
#define GLFW_DEPTH_BITS 0x00021005
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_STENCIL_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_STENCIL_BITS).
+ */
#define GLFW_STENCIL_BITS 0x00021006
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_ACCUM_RED_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_ACCUM_RED_BITS).
+ */
#define GLFW_ACCUM_RED_BITS 0x00021007
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_ACCUM_GREEN_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_ACCUM_GREEN_BITS).
+ */
#define GLFW_ACCUM_GREEN_BITS 0x00021008
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_ACCUM_BLUE_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_ACCUM_BLUE_BITS).
+ */
#define GLFW_ACCUM_BLUE_BITS 0x00021009
-/*! @brief Framebuffer bit depth hint.
- *
- * Framebuffer bit depth [hint](@ref GLFW_ACCUM_ALPHA_BITS).
- */
+ /*! @brief Framebuffer bit depth hint.
+ *
+ * Framebuffer bit depth [hint](@ref GLFW_ACCUM_ALPHA_BITS).
+ */
#define GLFW_ACCUM_ALPHA_BITS 0x0002100A
-/*! @brief Framebuffer auxiliary buffer hint.
- *
- * Framebuffer auxiliary buffer [hint](@ref GLFW_AUX_BUFFERS).
- */
+ /*! @brief Framebuffer auxiliary buffer hint.
+ *
+ * Framebuffer auxiliary buffer [hint](@ref GLFW_AUX_BUFFERS).
+ */
#define GLFW_AUX_BUFFERS 0x0002100B
-/*! @brief OpenGL stereoscopic rendering hint.
- *
- * OpenGL stereoscopic rendering [hint](@ref GLFW_STEREO).
- */
+ /*! @brief OpenGL stereoscopic rendering hint.
+ *
+ * OpenGL stereoscopic rendering [hint](@ref GLFW_STEREO).
+ */
#define GLFW_STEREO 0x0002100C
-/*! @brief Framebuffer MSAA samples hint.
- *
- * Framebuffer MSAA samples [hint](@ref GLFW_SAMPLES).
- */
+ /*! @brief Framebuffer MSAA samples hint.
+ *
+ * Framebuffer MSAA samples [hint](@ref GLFW_SAMPLES).
+ */
#define GLFW_SAMPLES 0x0002100D
-/*! @brief Framebuffer sRGB hint.
- *
- * Framebuffer sRGB [hint](@ref GLFW_SRGB_CAPABLE).
- */
+ /*! @brief Framebuffer sRGB hint.
+ *
+ * Framebuffer sRGB [hint](@ref GLFW_SRGB_CAPABLE).
+ */
#define GLFW_SRGB_CAPABLE 0x0002100E
-/*! @brief Monitor refresh rate hint.
- *
- * Monitor refresh rate [hint](@ref GLFW_REFRESH_RATE).
- */
+ /*! @brief Monitor refresh rate hint.
+ *
+ * Monitor refresh rate [hint](@ref GLFW_REFRESH_RATE).
+ */
#define GLFW_REFRESH_RATE 0x0002100F
-/*! @brief Framebuffer double buffering hint and attribute.
- *
- * Framebuffer double buffering [hint](@ref GLFW_DOUBLEBUFFER_hint) and
- * [attribute](@ref GLFW_DOUBLEBUFFER_attrib).
- */
+ /*! @brief Framebuffer double buffering hint and attribute.
+ *
+ * Framebuffer double buffering [hint](@ref GLFW_DOUBLEBUFFER_hint) and
+ * [attribute](@ref GLFW_DOUBLEBUFFER_attrib).
+ */
#define GLFW_DOUBLEBUFFER 0x00021010
-
-/*! @brief Context client API hint and attribute.
- *
- * Context client API [hint](@ref GLFW_CLIENT_API_hint) and
- * [attribute](@ref GLFW_CLIENT_API_attrib).
- */
+
+ /*! @brief Context client API hint and attribute.
+ *
+ * Context client API [hint](@ref GLFW_CLIENT_API_hint) and
+ * [attribute](@ref GLFW_CLIENT_API_attrib).
+ */
#define GLFW_CLIENT_API 0x00022001
-/*! @brief Context client API major version hint and attribute.
- *
- * Context client API major version [hint](@ref GLFW_CONTEXT_VERSION_MAJOR_hint)
- * and [attribute](@ref GLFW_CONTEXT_VERSION_MAJOR_attrib).
- */
+ /*! @brief Context client API major version hint and attribute.
+ *
+ * Context client API major version [hint](@ref GLFW_CONTEXT_VERSION_MAJOR_hint)
+ * and [attribute](@ref GLFW_CONTEXT_VERSION_MAJOR_attrib).
+ */
#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
-/*! @brief Context client API minor version hint and attribute.
- *
- * Context client API minor version [hint](@ref GLFW_CONTEXT_VERSION_MINOR_hint)
- * and [attribute](@ref GLFW_CONTEXT_VERSION_MINOR_attrib).
- */
+ /*! @brief Context client API minor version hint and attribute.
+ *
+ * Context client API minor version [hint](@ref GLFW_CONTEXT_VERSION_MINOR_hint)
+ * and [attribute](@ref GLFW_CONTEXT_VERSION_MINOR_attrib).
+ */
#define GLFW_CONTEXT_VERSION_MINOR 0x00022003
-/*! @brief Context client API revision number attribute.
- *
- * Context client API revision number
- * [attribute](@ref GLFW_CONTEXT_REVISION_attrib).
- */
+ /*! @brief Context client API revision number attribute.
+ *
+ * Context client API revision number
+ * [attribute](@ref GLFW_CONTEXT_REVISION_attrib).
+ */
#define GLFW_CONTEXT_REVISION 0x00022004
-/*! @brief Context robustness hint and attribute.
- *
- * Context client API revision number [hint](@ref GLFW_CONTEXT_ROBUSTNESS_hint)
- * and [attribute](@ref GLFW_CONTEXT_ROBUSTNESS_attrib).
- */
+ /*! @brief Context robustness hint and attribute.
+ *
+ * Context client API revision number [hint](@ref GLFW_CONTEXT_ROBUSTNESS_hint)
+ * and [attribute](@ref GLFW_CONTEXT_ROBUSTNESS_attrib).
+ */
#define GLFW_CONTEXT_ROBUSTNESS 0x00022005
-/*! @brief OpenGL forward-compatibility hint and attribute.
- *
- * OpenGL forward-compatibility [hint](@ref GLFW_OPENGL_FORWARD_COMPAT_hint)
- * and [attribute](@ref GLFW_OPENGL_FORWARD_COMPAT_attrib).
- */
+ /*! @brief OpenGL forward-compatibility hint and attribute.
+ *
+ * OpenGL forward-compatibility [hint](@ref GLFW_OPENGL_FORWARD_COMPAT_hint)
+ * and [attribute](@ref GLFW_OPENGL_FORWARD_COMPAT_attrib).
+ */
#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
-/*! @brief Debug mode context hint and attribute.
- *
- * Debug mode context [hint](@ref GLFW_CONTEXT_DEBUG_hint) and
- * [attribute](@ref GLFW_CONTEXT_DEBUG_attrib).
- */
+ /*! @brief Debug mode context hint and attribute.
+ *
+ * Debug mode context [hint](@ref GLFW_CONTEXT_DEBUG_hint) and
+ * [attribute](@ref GLFW_CONTEXT_DEBUG_attrib).
+ */
#define GLFW_CONTEXT_DEBUG 0x00022007
-/*! @brief Legacy name for compatibility.
- *
- * This is an alias for compatibility with earlier versions.
- */
+ /*! @brief Legacy name for compatibility.
+ *
+ * This is an alias for compatibility with earlier versions.
+ */
#define GLFW_OPENGL_DEBUG_CONTEXT GLFW_CONTEXT_DEBUG
-/*! @brief OpenGL profile hint and attribute.
- *
- * OpenGL profile [hint](@ref GLFW_OPENGL_PROFILE_hint) and
- * [attribute](@ref GLFW_OPENGL_PROFILE_attrib).
- */
+ /*! @brief OpenGL profile hint and attribute.
+ *
+ * OpenGL profile [hint](@ref GLFW_OPENGL_PROFILE_hint) and
+ * [attribute](@ref GLFW_OPENGL_PROFILE_attrib).
+ */
#define GLFW_OPENGL_PROFILE 0x00022008
-/*! @brief Context flush-on-release hint and attribute.
- *
- * Context flush-on-release [hint](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint) and
- * [attribute](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib).
- */
+ /*! @brief Context flush-on-release hint and attribute.
+ *
+ * Context flush-on-release [hint](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint) and
+ * [attribute](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib).
+ */
#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
-/*! @brief Context error suppression hint and attribute.
- *
- * Context error suppression [hint](@ref GLFW_CONTEXT_NO_ERROR_hint) and
- * [attribute](@ref GLFW_CONTEXT_NO_ERROR_attrib).
- */
+ /*! @brief Context error suppression hint and attribute.
+ *
+ * Context error suppression [hint](@ref GLFW_CONTEXT_NO_ERROR_hint) and
+ * [attribute](@ref GLFW_CONTEXT_NO_ERROR_attrib).
+ */
#define GLFW_CONTEXT_NO_ERROR 0x0002200A
-/*! @brief Context creation API hint and attribute.
- *
- * Context creation API [hint](@ref GLFW_CONTEXT_CREATION_API_hint) and
- * [attribute](@ref GLFW_CONTEXT_CREATION_API_attrib).
- */
+ /*! @brief Context creation API hint and attribute.
+ *
+ * Context creation API [hint](@ref GLFW_CONTEXT_CREATION_API_hint) and
+ * [attribute](@ref GLFW_CONTEXT_CREATION_API_attrib).
+ */
#define GLFW_CONTEXT_CREATION_API 0x0002200B
-/*! @brief Window content area scaling window
- * [window hint](@ref GLFW_SCALE_TO_MONITOR).
- */
+ /*! @brief Window content area scaling window
+ * [window hint](@ref GLFW_SCALE_TO_MONITOR).
+ */
#define GLFW_SCALE_TO_MONITOR 0x0002200C
-/*! @brief Window framebuffer scaling
- * [window hint](@ref GLFW_SCALE_FRAMEBUFFER_hint).
- */
+ /*! @brief Window framebuffer scaling
+ * [window hint](@ref GLFW_SCALE_FRAMEBUFFER_hint).
+ */
#define GLFW_SCALE_FRAMEBUFFER 0x0002200D
-/*! @brief Legacy name for compatibility.
- *
- * This is an alias for the
- * [GLFW_SCALE_FRAMEBUFFER](@ref GLFW_SCALE_FRAMEBUFFER_hint) window hint for
- * compatibility with earlier versions.
- */
+ /*! @brief Legacy name for compatibility.
+ *
+ * This is an alias for the
+ * [GLFW_SCALE_FRAMEBUFFER](@ref GLFW_SCALE_FRAMEBUFFER_hint) window hint for
+ * compatibility with earlier versions.
+ */
#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
-/*! @brief macOS specific
- * [window hint](@ref GLFW_COCOA_FRAME_NAME_hint).
- */
+ /*! @brief macOS specific
+ * [window hint](@ref GLFW_COCOA_FRAME_NAME_hint).
+ */
#define GLFW_COCOA_FRAME_NAME 0x00023002
-/*! @brief macOS specific
- * [window hint](@ref GLFW_COCOA_GRAPHICS_SWITCHING_hint).
- */
+ /*! @brief macOS specific
+ * [window hint](@ref GLFW_COCOA_GRAPHICS_SWITCHING_hint).
+ */
#define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
-/*! @brief X11 specific
- * [window hint](@ref GLFW_X11_CLASS_NAME_hint).
- */
+ /*! @brief X11 specific
+ * [window hint](@ref GLFW_X11_CLASS_NAME_hint).
+ */
#define GLFW_X11_CLASS_NAME 0x00024001
-/*! @brief X11 specific
- * [window hint](@ref GLFW_X11_CLASS_NAME_hint).
- */
+ /*! @brief X11 specific
+ * [window hint](@ref GLFW_X11_CLASS_NAME_hint).
+ */
#define GLFW_X11_INSTANCE_NAME 0x00024002
#define GLFW_WIN32_KEYBOARD_MENU 0x00025001
-/*! @brief Win32 specific [window hint](@ref GLFW_WIN32_SHOWDEFAULT_hint).
- */
+ /*! @brief Win32 specific [window hint](@ref GLFW_WIN32_SHOWDEFAULT_hint).
+ */
#define GLFW_WIN32_SHOWDEFAULT 0x00025002
-/*! @brief Wayland specific
- * [window hint](@ref GLFW_WAYLAND_APP_ID_hint).
- *
- * Allows specification of the Wayland app_id.
- */
+ /*! @brief Wayland specific
+ * [window hint](@ref GLFW_WAYLAND_APP_ID_hint).
+ *
+ * Allows specification of the Wayland app_id.
+ */
#define GLFW_WAYLAND_APP_ID 0x00026001
-/*! @} */
-
+ /*! @} */
+
#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_UNLIMITED_MOUSE_BUTTONS 0x00033006
-
+
#define GLFW_CURSOR_NORMAL 0x00034001
#define GLFW_CURSOR_HIDDEN 0x00034002
#define GLFW_CURSOR_DISABLED 0x00034003
#define GLFW_CURSOR_CAPTURED 0x00034004
-
+
#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_ANGLE_PLATFORM_TYPE_NONE 0x00037001
#define GLFW_ANGLE_PLATFORM_TYPE_OPENGL 0x00037002
#define GLFW_ANGLE_PLATFORM_TYPE_OPENGLES 0x00037003
@@ -1176,5383 +1176,5383 @@ extern "C" {
#define GLFW_ANGLE_PLATFORM_TYPE_D3D11 0x00037005
#define GLFW_ANGLE_PLATFORM_TYPE_VULKAN 0x00037007
#define GLFW_ANGLE_PLATFORM_TYPE_METAL 0x00037008
-
+
#define GLFW_WAYLAND_PREFER_LIBDECOR 0x00038001
#define GLFW_WAYLAND_DISABLE_LIBDECOR 0x00038002
-
+
#define GLFW_ANY_POSITION 0x80000000
-
-/*! @defgroup shapes Standard cursor shapes
- * @brief Standard system cursor shapes.
- *
- * These are the [standard cursor shapes](@ref cursor_standard) that can be
- * requested from the platform (window system).
- *
- * @ingroup input
- * @{ */
-
-/*! @brief The regular arrow cursor shape.
- *
- * The regular arrow cursor shape.
- */
+
+ /*! @defgroup shapes Standard cursor shapes
+ * @brief Standard system cursor shapes.
+ *
+ * These are the [standard cursor shapes](@ref cursor_standard) that can be
+ * requested from the platform (window system).
+ *
+ * @ingroup input
+ * @{ */
+
+ /*! @brief The regular arrow cursor shape.
+ *
+ * The regular arrow cursor shape.
+ */
#define GLFW_ARROW_CURSOR 0x00036001
-/*! @brief The text input I-beam cursor shape.
- *
- * The text input I-beam cursor shape.
- */
+ /*! @brief The text input I-beam cursor shape.
+ *
+ * The text input I-beam cursor shape.
+ */
#define GLFW_IBEAM_CURSOR 0x00036002
-/*! @brief The crosshair cursor shape.
- *
- * The crosshair cursor shape.
- */
+ /*! @brief The crosshair cursor shape.
+ *
+ * The crosshair cursor shape.
+ */
#define GLFW_CROSSHAIR_CURSOR 0x00036003
-/*! @brief The pointing hand cursor shape.
- *
- * The pointing hand cursor shape.
- */
+ /*! @brief The pointing hand cursor shape.
+ *
+ * The pointing hand cursor shape.
+ */
#define GLFW_POINTING_HAND_CURSOR 0x00036004
-/*! @brief The horizontal resize/move arrow shape.
- *
- * The horizontal resize/move arrow shape. This is usually a horizontal
- * double-headed arrow.
- */
+ /*! @brief The horizontal resize/move arrow shape.
+ *
+ * The horizontal resize/move arrow shape. This is usually a horizontal
+ * double-headed arrow.
+ */
#define GLFW_RESIZE_EW_CURSOR 0x00036005
-/*! @brief The vertical resize/move arrow shape.
- *
- * The vertical resize/move shape. This is usually a vertical double-headed
- * arrow.
- */
+ /*! @brief The vertical resize/move arrow shape.
+ *
+ * The vertical resize/move shape. This is usually a vertical double-headed
+ * arrow.
+ */
#define GLFW_RESIZE_NS_CURSOR 0x00036006
-/*! @brief The top-left to bottom-right diagonal resize/move arrow shape.
- *
- * The top-left to bottom-right diagonal resize/move shape. This is usually
- * a diagonal double-headed arrow.
- *
- * @note @macos This shape is provided by a private system API and may fail
- * with @ref GLFW_CURSOR_UNAVAILABLE in the future.
- *
- * @note @wayland This shape is provided by a newer standard not supported by
- * all cursor themes.
- *
- * @note @x11 This shape is provided by a newer standard not supported by all
- * cursor themes.
- */
+ /*! @brief The top-left to bottom-right diagonal resize/move arrow shape.
+ *
+ * The top-left to bottom-right diagonal resize/move shape. This is usually
+ * a diagonal double-headed arrow.
+ *
+ * @note @macos This shape is provided by a private system API and may fail
+ * with @ref GLFW_CURSOR_UNAVAILABLE in the future.
+ *
+ * @note @wayland This shape is provided by a newer standard not supported by
+ * all cursor themes.
+ *
+ * @note @x11 This shape is provided by a newer standard not supported by all
+ * cursor themes.
+ */
#define GLFW_RESIZE_NWSE_CURSOR 0x00036007
-/*! @brief The top-right to bottom-left diagonal resize/move arrow shape.
- *
- * The top-right to bottom-left diagonal resize/move shape. This is usually
- * a diagonal double-headed arrow.
- *
- * @note @macos This shape is provided by a private system API and may fail
- * with @ref GLFW_CURSOR_UNAVAILABLE in the future.
- *
- * @note @wayland This shape is provided by a newer standard not supported by
- * all cursor themes.
- *
- * @note @x11 This shape is provided by a newer standard not supported by all
- * cursor themes.
- */
+ /*! @brief The top-right to bottom-left diagonal resize/move arrow shape.
+ *
+ * The top-right to bottom-left diagonal resize/move shape. This is usually
+ * a diagonal double-headed arrow.
+ *
+ * @note @macos This shape is provided by a private system API and may fail
+ * with @ref GLFW_CURSOR_UNAVAILABLE in the future.
+ *
+ * @note @wayland This shape is provided by a newer standard not supported by
+ * all cursor themes.
+ *
+ * @note @x11 This shape is provided by a newer standard not supported by all
+ * cursor themes.
+ */
#define GLFW_RESIZE_NESW_CURSOR 0x00036008
-/*! @brief The omni-directional resize/move cursor shape.
- *
- * The omni-directional resize cursor/move shape. This is usually either
- * a combined horizontal and vertical double-headed arrow or a grabbing hand.
- */
+ /*! @brief The omni-directional resize/move cursor shape.
+ *
+ * The omni-directional resize cursor/move shape. This is usually either
+ * a combined horizontal and vertical double-headed arrow or a grabbing hand.
+ */
#define GLFW_RESIZE_ALL_CURSOR 0x00036009
-/*! @brief The operation-not-allowed shape.
- *
- * The operation-not-allowed shape. This is usually a circle with a diagonal
- * line through it.
- *
- * @note @wayland This shape is provided by a newer standard not supported by
- * all cursor themes.
- *
- * @note @x11 This shape is provided by a newer standard not supported by all
- * cursor themes.
- */
+ /*! @brief The operation-not-allowed shape.
+ *
+ * The operation-not-allowed shape. This is usually a circle with a diagonal
+ * line through it.
+ *
+ * @note @wayland This shape is provided by a newer standard not supported by
+ * all cursor themes.
+ *
+ * @note @x11 This shape is provided by a newer standard not supported by all
+ * cursor themes.
+ */
#define GLFW_NOT_ALLOWED_CURSOR 0x0003600A
-/*! @brief Legacy name for compatibility.
- *
- * This is an alias for compatibility with earlier versions.
- */
+ /*! @brief Legacy name for compatibility.
+ *
+ * This is an alias for compatibility with earlier versions.
+ */
#define GLFW_HRESIZE_CURSOR GLFW_RESIZE_EW_CURSOR
-/*! @brief Legacy name for compatibility.
- *
- * This is an alias for compatibility with earlier versions.
- */
+ /*! @brief Legacy name for compatibility.
+ *
+ * This is an alias for compatibility with earlier versions.
+ */
#define GLFW_VRESIZE_CURSOR GLFW_RESIZE_NS_CURSOR
-/*! @brief Legacy name for compatibility.
- *
- * This is an alias for compatibility with earlier versions.
- */
+ /*! @brief Legacy name for compatibility.
+ *
+ * This is an alias for compatibility with earlier versions.
+ */
#define GLFW_HAND_CURSOR GLFW_POINTING_HAND_CURSOR
-/*! @} */
-
+ /*! @} */
+
#define GLFW_CONNECTED 0x00040001
#define GLFW_DISCONNECTED 0x00040002
-
-/*! @addtogroup init
- * @{ */
-/*! @brief Joystick hat buttons init hint.
- *
- * Joystick hat buttons [init hint](@ref GLFW_JOYSTICK_HAT_BUTTONS).
- */
+
+ /*! @addtogroup init
+ * @{ */
+ /*! @brief Joystick hat buttons init hint.
+ *
+ * Joystick hat buttons [init hint](@ref GLFW_JOYSTICK_HAT_BUTTONS).
+ */
#define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001
-/*! @brief ANGLE rendering backend init hint.
- *
- * ANGLE rendering backend [init hint](@ref GLFW_ANGLE_PLATFORM_TYPE_hint).
- */
+ /*! @brief ANGLE rendering backend init hint.
+ *
+ * ANGLE rendering backend [init hint](@ref GLFW_ANGLE_PLATFORM_TYPE_hint).
+ */
#define GLFW_ANGLE_PLATFORM_TYPE 0x00050002
-/*! @brief Platform selection init hint.
- *
- * Platform selection [init hint](@ref GLFW_PLATFORM).
- */
+ /*! @brief Platform selection init hint.
+ *
+ * Platform selection [init hint](@ref GLFW_PLATFORM).
+ */
#define GLFW_PLATFORM 0x00050003
-/*! @brief macOS specific init hint.
- *
- * macOS specific [init hint](@ref GLFW_COCOA_CHDIR_RESOURCES_hint).
- */
+ /*! @brief macOS specific init hint.
+ *
+ * macOS specific [init hint](@ref GLFW_COCOA_CHDIR_RESOURCES_hint).
+ */
#define GLFW_COCOA_CHDIR_RESOURCES 0x00051001
-/*! @brief macOS specific init hint.
- *
- * macOS specific [init hint](@ref GLFW_COCOA_MENUBAR_hint).
- */
+ /*! @brief macOS specific init hint.
+ *
+ * macOS specific [init hint](@ref GLFW_COCOA_MENUBAR_hint).
+ */
#define GLFW_COCOA_MENUBAR 0x00051002
-/*! @brief X11 specific init hint.
- *
- * X11 specific [init hint](@ref GLFW_X11_XCB_VULKAN_SURFACE_hint).
- */
+ /*! @brief X11 specific init hint.
+ *
+ * X11 specific [init hint](@ref GLFW_X11_XCB_VULKAN_SURFACE_hint).
+ */
#define GLFW_X11_XCB_VULKAN_SURFACE 0x00052001
-/*! @brief Wayland specific init hint.
- *
- * Wayland specific [init hint](@ref GLFW_WAYLAND_LIBDECOR_hint).
- */
+ /*! @brief Wayland specific init hint.
+ *
+ * Wayland specific [init hint](@ref GLFW_WAYLAND_LIBDECOR_hint).
+ */
#define GLFW_WAYLAND_LIBDECOR 0x00053001
-/*! @} */
-
-/*! @addtogroup init
- * @{ */
-/*! @brief Hint value that enables automatic platform selection.
- *
- * Hint value for @ref GLFW_PLATFORM that enables automatic platform selection.
- */
+ /*! @} */
+
+ /*! @addtogroup init
+ * @{ */
+ /*! @brief Hint value that enables automatic platform selection.
+ *
+ * Hint value for @ref GLFW_PLATFORM that enables automatic platform selection.
+ */
#define GLFW_ANY_PLATFORM 0x00060000
#define GLFW_PLATFORM_WIN32 0x00060001
#define GLFW_PLATFORM_COCOA 0x00060002
#define GLFW_PLATFORM_WAYLAND 0x00060003
#define GLFW_PLATFORM_X11 0x00060004
#define GLFW_PLATFORM_NULL 0x00060005
-/*! @} */
-
+ /*! @} */
+
#define GLFW_DONT_CARE -1
-
-
-/*************************************************************************
- * GLFW API types
- *************************************************************************/
-
-/*! @brief Client API function pointer type.
- *
- * Generic function pointer used for returning client API function pointers
- * without forcing a cast from a regular pointer.
- *
- * @sa @ref context_glext
- * @sa @ref glfwGetProcAddress
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- */
-typedef void (*GLFWglproc)(void);
-
-/*! @brief Vulkan API function pointer type.
- *
- * Generic function pointer used for returning Vulkan API function pointers
- * without forcing a cast from a regular pointer.
- *
- * @sa @ref vulkan_proc
- * @sa @ref glfwGetInstanceProcAddress
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-typedef void (*GLFWvkproc)(void);
-
-/*! @brief Opaque monitor object.
- *
- * Opaque monitor object.
- *
- * @see @ref monitor_object
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-typedef struct GLFWmonitor GLFWmonitor;
-
-/*! @brief Opaque window object.
- *
- * Opaque window object.
- *
- * @see @ref window_object
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-typedef struct GLFWwindow GLFWwindow;
-
-/*! @brief Opaque cursor object.
- *
- * Opaque cursor object.
- *
- * @see @ref cursor_object
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-typedef struct GLFWcursor GLFWcursor;
-
-/*! @brief The function pointer type for memory allocation callbacks.
- *
- * This is the function pointer type for memory allocation callbacks. A memory
- * allocation callback function has the following signature:
- * @code
- * void* function_name(size_t size, void* user)
- * @endcode
- *
- * This function must return either a memory block at least `size` bytes long,
- * or `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
- * failures gracefully yet.
- *
- * This function must support being called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the library is no
- * longer flagged as initialized.
- *
- * Any memory allocated via this function will be deallocated via the same allocator
- * during library termination or earlier.
- *
- * Any memory allocated via this function must be suitably aligned for any object type.
- * If you are using C99 or earlier, this alignment is platform-dependent but will be the
- * same as what `malloc` provides. If you are using C11 or later, this is the value of
- * `alignof(max_align_t)`.
- *
- * The size will always be greater than zero. Allocations of size zero are filtered out
- * before reaching the custom allocator.
- *
- * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
- *
- * This function must not call any GLFW function.
- *
- * @param[in] size The minimum size, in bytes, of the memory block.
- * @param[in] user The user-defined pointer from the allocator.
- * @return The address of the newly allocated memory block, or `NULL` if an
- * error occurred.
- *
- * @pointer_lifetime The returned memory block must be valid at least until it
- * is deallocated.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function must support being called from any thread that calls GLFW
- * functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-typedef void* (* GLFWallocatefun)(size_t size, void* user);
-
-/*! @brief The function pointer type for memory reallocation callbacks.
- *
- * This is the function pointer type for memory reallocation callbacks.
- * A memory reallocation callback function has the following signature:
- * @code
- * void* function_name(void* block, size_t size, void* user)
- * @endcode
- *
- * This function must return a memory block at least `size` bytes long, or
- * `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
- * failures gracefully yet.
- *
- * This function must support being called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the library is no
- * longer flagged as initialized.
- *
- * Any memory allocated via this function will be deallocated via the same allocator
- * during library termination or earlier.
- *
- * Any memory allocated via this function must be suitably aligned for any object type.
- * If you are using C99 or earlier, this alignment is platform-dependent but will be the
- * same as what `realloc` provides. If you are using C11 or later, this is the value of
- * `alignof(max_align_t)`.
- *
- * The block address will never be `NULL` and the size will always be greater than zero.
- * Reallocations of a block to size zero are converted into deallocations before reaching
- * the custom allocator. Reallocations of `NULL` to a non-zero size are converted into
- * regular allocations before reaching the custom allocator.
- *
- * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
- *
- * This function must not call any GLFW function.
- *
- * @param[in] block The address of the memory block to reallocate.
- * @param[in] size The new minimum size, in bytes, of the memory block.
- * @param[in] user The user-defined pointer from the allocator.
- * @return The address of the newly allocated or resized memory block, or
- * `NULL` if an error occurred.
- *
- * @pointer_lifetime The returned memory block must be valid at least until it
- * is deallocated.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function must support being called from any thread that calls GLFW
- * functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-typedef void* (* GLFWreallocatefun)(void* block, size_t size, void* user);
-
-/*! @brief The function pointer type for memory deallocation callbacks.
- *
- * This is the function pointer type for memory deallocation callbacks.
- * A memory deallocation callback function has the following signature:
- * @code
- * void function_name(void* block, void* user)
- * @endcode
- *
- * This function may deallocate the specified memory block. This memory block
- * will have been allocated with the same allocator.
- *
- * This function must support being called during @ref glfwInit but before the library is
- * flagged as initialized, as well as during @ref glfwTerminate after the library is no
- * longer flagged as initialized.
- *
- * The block address will never be `NULL`. Deallocations of `NULL` are filtered out
- * before reaching the custom allocator.
- *
- * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
- *
- * This function must not call any GLFW function.
- *
- * @param[in] block The address of the memory block to deallocate.
- * @param[in] user The user-defined pointer from the allocator.
- *
- * @pointer_lifetime The specified memory block will not be accessed by GLFW
- * after this function is called.
- *
- * @reentrancy This function should not call any GLFW function.
- *
- * @thread_safety This function must support being called from any thread that calls GLFW
- * functions.
- *
- * @sa @ref init_allocator
- * @sa @ref GLFWallocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-typedef void (* GLFWdeallocatefun)(void* block, void* user);
-
-/*! @brief The function pointer type for error callbacks.
- *
- * This is the function pointer type for error callbacks. An error callback
- * function has the following signature:
- * @code
- * void callback_name(int error_code, const char* description)
- * @endcode
- *
- * @param[in] error_code An [error code](@ref errors). Future releases may add
- * more error codes.
- * @param[in] description A UTF-8 encoded string describing the error.
- *
- * @pointer_lifetime The error description string is valid until the callback
- * function returns.
- *
- * @sa @ref error_handling
- * @sa @ref glfwSetErrorCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- */
-typedef void (* GLFWerrorfun)(int error_code, const char* description);
-
-/*! @brief The function pointer type for window position callbacks.
- *
- * This is the function pointer type for window position callbacks. A window
- * position callback function has the following signature:
- * @code
- * void callback_name(GLFWwindow* window, int xpos, int ypos)
- * @endcode
- *
- * @param[in] window The window that was moved.
- * @param[in] xpos The new x-coordinate, in screen coordinates, of the
- * upper-left corner of the content area of the window.
- * @param[in] ypos The new y-coordinate, in screen coordinates, of the
- * upper-left corner of the content area of the window.
- *
- * @sa @ref window_pos
- * @sa @ref glfwSetWindowPosCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowposfun)(GLFWwindow* window, int xpos, int ypos);
-
-/*! @brief The function pointer type for window size callbacks.
- *
- * This is the function pointer type for window size callbacks. A window size
- * callback function has the following signature:
- * @code
- * void callback_name(GLFWwindow* window, int width, int height)
- * @endcode
- *
- * @param[in] window The window that was resized.
- * @param[in] width The new width, in screen coordinates, of the window.
- * @param[in] height The new height, in screen coordinates, of the window.
- *
- * @sa @ref window_size
- * @sa @ref glfwSetWindowSizeCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowsizefun)(GLFWwindow* window, int width, int height);
-
-/*! @brief The function pointer type for window close callbacks.
- *
- * This is the function pointer type for window close callbacks. A window
- * close callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window)
- * @endcode
- *
- * @param[in] window The window that the user attempted to close.
- *
- * @sa @ref window_close
- * @sa @ref glfwSetWindowCloseCallback
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowclosefun)(GLFWwindow* window);
-
-/*! @brief The function pointer type for window content refresh callbacks.
- *
- * This is the function pointer type for window content refresh callbacks.
- * A window content refresh callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window);
- * @endcode
- *
- * @param[in] window The window whose content needs to be refreshed.
- *
- * @sa @ref window_refresh
- * @sa @ref glfwSetWindowRefreshCallback
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowrefreshfun)(GLFWwindow* window);
-
-/*! @brief The function pointer type for window focus callbacks.
- *
- * This is the function pointer type for window focus callbacks. A window
- * focus callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int focused)
- * @endcode
- *
- * @param[in] window The window that gained or lost input focus.
- * @param[in] focused `GLFW_TRUE` if the window was given input focus, or
- * `GLFW_FALSE` if it lost it.
- *
- * @sa @ref window_focus
- * @sa @ref glfwSetWindowFocusCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowfocusfun)(GLFWwindow* window, int focused);
-
-/*! @brief The function pointer type for window iconify callbacks.
- *
- * This is the function pointer type for window iconify callbacks. A window
- * iconify callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int iconified)
- * @endcode
- *
- * @param[in] window The window that was iconified or restored.
- * @param[in] iconified `GLFW_TRUE` if the window was iconified, or
- * `GLFW_FALSE` if it was restored.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwSetWindowIconifyCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowiconifyfun)(GLFWwindow* window, int iconified);
-
-/*! @brief The function pointer type for window maximize callbacks.
- *
- * This is the function pointer type for window maximize callbacks. A window
- * maximize callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int maximized)
- * @endcode
- *
- * @param[in] window The window that was maximized or restored.
- * @param[in] maximized `GLFW_TRUE` if the window was maximized, or
- * `GLFW_FALSE` if it was restored.
- *
- * @sa @ref window_maximize
- * @sa glfwSetWindowMaximizeCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowmaximizefun)(GLFWwindow* window, int maximized);
-
-/*! @brief The function pointer type for framebuffer size callbacks.
- *
- * This is the function pointer type for framebuffer size callbacks.
- * A framebuffer size callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- *
- * @param[in] window The window whose framebuffer was resized.
- * @param[in] width The new width, in pixels, of the framebuffer.
- * @param[in] height The new height, in pixels, of the framebuffer.
- *
- * @sa @ref window_fbsize
- * @sa @ref glfwSetFramebufferSizeCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-typedef void (* GLFWframebuffersizefun)(GLFWwindow* window, int width, int height);
-
-/*! @brief The function pointer type for window content scale callbacks.
- *
- * This is the function pointer type for window content scale callbacks.
- * A window content scale callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, float xscale, float yscale)
- * @endcode
- *
- * @param[in] window The window whose content scale changed.
- * @param[in] xscale The new x-axis content scale of the window.
- * @param[in] yscale The new y-axis content scale of the window.
- *
- * @sa @ref window_scale
- * @sa @ref glfwSetWindowContentScaleCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-typedef void (* GLFWwindowcontentscalefun)(GLFWwindow* window, float xscale, float yscale);
-
-/*! @brief The function pointer type for mouse button callbacks.
- *
- * This is the function pointer type for mouse button callback functions.
- * A mouse button callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int button, int action, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] button The [mouse button](@ref buttons) that was pressed or
- * released.
- * @param[in] action One of `GLFW_PRESS` or `GLFW_RELEASE`. Future releases
- * may add more actions.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_mouse_button
- * @sa @ref glfwSetMouseButtonCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle and modifier mask parameters.
- *
- * @ingroup input
- */
-typedef void (* GLFWmousebuttonfun)(GLFWwindow* window, int button, int action, int mods);
-
-/*! @brief The function pointer type for cursor position callbacks.
- *
- * This is the function pointer type for cursor position callbacks. A cursor
- * position callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, double xpos, double ypos);
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] xpos The new cursor x-coordinate, relative to the left edge of
- * the content area.
- * @param[in] ypos The new cursor y-coordinate, relative to the top edge of the
- * content area.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwSetCursorPosCallback
- *
- * @since Added in version 3.0. Replaces `GLFWmouseposfun`.
- *
- * @ingroup input
- */
-typedef void (* GLFWcursorposfun)(GLFWwindow* window, double xpos, double ypos);
-
-/*! @brief The function pointer type for cursor enter/leave callbacks.
- *
- * This is the function pointer type for cursor enter/leave callbacks.
- * A cursor enter/leave callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int entered)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] entered `GLFW_TRUE` if the cursor entered the window's content
- * area, or `GLFW_FALSE` if it left it.
- *
- * @sa @ref cursor_enter
- * @sa @ref glfwSetCursorEnterCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-typedef void (* GLFWcursorenterfun)(GLFWwindow* window, int entered);
-
-/*! @brief The function pointer type for scroll callbacks.
- *
- * This is the function pointer type for scroll callbacks. A scroll callback
- * function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, double xoffset, double yoffset)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] xoffset The scroll offset along the x-axis.
- * @param[in] yoffset The scroll offset along the y-axis.
- *
- * @sa @ref scrolling
- * @sa @ref glfwSetScrollCallback
- *
- * @since Added in version 3.0. Replaces `GLFWmousewheelfun`.
- *
- * @ingroup input
- */
-typedef void (* GLFWscrollfun)(GLFWwindow* window, double xoffset, double yoffset);
-
-/*! @brief The function pointer type for keyboard key callbacks.
- *
- * This is the function pointer type for keyboard key callbacks. A keyboard
- * key callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] key The [keyboard key](@ref keys) that was pressed or released.
- * @param[in] scancode The platform-specific scancode of the key.
- * @param[in] action `GLFW_PRESS`, `GLFW_RELEASE` or `GLFW_REPEAT`. Future
- * releases may add more actions.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_key
- * @sa @ref glfwSetKeyCallback
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle, scancode and modifier mask parameters.
- *
- * @ingroup input
- */
-typedef void (* GLFWkeyfun)(GLFWwindow* window, int key, int scancode, int action, int mods);
-
-/*! @brief The function pointer type for Unicode character callbacks.
- *
- * This is the function pointer type for Unicode character callbacks.
- * A Unicode character callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] codepoint The Unicode code point of the character.
- *
- * @sa @ref input_char
- * @sa @ref glfwSetCharCallback
- *
- * @since Added in version 2.4.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- */
-typedef void (* GLFWcharfun)(GLFWwindow* window, unsigned int codepoint);
-
-/*! @brief The function pointer type for Unicode character with modifiers
- * callbacks.
- *
- * This is the function pointer type for Unicode character with modifiers
- * callbacks. It is called for each input character, regardless of what
- * modifier keys are held down. A Unicode character with modifiers callback
- * function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] codepoint The Unicode code point of the character.
- * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
- * held down.
- *
- * @sa @ref input_char
- * @sa @ref glfwSetCharModsCallback
- *
- * @deprecated Scheduled for removal in version 4.0.
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-typedef void (* GLFWcharmodsfun)(GLFWwindow* window, unsigned int codepoint, int mods);
-
-/*! @brief The function pointer type for path drop callbacks.
- *
- * This is the function pointer type for path drop callbacks. A path drop
- * callback function has the following signature:
- * @code
- * void function_name(GLFWwindow* window, int path_count, const char* paths[])
- * @endcode
- *
- * @param[in] window The window that received the event.
- * @param[in] path_count The number of dropped paths.
- * @param[in] paths The UTF-8 encoded file and/or directory path names.
- *
- * @pointer_lifetime The path array and its strings are valid until the
- * callback function returns.
- *
- * @sa @ref path_drop
- * @sa @ref glfwSetDropCallback
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-typedef void (* GLFWdropfun)(GLFWwindow* window, int path_count, const char* paths[]);
-
-/*! @brief The function pointer type for monitor configuration callbacks.
- *
- * This is the function pointer type for monitor configuration callbacks.
- * A monitor callback function has the following signature:
- * @code
- * void function_name(GLFWmonitor* monitor, int event)
- * @endcode
- *
- * @param[in] monitor The monitor that was connected or disconnected.
- * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
- * releases may add more events.
- *
- * @sa @ref monitor_event
- * @sa @ref glfwSetMonitorCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-typedef void (* GLFWmonitorfun)(GLFWmonitor* monitor, int event);
-
-/*! @brief The function pointer type for joystick configuration callbacks.
- *
- * This is the function pointer type for joystick configuration callbacks.
- * A joystick configuration callback function has the following signature:
- * @code
- * void function_name(int jid, int event)
- * @endcode
- *
- * @param[in] jid The joystick that was connected or disconnected.
- * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
- * releases may add more events.
- *
- * @sa @ref joystick_event
- * @sa @ref glfwSetJoystickCallback
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- */
-typedef void (* GLFWjoystickfun)(int jid, int event);
-
-/*! @brief Video mode type.
- *
- * This describes a single video mode.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoMode
- * @sa @ref glfwGetVideoModes
- *
- * @since Added in version 1.0.
- * @glfw3 Added refresh rate member.
- *
- * @ingroup monitor
- */
-typedef struct GLFWvidmode
-{
- /*! The width, in screen coordinates, of the video mode.
+
+
+ /*************************************************************************
+ * GLFW API types
+ *************************************************************************/
+
+ /*! @brief Client API function pointer type.
+ *
+ * Generic function pointer used for returning client API function pointers
+ * without forcing a cast from a regular pointer.
+ *
+ * @sa @ref context_glext
+ * @sa @ref glfwGetProcAddress
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup context
*/
- int width;
- /*! The height, in screen coordinates, of the video mode.
+ typedef void (*GLFWglproc)(void);
+
+ /*! @brief Vulkan API function pointer type.
+ *
+ * Generic function pointer used for returning Vulkan API function pointers
+ * without forcing a cast from a regular pointer.
+ *
+ * @sa @ref vulkan_proc
+ * @sa @ref glfwGetInstanceProcAddress
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
*/
- int height;
- /*! The bit depth of the red channel of the video mode.
+ typedef void (*GLFWvkproc)(void);
+
+ /*! @brief Opaque monitor object.
+ *
+ * Opaque monitor object.
+ *
+ * @see @ref monitor_object
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
*/
- int redBits;
- /*! The bit depth of the green channel of the video mode.
+ typedef struct GLFWmonitor GLFWmonitor;
+
+ /*! @brief Opaque window object.
+ *
+ * Opaque window object.
+ *
+ * @see @ref window_object
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
*/
- int greenBits;
- /*! The bit depth of the blue channel of the video mode.
+ typedef struct GLFWwindow GLFWwindow;
+
+ /*! @brief Opaque cursor object.
+ *
+ * Opaque cursor object.
+ *
+ * @see @ref cursor_object
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
*/
- int blueBits;
- /*! The refresh rate, in Hz, of the video mode.
+ typedef struct GLFWcursor GLFWcursor;
+
+ /*! @brief The function pointer type for memory allocation callbacks.
+ *
+ * This is the function pointer type for memory allocation callbacks. A memory
+ * allocation callback function has the following signature:
+ * @code
+ * void* function_name(size_t size, void* user)
+ * @endcode
+ *
+ * This function must return either a memory block at least `size` bytes long,
+ * or `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
+ * failures gracefully yet.
+ *
+ * This function must support being called during @ref glfwInit but before the library is
+ * flagged as initialized, as well as during @ref glfwTerminate after the library is no
+ * longer flagged as initialized.
+ *
+ * Any memory allocated via this function will be deallocated via the same allocator
+ * during library termination or earlier.
+ *
+ * Any memory allocated via this function must be suitably aligned for any object type.
+ * If you are using C99 or earlier, this alignment is platform-dependent but will be the
+ * same as what `malloc` provides. If you are using C11 or later, this is the value of
+ * `alignof(max_align_t)`.
+ *
+ * The size will always be greater than zero. Allocations of size zero are filtered out
+ * before reaching the custom allocator.
+ *
+ * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
+ *
+ * This function must not call any GLFW function.
+ *
+ * @param[in] size The minimum size, in bytes, of the memory block.
+ * @param[in] user The user-defined pointer from the allocator.
+ * @return The address of the newly allocated memory block, or `NULL` if an
+ * error occurred.
+ *
+ * @pointer_lifetime The returned memory block must be valid at least until it
+ * is deallocated.
+ *
+ * @reentrancy This function should not call any GLFW function.
+ *
+ * @thread_safety This function must support being called from any thread that calls GLFW
+ * functions.
+ *
+ * @sa @ref init_allocator
+ * @sa @ref GLFWallocator
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
*/
- int refreshRate;
-} GLFWvidmode;
-
-/*! @brief Gamma ramp.
- *
- * This describes the gamma ramp for a monitor.
- *
- * @sa @ref monitor_gamma
- * @sa @ref glfwGetGammaRamp
- * @sa @ref glfwSetGammaRamp
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-typedef struct GLFWgammaramp
-{
- /*! An array of value describing the response of the red channel.
+ typedef void* (* GLFWallocatefun)(size_t size, void* user);
+
+ /*! @brief The function pointer type for memory reallocation callbacks.
+ *
+ * This is the function pointer type for memory reallocation callbacks.
+ * A memory reallocation callback function has the following signature:
+ * @code
+ * void* function_name(void* block, size_t size, void* user)
+ * @endcode
+ *
+ * This function must return a memory block at least `size` bytes long, or
+ * `NULL` if allocation failed. Note that not all parts of GLFW handle allocation
+ * failures gracefully yet.
+ *
+ * This function must support being called during @ref glfwInit but before the library is
+ * flagged as initialized, as well as during @ref glfwTerminate after the library is no
+ * longer flagged as initialized.
+ *
+ * Any memory allocated via this function will be deallocated via the same allocator
+ * during library termination or earlier.
+ *
+ * Any memory allocated via this function must be suitably aligned for any object type.
+ * If you are using C99 or earlier, this alignment is platform-dependent but will be the
+ * same as what `realloc` provides. If you are using C11 or later, this is the value of
+ * `alignof(max_align_t)`.
+ *
+ * The block address will never be `NULL` and the size will always be greater than zero.
+ * Reallocations of a block to size zero are converted into deallocations before reaching
+ * the custom allocator. Reallocations of `NULL` to a non-zero size are converted into
+ * regular allocations before reaching the custom allocator.
+ *
+ * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
+ *
+ * This function must not call any GLFW function.
+ *
+ * @param[in] block The address of the memory block to reallocate.
+ * @param[in] size The new minimum size, in bytes, of the memory block.
+ * @param[in] user The user-defined pointer from the allocator.
+ * @return The address of the newly allocated or resized memory block, or
+ * `NULL` if an error occurred.
+ *
+ * @pointer_lifetime The returned memory block must be valid at least until it
+ * is deallocated.
+ *
+ * @reentrancy This function should not call any GLFW function.
+ *
+ * @thread_safety This function must support being called from any thread that calls GLFW
+ * functions.
+ *
+ * @sa @ref init_allocator
+ * @sa @ref GLFWallocator
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
*/
- unsigned short* red;
- /*! An array of value describing the response of the green channel.
+ typedef void* (* GLFWreallocatefun)(void* block, size_t size, void* user);
+
+ /*! @brief The function pointer type for memory deallocation callbacks.
+ *
+ * This is the function pointer type for memory deallocation callbacks.
+ * A memory deallocation callback function has the following signature:
+ * @code
+ * void function_name(void* block, void* user)
+ * @endcode
+ *
+ * This function may deallocate the specified memory block. This memory block
+ * will have been allocated with the same allocator.
+ *
+ * This function must support being called during @ref glfwInit but before the library is
+ * flagged as initialized, as well as during @ref glfwTerminate after the library is no
+ * longer flagged as initialized.
+ *
+ * The block address will never be `NULL`. Deallocations of `NULL` are filtered out
+ * before reaching the custom allocator.
+ *
+ * If this function returns `NULL`, GLFW will emit @ref GLFW_OUT_OF_MEMORY.
+ *
+ * This function must not call any GLFW function.
+ *
+ * @param[in] block The address of the memory block to deallocate.
+ * @param[in] user The user-defined pointer from the allocator.
+ *
+ * @pointer_lifetime The specified memory block will not be accessed by GLFW
+ * after this function is called.
+ *
+ * @reentrancy This function should not call any GLFW function.
+ *
+ * @thread_safety This function must support being called from any thread that calls GLFW
+ * functions.
+ *
+ * @sa @ref init_allocator
+ * @sa @ref GLFWallocator
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
*/
- unsigned short* green;
- /*! An array of value describing the response of the blue channel.
+ typedef void (* GLFWdeallocatefun)(void* block, void* user);
+
+ /*! @brief The function pointer type for error callbacks.
+ *
+ * This is the function pointer type for error callbacks. An error callback
+ * function has the following signature:
+ * @code
+ * void callback_name(int error_code, const char* description)
+ * @endcode
+ *
+ * @param[in] error_code An [error code](@ref errors). Future releases may add
+ * more error codes.
+ * @param[in] description A UTF-8 encoded string describing the error.
+ *
+ * @pointer_lifetime The error description string is valid until the callback
+ * function returns.
+ *
+ * @sa @ref error_handling
+ * @sa @ref glfwSetErrorCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup init
*/
- unsigned short* blue;
- /*! The number of elements in each array.
+ typedef void (* GLFWerrorfun)(int error_code, const char* description);
+
+ /*! @brief The function pointer type for window position callbacks.
+ *
+ * This is the function pointer type for window position callbacks. A window
+ * position callback function has the following signature:
+ * @code
+ * void callback_name(GLFWwindow* window, int xpos, int ypos)
+ * @endcode
+ *
+ * @param[in] window The window that was moved.
+ * @param[in] xpos The new x-coordinate, in screen coordinates, of the
+ * upper-left corner of the content area of the window.
+ * @param[in] ypos The new y-coordinate, in screen coordinates, of the
+ * upper-left corner of the content area of the window.
+ *
+ * @sa @ref window_pos
+ * @sa @ref glfwSetWindowPosCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
*/
- unsigned int size;
-} GLFWgammaramp;
-
-/*! @brief Image data.
- *
- * This describes a single 2D image. See the documentation for each related
- * function what the expected pixel format is.
- *
- * @sa @ref cursor_custom
- * @sa @ref window_icon
- *
- * @since Added in version 2.1.
- * @glfw3 Removed format and bytes-per-pixel members.
- *
- * @ingroup window
- */
-typedef struct GLFWimage
-{
- /*! The width, in pixels, of this image.
+ typedef void (* GLFWwindowposfun)(GLFWwindow* window, int xpos, int ypos);
+
+ /*! @brief The function pointer type for window size callbacks.
+ *
+ * This is the function pointer type for window size callbacks. A window size
+ * callback function has the following signature:
+ * @code
+ * void callback_name(GLFWwindow* window, int width, int height)
+ * @endcode
+ *
+ * @param[in] window The window that was resized.
+ * @param[in] width The new width, in screen coordinates, of the window.
+ * @param[in] height The new height, in screen coordinates, of the window.
+ *
+ * @sa @ref window_size
+ * @sa @ref glfwSetWindowSizeCallback
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
*/
- int width;
- /*! The height, in pixels, of this image.
+ typedef void (* GLFWwindowsizefun)(GLFWwindow* window, int width, int height);
+
+ /*! @brief The function pointer type for window close callbacks.
+ *
+ * This is the function pointer type for window close callbacks. A window
+ * close callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window)
+ * @endcode
+ *
+ * @param[in] window The window that the user attempted to close.
+ *
+ * @sa @ref window_close
+ * @sa @ref glfwSetWindowCloseCallback
+ *
+ * @since Added in version 2.5.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
*/
- int height;
- /*! The pixel data of this image, arranged left-to-right, top-to-bottom.
+ typedef void (* GLFWwindowclosefun)(GLFWwindow* window);
+
+ /*! @brief The function pointer type for window content refresh callbacks.
+ *
+ * This is the function pointer type for window content refresh callbacks.
+ * A window content refresh callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window);
+ * @endcode
+ *
+ * @param[in] window The window whose content needs to be refreshed.
+ *
+ * @sa @ref window_refresh
+ * @sa @ref glfwSetWindowRefreshCallback
+ *
+ * @since Added in version 2.5.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
*/
- unsigned char* pixels;
-} GLFWimage;
-
-/*! @brief Gamepad input state
- *
- * This describes the input state of a gamepad.
- *
- * @sa @ref gamepad
- * @sa @ref glfwGetGamepadState
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-typedef struct GLFWgamepadstate
-{
- /*! The states of each [gamepad button](@ref gamepad_buttons), `GLFW_PRESS`
- * or `GLFW_RELEASE`.
- */
- unsigned char buttons[15];
- /*! The states of each [gamepad axis](@ref gamepad_axes), in the range -1.0
- * to 1.0 inclusive.
- */
- float axes[6];
-} GLFWgamepadstate;
-
-/*! @brief Custom heap memory allocator.
- *
- * This describes a custom heap memory allocator for GLFW. To set an allocator, pass it
- * to @ref glfwInitAllocator before initializing the library.
- *
- * @sa @ref init_allocator
- * @sa @ref glfwInitAllocator
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-typedef struct GLFWallocator
-{
- /*! The memory allocation function. See @ref GLFWallocatefun for details about
- * allocation function.
- */
- GLFWallocatefun allocate;
- /*! The memory reallocation function. See @ref GLFWreallocatefun for details about
- * reallocation function.
- */
- GLFWreallocatefun reallocate;
- /*! The memory deallocation function. See @ref GLFWdeallocatefun for details about
- * deallocation function.
- */
- GLFWdeallocatefun deallocate;
- /*! The user pointer for this custom allocator. This value will be passed to the
- * allocator functions.
- */
- void* user;
-} GLFWallocator;
-
-
-/*************************************************************************
- * GLFW API functions
- *************************************************************************/
-
-/*! @brief Initializes the GLFW library.
- *
- * This function initializes the GLFW library. Before most GLFW functions can
- * be used, GLFW must be initialized, and before an application terminates GLFW
- * should be terminated in order to free any resources allocated during or
- * after initialization.
- *
- * If this function fails, it calls @ref glfwTerminate before returning. If it
- * succeeds, you should call @ref glfwTerminate before the application exits.
- *
- * Additional calls to this function after successful initialization but before
- * termination will return `GLFW_TRUE` immediately.
- *
- * The @ref GLFW_PLATFORM init hint controls which platforms are considered during
- * initialization. This also depends on which platforms the library was compiled to
- * support.
- *
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_PLATFORM_UNAVAILABLE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos This function will change the current directory of the
- * application to the `Contents/Resources` subdirectory of the application's
- * bundle, if present. This can be disabled with the @ref
- * GLFW_COCOA_CHDIR_RESOURCES init hint.
- *
- * @remark @macos This function will create the main menu and dock icon for the
- * application. If GLFW finds a `MainMenu.nib` it is loaded and assumed to
- * contain a menu bar. Otherwise a minimal menu bar is created manually with
- * common commands like Hide, Quit and About. The About entry opens a minimal
- * about dialog with information from the application's bundle. The menu bar
- * and dock icon can be disabled entirely with the @ref GLFW_COCOA_MENUBAR init
- * hint.
- *
- * @remark __Wayland, X11:__ If the library was compiled with support for both
- * Wayland and X11, and the @ref GLFW_PLATFORM init hint is set to
- * `GLFW_ANY_PLATFORM`, the `XDG_SESSION_TYPE` environment variable affects
- * which platform is picked. If the environment variable is not set, or is set
- * to something other than `wayland` or `x11`, the regular detection mechanism
- * will be used instead.
- *
- * @remark @x11 This function will set the `LC_CTYPE` category of the
- * application locale according to the current environment if that category is
- * still "C". This is because the "C" locale breaks Unicode text input.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref intro_init
- * @sa @ref glfwInitHint
- * @sa @ref glfwInitAllocator
- * @sa @ref glfwTerminate
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- */
-GLFWAPI int glfwInit(void);
-
-/*! @brief Terminates the GLFW library.
- *
- * This function destroys all remaining windows and cursors, restores any
- * modified gamma ramps and frees any other allocated resources. Once this
- * function is called, you must again call @ref glfwInit successfully before
- * you will be able to use most GLFW functions.
- *
- * If GLFW has been successfully initialized, this function should be called
- * before the application exits. If initialization fails, there is no need to
- * call this function, as it is called by @ref glfwInit before it returns
- * failure.
- *
- * This function has no effect if GLFW is not initialized.
- *
- * @errors Possible errors include @ref GLFW_PLATFORM_ERROR.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @warning The contexts of any remaining windows must not be current on any
- * other thread when this function is called.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref intro_init
- * @sa @ref glfwInit
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- */
-GLFWAPI void glfwTerminate(void);
-
-/*! @brief Sets the specified init hint to the desired value.
- *
- * This function sets hints for the next initialization of GLFW.
- *
- * The values you set hints to are never reset by GLFW, but they only take
- * effect during initialization. Once GLFW has been initialized, any values
- * you set will be ignored until the library is terminated and initialized
- * again.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [init hint](@ref init_hints) to set.
- * @param[in] value The new value of the init hint.
- *
- * @errors Possible errors include @ref GLFW_INVALID_ENUM and @ref
- * GLFW_INVALID_VALUE.
- *
- * @remarks This function may be called before @ref glfwInit.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa init_hints
- * @sa glfwInit
- *
- * @since Added in version 3.3.
- *
- * @ingroup init
- */
-GLFWAPI void glfwInitHint(int hint, int value);
-
-/*! @brief Sets the init allocator to the desired value.
- *
- * To use the default allocator, call this function with a `NULL` argument.
- *
- * If you specify an allocator struct, every member must be a valid function
- * pointer. If any member is `NULL`, this function will emit @ref
- * GLFW_INVALID_VALUE and the init allocator will be unchanged.
- *
- * The functions in the allocator must fulfil a number of requirements. See the
- * documentation for @ref GLFWallocatefun, @ref GLFWreallocatefun and @ref
- * GLFWdeallocatefun for details.
- *
- * @param[in] allocator The allocator to use at the next initialization, or
- * `NULL` to use the default one.
- *
- * @errors Possible errors include @ref GLFW_INVALID_VALUE.
- *
- * @pointer_lifetime The specified allocator is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref init_allocator
- * @sa @ref glfwInit
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-GLFWAPI void glfwInitAllocator(const GLFWallocator* allocator);
-
+ typedef void (* GLFWwindowrefreshfun)(GLFWwindow* window);
+
+ /*! @brief The function pointer type for window focus callbacks.
+ *
+ * This is the function pointer type for window focus callbacks. A window
+ * focus callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int focused)
+ * @endcode
+ *
+ * @param[in] window The window that gained or lost input focus.
+ * @param[in] focused `GLFW_TRUE` if the window was given input focus, or
+ * `GLFW_FALSE` if it lost it.
+ *
+ * @sa @ref window_focus
+ * @sa @ref glfwSetWindowFocusCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ typedef void (* GLFWwindowfocusfun)(GLFWwindow* window, int focused);
+
+ /*! @brief The function pointer type for window iconify callbacks.
+ *
+ * This is the function pointer type for window iconify callbacks. A window
+ * iconify callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int iconified)
+ * @endcode
+ *
+ * @param[in] window The window that was iconified or restored.
+ * @param[in] iconified `GLFW_TRUE` if the window was iconified, or
+ * `GLFW_FALSE` if it was restored.
+ *
+ * @sa @ref window_iconify
+ * @sa @ref glfwSetWindowIconifyCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ typedef void (* GLFWwindowiconifyfun)(GLFWwindow* window, int iconified);
+
+ /*! @brief The function pointer type for window maximize callbacks.
+ *
+ * This is the function pointer type for window maximize callbacks. A window
+ * maximize callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int maximized)
+ * @endcode
+ *
+ * @param[in] window The window that was maximized or restored.
+ * @param[in] maximized `GLFW_TRUE` if the window was maximized, or
+ * `GLFW_FALSE` if it was restored.
+ *
+ * @sa @ref window_maximize
+ * @sa glfwSetWindowMaximizeCallback
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ typedef void (* GLFWwindowmaximizefun)(GLFWwindow* window, int maximized);
+
+ /*! @brief The function pointer type for framebuffer size callbacks.
+ *
+ * This is the function pointer type for framebuffer size callbacks.
+ * A framebuffer size callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int width, int height)
+ * @endcode
+ *
+ * @param[in] window The window whose framebuffer was resized.
+ * @param[in] width The new width, in pixels, of the framebuffer.
+ * @param[in] height The new height, in pixels, of the framebuffer.
+ *
+ * @sa @ref window_fbsize
+ * @sa @ref glfwSetFramebufferSizeCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ typedef void (* GLFWframebuffersizefun)(GLFWwindow* window, int width, int height);
+
+ /*! @brief The function pointer type for window content scale callbacks.
+ *
+ * This is the function pointer type for window content scale callbacks.
+ * A window content scale callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, float xscale, float yscale)
+ * @endcode
+ *
+ * @param[in] window The window whose content scale changed.
+ * @param[in] xscale The new x-axis content scale of the window.
+ * @param[in] yscale The new y-axis content scale of the window.
+ *
+ * @sa @ref window_scale
+ * @sa @ref glfwSetWindowContentScaleCallback
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ typedef void (* GLFWwindowcontentscalefun)(GLFWwindow* window, float xscale, float yscale);
+
+ /*! @brief The function pointer type for mouse button callbacks.
+ *
+ * This is the function pointer type for mouse button callback functions.
+ * A mouse button callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int button, int action, int mods)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] button The [mouse button](@ref buttons) that was pressed or
+ * released.
+ * @param[in] action One of `GLFW_PRESS` or `GLFW_RELEASE`. Future releases
+ * may add more actions.
+ * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
+ * held down.
+ *
+ * @sa @ref input_mouse_button
+ * @sa @ref glfwSetMouseButtonCallback
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle and modifier mask parameters.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWmousebuttonfun)(GLFWwindow* window, int button, int action, int mods);
+
+ /*! @brief The function pointer type for cursor position callbacks.
+ *
+ * This is the function pointer type for cursor position callbacks. A cursor
+ * position callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, double xpos, double ypos);
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] xpos The new cursor x-coordinate, relative to the left edge of
+ * the content area.
+ * @param[in] ypos The new cursor y-coordinate, relative to the top edge of the
+ * content area.
+ *
+ * @sa @ref cursor_pos
+ * @sa @ref glfwSetCursorPosCallback
+ *
+ * @since Added in version 3.0. Replaces `GLFWmouseposfun`.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWcursorposfun)(GLFWwindow* window, double xpos, double ypos);
+
+ /*! @brief The function pointer type for cursor enter/leave callbacks.
+ *
+ * This is the function pointer type for cursor enter/leave callbacks.
+ * A cursor enter/leave callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int entered)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] entered `GLFW_TRUE` if the cursor entered the window's content
+ * area, or `GLFW_FALSE` if it left it.
+ *
+ * @sa @ref cursor_enter
+ * @sa @ref glfwSetCursorEnterCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWcursorenterfun)(GLFWwindow* window, int entered);
+
+ /*! @brief The function pointer type for scroll callbacks.
+ *
+ * This is the function pointer type for scroll callbacks. A scroll callback
+ * function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, double xoffset, double yoffset)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] xoffset The scroll offset along the x-axis.
+ * @param[in] yoffset The scroll offset along the y-axis.
+ *
+ * @sa @ref scrolling
+ * @sa @ref glfwSetScrollCallback
+ *
+ * @since Added in version 3.0. Replaces `GLFWmousewheelfun`.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWscrollfun)(GLFWwindow* window, double xoffset, double yoffset);
+
+ /*! @brief The function pointer type for keyboard key callbacks.
+ *
+ * This is the function pointer type for keyboard key callbacks. A keyboard
+ * key callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] key The [keyboard key](@ref keys) that was pressed or released.
+ * @param[in] scancode The platform-specific scancode of the key.
+ * @param[in] action `GLFW_PRESS`, `GLFW_RELEASE` or `GLFW_REPEAT`. Future
+ * releases may add more actions.
+ * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
+ * held down.
+ *
+ * @sa @ref input_key
+ * @sa @ref glfwSetKeyCallback
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle, scancode and modifier mask parameters.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWkeyfun)(GLFWwindow* window, int key, int scancode, int action, int mods);
+
+ /*! @brief The function pointer type for Unicode character callbacks.
+ *
+ * This is the function pointer type for Unicode character callbacks.
+ * A Unicode character callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, unsigned int codepoint)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] codepoint The Unicode code point of the character.
+ *
+ * @sa @ref input_char
+ * @sa @ref glfwSetCharCallback
+ *
+ * @since Added in version 2.4.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWcharfun)(GLFWwindow* window, unsigned int codepoint);
+
+ /*! @brief The function pointer type for Unicode character with modifiers
+ * callbacks.
+ *
+ * This is the function pointer type for Unicode character with modifiers
+ * callbacks. It is called for each input character, regardless of what
+ * modifier keys are held down. A Unicode character with modifiers callback
+ * function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] codepoint The Unicode code point of the character.
+ * @param[in] mods Bit field describing which [modifier keys](@ref mods) were
+ * held down.
+ *
+ * @sa @ref input_char
+ * @sa @ref glfwSetCharModsCallback
+ *
+ * @deprecated Scheduled for removal in version 4.0.
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWcharmodsfun)(GLFWwindow* window, unsigned int codepoint, int mods);
+
+ /*! @brief The function pointer type for path drop callbacks.
+ *
+ * This is the function pointer type for path drop callbacks. A path drop
+ * callback function has the following signature:
+ * @code
+ * void function_name(GLFWwindow* window, int path_count, const char* paths[])
+ * @endcode
+ *
+ * @param[in] window The window that received the event.
+ * @param[in] path_count The number of dropped paths.
+ * @param[in] paths The UTF-8 encoded file and/or directory path names.
+ *
+ * @pointer_lifetime The path array and its strings are valid until the
+ * callback function returns.
+ *
+ * @sa @ref path_drop
+ * @sa @ref glfwSetDropCallback
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWdropfun)(GLFWwindow* window, int path_count, const char* paths[]);
+
+ /*! @brief The function pointer type for monitor configuration callbacks.
+ *
+ * This is the function pointer type for monitor configuration callbacks.
+ * A monitor callback function has the following signature:
+ * @code
+ * void function_name(GLFWmonitor* monitor, int event)
+ * @endcode
+ *
+ * @param[in] monitor The monitor that was connected or disconnected.
+ * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
+ * releases may add more events.
+ *
+ * @sa @ref monitor_event
+ * @sa @ref glfwSetMonitorCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ typedef void (* GLFWmonitorfun)(GLFWmonitor* monitor, int event);
+
+ /*! @brief The function pointer type for joystick configuration callbacks.
+ *
+ * This is the function pointer type for joystick configuration callbacks.
+ * A joystick configuration callback function has the following signature:
+ * @code
+ * void function_name(int jid, int event)
+ * @endcode
+ *
+ * @param[in] jid The joystick that was connected or disconnected.
+ * @param[in] event One of `GLFW_CONNECTED` or `GLFW_DISCONNECTED`. Future
+ * releases may add more events.
+ *
+ * @sa @ref joystick_event
+ * @sa @ref glfwSetJoystickCallback
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup input
+ */
+ typedef void (* GLFWjoystickfun)(int jid, int event);
+
+ /*! @brief Video mode type.
+ *
+ * This describes a single video mode.
+ *
+ * @sa @ref monitor_modes
+ * @sa @ref glfwGetVideoMode
+ * @sa @ref glfwGetVideoModes
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added refresh rate member.
+ *
+ * @ingroup monitor
+ */
+ typedef struct GLFWvidmode
+ {
+ /*! The width, in screen coordinates, of the video mode.
+ */
+ int width;
+ /*! The height, in screen coordinates, of the video mode.
+ */
+ int height;
+ /*! The bit depth of the red channel of the video mode.
+ */
+ int redBits;
+ /*! The bit depth of the green channel of the video mode.
+ */
+ int greenBits;
+ /*! The bit depth of the blue channel of the video mode.
+ */
+ int blueBits;
+ /*! The refresh rate, in Hz, of the video mode.
+ */
+ int refreshRate;
+ } GLFWvidmode;
+
+ /*! @brief Gamma ramp.
+ *
+ * This describes the gamma ramp for a monitor.
+ *
+ * @sa @ref monitor_gamma
+ * @sa @ref glfwGetGammaRamp
+ * @sa @ref glfwSetGammaRamp
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ typedef struct GLFWgammaramp
+ {
+ /*! An array of value describing the response of the red channel.
+ */
+ unsigned short* red;
+ /*! An array of value describing the response of the green channel.
+ */
+ unsigned short* green;
+ /*! An array of value describing the response of the blue channel.
+ */
+ unsigned short* blue;
+ /*! The number of elements in each array.
+ */
+ unsigned int size;
+ } GLFWgammaramp;
+
+ /*! @brief Image data.
+ *
+ * This describes a single 2D image. See the documentation for each related
+ * function what the expected pixel format is.
+ *
+ * @sa @ref cursor_custom
+ * @sa @ref window_icon
+ *
+ * @since Added in version 2.1.
+ * @glfw3 Removed format and bytes-per-pixel members.
+ *
+ * @ingroup window
+ */
+ typedef struct GLFWimage
+ {
+ /*! The width, in pixels, of this image.
+ */
+ int width;
+ /*! The height, in pixels, of this image.
+ */
+ int height;
+ /*! The pixel data of this image, arranged left-to-right, top-to-bottom.
+ */
+ unsigned char* pixels;
+ } GLFWimage;
+
+ /*! @brief Gamepad input state
+ *
+ * This describes the input state of a gamepad.
+ *
+ * @sa @ref gamepad
+ * @sa @ref glfwGetGamepadState
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ typedef struct GLFWgamepadstate
+ {
+ /*! The states of each [gamepad button](@ref gamepad_buttons), `GLFW_PRESS`
+ * or `GLFW_RELEASE`.
+ */
+ unsigned char buttons[15];
+ /*! The states of each [gamepad axis](@ref gamepad_axes), in the range -1.0
+ * to 1.0 inclusive.
+ */
+ float axes[6];
+ } GLFWgamepadstate;
+
+ /*! @brief Custom heap memory allocator.
+ *
+ * This describes a custom heap memory allocator for GLFW. To set an allocator, pass it
+ * to @ref glfwInitAllocator before initializing the library.
+ *
+ * @sa @ref init_allocator
+ * @sa @ref glfwInitAllocator
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
+ */
+ typedef struct GLFWallocator
+ {
+ /*! The memory allocation function. See @ref GLFWallocatefun for details about
+ * allocation function.
+ */
+ GLFWallocatefun allocate;
+ /*! The memory reallocation function. See @ref GLFWreallocatefun for details about
+ * reallocation function.
+ */
+ GLFWreallocatefun reallocate;
+ /*! The memory deallocation function. See @ref GLFWdeallocatefun for details about
+ * deallocation function.
+ */
+ GLFWdeallocatefun deallocate;
+ /*! The user pointer for this custom allocator. This value will be passed to the
+ * allocator functions.
+ */
+ void* user;
+ } GLFWallocator;
+
+
+ /*************************************************************************
+ * GLFW API functions
+ *************************************************************************/
+
+ /*! @brief Initializes the GLFW library.
+ *
+ * This function initializes the GLFW library. Before most GLFW functions can
+ * be used, GLFW must be initialized, and before an application terminates GLFW
+ * should be terminated in order to free any resources allocated during or
+ * after initialization.
+ *
+ * If this function fails, it calls @ref glfwTerminate before returning. If it
+ * succeeds, you should call @ref glfwTerminate before the application exits.
+ *
+ * Additional calls to this function after successful initialization but before
+ * termination will return `GLFW_TRUE` immediately.
+ *
+ * The @ref GLFW_PLATFORM init hint controls which platforms are considered during
+ * initialization. This also depends on which platforms the library was compiled to
+ * support.
+ *
+ * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_PLATFORM_UNAVAILABLE and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @macos This function will change the current directory of the
+ * application to the `Contents/Resources` subdirectory of the application's
+ * bundle, if present. This can be disabled with the @ref
+ * GLFW_COCOA_CHDIR_RESOURCES init hint.
+ *
+ * @remark @macos This function will create the main menu and dock icon for the
+ * application. If GLFW finds a `MainMenu.nib` it is loaded and assumed to
+ * contain a menu bar. Otherwise a minimal menu bar is created manually with
+ * common commands like Hide, Quit and About. The About entry opens a minimal
+ * about dialog with information from the application's bundle. The menu bar
+ * and dock icon can be disabled entirely with the @ref GLFW_COCOA_MENUBAR init
+ * hint.
+ *
+ * @remark __Wayland, X11:__ If the library was compiled with support for both
+ * Wayland and X11, and the @ref GLFW_PLATFORM init hint is set to
+ * `GLFW_ANY_PLATFORM`, the `XDG_SESSION_TYPE` environment variable affects
+ * which platform is picked. If the environment variable is not set, or is set
+ * to something other than `wayland` or `x11`, the regular detection mechanism
+ * will be used instead.
+ *
+ * @remark @x11 This function will set the `LC_CTYPE` category of the
+ * application locale according to the current environment if that category is
+ * still "C". This is because the "C" locale breaks Unicode text input.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref intro_init
+ * @sa @ref glfwInitHint
+ * @sa @ref glfwInitAllocator
+ * @sa @ref glfwTerminate
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup init
+ */
+ GLFWAPI int glfwInit(void);
+
+ /*! @brief Terminates the GLFW library.
+ *
+ * This function destroys all remaining windows and cursors, restores any
+ * modified gamma ramps and frees any other allocated resources. Once this
+ * function is called, you must again call @ref glfwInit successfully before
+ * you will be able to use most GLFW functions.
+ *
+ * If GLFW has been successfully initialized, this function should be called
+ * before the application exits. If initialization fails, there is no need to
+ * call this function, as it is called by @ref glfwInit before it returns
+ * failure.
+ *
+ * This function has no effect if GLFW is not initialized.
+ *
+ * @errors Possible errors include @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @warning The contexts of any remaining windows must not be current on any
+ * other thread when this function is called.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref intro_init
+ * @sa @ref glfwInit
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup init
+ */
+ GLFWAPI void glfwTerminate(void);
+
+ /*! @brief Sets the specified init hint to the desired value.
+ *
+ * This function sets hints for the next initialization of GLFW.
+ *
+ * The values you set hints to are never reset by GLFW, but they only take
+ * effect during initialization. Once GLFW has been initialized, any values
+ * you set will be ignored until the library is terminated and initialized
+ * again.
+ *
+ * Some hints are platform specific. These may be set on any platform but they
+ * will only affect their specific platform. Other platforms will ignore them.
+ * Setting these hints requires no platform specific headers or functions.
+ *
+ * @param[in] hint The [init hint](@ref init_hints) to set.
+ * @param[in] value The new value of the init hint.
+ *
+ * @errors Possible errors include @ref GLFW_INVALID_ENUM and @ref
+ * GLFW_INVALID_VALUE.
+ *
+ * @remarks This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa init_hints
+ * @sa glfwInit
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup init
+ */
+ GLFWAPI void glfwInitHint(int hint, int value);
+
+ /*! @brief Sets the init allocator to the desired value.
+ *
+ * To use the default allocator, call this function with a `NULL` argument.
+ *
+ * If you specify an allocator struct, every member must be a valid function
+ * pointer. If any member is `NULL`, this function will emit @ref
+ * GLFW_INVALID_VALUE and the init allocator will be unchanged.
+ *
+ * The functions in the allocator must fulfil a number of requirements. See the
+ * documentation for @ref GLFWallocatefun, @ref GLFWreallocatefun and @ref
+ * GLFWdeallocatefun for details.
+ *
+ * @param[in] allocator The allocator to use at the next initialization, or
+ * `NULL` to use the default one.
+ *
+ * @errors Possible errors include @ref GLFW_INVALID_VALUE.
+ *
+ * @pointer_lifetime The specified allocator is copied before this function
+ * returns.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref init_allocator
+ * @sa @ref glfwInit
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
+ */
+ GLFWAPI void glfwInitAllocator(const GLFWallocator* allocator);
+
#if defined(VK_VERSION_1_0)
-
-/*! @brief Sets the desired Vulkan `vkGetInstanceProcAddr` function.
- *
- * This function sets the `vkGetInstanceProcAddr` function that GLFW will use for all
- * Vulkan related entry point queries.
- *
- * This feature is mostly useful on macOS, if your copy of the Vulkan loader is in
- * a location where GLFW cannot find it through dynamic loading, or if you are still
- * using the static library version of the loader.
- *
- * If set to `NULL`, GLFW will try to load the Vulkan loader dynamically by its standard
- * name and get this function from there. This is the default behavior.
- *
- * The standard name of the loader is `vulkan-1.dll` on Windows, `libvulkan.so.1` on
- * Linux and other Unix-like systems and `libvulkan.1.dylib` on macOS. If your code is
- * also loading it via these names then you probably don't need to use this function.
- *
- * The function address you set is never reset by GLFW, but it only takes effect during
- * initialization. Once GLFW has been initialized, any updates will be ignored until the
- * library is terminated and initialized again.
- *
- * @param[in] loader The address of the function to use, or `NULL`.
- *
- * @par Loader function signature
- * @code
- * PFN_vkVoidFunction vkGetInstanceProcAddr(VkInstance instance, const char* name)
- * @endcode
- * For more information about this function, see the
- * [Vulkan Registry](https://www.khronos.org/registry/vulkan/).
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref vulkan_loader
- * @sa @ref glfwInit
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-GLFWAPI void glfwInitVulkanLoader(PFN_vkGetInstanceProcAddr loader);
-
+
+ /*! @brief Sets the desired Vulkan `vkGetInstanceProcAddr` function.
+ *
+ * This function sets the `vkGetInstanceProcAddr` function that GLFW will use for all
+ * Vulkan related entry point queries.
+ *
+ * This feature is mostly useful on macOS, if your copy of the Vulkan loader is in
+ * a location where GLFW cannot find it through dynamic loading, or if you are still
+ * using the static library version of the loader.
+ *
+ * If set to `NULL`, GLFW will try to load the Vulkan loader dynamically by its standard
+ * name and get this function from there. This is the default behavior.
+ *
+ * The standard name of the loader is `vulkan-1.dll` on Windows, `libvulkan.so.1` on
+ * Linux and other Unix-like systems and `libvulkan.1.dylib` on macOS. If your code is
+ * also loading it via these names then you probably don't need to use this function.
+ *
+ * The function address you set is never reset by GLFW, but it only takes effect during
+ * initialization. Once GLFW has been initialized, any updates will be ignored until the
+ * library is terminated and initialized again.
+ *
+ * @param[in] loader The address of the function to use, or `NULL`.
+ *
+ * @par Loader function signature
+ * @code
+ * PFN_vkVoidFunction vkGetInstanceProcAddr(VkInstance instance, const char* name)
+ * @endcode
+ * For more information about this function, see the
+ * [Vulkan Registry](https://www.khronos.org/registry/vulkan/).
+ *
+ * @errors None.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref vulkan_loader
+ * @sa @ref glfwInit
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
+ */
+ GLFWAPI void glfwInitVulkanLoader(PFN_vkGetInstanceProcAddr loader);
+
#endif /*VK_VERSION_1_0*/
-
-/*! @brief Retrieves the version of the GLFW library.
- *
- * This function retrieves the major, minor and revision numbers of the GLFW
- * library. It is intended for when you are using GLFW as a shared library and
- * want to ensure that you are using the minimum required version.
- *
- * Any or all of the version arguments may be `NULL`.
- *
- * @param[out] major Where to store the major version number, or `NULL`.
- * @param[out] minor Where to store the minor version number, or `NULL`.
- * @param[out] rev Where to store the revision number, or `NULL`.
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref intro_version
- * @sa @ref glfwGetVersionString
- *
- * @since Added in version 1.0.
- *
- * @ingroup init
- */
-GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
-
-/*! @brief Returns a string describing the compile-time configuration.
- *
- * This function returns the compile-time generated
- * [version string](@ref intro_version_string) of the GLFW library binary. It describes
- * the version, platforms, compiler and any platform or operating system specific
- * compile-time options. It should not be confused with the OpenGL or OpenGL ES version
- * string, queried with `glGetString`.
- *
- * __Do not use the version string__ to parse the GLFW library version. The
- * @ref glfwGetVersion function provides the version of the running library
- * binary in numerical format.
- *
- * __Do not use the version string__ to parse what platforms are supported. The @ref
- * glfwPlatformSupported function lets you query platform support.
- *
- * @return The ASCII encoded GLFW version string.
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @pointer_lifetime The returned string is static and compile-time generated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref intro_version
- * @sa @ref glfwGetVersion
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- */
-GLFWAPI const char* glfwGetVersionString(void);
-
-/*! @brief Returns and clears the last error for the calling thread.
- *
- * This function returns and clears the [error code](@ref errors) of the last
- * error that occurred on the calling thread, and optionally a UTF-8 encoded
- * human-readable description of it. If no error has occurred since the last
- * call, it returns @ref GLFW_NO_ERROR (zero) and the description pointer is
- * set to `NULL`.
- *
- * @param[in] description Where to store the error description pointer, or `NULL`.
- * @return The last error code for the calling thread, or @ref GLFW_NO_ERROR
- * (zero).
- *
- * @errors None.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * next error occurs or the library is terminated.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref error_handling
- * @sa @ref glfwSetErrorCallback
- *
- * @since Added in version 3.3.
- *
- * @ingroup init
- */
-GLFWAPI int glfwGetError(const char** description);
-
-/*! @brief Sets the error callback.
- *
- * This function sets the error callback, which is called with an error code
- * and a human-readable description each time a GLFW error occurs.
- *
- * The error code is set before the callback is called. Calling @ref
- * glfwGetError from the error callback will return the same value as the error
- * code argument.
- *
- * The error callback is called on the thread where the error occurred. If you
- * are using GLFW from multiple threads, your error callback needs to be
- * written accordingly.
- *
- * Because the description string may have been generated specifically for that
- * error, it is not guaranteed to be valid after the callback has returned. If
- * you wish to use it after the callback returns, you need to make a copy.
- *
- * Once set, the error callback remains set even after the library has been
- * terminated.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set.
- *
- * @callback_signature
- * @code
- * void callback_name(int error_code, const char* description)
- * @endcode
- * For more information about the callback parameters, see the
- * [callback pointer type](@ref GLFWerrorfun).
- *
- * @errors None.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref error_handling
- * @sa @ref glfwGetError
- *
- * @since Added in version 3.0.
- *
- * @ingroup init
- */
-GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback);
-
-/*! @brief Returns the currently selected platform.
- *
- * This function returns the platform that was selected during initialization. The
- * returned value will be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
- * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
- *
- * @return The currently selected platform, or zero if an error occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref platform
- * @sa @ref glfwPlatformSupported
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-GLFWAPI int glfwGetPlatform(void);
-
-/*! @brief Returns whether the library includes support for the specified platform.
- *
- * This function returns whether the library was compiled with support for the specified
- * platform. The platform must be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
- * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
- *
- * @param[in] platform The platform to query.
- * @return `GLFW_TRUE` if the platform is supported, or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_INVALID_ENUM.
- *
- * @remark This function may be called before @ref glfwInit.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref platform
- * @sa @ref glfwGetPlatform
- *
- * @since Added in version 3.4.
- *
- * @ingroup init
- */
-GLFWAPI int glfwPlatformSupported(int platform);
-
-/*! @brief Returns the currently connected monitors.
- *
- * This function returns an array of handles for all currently connected
- * monitors. The primary monitor is always first in the returned array. If no
- * monitors were found, this function returns `NULL`.
- *
- * @param[out] count Where to store the number of monitors in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of monitor handles, or `NULL` if no monitors were found or
- * if an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * monitor configuration changes or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_monitors
- * @sa @ref monitor_event
- * @sa @ref glfwGetPrimaryMonitor
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
-
-/*! @brief Returns the primary monitor.
- *
- * This function returns the primary monitor. This is usually the monitor
- * where elements like the task bar or global menu bar are located.
- *
- * @return The primary monitor, or `NULL` if no monitors were found or if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @remark The primary monitor is always first in the array returned by @ref
- * glfwGetMonitors.
- *
- * @sa @ref monitor_monitors
- * @sa @ref glfwGetMonitors
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
-
-/*! @brief Returns the position of the monitor's viewport on the virtual screen.
- *
- * This function returns the position, in screen coordinates, of the upper-left
- * corner of the specified monitor.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
- * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
-
-/*! @brief Retrieves the work area of the monitor.
- *
- * This function returns the position, in screen coordinates, of the upper-left
- * corner of the work area of the specified monitor along with the work area
- * size in screen coordinates. The work area is defined as the area of the
- * monitor not occluded by the window system task bar where present. If no
- * task bar exists then the work area is the monitor resolution in screen
- * coordinates.
- *
- * Any or all of the position and size arguments may be `NULL`. If an error
- * occurs, all non-`NULL` position and size arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
- * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
- * @param[out] width Where to store the monitor width, or `NULL`.
- * @param[out] height Where to store the monitor height, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_workarea
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
-
-/*! @brief Returns the physical size of the monitor.
- *
- * This function returns the size, in millimetres, of the display area of the
- * specified monitor.
- *
- * Some platforms do not provide accurate monitor size information, either
- * because the monitor [EDID][] data is incorrect or because the driver does
- * not report it accurately.
- *
- * [EDID]: https://en.wikipedia.org/wiki/Extended_display_identification_data
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] widthMM Where to store the width, in millimetres, of the
- * monitor's display area, or `NULL`.
- * @param[out] heightMM Where to store the height, in millimetres, of the
- * monitor's display area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @win32 On Windows 8 and earlier the physical size is calculated from
- * the current resolution and system DPI instead of querying the monitor EDID data.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
-
-/*! @brief Retrieves the content scale for the specified monitor.
- *
- * This function retrieves the content scale for the specified monitor. The
- * content scale is the ratio between the current DPI and the platform's
- * default DPI. This is especially important for text and any UI elements. If
- * the pixel dimensions of your UI scaled by this look appropriate on your
- * machine then it should appear at a reasonable size on other machines
- * regardless of their DPI and scaling settings. This relies on the system DPI
- * and scaling settings being somewhat correct.
- *
- * The content scale may depend on both the monitor resolution and pixel
- * density and on user settings. It may be very different from the raw DPI
- * calculated from the physical size and current resolution.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
- * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland Fractional scaling information is not yet available for
- * monitors, so this function only returns integer content scales.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_scale
- * @sa @ref glfwGetWindowContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
-
-/*! @brief Returns the name of the specified monitor.
- *
- * This function returns a human-readable name, encoded as UTF-8, of the
- * specified monitor. The name typically reflects the make and model of the
- * monitor and is not guaranteed to be unique among the connected monitors.
- *
- * @param[in] monitor The monitor to query.
- * @return The UTF-8 encoded name of the monitor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_properties
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
-
-/*! @brief Sets the user pointer of the specified monitor.
- *
- * This function sets the user-defined pointer of the specified monitor. The
- * current value is retained until the monitor is disconnected. The initial
- * value is `NULL`.
- *
- * This function may be called from the monitor callback, even for a monitor
- * that is being disconnected.
- *
- * @param[in] monitor The monitor whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref monitor_userptr
- * @sa @ref glfwGetMonitorUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
-
-/*! @brief Returns the user pointer of the specified monitor.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified monitor. The initial value is `NULL`.
- *
- * This function may be called from the monitor callback, even for a monitor
- * that is being disconnected.
- *
- * @param[in] monitor The monitor whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref monitor_userptr
- * @sa @ref glfwSetMonitorUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup monitor
- */
-GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
-
-/*! @brief Sets the monitor configuration callback.
- *
- * This function sets the monitor configuration callback, or removes the
- * currently set callback. This is called when a monitor is connected to or
- * disconnected from the system.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWmonitor* monitor, int event)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWmonitorfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_event
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback);
-
-/*! @brief Returns the available video modes for the specified monitor.
- *
- * This function returns an array of all video modes supported by the specified
- * monitor. The returned array is sorted in ascending order, first by color
- * bit depth (the sum of all channel depths), then by resolution area (the
- * product of width and height), then resolution width and finally by refresh
- * rate.
- *
- * @param[in] monitor The monitor to query.
- * @param[out] count Where to store the number of video modes in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of video modes, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected, this function is called again for that monitor or the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoMode
- *
- * @since Added in version 1.0.
- * @glfw3 Changed to return an array of modes for a specific monitor.
- *
- * @ingroup monitor
- */
-GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
-
-/*! @brief Returns the current mode of the specified monitor.
- *
- * This function returns the current video mode of the specified monitor. If
- * you have created a full screen window for that monitor, the return value
- * will depend on whether that window is iconified.
- *
- * @param[in] monitor The monitor to query.
- * @return The current mode of the monitor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified monitor is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_modes
- * @sa @ref glfwGetVideoModes
- *
- * @since Added in version 3.0. Replaces `glfwGetDesktopMode`.
- *
- * @ingroup monitor
- */
-GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
-
-/*! @brief Generates a gamma ramp and sets it for the specified monitor.
- *
- * This function generates an appropriately sized gamma ramp from the specified
- * exponent and then calls @ref glfwSetGammaRamp with it. The value must be
- * a finite number greater than zero.
- *
- * The software controlled gamma ramp is applied _in addition_ to the hardware
- * gamma correction, which today is usually an approximation of sRGB gamma.
- * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
- * the default (usually sRGB-like) behavior.
- *
- * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
- * GLFW_SRGB_CAPABLE hint.
- *
- * @param[in] monitor The monitor whose gamma ramp to set.
- * @param[in] gamma The desired exponent.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_INVALID_VALUE,
- * @ref GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
-
-/*! @brief Returns the current gamma ramp for the specified monitor.
- *
- * This function returns the current gamma ramp of the specified monitor.
- *
- * @param[in] monitor The monitor to query.
- * @return The current gamma ramp, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
- * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE while
- * returning `NULL`.
- *
- * @pointer_lifetime The returned structure and its arrays are allocated and
- * freed by GLFW. You should not free them yourself. They are valid until the
- * specified monitor is disconnected, this function is called again for that
- * monitor or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
-
-/*! @brief Sets the current gamma ramp for the specified monitor.
- *
- * This function sets the current gamma ramp for the specified monitor. The
- * original gamma ramp for that monitor is saved by GLFW the first time this
- * function is called and is restored by @ref glfwTerminate.
- *
- * The software controlled gamma ramp is applied _in addition_ to the hardware
- * gamma correction, which today is usually an approximation of sRGB gamma.
- * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
- * the default (usually sRGB-like) behavior.
- *
- * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
- * GLFW_SRGB_CAPABLE hint.
- *
- * @param[in] monitor The monitor whose gamma ramp to set.
- * @param[in] ramp The gamma ramp to use.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
- * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark The size of the specified gamma ramp should match the size of the
- * current ramp for that monitor.
- *
- * @remark @win32 The gamma ramp size must be 256.
- *
- * @remark @wayland Gamma handling is a privileged protocol, this function
- * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @pointer_lifetime The specified gamma ramp is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref monitor_gamma
- *
- * @since Added in version 3.0.
- *
- * @ingroup monitor
- */
-GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
-
-/*! @brief Resets all window hints to their default values.
- *
- * This function resets all window hints to their
- * [default values](@ref window_hints_values).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHint
- * @sa @ref glfwWindowHintString
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwDefaultWindowHints(void);
-
-/*! @brief Sets the specified window hint to the desired value.
- *
- * This function sets hints for the next call to @ref glfwCreateWindow. The
- * hints, once set, retain their values until changed by a call to this
- * function or @ref glfwDefaultWindowHints, or until the library is terminated.
- *
- * Only integer value hints can be set with this function. String value hints
- * are set with @ref glfwWindowHintString.
- *
- * This function does not check whether the specified hint values are valid.
- * If you set hints to invalid values this will instead be reported by the next
- * call to @ref glfwCreateWindow.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [window hint](@ref window_hints) to set.
- * @param[in] value The new value of the window hint.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHintString
- * @sa @ref glfwDefaultWindowHints
- *
- * @since Added in version 3.0. Replaces `glfwOpenWindowHint`.
- *
- * @ingroup window
- */
-GLFWAPI void glfwWindowHint(int hint, int value);
-
-/*! @brief Sets the specified window hint to the desired value.
- *
- * This function sets hints for the next call to @ref glfwCreateWindow. The
- * hints, once set, retain their values until changed by a call to this
- * function or @ref glfwDefaultWindowHints, or until the library is terminated.
- *
- * Only string type hints can be set with this function. Integer value hints
- * are set with @ref glfwWindowHint.
- *
- * This function does not check whether the specified hint values are valid.
- * If you set hints to invalid values this will instead be reported by the next
- * call to @ref glfwCreateWindow.
- *
- * Some hints are platform specific. These may be set on any platform but they
- * will only affect their specific platform. Other platforms will ignore them.
- * Setting these hints requires no platform specific headers or functions.
- *
- * @param[in] hint The [window hint](@ref window_hints) to set.
- * @param[in] value The new value of the window hint.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @pointer_lifetime The specified string is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hints
- * @sa @ref glfwWindowHint
- * @sa @ref glfwDefaultWindowHints
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI void glfwWindowHintString(int hint, const char* value);
-
-/*! @brief Creates a window and its associated context.
- *
- * This function creates a window and its associated OpenGL or OpenGL ES
- * context. Most of the options controlling how the window and its context
- * should be created are specified with [window hints](@ref window_hints).
- *
- * Successful creation does not change which context is current. Before you
- * can use the newly created context, you need to
- * [make it current](@ref context_current). For information about the `share`
- * parameter, see @ref context_sharing.
- *
- * The created window, framebuffer and context may differ from what you
- * requested, as not all parameters and hints are
- * [hard constraints](@ref window_hints_hard). This includes the size of the
- * window, especially for full screen windows. To query the actual attributes
- * of the created window, framebuffer and context, see @ref
- * glfwGetWindowAttrib, @ref glfwGetWindowSize and @ref glfwGetFramebufferSize.
- *
- * To create a full screen window, you need to specify the monitor the window
- * will cover. If no monitor is specified, the window will be windowed mode.
- * Unless you have a way for the user to choose a specific monitor, it is
- * recommended that you pick the primary monitor. For more information on how
- * to query connected monitors, see @ref monitor_monitors.
- *
- * For full screen windows, the specified size becomes the resolution of the
- * window's _desired video mode_. As long as a full screen window is not
- * iconified, the supported video mode most closely matching the desired video
- * mode is set for the specified monitor. For more information about full
- * screen windows, including the creation of so called _windowed full screen_
- * or _borderless full screen_ windows, see @ref window_windowed_full_screen.
- *
- * Once you have created the window, you can switch it between windowed and
- * full screen mode with @ref glfwSetWindowMonitor. This will not affect its
- * OpenGL or OpenGL ES context.
- *
- * By default, newly created windows use the placement recommended by the
- * window system. To create the window at a specific position, set the @ref
- * GLFW_POSITION_X and @ref GLFW_POSITION_Y window hints before creation. To
- * restore the default behavior, set either or both hints back to
- * `GLFW_ANY_POSITION`.
- *
- * As long as at least one full screen window is not iconified, the screensaver
- * is prohibited from starting.
- *
- * Window systems put limits on window sizes. Very large or very small window
- * dimensions may be overridden by the window system on creation. Check the
- * actual [size](@ref window_size) after creation.
- *
- * The [swap interval](@ref buffer_swap) is not set during window creation and
- * the initial value may vary depending on driver settings and defaults.
- *
- * @param[in] width The desired width, in screen coordinates, of the window.
- * This must be greater than zero.
- * @param[in] height The desired height, in screen coordinates, of the window.
- * This must be greater than zero.
- * @param[in] title The initial, UTF-8 encoded window title.
- * @param[in] monitor The monitor to use for full screen mode, or `NULL` for
- * windowed mode.
- * @param[in] share The window whose context to share resources with, or `NULL`
- * to not share resources.
- * @return The handle of the created window, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_API_UNAVAILABLE, @ref
- * GLFW_VERSION_UNAVAILABLE, @ref GLFW_FORMAT_UNAVAILABLE, @ref
- * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark @win32 Window creation will fail if the Microsoft GDI software
- * OpenGL implementation is the only one available.
- *
- * @remark @win32 If the executable has an icon resource named `GLFW_ICON,` it
- * will be set as the initial icon for the window. If no such icon is present,
- * the `IDI_APPLICATION` icon will be used instead. To set a different icon,
- * see @ref glfwSetWindowIcon.
- *
- * @remark @win32 The context to share resources with must not be current on
- * any other thread.
- *
- * @remark @macos The OS only supports core profile contexts for OpenGL
- * versions 3.2 and later. Before creating an OpenGL context of version 3.2 or
- * later you must set the [GLFW_OPENGL_PROFILE](@ref GLFW_OPENGL_PROFILE_hint)
- * hint accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all
- * on macOS.
- *
- * @remark @macos The GLFW window has no icon, as it is not a document
- * window, but the dock icon will be the same as the application bundle's icon.
- * For more information on bundles, see the
- * [Bundle Programming Guide][bundle-guide] in the Mac Developer Library.
- *
- * [bundle-guide]: https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/
- *
- * @remark @macos The window frame will not be rendered at full resolution on
- * Retina displays unless the
- * [GLFW_SCALE_FRAMEBUFFER](@ref GLFW_SCALE_FRAMEBUFFER_hint)
- * hint is `GLFW_TRUE` and the `NSHighResolutionCapable` key is enabled in the
- * application bundle's `Info.plist`. For more information, see
- * [High Resolution Guidelines for OS X][hidpi-guide] in the Mac Developer
- * Library. The GLFW test and example programs use a custom `Info.plist`
- * template for this, which can be found as `CMake/Info.plist.in` in the source
- * tree.
- *
- * [hidpi-guide]: https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html
- *
- * @remark @macos When activating frame autosaving with
- * [GLFW_COCOA_FRAME_NAME](@ref GLFW_COCOA_FRAME_NAME_hint), the specified
- * window size and position may be overridden by previously saved values.
- *
- * @remark @wayland GLFW uses [libdecor][] where available to create its window
- * decorations. This in turn uses server-side XDG decorations where available
- * and provides high quality client-side decorations on compositors like GNOME.
- * If both XDG decorations and libdecor are unavailable, GLFW falls back to
- * a very simple set of window decorations that only support moving, resizing
- * and the window manager's right-click menu.
- *
- * [libdecor]: https://gitlab.freedesktop.org/libdecor/libdecor
- *
- * @remark @x11 Some window managers will not respect the placement of
- * initially hidden windows.
- *
- * @remark @x11 Due to the asynchronous nature of X11, it may take a moment for
- * a window to reach its requested state. This means you may not be able to
- * query the final size, position or other attributes directly after window
- * creation.
- *
- * @remark @x11 The class part of the `WM_CLASS` window property will by
- * default be set to the window title passed to this function. The instance
- * part will use the contents of the `RESOURCE_NAME` environment variable, if
- * present and not empty, or fall back to the window title. Set the
- * [GLFW_X11_CLASS_NAME](@ref GLFW_X11_CLASS_NAME_hint) and
- * [GLFW_X11_INSTANCE_NAME](@ref GLFW_X11_INSTANCE_NAME_hint) window hints to
- * override this.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_creation
- * @sa @ref glfwDestroyWindow
- *
- * @since Added in version 3.0. Replaces `glfwOpenWindow`.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
-
-/*! @brief Destroys the specified window and its context.
- *
- * This function destroys the specified window and its context. On calling
- * this function, no further callbacks will be called for that window.
- *
- * If the context of the specified window is current on the main thread, it is
- * detached before being destroyed.
- *
- * @param[in] window The window to destroy.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @note The context of the specified window must not be current on any other
- * thread when this function is called.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_creation
- * @sa @ref glfwCreateWindow
- *
- * @since Added in version 3.0. Replaces `glfwCloseWindow`.
- *
- * @ingroup window
- */
-GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
-
-/*! @brief Checks the close flag of the specified window.
- *
- * This function returns the value of the close flag of the specified window.
- *
- * @param[in] window The window to query.
- * @return The value of the close flag.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_close
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
-
-/*! @brief Sets the close flag of the specified window.
- *
- * This function sets the value of the close flag of the specified window.
- * This can be used to override the user's attempt to close the window, or
- * to signal that it should be closed.
- *
- * @param[in] window The window whose flag to change.
- * @param[in] value The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_close
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
-
-/*! @brief Returns the title of the specified window.
- *
- * This function returns the window title, encoded as UTF-8, of the specified
- * window. This is the title set previously by @ref glfwCreateWindow
- * or @ref glfwSetWindowTitle.
- *
- * @param[in] window The window to query.
- * @return The UTF-8 encoded window title, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark The returned title is currently a copy of the title last set by @ref
- * glfwCreateWindow or @ref glfwSetWindowTitle. It does not include any
- * additional text which may be appended by the platform or another program.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the next call to @ref
- * glfwGetWindowTitle or @ref glfwSetWindowTitle, or until the library is
- * terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_title
- * @sa @ref glfwSetWindowTitle
- *
- * @since Added in version 3.4.
- *
- * @ingroup window
- */
-GLFWAPI const char* glfwGetWindowTitle(GLFWwindow* window);
-
-/*! @brief Sets the title of the specified window.
- *
- * This function sets the window title, encoded as UTF-8, of the specified
- * window.
- *
- * @param[in] window The window whose title to change.
- * @param[in] title The UTF-8 encoded window title.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos The window title will not be updated until the next time you
- * process events.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_title
- * @sa @ref glfwGetWindowTitle
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
-
-/*! @brief Sets the icon for the specified window.
- *
- * This function sets the icon of the specified window. If passed an array of
- * candidate images, those of or closest to the sizes desired by the system are
- * selected. If no images are specified, the window reverts to its default
- * icon.
- *
- * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
- * bits per channel with the red channel first. They are arranged canonically
- * as packed sequential rows, starting from the top-left corner.
- *
- * The desired image sizes varies depending on platform and system settings.
- * The selected images will be rescaled as needed. Good sizes include 16x16,
- * 32x32 and 48x48.
- *
- * @param[in] window The window whose icon to set.
- * @param[in] count The number of images in the specified array, or zero to
- * revert to the default window icon.
- * @param[in] images The images to create the icon from. This is ignored if
- * count is zero.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @pointer_lifetime The specified image data is copied before this function
- * returns.
- *
- * @remark @macos Regular windows do not have icons on macOS. This function
- * will emit @ref GLFW_FEATURE_UNAVAILABLE. The dock icon will be the same as
- * the application bundle's icon. For more information on bundles, see the
- * [Bundle Programming Guide][bundle-guide] in the Mac Developer Library.
- *
- * [bundle-guide]: https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/
- *
- * @remark @wayland There is no existing protocol to change an icon, the
- * window will thus inherit the one defined in the application's desktop file.
- * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_icon
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);
-
-/*! @brief Retrieves the position of the content area of the specified window.
- *
- * This function retrieves the position, in screen coordinates, of the
- * upper-left corner of the content area of the specified window.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] window The window to query.
- * @param[out] xpos Where to store the x-coordinate of the upper-left corner of
- * the content area, or `NULL`.
- * @param[out] ypos Where to store the y-coordinate of the upper-left corner of
- * the content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way for an application to retrieve the global
- * position of its windows. This function will emit @ref
- * GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- * @sa @ref glfwSetWindowPos
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
-
-/*! @brief Sets the position of the content area of the specified window.
- *
- * This function sets the position, in screen coordinates, of the upper-left
- * corner of the content area of the specified windowed mode window. If the
- * window is a full screen window, this function does nothing.
- *
- * __Do not use this function__ to move an already visible window unless you
- * have very good reasons for doing so, as it will confuse and annoy the user.
- *
- * The window manager may put limits on what positions are allowed. GLFW
- * cannot and should not override these limits.
- *
- * @param[in] window The window to query.
- * @param[in] xpos The x-coordinate of the upper-left corner of the content area.
- * @param[in] ypos The y-coordinate of the upper-left corner of the content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way for an application to set the global
- * position of its windows. This function will emit @ref
- * GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- * @sa @ref glfwGetWindowPos
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
-
-/*! @brief Retrieves the size of the content area of the specified window.
- *
- * This function retrieves the size, in screen coordinates, of the content area
- * of the specified window. If you wish to retrieve the size of the
- * framebuffer of the window in pixels, see @ref glfwGetFramebufferSize.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose size to retrieve.
- * @param[out] width Where to store the width, in screen coordinates, of the
- * content area, or `NULL`.
- * @param[out] height Where to store the height, in screen coordinates, of the
- * content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- * @sa @ref glfwSetWindowSize
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
-
-/*! @brief Sets the size limits of the specified window.
- *
- * This function sets the size limits of the content area of the specified
- * window. If the window is full screen, the size limits only take effect
- * once it is made windowed. If the window is not resizable, this function
- * does nothing.
- *
- * The size limits are applied immediately to a windowed mode window and may
- * cause it to be resized.
- *
- * The maximum dimensions must be greater than or equal to the minimum
- * dimensions and all must be greater than or equal to zero.
- *
- * @param[in] window The window to set limits for.
- * @param[in] minwidth The minimum width, in screen coordinates, of the content
- * area, or `GLFW_DONT_CARE`.
- * @param[in] minheight The minimum height, in screen coordinates, of the
- * content area, or `GLFW_DONT_CARE`.
- * @param[in] maxwidth The maximum width, in screen coordinates, of the content
- * area, or `GLFW_DONT_CARE`.
- * @param[in] maxheight The maximum height, in screen coordinates, of the
- * content area, or `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark If you set size limits and an aspect ratio that conflict, the
- * results are undefined.
- *
- * @remark @wayland The size limits will not be applied until the window is
- * actually resized, either by the user or by the compositor.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_sizelimits
- * @sa @ref glfwSetWindowAspectRatio
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);
-
-/*! @brief Sets the aspect ratio of the specified window.
- *
- * This function sets the required aspect ratio of the content area of the
- * specified window. If the window is full screen, the aspect ratio only takes
- * effect once it is made windowed. If the window is not resizable, this
- * function does nothing.
- *
- * The aspect ratio is specified as a numerator and a denominator and both
- * values must be greater than zero. For example, the common 16:9 aspect ratio
- * is specified as 16 and 9, respectively.
- *
- * If the numerator and denominator is set to `GLFW_DONT_CARE` then the aspect
- * ratio limit is disabled.
- *
- * The aspect ratio is applied immediately to a windowed mode window and may
- * cause it to be resized.
- *
- * @param[in] window The window to set limits for.
- * @param[in] numer The numerator of the desired aspect ratio, or
- * `GLFW_DONT_CARE`.
- * @param[in] denom The denominator of the desired aspect ratio, or
- * `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark If you set size limits and an aspect ratio that conflict, the
- * results are undefined.
- *
- * @remark @wayland The aspect ratio will not be applied until the window is
- * actually resized, either by the user or by the compositor.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_sizelimits
- * @sa @ref glfwSetWindowSizeLimits
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);
-
-/*! @brief Sets the size of the content area of the specified window.
- *
- * This function sets the size, in screen coordinates, of the content area of
- * the specified window.
- *
- * For full screen windows, this function updates the resolution of its desired
- * video mode and switches to the video mode closest to it, without affecting
- * the window's context. As the context is unaffected, the bit depths of the
- * framebuffer remain unchanged.
- *
- * If you wish to update the refresh rate of the desired video mode in addition
- * to its resolution, see @ref glfwSetWindowMonitor.
- *
- * The window manager may put limits on what sizes are allowed. GLFW cannot
- * and should not override these limits.
- *
- * @param[in] window The window to resize.
- * @param[in] width The desired width, in screen coordinates, of the window
- * content area.
- * @param[in] height The desired height, in screen coordinates, of the window
- * content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- * @sa @ref glfwGetWindowSize
- * @sa @ref glfwSetWindowMonitor
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
-
-/*! @brief Retrieves the size of the framebuffer of the specified window.
- *
- * This function retrieves the size, in pixels, of the framebuffer of the
- * specified window. If you wish to retrieve the size of the window in screen
- * coordinates, see @ref glfwGetWindowSize.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose framebuffer to query.
- * @param[out] width Where to store the width, in pixels, of the framebuffer,
- * or `NULL`.
- * @param[out] height Where to store the height, in pixels, of the framebuffer,
- * or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_fbsize
- * @sa @ref glfwSetFramebufferSizeCallback
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
-
-/*! @brief Retrieves the size of the frame of the window.
- *
- * This function retrieves the size, in screen coordinates, of each edge of the
- * frame of the specified window. This size includes the title bar, if the
- * window has one. The size of the frame may vary depending on the
- * [window-related hints](@ref window_hints_wnd) used to create it.
- *
- * Because this function retrieves the size of each window frame edge and not
- * the offset along a particular coordinate axis, the retrieved values will
- * always be zero or positive.
- *
- * Any or all of the size arguments may be `NULL`. If an error occurs, all
- * non-`NULL` size arguments will be set to zero.
- *
- * @param[in] window The window whose frame size to query.
- * @param[out] left Where to store the size, in screen coordinates, of the left
- * edge of the window frame, or `NULL`.
- * @param[out] top Where to store the size, in screen coordinates, of the top
- * edge of the window frame, or `NULL`.
- * @param[out] right Where to store the size, in screen coordinates, of the
- * right edge of the window frame, or `NULL`.
- * @param[out] bottom Where to store the size, in screen coordinates, of the
- * bottom edge of the window frame, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- *
- * @since Added in version 3.1.
- *
- * @ingroup window
- */
-GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
-
-/*! @brief Retrieves the content scale for the specified window.
- *
- * This function retrieves the content scale for the specified window. The
- * content scale is the ratio between the current DPI and the platform's
- * default DPI. This is especially important for text and any UI elements. If
- * the pixel dimensions of your UI scaled by this look appropriate on your
- * machine then it should appear at a reasonable size on other machines
- * regardless of their DPI and scaling settings. This relies on the system DPI
- * and scaling settings being somewhat correct.
- *
- * On platforms where each monitors can have its own content scale, the window
- * content scale will depend on which monitor the system considers the window
- * to be on.
- *
- * @param[in] window The window to query.
- * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
- * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_scale
- * @sa @ref glfwSetWindowContentScaleCallback
- * @sa @ref glfwGetMonitorContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);
-
-/*! @brief Returns the opacity of the whole window.
- *
- * This function returns the opacity of the window, including any decorations.
- *
- * The opacity (or alpha) value is a positive finite number between zero and
- * one, where zero is fully transparent and one is fully opaque. If the system
- * does not support whole window transparency, this function always returns one.
- *
- * The initial opacity value for newly created windows is one.
- *
- * @param[in] window The window to query.
- * @return The opacity value of the specified window.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_transparency
- * @sa @ref glfwSetWindowOpacity
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);
-
-/*! @brief Sets the opacity of the whole window.
- *
- * This function sets the opacity of the window, including any decorations.
- *
- * The opacity (or alpha) value is a positive finite number between zero and
- * one, where zero is fully transparent and one is fully opaque.
- *
- * The initial opacity value for newly created windows is one.
- *
- * A window created with framebuffer transparency may not use whole window
- * transparency. The results of doing this are undefined.
- *
- * @param[in] window The window to set the opacity for.
- * @param[in] opacity The desired opacity of the specified window.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland There is no way to set an opacity factor for a window.
- * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_transparency
- * @sa @ref glfwGetWindowOpacity
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
-
-/*! @brief Iconifies the specified window.
- *
- * This function iconifies (minimizes) the specified window if it was
- * previously restored. If the window is already iconified, this function does
- * nothing.
- *
- * If the specified window is a full screen window, GLFW restores the original
- * video mode of the monitor. The window's desired video mode is set again
- * when the window is restored.
- *
- * @param[in] window The window to iconify.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland Once a window is iconified, @ref glfwRestoreWindow won’t
- * be able to restore it. This is a design decision of the xdg-shell
- * protocol.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwRestoreWindow
- * @sa @ref glfwMaximizeWindow
- *
- * @since Added in version 2.1.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
-
-/*! @brief Restores the specified window.
- *
- * This function restores the specified window if it was previously iconified
- * (minimized) or maximized. If the window is already restored, this function
- * does nothing.
- *
- * If the specified window is an iconified full screen window, its desired
- * video mode is set again for its monitor when the window is restored.
- *
- * @param[in] window The window to restore.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwIconifyWindow
- * @sa @ref glfwMaximizeWindow
- *
- * @since Added in version 2.1.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
-
-/*! @brief Maximizes the specified window.
- *
- * This function maximizes the specified window if it was previously not
- * maximized. If the window is already maximized, this function does nothing.
- *
- * If the specified window is a full screen window, this function does nothing.
- *
- * @param[in] window The window to maximize.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @par Thread Safety
- * This function may only be called from the main thread.
- *
- * @sa @ref window_iconify
- * @sa @ref glfwIconifyWindow
- * @sa @ref glfwRestoreWindow
- *
- * @since Added in GLFW 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);
-
-/*! @brief Makes the specified window visible.
- *
- * This function makes the specified window visible if it was previously
- * hidden. If the window is already visible or is in full screen mode, this
- * function does nothing.
- *
- * By default, windowed mode windows are focused when shown
- * Set the [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) window hint
- * to change this behavior for all newly created windows, or change the
- * behavior for an existing window with @ref glfwSetWindowAttrib.
- *
- * @param[in] window The window to make visible.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland Because Wayland wants every frame of the desktop to be
- * complete, this function does not immediately make the window visible.
- * Instead it will become visible the next time the window framebuffer is
- * updated after this call.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hide
- * @sa @ref glfwHideWindow
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwShowWindow(GLFWwindow* window);
-
-/*! @brief Hides the specified window.
- *
- * This function hides the specified window if it was previously visible. If
- * the window is already hidden or is in full screen mode, this function does
- * nothing.
- *
- * @param[in] window The window to hide.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_hide
- * @sa @ref glfwShowWindow
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwHideWindow(GLFWwindow* window);
-
-/*! @brief Brings the specified window to front and sets input focus.
- *
- * This function brings the specified window to front and sets input focus.
- * The window should already be visible and not iconified.
- *
- * By default, both windowed and full screen mode windows are focused when
- * initially created. Set the [GLFW_FOCUSED](@ref GLFW_FOCUSED_hint) to
- * disable this behavior.
- *
- * Also by default, windowed mode windows are focused when shown
- * with @ref glfwShowWindow. Set the
- * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) to disable this behavior.
- *
- * __Do not use this function__ to steal focus from other applications unless
- * you are certain that is what the user wants. Focus stealing can be
- * extremely disruptive.
- *
- * For a less disruptive way of getting the user's attention, see
- * [attention requests](@ref window_attention).
- *
- * @param[in] window The window to give input focus.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @wayland The compositor will likely ignore focus requests unless
- * another window created by the same application already has input focus.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_focus
- * @sa @ref window_attention
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwFocusWindow(GLFWwindow* window);
-
-/*! @brief Requests user attention to the specified window.
- *
- * This function requests user attention to the specified window. On
- * platforms where this is not supported, attention is requested to the
- * application as a whole.
- *
- * Once the user has given attention, usually by focusing the window or
- * application, the system will end the request automatically.
- *
- * @param[in] window The window to request attention to.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @macos Attention is requested to the application as a whole, not the
- * specific window.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attention
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);
-
-/*! @brief Returns the monitor that the window uses for full screen mode.
- *
- * This function returns the handle of the monitor that the specified window is
- * in full screen on.
- *
- * @param[in] window The window to query.
- * @return The monitor, or `NULL` if the window is in windowed mode or an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_monitor
- * @sa @ref glfwSetWindowMonitor
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
-
-/*! @brief Sets the mode, monitor, video mode and placement of a window.
- *
- * This function sets the monitor that the window uses for full screen mode or,
- * if the monitor is `NULL`, makes it windowed mode.
- *
- * When setting a monitor, this function updates the width, height and refresh
- * rate of the desired video mode and switches to the video mode closest to it.
- * The window position is ignored when setting a monitor.
- *
- * When the monitor is `NULL`, the position, width and height are used to
- * place the window content area. The refresh rate is ignored when no monitor
- * is specified.
- *
- * If you only wish to update the resolution of a full screen window or the
- * size of a windowed mode window, see @ref glfwSetWindowSize.
- *
- * When a window transitions from full screen to windowed mode, this function
- * restores any previous window settings such as whether it is decorated,
- * floating, resizable, has size or aspect ratio limits, etc.
- *
- * @param[in] window The window whose monitor, size or video mode to set.
- * @param[in] monitor The desired monitor, or `NULL` to set windowed mode.
- * @param[in] xpos The desired x-coordinate of the upper-left corner of the
- * content area.
- * @param[in] ypos The desired y-coordinate of the upper-left corner of the
- * content area.
- * @param[in] width The desired with, in screen coordinates, of the content
- * area or video mode.
- * @param[in] height The desired height, in screen coordinates, of the content
- * area or video mode.
- * @param[in] refreshRate The desired refresh rate, in Hz, of the video mode,
- * or `GLFW_DONT_CARE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark The OpenGL or OpenGL ES context will not be destroyed or otherwise
- * affected by any resizing or mode switching, although you may need to update
- * your viewport if the framebuffer size has changed.
- *
- * @remark @wayland The desired window position is ignored, as there is no way
- * for an application to set this property.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_monitor
- * @sa @ref window_full_screen
- * @sa @ref glfwGetWindowMonitor
- * @sa @ref glfwSetWindowSize
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);
-
-/*! @brief Returns an attribute of the specified window.
- *
- * This function returns the value of an attribute of the specified window or
- * its OpenGL or OpenGL ES context.
- *
- * @param[in] window The window to query.
- * @param[in] attrib The [window attribute](@ref window_attribs) whose value to
- * return.
- * @return The value of the attribute, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark Framebuffer related hints are not window attributes. See @ref
- * window_attribs_fb for more information.
- *
- * @remark Zero is a valid value for many window and context related
- * attributes so you cannot use a return value of zero as an indication of
- * errors. However, this function should not fail as long as it is passed
- * valid arguments and the library has been [initialized](@ref intro_init).
- *
- * @remark @wayland The Wayland protocol provides no way to check whether a
- * window is iconfied, so @ref GLFW_ICONIFIED always returns `GLFW_FALSE`.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attribs
- * @sa @ref glfwSetWindowAttrib
- *
- * @since Added in version 3.0. Replaces `glfwGetWindowParam` and
- * `glfwGetGLVersion`.
- *
- * @ingroup window
- */
-GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
-
-/*! @brief Sets an attribute of the specified window.
- *
- * This function sets the value of an attribute of the specified window.
- *
- * The supported attributes are [GLFW_DECORATED](@ref GLFW_DECORATED_attrib),
- * [GLFW_RESIZABLE](@ref GLFW_RESIZABLE_attrib),
- * [GLFW_FLOATING](@ref GLFW_FLOATING_attrib),
- * [GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_attrib) and
- * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_attrib).
- * [GLFW_MOUSE_PASSTHROUGH](@ref GLFW_MOUSE_PASSTHROUGH_attrib)
- *
- * Some of these attributes are ignored for full screen windows. The new
- * value will take effect if the window is later made windowed.
- *
- * Some of these attributes are ignored for windowed mode windows. The new
- * value will take effect if the window is later made full screen.
- *
- * @param[in] window The window to set the attribute for.
- * @param[in] attrib A supported window attribute.
- * @param[in] value `GLFW_TRUE` or `GLFW_FALSE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark Calling @ref glfwGetWindowAttrib will always return the latest
- * value, even if that value is ignored by the current mode of the window.
- *
- * @remark @wayland The [GLFW_FLOATING](@ref GLFW_FLOATING_attrib) window attribute is
- * not supported. Setting this will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_attribs
- * @sa @ref glfwGetWindowAttrib
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);
-
-/*! @brief Sets the user pointer of the specified window.
- *
- * This function sets the user-defined pointer of the specified window. The
- * current value is retained until the window is destroyed. The initial value
- * is `NULL`.
- *
- * @param[in] window The window whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_userptr
- * @sa @ref glfwGetWindowUserPointer
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
-
-/*! @brief Returns the user pointer of the specified window.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified window. The initial value is `NULL`.
- *
- * @param[in] window The window whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref window_userptr
- * @sa @ref glfwSetWindowUserPointer
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
-
-/*! @brief Sets the position callback for the specified window.
- *
- * This function sets the position callback of the specified window, which is
- * called when the window is moved. The callback is provided with the
- * position, in screen coordinates, of the upper-left corner of the content
- * area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int xpos, int ypos)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowposfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @wayland This callback will never be called, as there is no way for
- * an application to know its global position.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_pos
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun callback);
-
-/*! @brief Sets the size callback for the specified window.
- *
- * This function sets the size callback of the specified window, which is
- * called when the window is resized. The callback is provided with the size,
- * in screen coordinates, of the content area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowsizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_size
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun callback);
-
-/*! @brief Sets the close callback for the specified window.
- *
- * This function sets the close callback of the specified window, which is
- * called when the user attempts to close the window, for example by clicking
- * the close widget in the title bar.
- *
- * The close flag is set before this callback is called, but you can modify it
- * at any time with @ref glfwSetWindowShouldClose.
- *
- * The close callback is not triggered by @ref glfwDestroyWindow.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowclosefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @remark @macos Selecting Quit from the application menu will trigger the
- * close callback for all windows.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_close
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);
-
-/*! @brief Sets the refresh callback for the specified window.
- *
- * This function sets the refresh callback of the specified window, which is
- * called when the content area of the window needs to be redrawn, for example
- * if the window has been exposed after having been covered by another window.
- *
- * On compositing window systems such as Aero, Compiz, Aqua or Wayland, where
- * the window contents are saved off-screen, this callback may be called only
- * very infrequently or never at all.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window);
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowrefreshfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_refresh
- *
- * @since Added in version 2.5.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);
-
-/*! @brief Sets the focus callback for the specified window.
- *
- * This function sets the focus callback of the specified window, which is
- * called when the window gains or loses input focus.
- *
- * After the focus callback is called for a window that lost input focus,
- * synthetic key and mouse button release events will be generated for all such
- * that had been pressed. For more information, see @ref glfwSetKeyCallback
- * and @ref glfwSetMouseButtonCallback.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int focused)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowfocusfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_focus
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);
-
-/*! @brief Sets the iconify callback for the specified window.
- *
- * This function sets the iconification callback of the specified window, which
- * is called when the window is iconified or restored.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int iconified)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowiconifyfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_iconify
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);
-
-/*! @brief Sets the maximize callback for the specified window.
- *
- * This function sets the maximization callback of the specified window, which
- * is called when the window is maximized or restored.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int maximized)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowmaximizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_maximize
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);
-
-/*! @brief Sets the framebuffer resize callback for the specified window.
- *
- * This function sets the framebuffer resize callback of the specified window,
- * which is called when the framebuffer of the specified window is resized.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int width, int height)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWframebuffersizefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_fbsize
- *
- * @since Added in version 3.0.
- *
- * @ingroup window
- */
-GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);
-
-/*! @brief Sets the window content scale callback for the specified window.
- *
- * This function sets the window content scale callback of the specified window,
- * which is called when the content scale of the specified window changes.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, float xscale, float yscale)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWwindowcontentscalefun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref window_scale
- * @sa @ref glfwGetWindowContentScale
- *
- * @since Added in version 3.3.
- *
- * @ingroup window
- */
-GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);
-
-/*! @brief Processes all pending events.
- *
- * This function processes only those events that are already in the event
- * queue and then returns immediately. Processing events will cause the window
- * and input callbacks associated with those events to be called.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwWaitEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 1.0.
- *
- * @ingroup window
- */
-GLFWAPI void glfwPollEvents(void);
-
-/*! @brief Waits until events are queued and processes them.
- *
- * This function puts the calling thread to sleep until at least one event is
- * available in the event queue. Once one or more events are available,
- * it behaves exactly like @ref glfwPollEvents, i.e. the events in the queue
- * are processed and the function then returns immediately. Processing events
- * will cause the window and input callbacks associated with those events to be
- * called.
- *
- * Since not all events are associated with callbacks, this function may return
- * without a callback having been called even if you are monitoring all
- * callbacks.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwPollEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 2.5.
- *
- * @ingroup window
- */
-GLFWAPI void glfwWaitEvents(void);
-
-/*! @brief Waits with timeout until events are queued and processes them.
- *
- * This function puts the calling thread to sleep until at least one event is
- * available in the event queue, or until the specified timeout is reached. If
- * one or more events are available, it behaves exactly like @ref
- * glfwPollEvents, i.e. the events in the queue are processed and the function
- * then returns immediately. Processing events will cause the window and input
- * callbacks associated with those events to be called.
- *
- * The timeout value must be a positive finite number.
- *
- * Since not all events are associated with callbacks, this function may return
- * without a callback having been called even if you are monitoring all
- * callbacks.
- *
- * On some platforms, a window move, resize or menu operation will cause event
- * processing to block. This is due to how event processing is designed on
- * those platforms. You can use the
- * [window refresh callback](@ref window_refresh) to redraw the contents of
- * your window when necessary during such operations.
- *
- * Do not assume that callbacks you set will _only_ be called in response to
- * event processing functions like this one. While it is necessary to poll for
- * events, window systems that require GLFW to register callbacks of its own
- * can pass events to GLFW in response to many window system function calls.
- * GLFW will pass those events on to the application callbacks before
- * returning.
- *
- * Event processing is not required for joystick input to work.
- *
- * @param[in] timeout The maximum amount of time, in seconds, to wait.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref events
- * @sa @ref glfwPollEvents
- * @sa @ref glfwWaitEvents
- *
- * @since Added in version 3.2.
- *
- * @ingroup window
- */
-GLFWAPI void glfwWaitEventsTimeout(double timeout);
-
-/*! @brief Posts an empty event to the event queue.
- *
- * This function posts an empty event from the current thread to the event
- * queue, causing @ref glfwWaitEvents or @ref glfwWaitEventsTimeout to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref events
- * @sa @ref glfwWaitEvents
- * @sa @ref glfwWaitEventsTimeout
- *
- * @since Added in version 3.1.
- *
- * @ingroup window
- */
-GLFWAPI void glfwPostEmptyEvent(void);
-
-/*! @brief Returns the value of an input option for the specified window.
- *
- * This function returns the value of an input option for the specified window.
- * The mode must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
- * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS or
- * @ref GLFW_RAW_MOUSE_MOTION.
- *
- * @param[in] window The window to query.
- * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
- * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
- * `GLFW_RAW_MOUSE_MOTION`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref glfwSetInputMode
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
-
-/*! @brief Sets an input option for the specified window.
- *
- * This function sets an input mode option for the specified window. The mode
- * must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
- * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS
- * @ref GLFW_RAW_MOUSE_MOTION, or @ref GLFW_UNLIMITED_MOUSE_BUTTONS.
- *
- * If the mode is `GLFW_CURSOR`, the value must be one of the following cursor
- * modes:
- * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
- * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the
- * content area of the window but does not restrict the cursor from leaving.
- * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual
- * and unlimited cursor movement. This is useful for implementing for
- * example 3D camera controls.
- * - `GLFW_CURSOR_CAPTURED` makes the cursor visible and confines it to the
- * content area of the window.
- *
- * If the mode is `GLFW_STICKY_KEYS`, the value must be either `GLFW_TRUE` to
- * enable sticky keys, or `GLFW_FALSE` to disable it. If sticky keys are
- * enabled, a key press will ensure that @ref glfwGetKey returns `GLFW_PRESS`
- * the next time it is called even if the key had been released before the
- * call. This is useful when you are only interested in whether keys have been
- * pressed but not when or in which order.
- *
- * If the mode is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either
- * `GLFW_TRUE` to enable sticky mouse buttons, or `GLFW_FALSE` to disable it.
- * If sticky mouse buttons are enabled, a mouse button press will ensure that
- * @ref glfwGetMouseButton returns `GLFW_PRESS` the next time it is called even
- * if the mouse button had been released before the call. This is useful when
- * you are only interested in whether mouse buttons have been pressed but not
- * when or in which order.
- *
- * If the mode is `GLFW_LOCK_KEY_MODS`, the value must be either `GLFW_TRUE` to
- * enable lock key modifier bits, or `GLFW_FALSE` to disable them. If enabled,
- * callbacks that receive modifier bits will also have the @ref
- * GLFW_MOD_CAPS_LOCK bit set when the event was generated with Caps Lock on,
- * and the @ref GLFW_MOD_NUM_LOCK bit when Num Lock was on.
- *
- * If the mode is `GLFW_RAW_MOUSE_MOTION`, the value must be either `GLFW_TRUE`
- * to enable raw (unscaled and unaccelerated) mouse motion when the cursor is
- * disabled, or `GLFW_FALSE` to disable it. If raw motion is not supported,
- * attempting to set this will emit @ref GLFW_FEATURE_UNAVAILABLE. Call @ref
- * glfwRawMouseMotionSupported to check for support.
- *
- * If the mode is `GLFW_UNLIMITED_MOUSE_BUTTONS`, the value must be either
- * `GLFW_TRUE` to disable the mouse button limit when calling the mouse button
- * callback, or `GLFW_FALSE` to limit the mouse buttons sent to the callback
- * to the mouse button token values up to `GLFW_MOUSE_BUTTON_LAST`.
- *
- * @param[in] window The window whose input mode to set.
- * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
- * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
- * `GLFW_RAW_MOUSE_MOTION`.
- * @param[in] value The new value of the specified input mode.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_PLATFORM_ERROR and @ref
- * GLFW_FEATURE_UNAVAILABLE (see above).
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref glfwGetInputMode
- *
- * @since Added in version 3.0. Replaces `glfwEnable` and `glfwDisable`.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
-
-/*! @brief Returns whether raw mouse motion is supported.
- *
- * This function returns whether raw mouse motion is supported on the current
- * system. This status does not change after GLFW has been initialized so you
- * only need to check this once. If you attempt to enable raw motion on
- * a system that does not support it, @ref GLFW_PLATFORM_ERROR will be emitted.
- *
- * Raw mouse motion is closer to the actual motion of the mouse across
- * a surface. It is not affected by the scaling and acceleration applied to
- * the motion of the desktop cursor. That processing is suitable for a cursor
- * while raw motion is better for controlling for example a 3D camera. Because
- * of this, raw mouse motion is only provided when the cursor is disabled.
- *
- * @return `GLFW_TRUE` if raw mouse motion is supported on the current machine,
- * or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref raw_mouse_motion
- * @sa @ref glfwSetInputMode
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI int glfwRawMouseMotionSupported(void);
-
-/*! @brief Returns the layout-specific name of the specified printable key.
- *
- * This function returns the name of the specified printable key, encoded as
- * UTF-8. This is typically the character that key would produce without any
- * modifier keys, intended for displaying key bindings to the user. For dead
- * keys, it is typically the diacritic it would add to a character.
- *
- * __Do not use this function__ for [text input](@ref input_char). You will
- * break text input for many languages even if it happens to work for yours.
- *
- * If the key is `GLFW_KEY_UNKNOWN`, the scancode is used to identify the key,
- * otherwise the scancode is ignored. If you specify a non-printable key, or
- * `GLFW_KEY_UNKNOWN` and a scancode that maps to a non-printable key, this
- * function returns `NULL` but does not emit an error.
- *
- * This behavior allows you to always pass in the arguments in the
- * [key callback](@ref input_key) without modification.
- *
- * The printable keys are:
- * - `GLFW_KEY_APOSTROPHE`
- * - `GLFW_KEY_COMMA`
- * - `GLFW_KEY_MINUS`
- * - `GLFW_KEY_PERIOD`
- * - `GLFW_KEY_SLASH`
- * - `GLFW_KEY_SEMICOLON`
- * - `GLFW_KEY_EQUAL`
- * - `GLFW_KEY_LEFT_BRACKET`
- * - `GLFW_KEY_RIGHT_BRACKET`
- * - `GLFW_KEY_BACKSLASH`
- * - `GLFW_KEY_WORLD_1`
- * - `GLFW_KEY_WORLD_2`
- * - `GLFW_KEY_0` to `GLFW_KEY_9`
- * - `GLFW_KEY_A` to `GLFW_KEY_Z`
- * - `GLFW_KEY_KP_0` to `GLFW_KEY_KP_9`
- * - `GLFW_KEY_KP_DECIMAL`
- * - `GLFW_KEY_KP_DIVIDE`
- * - `GLFW_KEY_KP_MULTIPLY`
- * - `GLFW_KEY_KP_SUBTRACT`
- * - `GLFW_KEY_KP_ADD`
- * - `GLFW_KEY_KP_EQUAL`
- *
- * Names for printable keys depend on keyboard layout, while names for
- * non-printable keys are the same across layouts but depend on the application
- * language and should be localized along with other user interface text.
- *
- * @param[in] key The key to query, or `GLFW_KEY_UNKNOWN`.
- * @param[in] scancode The scancode of the key to query.
- * @return The UTF-8 encoded, layout-specific name of the key, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE, @ref GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark The contents of the returned string may change when a keyboard
- * layout change event is received.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key_name
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- */
-GLFWAPI const char* glfwGetKeyName(int key, int scancode);
-
-/*! @brief Returns the platform-specific scancode of the specified key.
- *
- * This function returns the platform-specific scancode of the specified key.
- *
- * If the specified [key token](@ref keys) corresponds to a physical key not
- * supported on the current platform then this method will return `-1`.
- * Calling this function with anything other than a key token will return `-1`
- * and generate a @ref GLFW_INVALID_ENUM error.
- *
- * @param[in] key Any [key token](@ref keys).
- * @return The platform-specific scancode for the key, or `-1` if the key is
- * not supported on the current platform or an [error](@ref error_handling)
- * occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI int glfwGetKeyScancode(int key);
-
-/*! @brief Returns the last reported state of a keyboard key for the specified
- * window.
- *
- * This function returns the last state reported for the specified key to the
- * specified window. The returned state is one of `GLFW_PRESS` or
- * `GLFW_RELEASE`. The action `GLFW_REPEAT` is only reported to the key callback.
- *
- * If the @ref GLFW_STICKY_KEYS input mode is enabled, this function returns
- * `GLFW_PRESS` the first time you call it for a key that was pressed, even if
- * that key has already been released.
- *
- * The key functions deal with physical keys, with [key tokens](@ref keys)
- * named after their use on the standard US keyboard layout. If you want to
- * input text, use the Unicode character callback instead.
- *
- * The [modifier key bit masks](@ref mods) are not key tokens and cannot be
- * used with this function.
- *
- * __Do not use this function__ to implement [text input](@ref input_char).
- *
- * @param[in] window The desired window.
- * @param[in] key The desired [keyboard key](@ref keys). `GLFW_KEY_UNKNOWN` is
- * not a valid key for this function.
- * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- */
-GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
-
-/*! @brief Returns the last reported state of a mouse button for the specified
- * window.
- *
- * This function returns the last state reported for the specified mouse button
- * to the specified window. The returned state is one of `GLFW_PRESS` or
- * `GLFW_RELEASE`.
- *
- * If the @ref GLFW_STICKY_MOUSE_BUTTONS input mode is enabled, this function
- * returns `GLFW_PRESS` the first time you call it for a mouse button that was
- * pressed, even if that mouse button has already been released.
- *
- * The @ref GLFW_UNLIMITED_MOUSE_BUTTONS input mode does not effect the
- * limit on buttons which can be polled with this function.
- *
- * @param[in] window The desired window.
- * @param[in] button The desired [mouse button token](@ref buttons).
- * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_mouse_button
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup input
- */
-GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
-
-/*! @brief Retrieves the position of the cursor relative to the content area of
- * the window.
- *
- * This function returns the position of the cursor, in screen coordinates,
- * relative to the upper-left corner of the content area of the specified
- * window.
- *
- * If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor
- * position is unbounded and limited only by the minimum and maximum values of
- * a `double`.
- *
- * The coordinate can be converted to their integer equivalents with the
- * `floor` function. Casting directly to an integer type works for positive
- * coordinates, but fails for negative ones.
- *
- * Any or all of the position arguments may be `NULL`. If an error occurs, all
- * non-`NULL` position arguments will be set to zero.
- *
- * @param[in] window The desired window.
- * @param[out] xpos Where to store the cursor x-coordinate, relative to the
- * left edge of the content area, or `NULL`.
- * @param[out] ypos Where to store the cursor y-coordinate, relative to the to
- * top edge of the content area, or `NULL`.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwSetCursorPos
- *
- * @since Added in version 3.0. Replaces `glfwGetMousePos`.
- *
- * @ingroup input
- */
-GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
-
-/*! @brief Sets the position of the cursor, relative to the content area of the
- * window.
- *
- * This function sets the position, in screen coordinates, of the cursor
- * relative to the upper-left corner of the content area of the specified
- * window. The window must have input focus. If the window does not have
- * input focus when this function is called, it fails silently.
- *
- * __Do not use this function__ to implement things like camera controls. GLFW
- * already provides the `GLFW_CURSOR_DISABLED` cursor mode that hides the
- * cursor, transparently re-centers it and provides unconstrained cursor
- * motion. See @ref glfwSetInputMode for more information.
- *
- * If the cursor mode is `GLFW_CURSOR_DISABLED` then the cursor position is
- * unconstrained and limited only by the minimum and maximum values of
- * a `double`.
- *
- * @param[in] window The desired window.
- * @param[in] xpos The desired x-coordinate, relative to the left edge of the
- * content area.
- * @param[in] ypos The desired y-coordinate, relative to the top edge of the
- * content area.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
- *
- * @remark @wayland This function will only work when the cursor mode is
- * `GLFW_CURSOR_DISABLED`, otherwise it will emit @ref GLFW_FEATURE_UNAVAILABLE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- * @sa @ref glfwGetCursorPos
- *
- * @since Added in version 3.0. Replaces `glfwSetMousePos`.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
-
-/*! @brief Creates a custom cursor.
- *
- * Creates a new custom cursor image that can be set for a window with @ref
- * glfwSetCursor. The cursor can be destroyed with @ref glfwDestroyCursor.
- * Any remaining cursors are destroyed by @ref glfwTerminate.
- *
- * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
- * bits per channel with the red channel first. They are arranged canonically
- * as packed sequential rows, starting from the top-left corner.
- *
- * The cursor hotspot is specified in pixels, relative to the upper-left corner
- * of the cursor image. Like all other coordinate systems in GLFW, the X-axis
- * points to the right and the Y-axis points down.
- *
- * @param[in] image The desired cursor image.
- * @param[in] xhot The desired x-coordinate, in pixels, of the cursor hotspot.
- * @param[in] yhot The desired y-coordinate, in pixels, of the cursor hotspot.
- * @return The handle of the created cursor, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The specified image data is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- * @sa @ref glfwDestroyCursor
- * @sa @ref glfwCreateStandardCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
-
-/*! @brief Creates a cursor with a standard shape.
- *
- * Returns a cursor with a standard shape, that can be set for a window with
- * @ref glfwSetCursor. The images for these cursors come from the system
- * cursor theme and their exact appearance will vary between platforms.
- *
- * Most of these shapes are guaranteed to exist on every supported platform but
- * a few may not be present. See the table below for details.
- *
- * Cursor shape | Windows | macOS | X11 | Wayland
- * ------------------------------ | ------- | ----- | ------ | -------
- * @ref GLFW_ARROW_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_IBEAM_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_CROSSHAIR_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_POINTING_HAND_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_EW_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_NS_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_RESIZE_NWSE_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- * @ref GLFW_RESIZE_NESW_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- * @ref GLFW_RESIZE_ALL_CURSOR | Yes | Yes | Yes | Yes
- * @ref GLFW_NOT_ALLOWED_CURSOR | Yes | Yes | Maybe<sup>2</sup> | Maybe<sup>2</sup>
- *
- * 1) This uses a private system API and may fail in the future.
- *
- * 2) This uses a newer standard that not all cursor themes support.
- *
- * If the requested shape is not available, this function emits a @ref
- * GLFW_CURSOR_UNAVAILABLE error and returns `NULL`.
- *
- * @param[in] shape One of the [standard shapes](@ref shapes).
- * @return A new cursor ready to use or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM, @ref GLFW_CURSOR_UNAVAILABLE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_standard
- * @sa @ref glfwCreateCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
-
-/*! @brief Destroys a cursor.
- *
- * This function destroys a cursor previously created with @ref
- * glfwCreateCursor. Any remaining cursors will be destroyed by @ref
- * glfwTerminate.
- *
- * If the specified cursor is current for any window, that window will be
- * reverted to the default cursor. This does not affect the cursor mode.
- *
- * @param[in] cursor The cursor object to destroy.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @reentrancy This function must not be called from a callback.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- * @sa @ref glfwCreateCursor
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
-
-/*! @brief Sets the cursor for the window.
- *
- * This function sets the cursor image to be used when the cursor is over the
- * content area of the specified window. The set cursor will only be visible
- * when the [cursor mode](@ref cursor_mode) of the window is
- * `GLFW_CURSOR_NORMAL`.
- *
- * On some platforms, the set cursor may not be visible unless the window also
- * has input focus.
- *
- * @param[in] window The window to set the cursor for.
- * @param[in] cursor The cursor to set, or `NULL` to switch back to the default
- * arrow cursor.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_object
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
-
-/*! @brief Sets the key callback.
- *
- * This function sets the key callback of the specified window, which is called
- * when a key is pressed, repeated or released.
- *
- * The key functions deal with physical keys, with layout independent
- * [key tokens](@ref keys) named after their values in the standard US keyboard
- * layout. If you want to input text, use the
- * [character callback](@ref glfwSetCharCallback) instead.
- *
- * When a window loses input focus, it will generate synthetic key release
- * events for all pressed keys with associated key tokens. You can tell these
- * events from user-generated events by the fact that the synthetic ones are
- * generated after the focus loss event has been processed, i.e. after the
- * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
- *
- * The scancode of a key is specific to that platform or sometimes even to that
- * machine. Scancodes are intended to allow users to bind keys that don't have
- * a GLFW key token. Such keys have `key` set to `GLFW_KEY_UNKNOWN`, their
- * state is not saved and so it cannot be queried with @ref glfwGetKey.
- *
- * Sometimes GLFW needs to generate synthetic key events, in which case the
- * scancode may be zero.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new key callback, or `NULL` to remove the currently
- * set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWkeyfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_key
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- */
-GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);
-
-/*! @brief Sets the Unicode character callback.
- *
- * This function sets the character callback of the specified window, which is
- * called when a Unicode character is input.
- *
- * The character callback is intended for Unicode text input. As it deals with
- * characters, it is keyboard layout dependent, whereas the
- * [key callback](@ref glfwSetKeyCallback) is not. Characters do not map 1:1
- * to physical keys, as a key may produce zero, one or more characters. If you
- * want to know whether a specific physical key was pressed or released, see
- * the key callback instead.
- *
- * The character callback behaves as system text input normally does and will
- * not be called if modifier keys are held down that would prevent normal text
- * input on that platform, for example a Super (Command) key on macOS or Alt key
- * on Windows.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcharfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_char
- *
- * @since Added in version 2.4.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);
-
-/*! @brief Sets the Unicode character with modifiers callback.
- *
- * This function sets the character with modifiers callback of the specified
- * window, which is called when a Unicode character is input regardless of what
- * modifier keys are used.
- *
- * The character with modifiers callback is intended for implementing custom
- * Unicode character input. For regular Unicode text input, see the
- * [character callback](@ref glfwSetCharCallback). Like the character
- * callback, the character with modifiers callback deals with characters and is
- * keyboard layout dependent. Characters do not map 1:1 to physical keys, as
- * a key may produce zero, one or more characters. If you want to know whether
- * a specific physical key was pressed or released, see the
- * [key callback](@ref glfwSetKeyCallback) instead.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or an
- * [error](@ref error_handling) occurred.
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcharmodsfun).
- *
- * @deprecated Scheduled for removal in version 4.0.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_char
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun callback);
-
-/*! @brief Sets the mouse button callback.
- *
- * This function sets the mouse button callback of the specified window, which
- * is called when a mouse button is pressed or released.
- *
- * When a window loses input focus, it will generate synthetic mouse button
- * release events for all pressed mouse buttons with associated button tokens.
- * You can tell these events from user-generated events by the fact that the
- * synthetic ones are generated after the focus loss event has been processed,
- * i.e. after the [window focus callback](@ref glfwSetWindowFocusCallback) has
- * been called.
- *
- * The reported `button` value can be higher than `GLFW_MOUSE_BUTTON_LAST` if
- * the button does not have an associated [button token](@ref buttons) and the
- * @ref GLFW_UNLIMITED_MOUSE_BUTTONS input mode is set.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int button, int action, int mods)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWmousebuttonfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref input_mouse_button
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter and return value.
- *
- * @ingroup input
- */
-GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun callback);
-
-/*! @brief Sets the cursor position callback.
- *
- * This function sets the cursor position callback of the specified window,
- * which is called when the cursor is moved. The callback is provided with the
- * position, in screen coordinates, relative to the upper-left corner of the
- * content area of the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, double xpos, double ypos);
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcursorposfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_pos
- *
- * @since Added in version 3.0. Replaces `glfwSetMousePosCallback`.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun callback);
-
-/*! @brief Sets the cursor enter/leave callback.
- *
- * This function sets the cursor boundary crossing callback of the specified
- * window, which is called when the cursor enters or leaves the content area of
- * the window.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int entered)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWcursorenterfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref cursor_enter
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun callback);
-
-/*! @brief Sets the scroll callback.
- *
- * This function sets the scroll callback of the specified window, which is
- * called when a scrolling device is used, such as a mouse wheel or scrolling
- * area of a touchpad.
- *
- * The scroll callback receives all scrolling input, like that from a mouse
- * wheel or a touchpad scrolling area.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new scroll callback, or `NULL` to remove the
- * currently set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, double xoffset, double yoffset)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWscrollfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref scrolling
- *
- * @since Added in version 3.0. Replaces `glfwSetMouseWheelCallback`.
- *
- * @ingroup input
- */
-GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);
-
-/*! @brief Sets the path drop callback.
- *
- * This function sets the path drop callback of the specified window, which is
- * called when one or more dragged paths are dropped on the window.
- *
- * Because the path array and its strings may have been generated specifically
- * for that event, they are not guaranteed to be valid after the callback has
- * returned. If you wish to use them after the callback returns, you need to
- * make a deep copy.
- *
- * @param[in] window The window whose callback to set.
- * @param[in] callback The new file drop callback, or `NULL` to remove the
- * currently set callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(GLFWwindow* window, int path_count, const char* paths[])
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWdropfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref path_drop
- *
- * @since Added in version 3.1.
- *
- * @ingroup input
- */
-GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);
-
-/*! @brief Returns whether the specified joystick is present.
- *
- * This function returns whether the specified joystick is present.
- *
- * There is no need to call this function before other functions that accept
- * a joystick ID, as they all check for presence before performing any other
- * work.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return `GLFW_TRUE` if the joystick is present, or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick
- *
- * @since Added in version 3.0. Replaces `glfwGetJoystickParam`.
- *
- * @ingroup input
- */
-GLFWAPI int glfwJoystickPresent(int jid);
-
-/*! @brief Returns the values of all axes of the specified joystick.
- *
- * This function returns the values of all axes of the specified joystick.
- * Each element in the array is a value between -1.0 and 1.0.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of axis values in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of axis values, or `NULL` if the joystick is not present or
- * an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_axis
- *
- * @since Added in version 3.0. Replaces `glfwGetJoystickPos`.
- *
- * @ingroup input
- */
-GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);
-
-/*! @brief Returns the state of all buttons of the specified joystick.
- *
- * This function returns the state of all buttons of the specified joystick.
- * Each element in the array is either `GLFW_PRESS` or `GLFW_RELEASE`.
- *
- * For backward compatibility with earlier versions that did not have @ref
- * glfwGetJoystickHats, the button array also includes all hats, each
- * represented as four buttons. The hats are in the same order as returned by
- * __glfwGetJoystickHats__ and are in the order _up_, _right_, _down_ and
- * _left_. To disable these extra buttons, set the @ref
- * GLFW_JOYSTICK_HAT_BUTTONS init hint before initialization.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of button states in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of button states, or `NULL` if the joystick is not present
- * or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_button
- *
- * @since Added in version 2.2.
- * @glfw3 Changed to return a dynamic array.
- *
- * @ingroup input
- */
-GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);
-
-/*! @brief Returns the state of all hats of the specified joystick.
- *
- * This function returns the state of all hats of the specified joystick.
- * Each element in the array is one of the following values:
- *
- * Name | Value
- * ---- | -----
- * `GLFW_HAT_CENTERED` | 0
- * `GLFW_HAT_UP` | 1
- * `GLFW_HAT_RIGHT` | 2
- * `GLFW_HAT_DOWN` | 4
- * `GLFW_HAT_LEFT` | 8
- * `GLFW_HAT_RIGHT_UP` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_UP`
- * `GLFW_HAT_RIGHT_DOWN` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_DOWN`
- * `GLFW_HAT_LEFT_UP` | `GLFW_HAT_LEFT` \| `GLFW_HAT_UP`
- * `GLFW_HAT_LEFT_DOWN` | `GLFW_HAT_LEFT` \| `GLFW_HAT_DOWN`
- *
- * The diagonal directions are bitwise combinations of the primary (up, right,
- * down and left) directions and you can test for these individually by ANDing
- * it with the corresponding direction.
- *
- * @code
- * if (hats[2] & GLFW_HAT_RIGHT)
- * {
- * // State of hat 2 could be right-up, right or right-down
- * }
- * @endcode
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] count Where to store the number of hat states in the returned
- * array. This is set to zero if the joystick is not present or an error
- * occurred.
- * @return An array of hat states, or `NULL` if the joystick is not present
- * or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected, this function is called again for that joystick or the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_hat
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);
-
-/*! @brief Returns the name of the specified joystick.
- *
- * This function returns the name, encoded as UTF-8, of the specified joystick.
- * The returned string is allocated and freed by GLFW. You should not free it
- * yourself.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick
- * is not present or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_name
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-GLFWAPI const char* glfwGetJoystickName(int jid);
-
-/*! @brief Returns the SDL compatible GUID of the specified joystick.
- *
- * This function returns the SDL compatible GUID, as a UTF-8 encoded
- * hexadecimal string, of the specified joystick. The returned string is
- * allocated and freed by GLFW. You should not free it yourself.
- *
- * The GUID is what connects a joystick to a gamepad mapping. A connected
- * joystick will always have a GUID even if there is no gamepad mapping
- * assigned to it.
- *
- * If the specified joystick is not present this function will return `NULL`
- * but will not generate an error. This can be used instead of first calling
- * @ref glfwJoystickPresent.
- *
- * The GUID uses the format introduced in SDL 2.0.5. This GUID tries to
- * uniquely identify the make and model of a joystick but does not identify
- * a specific unit, e.g. all wired Xbox 360 controllers will have the same
- * GUID on that platform. The GUID for a unit may vary between platforms
- * depending on what hardware information the platform specific APIs provide.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded GUID of the joystick, or `NULL` if the joystick
- * is not present or an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI const char* glfwGetJoystickGUID(int jid);
-
-/*! @brief Sets the user pointer of the specified joystick.
- *
- * This function sets the user-defined pointer of the specified joystick. The
- * current value is retained until the joystick is disconnected. The initial
- * value is `NULL`.
- *
- * This function may be called from the joystick callback, even for a joystick
- * that is being disconnected.
- *
- * @param[in] jid The joystick whose pointer to set.
- * @param[in] pointer The new value.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref joystick_userptr
- * @sa @ref glfwGetJoystickUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);
-
-/*! @brief Returns the user pointer of the specified joystick.
- *
- * This function returns the current value of the user-defined pointer of the
- * specified joystick. The initial value is `NULL`.
- *
- * This function may be called from the joystick callback, even for a joystick
- * that is being disconnected.
- *
- * @param[in] jid The joystick whose pointer to return.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Access is not
- * synchronized.
- *
- * @sa @ref joystick_userptr
- * @sa @ref glfwSetJoystickUserPointer
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI void* glfwGetJoystickUserPointer(int jid);
-
-/*! @brief Returns whether the specified joystick has a gamepad mapping.
- *
- * This function returns whether the specified joystick is both present and has
- * a gamepad mapping.
- *
- * If the specified joystick is present but does not have a gamepad mapping
- * this function will return `GLFW_FALSE` but will not generate an error. Call
- * @ref glfwJoystickPresent to check if a joystick is present regardless of
- * whether it has a mapping.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return `GLFW_TRUE` if a joystick is both present and has a gamepad mapping,
- * or `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwGetGamepadState
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI int glfwJoystickIsGamepad(int jid);
-
-/*! @brief Sets the joystick configuration callback.
- *
- * This function sets the joystick configuration callback, or removes the
- * currently set callback. This is called when a joystick is connected to or
- * disconnected from the system.
- *
- * For joystick connection and disconnection events to be delivered on all
- * platforms, you need to call one of the [event processing](@ref events)
- * functions. Joystick disconnection may also be detected and the callback
- * called by joystick functions. The function will then return whatever it
- * returns if the joystick is not present.
- *
- * @param[in] callback The new callback, or `NULL` to remove the currently set
- * callback.
- * @return The previously set callback, or `NULL` if no callback was set or the
- * library had not been [initialized](@ref intro_init).
- *
- * @callback_signature
- * @code
- * void function_name(int jid, int event)
- * @endcode
- * For more information about the callback parameters, see the
- * [function pointer type](@ref GLFWjoystickfun).
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref joystick_event
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- */
-GLFWAPI GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback);
-
-/*! @brief Adds the specified SDL_GameControllerDB gamepad mappings.
- *
- * This function parses the specified ASCII encoded string and updates the
- * internal list with any gamepad mappings it finds. This string may
- * contain either a single gamepad mapping or many mappings separated by
- * newlines. The parser supports the full format of the `gamecontrollerdb.txt`
- * source file including empty lines and comments.
- *
- * See @ref gamepad_mapping for a description of the format.
- *
- * If there is already a gamepad mapping for a given GUID in the internal list,
- * it will be replaced by the one passed to this function. If the library is
- * terminated and re-initialized the internal list will revert to the built-in
- * default.
- *
- * @param[in] string The string containing the gamepad mappings.
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_VALUE.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwJoystickIsGamepad
- * @sa @ref glfwGetGamepadName
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI int glfwUpdateGamepadMappings(const char* string);
-
-/*! @brief Returns the human-readable gamepad name for the specified joystick.
- *
- * This function returns the human-readable name of the gamepad from the
- * gamepad mapping assigned to the specified joystick.
- *
- * If the specified joystick is not present or does not have a gamepad mapping
- * this function will return `NULL` but will not generate an error. Call
- * @ref glfwJoystickPresent to check whether it is present regardless of
- * whether it has a mapping.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @return The UTF-8 encoded name of the gamepad, or `NULL` if the
- * joystick is not present, does not have a mapping or an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref GLFW_INVALID_ENUM.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the specified joystick is
- * disconnected, the gamepad mappings are updated or the library is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwJoystickIsGamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI const char* glfwGetGamepadName(int jid);
-
-/*! @brief Retrieves the state of the specified joystick remapped as a gamepad.
- *
- * This function retrieves the state of the specified joystick remapped to
- * an Xbox-like gamepad.
- *
- * If the specified joystick is not present or does not have a gamepad mapping
- * this function will return `GLFW_FALSE` but will not generate an error. Call
- * @ref glfwJoystickPresent to check whether it is present regardless of
- * whether it has a mapping.
- *
- * The Guide button may not be available for input as it is often hooked by the
- * system or the Steam client.
- *
- * Not all devices have all the buttons or axes provided by @ref
- * GLFWgamepadstate. Unavailable buttons and axes will always report
- * `GLFW_RELEASE` and 0.0 respectively.
- *
- * @param[in] jid The [joystick](@ref joysticks) to query.
- * @param[out] state The gamepad input state of the joystick.
- * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if no joystick is
- * connected, it has no gamepad mapping or an [error](@ref error_handling)
- * occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_ENUM.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref gamepad
- * @sa @ref glfwUpdateGamepadMappings
- * @sa @ref glfwJoystickIsGamepad
- *
- * @since Added in version 3.3.
- *
- * @ingroup input
- */
-GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);
-
-/*! @brief Sets the clipboard to the specified string.
- *
- * This function sets the system clipboard to the specified, UTF-8 encoded
- * string.
- *
- * @param[in] window Deprecated. Any valid window or `NULL`.
- * @param[in] string A UTF-8 encoded string.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @remark @win32 The clipboard on Windows has a single global lock for reading and
- * writing. GLFW tries to acquire it a few times, which is almost always enough. If it
- * cannot acquire the lock then this function emits @ref GLFW_PLATFORM_ERROR and returns.
- * It is safe to try this multiple times.
- *
- * @pointer_lifetime The specified string is copied before this function
- * returns.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref clipboard
- * @sa @ref glfwGetClipboardString
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
-
-/*! @brief Returns the contents of the clipboard as a string.
- *
- * This function returns the contents of the system clipboard, if it contains
- * or is convertible to a UTF-8 encoded string. If the clipboard is empty or
- * if its contents cannot be converted, `NULL` is returned and a @ref
- * GLFW_FORMAT_UNAVAILABLE error is generated.
- *
- * @param[in] window Deprecated. Any valid window or `NULL`.
- * @return The contents of the clipboard as a UTF-8 encoded string, or `NULL`
- * if an [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_FORMAT_UNAVAILABLE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark @win32 The clipboard on Windows has a single global lock for reading and
- * writing. GLFW tries to acquire it a few times, which is almost always enough. If it
- * cannot acquire the lock then this function emits @ref GLFW_PLATFORM_ERROR and returns.
- * It is safe to try this multiple times.
- *
- * @pointer_lifetime The returned string is allocated and freed by GLFW. You
- * should not free it yourself. It is valid until the next call to @ref
- * glfwGetClipboardString or @ref glfwSetClipboardString, or until the library
- * is terminated.
- *
- * @thread_safety This function must only be called from the main thread.
- *
- * @sa @ref clipboard
- * @sa @ref glfwSetClipboardString
- *
- * @since Added in version 3.0.
- *
- * @ingroup input
- */
-GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
-
-/*! @brief Returns the GLFW time.
- *
- * This function returns the current GLFW time, in seconds. Unless the time
- * has been set using @ref glfwSetTime it measures time elapsed since GLFW was
- * initialized.
- *
- * This function and @ref glfwSetTime are helper functions on top of @ref
- * glfwGetTimerFrequency and @ref glfwGetTimerValue.
- *
- * The resolution of the timer is system dependent, but is usually on the order
- * of a few micro- or nanoseconds. It uses the highest-resolution monotonic
- * time source on each operating system.
- *
- * @return The current time, in seconds, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread. Reading and
- * writing of the internal base time is not atomic, so it needs to be
- * externally synchronized with calls to @ref glfwSetTime.
- *
- * @sa @ref time
- *
- * @since Added in version 1.0.
- *
- * @ingroup input
- */
-GLFWAPI double glfwGetTime(void);
-
-/*! @brief Sets the GLFW time.
- *
- * This function sets the current GLFW time, in seconds. The value must be
- * a positive finite number less than or equal to 18446744073.0, which is
- * approximately 584.5 years.
- *
- * This function and @ref glfwGetTime are helper functions on top of @ref
- * glfwGetTimerFrequency and @ref glfwGetTimerValue.
- *
- * @param[in] time The new value, in seconds.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_INVALID_VALUE.
- *
- * @remark The upper limit of GLFW time is calculated as
- * floor((2<sup>64</sup> - 1) / 10<sup>9</sup>) and is due to implementations
- * storing nanoseconds in 64 bits. The limit may be increased in the future.
- *
- * @thread_safety This function may be called from any thread. Reading and
- * writing of the internal base time is not atomic, so it needs to be
- * externally synchronized with calls to @ref glfwGetTime.
- *
- * @sa @ref time
- *
- * @since Added in version 2.2.
- *
- * @ingroup input
- */
-GLFWAPI void glfwSetTime(double time);
-
-/*! @brief Returns the current value of the raw timer.
- *
- * This function returns the current value of the raw timer, measured in
- * 1&nbsp;/&nbsp;frequency seconds. To get the frequency, call @ref
- * glfwGetTimerFrequency.
- *
- * @return The value of the timer, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref time
- * @sa @ref glfwGetTimerFrequency
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- */
-GLFWAPI uint64_t glfwGetTimerValue(void);
-
-/*! @brief Returns the frequency, in Hz, of the raw timer.
- *
- * This function returns the frequency, in Hz, of the raw timer.
- *
- * @return The frequency of the timer, in Hz, or zero if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref time
- * @sa @ref glfwGetTimerValue
- *
- * @since Added in version 3.2.
- *
- * @ingroup input
- */
-GLFWAPI uint64_t glfwGetTimerFrequency(void);
-
-/*! @brief Makes the context of the specified window current for the calling
- * thread.
- *
- * This function makes the OpenGL or OpenGL ES context of the specified window
- * current on the calling thread. It can also detach the current context from
- * the calling thread without making a new one current by passing in `NULL`.
- *
- * A context must only be made current on a single thread at a time and each
- * thread can have only a single current context at a time. Making a context
- * current detaches any previously current context on the calling thread.
- *
- * When moving a context between threads, you must detach it (make it
- * non-current) on the old thread before making it current on the new one.
- *
- * By default, making a context non-current implicitly forces a pipeline flush.
- * On machines that support `GL_KHR_context_flush_control`, you can control
- * whether a context performs this flush by setting the
- * [GLFW_CONTEXT_RELEASE_BEHAVIOR](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint)
- * hint.
- *
- * The specified window must have an OpenGL or OpenGL ES context. Specifying
- * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
- * error.
- *
- * @param[in] window The window whose context to make current, or `NULL` to
- * detach the current context.
- *
- * @remarks If the previously current context was created via a different
- * context creation API than the one passed to this function, GLFW will still
- * detach the previous one from its API before making the new one current.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_current
- * @sa @ref glfwGetCurrentContext
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- */
-GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
-
-/*! @brief Returns the window whose context is current on the calling thread.
- *
- * This function returns the window whose OpenGL or OpenGL ES context is
- * current on the calling thread.
- *
- * @return The window whose context is current, or `NULL` if no window's
- * context is current.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_current
- * @sa @ref glfwMakeContextCurrent
- *
- * @since Added in version 3.0.
- *
- * @ingroup context
- */
-GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
-
-/*! @brief Swaps the front and back buffers of the specified window.
- *
- * This function swaps the front and back buffers of the specified window when
- * rendering with OpenGL or OpenGL ES. If the swap interval is greater than
- * zero, the GPU driver waits the specified number of screen updates before
- * swapping the buffers.
- *
- * The specified window must have an OpenGL or OpenGL ES context. Specifying
- * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
- * error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see `vkQueuePresentKHR` instead.
- *
- * @param[in] window The window whose buffers to swap.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark __EGL:__ The context of the specified window must be current on the
- * calling thread.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref buffer_swap
- * @sa @ref glfwSwapInterval
- *
- * @since Added in version 1.0.
- * @glfw3 Added window handle parameter.
- *
- * @ingroup window
- */
-GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
-
-/*! @brief Sets the swap interval for the current context.
- *
- * This function sets the swap interval for the current OpenGL or OpenGL ES
- * context, i.e. the number of screen updates to wait from the time @ref
- * glfwSwapBuffers was called before swapping the buffers and returning. This
- * is sometimes called _vertical synchronization_, _vertical retrace
- * synchronization_ or just _vsync_.
- *
- * A context that supports either of the `WGL_EXT_swap_control_tear` and
- * `GLX_EXT_swap_control_tear` extensions also accepts _negative_ swap
- * intervals, which allows the driver to swap immediately even if a frame
- * arrives a little bit late. You can check for these extensions with @ref
- * glfwExtensionSupported.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see the present mode of your swapchain instead.
- *
- * @param[in] interval The minimum number of screen updates to wait for
- * until the buffers are swapped by @ref glfwSwapBuffers.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark This function is not called during context creation, leaving the
- * swap interval set to whatever is the default for that API. This is done
- * because some swap interval extensions used by GLFW do not allow the swap
- * interval to be reset to zero once it has been set to a non-zero value.
- *
- * @remark Some GPU drivers do not honor the requested swap interval, either
- * because of a user setting that overrides the application's request or due to
- * bugs in the driver.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref buffer_swap
- * @sa @ref glfwSwapBuffers
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- */
-GLFWAPI void glfwSwapInterval(int interval);
-
-/*! @brief Returns whether the specified extension is available.
- *
- * This function returns whether the specified
- * [API extension](@ref context_glext) is supported by the current OpenGL or
- * OpenGL ES context. It searches both for client API extension and context
- * creation API extensions.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * As this functions retrieves and searches one or more extension strings each
- * call, it is recommended that you cache its results if it is going to be used
- * frequently. The extension strings will not change during the lifetime of
- * a context, so there is no danger in doing this.
- *
- * This function does not apply to Vulkan. If you are using Vulkan, see @ref
- * glfwGetRequiredInstanceExtensions, `vkEnumerateInstanceExtensionProperties`
- * and `vkEnumerateDeviceExtensionProperties` instead.
- *
- * @param[in] extension The ASCII encoded name of the extension.
- * @return `GLFW_TRUE` if the extension is available, or `GLFW_FALSE`
- * otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT, @ref GLFW_INVALID_VALUE and @ref
- * GLFW_PLATFORM_ERROR.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_glext
- * @sa @ref glfwGetProcAddress
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- */
-GLFWAPI int glfwExtensionSupported(const char* extension);
-
-/*! @brief Returns the address of the specified function for the current
- * context.
- *
- * This function returns the address of the specified OpenGL or OpenGL ES
- * [core or extension function](@ref context_glext), if it is supported
- * by the current context.
- *
- * A context must be current on the calling thread. Calling this function
- * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
- *
- * This function does not apply to Vulkan. If you are rendering with Vulkan,
- * see @ref glfwGetInstanceProcAddress, `vkGetInstanceProcAddr` and
- * `vkGetDeviceProcAddr` instead.
- *
- * @param[in] procname The ASCII encoded name of the function.
- * @return The address of the function, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark The address of a given function is not guaranteed to be the same
- * between contexts.
- *
- * @remark This function may return a non-`NULL` address despite the
- * associated version or extension not being available. Always check the
- * context version or extension string first.
- *
- * @pointer_lifetime The returned function pointer is valid until the context
- * is destroyed or the library is terminated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref context_glext
- * @sa @ref glfwExtensionSupported
- *
- * @since Added in version 1.0.
- *
- * @ingroup context
- */
-GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);
-
-/*! @brief Returns whether the Vulkan loader and an ICD have been found.
- *
- * This function returns whether the Vulkan loader and any minimally functional
- * ICD have been found.
- *
- * The availability of a Vulkan loader and even an ICD does not by itself guarantee that
- * surface creation or even instance creation is possible. Call @ref
- * glfwGetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan
- * surface creation are available and @ref glfwGetPhysicalDevicePresentationSupport to
- * check whether a queue family of a physical device supports image presentation.
- *
- * @return `GLFW_TRUE` if Vulkan is minimally available, or `GLFW_FALSE`
- * otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref vulkan_support
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-GLFWAPI int glfwVulkanSupported(void);
-
-/*! @brief Returns the Vulkan instance extensions required by GLFW.
- *
- * This function returns an array of names of Vulkan instance extensions required
- * by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the
- * list will always contain `VK_KHR_surface`, so if you don't require any
- * additional extensions you can pass this list directly to the
- * `VkInstanceCreateInfo` struct.
- *
- * If Vulkan is not available on the machine, this function returns `NULL` and
- * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
- * to check whether Vulkan is at least minimally available.
- *
- * If Vulkan is available but no set of extensions allowing window surface
- * creation was found, this function returns `NULL`. You may still use Vulkan
- * for off-screen rendering and compute work.
- *
- * @param[out] count Where to store the number of extensions in the returned
- * array. This is set to zero if an error occurred.
- * @return An array of ASCII encoded extension names, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_API_UNAVAILABLE.
- *
- * @remark Additional extensions may be required by future versions of GLFW.
- * You should check if any extensions you wish to enable are already in the
- * returned array, as it is an error to specify an extension more than once in
- * the `VkInstanceCreateInfo` struct.
- *
- * @pointer_lifetime The returned array is allocated and freed by GLFW. You
- * should not free it yourself. It is guaranteed to be valid only until the
- * library is terminated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref vulkan_ext
- * @sa @ref glfwCreateWindowSurface
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);
-
+
+ /*! @brief Retrieves the version of the GLFW library.
+ *
+ * This function retrieves the major, minor and revision numbers of the GLFW
+ * library. It is intended for when you are using GLFW as a shared library and
+ * want to ensure that you are using the minimum required version.
+ *
+ * Any or all of the version arguments may be `NULL`.
+ *
+ * @param[out] major Where to store the major version number, or `NULL`.
+ * @param[out] minor Where to store the minor version number, or `NULL`.
+ * @param[out] rev Where to store the revision number, or `NULL`.
+ *
+ * @errors None.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref intro_version
+ * @sa @ref glfwGetVersionString
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup init
+ */
+ GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
+
+ /*! @brief Returns a string describing the compile-time configuration.
+ *
+ * This function returns the compile-time generated
+ * [version string](@ref intro_version_string) of the GLFW library binary. It describes
+ * the version, platforms, compiler and any platform or operating system specific
+ * compile-time options. It should not be confused with the OpenGL or OpenGL ES version
+ * string, queried with `glGetString`.
+ *
+ * __Do not use the version string__ to parse the GLFW library version. The
+ * @ref glfwGetVersion function provides the version of the running library
+ * binary in numerical format.
+ *
+ * __Do not use the version string__ to parse what platforms are supported. The @ref
+ * glfwPlatformSupported function lets you query platform support.
+ *
+ * @return The ASCII encoded GLFW version string.
+ *
+ * @errors None.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @pointer_lifetime The returned string is static and compile-time generated.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref intro_version
+ * @sa @ref glfwGetVersion
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup init
+ */
+ GLFWAPI const char* glfwGetVersionString(void);
+
+ /*! @brief Returns and clears the last error for the calling thread.
+ *
+ * This function returns and clears the [error code](@ref errors) of the last
+ * error that occurred on the calling thread, and optionally a UTF-8 encoded
+ * human-readable description of it. If no error has occurred since the last
+ * call, it returns @ref GLFW_NO_ERROR (zero) and the description pointer is
+ * set to `NULL`.
+ *
+ * @param[in] description Where to store the error description pointer, or `NULL`.
+ * @return The last error code for the calling thread, or @ref GLFW_NO_ERROR
+ * (zero).
+ *
+ * @errors None.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is guaranteed to be valid only until the
+ * next error occurs or the library is terminated.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref error_handling
+ * @sa @ref glfwSetErrorCallback
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup init
+ */
+ GLFWAPI int glfwGetError(const char** description);
+
+ /*! @brief Sets the error callback.
+ *
+ * This function sets the error callback, which is called with an error code
+ * and a human-readable description each time a GLFW error occurs.
+ *
+ * The error code is set before the callback is called. Calling @ref
+ * glfwGetError from the error callback will return the same value as the error
+ * code argument.
+ *
+ * The error callback is called on the thread where the error occurred. If you
+ * are using GLFW from multiple threads, your error callback needs to be
+ * written accordingly.
+ *
+ * Because the description string may have been generated specifically for that
+ * error, it is not guaranteed to be valid after the callback has returned. If
+ * you wish to use it after the callback returns, you need to make a copy.
+ *
+ * Once set, the error callback remains set even after the library has been
+ * terminated.
+ *
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set.
+ *
+ * @callback_signature
+ * @code
+ * void callback_name(int error_code, const char* description)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [callback pointer type](@ref GLFWerrorfun).
+ *
+ * @errors None.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref error_handling
+ * @sa @ref glfwGetError
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup init
+ */
+ GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback);
+
+ /*! @brief Returns the currently selected platform.
+ *
+ * This function returns the platform that was selected during initialization. The
+ * returned value will be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
+ * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
+ *
+ * @return The currently selected platform, or zero if an error occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref platform
+ * @sa @ref glfwPlatformSupported
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
+ */
+ GLFWAPI int glfwGetPlatform(void);
+
+ /*! @brief Returns whether the library includes support for the specified platform.
+ *
+ * This function returns whether the library was compiled with support for the specified
+ * platform. The platform must be one of `GLFW_PLATFORM_WIN32`, `GLFW_PLATFORM_COCOA`,
+ * `GLFW_PLATFORM_WAYLAND`, `GLFW_PLATFORM_X11` or `GLFW_PLATFORM_NULL`.
+ *
+ * @param[in] platform The platform to query.
+ * @return `GLFW_TRUE` if the platform is supported, or `GLFW_FALSE` otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_INVALID_ENUM.
+ *
+ * @remark This function may be called before @ref glfwInit.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref platform
+ * @sa @ref glfwGetPlatform
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup init
+ */
+ GLFWAPI int glfwPlatformSupported(int platform);
+
+ /*! @brief Returns the currently connected monitors.
+ *
+ * This function returns an array of handles for all currently connected
+ * monitors. The primary monitor is always first in the returned array. If no
+ * monitors were found, this function returns `NULL`.
+ *
+ * @param[out] count Where to store the number of monitors in the returned
+ * array. This is set to zero if an error occurred.
+ * @return An array of monitor handles, or `NULL` if no monitors were found or
+ * if an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is guaranteed to be valid only until the
+ * monitor configuration changes or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_monitors
+ * @sa @ref monitor_event
+ * @sa @ref glfwGetPrimaryMonitor
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
+
+ /*! @brief Returns the primary monitor.
+ *
+ * This function returns the primary monitor. This is usually the monitor
+ * where elements like the task bar or global menu bar are located.
+ *
+ * @return The primary monitor, or `NULL` if no monitors were found or if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @remark The primary monitor is always first in the array returned by @ref
+ * glfwGetMonitors.
+ *
+ * @sa @ref monitor_monitors
+ * @sa @ref glfwGetMonitors
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
+
+ /*! @brief Returns the position of the monitor's viewport on the virtual screen.
+ *
+ * This function returns the position, in screen coordinates, of the upper-left
+ * corner of the specified monitor.
+ *
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
+ * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
+
+ /*! @brief Retrieves the work area of the monitor.
+ *
+ * This function returns the position, in screen coordinates, of the upper-left
+ * corner of the work area of the specified monitor along with the work area
+ * size in screen coordinates. The work area is defined as the area of the
+ * monitor not occluded by the window system task bar where present. If no
+ * task bar exists then the work area is the monitor resolution in screen
+ * coordinates.
+ *
+ * Any or all of the position and size arguments may be `NULL`. If an error
+ * occurs, all non-`NULL` position and size arguments will be set to zero.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] xpos Where to store the monitor x-coordinate, or `NULL`.
+ * @param[out] ypos Where to store the monitor y-coordinate, or `NULL`.
+ * @param[out] width Where to store the monitor width, or `NULL`.
+ * @param[out] height Where to store the monitor height, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_workarea
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
+
+ /*! @brief Returns the physical size of the monitor.
+ *
+ * This function returns the size, in millimetres, of the display area of the
+ * specified monitor.
+ *
+ * Some platforms do not provide accurate monitor size information, either
+ * because the monitor [EDID][] data is incorrect or because the driver does
+ * not report it accurately.
+ *
+ * [EDID]: https://en.wikipedia.org/wiki/Extended_display_identification_data
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] widthMM Where to store the width, in millimetres, of the
+ * monitor's display area, or `NULL`.
+ * @param[out] heightMM Where to store the height, in millimetres, of the
+ * monitor's display area, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @remark @win32 On Windows 8 and earlier the physical size is calculated from
+ * the current resolution and system DPI instead of querying the monitor EDID data.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
+
+ /*! @brief Retrieves the content scale for the specified monitor.
+ *
+ * This function retrieves the content scale for the specified monitor. The
+ * content scale is the ratio between the current DPI and the platform's
+ * default DPI. This is especially important for text and any UI elements. If
+ * the pixel dimensions of your UI scaled by this look appropriate on your
+ * machine then it should appear at a reasonable size on other machines
+ * regardless of their DPI and scaling settings. This relies on the system DPI
+ * and scaling settings being somewhat correct.
+ *
+ * The content scale may depend on both the monitor resolution and pixel
+ * density and on user settings. It may be very different from the raw DPI
+ * calculated from the physical size and current resolution.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
+ * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @wayland Fractional scaling information is not yet available for
+ * monitors, so this function only returns integer content scales.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_scale
+ * @sa @ref glfwGetWindowContentScale
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
+
+ /*! @brief Returns the name of the specified monitor.
+ *
+ * This function returns a human-readable name, encoded as UTF-8, of the
+ * specified monitor. The name typically reflects the make and model of the
+ * monitor and is not guaranteed to be unique among the connected monitors.
+ *
+ * @param[in] monitor The monitor to query.
+ * @return The UTF-8 encoded name of the monitor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified monitor is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_properties
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
+
+ /*! @brief Sets the user pointer of the specified monitor.
+ *
+ * This function sets the user-defined pointer of the specified monitor. The
+ * current value is retained until the monitor is disconnected. The initial
+ * value is `NULL`.
+ *
+ * This function may be called from the monitor callback, even for a monitor
+ * that is being disconnected.
+ *
+ * @param[in] monitor The monitor whose pointer to set.
+ * @param[in] pointer The new value.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref monitor_userptr
+ * @sa @ref glfwGetMonitorUserPointer
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
+
+ /*! @brief Returns the user pointer of the specified monitor.
+ *
+ * This function returns the current value of the user-defined pointer of the
+ * specified monitor. The initial value is `NULL`.
+ *
+ * This function may be called from the monitor callback, even for a monitor
+ * that is being disconnected.
+ *
+ * @param[in] monitor The monitor whose pointer to return.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref monitor_userptr
+ * @sa @ref glfwSetMonitorUserPointer
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
+
+ /*! @brief Sets the monitor configuration callback.
+ *
+ * This function sets the monitor configuration callback, or removes the
+ * currently set callback. This is called when a monitor is connected to or
+ * disconnected from the system.
+ *
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWmonitor* monitor, int event)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWmonitorfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_event
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback);
+
+ /*! @brief Returns the available video modes for the specified monitor.
+ *
+ * This function returns an array of all video modes supported by the specified
+ * monitor. The returned array is sorted in ascending order, first by color
+ * bit depth (the sum of all channel depths), then by resolution area (the
+ * product of width and height), then resolution width and finally by refresh
+ * rate.
+ *
+ * @param[in] monitor The monitor to query.
+ * @param[out] count Where to store the number of video modes in the returned
+ * array. This is set to zero if an error occurred.
+ * @return An array of video modes, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified monitor is
+ * disconnected, this function is called again for that monitor or the library
+ * is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_modes
+ * @sa @ref glfwGetVideoMode
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Changed to return an array of modes for a specific monitor.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
+
+ /*! @brief Returns the current mode of the specified monitor.
+ *
+ * This function returns the current video mode of the specified monitor. If
+ * you have created a full screen window for that monitor, the return value
+ * will depend on whether that window is iconified.
+ *
+ * @param[in] monitor The monitor to query.
+ * @return The current mode of the monitor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified monitor is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_modes
+ * @sa @ref glfwGetVideoModes
+ *
+ * @since Added in version 3.0. Replaces `glfwGetDesktopMode`.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
+
+ /*! @brief Generates a gamma ramp and sets it for the specified monitor.
+ *
+ * This function generates an appropriately sized gamma ramp from the specified
+ * exponent and then calls @ref glfwSetGammaRamp with it. The value must be
+ * a finite number greater than zero.
+ *
+ * The software controlled gamma ramp is applied _in addition_ to the hardware
+ * gamma correction, which today is usually an approximation of sRGB gamma.
+ * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
+ * the default (usually sRGB-like) behavior.
+ *
+ * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
+ * GLFW_SRGB_CAPABLE hint.
+ *
+ * @param[in] monitor The monitor whose gamma ramp to set.
+ * @param[in] gamma The desired exponent.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_INVALID_VALUE,
+ * @ref GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland Gamma handling is a privileged protocol, this function
+ * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
+
+ /*! @brief Returns the current gamma ramp for the specified monitor.
+ *
+ * This function returns the current gamma ramp of the specified monitor.
+ *
+ * @param[in] monitor The monitor to query.
+ * @return The current gamma ramp, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
+ * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland Gamma handling is a privileged protocol, this function
+ * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE while
+ * returning `NULL`.
+ *
+ * @pointer_lifetime The returned structure and its arrays are allocated and
+ * freed by GLFW. You should not free them yourself. They are valid until the
+ * specified monitor is disconnected, this function is called again for that
+ * monitor or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
+
+ /*! @brief Sets the current gamma ramp for the specified monitor.
+ *
+ * This function sets the current gamma ramp for the specified monitor. The
+ * original gamma ramp for that monitor is saved by GLFW the first time this
+ * function is called and is restored by @ref glfwTerminate.
+ *
+ * The software controlled gamma ramp is applied _in addition_ to the hardware
+ * gamma correction, which today is usually an approximation of sRGB gamma.
+ * This means that setting a perfectly linear ramp, or gamma 1.0, will produce
+ * the default (usually sRGB-like) behavior.
+ *
+ * For gamma correct rendering with OpenGL or OpenGL ES, see the @ref
+ * GLFW_SRGB_CAPABLE hint.
+ *
+ * @param[in] monitor The monitor whose gamma ramp to set.
+ * @param[in] ramp The gamma ramp to use.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref GLFW_PLATFORM_ERROR
+ * and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark The size of the specified gamma ramp should match the size of the
+ * current ramp for that monitor.
+ *
+ * @remark @win32 The gamma ramp size must be 256.
+ *
+ * @remark @wayland Gamma handling is a privileged protocol, this function
+ * will thus never be implemented and emits @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @pointer_lifetime The specified gamma ramp is copied before this function
+ * returns.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref monitor_gamma
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup monitor
+ */
+ GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
+
+ /*! @brief Resets all window hints to their default values.
+ *
+ * This function resets all window hints to their
+ * [default values](@ref window_hints_values).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_hints
+ * @sa @ref glfwWindowHint
+ * @sa @ref glfwWindowHintString
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwDefaultWindowHints(void);
+
+ /*! @brief Sets the specified window hint to the desired value.
+ *
+ * This function sets hints for the next call to @ref glfwCreateWindow. The
+ * hints, once set, retain their values until changed by a call to this
+ * function or @ref glfwDefaultWindowHints, or until the library is terminated.
+ *
+ * Only integer value hints can be set with this function. String value hints
+ * are set with @ref glfwWindowHintString.
+ *
+ * This function does not check whether the specified hint values are valid.
+ * If you set hints to invalid values this will instead be reported by the next
+ * call to @ref glfwCreateWindow.
+ *
+ * Some hints are platform specific. These may be set on any platform but they
+ * will only affect their specific platform. Other platforms will ignore them.
+ * Setting these hints requires no platform specific headers or functions.
+ *
+ * @param[in] hint The [window hint](@ref window_hints) to set.
+ * @param[in] value The new value of the window hint.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_hints
+ * @sa @ref glfwWindowHintString
+ * @sa @ref glfwDefaultWindowHints
+ *
+ * @since Added in version 3.0. Replaces `glfwOpenWindowHint`.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwWindowHint(int hint, int value);
+
+ /*! @brief Sets the specified window hint to the desired value.
+ *
+ * This function sets hints for the next call to @ref glfwCreateWindow. The
+ * hints, once set, retain their values until changed by a call to this
+ * function or @ref glfwDefaultWindowHints, or until the library is terminated.
+ *
+ * Only string type hints can be set with this function. Integer value hints
+ * are set with @ref glfwWindowHint.
+ *
+ * This function does not check whether the specified hint values are valid.
+ * If you set hints to invalid values this will instead be reported by the next
+ * call to @ref glfwCreateWindow.
+ *
+ * Some hints are platform specific. These may be set on any platform but they
+ * will only affect their specific platform. Other platforms will ignore them.
+ * Setting these hints requires no platform specific headers or functions.
+ *
+ * @param[in] hint The [window hint](@ref window_hints) to set.
+ * @param[in] value The new value of the window hint.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @pointer_lifetime The specified string is copied before this function
+ * returns.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_hints
+ * @sa @ref glfwWindowHint
+ * @sa @ref glfwDefaultWindowHints
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwWindowHintString(int hint, const char* value);
+
+ /*! @brief Creates a window and its associated context.
+ *
+ * This function creates a window and its associated OpenGL or OpenGL ES
+ * context. Most of the options controlling how the window and its context
+ * should be created are specified with [window hints](@ref window_hints).
+ *
+ * Successful creation does not change which context is current. Before you
+ * can use the newly created context, you need to
+ * [make it current](@ref context_current). For information about the `share`
+ * parameter, see @ref context_sharing.
+ *
+ * The created window, framebuffer and context may differ from what you
+ * requested, as not all parameters and hints are
+ * [hard constraints](@ref window_hints_hard). This includes the size of the
+ * window, especially for full screen windows. To query the actual attributes
+ * of the created window, framebuffer and context, see @ref
+ * glfwGetWindowAttrib, @ref glfwGetWindowSize and @ref glfwGetFramebufferSize.
+ *
+ * To create a full screen window, you need to specify the monitor the window
+ * will cover. If no monitor is specified, the window will be windowed mode.
+ * Unless you have a way for the user to choose a specific monitor, it is
+ * recommended that you pick the primary monitor. For more information on how
+ * to query connected monitors, see @ref monitor_monitors.
+ *
+ * For full screen windows, the specified size becomes the resolution of the
+ * window's _desired video mode_. As long as a full screen window is not
+ * iconified, the supported video mode most closely matching the desired video
+ * mode is set for the specified monitor. For more information about full
+ * screen windows, including the creation of so called _windowed full screen_
+ * or _borderless full screen_ windows, see @ref window_windowed_full_screen.
+ *
+ * Once you have created the window, you can switch it between windowed and
+ * full screen mode with @ref glfwSetWindowMonitor. This will not affect its
+ * OpenGL or OpenGL ES context.
+ *
+ * By default, newly created windows use the placement recommended by the
+ * window system. To create the window at a specific position, set the @ref
+ * GLFW_POSITION_X and @ref GLFW_POSITION_Y window hints before creation. To
+ * restore the default behavior, set either or both hints back to
+ * `GLFW_ANY_POSITION`.
+ *
+ * As long as at least one full screen window is not iconified, the screensaver
+ * is prohibited from starting.
+ *
+ * Window systems put limits on window sizes. Very large or very small window
+ * dimensions may be overridden by the window system on creation. Check the
+ * actual [size](@ref window_size) after creation.
+ *
+ * The [swap interval](@ref buffer_swap) is not set during window creation and
+ * the initial value may vary depending on driver settings and defaults.
+ *
+ * @param[in] width The desired width, in screen coordinates, of the window.
+ * This must be greater than zero.
+ * @param[in] height The desired height, in screen coordinates, of the window.
+ * This must be greater than zero.
+ * @param[in] title The initial, UTF-8 encoded window title.
+ * @param[in] monitor The monitor to use for full screen mode, or `NULL` for
+ * windowed mode.
+ * @param[in] share The window whose context to share resources with, or `NULL`
+ * to not share resources.
+ * @return The handle of the created window, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_API_UNAVAILABLE, @ref
+ * GLFW_VERSION_UNAVAILABLE, @ref GLFW_FORMAT_UNAVAILABLE, @ref
+ * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark @win32 Window creation will fail if the Microsoft GDI software
+ * OpenGL implementation is the only one available.
+ *
+ * @remark @win32 If the executable has an icon resource named `GLFW_ICON,` it
+ * will be set as the initial icon for the window. If no such icon is present,
+ * the `IDI_APPLICATION` icon will be used instead. To set a different icon,
+ * see @ref glfwSetWindowIcon.
+ *
+ * @remark @win32 The context to share resources with must not be current on
+ * any other thread.
+ *
+ * @remark @macos The OS only supports core profile contexts for OpenGL
+ * versions 3.2 and later. Before creating an OpenGL context of version 3.2 or
+ * later you must set the [GLFW_OPENGL_PROFILE](@ref GLFW_OPENGL_PROFILE_hint)
+ * hint accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all
+ * on macOS.
+ *
+ * @remark @macos The GLFW window has no icon, as it is not a document
+ * window, but the dock icon will be the same as the application bundle's icon.
+ * For more information on bundles, see the
+ * [Bundle Programming Guide][bundle-guide] in the Mac Developer Library.
+ *
+ * [bundle-guide]: https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/
+ *
+ * @remark @macos The window frame will not be rendered at full resolution on
+ * Retina displays unless the
+ * [GLFW_SCALE_FRAMEBUFFER](@ref GLFW_SCALE_FRAMEBUFFER_hint)
+ * hint is `GLFW_TRUE` and the `NSHighResolutionCapable` key is enabled in the
+ * application bundle's `Info.plist`. For more information, see
+ * [High Resolution Guidelines for OS X][hidpi-guide] in the Mac Developer
+ * Library. The GLFW test and example programs use a custom `Info.plist`
+ * template for this, which can be found as `CMake/Info.plist.in` in the source
+ * tree.
+ *
+ * [hidpi-guide]: https://developer.apple.com/library/mac/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Explained/Explained.html
+ *
+ * @remark @macos When activating frame autosaving with
+ * [GLFW_COCOA_FRAME_NAME](@ref GLFW_COCOA_FRAME_NAME_hint), the specified
+ * window size and position may be overridden by previously saved values.
+ *
+ * @remark @wayland GLFW uses [libdecor][] where available to create its window
+ * decorations. This in turn uses server-side XDG decorations where available
+ * and provides high quality client-side decorations on compositors like GNOME.
+ * If both XDG decorations and libdecor are unavailable, GLFW falls back to
+ * a very simple set of window decorations that only support moving, resizing
+ * and the window manager's right-click menu.
+ *
+ * [libdecor]: https://gitlab.freedesktop.org/libdecor/libdecor
+ *
+ * @remark @x11 Some window managers will not respect the placement of
+ * initially hidden windows.
+ *
+ * @remark @x11 Due to the asynchronous nature of X11, it may take a moment for
+ * a window to reach its requested state. This means you may not be able to
+ * query the final size, position or other attributes directly after window
+ * creation.
+ *
+ * @remark @x11 The class part of the `WM_CLASS` window property will by
+ * default be set to the window title passed to this function. The instance
+ * part will use the contents of the `RESOURCE_NAME` environment variable, if
+ * present and not empty, or fall back to the window title. Set the
+ * [GLFW_X11_CLASS_NAME](@ref GLFW_X11_CLASS_NAME_hint) and
+ * [GLFW_X11_INSTANCE_NAME](@ref GLFW_X11_INSTANCE_NAME_hint) window hints to
+ * override this.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_creation
+ * @sa @ref glfwDestroyWindow
+ *
+ * @since Added in version 3.0. Replaces `glfwOpenWindow`.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
+
+ /*! @brief Destroys the specified window and its context.
+ *
+ * This function destroys the specified window and its context. On calling
+ * this function, no further callbacks will be called for that window.
+ *
+ * If the context of the specified window is current on the main thread, it is
+ * detached before being destroyed.
+ *
+ * @param[in] window The window to destroy.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @note The context of the specified window must not be current on any other
+ * thread when this function is called.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_creation
+ * @sa @ref glfwCreateWindow
+ *
+ * @since Added in version 3.0. Replaces `glfwCloseWindow`.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
+
+ /*! @brief Checks the close flag of the specified window.
+ *
+ * This function returns the value of the close flag of the specified window.
+ *
+ * @param[in] window The window to query.
+ * @return The value of the close flag.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
+
+ /*! @brief Sets the close flag of the specified window.
+ *
+ * This function sets the value of the close flag of the specified window.
+ * This can be used to override the user's attempt to close the window, or
+ * to signal that it should be closed.
+ *
+ * @param[in] window The window whose flag to change.
+ * @param[in] value The new value.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
+
+ /*! @brief Returns the title of the specified window.
+ *
+ * This function returns the window title, encoded as UTF-8, of the specified
+ * window. This is the title set previously by @ref glfwCreateWindow
+ * or @ref glfwSetWindowTitle.
+ *
+ * @param[in] window The window to query.
+ * @return The UTF-8 encoded window title, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @remark The returned title is currently a copy of the title last set by @ref
+ * glfwCreateWindow or @ref glfwSetWindowTitle. It does not include any
+ * additional text which may be appended by the platform or another program.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the next call to @ref
+ * glfwGetWindowTitle or @ref glfwSetWindowTitle, or until the library is
+ * terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_title
+ * @sa @ref glfwSetWindowTitle
+ *
+ * @since Added in version 3.4.
+ *
+ * @ingroup window
+ */
+ GLFWAPI const char* glfwGetWindowTitle(GLFWwindow* window);
+
+ /*! @brief Sets the title of the specified window.
+ *
+ * This function sets the window title, encoded as UTF-8, of the specified
+ * window.
+ *
+ * @param[in] window The window whose title to change.
+ * @param[in] title The UTF-8 encoded window title.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @macos The window title will not be updated until the next time you
+ * process events.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_title
+ * @sa @ref glfwGetWindowTitle
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
+
+ /*! @brief Sets the icon for the specified window.
+ *
+ * This function sets the icon of the specified window. If passed an array of
+ * candidate images, those of or closest to the sizes desired by the system are
+ * selected. If no images are specified, the window reverts to its default
+ * icon.
+ *
+ * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
+ * bits per channel with the red channel first. They are arranged canonically
+ * as packed sequential rows, starting from the top-left corner.
+ *
+ * The desired image sizes varies depending on platform and system settings.
+ * The selected images will be rescaled as needed. Good sizes include 16x16,
+ * 32x32 and 48x48.
+ *
+ * @param[in] window The window whose icon to set.
+ * @param[in] count The number of images in the specified array, or zero to
+ * revert to the default window icon.
+ * @param[in] images The images to create the icon from. This is ignored if
+ * count is zero.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
+ * GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @pointer_lifetime The specified image data is copied before this function
+ * returns.
+ *
+ * @remark @macos Regular windows do not have icons on macOS. This function
+ * will emit @ref GLFW_FEATURE_UNAVAILABLE. The dock icon will be the same as
+ * the application bundle's icon. For more information on bundles, see the
+ * [Bundle Programming Guide][bundle-guide] in the Mac Developer Library.
+ *
+ * [bundle-guide]: https://developer.apple.com/library/mac/documentation/CoreFoundation/Conceptual/CFBundles/
+ *
+ * @remark @wayland There is no existing protocol to change an icon, the
+ * window will thus inherit the one defined in the application's desktop file.
+ * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_icon
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);
+
+ /*! @brief Retrieves the position of the content area of the specified window.
+ *
+ * This function retrieves the position, in screen coordinates, of the
+ * upper-left corner of the content area of the specified window.
+ *
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
+ * @param[in] window The window to query.
+ * @param[out] xpos Where to store the x-coordinate of the upper-left corner of
+ * the content area, or `NULL`.
+ * @param[out] ypos Where to store the y-coordinate of the upper-left corner of
+ * the content area, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland There is no way for an application to retrieve the global
+ * position of its windows. This function will emit @ref
+ * GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_pos
+ * @sa @ref glfwSetWindowPos
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
+
+ /*! @brief Sets the position of the content area of the specified window.
+ *
+ * This function sets the position, in screen coordinates, of the upper-left
+ * corner of the content area of the specified windowed mode window. If the
+ * window is a full screen window, this function does nothing.
+ *
+ * __Do not use this function__ to move an already visible window unless you
+ * have very good reasons for doing so, as it will confuse and annoy the user.
+ *
+ * The window manager may put limits on what positions are allowed. GLFW
+ * cannot and should not override these limits.
+ *
+ * @param[in] window The window to query.
+ * @param[in] xpos The x-coordinate of the upper-left corner of the content area.
+ * @param[in] ypos The y-coordinate of the upper-left corner of the content area.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland There is no way for an application to set the global
+ * position of its windows. This function will emit @ref
+ * GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_pos
+ * @sa @ref glfwGetWindowPos
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
+
+ /*! @brief Retrieves the size of the content area of the specified window.
+ *
+ * This function retrieves the size, in screen coordinates, of the content area
+ * of the specified window. If you wish to retrieve the size of the
+ * framebuffer of the window in pixels, see @ref glfwGetFramebufferSize.
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] window The window whose size to retrieve.
+ * @param[out] width Where to store the width, in screen coordinates, of the
+ * content area, or `NULL`.
+ * @param[out] height Where to store the height, in screen coordinates, of the
+ * content area, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_size
+ * @sa @ref glfwSetWindowSize
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
+
+ /*! @brief Sets the size limits of the specified window.
+ *
+ * This function sets the size limits of the content area of the specified
+ * window. If the window is full screen, the size limits only take effect
+ * once it is made windowed. If the window is not resizable, this function
+ * does nothing.
+ *
+ * The size limits are applied immediately to a windowed mode window and may
+ * cause it to be resized.
+ *
+ * The maximum dimensions must be greater than or equal to the minimum
+ * dimensions and all must be greater than or equal to zero.
+ *
+ * @param[in] window The window to set limits for.
+ * @param[in] minwidth The minimum width, in screen coordinates, of the content
+ * area, or `GLFW_DONT_CARE`.
+ * @param[in] minheight The minimum height, in screen coordinates, of the
+ * content area, or `GLFW_DONT_CARE`.
+ * @param[in] maxwidth The maximum width, in screen coordinates, of the content
+ * area, or `GLFW_DONT_CARE`.
+ * @param[in] maxheight The maximum height, in screen coordinates, of the
+ * content area, or `GLFW_DONT_CARE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark If you set size limits and an aspect ratio that conflict, the
+ * results are undefined.
+ *
+ * @remark @wayland The size limits will not be applied until the window is
+ * actually resized, either by the user or by the compositor.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_sizelimits
+ * @sa @ref glfwSetWindowAspectRatio
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);
+
+ /*! @brief Sets the aspect ratio of the specified window.
+ *
+ * This function sets the required aspect ratio of the content area of the
+ * specified window. If the window is full screen, the aspect ratio only takes
+ * effect once it is made windowed. If the window is not resizable, this
+ * function does nothing.
+ *
+ * The aspect ratio is specified as a numerator and a denominator and both
+ * values must be greater than zero. For example, the common 16:9 aspect ratio
+ * is specified as 16 and 9, respectively.
+ *
+ * If the numerator and denominator is set to `GLFW_DONT_CARE` then the aspect
+ * ratio limit is disabled.
+ *
+ * The aspect ratio is applied immediately to a windowed mode window and may
+ * cause it to be resized.
+ *
+ * @param[in] window The window to set limits for.
+ * @param[in] numer The numerator of the desired aspect ratio, or
+ * `GLFW_DONT_CARE`.
+ * @param[in] denom The denominator of the desired aspect ratio, or
+ * `GLFW_DONT_CARE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark If you set size limits and an aspect ratio that conflict, the
+ * results are undefined.
+ *
+ * @remark @wayland The aspect ratio will not be applied until the window is
+ * actually resized, either by the user or by the compositor.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_sizelimits
+ * @sa @ref glfwSetWindowSizeLimits
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);
+
+ /*! @brief Sets the size of the content area of the specified window.
+ *
+ * This function sets the size, in screen coordinates, of the content area of
+ * the specified window.
+ *
+ * For full screen windows, this function updates the resolution of its desired
+ * video mode and switches to the video mode closest to it, without affecting
+ * the window's context. As the context is unaffected, the bit depths of the
+ * framebuffer remain unchanged.
+ *
+ * If you wish to update the refresh rate of the desired video mode in addition
+ * to its resolution, see @ref glfwSetWindowMonitor.
+ *
+ * The window manager may put limits on what sizes are allowed. GLFW cannot
+ * and should not override these limits.
+ *
+ * @param[in] window The window to resize.
+ * @param[in] width The desired width, in screen coordinates, of the window
+ * content area.
+ * @param[in] height The desired height, in screen coordinates, of the window
+ * content area.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_size
+ * @sa @ref glfwGetWindowSize
+ * @sa @ref glfwSetWindowMonitor
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
+
+ /*! @brief Retrieves the size of the framebuffer of the specified window.
+ *
+ * This function retrieves the size, in pixels, of the framebuffer of the
+ * specified window. If you wish to retrieve the size of the window in screen
+ * coordinates, see @ref glfwGetWindowSize.
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] window The window whose framebuffer to query.
+ * @param[out] width Where to store the width, in pixels, of the framebuffer,
+ * or `NULL`.
+ * @param[out] height Where to store the height, in pixels, of the framebuffer,
+ * or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_fbsize
+ * @sa @ref glfwSetFramebufferSizeCallback
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
+
+ /*! @brief Retrieves the size of the frame of the window.
+ *
+ * This function retrieves the size, in screen coordinates, of each edge of the
+ * frame of the specified window. This size includes the title bar, if the
+ * window has one. The size of the frame may vary depending on the
+ * [window-related hints](@ref window_hints_wnd) used to create it.
+ *
+ * Because this function retrieves the size of each window frame edge and not
+ * the offset along a particular coordinate axis, the retrieved values will
+ * always be zero or positive.
+ *
+ * Any or all of the size arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` size arguments will be set to zero.
+ *
+ * @param[in] window The window whose frame size to query.
+ * @param[out] left Where to store the size, in screen coordinates, of the left
+ * edge of the window frame, or `NULL`.
+ * @param[out] top Where to store the size, in screen coordinates, of the top
+ * edge of the window frame, or `NULL`.
+ * @param[out] right Where to store the size, in screen coordinates, of the
+ * right edge of the window frame, or `NULL`.
+ * @param[out] bottom Where to store the size, in screen coordinates, of the
+ * bottom edge of the window frame, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_size
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
+
+ /*! @brief Retrieves the content scale for the specified window.
+ *
+ * This function retrieves the content scale for the specified window. The
+ * content scale is the ratio between the current DPI and the platform's
+ * default DPI. This is especially important for text and any UI elements. If
+ * the pixel dimensions of your UI scaled by this look appropriate on your
+ * machine then it should appear at a reasonable size on other machines
+ * regardless of their DPI and scaling settings. This relies on the system DPI
+ * and scaling settings being somewhat correct.
+ *
+ * On platforms where each monitors can have its own content scale, the window
+ * content scale will depend on which monitor the system considers the window
+ * to be on.
+ *
+ * @param[in] window The window to query.
+ * @param[out] xscale Where to store the x-axis content scale, or `NULL`.
+ * @param[out] yscale Where to store the y-axis content scale, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_scale
+ * @sa @ref glfwSetWindowContentScaleCallback
+ * @sa @ref glfwGetMonitorContentScale
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);
+
+ /*! @brief Returns the opacity of the whole window.
+ *
+ * This function returns the opacity of the window, including any decorations.
+ *
+ * The opacity (or alpha) value is a positive finite number between zero and
+ * one, where zero is fully transparent and one is fully opaque. If the system
+ * does not support whole window transparency, this function always returns one.
+ *
+ * The initial opacity value for newly created windows is one.
+ *
+ * @param[in] window The window to query.
+ * @return The opacity value of the specified window.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_transparency
+ * @sa @ref glfwSetWindowOpacity
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);
+
+ /*! @brief Sets the opacity of the whole window.
+ *
+ * This function sets the opacity of the window, including any decorations.
+ *
+ * The opacity (or alpha) value is a positive finite number between zero and
+ * one, where zero is fully transparent and one is fully opaque.
+ *
+ * The initial opacity value for newly created windows is one.
+ *
+ * A window created with framebuffer transparency may not use whole window
+ * transparency. The results of doing this are undefined.
+ *
+ * @param[in] window The window to set the opacity for.
+ * @param[in] opacity The desired opacity of the specified window.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland There is no way to set an opacity factor for a window.
+ * This function will emit @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_transparency
+ * @sa @ref glfwGetWindowOpacity
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
+
+ /*! @brief Iconifies the specified window.
+ *
+ * This function iconifies (minimizes) the specified window if it was
+ * previously restored. If the window is already iconified, this function does
+ * nothing.
+ *
+ * If the specified window is a full screen window, GLFW restores the original
+ * video mode of the monitor. The window's desired video mode is set again
+ * when the window is restored.
+ *
+ * @param[in] window The window to iconify.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @wayland Once a window is iconified, @ref glfwRestoreWindow won’t
+ * be able to restore it. This is a design decision of the xdg-shell
+ * protocol.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_iconify
+ * @sa @ref glfwRestoreWindow
+ * @sa @ref glfwMaximizeWindow
+ *
+ * @since Added in version 2.1.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
+
+ /*! @brief Restores the specified window.
+ *
+ * This function restores the specified window if it was previously iconified
+ * (minimized) or maximized. If the window is already restored, this function
+ * does nothing.
+ *
+ * If the specified window is an iconified full screen window, its desired
+ * video mode is set again for its monitor when the window is restored.
+ *
+ * @param[in] window The window to restore.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_iconify
+ * @sa @ref glfwIconifyWindow
+ * @sa @ref glfwMaximizeWindow
+ *
+ * @since Added in version 2.1.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
+
+ /*! @brief Maximizes the specified window.
+ *
+ * This function maximizes the specified window if it was previously not
+ * maximized. If the window is already maximized, this function does nothing.
+ *
+ * If the specified window is a full screen window, this function does nothing.
+ *
+ * @param[in] window The window to maximize.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @par Thread Safety
+ * This function may only be called from the main thread.
+ *
+ * @sa @ref window_iconify
+ * @sa @ref glfwIconifyWindow
+ * @sa @ref glfwRestoreWindow
+ *
+ * @since Added in GLFW 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);
+
+ /*! @brief Makes the specified window visible.
+ *
+ * This function makes the specified window visible if it was previously
+ * hidden. If the window is already visible or is in full screen mode, this
+ * function does nothing.
+ *
+ * By default, windowed mode windows are focused when shown
+ * Set the [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) window hint
+ * to change this behavior for all newly created windows, or change the
+ * behavior for an existing window with @ref glfwSetWindowAttrib.
+ *
+ * @param[in] window The window to make visible.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @wayland Because Wayland wants every frame of the desktop to be
+ * complete, this function does not immediately make the window visible.
+ * Instead it will become visible the next time the window framebuffer is
+ * updated after this call.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_hide
+ * @sa @ref glfwHideWindow
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwShowWindow(GLFWwindow* window);
+
+ /*! @brief Hides the specified window.
+ *
+ * This function hides the specified window if it was previously visible. If
+ * the window is already hidden or is in full screen mode, this function does
+ * nothing.
+ *
+ * @param[in] window The window to hide.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_hide
+ * @sa @ref glfwShowWindow
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwHideWindow(GLFWwindow* window);
+
+ /*! @brief Brings the specified window to front and sets input focus.
+ *
+ * This function brings the specified window to front and sets input focus.
+ * The window should already be visible and not iconified.
+ *
+ * By default, both windowed and full screen mode windows are focused when
+ * initially created. Set the [GLFW_FOCUSED](@ref GLFW_FOCUSED_hint) to
+ * disable this behavior.
+ *
+ * Also by default, windowed mode windows are focused when shown
+ * with @ref glfwShowWindow. Set the
+ * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) to disable this behavior.
+ *
+ * __Do not use this function__ to steal focus from other applications unless
+ * you are certain that is what the user wants. Focus stealing can be
+ * extremely disruptive.
+ *
+ * For a less disruptive way of getting the user's attention, see
+ * [attention requests](@ref window_attention).
+ *
+ * @param[in] window The window to give input focus.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @wayland The compositor will likely ignore focus requests unless
+ * another window created by the same application already has input focus.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_focus
+ * @sa @ref window_attention
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwFocusWindow(GLFWwindow* window);
+
+ /*! @brief Requests user attention to the specified window.
+ *
+ * This function requests user attention to the specified window. On
+ * platforms where this is not supported, attention is requested to the
+ * application as a whole.
+ *
+ * Once the user has given attention, usually by focusing the window or
+ * application, the system will end the request automatically.
+ *
+ * @param[in] window The window to request attention to.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @macos Attention is requested to the application as a whole, not the
+ * specific window.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_attention
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);
+
+ /*! @brief Returns the monitor that the window uses for full screen mode.
+ *
+ * This function returns the handle of the monitor that the specified window is
+ * in full screen on.
+ *
+ * @param[in] window The window to query.
+ * @return The monitor, or `NULL` if the window is in windowed mode or an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_monitor
+ * @sa @ref glfwSetWindowMonitor
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
+
+ /*! @brief Sets the mode, monitor, video mode and placement of a window.
+ *
+ * This function sets the monitor that the window uses for full screen mode or,
+ * if the monitor is `NULL`, makes it windowed mode.
+ *
+ * When setting a monitor, this function updates the width, height and refresh
+ * rate of the desired video mode and switches to the video mode closest to it.
+ * The window position is ignored when setting a monitor.
+ *
+ * When the monitor is `NULL`, the position, width and height are used to
+ * place the window content area. The refresh rate is ignored when no monitor
+ * is specified.
+ *
+ * If you only wish to update the resolution of a full screen window or the
+ * size of a windowed mode window, see @ref glfwSetWindowSize.
+ *
+ * When a window transitions from full screen to windowed mode, this function
+ * restores any previous window settings such as whether it is decorated,
+ * floating, resizable, has size or aspect ratio limits, etc.
+ *
+ * @param[in] window The window whose monitor, size or video mode to set.
+ * @param[in] monitor The desired monitor, or `NULL` to set windowed mode.
+ * @param[in] xpos The desired x-coordinate of the upper-left corner of the
+ * content area.
+ * @param[in] ypos The desired y-coordinate of the upper-left corner of the
+ * content area.
+ * @param[in] width The desired with, in screen coordinates, of the content
+ * area or video mode.
+ * @param[in] height The desired height, in screen coordinates, of the content
+ * area or video mode.
+ * @param[in] refreshRate The desired refresh rate, in Hz, of the video mode,
+ * or `GLFW_DONT_CARE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark The OpenGL or OpenGL ES context will not be destroyed or otherwise
+ * affected by any resizing or mode switching, although you may need to update
+ * your viewport if the framebuffer size has changed.
+ *
+ * @remark @wayland The desired window position is ignored, as there is no way
+ * for an application to set this property.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_monitor
+ * @sa @ref window_full_screen
+ * @sa @ref glfwGetWindowMonitor
+ * @sa @ref glfwSetWindowSize
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);
+
+ /*! @brief Returns an attribute of the specified window.
+ *
+ * This function returns the value of an attribute of the specified window or
+ * its OpenGL or OpenGL ES context.
+ *
+ * @param[in] window The window to query.
+ * @param[in] attrib The [window attribute](@ref window_attribs) whose value to
+ * return.
+ * @return The value of the attribute, or zero if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark Framebuffer related hints are not window attributes. See @ref
+ * window_attribs_fb for more information.
+ *
+ * @remark Zero is a valid value for many window and context related
+ * attributes so you cannot use a return value of zero as an indication of
+ * errors. However, this function should not fail as long as it is passed
+ * valid arguments and the library has been [initialized](@ref intro_init).
+ *
+ * @remark @wayland The Wayland protocol provides no way to check whether a
+ * window is iconfied, so @ref GLFW_ICONIFIED always returns `GLFW_FALSE`.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_attribs
+ * @sa @ref glfwSetWindowAttrib
+ *
+ * @since Added in version 3.0. Replaces `glfwGetWindowParam` and
+ * `glfwGetGLVersion`.
+ *
+ * @ingroup window
+ */
+ GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
+
+ /*! @brief Sets an attribute of the specified window.
+ *
+ * This function sets the value of an attribute of the specified window.
+ *
+ * The supported attributes are [GLFW_DECORATED](@ref GLFW_DECORATED_attrib),
+ * [GLFW_RESIZABLE](@ref GLFW_RESIZABLE_attrib),
+ * [GLFW_FLOATING](@ref GLFW_FLOATING_attrib),
+ * [GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_attrib) and
+ * [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_attrib).
+ * [GLFW_MOUSE_PASSTHROUGH](@ref GLFW_MOUSE_PASSTHROUGH_attrib)
+ *
+ * Some of these attributes are ignored for full screen windows. The new
+ * value will take effect if the window is later made windowed.
+ *
+ * Some of these attributes are ignored for windowed mode windows. The new
+ * value will take effect if the window is later made full screen.
+ *
+ * @param[in] window The window to set the attribute for.
+ * @param[in] attrib A supported window attribute.
+ * @param[in] value `GLFW_TRUE` or `GLFW_FALSE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM, @ref GLFW_INVALID_VALUE, @ref GLFW_PLATFORM_ERROR and @ref
+ * GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark Calling @ref glfwGetWindowAttrib will always return the latest
+ * value, even if that value is ignored by the current mode of the window.
+ *
+ * @remark @wayland The [GLFW_FLOATING](@ref GLFW_FLOATING_attrib) window attribute is
+ * not supported. Setting this will emit @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_attribs
+ * @sa @ref glfwGetWindowAttrib
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);
+
+ /*! @brief Sets the user pointer of the specified window.
+ *
+ * This function sets the user-defined pointer of the specified window. The
+ * current value is retained until the window is destroyed. The initial value
+ * is `NULL`.
+ *
+ * @param[in] window The window whose pointer to set.
+ * @param[in] pointer The new value.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref window_userptr
+ * @sa @ref glfwGetWindowUserPointer
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
+
+ /*! @brief Returns the user pointer of the specified window.
+ *
+ * This function returns the current value of the user-defined pointer of the
+ * specified window. The initial value is `NULL`.
+ *
+ * @param[in] window The window whose pointer to return.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref window_userptr
+ * @sa @ref glfwSetWindowUserPointer
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
+
+ /*! @brief Sets the position callback for the specified window.
+ *
+ * This function sets the position callback of the specified window, which is
+ * called when the window is moved. The callback is provided with the
+ * position, in screen coordinates, of the upper-left corner of the content
+ * area of the window.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int xpos, int ypos)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowposfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @remark @wayland This callback will never be called, as there is no way for
+ * an application to know its global position.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_pos
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun callback);
+
+ /*! @brief Sets the size callback for the specified window.
+ *
+ * This function sets the size callback of the specified window, which is
+ * called when the window is resized. The callback is provided with the size,
+ * in screen coordinates, of the content area of the window.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int width, int height)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowsizefun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_size
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun callback);
+
+ /*! @brief Sets the close callback for the specified window.
+ *
+ * This function sets the close callback of the specified window, which is
+ * called when the user attempts to close the window, for example by clicking
+ * the close widget in the title bar.
+ *
+ * The close flag is set before this callback is called, but you can modify it
+ * at any time with @ref glfwSetWindowShouldClose.
+ *
+ * The close callback is not triggered by @ref glfwDestroyWindow.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowclosefun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @remark @macos Selecting Quit from the application menu will trigger the
+ * close callback for all windows.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_close
+ *
+ * @since Added in version 2.5.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);
+
+ /*! @brief Sets the refresh callback for the specified window.
+ *
+ * This function sets the refresh callback of the specified window, which is
+ * called when the content area of the window needs to be redrawn, for example
+ * if the window has been exposed after having been covered by another window.
+ *
+ * On compositing window systems such as Aero, Compiz, Aqua or Wayland, where
+ * the window contents are saved off-screen, this callback may be called only
+ * very infrequently or never at all.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window);
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowrefreshfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_refresh
+ *
+ * @since Added in version 2.5.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);
+
+ /*! @brief Sets the focus callback for the specified window.
+ *
+ * This function sets the focus callback of the specified window, which is
+ * called when the window gains or loses input focus.
+ *
+ * After the focus callback is called for a window that lost input focus,
+ * synthetic key and mouse button release events will be generated for all such
+ * that had been pressed. For more information, see @ref glfwSetKeyCallback
+ * and @ref glfwSetMouseButtonCallback.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int focused)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowfocusfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_focus
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);
+
+ /*! @brief Sets the iconify callback for the specified window.
+ *
+ * This function sets the iconification callback of the specified window, which
+ * is called when the window is iconified or restored.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int iconified)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowiconifyfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_iconify
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);
+
+ /*! @brief Sets the maximize callback for the specified window.
+ *
+ * This function sets the maximization callback of the specified window, which
+ * is called when the window is maximized or restored.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int maximized)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowmaximizefun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_maximize
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);
+
+ /*! @brief Sets the framebuffer resize callback for the specified window.
+ *
+ * This function sets the framebuffer resize callback of the specified window,
+ * which is called when the framebuffer of the specified window is resized.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int width, int height)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWframebuffersizefun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_fbsize
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);
+
+ /*! @brief Sets the window content scale callback for the specified window.
+ *
+ * This function sets the window content scale callback of the specified window,
+ * which is called when the content scale of the specified window changes.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, float xscale, float yscale)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWwindowcontentscalefun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref window_scale
+ * @sa @ref glfwGetWindowContentScale
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup window
+ */
+ GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);
+
+ /*! @brief Processes all pending events.
+ *
+ * This function processes only those events that are already in the event
+ * queue and then returns immediately. Processing events will cause the window
+ * and input callbacks associated with those events to be called.
+ *
+ * On some platforms, a window move, resize or menu operation will cause event
+ * processing to block. This is due to how event processing is designed on
+ * those platforms. You can use the
+ * [window refresh callback](@ref window_refresh) to redraw the contents of
+ * your window when necessary during such operations.
+ *
+ * Do not assume that callbacks you set will _only_ be called in response to
+ * event processing functions like this one. While it is necessary to poll for
+ * events, window systems that require GLFW to register callbacks of its own
+ * can pass events to GLFW in response to many window system function calls.
+ * GLFW will pass those events on to the application callbacks before
+ * returning.
+ *
+ * Event processing is not required for joystick input to work.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref events
+ * @sa @ref glfwWaitEvents
+ * @sa @ref glfwWaitEventsTimeout
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwPollEvents(void);
+
+ /*! @brief Waits until events are queued and processes them.
+ *
+ * This function puts the calling thread to sleep until at least one event is
+ * available in the event queue. Once one or more events are available,
+ * it behaves exactly like @ref glfwPollEvents, i.e. the events in the queue
+ * are processed and the function then returns immediately. Processing events
+ * will cause the window and input callbacks associated with those events to be
+ * called.
+ *
+ * Since not all events are associated with callbacks, this function may return
+ * without a callback having been called even if you are monitoring all
+ * callbacks.
+ *
+ * On some platforms, a window move, resize or menu operation will cause event
+ * processing to block. This is due to how event processing is designed on
+ * those platforms. You can use the
+ * [window refresh callback](@ref window_refresh) to redraw the contents of
+ * your window when necessary during such operations.
+ *
+ * Do not assume that callbacks you set will _only_ be called in response to
+ * event processing functions like this one. While it is necessary to poll for
+ * events, window systems that require GLFW to register callbacks of its own
+ * can pass events to GLFW in response to many window system function calls.
+ * GLFW will pass those events on to the application callbacks before
+ * returning.
+ *
+ * Event processing is not required for joystick input to work.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref events
+ * @sa @ref glfwPollEvents
+ * @sa @ref glfwWaitEventsTimeout
+ *
+ * @since Added in version 2.5.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwWaitEvents(void);
+
+ /*! @brief Waits with timeout until events are queued and processes them.
+ *
+ * This function puts the calling thread to sleep until at least one event is
+ * available in the event queue, or until the specified timeout is reached. If
+ * one or more events are available, it behaves exactly like @ref
+ * glfwPollEvents, i.e. the events in the queue are processed and the function
+ * then returns immediately. Processing events will cause the window and input
+ * callbacks associated with those events to be called.
+ *
+ * The timeout value must be a positive finite number.
+ *
+ * Since not all events are associated with callbacks, this function may return
+ * without a callback having been called even if you are monitoring all
+ * callbacks.
+ *
+ * On some platforms, a window move, resize or menu operation will cause event
+ * processing to block. This is due to how event processing is designed on
+ * those platforms. You can use the
+ * [window refresh callback](@ref window_refresh) to redraw the contents of
+ * your window when necessary during such operations.
+ *
+ * Do not assume that callbacks you set will _only_ be called in response to
+ * event processing functions like this one. While it is necessary to poll for
+ * events, window systems that require GLFW to register callbacks of its own
+ * can pass events to GLFW in response to many window system function calls.
+ * GLFW will pass those events on to the application callbacks before
+ * returning.
+ *
+ * Event processing is not required for joystick input to work.
+ *
+ * @param[in] timeout The maximum amount of time, in seconds, to wait.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref events
+ * @sa @ref glfwPollEvents
+ * @sa @ref glfwWaitEvents
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwWaitEventsTimeout(double timeout);
+
+ /*! @brief Posts an empty event to the event queue.
+ *
+ * This function posts an empty event from the current thread to the event
+ * queue, causing @ref glfwWaitEvents or @ref glfwWaitEventsTimeout to return.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref events
+ * @sa @ref glfwWaitEvents
+ * @sa @ref glfwWaitEventsTimeout
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwPostEmptyEvent(void);
+
+ /*! @brief Returns the value of an input option for the specified window.
+ *
+ * This function returns the value of an input option for the specified window.
+ * The mode must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
+ * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS or
+ * @ref GLFW_RAW_MOUSE_MOTION.
+ *
+ * @param[in] window The window to query.
+ * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
+ * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
+ * `GLFW_RAW_MOUSE_MOTION`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref glfwSetInputMode
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
+
+ /*! @brief Sets an input option for the specified window.
+ *
+ * This function sets an input mode option for the specified window. The mode
+ * must be one of @ref GLFW_CURSOR, @ref GLFW_STICKY_KEYS,
+ * @ref GLFW_STICKY_MOUSE_BUTTONS, @ref GLFW_LOCK_KEY_MODS
+ * @ref GLFW_RAW_MOUSE_MOTION, or @ref GLFW_UNLIMITED_MOUSE_BUTTONS.
+ *
+ * If the mode is `GLFW_CURSOR`, the value must be one of the following cursor
+ * modes:
+ * - `GLFW_CURSOR_NORMAL` makes the cursor visible and behaving normally.
+ * - `GLFW_CURSOR_HIDDEN` makes the cursor invisible when it is over the
+ * content area of the window but does not restrict the cursor from leaving.
+ * - `GLFW_CURSOR_DISABLED` hides and grabs the cursor, providing virtual
+ * and unlimited cursor movement. This is useful for implementing for
+ * example 3D camera controls.
+ * - `GLFW_CURSOR_CAPTURED` makes the cursor visible and confines it to the
+ * content area of the window.
+ *
+ * If the mode is `GLFW_STICKY_KEYS`, the value must be either `GLFW_TRUE` to
+ * enable sticky keys, or `GLFW_FALSE` to disable it. If sticky keys are
+ * enabled, a key press will ensure that @ref glfwGetKey returns `GLFW_PRESS`
+ * the next time it is called even if the key had been released before the
+ * call. This is useful when you are only interested in whether keys have been
+ * pressed but not when or in which order.
+ *
+ * If the mode is `GLFW_STICKY_MOUSE_BUTTONS`, the value must be either
+ * `GLFW_TRUE` to enable sticky mouse buttons, or `GLFW_FALSE` to disable it.
+ * If sticky mouse buttons are enabled, a mouse button press will ensure that
+ * @ref glfwGetMouseButton returns `GLFW_PRESS` the next time it is called even
+ * if the mouse button had been released before the call. This is useful when
+ * you are only interested in whether mouse buttons have been pressed but not
+ * when or in which order.
+ *
+ * If the mode is `GLFW_LOCK_KEY_MODS`, the value must be either `GLFW_TRUE` to
+ * enable lock key modifier bits, or `GLFW_FALSE` to disable them. If enabled,
+ * callbacks that receive modifier bits will also have the @ref
+ * GLFW_MOD_CAPS_LOCK bit set when the event was generated with Caps Lock on,
+ * and the @ref GLFW_MOD_NUM_LOCK bit when Num Lock was on.
+ *
+ * If the mode is `GLFW_RAW_MOUSE_MOTION`, the value must be either `GLFW_TRUE`
+ * to enable raw (unscaled and unaccelerated) mouse motion when the cursor is
+ * disabled, or `GLFW_FALSE` to disable it. If raw motion is not supported,
+ * attempting to set this will emit @ref GLFW_FEATURE_UNAVAILABLE. Call @ref
+ * glfwRawMouseMotionSupported to check for support.
+ *
+ * If the mode is `GLFW_UNLIMITED_MOUSE_BUTTONS`, the value must be either
+ * `GLFW_TRUE` to disable the mouse button limit when calling the mouse button
+ * callback, or `GLFW_FALSE` to limit the mouse buttons sent to the callback
+ * to the mouse button token values up to `GLFW_MOUSE_BUTTON_LAST`.
+ *
+ * @param[in] window The window whose input mode to set.
+ * @param[in] mode One of `GLFW_CURSOR`, `GLFW_STICKY_KEYS`,
+ * `GLFW_STICKY_MOUSE_BUTTONS`, `GLFW_LOCK_KEY_MODS` or
+ * `GLFW_RAW_MOUSE_MOTION`.
+ * @param[in] value The new value of the specified input mode.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM, @ref GLFW_PLATFORM_ERROR and @ref
+ * GLFW_FEATURE_UNAVAILABLE (see above).
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref glfwGetInputMode
+ *
+ * @since Added in version 3.0. Replaces `glfwEnable` and `glfwDisable`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
+
+ /*! @brief Returns whether raw mouse motion is supported.
+ *
+ * This function returns whether raw mouse motion is supported on the current
+ * system. This status does not change after GLFW has been initialized so you
+ * only need to check this once. If you attempt to enable raw motion on
+ * a system that does not support it, @ref GLFW_PLATFORM_ERROR will be emitted.
+ *
+ * Raw mouse motion is closer to the actual motion of the mouse across
+ * a surface. It is not affected by the scaling and acceleration applied to
+ * the motion of the desktop cursor. That processing is suitable for a cursor
+ * while raw motion is better for controlling for example a 3D camera. Because
+ * of this, raw mouse motion is only provided when the cursor is disabled.
+ *
+ * @return `GLFW_TRUE` if raw mouse motion is supported on the current machine,
+ * or `GLFW_FALSE` otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref raw_mouse_motion
+ * @sa @ref glfwSetInputMode
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwRawMouseMotionSupported(void);
+
+ /*! @brief Returns the layout-specific name of the specified printable key.
+ *
+ * This function returns the name of the specified printable key, encoded as
+ * UTF-8. This is typically the character that key would produce without any
+ * modifier keys, intended for displaying key bindings to the user. For dead
+ * keys, it is typically the diacritic it would add to a character.
+ *
+ * __Do not use this function__ for [text input](@ref input_char). You will
+ * break text input for many languages even if it happens to work for yours.
+ *
+ * If the key is `GLFW_KEY_UNKNOWN`, the scancode is used to identify the key,
+ * otherwise the scancode is ignored. If you specify a non-printable key, or
+ * `GLFW_KEY_UNKNOWN` and a scancode that maps to a non-printable key, this
+ * function returns `NULL` but does not emit an error.
+ *
+ * This behavior allows you to always pass in the arguments in the
+ * [key callback](@ref input_key) without modification.
+ *
+ * The printable keys are:
+ * - `GLFW_KEY_APOSTROPHE`
+ * - `GLFW_KEY_COMMA`
+ * - `GLFW_KEY_MINUS`
+ * - `GLFW_KEY_PERIOD`
+ * - `GLFW_KEY_SLASH`
+ * - `GLFW_KEY_SEMICOLON`
+ * - `GLFW_KEY_EQUAL`
+ * - `GLFW_KEY_LEFT_BRACKET`
+ * - `GLFW_KEY_RIGHT_BRACKET`
+ * - `GLFW_KEY_BACKSLASH`
+ * - `GLFW_KEY_WORLD_1`
+ * - `GLFW_KEY_WORLD_2`
+ * - `GLFW_KEY_0` to `GLFW_KEY_9`
+ * - `GLFW_KEY_A` to `GLFW_KEY_Z`
+ * - `GLFW_KEY_KP_0` to `GLFW_KEY_KP_9`
+ * - `GLFW_KEY_KP_DECIMAL`
+ * - `GLFW_KEY_KP_DIVIDE`
+ * - `GLFW_KEY_KP_MULTIPLY`
+ * - `GLFW_KEY_KP_SUBTRACT`
+ * - `GLFW_KEY_KP_ADD`
+ * - `GLFW_KEY_KP_EQUAL`
+ *
+ * Names for printable keys depend on keyboard layout, while names for
+ * non-printable keys are the same across layouts but depend on the application
+ * language and should be localized along with other user interface text.
+ *
+ * @param[in] key The key to query, or `GLFW_KEY_UNKNOWN`.
+ * @param[in] scancode The scancode of the key to query.
+ * @return The UTF-8 encoded, layout-specific name of the key, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE, @ref GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark The contents of the returned string may change when a keyboard
+ * layout change event is received.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_key_name
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const char* glfwGetKeyName(int key, int scancode);
+
+ /*! @brief Returns the platform-specific scancode of the specified key.
+ *
+ * This function returns the platform-specific scancode of the specified key.
+ *
+ * If the specified [key token](@ref keys) corresponds to a physical key not
+ * supported on the current platform then this method will return `-1`.
+ * Calling this function with anything other than a key token will return `-1`
+ * and generate a @ref GLFW_INVALID_ENUM error.
+ *
+ * @param[in] key Any [key token](@ref keys).
+ * @return The platform-specific scancode for the key, or `-1` if the key is
+ * not supported on the current platform or an [error](@ref error_handling)
+ * occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref input_key
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwGetKeyScancode(int key);
+
+ /*! @brief Returns the last reported state of a keyboard key for the specified
+ * window.
+ *
+ * This function returns the last state reported for the specified key to the
+ * specified window. The returned state is one of `GLFW_PRESS` or
+ * `GLFW_RELEASE`. The action `GLFW_REPEAT` is only reported to the key callback.
+ *
+ * If the @ref GLFW_STICKY_KEYS input mode is enabled, this function returns
+ * `GLFW_PRESS` the first time you call it for a key that was pressed, even if
+ * that key has already been released.
+ *
+ * The key functions deal with physical keys, with [key tokens](@ref keys)
+ * named after their use on the standard US keyboard layout. If you want to
+ * input text, use the Unicode character callback instead.
+ *
+ * The [modifier key bit masks](@ref mods) are not key tokens and cannot be
+ * used with this function.
+ *
+ * __Do not use this function__ to implement [text input](@ref input_char).
+ *
+ * @param[in] window The desired window.
+ * @param[in] key The desired [keyboard key](@ref keys). `GLFW_KEY_UNKNOWN` is
+ * not a valid key for this function.
+ * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_key
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
+
+ /*! @brief Returns the last reported state of a mouse button for the specified
+ * window.
+ *
+ * This function returns the last state reported for the specified mouse button
+ * to the specified window. The returned state is one of `GLFW_PRESS` or
+ * `GLFW_RELEASE`.
+ *
+ * If the @ref GLFW_STICKY_MOUSE_BUTTONS input mode is enabled, this function
+ * returns `GLFW_PRESS` the first time you call it for a mouse button that was
+ * pressed, even if that mouse button has already been released.
+ *
+ * The @ref GLFW_UNLIMITED_MOUSE_BUTTONS input mode does not effect the
+ * limit on buttons which can be polled with this function.
+ *
+ * @param[in] window The desired window.
+ * @param[in] button The desired [mouse button token](@ref buttons).
+ * @return One of `GLFW_PRESS` or `GLFW_RELEASE`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_mouse_button
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
+
+ /*! @brief Retrieves the position of the cursor relative to the content area of
+ * the window.
+ *
+ * This function returns the position of the cursor, in screen coordinates,
+ * relative to the upper-left corner of the content area of the specified
+ * window.
+ *
+ * If the cursor is disabled (with `GLFW_CURSOR_DISABLED`) then the cursor
+ * position is unbounded and limited only by the minimum and maximum values of
+ * a `double`.
+ *
+ * The coordinate can be converted to their integer equivalents with the
+ * `floor` function. Casting directly to an integer type works for positive
+ * coordinates, but fails for negative ones.
+ *
+ * Any or all of the position arguments may be `NULL`. If an error occurs, all
+ * non-`NULL` position arguments will be set to zero.
+ *
+ * @param[in] window The desired window.
+ * @param[out] xpos Where to store the cursor x-coordinate, relative to the
+ * left edge of the content area, or `NULL`.
+ * @param[out] ypos Where to store the cursor y-coordinate, relative to the to
+ * top edge of the content area, or `NULL`.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
+ * @sa @ref glfwSetCursorPos
+ *
+ * @since Added in version 3.0. Replaces `glfwGetMousePos`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
+
+ /*! @brief Sets the position of the cursor, relative to the content area of the
+ * window.
+ *
+ * This function sets the position, in screen coordinates, of the cursor
+ * relative to the upper-left corner of the content area of the specified
+ * window. The window must have input focus. If the window does not have
+ * input focus when this function is called, it fails silently.
+ *
+ * __Do not use this function__ to implement things like camera controls. GLFW
+ * already provides the `GLFW_CURSOR_DISABLED` cursor mode that hides the
+ * cursor, transparently re-centers it and provides unconstrained cursor
+ * motion. See @ref glfwSetInputMode for more information.
+ *
+ * If the cursor mode is `GLFW_CURSOR_DISABLED` then the cursor position is
+ * unconstrained and limited only by the minimum and maximum values of
+ * a `double`.
+ *
+ * @param[in] window The desired window.
+ * @param[in] xpos The desired x-coordinate, relative to the left edge of the
+ * content area.
+ * @param[in] ypos The desired y-coordinate, relative to the top edge of the
+ * content area.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_PLATFORM_ERROR and @ref GLFW_FEATURE_UNAVAILABLE (see remarks).
+ *
+ * @remark @wayland This function will only work when the cursor mode is
+ * `GLFW_CURSOR_DISABLED`, otherwise it will emit @ref GLFW_FEATURE_UNAVAILABLE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
+ * @sa @ref glfwGetCursorPos
+ *
+ * @since Added in version 3.0. Replaces `glfwSetMousePos`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
+
+ /*! @brief Creates a custom cursor.
+ *
+ * Creates a new custom cursor image that can be set for a window with @ref
+ * glfwSetCursor. The cursor can be destroyed with @ref glfwDestroyCursor.
+ * Any remaining cursors are destroyed by @ref glfwTerminate.
+ *
+ * The pixels are 32-bit, little-endian, non-premultiplied RGBA, i.e. eight
+ * bits per channel with the red channel first. They are arranged canonically
+ * as packed sequential rows, starting from the top-left corner.
+ *
+ * The cursor hotspot is specified in pixels, relative to the upper-left corner
+ * of the cursor image. Like all other coordinate systems in GLFW, the X-axis
+ * points to the right and the Y-axis points down.
+ *
+ * @param[in] image The desired cursor image.
+ * @param[in] xhot The desired x-coordinate, in pixels, of the cursor hotspot.
+ * @param[in] yhot The desired y-coordinate, in pixels, of the cursor hotspot.
+ * @return The handle of the created cursor, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_VALUE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The specified image data is copied before this function
+ * returns.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ * @sa @ref glfwDestroyCursor
+ * @sa @ref glfwCreateStandardCursor
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
+
+ /*! @brief Creates a cursor with a standard shape.
+ *
+ * Returns a cursor with a standard shape, that can be set for a window with
+ * @ref glfwSetCursor. The images for these cursors come from the system
+ * cursor theme and their exact appearance will vary between platforms.
+ *
+ * Most of these shapes are guaranteed to exist on every supported platform but
+ * a few may not be present. See the table below for details.
+ *
+ * Cursor shape | Windows | macOS | X11 | Wayland
+ * ------------------------------ | ------- | ----- | ------ | -------
+ * @ref GLFW_ARROW_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_IBEAM_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_CROSSHAIR_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_POINTING_HAND_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_RESIZE_EW_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_RESIZE_NS_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_RESIZE_NWSE_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
+ * @ref GLFW_RESIZE_NESW_CURSOR | Yes | Yes<sup>1</sup> | Maybe<sup>2</sup> | Maybe<sup>2</sup>
+ * @ref GLFW_RESIZE_ALL_CURSOR | Yes | Yes | Yes | Yes
+ * @ref GLFW_NOT_ALLOWED_CURSOR | Yes | Yes | Maybe<sup>2</sup> | Maybe<sup>2</sup>
+ *
+ * 1) This uses a private system API and may fail in the future.
+ *
+ * 2) This uses a newer standard that not all cursor themes support.
+ *
+ * If the requested shape is not available, this function emits a @ref
+ * GLFW_CURSOR_UNAVAILABLE error and returns `NULL`.
+ *
+ * @param[in] shape One of the [standard shapes](@ref shapes).
+ * @return A new cursor ready to use or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM, @ref GLFW_CURSOR_UNAVAILABLE and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_standard
+ * @sa @ref glfwCreateCursor
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
+
+ /*! @brief Destroys a cursor.
+ *
+ * This function destroys a cursor previously created with @ref
+ * glfwCreateCursor. Any remaining cursors will be destroyed by @ref
+ * glfwTerminate.
+ *
+ * If the specified cursor is current for any window, that window will be
+ * reverted to the default cursor. This does not affect the cursor mode.
+ *
+ * @param[in] cursor The cursor object to destroy.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @reentrancy This function must not be called from a callback.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ * @sa @ref glfwCreateCursor
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
+
+ /*! @brief Sets the cursor for the window.
+ *
+ * This function sets the cursor image to be used when the cursor is over the
+ * content area of the specified window. The set cursor will only be visible
+ * when the [cursor mode](@ref cursor_mode) of the window is
+ * `GLFW_CURSOR_NORMAL`.
+ *
+ * On some platforms, the set cursor may not be visible unless the window also
+ * has input focus.
+ *
+ * @param[in] window The window to set the cursor for.
+ * @param[in] cursor The cursor to set, or `NULL` to switch back to the default
+ * arrow cursor.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_object
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
+
+ /*! @brief Sets the key callback.
+ *
+ * This function sets the key callback of the specified window, which is called
+ * when a key is pressed, repeated or released.
+ *
+ * The key functions deal with physical keys, with layout independent
+ * [key tokens](@ref keys) named after their values in the standard US keyboard
+ * layout. If you want to input text, use the
+ * [character callback](@ref glfwSetCharCallback) instead.
+ *
+ * When a window loses input focus, it will generate synthetic key release
+ * events for all pressed keys with associated key tokens. You can tell these
+ * events from user-generated events by the fact that the synthetic ones are
+ * generated after the focus loss event has been processed, i.e. after the
+ * [window focus callback](@ref glfwSetWindowFocusCallback) has been called.
+ *
+ * The scancode of a key is specific to that platform or sometimes even to that
+ * machine. Scancodes are intended to allow users to bind keys that don't have
+ * a GLFW key token. Such keys have `key` set to `GLFW_KEY_UNKNOWN`, their
+ * state is not saved and so it cannot be queried with @ref glfwGetKey.
+ *
+ * Sometimes GLFW needs to generate synthetic key events, in which case the
+ * scancode may be zero.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new key callback, or `NULL` to remove the currently
+ * set callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWkeyfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_key
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);
+
+ /*! @brief Sets the Unicode character callback.
+ *
+ * This function sets the character callback of the specified window, which is
+ * called when a Unicode character is input.
+ *
+ * The character callback is intended for Unicode text input. As it deals with
+ * characters, it is keyboard layout dependent, whereas the
+ * [key callback](@ref glfwSetKeyCallback) is not. Characters do not map 1:1
+ * to physical keys, as a key may produce zero, one or more characters. If you
+ * want to know whether a specific physical key was pressed or released, see
+ * the key callback instead.
+ *
+ * The character callback behaves as system text input normally does and will
+ * not be called if modifier keys are held down that would prevent normal text
+ * input on that platform, for example a Super (Command) key on macOS or Alt key
+ * on Windows.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, unsigned int codepoint)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWcharfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_char
+ *
+ * @since Added in version 2.4.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);
+
+ /*! @brief Sets the Unicode character with modifiers callback.
+ *
+ * This function sets the character with modifiers callback of the specified
+ * window, which is called when a Unicode character is input regardless of what
+ * modifier keys are used.
+ *
+ * The character with modifiers callback is intended for implementing custom
+ * Unicode character input. For regular Unicode text input, see the
+ * [character callback](@ref glfwSetCharCallback). Like the character
+ * callback, the character with modifiers callback deals with characters and is
+ * keyboard layout dependent. Characters do not map 1:1 to physical keys, as
+ * a key may produce zero, one or more characters. If you want to know whether
+ * a specific physical key was pressed or released, see the
+ * [key callback](@ref glfwSetKeyCallback) instead.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or an
+ * [error](@ref error_handling) occurred.
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWcharmodsfun).
+ *
+ * @deprecated Scheduled for removal in version 4.0.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_char
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun callback);
+
+ /*! @brief Sets the mouse button callback.
+ *
+ * This function sets the mouse button callback of the specified window, which
+ * is called when a mouse button is pressed or released.
+ *
+ * When a window loses input focus, it will generate synthetic mouse button
+ * release events for all pressed mouse buttons with associated button tokens.
+ * You can tell these events from user-generated events by the fact that the
+ * synthetic ones are generated after the focus loss event has been processed,
+ * i.e. after the [window focus callback](@ref glfwSetWindowFocusCallback) has
+ * been called.
+ *
+ * The reported `button` value can be higher than `GLFW_MOUSE_BUTTON_LAST` if
+ * the button does not have an associated [button token](@ref buttons) and the
+ * @ref GLFW_UNLIMITED_MOUSE_BUTTONS input mode is set.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int button, int action, int mods)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWmousebuttonfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref input_mouse_button
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter and return value.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun callback);
+
+ /*! @brief Sets the cursor position callback.
+ *
+ * This function sets the cursor position callback of the specified window,
+ * which is called when the cursor is moved. The callback is provided with the
+ * position, in screen coordinates, relative to the upper-left corner of the
+ * content area of the window.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, double xpos, double ypos);
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWcursorposfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_pos
+ *
+ * @since Added in version 3.0. Replaces `glfwSetMousePosCallback`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun callback);
+
+ /*! @brief Sets the cursor enter/leave callback.
+ *
+ * This function sets the cursor boundary crossing callback of the specified
+ * window, which is called when the cursor enters or leaves the content area of
+ * the window.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int entered)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWcursorenterfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref cursor_enter
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun callback);
+
+ /*! @brief Sets the scroll callback.
+ *
+ * This function sets the scroll callback of the specified window, which is
+ * called when a scrolling device is used, such as a mouse wheel or scrolling
+ * area of a touchpad.
+ *
+ * The scroll callback receives all scrolling input, like that from a mouse
+ * wheel or a touchpad scrolling area.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new scroll callback, or `NULL` to remove the
+ * currently set callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, double xoffset, double yoffset)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWscrollfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref scrolling
+ *
+ * @since Added in version 3.0. Replaces `glfwSetMouseWheelCallback`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);
+
+ /*! @brief Sets the path drop callback.
+ *
+ * This function sets the path drop callback of the specified window, which is
+ * called when one or more dragged paths are dropped on the window.
+ *
+ * Because the path array and its strings may have been generated specifically
+ * for that event, they are not guaranteed to be valid after the callback has
+ * returned. If you wish to use them after the callback returns, you need to
+ * make a deep copy.
+ *
+ * @param[in] window The window whose callback to set.
+ * @param[in] callback The new file drop callback, or `NULL` to remove the
+ * currently set callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(GLFWwindow* window, int path_count, const char* paths[])
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWdropfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref path_drop
+ *
+ * @since Added in version 3.1.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);
+
+ /*! @brief Returns whether the specified joystick is present.
+ *
+ * This function returns whether the specified joystick is present.
+ *
+ * There is no need to call this function before other functions that accept
+ * a joystick ID, as they all check for presence before performing any other
+ * work.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @return `GLFW_TRUE` if the joystick is present, or `GLFW_FALSE` otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick
+ *
+ * @since Added in version 3.0. Replaces `glfwGetJoystickParam`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwJoystickPresent(int jid);
+
+ /*! @brief Returns the values of all axes of the specified joystick.
+ *
+ * This function returns the values of all axes of the specified joystick.
+ * Each element in the array is a value between -1.0 and 1.0.
+ *
+ * If the specified joystick is not present this function will return `NULL`
+ * but will not generate an error. This can be used instead of first calling
+ * @ref glfwJoystickPresent.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @param[out] count Where to store the number of axis values in the returned
+ * array. This is set to zero if the joystick is not present or an error
+ * occurred.
+ * @return An array of axis values, or `NULL` if the joystick is not present or
+ * an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick_axis
+ *
+ * @since Added in version 3.0. Replaces `glfwGetJoystickPos`.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);
+
+ /*! @brief Returns the state of all buttons of the specified joystick.
+ *
+ * This function returns the state of all buttons of the specified joystick.
+ * Each element in the array is either `GLFW_PRESS` or `GLFW_RELEASE`.
+ *
+ * For backward compatibility with earlier versions that did not have @ref
+ * glfwGetJoystickHats, the button array also includes all hats, each
+ * represented as four buttons. The hats are in the same order as returned by
+ * __glfwGetJoystickHats__ and are in the order _up_, _right_, _down_ and
+ * _left_. To disable these extra buttons, set the @ref
+ * GLFW_JOYSTICK_HAT_BUTTONS init hint before initialization.
+ *
+ * If the specified joystick is not present this function will return `NULL`
+ * but will not generate an error. This can be used instead of first calling
+ * @ref glfwJoystickPresent.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @param[out] count Where to store the number of button states in the returned
+ * array. This is set to zero if the joystick is not present or an error
+ * occurred.
+ * @return An array of button states, or `NULL` if the joystick is not present
+ * or an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick_button
+ *
+ * @since Added in version 2.2.
+ * @glfw3 Changed to return a dynamic array.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);
+
+ /*! @brief Returns the state of all hats of the specified joystick.
+ *
+ * This function returns the state of all hats of the specified joystick.
+ * Each element in the array is one of the following values:
+ *
+ * Name | Value
+ * ---- | -----
+ * `GLFW_HAT_CENTERED` | 0
+ * `GLFW_HAT_UP` | 1
+ * `GLFW_HAT_RIGHT` | 2
+ * `GLFW_HAT_DOWN` | 4
+ * `GLFW_HAT_LEFT` | 8
+ * `GLFW_HAT_RIGHT_UP` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_UP`
+ * `GLFW_HAT_RIGHT_DOWN` | `GLFW_HAT_RIGHT` \| `GLFW_HAT_DOWN`
+ * `GLFW_HAT_LEFT_UP` | `GLFW_HAT_LEFT` \| `GLFW_HAT_UP`
+ * `GLFW_HAT_LEFT_DOWN` | `GLFW_HAT_LEFT` \| `GLFW_HAT_DOWN`
+ *
+ * The diagonal directions are bitwise combinations of the primary (up, right,
+ * down and left) directions and you can test for these individually by ANDing
+ * it with the corresponding direction.
+ *
+ * @code
+ * if (hats[2] & GLFW_HAT_RIGHT)
+ * {
+ * // State of hat 2 could be right-up, right or right-down
+ * }
+ * @endcode
+ *
+ * If the specified joystick is not present this function will return `NULL`
+ * but will not generate an error. This can be used instead of first calling
+ * @ref glfwJoystickPresent.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @param[out] count Where to store the number of hat states in the returned
+ * array. This is set to zero if the joystick is not present or an error
+ * occurred.
+ * @return An array of hat states, or `NULL` if the joystick is not present
+ * or an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected, this function is called again for that joystick or the library
+ * is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick_hat
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);
+
+ /*! @brief Returns the name of the specified joystick.
+ *
+ * This function returns the name, encoded as UTF-8, of the specified joystick.
+ * The returned string is allocated and freed by GLFW. You should not free it
+ * yourself.
+ *
+ * If the specified joystick is not present this function will return `NULL`
+ * but will not generate an error. This can be used instead of first calling
+ * @ref glfwJoystickPresent.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @return The UTF-8 encoded name of the joystick, or `NULL` if the joystick
+ * is not present or an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick_name
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const char* glfwGetJoystickName(int jid);
+
+ /*! @brief Returns the SDL compatible GUID of the specified joystick.
+ *
+ * This function returns the SDL compatible GUID, as a UTF-8 encoded
+ * hexadecimal string, of the specified joystick. The returned string is
+ * allocated and freed by GLFW. You should not free it yourself.
+ *
+ * The GUID is what connects a joystick to a gamepad mapping. A connected
+ * joystick will always have a GUID even if there is no gamepad mapping
+ * assigned to it.
+ *
+ * If the specified joystick is not present this function will return `NULL`
+ * but will not generate an error. This can be used instead of first calling
+ * @ref glfwJoystickPresent.
+ *
+ * The GUID uses the format introduced in SDL 2.0.5. This GUID tries to
+ * uniquely identify the make and model of a joystick but does not identify
+ * a specific unit, e.g. all wired Xbox 360 controllers will have the same
+ * GUID on that platform. The GUID for a unit may vary between platforms
+ * depending on what hardware information the platform specific APIs provide.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @return The UTF-8 encoded GUID of the joystick, or `NULL` if the joystick
+ * is not present or an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_INVALID_ENUM and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref gamepad
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const char* glfwGetJoystickGUID(int jid);
+
+ /*! @brief Sets the user pointer of the specified joystick.
+ *
+ * This function sets the user-defined pointer of the specified joystick. The
+ * current value is retained until the joystick is disconnected. The initial
+ * value is `NULL`.
+ *
+ * This function may be called from the joystick callback, even for a joystick
+ * that is being disconnected.
+ *
+ * @param[in] jid The joystick whose pointer to set.
+ * @param[in] pointer The new value.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref joystick_userptr
+ * @sa @ref glfwGetJoystickUserPointer
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);
+
+ /*! @brief Returns the user pointer of the specified joystick.
+ *
+ * This function returns the current value of the user-defined pointer of the
+ * specified joystick. The initial value is `NULL`.
+ *
+ * This function may be called from the joystick callback, even for a joystick
+ * that is being disconnected.
+ *
+ * @param[in] jid The joystick whose pointer to return.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Access is not
+ * synchronized.
+ *
+ * @sa @ref joystick_userptr
+ * @sa @ref glfwSetJoystickUserPointer
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void* glfwGetJoystickUserPointer(int jid);
+
+ /*! @brief Returns whether the specified joystick has a gamepad mapping.
+ *
+ * This function returns whether the specified joystick is both present and has
+ * a gamepad mapping.
+ *
+ * If the specified joystick is present but does not have a gamepad mapping
+ * this function will return `GLFW_FALSE` but will not generate an error. Call
+ * @ref glfwJoystickPresent to check if a joystick is present regardless of
+ * whether it has a mapping.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @return `GLFW_TRUE` if a joystick is both present and has a gamepad mapping,
+ * or `GLFW_FALSE` otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref gamepad
+ * @sa @ref glfwGetGamepadState
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwJoystickIsGamepad(int jid);
+
+ /*! @brief Sets the joystick configuration callback.
+ *
+ * This function sets the joystick configuration callback, or removes the
+ * currently set callback. This is called when a joystick is connected to or
+ * disconnected from the system.
+ *
+ * For joystick connection and disconnection events to be delivered on all
+ * platforms, you need to call one of the [event processing](@ref events)
+ * functions. Joystick disconnection may also be detected and the callback
+ * called by joystick functions. The function will then return whatever it
+ * returns if the joystick is not present.
+ *
+ * @param[in] callback The new callback, or `NULL` to remove the currently set
+ * callback.
+ * @return The previously set callback, or `NULL` if no callback was set or the
+ * library had not been [initialized](@ref intro_init).
+ *
+ * @callback_signature
+ * @code
+ * void function_name(int jid, int event)
+ * @endcode
+ * For more information about the callback parameters, see the
+ * [function pointer type](@ref GLFWjoystickfun).
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref joystick_event
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup input
+ */
+ GLFWAPI GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback);
+
+ /*! @brief Adds the specified SDL_GameControllerDB gamepad mappings.
+ *
+ * This function parses the specified ASCII encoded string and updates the
+ * internal list with any gamepad mappings it finds. This string may
+ * contain either a single gamepad mapping or many mappings separated by
+ * newlines. The parser supports the full format of the `gamecontrollerdb.txt`
+ * source file including empty lines and comments.
+ *
+ * See @ref gamepad_mapping for a description of the format.
+ *
+ * If there is already a gamepad mapping for a given GUID in the internal list,
+ * it will be replaced by the one passed to this function. If the library is
+ * terminated and re-initialized the internal list will revert to the built-in
+ * default.
+ *
+ * @param[in] string The string containing the gamepad mappings.
+ * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_VALUE.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref gamepad
+ * @sa @ref glfwJoystickIsGamepad
+ * @sa @ref glfwGetGamepadName
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwUpdateGamepadMappings(const char* string);
+
+ /*! @brief Returns the human-readable gamepad name for the specified joystick.
+ *
+ * This function returns the human-readable name of the gamepad from the
+ * gamepad mapping assigned to the specified joystick.
+ *
+ * If the specified joystick is not present or does not have a gamepad mapping
+ * this function will return `NULL` but will not generate an error. Call
+ * @ref glfwJoystickPresent to check whether it is present regardless of
+ * whether it has a mapping.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @return The UTF-8 encoded name of the gamepad, or `NULL` if the
+ * joystick is not present, does not have a mapping or an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref GLFW_INVALID_ENUM.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the specified joystick is
+ * disconnected, the gamepad mappings are updated or the library is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref gamepad
+ * @sa @ref glfwJoystickIsGamepad
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const char* glfwGetGamepadName(int jid);
+
+ /*! @brief Retrieves the state of the specified joystick remapped as a gamepad.
+ *
+ * This function retrieves the state of the specified joystick remapped to
+ * an Xbox-like gamepad.
+ *
+ * If the specified joystick is not present or does not have a gamepad mapping
+ * this function will return `GLFW_FALSE` but will not generate an error. Call
+ * @ref glfwJoystickPresent to check whether it is present regardless of
+ * whether it has a mapping.
+ *
+ * The Guide button may not be available for input as it is often hooked by the
+ * system or the Steam client.
+ *
+ * Not all devices have all the buttons or axes provided by @ref
+ * GLFWgamepadstate. Unavailable buttons and axes will always report
+ * `GLFW_RELEASE` and 0.0 respectively.
+ *
+ * @param[in] jid The [joystick](@ref joysticks) to query.
+ * @param[out] state The gamepad input state of the joystick.
+ * @return `GLFW_TRUE` if successful, or `GLFW_FALSE` if no joystick is
+ * connected, it has no gamepad mapping or an [error](@ref error_handling)
+ * occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_ENUM.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref gamepad
+ * @sa @ref glfwUpdateGamepadMappings
+ * @sa @ref glfwJoystickIsGamepad
+ *
+ * @since Added in version 3.3.
+ *
+ * @ingroup input
+ */
+ GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);
+
+ /*! @brief Sets the clipboard to the specified string.
+ *
+ * This function sets the system clipboard to the specified, UTF-8 encoded
+ * string.
+ *
+ * @param[in] window Deprecated. Any valid window or `NULL`.
+ * @param[in] string A UTF-8 encoded string.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @remark @win32 The clipboard on Windows has a single global lock for reading and
+ * writing. GLFW tries to acquire it a few times, which is almost always enough. If it
+ * cannot acquire the lock then this function emits @ref GLFW_PLATFORM_ERROR and returns.
+ * It is safe to try this multiple times.
+ *
+ * @pointer_lifetime The specified string is copied before this function
+ * returns.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref clipboard
+ * @sa @ref glfwGetClipboardString
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
+
+ /*! @brief Returns the contents of the clipboard as a string.
+ *
+ * This function returns the contents of the system clipboard, if it contains
+ * or is convertible to a UTF-8 encoded string. If the clipboard is empty or
+ * if its contents cannot be converted, `NULL` is returned and a @ref
+ * GLFW_FORMAT_UNAVAILABLE error is generated.
+ *
+ * @param[in] window Deprecated. Any valid window or `NULL`.
+ * @return The contents of the clipboard as a UTF-8 encoded string, or `NULL`
+ * if an [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_FORMAT_UNAVAILABLE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark @win32 The clipboard on Windows has a single global lock for reading and
+ * writing. GLFW tries to acquire it a few times, which is almost always enough. If it
+ * cannot acquire the lock then this function emits @ref GLFW_PLATFORM_ERROR and returns.
+ * It is safe to try this multiple times.
+ *
+ * @pointer_lifetime The returned string is allocated and freed by GLFW. You
+ * should not free it yourself. It is valid until the next call to @ref
+ * glfwGetClipboardString or @ref glfwSetClipboardString, or until the library
+ * is terminated.
+ *
+ * @thread_safety This function must only be called from the main thread.
+ *
+ * @sa @ref clipboard
+ * @sa @ref glfwSetClipboardString
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
+
+ /*! @brief Returns the GLFW time.
+ *
+ * This function returns the current GLFW time, in seconds. Unless the time
+ * has been set using @ref glfwSetTime it measures time elapsed since GLFW was
+ * initialized.
+ *
+ * This function and @ref glfwSetTime are helper functions on top of @ref
+ * glfwGetTimerFrequency and @ref glfwGetTimerValue.
+ *
+ * The resolution of the timer is system dependent, but is usually on the order
+ * of a few micro- or nanoseconds. It uses the highest-resolution monotonic
+ * time source on each operating system.
+ *
+ * @return The current time, in seconds, or zero if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread. Reading and
+ * writing of the internal base time is not atomic, so it needs to be
+ * externally synchronized with calls to @ref glfwSetTime.
+ *
+ * @sa @ref time
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup input
+ */
+ GLFWAPI double glfwGetTime(void);
+
+ /*! @brief Sets the GLFW time.
+ *
+ * This function sets the current GLFW time, in seconds. The value must be
+ * a positive finite number less than or equal to 18446744073.0, which is
+ * approximately 584.5 years.
+ *
+ * This function and @ref glfwGetTime are helper functions on top of @ref
+ * glfwGetTimerFrequency and @ref glfwGetTimerValue.
+ *
+ * @param[in] time The new value, in seconds.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_INVALID_VALUE.
+ *
+ * @remark The upper limit of GLFW time is calculated as
+ * floor((2<sup>64</sup> - 1) / 10<sup>9</sup>) and is due to implementations
+ * storing nanoseconds in 64 bits. The limit may be increased in the future.
+ *
+ * @thread_safety This function may be called from any thread. Reading and
+ * writing of the internal base time is not atomic, so it needs to be
+ * externally synchronized with calls to @ref glfwGetTime.
+ *
+ * @sa @ref time
+ *
+ * @since Added in version 2.2.
+ *
+ * @ingroup input
+ */
+ GLFWAPI void glfwSetTime(double time);
+
+ /*! @brief Returns the current value of the raw timer.
+ *
+ * This function returns the current value of the raw timer, measured in
+ * 1&nbsp;/&nbsp;frequency seconds. To get the frequency, call @ref
+ * glfwGetTimerFrequency.
+ *
+ * @return The value of the timer, or zero if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref time
+ * @sa @ref glfwGetTimerFrequency
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup input
+ */
+ GLFWAPI uint64_t glfwGetTimerValue(void);
+
+ /*! @brief Returns the frequency, in Hz, of the raw timer.
+ *
+ * This function returns the frequency, in Hz, of the raw timer.
+ *
+ * @return The frequency of the timer, in Hz, or zero if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref time
+ * @sa @ref glfwGetTimerValue
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup input
+ */
+ GLFWAPI uint64_t glfwGetTimerFrequency(void);
+
+ /*! @brief Makes the context of the specified window current for the calling
+ * thread.
+ *
+ * This function makes the OpenGL or OpenGL ES context of the specified window
+ * current on the calling thread. It can also detach the current context from
+ * the calling thread without making a new one current by passing in `NULL`.
+ *
+ * A context must only be made current on a single thread at a time and each
+ * thread can have only a single current context at a time. Making a context
+ * current detaches any previously current context on the calling thread.
+ *
+ * When moving a context between threads, you must detach it (make it
+ * non-current) on the old thread before making it current on the new one.
+ *
+ * By default, making a context non-current implicitly forces a pipeline flush.
+ * On machines that support `GL_KHR_context_flush_control`, you can control
+ * whether a context performs this flush by setting the
+ * [GLFW_CONTEXT_RELEASE_BEHAVIOR](@ref GLFW_CONTEXT_RELEASE_BEHAVIOR_hint)
+ * hint.
+ *
+ * The specified window must have an OpenGL or OpenGL ES context. Specifying
+ * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
+ * error.
+ *
+ * @param[in] window The window whose context to make current, or `NULL` to
+ * detach the current context.
+ *
+ * @remarks If the previously current context was created via a different
+ * context creation API than the one passed to this function, GLFW will still
+ * detach the previous one from its API before making the new one current.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref context_current
+ * @sa @ref glfwGetCurrentContext
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup context
+ */
+ GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
+
+ /*! @brief Returns the window whose context is current on the calling thread.
+ *
+ * This function returns the window whose OpenGL or OpenGL ES context is
+ * current on the calling thread.
+ *
+ * @return The window whose context is current, or `NULL` if no window's
+ * context is current.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref context_current
+ * @sa @ref glfwMakeContextCurrent
+ *
+ * @since Added in version 3.0.
+ *
+ * @ingroup context
+ */
+ GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
+
+ /*! @brief Swaps the front and back buffers of the specified window.
+ *
+ * This function swaps the front and back buffers of the specified window when
+ * rendering with OpenGL or OpenGL ES. If the swap interval is greater than
+ * zero, the GPU driver waits the specified number of screen updates before
+ * swapping the buffers.
+ *
+ * The specified window must have an OpenGL or OpenGL ES context. Specifying
+ * a window without a context will generate a @ref GLFW_NO_WINDOW_CONTEXT
+ * error.
+ *
+ * This function does not apply to Vulkan. If you are rendering with Vulkan,
+ * see `vkQueuePresentKHR` instead.
+ *
+ * @param[in] window The window whose buffers to swap.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_NO_WINDOW_CONTEXT and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark __EGL:__ The context of the specified window must be current on the
+ * calling thread.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref buffer_swap
+ * @sa @ref glfwSwapInterval
+ *
+ * @since Added in version 1.0.
+ * @glfw3 Added window handle parameter.
+ *
+ * @ingroup window
+ */
+ GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
+
+ /*! @brief Sets the swap interval for the current context.
+ *
+ * This function sets the swap interval for the current OpenGL or OpenGL ES
+ * context, i.e. the number of screen updates to wait from the time @ref
+ * glfwSwapBuffers was called before swapping the buffers and returning. This
+ * is sometimes called _vertical synchronization_, _vertical retrace
+ * synchronization_ or just _vsync_.
+ *
+ * A context that supports either of the `WGL_EXT_swap_control_tear` and
+ * `GLX_EXT_swap_control_tear` extensions also accepts _negative_ swap
+ * intervals, which allows the driver to swap immediately even if a frame
+ * arrives a little bit late. You can check for these extensions with @ref
+ * glfwExtensionSupported.
+ *
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
+ * This function does not apply to Vulkan. If you are rendering with Vulkan,
+ * see the present mode of your swapchain instead.
+ *
+ * @param[in] interval The minimum number of screen updates to wait for
+ * until the buffers are swapped by @ref glfwSwapBuffers.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark This function is not called during context creation, leaving the
+ * swap interval set to whatever is the default for that API. This is done
+ * because some swap interval extensions used by GLFW do not allow the swap
+ * interval to be reset to zero once it has been set to a non-zero value.
+ *
+ * @remark Some GPU drivers do not honor the requested swap interval, either
+ * because of a user setting that overrides the application's request or due to
+ * bugs in the driver.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref buffer_swap
+ * @sa @ref glfwSwapBuffers
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup context
+ */
+ GLFWAPI void glfwSwapInterval(int interval);
+
+ /*! @brief Returns whether the specified extension is available.
+ *
+ * This function returns whether the specified
+ * [API extension](@ref context_glext) is supported by the current OpenGL or
+ * OpenGL ES context. It searches both for client API extension and context
+ * creation API extensions.
+ *
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
+ * As this functions retrieves and searches one or more extension strings each
+ * call, it is recommended that you cache its results if it is going to be used
+ * frequently. The extension strings will not change during the lifetime of
+ * a context, so there is no danger in doing this.
+ *
+ * This function does not apply to Vulkan. If you are using Vulkan, see @ref
+ * glfwGetRequiredInstanceExtensions, `vkEnumerateInstanceExtensionProperties`
+ * and `vkEnumerateDeviceExtensionProperties` instead.
+ *
+ * @param[in] extension The ASCII encoded name of the extension.
+ * @return `GLFW_TRUE` if the extension is available, or `GLFW_FALSE`
+ * otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_NO_CURRENT_CONTEXT, @ref GLFW_INVALID_VALUE and @ref
+ * GLFW_PLATFORM_ERROR.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref context_glext
+ * @sa @ref glfwGetProcAddress
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup context
+ */
+ GLFWAPI int glfwExtensionSupported(const char* extension);
+
+ /*! @brief Returns the address of the specified function for the current
+ * context.
+ *
+ * This function returns the address of the specified OpenGL or OpenGL ES
+ * [core or extension function](@ref context_glext), if it is supported
+ * by the current context.
+ *
+ * A context must be current on the calling thread. Calling this function
+ * without a current context will cause a @ref GLFW_NO_CURRENT_CONTEXT error.
+ *
+ * This function does not apply to Vulkan. If you are rendering with Vulkan,
+ * see @ref glfwGetInstanceProcAddress, `vkGetInstanceProcAddr` and
+ * `vkGetDeviceProcAddr` instead.
+ *
+ * @param[in] procname The ASCII encoded name of the function.
+ * @return The address of the function, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_NO_CURRENT_CONTEXT and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark The address of a given function is not guaranteed to be the same
+ * between contexts.
+ *
+ * @remark This function may return a non-`NULL` address despite the
+ * associated version or extension not being available. Always check the
+ * context version or extension string first.
+ *
+ * @pointer_lifetime The returned function pointer is valid until the context
+ * is destroyed or the library is terminated.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref context_glext
+ * @sa @ref glfwExtensionSupported
+ *
+ * @since Added in version 1.0.
+ *
+ * @ingroup context
+ */
+ GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);
+
+ /*! @brief Returns whether the Vulkan loader and an ICD have been found.
+ *
+ * This function returns whether the Vulkan loader and any minimally functional
+ * ICD have been found.
+ *
+ * The availability of a Vulkan loader and even an ICD does not by itself guarantee that
+ * surface creation or even instance creation is possible. Call @ref
+ * glfwGetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan
+ * surface creation are available and @ref glfwGetPhysicalDevicePresentationSupport to
+ * check whether a queue family of a physical device supports image presentation.
+ *
+ * @return `GLFW_TRUE` if Vulkan is minimally available, or `GLFW_FALSE`
+ * otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref vulkan_support
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
+ */
+ GLFWAPI int glfwVulkanSupported(void);
+
+ /*! @brief Returns the Vulkan instance extensions required by GLFW.
+ *
+ * This function returns an array of names of Vulkan instance extensions required
+ * by GLFW for creating Vulkan surfaces for GLFW windows. If successful, the
+ * list will always contain `VK_KHR_surface`, so if you don't require any
+ * additional extensions you can pass this list directly to the
+ * `VkInstanceCreateInfo` struct.
+ *
+ * If Vulkan is not available on the machine, this function returns `NULL` and
+ * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
+ * to check whether Vulkan is at least minimally available.
+ *
+ * If Vulkan is available but no set of extensions allowing window surface
+ * creation was found, this function returns `NULL`. You may still use Vulkan
+ * for off-screen rendering and compute work.
+ *
+ * @param[out] count Where to store the number of extensions in the returned
+ * array. This is set to zero if an error occurred.
+ * @return An array of ASCII encoded extension names, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_API_UNAVAILABLE.
+ *
+ * @remark Additional extensions may be required by future versions of GLFW.
+ * You should check if any extensions you wish to enable are already in the
+ * returned array, as it is an error to specify an extension more than once in
+ * the `VkInstanceCreateInfo` struct.
+ *
+ * @pointer_lifetime The returned array is allocated and freed by GLFW. You
+ * should not free it yourself. It is guaranteed to be valid only until the
+ * library is terminated.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref vulkan_ext
+ * @sa @ref glfwCreateWindowSurface
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
+ */
+ GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);
+
#if defined(VK_VERSION_1_0)
-
-/*! @brief Returns the address of the specified Vulkan instance function.
- *
- * This function returns the address of the specified Vulkan core or extension
- * function for the specified instance. If instance is set to `NULL` it can
- * return any function exported from the Vulkan loader, including at least the
- * following functions:
- *
- * - `vkEnumerateInstanceExtensionProperties`
- * - `vkEnumerateInstanceLayerProperties`
- * - `vkCreateInstance`
- * - `vkGetInstanceProcAddr`
- *
- * If Vulkan is not available on the machine, this function returns `NULL` and
- * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
- * to check whether Vulkan is at least minimally available.
- *
- * This function is equivalent to calling `vkGetInstanceProcAddr` with
- * a platform-specific query of the Vulkan loader as a fallback.
- *
- * @param[in] instance The Vulkan instance to query, or `NULL` to retrieve
- * functions related to instance creation.
- * @param[in] procname The ASCII encoded name of the function.
- * @return The address of the function, or `NULL` if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
- * GLFW_API_UNAVAILABLE.
- *
- * @pointer_lifetime The returned function pointer is valid until the library
- * is terminated.
- *
- * @thread_safety This function may be called from any thread.
- *
- * @sa @ref vulkan_proc
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);
-
-/*! @brief Returns whether the specified queue family can present images.
- *
- * This function returns whether the specified queue family of the specified
- * physical device supports presentation to the platform GLFW was built for.
- *
- * If Vulkan or the required window surface creation instance extensions are
- * not available on the machine, or if the specified instance was not created
- * with the required extensions, this function returns `GLFW_FALSE` and
- * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
- * to check whether Vulkan is at least minimally available and @ref
- * glfwGetRequiredInstanceExtensions to check what instance extensions are
- * required.
- *
- * @param[in] instance The instance that the physical device belongs to.
- * @param[in] device The physical device that the queue family belongs to.
- * @param[in] queuefamily The index of the queue family to query.
- * @return `GLFW_TRUE` if the queue family supports presentation, or
- * `GLFW_FALSE` otherwise.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_API_UNAVAILABLE and @ref GLFW_PLATFORM_ERROR.
- *
- * @remark @macos This function currently always returns `GLFW_TRUE`, as the
- * `VK_MVK_macos_surface` and `VK_EXT_metal_surface` extensions do not provide
- * a `vkGetPhysicalDevice*PresentationSupport` type function.
- *
- * @thread_safety This function may be called from any thread. For
- * synchronization details of Vulkan objects, see the Vulkan specification.
- *
- * @sa @ref vulkan_present
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);
-
-/*! @brief Creates a Vulkan surface for the specified window.
- *
- * This function creates a Vulkan surface for the specified window.
- *
- * If the Vulkan loader or at least one minimally functional ICD were not found,
- * this function returns `VK_ERROR_INITIALIZATION_FAILED` and generates a @ref
- * GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported to check whether
- * Vulkan is at least minimally available.
- *
- * If the required window surface creation instance extensions are not
- * available or if the specified instance was not created with these extensions
- * enabled, this function returns `VK_ERROR_EXTENSION_NOT_PRESENT` and
- * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref
- * glfwGetRequiredInstanceExtensions to check what instance extensions are
- * required.
- *
- * The window surface cannot be shared with another API so the window must
- * have been created with the [client api hint](@ref GLFW_CLIENT_API_attrib)
- * set to `GLFW_NO_API` otherwise it generates a @ref GLFW_INVALID_VALUE error
- * and returns `VK_ERROR_NATIVE_WINDOW_IN_USE_KHR`.
- *
- * The window surface must be destroyed before the specified Vulkan instance.
- * It is the responsibility of the caller to destroy the window surface. GLFW
- * does not destroy it for you. Call `vkDestroySurfaceKHR` to destroy the
- * surface.
- *
- * @param[in] instance The Vulkan instance to create the surface in.
- * @param[in] window The window to create the surface for.
- * @param[in] allocator The allocator to use, or `NULL` to use the default
- * allocator.
- * @param[out] surface Where to store the handle of the surface. This is set
- * to `VK_NULL_HANDLE` if an error occurred.
- * @return `VK_SUCCESS` if successful, or a Vulkan error code if an
- * [error](@ref error_handling) occurred.
- *
- * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
- * GLFW_API_UNAVAILABLE, @ref GLFW_PLATFORM_ERROR and @ref GLFW_INVALID_VALUE
- *
- * @remark If an error occurs before the creation call is made, GLFW returns
- * the Vulkan error code most appropriate for the error. Appropriate use of
- * @ref glfwVulkanSupported and @ref glfwGetRequiredInstanceExtensions should
- * eliminate almost all occurrences of these errors.
- *
- * @remark @macos GLFW prefers the `VK_EXT_metal_surface` extension, with the
- * `VK_MVK_macos_surface` extension as a fallback. The name of the selected
- * extension, if any, is included in the array returned by @ref
- * glfwGetRequiredInstanceExtensions.
- *
- * @remark @macos This function creates and sets a `CAMetalLayer` instance for
- * the window content view, which is required for MoltenVK to function.
- *
- * @remark @x11 By default GLFW prefers the `VK_KHR_xcb_surface` extension,
- * with the `VK_KHR_xlib_surface` extension as a fallback. You can make
- * `VK_KHR_xlib_surface` the preferred extension by setting the
- * [GLFW_X11_XCB_VULKAN_SURFACE](@ref GLFW_X11_XCB_VULKAN_SURFACE_hint) init
- * hint. The name of the selected extension, if any, is included in the array
- * returned by @ref glfwGetRequiredInstanceExtensions.
- *
- * @thread_safety This function may be called from any thread. For
- * synchronization details of Vulkan objects, see the Vulkan specification.
- *
- * @sa @ref vulkan_surface
- * @sa @ref glfwGetRequiredInstanceExtensions
- *
- * @since Added in version 3.2.
- *
- * @ingroup vulkan
- */
-GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);
-
+
+ /*! @brief Returns the address of the specified Vulkan instance function.
+ *
+ * This function returns the address of the specified Vulkan core or extension
+ * function for the specified instance. If instance is set to `NULL` it can
+ * return any function exported from the Vulkan loader, including at least the
+ * following functions:
+ *
+ * - `vkEnumerateInstanceExtensionProperties`
+ * - `vkEnumerateInstanceLayerProperties`
+ * - `vkCreateInstance`
+ * - `vkGetInstanceProcAddr`
+ *
+ * If Vulkan is not available on the machine, this function returns `NULL` and
+ * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
+ * to check whether Vulkan is at least minimally available.
+ *
+ * This function is equivalent to calling `vkGetInstanceProcAddr` with
+ * a platform-specific query of the Vulkan loader as a fallback.
+ *
+ * @param[in] instance The Vulkan instance to query, or `NULL` to retrieve
+ * functions related to instance creation.
+ * @param[in] procname The ASCII encoded name of the function.
+ * @return The address of the function, or `NULL` if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED and @ref
+ * GLFW_API_UNAVAILABLE.
+ *
+ * @pointer_lifetime The returned function pointer is valid until the library
+ * is terminated.
+ *
+ * @thread_safety This function may be called from any thread.
+ *
+ * @sa @ref vulkan_proc
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
+ */
+ GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);
+
+ /*! @brief Returns whether the specified queue family can present images.
+ *
+ * This function returns whether the specified queue family of the specified
+ * physical device supports presentation to the platform GLFW was built for.
+ *
+ * If Vulkan or the required window surface creation instance extensions are
+ * not available on the machine, or if the specified instance was not created
+ * with the required extensions, this function returns `GLFW_FALSE` and
+ * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported
+ * to check whether Vulkan is at least minimally available and @ref
+ * glfwGetRequiredInstanceExtensions to check what instance extensions are
+ * required.
+ *
+ * @param[in] instance The instance that the physical device belongs to.
+ * @param[in] device The physical device that the queue family belongs to.
+ * @param[in] queuefamily The index of the queue family to query.
+ * @return `GLFW_TRUE` if the queue family supports presentation, or
+ * `GLFW_FALSE` otherwise.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_API_UNAVAILABLE and @ref GLFW_PLATFORM_ERROR.
+ *
+ * @remark @macos This function currently always returns `GLFW_TRUE`, as the
+ * `VK_MVK_macos_surface` and `VK_EXT_metal_surface` extensions do not provide
+ * a `vkGetPhysicalDevice*PresentationSupport` type function.
+ *
+ * @thread_safety This function may be called from any thread. For
+ * synchronization details of Vulkan objects, see the Vulkan specification.
+ *
+ * @sa @ref vulkan_present
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
+ */
+ GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);
+
+ /*! @brief Creates a Vulkan surface for the specified window.
+ *
+ * This function creates a Vulkan surface for the specified window.
+ *
+ * If the Vulkan loader or at least one minimally functional ICD were not found,
+ * this function returns `VK_ERROR_INITIALIZATION_FAILED` and generates a @ref
+ * GLFW_API_UNAVAILABLE error. Call @ref glfwVulkanSupported to check whether
+ * Vulkan is at least minimally available.
+ *
+ * If the required window surface creation instance extensions are not
+ * available or if the specified instance was not created with these extensions
+ * enabled, this function returns `VK_ERROR_EXTENSION_NOT_PRESENT` and
+ * generates a @ref GLFW_API_UNAVAILABLE error. Call @ref
+ * glfwGetRequiredInstanceExtensions to check what instance extensions are
+ * required.
+ *
+ * The window surface cannot be shared with another API so the window must
+ * have been created with the [client api hint](@ref GLFW_CLIENT_API_attrib)
+ * set to `GLFW_NO_API` otherwise it generates a @ref GLFW_INVALID_VALUE error
+ * and returns `VK_ERROR_NATIVE_WINDOW_IN_USE_KHR`.
+ *
+ * The window surface must be destroyed before the specified Vulkan instance.
+ * It is the responsibility of the caller to destroy the window surface. GLFW
+ * does not destroy it for you. Call `vkDestroySurfaceKHR` to destroy the
+ * surface.
+ *
+ * @param[in] instance The Vulkan instance to create the surface in.
+ * @param[in] window The window to create the surface for.
+ * @param[in] allocator The allocator to use, or `NULL` to use the default
+ * allocator.
+ * @param[out] surface Where to store the handle of the surface. This is set
+ * to `VK_NULL_HANDLE` if an error occurred.
+ * @return `VK_SUCCESS` if successful, or a Vulkan error code if an
+ * [error](@ref error_handling) occurred.
+ *
+ * @errors Possible errors include @ref GLFW_NOT_INITIALIZED, @ref
+ * GLFW_API_UNAVAILABLE, @ref GLFW_PLATFORM_ERROR and @ref GLFW_INVALID_VALUE
+ *
+ * @remark If an error occurs before the creation call is made, GLFW returns
+ * the Vulkan error code most appropriate for the error. Appropriate use of
+ * @ref glfwVulkanSupported and @ref glfwGetRequiredInstanceExtensions should
+ * eliminate almost all occurrences of these errors.
+ *
+ * @remark @macos GLFW prefers the `VK_EXT_metal_surface` extension, with the
+ * `VK_MVK_macos_surface` extension as a fallback. The name of the selected
+ * extension, if any, is included in the array returned by @ref
+ * glfwGetRequiredInstanceExtensions.
+ *
+ * @remark @macos This function creates and sets a `CAMetalLayer` instance for
+ * the window content view, which is required for MoltenVK to function.
+ *
+ * @remark @x11 By default GLFW prefers the `VK_KHR_xcb_surface` extension,
+ * with the `VK_KHR_xlib_surface` extension as a fallback. You can make
+ * `VK_KHR_xlib_surface` the preferred extension by setting the
+ * [GLFW_X11_XCB_VULKAN_SURFACE](@ref GLFW_X11_XCB_VULKAN_SURFACE_hint) init
+ * hint. The name of the selected extension, if any, is included in the array
+ * returned by @ref glfwGetRequiredInstanceExtensions.
+ *
+ * @thread_safety This function may be called from any thread. For
+ * synchronization details of Vulkan objects, see the Vulkan specification.
+ *
+ * @sa @ref vulkan_surface
+ * @sa @ref glfwGetRequiredInstanceExtensions
+ *
+ * @since Added in version 3.2.
+ *
+ * @ingroup vulkan
+ */
+ GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);
+
#endif /*VK_VERSION_1_0*/
-
-
-/*************************************************************************
- * Global definition cleanup
- *************************************************************************/
-
-/* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
-
+
+
+ /*************************************************************************
+ * Global definition cleanup
+ *************************************************************************/
+
+ /* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
+
#ifdef GLFW_WINGDIAPI_DEFINED
- #undef WINGDIAPI
- #undef GLFW_WINGDIAPI_DEFINED
+#undef WINGDIAPI
+#undef GLFW_WINGDIAPI_DEFINED
#endif
-
+
#ifdef GLFW_CALLBACK_DEFINED
- #undef CALLBACK
- #undef 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.
- */
+
+ /* 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
- #define GLFW_GLAPIENTRY_DEFINED
+#define GLAPIENTRY APIENTRY
+#define GLFW_GLAPIENTRY_DEFINED
#endif
-
-/* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
-
-
+
+ /* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
+
+
#ifdef __cplusplus
}
#endif
diff --git a/libs/pwyazh/mesh.h b/libs/pwyazh/mesh.h
index 9443a13..c703beb 100644
--- a/libs/pwyazh/mesh.h
+++ b/libs/pwyazh/mesh.h
@@ -1,6 +1,20 @@
#ifndef MESH_H
#define MESH_H
+typedef struct {
+ V3F pos;
+ V3F normal;
+ V2F tex_coords;
+} Vertex;
+
+typedef struct {
+ U32 vao;
+ Vertex *vertices;
+ U32 vertex_count;
+ U32 *indices;
+ U32 index_count;
+} Mesh;
+
Vertex
vertex(V3F pos, V3F normal, V2F tex_coords)
{
@@ -68,9 +82,12 @@ mesh_init(Arena *arena,
void
mesh_draw(Mesh *mesh)
{
+ if (!mesh)
+ return;
+
glBindVertexArray(mesh->vao);
glDrawElements(GL_TRIANGLES, mesh->index_count, GL_UNSIGNED_INT, 0);
glBindVertexArray(0);
}
-#endif /* MESH_H */ \ No newline at end of file
+#endif /* MESH_H */
diff --git a/libs/pwyazh/pwyazh.h b/libs/pwyazh/pwyazh.h
index 0eede02..7231d68 100644
--- a/libs/pwyazh/pwyazh.h
+++ b/libs/pwyazh/pwyazh.h
@@ -18,6 +18,4 @@
#include "strings.h"
-#include "mesh.h"
-
#endif /* PWYAZH_H */
diff --git a/libs/pwyazh/pwyazh_GL.h b/libs/pwyazh/pwyazh_GL.h
new file mode 100644
index 0000000..6611ce5
--- /dev/null
+++ b/libs/pwyazh/pwyazh_GL.h
@@ -0,0 +1,8 @@
+#ifndef PWYAZH_GL_H
+#define PWYAZH_GL_H
+
+/* OpenGL related stuff. Some types and helpers */
+
+#include "mesh.h"
+
+#endif /* PWYAZH_GL_H */
diff --git a/libs/pwyazh/types.h b/libs/pwyazh/types.h
index 1e16449..0704299 100644
--- a/libs/pwyazh/types.h
+++ b/libs/pwyazh/types.h
@@ -55,20 +55,6 @@ typedef struct {
String8Node *last;
} String8List;
-typedef struct {
- V3F pos;
- V3F normal;
- V2F tex_coords;
-} Vertex;
-
-typedef struct {
- U32 vao;
- Vertex *vertices;
- U32 vertex_count;
- U32 *indices;
- U32 index_count;
-} Mesh;
-
static F32 pi_F32 = 3.14159265359f;
#endif /* TYPES_H */
diff --git a/mesh_loading_test/build.sh b/mesh_loading_test/build.sh
deleted file mode 100755
index 23ccbfa..0000000
--- a/mesh_loading_test/build.sh
+++ /dev/null
@@ -1,5 +0,0 @@
-#!/bin/sh
-. ../config
-TARGET='mesh_loading_test'
-set -x
-gcc -o $TARGET $CFLAGS $INCLUDE $LFLAGS $TARGET.c $LIBS && ./$TARGET
diff --git a/mesh_loading_test/shaders/default.fs b/mesh_loading_test/shaders/default.fs
deleted file mode 100644
index bdd4b9a..0000000
--- a/mesh_loading_test/shaders/default.fs
+++ /dev/null
@@ -1,13 +0,0 @@
-#version 330 core
-
-in vec2 tex_coords;
-
-out vec4 frag_color;
-
-uniform sampler2D texture1;
-
-void
-main(void)
-{
- frag_color = texture(texture1, tex_coords);
-}
diff --git a/mesh_loading_test/what_cube/pryazha.jpg b/mesh_loading_test/what_cube/pryazha.jpg
deleted file mode 100644
index b735c71..0000000
--- a/mesh_loading_test/what_cube/pryazha.jpg
+++ /dev/null
Binary files differ
diff --git a/mesh_loading_test/what_cube/what_cube.obj b/mesh_loading_test/what_cube/what_cube.obj
deleted file mode 100644
index b5f8ca0..0000000
--- a/mesh_loading_test/what_cube/what_cube.obj
+++ /dev/null
@@ -1,56 +0,0 @@
-# Blender 4.3.1
-# www.blender.org
-mtllib what_cube.mtl
-o Cube
-v 1.000000 1.000000 -1.000000
-v 1.000000 -1.000000 -1.000000
-v 1.000000 1.000000 1.000000
-v 1.000000 -1.000000 1.000000
-v -1.000000 1.000000 -1.000000
-v -1.000000 -1.000000 -1.000000
-v -1.000000 1.000000 1.000000
-v -1.000000 -1.000000 1.000000
-vn -0.0000 1.0000 -0.0000
-vn -0.0000 -0.0000 1.0000
-vn -1.0000 -0.0000 -0.0000
-vn -0.0000 -1.0000 -0.0000
-vn 1.0000 -0.0000 -0.0000
-vn -0.0000 -0.0000 -1.0000
-vt 0.608128 0.885598
-vt 0.382473 0.659943
-vt 0.608128 0.659943
-vt 0.277495 0.579754
-vt 0.051840 0.354100
-vt 0.277495 0.354100
-vt 0.908901 0.910597
-vt 0.837359 0.839055
-vt 0.908901 0.839055
-vt 0.539373 0.275355
-vt 0.313718 0.049700
-vt 0.539373 0.049700
-vt 0.526773 0.576605
-vt 0.301119 0.350950
-vt 0.526773 0.350950
-vt 0.919368 0.575030
-vt 0.693713 0.349375
-vt 0.919368 0.349375
-vt 0.382473 0.885598
-vt 0.051840 0.579755
-vt 0.837359 0.910597
-vt 0.313718 0.275355
-vt 0.301119 0.576605
-vt 0.693713 0.575030
-s 0
-usemtl Material
-f 5/1/1 3/2/1 1/3/1
-f 3/4/2 8/5/2 4/6/2
-f 7/7/3 6/8/3 8/9/3
-f 2/10/4 8/11/4 6/12/4
-f 1/13/5 4/14/5 2/15/5
-f 5/16/6 2/17/6 6/18/6
-f 5/1/1 7/19/1 3/2/1
-f 3/4/2 7/20/2 8/5/2
-f 7/7/3 5/21/3 6/8/3
-f 2/10/4 4/22/4 8/11/4
-f 1/13/5 3/23/5 4/14/5
-f 5/16/6 1/24/6 2/17/6