From 7b3afcaf77f96e7d62f6cd1623ead7f17512d79f Mon Sep 17 00:00:00 2001 From: Omniscient <17525998+omnisci3nce@users.noreply.github.com> Date: Sat, 24 Feb 2024 22:47:46 +1100 Subject: repo init. partial port of existing code --- deps/glfw-3.3.8/docs/CMakeLists.txt | 34 + deps/glfw-3.3.8/docs/CONTRIBUTING.md | 391 +++ deps/glfw-3.3.8/docs/Doxyfile.in | 1828 +++++++++++ deps/glfw-3.3.8/docs/DoxygenLayout.xml | 71 + deps/glfw-3.3.8/docs/SUPPORT.md | 14 + deps/glfw-3.3.8/docs/build.dox | 348 ++ deps/glfw-3.3.8/docs/compat.dox | 281 ++ deps/glfw-3.3.8/docs/compile.dox | 367 +++ deps/glfw-3.3.8/docs/context.dox | 346 ++ deps/glfw-3.3.8/docs/extra.css | 1 + deps/glfw-3.3.8/docs/extra.css.map | 1 + deps/glfw-3.3.8/docs/extra.scss | 430 +++ deps/glfw-3.3.8/docs/footer.html | 7 + deps/glfw-3.3.8/docs/header.html | 34 + deps/glfw-3.3.8/docs/html/bc_s.png | Bin 0 -> 676 bytes deps/glfw-3.3.8/docs/html/bdwn.png | Bin 0 -> 147 bytes deps/glfw-3.3.8/docs/html/build_8dox.html | 74 + deps/glfw-3.3.8/docs/html/build_guide.html | 192 ++ deps/glfw-3.3.8/docs/html/closed.png | Bin 0 -> 132 bytes deps/glfw-3.3.8/docs/html/compat_8dox.html | 74 + deps/glfw-3.3.8/docs/html/compat_guide.html | 145 + deps/glfw-3.3.8/docs/html/compile_8dox.html | 74 + deps/glfw-3.3.8/docs/html/compile_guide.html | 216 ++ deps/glfw-3.3.8/docs/html/context_8dox.html | 74 + deps/glfw-3.3.8/docs/html/context_guide.html | 251 ++ deps/glfw-3.3.8/docs/html/deprecated.html | 81 + .../html/dir_1dfd43b3952c5bc1ba15d15b12afff7b.html | 88 + .../html/dir_4351554941a2744586042c1cf3cf139a.html | 86 + .../html/dir_f6ba4c3dca55a8d4e7d63c8235e0ad43.html | 84 + .../html/dir_fda32cf7bec00275262cb8799a618f76.html | 78 + deps/glfw-3.3.8/docs/html/doc.png | Bin 0 -> 746 bytes deps/glfw-3.3.8/docs/html/doxygen.css | 1841 +++++++++++ deps/glfw-3.3.8/docs/html/doxygen.svg | 26 + deps/glfw-3.3.8/docs/html/dynsections.js | 121 + deps/glfw-3.3.8/docs/html/extra.css | 1 + deps/glfw-3.3.8/docs/html/files.html | 84 + deps/glfw-3.3.8/docs/html/folderclosed.png | Bin 0 -> 616 bytes deps/glfw-3.3.8/docs/html/folderopen.png | Bin 0 -> 597 bytes deps/glfw-3.3.8/docs/html/glfw3_8h.html | 1619 +++++++++ deps/glfw-3.3.8/docs/html/glfw3_8h_source.html | 1155 +++++++ deps/glfw-3.3.8/docs/html/glfw3native_8h.html | 160 + .../docs/html/glfw3native_8h_source.html | 285 ++ deps/glfw-3.3.8/docs/html/group__buttons.html | 275 ++ deps/glfw-3.3.8/docs/html/group__context.html | 295 ++ deps/glfw-3.3.8/docs/html/group__errors.html | 297 ++ .../glfw-3.3.8/docs/html/group__gamepad__axes.html | 195 ++ .../docs/html/group__gamepad__buttons.html | 403 +++ deps/glfw-3.3.8/docs/html/group__hat__state.html | 227 ++ deps/glfw-3.3.8/docs/html/group__init.html | 545 ++++ deps/glfw-3.3.8/docs/html/group__input.html | 2228 +++++++++++++ deps/glfw-3.3.8/docs/html/group__joysticks.html | 355 ++ deps/glfw-3.3.8/docs/html/group__keys.html | 2043 ++++++++++++ deps/glfw-3.3.8/docs/html/group__mods.html | 191 ++ deps/glfw-3.3.8/docs/html/group__monitor.html | 841 +++++ deps/glfw-3.3.8/docs/html/group__native.html | 805 +++++ deps/glfw-3.3.8/docs/html/group__shapes.html | 191 ++ deps/glfw-3.3.8/docs/html/group__vulkan.html | 352 ++ deps/glfw-3.3.8/docs/html/group__window.html | 3427 ++++++++++++++++++++ deps/glfw-3.3.8/docs/html/index.html | 93 + deps/glfw-3.3.8/docs/html/input_8dox.html | 74 + deps/glfw-3.3.8/docs/html/input_guide.html | 562 ++++ deps/glfw-3.3.8/docs/html/internal_8dox.html | 74 + deps/glfw-3.3.8/docs/html/internals_guide.html | 125 + deps/glfw-3.3.8/docs/html/intro_8dox.html | 74 + deps/glfw-3.3.8/docs/html/intro_guide.html | 329 ++ deps/glfw-3.3.8/docs/html/jquery.js | 35 + deps/glfw-3.3.8/docs/html/main_8dox.html | 74 + deps/glfw-3.3.8/docs/html/menu.js | 135 + deps/glfw-3.3.8/docs/html/menudata.js | 30 + deps/glfw-3.3.8/docs/html/modules.html | 94 + deps/glfw-3.3.8/docs/html/monitor_8dox.html | 74 + deps/glfw-3.3.8/docs/html/monitor_guide.html | 222 ++ deps/glfw-3.3.8/docs/html/moving_8dox.html | 74 + deps/glfw-3.3.8/docs/html/moving_guide.html | 367 +++ deps/glfw-3.3.8/docs/html/nav_f.png | Bin 0 -> 153 bytes deps/glfw-3.3.8/docs/html/nav_g.png | Bin 0 -> 95 bytes deps/glfw-3.3.8/docs/html/nav_h.png | Bin 0 -> 98 bytes deps/glfw-3.3.8/docs/html/news.html | 614 ++++ deps/glfw-3.3.8/docs/html/news_8dox.html | 74 + deps/glfw-3.3.8/docs/html/open.png | Bin 0 -> 123 bytes deps/glfw-3.3.8/docs/html/pages.html | 92 + deps/glfw-3.3.8/docs/html/quick_8dox.html | 74 + deps/glfw-3.3.8/docs/html/quick_guide.html | 391 +++ deps/glfw-3.3.8/docs/html/search/all_0.html | 37 + deps/glfw-3.3.8/docs/html/search/all_0.js | 4 + deps/glfw-3.3.8/docs/html/search/all_1.html | 37 + deps/glfw-3.3.8/docs/html/search/all_1.js | 8 + deps/glfw-3.3.8/docs/html/search/all_10.html | 37 + deps/glfw-3.3.8/docs/html/search/all_10.js | 6 + deps/glfw-3.3.8/docs/html/search/all_11.html | 37 + deps/glfw-3.3.8/docs/html/search/all_11.js | 7 + deps/glfw-3.3.8/docs/html/search/all_2.html | 37 + deps/glfw-3.3.8/docs/html/search/all_2.js | 9 + deps/glfw-3.3.8/docs/html/search/all_3.html | 37 + deps/glfw-3.3.8/docs/html/search/all_3.js | 4 + deps/glfw-3.3.8/docs/html/search/all_4.html | 37 + deps/glfw-3.3.8/docs/html/search/all_4.js | 4 + deps/glfw-3.3.8/docs/html/search/all_5.html | 37 + deps/glfw-3.3.8/docs/html/search/all_5.js | 477 +++ deps/glfw-3.3.8/docs/html/search/all_6.html | 37 + deps/glfw-3.3.8/docs/html/search/all_6.js | 4 + deps/glfw-3.3.8/docs/html/search/all_7.html | 37 + deps/glfw-3.3.8/docs/html/search/all_7.js | 11 + deps/glfw-3.3.8/docs/html/search/all_8.html | 37 + deps/glfw-3.3.8/docs/html/search/all_8.js | 5 + deps/glfw-3.3.8/docs/html/search/all_9.html | 37 + deps/glfw-3.3.8/docs/html/search/all_9.js | 4 + deps/glfw-3.3.8/docs/html/search/all_a.html | 37 + deps/glfw-3.3.8/docs/html/search/all_a.js | 11 + deps/glfw-3.3.8/docs/html/search/all_b.html | 37 + deps/glfw-3.3.8/docs/html/search/all_b.js | 6 + deps/glfw-3.3.8/docs/html/search/all_c.html | 37 + deps/glfw-3.3.8/docs/html/search/all_c.js | 4 + deps/glfw-3.3.8/docs/html/search/all_d.html | 37 + deps/glfw-3.3.8/docs/html/search/all_d.js | 4 + deps/glfw-3.3.8/docs/html/search/all_e.html | 37 + deps/glfw-3.3.8/docs/html/search/all_e.js | 7 + deps/glfw-3.3.8/docs/html/search/all_f.html | 37 + deps/glfw-3.3.8/docs/html/search/all_f.js | 6 + deps/glfw-3.3.8/docs/html/search/classes_0.html | 37 + deps/glfw-3.3.8/docs/html/search/classes_0.js | 7 + deps/glfw-3.3.8/docs/html/search/close.svg | 31 + deps/glfw-3.3.8/docs/html/search/defines_0.html | 37 + deps/glfw-3.3.8/docs/html/search/defines_0.js | 32 + deps/glfw-3.3.8/docs/html/search/files_0.html | 37 + deps/glfw-3.3.8/docs/html/search/files_0.js | 4 + deps/glfw-3.3.8/docs/html/search/files_1.html | 37 + deps/glfw-3.3.8/docs/html/search/files_1.js | 6 + deps/glfw-3.3.8/docs/html/search/files_2.html | 37 + deps/glfw-3.3.8/docs/html/search/files_2.js | 5 + deps/glfw-3.3.8/docs/html/search/files_3.html | 37 + deps/glfw-3.3.8/docs/html/search/files_3.js | 6 + deps/glfw-3.3.8/docs/html/search/files_4.html | 37 + deps/glfw-3.3.8/docs/html/search/files_4.js | 6 + deps/glfw-3.3.8/docs/html/search/files_5.html | 37 + deps/glfw-3.3.8/docs/html/search/files_5.js | 4 + deps/glfw-3.3.8/docs/html/search/files_6.html | 37 + deps/glfw-3.3.8/docs/html/search/files_6.js | 4 + deps/glfw-3.3.8/docs/html/search/files_7.html | 37 + deps/glfw-3.3.8/docs/html/search/files_7.js | 4 + deps/glfw-3.3.8/docs/html/search/files_8.html | 37 + deps/glfw-3.3.8/docs/html/search/files_8.js | 4 + deps/glfw-3.3.8/docs/html/search/functions_0.html | 37 + deps/glfw-3.3.8/docs/html/search/functions_0.js | 146 + deps/glfw-3.3.8/docs/html/search/groups_0.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_0.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_1.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_1.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_2.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_2.js | 5 + deps/glfw-3.3.8/docs/html/search/groups_3.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_3.js | 5 + deps/glfw-3.3.8/docs/html/search/groups_4.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_4.js | 5 + deps/glfw-3.3.8/docs/html/search/groups_5.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_5.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_6.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_6.js | 6 + deps/glfw-3.3.8/docs/html/search/groups_7.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_7.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_8.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_8.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_9.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_9.js | 4 + deps/glfw-3.3.8/docs/html/search/groups_a.html | 37 + deps/glfw-3.3.8/docs/html/search/groups_a.js | 4 + deps/glfw-3.3.8/docs/html/search/mag_sel.svg | 74 + deps/glfw-3.3.8/docs/html/search/nomatches.html | 13 + deps/glfw-3.3.8/docs/html/search/pages_0.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_0.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_1.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_1.js | 5 + deps/glfw-3.3.8/docs/html/search/pages_2.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_2.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_3.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_3.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_4.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_4.js | 6 + deps/glfw-3.3.8/docs/html/search/pages_5.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_5.js | 5 + deps/glfw-3.3.8/docs/html/search/pages_6.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_6.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_7.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_7.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_8.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_8.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_9.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_9.js | 4 + deps/glfw-3.3.8/docs/html/search/pages_a.html | 37 + deps/glfw-3.3.8/docs/html/search/pages_a.js | 4 + deps/glfw-3.3.8/docs/html/search/search.css | 263 ++ deps/glfw-3.3.8/docs/html/search/search.js | 802 +++++ deps/glfw-3.3.8/docs/html/search/search_l.png | Bin 0 -> 567 bytes deps/glfw-3.3.8/docs/html/search/search_m.png | Bin 0 -> 158 bytes deps/glfw-3.3.8/docs/html/search/search_r.png | Bin 0 -> 553 bytes deps/glfw-3.3.8/docs/html/search/searchdata.js | 39 + deps/glfw-3.3.8/docs/html/search/typedefs_0.html | 37 + deps/glfw-3.3.8/docs/html/search/typedefs_0.js | 32 + deps/glfw-3.3.8/docs/html/search/variables_0.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_0.js | 4 + deps/glfw-3.3.8/docs/html/search/variables_1.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_1.js | 6 + deps/glfw-3.3.8/docs/html/search/variables_2.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_2.js | 5 + deps/glfw-3.3.8/docs/html/search/variables_3.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_3.js | 4 + deps/glfw-3.3.8/docs/html/search/variables_4.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_4.js | 4 + deps/glfw-3.3.8/docs/html/search/variables_5.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_5.js | 6 + deps/glfw-3.3.8/docs/html/search/variables_6.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_6.js | 4 + deps/glfw-3.3.8/docs/html/search/variables_7.html | 37 + deps/glfw-3.3.8/docs/html/search/variables_7.js | 4 + deps/glfw-3.3.8/docs/html/spaces.svg | 877 +++++ deps/glfw-3.3.8/docs/html/splitbar.png | Bin 0 -> 314 bytes .../docs/html/structGLFWgamepadstate.html | 129 + deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html | 165 + deps/glfw-3.3.8/docs/html/structGLFWimage.html | 146 + deps/glfw-3.3.8/docs/html/structGLFWvidmode.html | 199 ++ deps/glfw-3.3.8/docs/html/sync_off.png | Bin 0 -> 853 bytes deps/glfw-3.3.8/docs/html/sync_on.png | Bin 0 -> 845 bytes deps/glfw-3.3.8/docs/html/tab_a.png | Bin 0 -> 142 bytes deps/glfw-3.3.8/docs/html/tab_b.png | Bin 0 -> 169 bytes deps/glfw-3.3.8/docs/html/tab_h.png | Bin 0 -> 177 bytes deps/glfw-3.3.8/docs/html/tab_s.png | Bin 0 -> 184 bytes deps/glfw-3.3.8/docs/html/tabs.css | 1 + deps/glfw-3.3.8/docs/html/vulkan_8dox.html | 74 + deps/glfw-3.3.8/docs/html/vulkan_guide.html | 189 ++ deps/glfw-3.3.8/docs/html/window_8dox.html | 74 + deps/glfw-3.3.8/docs/html/window_guide.html | 756 +++++ deps/glfw-3.3.8/docs/input.dox | 962 ++++++ deps/glfw-3.3.8/docs/internal.dox | 115 + deps/glfw-3.3.8/docs/intro.dox | 454 +++ deps/glfw-3.3.8/docs/main.dox | 46 + deps/glfw-3.3.8/docs/monitor.dox | 268 ++ deps/glfw-3.3.8/docs/moving.dox | 513 +++ deps/glfw-3.3.8/docs/news.dox | 876 +++++ deps/glfw-3.3.8/docs/quick.dox | 365 +++ deps/glfw-3.3.8/docs/spaces.svg | 877 +++++ deps/glfw-3.3.8/docs/vulkan.dox | 242 ++ deps/glfw-3.3.8/docs/window.dox | 1412 ++++++++ 242 files changed, 40507 insertions(+) create mode 100644 deps/glfw-3.3.8/docs/CMakeLists.txt create mode 100644 deps/glfw-3.3.8/docs/CONTRIBUTING.md create mode 100644 deps/glfw-3.3.8/docs/Doxyfile.in create mode 100644 deps/glfw-3.3.8/docs/DoxygenLayout.xml create mode 100644 deps/glfw-3.3.8/docs/SUPPORT.md create mode 100644 deps/glfw-3.3.8/docs/build.dox create mode 100644 deps/glfw-3.3.8/docs/compat.dox create mode 100644 deps/glfw-3.3.8/docs/compile.dox create mode 100644 deps/glfw-3.3.8/docs/context.dox create mode 100644 deps/glfw-3.3.8/docs/extra.css create mode 100644 deps/glfw-3.3.8/docs/extra.css.map create mode 100644 deps/glfw-3.3.8/docs/extra.scss create mode 100644 deps/glfw-3.3.8/docs/footer.html create mode 100644 deps/glfw-3.3.8/docs/header.html create mode 100644 deps/glfw-3.3.8/docs/html/bc_s.png create mode 100644 deps/glfw-3.3.8/docs/html/bdwn.png create mode 100644 deps/glfw-3.3.8/docs/html/build_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/build_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/closed.png create mode 100644 deps/glfw-3.3.8/docs/html/compat_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/compat_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/compile_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/compile_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/context_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/context_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/deprecated.html create mode 100644 deps/glfw-3.3.8/docs/html/dir_1dfd43b3952c5bc1ba15d15b12afff7b.html create mode 100644 deps/glfw-3.3.8/docs/html/dir_4351554941a2744586042c1cf3cf139a.html create mode 100644 deps/glfw-3.3.8/docs/html/dir_f6ba4c3dca55a8d4e7d63c8235e0ad43.html create mode 100644 deps/glfw-3.3.8/docs/html/dir_fda32cf7bec00275262cb8799a618f76.html create mode 100644 deps/glfw-3.3.8/docs/html/doc.png create mode 100644 deps/glfw-3.3.8/docs/html/doxygen.css create mode 100644 deps/glfw-3.3.8/docs/html/doxygen.svg create mode 100644 deps/glfw-3.3.8/docs/html/dynsections.js create mode 100644 deps/glfw-3.3.8/docs/html/extra.css create mode 100644 deps/glfw-3.3.8/docs/html/files.html create mode 100644 deps/glfw-3.3.8/docs/html/folderclosed.png create mode 100644 deps/glfw-3.3.8/docs/html/folderopen.png create mode 100644 deps/glfw-3.3.8/docs/html/glfw3_8h.html create mode 100644 deps/glfw-3.3.8/docs/html/glfw3_8h_source.html create mode 100644 deps/glfw-3.3.8/docs/html/glfw3native_8h.html create mode 100644 deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html create mode 100644 deps/glfw-3.3.8/docs/html/group__buttons.html create mode 100644 deps/glfw-3.3.8/docs/html/group__context.html create mode 100644 deps/glfw-3.3.8/docs/html/group__errors.html create mode 100644 deps/glfw-3.3.8/docs/html/group__gamepad__axes.html create mode 100644 deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html create mode 100644 deps/glfw-3.3.8/docs/html/group__hat__state.html create mode 100644 deps/glfw-3.3.8/docs/html/group__init.html create mode 100644 deps/glfw-3.3.8/docs/html/group__input.html create mode 100644 deps/glfw-3.3.8/docs/html/group__joysticks.html create mode 100644 deps/glfw-3.3.8/docs/html/group__keys.html create mode 100644 deps/glfw-3.3.8/docs/html/group__mods.html create mode 100644 deps/glfw-3.3.8/docs/html/group__monitor.html create mode 100644 deps/glfw-3.3.8/docs/html/group__native.html create mode 100644 deps/glfw-3.3.8/docs/html/group__shapes.html create mode 100644 deps/glfw-3.3.8/docs/html/group__vulkan.html create mode 100644 deps/glfw-3.3.8/docs/html/group__window.html create mode 100644 deps/glfw-3.3.8/docs/html/index.html create mode 100644 deps/glfw-3.3.8/docs/html/input_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/input_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/internal_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/internals_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/intro_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/intro_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/jquery.js create mode 100644 deps/glfw-3.3.8/docs/html/main_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/menu.js create mode 100644 deps/glfw-3.3.8/docs/html/menudata.js create mode 100644 deps/glfw-3.3.8/docs/html/modules.html create mode 100644 deps/glfw-3.3.8/docs/html/monitor_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/monitor_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/moving_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/moving_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/nav_f.png create mode 100644 deps/glfw-3.3.8/docs/html/nav_g.png create mode 100644 deps/glfw-3.3.8/docs/html/nav_h.png create mode 100644 deps/glfw-3.3.8/docs/html/news.html create mode 100644 deps/glfw-3.3.8/docs/html/news_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/open.png create mode 100644 deps/glfw-3.3.8/docs/html/pages.html create mode 100644 deps/glfw-3.3.8/docs/html/quick_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/quick_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_1.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_1.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_10.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_10.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_11.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_11.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_2.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_2.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_3.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_3.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_4.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_4.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_5.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_5.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_6.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_6.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_7.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_7.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_8.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_8.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_9.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_9.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_a.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_a.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_b.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_b.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_c.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_c.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_d.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_d.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_e.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_e.js create mode 100644 deps/glfw-3.3.8/docs/html/search/all_f.html create mode 100644 deps/glfw-3.3.8/docs/html/search/all_f.js create mode 100644 deps/glfw-3.3.8/docs/html/search/classes_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/classes_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/close.svg create mode 100644 deps/glfw-3.3.8/docs/html/search/defines_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/defines_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_1.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_1.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_2.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_2.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_3.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_3.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_4.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_4.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_5.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_5.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_6.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_6.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_7.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_7.js create mode 100644 deps/glfw-3.3.8/docs/html/search/files_8.html create mode 100644 deps/glfw-3.3.8/docs/html/search/files_8.js create mode 100644 deps/glfw-3.3.8/docs/html/search/functions_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/functions_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_1.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_1.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_2.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_2.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_3.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_3.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_4.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_4.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_5.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_5.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_6.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_6.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_7.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_7.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_8.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_8.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_9.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_9.js create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_a.html create mode 100644 deps/glfw-3.3.8/docs/html/search/groups_a.js create mode 100644 deps/glfw-3.3.8/docs/html/search/mag_sel.svg create mode 100644 deps/glfw-3.3.8/docs/html/search/nomatches.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_1.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_1.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_2.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_2.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_3.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_3.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_4.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_4.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_5.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_5.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_6.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_6.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_7.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_7.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_8.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_8.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_9.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_9.js create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_a.html create mode 100644 deps/glfw-3.3.8/docs/html/search/pages_a.js create mode 100644 deps/glfw-3.3.8/docs/html/search/search.css create mode 100644 deps/glfw-3.3.8/docs/html/search/search.js create mode 100644 deps/glfw-3.3.8/docs/html/search/search_l.png create mode 100644 deps/glfw-3.3.8/docs/html/search/search_m.png create mode 100644 deps/glfw-3.3.8/docs/html/search/search_r.png create mode 100644 deps/glfw-3.3.8/docs/html/search/searchdata.js create mode 100644 deps/glfw-3.3.8/docs/html/search/typedefs_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/typedefs_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_0.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_0.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_1.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_1.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_2.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_2.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_3.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_3.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_4.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_4.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_5.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_5.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_6.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_6.js create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_7.html create mode 100644 deps/glfw-3.3.8/docs/html/search/variables_7.js create mode 100644 deps/glfw-3.3.8/docs/html/spaces.svg create mode 100644 deps/glfw-3.3.8/docs/html/splitbar.png create mode 100644 deps/glfw-3.3.8/docs/html/structGLFWgamepadstate.html create mode 100644 deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html create mode 100644 deps/glfw-3.3.8/docs/html/structGLFWimage.html create mode 100644 deps/glfw-3.3.8/docs/html/structGLFWvidmode.html create mode 100644 deps/glfw-3.3.8/docs/html/sync_off.png create mode 100644 deps/glfw-3.3.8/docs/html/sync_on.png create mode 100644 deps/glfw-3.3.8/docs/html/tab_a.png create mode 100644 deps/glfw-3.3.8/docs/html/tab_b.png create mode 100644 deps/glfw-3.3.8/docs/html/tab_h.png create mode 100644 deps/glfw-3.3.8/docs/html/tab_s.png create mode 100644 deps/glfw-3.3.8/docs/html/tabs.css create mode 100644 deps/glfw-3.3.8/docs/html/vulkan_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/vulkan_guide.html create mode 100644 deps/glfw-3.3.8/docs/html/window_8dox.html create mode 100644 deps/glfw-3.3.8/docs/html/window_guide.html create mode 100644 deps/glfw-3.3.8/docs/input.dox create mode 100644 deps/glfw-3.3.8/docs/internal.dox create mode 100644 deps/glfw-3.3.8/docs/intro.dox create mode 100644 deps/glfw-3.3.8/docs/main.dox create mode 100644 deps/glfw-3.3.8/docs/monitor.dox create mode 100644 deps/glfw-3.3.8/docs/moving.dox create mode 100644 deps/glfw-3.3.8/docs/news.dox create mode 100644 deps/glfw-3.3.8/docs/quick.dox create mode 100644 deps/glfw-3.3.8/docs/spaces.svg create mode 100644 deps/glfw-3.3.8/docs/vulkan.dox create mode 100644 deps/glfw-3.3.8/docs/window.dox (limited to 'deps/glfw-3.3.8/docs') diff --git a/deps/glfw-3.3.8/docs/CMakeLists.txt b/deps/glfw-3.3.8/docs/CMakeLists.txt new file mode 100644 index 0000000..2347858 --- /dev/null +++ b/deps/glfw-3.3.8/docs/CMakeLists.txt @@ -0,0 +1,34 @@ + +# NOTE: The order of this list determines the order of items in the Guides +# (i.e. Pages) list in the generated documentation +set(GLFW_DOXYGEN_SOURCES + "include/GLFW/glfw3.h" + "include/GLFW/glfw3native.h" + "docs/main.dox" + "docs/news.dox" + "docs/quick.dox" + "docs/moving.dox" + "docs/compile.dox" + "docs/build.dox" + "docs/intro.dox" + "docs/context.dox" + "docs/monitor.dox" + "docs/window.dox" + "docs/input.dox" + "docs/vulkan.dox" + "docs/compat.dox" + "docs/internal.dox") + +# Format the source list into a Doxyfile INPUT value that Doxygen can parse +foreach(path IN LISTS GLFW_DOXYGEN_SOURCES) + set(GLFW_DOXYGEN_INPUT "${GLFW_DOXYGEN_INPUT} \\\n\"${GLFW_SOURCE_DIR}/${path}\"") +endforeach() + +configure_file(Doxyfile.in Doxyfile @ONLY) + +add_custom_target(docs ALL "${DOXYGEN_EXECUTABLE}" + WORKING_DIRECTORY "${GLFW_BINARY_DIR}/docs" + COMMENT "Generating HTML documentation" VERBATIM) + +set_target_properties(docs PROPERTIES FOLDER "GLFW3") + diff --git a/deps/glfw-3.3.8/docs/CONTRIBUTING.md b/deps/glfw-3.3.8/docs/CONTRIBUTING.md new file mode 100644 index 0000000..050c1be --- /dev/null +++ b/deps/glfw-3.3.8/docs/CONTRIBUTING.md @@ -0,0 +1,391 @@ +# Contribution Guide + +## Contents + +- [Asking a question](#asking-a-question) +- [Reporting a bug](#reporting-a-bug) + - [Reporting a compile or link bug](#reporting-a-compile-or-link-bug) + - [Reporting a segfault or other crash bug](#reporting-a-segfault-or-other-crash-bug) + - [Reporting a context creation bug](#reporting-a-context-creation-bug) + - [Reporting a monitor or video mode bug](#reporting-a-monitor-or-video-mode-bug) + - [Reporting a window, input or event bug](#reporting-a-window-input-or-event-bug) + - [Reporting some other library bug](#reporting-some-other-library-bug) + - [Reporting a documentation bug](#reporting-a-documentation-bug) + - [Reporting a website bug](#reporting-a-website-bug) +- [Requesting a feature](#requesting-a-feature) +- [Contributing a bug fix](#contributing-a-bug-fix) +- [Contributing a feature](#contributing-a-feature) + + +## Asking a question + +Questions about how to use GLFW should be asked either in the [support +section](https://discourse.glfw.org/c/support) of the forum, under the [Stack +Overflow tag](https://stackoverflow.com/questions/tagged/glfw) or [Game +Development tag](https://gamedev.stackexchange.com/questions/tagged/glfw) on +Stack Exchange or in the IRC channel `#glfw` on +[Libera.Chat](https://libera.chat/). + +Questions about the design or implementation of GLFW or about future plans +should be asked in the [dev section](https://discourse.glfw.org/c/dev) of the +forum or in the IRC channel. Please don't open a GitHub issue to discuss design +questions without first checking with a maintainer. + + +## Reporting a bug + +If GLFW is behaving unexpectedly at run-time, start by setting an [error +callback](https://www.glfw.org/docs/latest/intro_guide.html#error_handling). +GLFW will often tell you the cause of an error via this callback. If it +doesn't, that might be a separate bug. + +If GLFW is crashing or triggering asserts, make sure that all your object +handles and other pointers are valid. + +For bugs where it makes sense, a short, self contained example is absolutely +invaluable. Just put it inline in the body text. Note that if the bug is +reproducible with one of the test programs that come with GLFW, just mention +that instead. + +__Don't worry about adding too much information__. Unimportant information can +be abbreviated or removed later, but missing information can stall bug fixing, +especially when your schedule doesn't align with that of the maintainer. + +__Please provide text as text, not as images__. This includes code, error +messages and any other text. Text in images cannot be found by other users +searching for the same problem and may have to be re-typed by maintainers when +debugging. + +You don't need to manually indent your code or other text to quote it with +GitHub Markdown; just surround it with triple backticks: + + ``` + Some quoted text. + ``` + +You can also add syntax highlighting by appending the common file extension: + + ```c + int five(void) + { + return 5; + } + ``` + +There are issue labels for both platforms and GPU manufacturers, so there is no +need to mention these in the subject line. If you do, it will be removed when +the issue is labeled. + +If your bug is already reported, please add any new information you have, or if +it already has everything, give it a :+1:. + + +### Reporting a compile or link bug + +__Note:__ GLFW needs many system APIs to do its job, which on some platforms +means linking to many system libraries. If you are using GLFW as a static +library, that means your application needs to link to these in addition to GLFW. + +__Note:__ Check the [Compiling +GLFW](https://www.glfw.org/docs/latest/compile.html) guide and or [Building +applications](https://www.glfw.org/docs/latest/build.html) guide for before +opening an issue of this kind. Most issues are caused by a missing package or +linker flag. + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`) and the __compiler name and version__ (e.g. `Visual +C++ 2015 Update 2`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +Please also include the __complete build log__ from your compiler and linker, +even if it's long. It can always be shortened later, if necessary. + + +#### Quick template + +``` +OS and version: +Compiler version: +Release or commit: +Build log: +``` + + +### Reporting a segfault or other crash bug + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +Please also include any __error messages__ provided to your application via the +[error +callback](https://www.glfw.org/docs/latest/intro_guide.html#error_handling) and +the __full call stack__ of the crash, or if the crash does not occur in debug +mode, mention that instead. + + +#### Quick template + +``` +OS and version: +Release or commit: +Error messages: +Call stack: +``` + + +### Reporting a context creation bug + +__Note:__ Windows ships with graphics drivers that do not support OpenGL. If +GLFW says that your machine lacks support for OpenGL, it very likely does. +Install drivers from the computer manufacturer or graphics card manufacturer +([Nvidia](https://www.geforce.com/drivers), +[AMD](https://www.amd.com/en/support), +[Intel](https://www-ssl.intel.com/content/www/us/en/support/detect.html)) to +fix this. + +__Note:__ AMD only supports OpenGL ES on Windows via EGL. See the +[GLFW\_CONTEXT\_CREATION\_API](https://www.glfw.org/docs/latest/window_guide.html#window_hints_ctx) +hint for how to select EGL. + +Please verify that context creation also fails with the `glfwinfo` tool before +reporting it as a bug. This tool is included in the GLFW source tree as +`tests/glfwinfo.c` and is built along with the library. It has switches for all +GLFW context and framebuffer hints. Run `glfwinfo -h` for a complete list. + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +If you are running your program in a virtual machine, please mention this and +include the __VM name and version__ (e.g. `VirtualBox 5.1`). + +Please also include the __GLFW version string__ (`3.2.0 X11 EGL clock_gettime +/dev/js`), as described +[here](https://www.glfw.org/docs/latest/intro.html#intro_version_string), the +__GPU model and driver version__ (e.g. `GeForce GTX660 with 352.79`), and the +__output of `glfwinfo`__ (with switches matching any hints you set in your +code) when reporting this kind of bug. If this tool doesn't run on the machine, +mention that instead. + + +#### Quick template + +``` +OS and version: +GPU and driver: +Release or commit: +Version string: +glfwinfo output: +``` + + +### Reporting a monitor or video mode bug + +__Note:__ On headless systems on some platforms, no monitors are reported. This +causes glfwGetPrimaryMonitor to return `NULL`, which not all applications are +prepared for. + +__Note:__ Some third-party tools report more video modes than are approved of +by the OS. For safety and compatibility, GLFW only reports video modes the OS +wants programs to use. This is not a bug. + +The `monitors` tool is included in the GLFW source tree as `tests/monitors.c` +and is built along with the library. It lists all information GLFW provides +about monitors it detects. + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +If you are running your program in a virtual machine, please mention this and +include the __VM name and version__ (e.g. `VirtualBox 5.1`). + +Please also include any __error messages__ provided to your application via the +[error +callback](https://www.glfw.org/docs/latest/intro_guide.html#error_handling) and +the __output of `monitors`__ when reporting this kind of bug. If this tool +doesn't run on the machine, mention this instead. + + +#### Quick template + +``` +OS and version: +Release or commit: +Error messages: +monitors output: +``` + + +### Reporting a window, input or event bug + +__Note:__ The exact ordering of related window events will sometimes differ. + +__Note:__ Window moving and resizing (by the user) will block the main thread on +some platforms. This is not a bug. Set a [refresh +callback](https://www.glfw.org/docs/latest/window.html#window_refresh) if you +want to keep the window contents updated during a move or size operation. + +The `events` tool is included in the GLFW source tree as `tests/events.c` and is +built along with the library. It prints all information provided to every +callback supported by GLFW as events occur. Each event is listed with the time +and a unique number to make discussions about event logs easier. The tool has +command-line options for creating multiple windows and full screen windows. + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +If you are running your program in a virtual machine, please mention this and +include the __VM name and version__ (e.g. `VirtualBox 5.1`). + +Please also include any __error messages__ provided to your application via the +[error +callback](https://www.glfw.org/docs/latest/intro_guide.html#error_handling) and +if relevant, the __output of `events`__ when reporting this kind of bug. If +this tool doesn't run on the machine, mention this instead. + +__X11:__ If possible, please include what desktop environment (e.g. GNOME, +Unity, KDE) and/or window manager (e.g. Openbox, dwm, Window Maker) you are +running. If the bug is related to keyboard input, please include any input +method (e.g. ibus, SCIM) you are using. + + +#### Quick template + +``` +OS and version: +Release or commit: +Error messages: +events output: +``` + + +### Reporting some other library bug + +Always include the __operating system name and version__ (e.g. `Windows +7 64-bit` or `Ubuntu 15.10`). If you are using an official release of GLFW, +include the __GLFW release version__ (e.g. `3.1.2`), otherwise include the +__GLFW commit ID__ (e.g. `3795d78b14ef06008889cc422a1fb8d642597751`) from Git. + +Please also include any __error messages__ provided to your application via the +[error +callback](https://www.glfw.org/docs/latest/intro_guide.html#error_handling), if +relevant. + + +#### Quick template + +``` +OS and version: +Release or commit: +Error messages: +``` + + +### Reporting a documentation bug + +If you found a bug in the documentation, including this file, then it's fine to +just link to that web page or mention that source file. You don't need to match +the source to the output or vice versa. + + +### Reporting a website bug + +If the bug is in the documentation (anything under `/docs/`) then please see the +section above. Bugs in the rest of the site are reported to the [website +source repository](https://github.com/glfw/website/issues). + + +## Requesting a feature + +Please explain why you need the feature and how you intend to use it. If you +have a specific API design in mind, please add that as well. If you have or are +planning to write code for the feature, see the section below. + +If there already is a request for the feature you need, add your specific use +case unless it is already mentioned. If it is, give it a :+1:. + + +## Contributing a bug fix + +__Note:__ You must have all necessary [intellectual +property rights](https://en.wikipedia.org/wiki/Intellectual_property) to any +code you contribute. If you did not write the code yourself, you must explain +where it came from and under what license you received it. Even code using the +same license as GLFW may not be copied without attribution. + +__There is no preferred patch size__. A one character fix is just as welcome as +a thousand line one, if that is the appropriate size for the fix. + +In addition to the code, a complete bug fix includes: + +- Change log entry in `README.md`, describing the incorrect behavior +- Credits entries for all authors of the bug fix + +Bug fixes will not be rejected because they don't include all the above parts, +but please keep in mind that maintainer time is finite and that there are many +other bugs and features to work on. + +If the patch fixes a bug introduced after the last release, it should not get +a change log entry. + +If you haven't already, read the excellent article [How to Write a Git Commit +Message](https://chris.beams.io/posts/git-commit/). + + +## Contributing a feature + +__Note:__ You must have all necessary rights to any code you contribute. If you +did not write the code yourself, you must explain where it came from and under +what license. Even code using the same license as GLFW may not be copied +without attribution. + +__Note:__ If you haven't already implemented the feature, check first if there +already is an open issue for it and if it's already being developed in an +[experimental branch](https://github.com/glfw/glfw/branches/all). + +__There is no preferred patch size__. A one-character change is just as welcome +as one adding a thousand lines, if that is the appropriate size for the +feature. + +In addition to the code, a complete feature includes: + +- Change log entry in `README.md`, listing all new symbols +- News page entry, briefly describing the feature +- Guide documentation, with minimal examples, in the relevant guide +- Reference documentation, with all applicable tags +- Cross-references and mentions in appropriate places +- Credits entries for all authors of the feature + +If the feature requires platform-specific code, at minimum stubs must be added +for the new platform function to all supported and experimental platforms. + +If it adds a new callback, support for it must be added to `tests/event.c`. + +If it adds a new monitor property, support for it must be added to +`tests/monitor.c`. + +If it adds a new OpenGL, OpenGL ES or Vulkan option or extension, support +for it must be added to `tests/glfwinfo.c` and the behavior of the library when +the extension is missing documented in `docs/compat.dox`. + +If you haven't already, read the excellent article [How to Write a Git Commit +Message](https://chris.beams.io/posts/git-commit/). + +Features will not be rejected because they don't include all the above parts, +but please keep in mind that maintainer time is finite and that there are many +other features and bugs to work on. + +Please also keep in mind that any part of the public API that has been included +in a release cannot be changed until the next _major_ version. Features can be +added and existing parts can sometimes be overloaded (in the general sense of +doing more things, not in the C++ sense), but code written to the API of one +minor release should both compile and run on subsequent minor releases. + diff --git a/deps/glfw-3.3.8/docs/Doxyfile.in b/deps/glfw-3.3.8/docs/Doxyfile.in new file mode 100644 index 0000000..482b028 --- /dev/null +++ b/deps/glfw-3.3.8/docs/Doxyfile.in @@ -0,0 +1,1828 @@ +# Doxyfile 1.8.3.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" "). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = "GLFW" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = @GLFW_VERSION@ + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "A multi-platform library for OpenGL, window and input" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = "@GLFW_BINARY_DIR@/docs" + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = NO + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = "thread_safety=@par Thread safety^^" \ + "pointer_lifetime=@par Pointer lifetime^^" \ + "analysis=@par Analysis^^" \ + "reentrancy=@par Reentrancy^^" \ + "errors=@par Errors^^" \ + "callback_signature=@par Callback signature^^" \ + "glfw3=__GLFW 3:__" \ + "x11=__X11:__" \ + "wayland=__Wayland:__" \ + "win32=__Windows:__" \ + "macos=__macOS:__" \ + "linux=__Linux:__" + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES (the +# default) will make doxygen replace the get and set methods by a property in +# the documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = YES + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if section-label ... \endif +# and \cond section-label ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = "@GLFW_SOURCE_DIR@/docs/DoxygenLayout.xml" + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. Do not use +# file names with spaces, bibtex cannot handle them. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = "@GLFW_BINARY_DIR@/docs/warnings.txt" + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = @GLFW_DOXYGEN_INPUT@ + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.h *.dox + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = APIENTRY GLFWAPI + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = "@GLFW_SOURCE_DIR@/examples" + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MD_FILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page (index.html). +# This can be useful if you have a project on for instance GitHub and want reuse +# the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = glfw GLFW_ + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = "@GLFW_SOURCE_DIR@/docs/header.html" + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = "@GLFW_SOURCE_DIR@/docs/footer.html" + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = "@GLFW_SOURCE_DIR@/docs/extra.css" + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = "@GLFW_SOURCE_DIR@/docs/spaces.svg" + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 300 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# thA MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and +# SVG. The default value is HTML-CSS, which is slower, but has the best +# compatibility. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. +# However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. +# There are two flavours of web server based search depending on the +# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for +# searching and an index file used by the script. When EXTERNAL_SEARCH is +# enabled the indexing and searching needs to be provided by external tools. +# See the manual for details. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain +# the search results. Doxygen ships with an example indexer (doxyindexer) and +# search engine (doxysearch.cgi) which are based on the open source search engine +# library Xapian. See the manual for configuration details. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will returned the search results when EXTERNAL_SEARCH is enabled. +# Doxygen ships with an example search engine (doxysearch) which is based on +# the open source search engine library Xapian. See the manual for configuration +# details. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH AND EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id +# of to a relative location where the documentation can be found. +# The format is: EXTRA_SEARCH_MAPPINGS = id1=loc1 id2=loc2 ... + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = YES + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = GLFWAPI= \ + GLFW_EXPOSE_NATIVE_WIN32 \ + GLFW_EXPOSE_NATIVE_WGL \ + GLFW_EXPOSE_NATIVE_X11 \ + GLFW_EXPOSE_NATIVE_WAYLAND \ + GLFW_EXPOSE_NATIVE_GLX \ + GLFW_EXPOSE_NATIVE_COCOA \ + GLFW_EXPOSE_NATIVE_NSGL \ + GLFW_EXPOSE_NATIVE_EGL \ + GLFW_EXPOSE_NATIVE_OSMESA \ + VK_VERSION_1_0 + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# manageable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = NO + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/deps/glfw-3.3.8/docs/DoxygenLayout.xml b/deps/glfw-3.3.8/docs/DoxygenLayout.xml new file mode 100644 index 0000000..ab97172 --- /dev/null +++ b/deps/glfw-3.3.8/docs/DoxygenLayout.xml @@ -0,0 +1,71 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/SUPPORT.md b/deps/glfw-3.3.8/docs/SUPPORT.md new file mode 100644 index 0000000..79a45a8 --- /dev/null +++ b/deps/glfw-3.3.8/docs/SUPPORT.md @@ -0,0 +1,14 @@ +# Support resources + +See the [latest documentation](https://www.glfw.org/docs/latest/) for tutorials, +guides and the API reference. + +If you have questions about using GLFW, we have a +[forum](https://discourse.glfw.org/), and the `#glfw` IRC channel on +[Libera.Chat](https://libera.chat/). + +Bugs are reported to our [issue tracker](https://github.com/glfw/glfw/issues). +Please check the [contribution +guide](https://github.com/glfw/glfw/blob/master/docs/CONTRIBUTING.md) for +information on what to include when reporting a bug. + diff --git a/deps/glfw-3.3.8/docs/build.dox b/deps/glfw-3.3.8/docs/build.dox new file mode 100644 index 0000000..adbbb85 --- /dev/null +++ b/deps/glfw-3.3.8/docs/build.dox @@ -0,0 +1,348 @@ +/*! + +@page build_guide Building applications + +@tableofcontents + +This is about compiling and linking applications that use GLFW. For information on +how to write such applications, start with the +[introductory tutorial](@ref quick_guide). For information on how to compile +the GLFW library itself, see @ref compile_guide. + +This is not a tutorial on compilation or linking. It assumes basic +understanding of how to compile and link a C program as well as how to use the +specific compiler of your chosen development environment. The compilation +and linking process should be explained in your C programming material and in +the documentation for your development environment. + + +@section build_include Including the GLFW header file + +You should include the GLFW header in the source files where you use OpenGL or +GLFW. + +@code +#include +@endcode + +This header defines all the constants and declares all the types and function +prototypes of the GLFW API. By default it also includes the OpenGL header from +your development environment. See [option macros](@ref build_macros) below for +how to select OpenGL ES headers and more. + +The GLFW header also defines any platform-specific macros needed by your OpenGL +header, so that it can be included without needing any window system headers. + +It does this only when needed, so if window system headers are included, the +GLFW header does not try to redefine those symbols. The reverse is not true, +i.e. `windows.h` cannot cope if any Win32 symbols have already been defined. + +In other words: + + - Use the GLFW header to include OpenGL or OpenGL ES headers portably + - Do not include window system headers unless you will use those APIs directly + - If you do need such headers, include them before the GLFW header + +If you are using an OpenGL extension loading library such as +[glad](https://github.com/Dav1dde/glad), the extension loader header should +be included before the GLFW one. GLFW attempts to detect any OpenGL or OpenGL +ES header or extension loader header included before it and will then disable +the inclusion of the default OpenGL header. Most extension loaders also define +macros that disable similar headers below it. + +@code +#include +#include +@endcode + +Both of these mechanisms depend on the extension loader header defining a known +macro. If yours doesn't or you don't know which one your users will pick, the +@ref GLFW_INCLUDE_NONE macro will explicitly prevent the GLFW header from +including the OpenGL header. This will also allow you to include the two +headers in any order. + +@code +#define GLFW_INCLUDE_NONE +#include +#include +@endcode + + +@subsection build_macros GLFW header option macros + +These macros may be defined before the inclusion of the GLFW header and affect +its behavior. + +@anchor GLFW_DLL +__GLFW_DLL__ is required on Windows when using the GLFW DLL, to tell the +compiler that the GLFW functions are defined in a DLL. + +The following macros control which OpenGL or OpenGL ES API header is included. +Only one of these may be defined at a time. + +@note GLFW does not provide any of the API headers mentioned below. They are +provided by your development environment or your OpenGL, OpenGL ES or Vulkan +SDK, and most of them can be downloaded from the +[Khronos Registry](https://www.khronos.org/registry/). + +@anchor GLFW_INCLUDE_GLCOREARB +__GLFW_INCLUDE_GLCOREARB__ makes the GLFW header include the modern +`GL/glcorearb.h` header (`OpenGL/gl3.h` on macOS) instead of the regular OpenGL +header. + +@anchor GLFW_INCLUDE_ES1 +__GLFW_INCLUDE_ES1__ makes the GLFW header include the OpenGL ES 1.x `GLES/gl.h` +header instead of the regular OpenGL header. + +@anchor GLFW_INCLUDE_ES2 +__GLFW_INCLUDE_ES2__ makes the GLFW header include the OpenGL ES 2.0 +`GLES2/gl2.h` header instead of the regular OpenGL header. + +@anchor GLFW_INCLUDE_ES3 +__GLFW_INCLUDE_ES3__ makes the GLFW header include the OpenGL ES 3.0 +`GLES3/gl3.h` header instead of the regular OpenGL header. + +@anchor GLFW_INCLUDE_ES31 +__GLFW_INCLUDE_ES31__ makes the GLFW header include the OpenGL ES 3.1 +`GLES3/gl31.h` header instead of the regular OpenGL header. + +@anchor GLFW_INCLUDE_ES32 +__GLFW_INCLUDE_ES32__ makes the GLFW header include the OpenGL ES 3.2 +`GLES3/gl32.h` header instead of the regular OpenGL header. + +@anchor GLFW_INCLUDE_NONE +__GLFW_INCLUDE_NONE__ makes the GLFW header not include any OpenGL or OpenGL ES +API header. This is useful in combination with an extension loading library. + +If none of the above inclusion macros are defined, the standard OpenGL `GL/gl.h` +header (`OpenGL/gl.h` on macOS) is included, unless GLFW detects the inclusion +guards of any OpenGL, OpenGL ES or extension loader header it knows about. + +The following macros control the inclusion of additional API headers. Any +number of these may be defined simultaneously, and/or together with one of the +above macros. + +@anchor GLFW_INCLUDE_VULKAN +__GLFW_INCLUDE_VULKAN__ makes the GLFW header include the Vulkan +`vulkan/vulkan.h` header in addition to any selected OpenGL or OpenGL ES header. + +@anchor GLFW_INCLUDE_GLEXT +__GLFW_INCLUDE_GLEXT__ makes the GLFW header include the appropriate extension +header for the OpenGL or OpenGL ES header selected above after and in addition +to that header. + +@anchor GLFW_INCLUDE_GLU +__GLFW_INCLUDE_GLU__ makes the header include the GLU header in addition to the +header selected above. This should only be used with the standard OpenGL header +and only for compatibility with legacy code. GLU has been deprecated and should +not be used in new code. + +@note None of these macros may be defined during the compilation of GLFW itself. +If your build includes GLFW and you define any these in your build files, make +sure they are not applied to the GLFW sources. + + +@section build_link Link with the right libraries + +GLFW is essentially a wrapper of various platform-specific APIs and therefore +needs to link against many different system libraries. If you are using GLFW as +a shared library / dynamic library / DLL then it takes care of these links. +However, if you are using GLFW as a static library then your executable will +need to link against these libraries. + +On Windows and macOS, the list of system libraries is static and can be +hard-coded into your build environment. See the section for your development +environment below. On Linux and other Unix-like operating systems, the list +varies but can be retrieved in various ways as described below. + +A good general introduction to linking is +[Beginner's Guide to Linkers](https://www.lurklurk.org/linkers/linkers.html) by +David Drysdale. + + +@subsection build_link_win32 With MinGW or Visual C++ on Windows + +The static version of the GLFW library is named `glfw3`. When using this +version, it is also necessary to link with some libraries that GLFW uses. + +When using MinGW to link an application with the static version of GLFW, you +must also explicitly link with `gdi32`. Other toolchains including MinGW-w64 +include it in the set of default libraries along with other dependencies like +`user32` and `kernel32`. + +The link library for the GLFW DLL is named `glfw3dll`. When compiling an +application that uses the DLL version of GLFW, you need to define the @ref +GLFW_DLL macro _before_ any inclusion of the GLFW header. This can be done +either with a compiler switch or by defining it in your source code. + + +@subsection build_link_cmake_source With CMake and GLFW source + +This section is about using CMake to compile and link GLFW along with your +application. If you want to use an installed binary instead, see @ref +build_link_cmake_package. + +With a few changes to your `CMakeLists.txt` you can have the GLFW source tree +built along with your application. + +When including GLFW as part of your build, you probably don't want to build the +GLFW tests, examples and documentation. To disable these, set the corresponding +cache variables before adding the GLFW source tree. + +@code +set(GLFW_BUILD_DOCS OFF CACHE BOOL "" FORCE) +set(GLFW_BUILD_TESTS OFF CACHE BOOL "" FORCE) +set(GLFW_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE) +@endcode + +Add the root directory of the GLFW source tree to your project. This will add +the `glfw` target to your project. + +@code{.cmake} +add_subdirectory(path/to/glfw) +@endcode + +Once GLFW has been added, link your application against the `glfw` target. +This adds the GLFW library and its link-time dependencies as it is currently +configured, the include directory for the GLFW header and, when applicable, the +@ref GLFW_DLL macro. + +@code{.cmake} +target_link_libraries(myapp glfw) +@endcode + +Note that the `glfw` target does not depend on OpenGL, as GLFW loads any OpenGL, +OpenGL ES or Vulkan libraries it needs at runtime. If your application calls +OpenGL directly, instead of using a modern +[extension loader library](@ref context_glext_auto), use the OpenGL CMake +package. + +@code{.cmake} +find_package(OpenGL REQUIRED) +@endcode + +If OpenGL is found, the `OpenGL::GL` target is added to your project, containing +library and include directory paths. Link against this like any other library. + +@code{.cmake} +target_link_libraries(myapp OpenGL::GL) +@endcode + +For a minimal example of a program and GLFW sources built with CMake, see the +[GLFW CMake Starter](https://github.com/juliettef/GLFW-CMake-starter) on GitHub. + + +@subsection build_link_cmake_package With CMake and installed GLFW binaries + +This section is about using CMake to link GLFW after it has been built and +installed. If you want to build it along with your application instead, see +@ref build_link_cmake_source. + +With a few changes to your `CMakeLists.txt` you can locate the package and +target files generated when GLFW is installed. + +@code{.cmake} +find_package(glfw3 3.3 REQUIRED) +@endcode + +Once GLFW has been added to the project, link against it with the `glfw` target. +This adds the GLFW library and its link-time dependencies, the include directory +for the GLFW header and, when applicable, the @ref GLFW_DLL macro. + +@code{.cmake} +target_link_libraries(myapp glfw) +@endcode + +Note that the `glfw` target does not depend on OpenGL, as GLFW loads any OpenGL, +OpenGL ES or Vulkan libraries it needs at runtime. If your application calls +OpenGL directly, instead of using a modern +[extension loader library](@ref context_glext_auto), use the OpenGL CMake +package. + +@code{.cmake} +find_package(OpenGL REQUIRED) +@endcode + +If OpenGL is found, the `OpenGL::GL` target is added to your project, containing +library and include directory paths. Link against this like any other library. + +@code{.cmake} +target_link_libraries(myapp OpenGL::GL) +@endcode + + +@subsection build_link_pkgconfig With makefiles and pkg-config on Unix + +GLFW supports [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/), +and the `glfw3.pc` pkg-config file is generated when the GLFW library is built +and is installed along with it. A pkg-config file describes all necessary +compile-time and link-time flags and dependencies needed to use a library. When +they are updated or if they differ between systems, you will get the correct +ones automatically. + +A typical compile and link command-line when using the static version of the +GLFW library may look like this: + +@code{.sh} +cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --static --libs glfw3) +@endcode + +If you are using the shared version of the GLFW library, omit the `--static` +flag. + +@code{.sh} +cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --libs glfw3) +@endcode + +You can also use the `glfw3.pc` file without installing it first, by using the +`PKG_CONFIG_PATH` environment variable. + +@code{.sh} +env PKG_CONFIG_PATH=path/to/glfw/src cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --libs glfw3) +@endcode + +The dependencies do not include OpenGL, as GLFW loads any OpenGL, OpenGL ES or +Vulkan libraries it needs at runtime. If your application calls OpenGL +directly, instead of using a modern +[extension loader library](@ref context_glext_auto), you should add the `gl` +pkg-config package. + +@code{.sh} +cc $(pkg-config --cflags glfw3 gl) -o myprog myprog.c $(pkg-config --libs glfw3 gl) +@endcode + + +@subsection build_link_xcode With Xcode on macOS + +If you are using the dynamic library version of GLFW, add it to the project +dependencies. + +If you are using the static library version of GLFW, add it and the Cocoa, +OpenGL and IOKit frameworks to the project as dependencies. They can all be +found in `/System/Library/Frameworks`. + + +@subsection build_link_osx With command-line on macOS + +It is recommended that you use [pkg-config](@ref build_link_pkgconfig) when +building from the command line on macOS. That way you will get any new +dependencies added automatically. If you still wish to build manually, you need +to add the required frameworks and libraries to your command-line yourself using +the `-l` and `-framework` switches. + +If you are using the dynamic GLFW library, which is named `libglfw.3.dylib`, do: + +@code{.sh} +cc -o myprog myprog.c -lglfw -framework Cocoa -framework OpenGL -framework IOKit +@endcode + +If you are using the static library, named `libglfw3.a`, substitute `-lglfw3` +for `-lglfw`. + +Note that you do not add the `.framework` extension to a framework when linking +against it from the command-line. + +@note Your machine may have `libGL.*.dylib` style OpenGL library, but that is +for the X Window System and will not work with the macOS native version of GLFW. + +*/ diff --git a/deps/glfw-3.3.8/docs/compat.dox b/deps/glfw-3.3.8/docs/compat.dox new file mode 100644 index 0000000..0b7c4b0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/compat.dox @@ -0,0 +1,281 @@ +/*! + +@page compat_guide Standards conformance + +@tableofcontents + +This guide describes the various API extensions used by this version of GLFW. +It lists what are essentially implementation details, but which are nonetheless +vital knowledge for developers intending to deploy their applications on a wide +range of machines. + +The information in this guide is not a part of GLFW API, but merely +preconditions for some parts of the library to function on a given machine. Any +part of this information may change in future versions of GLFW and that will not +be considered a breaking API change. + + +@section compat_x11 X11 extensions, protocols and IPC standards + +As GLFW uses Xlib directly, without any intervening toolkit +library, it has sole responsibility for interacting well with the many and +varied window managers in use on Unix-like systems. In order for applications +and window managers to work well together, a number of standards and +conventions have been developed that regulate behavior outside the scope of the +X11 API; most importantly the +[Inter-Client Communication Conventions Manual](https://www.tronche.com/gui/x/icccm/) +(ICCCM) and +[Extended Window Manager Hints](https://standards.freedesktop.org/wm-spec/wm-spec-latest.html) +(EWMH) standards. + +GLFW uses the `_MOTIF_WM_HINTS` window property to support borderless windows. +If the running window manager does not support this property, the +`GLFW_DECORATED` hint will have no effect. + +GLFW uses the ICCCM `WM_DELETE_WINDOW` protocol to intercept the user +attempting to close the GLFW window. If the running window manager does not +support this protocol, the close callback will never be called. + +GLFW uses the EWMH `_NET_WM_PING` protocol, allowing the window manager notify +the user when the application has stopped responding, i.e. when it has ceased to +process events. If the running window manager does not support this protocol, +the user will not be notified if the application locks up. + +GLFW uses the EWMH `_NET_WM_STATE_FULLSCREEN` window state to tell the window +manager to make the GLFW window full screen. If the running window manager does +not support this state, full screen windows may not work properly. GLFW has +a fallback code path in case this state is unavailable, but every window manager +behaves slightly differently in this regard. + +GLFW uses the EWMH `_NET_WM_BYPASS_COMPOSITOR` window property to tell a +compositing window manager to un-redirect full screen GLFW windows. If the +running window manager uses compositing but does not support this property then +additional copying may be performed for each buffer swap of full screen windows. + +GLFW uses the +[clipboard manager protocol](https://www.freedesktop.org/wiki/ClipboardManager/) +to push a clipboard string (i.e. selection) owned by a GLFW window about to be +destroyed to the clipboard manager. If there is no running clipboard manager, +the clipboard string will be unavailable once the window has been destroyed. + +GLFW uses the +[X drag-and-drop protocol](https://www.freedesktop.org/wiki/Specifications/XDND/) +to provide file drop events. If the application originating the drag does not +support this protocol, drag and drop will not work. + +GLFW uses the XRandR 1.3 extension to provide multi-monitor support. If the +running X server does not support this version of this extension, multi-monitor +support will not function and only a single, desktop-spanning monitor will be +reported. + +GLFW uses the XRandR 1.3 and Xf86vidmode extensions to provide gamma ramp +support. If the running X server does not support either or both of these +extensions, gamma ramp support will not function. + +GLFW uses the Xkb extension and detectable auto-repeat to provide keyboard +input. If the running X server does not support this extension, a non-Xkb +fallback path is used. + +GLFW uses the XInput2 extension to provide raw, non-accelerated mouse motion +when the cursor is disabled. If the running X server does not support this +extension, regular accelerated mouse motion will be used. + +GLFW uses both the XRender extension and the compositing manager to support +transparent window framebuffers. If the running X server does not support this +extension or there is no running compositing manager, the +`GLFW_TRANSPARENT_FRAMEBUFFER` framebuffer hint will have no effect. + + +@section compat_wayland Wayland protocols and IPC standards + +As GLFW uses libwayland directly, without any intervening toolkit library, it +has sole responsibility for interacting well with every compositor in use on +Unix-like systems. Most of the features are provided by the core protocol, +while cursor support is provided by the libwayland-cursor helper library, EGL +integration by libwayland-egl, and keyboard handling by +[libxkbcommon](https://xkbcommon.org/). In addition, GLFW uses some protocols +from wayland-protocols to provide additional features if the compositor +supports them. + +GLFW uses xkbcommon 0.5.0 to provide compose key support. When it has been +built against an older xkbcommon, the compose key will be disabled even if it +has been configured in the compositor. + +GLFW uses the [xdg-shell +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/stable/xdg-shell/xdg-shell.xml) +to provide better window management. This protocol is part of +wayland-protocols 1.12, and mandatory at build time. + +GLFW uses the [relative pointer +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/relative-pointer/relative-pointer-unstable-v1.xml) +alongside the [pointer constraints +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/pointer-constraints/pointer-constraints-unstable-v1.xml) +to implement disabled cursor. These two protocols are part of +wayland-protocols 1.1, and mandatory at build time. If the running compositor +does not support both of these protocols, disabling the cursor will have no +effect. + +GLFW uses the [idle inhibit +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/idle-inhibit/idle-inhibit-unstable-v1.xml) +to prohibit the screensaver from starting. This protocol is part of +wayland-protocols 1.6, and mandatory at build time. If the running compositor +does not support this protocol, the screensaver may start even for full screen +windows. + +GLFW uses the [xdg-decoration +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/unstable/xdg-decoration/xdg-decoration-unstable-v1.xml) +to request decorations to be drawn around its windows. This protocol is part +of wayland-protocols 1.15, and mandatory at build time. If the running +compositor does not support this protocol, a very simple frame will be drawn by +GLFW itself, using the [viewporter +protocol](https://cgit.freedesktop.org/wayland/wayland-protocols/tree/stable/viewporter/viewporter.xml) +alongside +[subsurfaces](https://cgit.freedesktop.org/wayland/wayland/tree/protocol/wayland.xml#n2598). +This protocol is part of wayland-protocols 1.4, and mandatory at build time. +If the running compositor does not support this protocol either, no decorations +will be drawn around windows. + + +@section compat_glx GLX extensions + +The GLX API is the default API used to create OpenGL contexts on Unix-like +systems using the X Window System. + +GLFW uses the GLX 1.3 `GLXFBConfig` functions to enumerate and select framebuffer pixel +formats. If GLX 1.3 is not supported, @ref glfwInit will fail. + +GLFW uses the `GLX_MESA_swap_control,` `GLX_EXT_swap_control` and +`GLX_SGI_swap_control` extensions to provide vertical retrace synchronization +(or _vsync_), in that order of preference. Where none of these extension are +available, calling @ref glfwSwapInterval will have no effect. + +GLFW uses the `GLX_ARB_multisample` extension to create contexts with +multisampling anti-aliasing. Where this extension is unavailable, the +`GLFW_SAMPLES` hint will have no effect. + +GLFW uses the `GLX_ARB_create_context` extension when available, even when +creating OpenGL contexts of version 2.1 and below. Where this extension is +unavailable, the `GLFW_CONTEXT_VERSION_MAJOR` and `GLFW_CONTEXT_VERSION_MINOR` +hints will only be partially supported, the `GLFW_OPENGL_DEBUG_CONTEXT` hint +will have no effect, and setting the `GLFW_OPENGL_PROFILE` or +`GLFW_OPENGL_FORWARD_COMPAT` hints to `GLFW_TRUE` will cause @ref +glfwCreateWindow to fail. + +GLFW uses the `GLX_ARB_create_context_profile` extension to provide support for +context profiles. Where this extension is unavailable, setting the +`GLFW_OPENGL_PROFILE` hint to anything but `GLFW_OPENGL_ANY_PROFILE`, or setting +`GLFW_CLIENT_API` to anything but `GLFW_OPENGL_API` or `GLFW_NO_API` will cause +@ref glfwCreateWindow to fail. + +GLFW uses the `GLX_ARB_context_flush_control` extension to provide control over +whether a context is flushed when it is released (made non-current). Where this +extension is unavailable, the `GLFW_CONTEXT_RELEASE_BEHAVIOR` hint will have no +effect and the context will always be flushed when released. + +GLFW uses the `GLX_ARB_framebuffer_sRGB` and `GLX_EXT_framebuffer_sRGB` +extensions to provide support for sRGB framebuffers. Where both of these +extensions are unavailable, the `GLFW_SRGB_CAPABLE` hint will have no effect. + + +@section compat_wgl WGL extensions + +The WGL API is used to create OpenGL contexts on Microsoft Windows and other +implementations of the Win32 API, such as Wine. + +GLFW uses either the `WGL_EXT_extension_string` or the +`WGL_ARB_extension_string` extension to check for the presence of all other WGL +extensions listed below. If both are available, the EXT one is preferred. If +neither is available, no other extensions are used and many GLFW features +related to context creation will have no effect or cause errors when used. + +GLFW uses the `WGL_EXT_swap_control` extension to provide vertical retrace +synchronization (or _vsync_). Where this extension is unavailable, calling @ref +glfwSwapInterval will have no effect. + +GLFW uses the `WGL_ARB_pixel_format` and `WGL_ARB_multisample` extensions to +create contexts with multisampling anti-aliasing. Where these extensions are +unavailable, the `GLFW_SAMPLES` hint will have no effect. + +GLFW uses the `WGL_ARB_create_context` extension when available, even when +creating OpenGL contexts of version 2.1 and below. Where this extension is +unavailable, the `GLFW_CONTEXT_VERSION_MAJOR` and `GLFW_CONTEXT_VERSION_MINOR` +hints will only be partially supported, the `GLFW_OPENGL_DEBUG_CONTEXT` hint +will have no effect, and setting the `GLFW_OPENGL_PROFILE` or +`GLFW_OPENGL_FORWARD_COMPAT` hints to `GLFW_TRUE` will cause @ref +glfwCreateWindow to fail. + +GLFW uses the `WGL_ARB_create_context_profile` extension to provide support for +context profiles. Where this extension is unavailable, setting the +`GLFW_OPENGL_PROFILE` hint to anything but `GLFW_OPENGL_ANY_PROFILE` will cause +@ref glfwCreateWindow to fail. + +GLFW uses the `WGL_ARB_context_flush_control` extension to provide control over +whether a context is flushed when it is released (made non-current). Where this +extension is unavailable, the `GLFW_CONTEXT_RELEASE_BEHAVIOR` hint will have no +effect and the context will always be flushed when released. + +GLFW uses the `WGL_ARB_framebuffer_sRGB` and `WGL_EXT_framebuffer_sRGB` +extensions to provide support for sRGB framebuffers. Where both of these +extension are unavailable, the `GLFW_SRGB_CAPABLE` hint will have no effect. + + +@section compat_osx OpenGL on macOS + +Support for OpenGL 3.2 and above was introduced with OS X 10.7 and even then +only forward-compatible, core profile contexts are supported. Support for +OpenGL 4.1 was introduced with OS X 10.9, also limited to forward-compatible, +core profile contexts. There is also still no mechanism for requesting debug +contexts or no-error contexts. Versions of Mac OS X earlier than 10.7 support +at most OpenGL version 2.1. + +Because of this, on OS X 10.7 and later, the `GLFW_CONTEXT_VERSION_MAJOR` and +`GLFW_CONTEXT_VERSION_MINOR` hints will cause @ref glfwCreateWindow to fail if +given version 3.0 or 3.1. The `GLFW_OPENGL_FORWARD_COMPAT` hint must be set to +`GLFW_TRUE` and the `GLFW_OPENGL_PROFILE` hint must be set to +`GLFW_OPENGL_CORE_PROFILE` when creating OpenGL 3.2 and later contexts. The +`GLFW_OPENGL_DEBUG_CONTEXT` and `GLFW_CONTEXT_NO_ERROR` hints are ignored. + +Also, on Mac OS X 10.6 and below, the `GLFW_CONTEXT_VERSION_MAJOR` and +`GLFW_CONTEXT_VERSION_MINOR` hints will fail if given a version above 2.1, +setting the `GLFW_OPENGL_PROFILE` or `GLFW_OPENGL_FORWARD_COMPAT` hints to +a non-default value will cause @ref glfwCreateWindow to fail and the +`GLFW_OPENGL_DEBUG_CONTEXT` hint is ignored. + + +@section compat_vulkan Vulkan loader and API + +By default, GLFW uses the standard system-wide Vulkan loader to access the +Vulkan API on all platforms except macOS. This is installed by both graphics +drivers and Vulkan SDKs. If either the loader or at least one minimally +functional ICD is missing, @ref glfwVulkanSupported will return `GLFW_FALSE` and +all other Vulkan-related functions will fail with an @ref GLFW_API_UNAVAILABLE +error. + + +@section compat_wsi Vulkan WSI extensions + +The Vulkan WSI extensions are used to create Vulkan surfaces for GLFW windows on +all supported platforms. + +GLFW uses the `VK_KHR_surface` and `VK_KHR_win32_surface` extensions to create +surfaces on Microsoft Windows. If any of these extensions are not available, +@ref glfwGetRequiredInstanceExtensions will return an empty list and window +surface creation will fail. + +GLFW uses the `VK_KHR_surface` and either the `VK_MVK_macos_surface` or +`VK_EXT_metal_surface` extensions to create surfaces on macOS. If any of these +extensions are not available, @ref glfwGetRequiredInstanceExtensions will +return an empty list and window surface creation will fail. + +GLFW uses the `VK_KHR_surface` and either the `VK_KHR_xlib_surface` or +`VK_KHR_xcb_surface` extensions to create surfaces on X11. If `VK_KHR_surface` +or both `VK_KHR_xlib_surface` and `VK_KHR_xcb_surface` are not available, @ref +glfwGetRequiredInstanceExtensions will return an empty list and window surface +creation will fail. + +GLFW uses the `VK_KHR_surface` and `VK_KHR_wayland_surface` extensions to create +surfaces on Wayland. If any of these extensions are not available, @ref +glfwGetRequiredInstanceExtensions will return an empty list and window surface +creation will fail. + +*/ diff --git a/deps/glfw-3.3.8/docs/compile.dox b/deps/glfw-3.3.8/docs/compile.dox new file mode 100644 index 0000000..ec458f4 --- /dev/null +++ b/deps/glfw-3.3.8/docs/compile.dox @@ -0,0 +1,367 @@ +/*! + +@page compile_guide Compiling GLFW + +@tableofcontents + +This is about compiling the GLFW library itself. For information on how to +build applications that use GLFW, see @ref build_guide. + + +@section compile_cmake Using CMake + +@note GLFW behaves like most other libraries that use CMake so this guide mostly +describes the basic configure/generate/compile sequence. If you are already +familiar with this from other projects, you may want to focus on the @ref +compile_deps and @ref compile_options sections for GLFW-specific information. + +GLFW uses [CMake](https://cmake.org/) to generate project files or makefiles +for your chosen development environment. To compile GLFW, first generate these +files with CMake and then use them to compile the GLFW library. + +If you are on Windows and macOS you can +[download CMake](https://cmake.org/download/) from their site. + +If you are on a Unix-like system such as Linux, FreeBSD or Cygwin or have +a package system like Fink, MacPorts or Homebrew, you can install its CMake +package. + +CMake is a complex tool and this guide will only show a few of the possible ways +to set up and compile GLFW. The CMake project has their own much more detailed +[CMake user guide](https://cmake.org/cmake/help/latest/guide/user-interaction/) +that includes everything in this guide not specific to GLFW. It may be a useful +companion to this one. + + +@subsection compile_deps Installing dependencies + +The C/C++ development environments in Visual Studio, Xcode and MinGW come with +all necessary dependencies for compiling GLFW, but on Unix-like systems like +Linux and FreeBSD you will need a few extra packages. + + +@subsubsection compile_deps_x11 Dependencies for X11 on Unix-like systems + +To compile GLFW for X11, you need to have the X11 development packages +installed. They are not needed to build or run programs that use GLFW. + +On Debian and derivates like Ubuntu and Linux Mint the `xorg-dev` meta-package +pulls in the development packages for all of X11. + +@code{.sh} +sudo apt install xorg-dev +@endcode + +On Fedora and derivatives like Red Hat the X11 extension packages +`libXcursor-devel`, `libXi-devel`, `libXinerama-devel` and `libXrandr-devel` +required by GLFW pull in all its other dependencies. + +@code{.sh} +sudo dnf install libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel +@endcode + +On FreeBSD the X11 headers are installed along the end-user X11 packages, so if +you have an X server running you should have the headers as well. If not, +install the `xorgproto` package. + +@code{.sh} +pkg install xorgproto +@endcode + +On Cygwin the `libXcursor-devel`, `libXi-devel`, `libXinerama-devel`, +`libXrandr-devel` and `libXrender-devel` packages in the Libs section of the GUI +installer will install all the headers and other development related files GLFW +requires for X11. + +Once you have the required depdendencies, move on to @ref compile_generate. + + +@subsubsection compile_deps_wayland Dependencies for Wayland on Unix-like systems + +To compile GLFW for Wayland, you need to have the Wayland and xkbcommon +development packages installed. They are not needed to build or run programs +that use GLFW. + +On Debian and derivates like Ubuntu and Linux Mint you will need the `libwayland-dev`, +`libxkbcommon-dev`, `wayland-protocols` and `extra-cmake-modules` packages. + +@code{.sh} +sudo apt install libwayland-dev libxkbcommon-dev wayland-protocols extra-cmake-modules +@endcode + +On Fedora and derivatives like Red Hat you will need the `wayland-devel`, +`libxkbcommon-devel`, `wayland-protocols-devel` and `extra-cmake-modules` packages. + +@code{.sh} +sudo dnf install wayland-devel libxkbcommon-devel wayland-protocols-devel extra-cmake-modules +@endcode + +On FreeBSD you will need the `wayland`, `libxkbcommon`, `wayland-protocols` and +`kf5-extra-cmake-modules` packages. + +@code{.sh} +pkg install wayland libxkbcommon wayland-protocols kf5-extra-cmake-modules +@endcode + +Once you have the required depdendencies, move on to @ref compile_generate. + + +@subsection compile_generate Generating build files with CMake + +Once you have all necessary dependencies it is time to generate the project +files or makefiles for your development environment. CMake needs two paths for +this: + + - the path to the root directory of the GLFW source tree (not its `src` + subdirectory) + - the path to the directory where the generated build files and compiled + binaries will be placed + +If these are the same, it is called an in-tree build, otherwise it is called an +out-of-tree build. + +Out-of-tree builds are recommended as they avoid cluttering up the source tree. +They also allow you to have several build directories for different +configurations all using the same source tree. + +A common pattern when building a single configuration is to have a build +directory named `build` in the root of the source tree. + + +@subsubsection compile_generate_gui Generating files with the CMake GUI + +Start the CMake GUI and set the paths to the source and build directories +described above. Then press _Configure_ and _Generate_. + +If you wish change any CMake variables in the list, press _Configure_ and then +_Generate_ to have the new values take effect. The variable list will be +populated after the first configure step. + +By default GLFW will use X11 on Linux and other Unix-like systems other +than macOS. To use Wayland instead, set the `GLFW_USE_WAYLAND` option in the +GLFW section of the variable list, then apply the new value as described above. + +Once you have generated the project files or makefiles for your chosen +development environment, move on to @ref compile_compile. + + +@subsubsection compile_generate_cli Generating files with the CMake command-line tool + +To make a build directory, pass the source and build directories to the `cmake` +command. These can be relative or absolute paths. The build directory is +created if it doesn't already exist. + +@code{.sh} +cmake -S path/to/glfw -B path/to/build +@endcode + +It is common to name the build directory `build` and place it in the root of the +source tree when only planning to build a single configuration. + +@code{.sh} +cd path/to/glfw +cmake -S . -B build +@endcode + +Without other flags these will generate Visual Studio project files on Windows +and makefiles on other platforms. You can choose other targets using the `-G` +flag. + +@code{.sh} +cmake -S path/to/glfw -B path/to/build -G Xcode +@endcode + +By default GLFW will use X11 on Linux and other Unix-like systems other +than macOS. To use Wayland instead, set the `GLFW_USE_WAYLAND` CMake option. + +@code{.sh} +cmake -S path/to/glfw -B path/to/build -D GLFW_USE_WAYLAND=1 +@endcode + +Once you have generated the project files or makefiles for your chosen +development environment, move on to @ref compile_compile. + + +@subsection compile_compile Compiling the library + +You should now have all required dependencies and the project files or makefiles +necessary to compile GLFW. Go ahead and compile the actual GLFW library with +these files as you would with any other project. + +With Visual Studio open `GLFW.sln` and use the Build menu. With Xcode open +`GLFW.xcodeproj` and use the Project menu. + +With Linux, macOS and other forms of Unix, run `make`. + +@code{.sh} +cd path/to/build +make +@endcode + +With MinGW, it is `mingw32-make`. + +@code{.sh} +cd path/to/build +mingw32-make +@endcode + +Any CMake build directory can also be built with the `cmake` command and the +`--build` flag. + +@code{.sh} +cmake --build path/to/build +@endcode + +This will run the platform specific build tool the directory was generated for. + +Once the GLFW library is compiled you are ready to build your application, +linking it to the GLFW library. See @ref build_guide for more information. + + +@section compile_options CMake options + +The CMake files for GLFW provide a number of options, although not all are +available on all supported platforms. Some of these are de facto standards +among projects using CMake and so have no `GLFW_` prefix. + +If you are using the GUI version of CMake, these are listed and can be changed +from there. If you are using the command-line version of CMake you can use the +`ccmake` ncurses GUI to set options. Some package systems like Ubuntu and other +distributions based on Debian GNU/Linux have this tool in a separate +`cmake-curses-gui` package. + +Finally, if you don't want to use any GUI, you can set options from the `cmake` +command-line with the `-D` flag. + +@code{.sh} +cmake -S path/to/glfw -B path/to/build -D BUILD_SHARED_LIBS=ON +@endcode + + +@subsection compile_options_shared Shared CMake options + +@anchor BUILD_SHARED_LIBS +__BUILD_SHARED_LIBS__ determines whether GLFW is built as a static +library or as a DLL / shared library / dynamic library. This is disabled by +default, producing a static GLFW library. + +@anchor GLFW_BUILD_EXAMPLES +__GLFW_BUILD_EXAMPLES__ determines whether the GLFW examples are built +along with the library. + +@anchor GLFW_BUILD_TESTS +__GLFW_BUILD_TESTS__ determines whether the GLFW test programs are +built along with the library. + +@anchor GLFW_BUILD_DOCS +__GLFW_BUILD_DOCS__ determines whether the GLFW documentation is built along +with the library. This is enabled by default if +[Doxygen](https://www.doxygen.nl/) is found by CMake during configuration. + +@anchor GLFW_VULKAN_STATIC +__GLFW_VULKAN_STATIC__ determines whether to use the Vulkan loader linked +directly with the application. This is disabled by default. + + +@subsection compile_options_win32 Windows specific CMake options + +@anchor USE_MSVC_RUNTIME_LIBRARY_DLL +__USE_MSVC_RUNTIME_LIBRARY_DLL__ determines whether to use the DLL version or the +static library version of the Visual C++ runtime library. When enabled, the +DLL version of the Visual C++ library is used. This is enabled by default. + +On CMake 3.15 and later you can set the standard CMake +[CMAKE_MSVC_RUNTIME_LIBRARY](https://cmake.org/cmake/help/latest/variable/CMAKE_MSVC_RUNTIME_LIBRARY.html) +variable instead of this GLFW-specific option. + +@anchor GLFW_USE_HYBRID_HPG +__GLFW_USE_HYBRID_HPG__ determines whether to export the `NvOptimusEnablement` and +`AmdPowerXpressRequestHighPerformance` symbols, which force the use of the +high-performance GPU on Nvidia Optimus and AMD PowerXpress systems. These symbols +need to be exported by the EXE to be detected by the driver, so the override +will not work if GLFW is built as a DLL. This is disabled by default, letting +the operating system and driver decide. + + +@subsection compile_options_wayland Wayland specific CMake options + +@anchor GLFW_USE_WAYLAND +__GLFW_USE_WAYLAND__ determines whether to compile the library for Wayland. +This option is only available on Linux and other Unix-like systems other than +macOS. This is disabled by default. + + +@section compile_mingw_cross Cross-compilation with CMake and MinGW + +Both Cygwin and many Linux distributions have MinGW or MinGW-w64 packages. For +example, Cygwin has the `mingw64-i686-gcc` and `mingw64-x86_64-gcc` packages +for 32- and 64-bit version of MinGW-w64, while Debian GNU/Linux and derivatives +like Ubuntu have the `mingw-w64` package for both. + +GLFW has CMake toolchain files in the `CMake` subdirectory that set up +cross-compilation of Windows binaries. To use these files you set the +`CMAKE_TOOLCHAIN_FILE` CMake variable with the `-D` flag add an option when +configuring and generating the build files. + +@code{.sh} +cmake -S path/to/glfw -B path/to/build -D CMAKE_TOOLCHAIN_FILE=path/to/file +@endcode + +The exact toolchain file to use depends on the prefix used by the MinGW or +MinGW-w64 binaries on your system. You can usually see this in the /usr +directory. For example, both the Ubuntu and Cygwin MinGW-w64 packages have +`/usr/x86_64-w64-mingw32` for the 64-bit compilers, so the correct invocation +would be: + +@code{.sh} +cmake -S path/to/glfw -B path/to/build -D CMAKE_TOOLCHAIN_FILE=CMake/x86_64-w64-mingw32.cmake +@endcode + +The path to the toolchain file is relative to the path to the GLFW source tree +passed to the `-S` flag, not to the current directory. + +For more details see the +[CMake toolchain guide](https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html). + + +@section compile_manual Compiling GLFW manually + +If you wish to compile GLFW without its CMake build environment then you will +have to do at least some of the platform detection yourself. GLFW needs +a configuration macro to be defined in order to know what window system it is +being compiled for and also has optional, platform-specific ones for various +features. + +When building with CMake, the `glfw_config.h` configuration header is generated +based on the current platform and CMake options. The GLFW CMake environment +defines @b GLFW_USE_CONFIG_H, which causes this header to be included by +`internal.h`. Without this macro, GLFW will expect the necessary configuration +macros to be defined on the command-line. + +The window creation API is used to create windows, handle input, monitors, gamma +ramps and clipboard. The options are: + + - @b _GLFW_COCOA to use the Cocoa frameworks + - @b _GLFW_WIN32 to use the Win32 API + - @b _GLFW_X11 to use the X Window System + - @b _GLFW_WAYLAND to use the Wayland API (experimental and incomplete) + - @b _GLFW_OSMESA to use the OSMesa API (headless and non-interactive) + +If you are building GLFW as a shared library / dynamic library / DLL then you +must also define @b _GLFW_BUILD_DLL. Otherwise, you must not define it. + +If you are linking the Vulkan loader directly with your application then you +must also define @b _GLFW_VULKAN_STATIC. Otherwise, GLFW will attempt to use the +external version. + +If you are using a custom name for the Vulkan, EGL, GLX, OSMesa, OpenGL, GLESv1 +or GLESv2 library, you can override the default names by defining those you need +of @b _GLFW_VULKAN_LIBRARY, @b _GLFW_EGL_LIBRARY, @b _GLFW_GLX_LIBRARY, @b +_GLFW_OSMESA_LIBRARY, @b _GLFW_OPENGL_LIBRARY, @b _GLFW_GLESV1_LIBRARY and @b +_GLFW_GLESV2_LIBRARY. Otherwise, GLFW will use the built-in default names. + +@note None of the @ref build_macros may be defined during the compilation of +GLFW. If you define any of these in your build files, make sure they are not +applied to the GLFW sources. + +*/ diff --git a/deps/glfw-3.3.8/docs/context.dox b/deps/glfw-3.3.8/docs/context.dox new file mode 100644 index 0000000..25de69f --- /dev/null +++ b/deps/glfw-3.3.8/docs/context.dox @@ -0,0 +1,346 @@ +/*! + +@page context_guide Context guide + +@tableofcontents + +This guide introduces the OpenGL and OpenGL ES context related functions of +GLFW. For details on a specific function in this category, see the @ref +context. There are also guides for the other areas of the GLFW API. + + - @ref intro_guide + - @ref window_guide + - @ref vulkan_guide + - @ref monitor_guide + - @ref input_guide + + +@section context_object Context objects + +A window object encapsulates both a top-level window and an OpenGL or OpenGL ES +context. It is created with @ref glfwCreateWindow and destroyed with @ref +glfwDestroyWindow or @ref glfwTerminate. See @ref window_creation for more +information. + +As the window and context are inseparably linked, the window object also serves +as the context handle. + +To test the creation of various kinds of contexts and see their properties, run +the `glfwinfo` test program. + +@note Vulkan does not have a context and the Vulkan instance is created via the +Vulkan API itself. If you will be using Vulkan to render to a window, disable +context creation by setting the [GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) +hint to `GLFW_NO_API`. For more information, see the @ref vulkan_guide. + + +@subsection context_hints Context creation hints + +There are a number of hints, specified using @ref glfwWindowHint, related to +what kind of context is created. See +[context related hints](@ref window_hints_ctx) in the window guide. + + +@subsection context_sharing Context object sharing + +When creating a window and its OpenGL or OpenGL ES context with @ref +glfwCreateWindow, you can specify another window whose context the new one +should share its objects (textures, vertex and element buffers, etc.) with. + +@code +GLFWwindow* second_window = glfwCreateWindow(640, 480, "Second Window", NULL, first_window); +@endcode + +Object sharing is implemented by the operating system and graphics driver. On +platforms where it is possible to choose which types of objects are shared, GLFW +requests that all types are shared. + +See the relevant chapter of the [OpenGL](https://www.opengl.org/registry/) or +[OpenGL ES](https://www.khronos.org/opengles/) reference documents for more +information. The name and number of this chapter unfortunately varies between +versions and APIs, but has at times been named _Shared Objects and Multiple +Contexts_. + +GLFW comes with a barebones object sharing example program called `sharing`. + + +@subsection context_offscreen Offscreen contexts + +GLFW doesn't support creating contexts without an associated window. However, +contexts with hidden windows can be created with the +[GLFW_VISIBLE](@ref GLFW_VISIBLE_hint) window hint. + +@code +glfwWindowHint(GLFW_VISIBLE, GLFW_FALSE); + +GLFWwindow* offscreen_context = glfwCreateWindow(640, 480, "", NULL, NULL); +@endcode + +The window never needs to be shown and its context can be used as a plain +offscreen context. Depending on the window manager, the size of a hidden +window's framebuffer may not be usable or modifiable, so framebuffer +objects are recommended for rendering with such contexts. + +You should still [process events](@ref events) as long as you have at least one +window, even if none of them are visible. + +@macos The first time a window is created the menu bar is created. This is not +desirable for example when writing a command-line only application. Menu bar +creation can be disabled with the @ref GLFW_COCOA_MENUBAR init hint. + + +@subsection context_less Windows without contexts + +You can disable context creation by setting the +[GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) hint to `GLFW_NO_API`. Windows +without contexts must not be passed to @ref glfwMakeContextCurrent or @ref +glfwSwapBuffers. + + +@section context_current Current context + +Before you can make OpenGL or OpenGL ES calls, you need to have a current +context of the correct type. A context can only be current for a single thread +at a time, and a thread can only have a single context current at a time. + +When moving a context between threads, you must make it non-current on the old +thread before making it current on the new one. + +The context of a window is made current with @ref glfwMakeContextCurrent. + +@code +glfwMakeContextCurrent(window); +@endcode + +The window of the current context is returned by @ref glfwGetCurrentContext. + +@code +GLFWwindow* window = glfwGetCurrentContext(); +@endcode + +The following GLFW functions require a context to be current. Calling any these +functions without a current context will generate a @ref GLFW_NO_CURRENT_CONTEXT +error. + + - @ref glfwSwapInterval + - @ref glfwExtensionSupported + - @ref glfwGetProcAddress + + +@section context_swap Buffer swapping + +See @ref buffer_swap in the window guide. + + +@section context_glext OpenGL and OpenGL ES extensions + +One of the benefits of OpenGL and OpenGL ES is their extensibility. +Hardware vendors may include extensions in their implementations that extend the +API before that functionality is included in a new version of the OpenGL or +OpenGL ES specification, and some extensions are never included and remain +as extensions until they become obsolete. + +An extension is defined by: + +- An extension name (e.g. `GL_ARB_gl_spirv`) +- New OpenGL tokens (e.g. `GL_SPIR_V_BINARY_ARB`) +- New OpenGL functions (e.g. `glSpecializeShaderARB`) + +Note the `ARB` affix, which stands for Architecture Review Board and is used +for official extensions. The extension above was created by the ARB, but there +are many different affixes, like `NV` for Nvidia and `AMD` for, well, AMD. Any +group may also use the generic `EXT` affix. Lists of extensions, together with +their specifications, can be found at the +[OpenGL Registry](https://www.opengl.org/registry/) and +[OpenGL ES Registry](https://www.khronos.org/registry/gles/). + + +@subsection context_glext_auto Loading extension with a loader library + +An extension loader library is the easiest and best way to access both OpenGL and +OpenGL ES extensions and modern versions of the core OpenGL or OpenGL ES APIs. +They will take care of all the details of declaring and loading everything you +need. One such library is [glad](https://github.com/Dav1dde/glad) and there are +several others. + +The following example will use glad but all extension loader libraries work +similarly. + +First you need to generate the source files using the glad Python script. This +example generates a loader for any version of OpenGL, which is the default for +both GLFW and glad, but loaders for OpenGL ES, as well as loaders for specific +API versions and extension sets can be generated. The generated files are +written to the `output` directory. + +@code{.sh} +python main.py --generator c --no-loader --out-path output +@endcode + +The `--no-loader` option is added because GLFW already provides a function for +loading OpenGL and OpenGL ES function pointers, one that automatically uses the +selected context creation API, and glad can call this instead of having to +implement its own. There are several other command-line options as well. See +the glad documentation for details. + +Add the generated `output/src/glad.c`, `output/include/glad/glad.h` and +`output/include/KHR/khrplatform.h` files to your build. Then you need to +include the glad header file, which will replace the OpenGL header of your +development environment. By including the glad header before the GLFW header, +it suppresses the development environment's OpenGL or OpenGL ES header. + +@code +#include +#include +@endcode + +Finally you need to initialize glad once you have a suitable current context. + +@code +window = glfwCreateWindow(640, 480, "My Window", NULL, NULL); +if (!window) +{ + ... +} + +glfwMakeContextCurrent(window); + +gladLoadGLLoader((GLADloadproc) glfwGetProcAddress); +@endcode + +Once glad has been loaded, you have access to all OpenGL core and extension +functions supported by both the context you created and the glad loader you +generated and you are ready to start rendering. + +You can specify a minimum required OpenGL or OpenGL ES version with +[context hints](@ref window_hints_ctx). If your needs are more complex, you can +check the actual OpenGL or OpenGL ES version with +[context attributes](@ref window_attribs_ctx), or you can check whether +a specific version is supported by the current context with the +`GLAD_GL_VERSION_x_x` booleans. + +@code +if (GLAD_GL_VERSION_3_2) +{ + // Call OpenGL 3.2+ specific code +} +@endcode + +To check whether a specific extension is supported, use the `GLAD_GL_xxx` +booleans. + +@code +if (GLAD_GL_ARB_gl_spirv) +{ + // Use GL_ARB_gl_spirv +} +@endcode + + +@subsection context_glext_manual Loading extensions manually + +__Do not use this technique__ unless it is absolutely necessary. An +[extension loader library](@ref context_glext_auto) will save you a ton of +tedious, repetitive, error prone work. + +To use a certain extension, you must first check whether the context supports +that extension and then, if it introduces new functions, retrieve the pointers +to those functions. GLFW provides @ref glfwExtensionSupported and @ref +glfwGetProcAddress for manual loading of extensions and new API functions. + +This section will demonstrate manual loading of OpenGL extensions. The loading +of OpenGL ES extensions is identical except for the name of the extension header. + + +@subsubsection context_glext_header The glext.h header + +The `glext.h` extension header is a continually updated file that defines the +interfaces for all OpenGL extensions. The latest version of this can always be +found at the [OpenGL Registry](https://www.opengl.org/registry/). There are also +extension headers for the various versions of OpenGL ES at the +[OpenGL ES Registry](https://www.khronos.org/registry/gles/). It it strongly +recommended that you use your own copy of the extension header, as the one +included in your development environment may be several years out of date and +may not include the extensions you wish to use. + +The header defines function pointer types for all functions of all extensions it +supports. These have names like `PFNGLSPECIALIZESHADERARBPROC` (for +`glSpecializeShaderARB`), i.e. the name is made uppercase and `PFN` (pointer +to function) and `PROC` (procedure) are added to the ends. + +To include the extension header, define @ref GLFW_INCLUDE_GLEXT before including +the GLFW header. + +@code +#define GLFW_INCLUDE_GLEXT +#include +@endcode + + +@subsubsection context_glext_string Checking for extensions + +A given machine may not actually support the extension (it may have older +drivers or a graphics card that lacks the necessary hardware features), so it +is necessary to check at run-time whether the context supports the extension. +This is done with @ref glfwExtensionSupported. + +@code +if (glfwExtensionSupported("GL_ARB_gl_spirv")) +{ + // The extension is supported by the current context +} +@endcode + +The argument is a null terminated ASCII string with the extension name. If the +extension is supported, @ref glfwExtensionSupported returns `GLFW_TRUE`, +otherwise it returns `GLFW_FALSE`. + + +@subsubsection context_glext_proc Fetching function pointers + +Many extensions, though not all, require the use of new OpenGL functions. +These functions often do not have entry points in the client API libraries of +your operating system, making it necessary to fetch them at run time. You can +retrieve pointers to these functions with @ref glfwGetProcAddress. + +@code +PFNGLSPECIALIZESHADERARBPROC pfnSpecializeShaderARB = glfwGetProcAddress("glSpecializeShaderARB"); +@endcode + +In general, you should avoid giving the function pointer variables the (exact) +same name as the function, as this may confuse your linker. Instead, you can +use a different prefix, like above, or some other naming scheme. + +Now that all the pieces have been introduced, here is what they might look like +when used together. + +@code +#define GLFW_INCLUDE_GLEXT +#include + +#define glSpecializeShaderARB pfnSpecializeShaderARB +PFNGLSPECIALIZESHADERARBPROC pfnSpecializeShaderARB; + +// Flag indicating whether the extension is supported +int has_ARB_gl_spirv = 0; + +void load_extensions(void) +{ + if (glfwExtensionSupported("GL_ARB_gl_spirv")) + { + pfnSpecializeShaderARB = (PFNGLSPECIALIZESHADERARBPROC) + glfwGetProcAddress("glSpecializeShaderARB"); + has_ARB_gl_spirv = 1; + } +} + +void some_function(void) +{ + if (has_ARB_gl_spirv) + { + // Now the extension function can be called as usual + glSpecializeShaderARB(...); + } +} +@endcode + +*/ diff --git a/deps/glfw-3.3.8/docs/extra.css b/deps/glfw-3.3.8/docs/extra.css new file mode 100644 index 0000000..05c1938 --- /dev/null +++ b/deps/glfw-3.3.8/docs/extra.css @@ -0,0 +1 @@ +.sm-dox,.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted,.sm-dox ul a:hover{background:none;text-shadow:none}.sm-dox a span.sub-arrow{border-color:#f2f2f2 transparent transparent transparent}.sm-dox a span.sub-arrow:active,.sm-dox a span.sub-arrow:focus,.sm-dox a span.sub-arrow:hover,.sm-dox a:hover span.sub-arrow{border-color:#f60 transparent transparent transparent}.sm-dox ul a span.sub-arrow:active,.sm-dox ul a span.sub-arrow:focus,.sm-dox ul a span.sub-arrow:hover,.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent #f60}.sm-dox ul a:hover{background:#666;text-shadow:none}.sm-dox ul.sm-nowrap a{color:#4d4d4d;text-shadow:none}#main-nav,#main-menu,#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li,.memdoc,dl.reflist dd,div.toc li,.ah,span.lineno,span.lineno a,span.lineno a:hover,.note code,.pre code,.post code,.invariant code,.warning code,.attention code,.deprecated code,.bug code,.todo code,.test code,.doxtable code,.markdownTable code{background:none}#titlearea,.footer,.contents,div.header,.memdoc,table.doxtable td,table.doxtable th,table.markdownTable td,table.markdownTable th,hr,.memSeparator{border:none}#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li,.reflist dt a.el,.levels span,.directory .levels span{text-shadow:none}.memdoc,dl.reflist dd{box-shadow:none}div.headertitle,.note code,.pre code,.post code,.invariant code,.warning code,.attention code,.deprecated code,.bug code,.todo code,.test code,table.doxtable code,table.markdownTable code{padding:0}#nav-path,.directory .levels,span.lineno{display:none}html,#titlearea,.footer,tr.even,.directory tr.even,.doxtable tr:nth-child(even),tr.markdownTableBody:nth-child(even),.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,code,.markdownTableRowEven{background:#f2f2f2}body{color:#4d4d4d}h1,h2,h2.groupheader,h3,div.toc h3,h4,h5,h6,strong,em{color:#1a1a1a;border-bottom:none}h1{padding-top:.5em;font-size:180%}h2{padding-top:.5em;margin-bottom:0;font-size:140%}h3{padding-top:.5em;margin-bottom:0;font-size:110%}.glfwheader{font-size:16px;min-height:64px;max-width:920px;padding:0 32px;margin:0 auto;display:flex;flex-direction:row;flex-wrap:wrap;justify-content:flex-start;align-items:center;align-content:stretch}#glfwhome{line-height:64px;padding-right:48px;color:#666;font-size:2.5em;background:url("https://www.glfw.org/css/arrow.png") no-repeat right}.glfwnavbar{list-style-type:none;margin:0 0 0 auto;float:right}#glfwhome,.glfwnavbar li{float:left}.glfwnavbar a,.glfwnavbar a:visited{line-height:64px;margin-left:2em;display:block;color:#666}.glfwnavbar{padding-left:0}#glfwhome,.glfwnavbar a,.glfwnavbar a:visited{transition:.35s ease}#titlearea,.footer{color:#666}address.footer{text-align:center;padding:2em;margin-top:3em}#top{background:#666}#main-nav{max-width:960px;margin:0 auto;font-size:13px}#main-menu{max-width:920px;margin:0 auto;font-size:13px}.memtitle{display:none}.memproto,.memname{font-weight:bold;text-shadow:none}#main-menu{min-height:36px;display:flex;flex-direction:row;flex-wrap:wrap;justify-content:flex-start;align-items:center;align-content:stretch}#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li{color:#f2f2f2}#main-menu li ul.sm-nowrap li a{color:#4d4d4d}#main-menu li ul.sm-nowrap li a:hover{color:#f60}#main-menu>li:last-child{margin:0 0 0 auto}.contents{min-height:590px}div.contents,div.header{max-width:920px;margin:0 auto;padding:0 32px;background:#fff none}table.doxtable th,table.markdownTable th,dl.reflist dt{background:linear-gradient(to bottom, #ffa733 0%, #ff6600 100%);box-shadow:inset 0 0 32px #f60;text-shadow:0 -1px 1px #b34700;text-align:left;color:#fff}dl.reflist dt a.el{color:#f60;padding:.2em;border-radius:4px;background-color:#ffe0cc}div.toc{float:none;width:auto}div.toc h3{font-size:1.17em}div.toc ul{padding-left:1.5em}div.toc li{font-size:1em;padding-left:0;list-style-type:disc}div.toc,.memproto,div.qindex,div.ah{background:linear-gradient(to bottom, #f2f2f2 0%, #e6e6e6 100%);box-shadow:inset 0 0 32px #e6e6e6;text-shadow:0 1px 1px #fff;color:#1a1a1a;border:2px solid #e6e6e6;border-radius:4px}.paramname{color:#803300}dl.reflist dt{border:2px solid #f60;border-top-left-radius:4px;border-top-right-radius:4px;border-bottom:none}dl.reflist dd{border:2px solid #f60;border-bottom-right-radius:4px;border-bottom-left-radius:4px;border-top:none}table.doxtable,table.markdownTable{border-collapse:inherit;border-spacing:0;border:2px solid #f60;border-radius:4px}a,a:hover,a:visited,a:visited:hover,.contents a:visited,.el,a.el:visited,#glfwhome:hover,#main-menu a:hover,span.lineno a:hover{color:#f60;text-decoration:none}div.directory{border-collapse:inherit;border-spacing:0;border:2px solid #f60;border-radius:4px}hr,.memSeparator{height:2px;background:linear-gradient(to right, #f2f2f2 0%, #d9d9d9 50%, #f2f2f2 100%)}dl.note,dl.pre,dl.post,dl.invariant{background:linear-gradient(to bottom, #ddfad1 0%, #cbf7ba 100%);box-shadow:inset 0 0 32px #baf5a3;color:#1e5309;border:2px solid #afe699}dl.warning,dl.attention{background:linear-gradient(to bottom, #fae8d1 0%, #f7ddba 100%);box-shadow:inset 0 0 32px #f5d1a3;color:#533309;border:2px solid #e6c499}dl.deprecated,dl.bug{background:linear-gradient(to bottom, #fad1e3 0%, #f7bad6 100%);box-shadow:inset 0 0 32px #f5a3c8;color:#53092a;border:2px solid #e699bb}dl.todo,dl.test{background:linear-gradient(to bottom, #d1ecfa 0%, #bae3f7 100%);box-shadow:inset 0 0 32px #a3daf5;color:#093a53;border:2px solid #99cce6}dl.note,dl.pre,dl.post,dl.invariant,dl.warning,dl.attention,dl.deprecated,dl.bug,dl.todo,dl.test{border-radius:4px;padding:1em;text-shadow:0 1px 1px #fff;margin:1em 0}.note a,.pre a,.post a,.invariant a,.warning a,.attention a,.deprecated a,.bug a,.todo a,.test a,.note a:visited,.pre a:visited,.post a:visited,.invariant a:visited,.warning a:visited,.attention a:visited,.deprecated a:visited,.bug a:visited,.todo a:visited,.test a:visited{color:inherit}div.line{line-height:inherit}div.fragment,pre.fragment{background:#f2f2f2;border-radius:4px;border:none;padding:1em;overflow:auto;border-left:4px solid #ccc;margin:1em 0}.lineno a,.lineno a:visited,.line,pre.fragment{color:#4d4d4d}span.preprocessor,span.comment{color:#007899}a.code,a.code:visited{color:#e64500}span.keyword,span.keywordtype,span.keywordflow{color:#404040;font-weight:bold}span.stringliteral{color:#360099}code{padding:.1em;border-radius:4px}/*# sourceMappingURL=extra.css.map */ diff --git a/deps/glfw-3.3.8/docs/extra.css.map b/deps/glfw-3.3.8/docs/extra.css.map new file mode 100644 index 0000000..7d10c5e --- /dev/null +++ b/deps/glfw-3.3.8/docs/extra.css.map @@ -0,0 +1 @@ +{"version":3,"sourceRoot":"","sources":["extra.scss"],"names":[],"mappings":"AA8EA,4GACI,gBACA,iBAGJ,yBACC,yDAGD,6HACC,sDAGD,yIACC,sDAGD,mBACI,WA9EuB,KA+EvB,iBAGJ,uBACC,MAzFoB,QA0FjB,iBAGJ,6UACC,gBAGD,mJACC,YAGD,yHACC,iBAGD,sBACC,gBAGD,4LACC,UAGD,yCACC,aAGD,kMACC,WAnHgC,QAsHjC,KACC,MA1HoB,QA6HrB,sDACC,MA/Ge,QAgHf,mBAGD,GACE,iBACA,eAGF,GACE,iBACA,gBACA,eAGF,GACE,iBACA,gBACA,eAGF,YACC,eACA,gBACA,gBACA,eACA,cAEA,aACA,mBACA,eACA,2BACA,mBACA,sBAGD,UACC,iBACA,mBACA,MA/J0B,KAgK1B,gBACA,qEAGD,YACC,qBACA,kBACA,YAGD,yBACC,WAGD,oCACC,iBACA,gBACA,cACA,MAlL0B,KAqL3B,YACC,eAGD,8CACC,qBAGD,mBACC,MA9L0B,KAiM3B,eACC,kBACA,YACA,eAGD,KACC,WAxM0B,KA2M3B,UACC,gBACA,cACA,eAGD,WACC,gBACA,cACA,eAGD,UACI,aAGJ,mBACI,iBACA,iBAGJ,WACC,gBACA,aACA,mBACA,eACA,2BACA,mBACA,sBAGD,mEACC,MA9OgC,QAiPjC,gCACC,MArPoB,QAwPrB,sCACC,MAjOoB,KAoOrB,yBACC,kBAGD,UACC,iBAGD,wBACC,gBACA,cACA,eACA,qBAGD,uDACC,gEACA,+BACA,+BACA,gBACA,MArPgB,KAwPjB,mBACC,MA5PoB,KA6PpB,aACA,kBACA,yBAGD,QACC,WACA,WAGD,WACC,iBAGD,WACC,mBAGD,WACC,cACA,eACA,qBAGD,oCACC,gEACA,kCACA,2BACA,MAlSe,QAmSf,yBACA,kBAGD,WACC,MA3QuB,QA8QxB,cACC,sBACA,2BACA,4BACA,mBAGD,cACC,sBACA,+BACA,8BACA,gBAGD,mCACC,wBACA,iBACA,sBACA,kBAGD,gIACC,MAxToB,KAyTpB,qBAGD,cACC,wBACA,iBACA,sBACA,kBAGD,iBACC,WACA,4EAGD,oCApSC,gEACA,kCACA,cACA,yBAqSD,wBAxSC,gEACA,kCACA,cACA,yBAySD,qBA5SC,gEACA,kCACA,cACA,yBA6SD,gBAhTC,gEACA,kCACA,cACA,yBAiTD,iGACC,kBACA,YACA,2BACA,aAGD,kRACC,cAGD,SACC,oBAGD,0BACC,mBACA,kBACA,YACA,YACA,cACA,2BACA,aAGD,+CACC,MA1YoB,QA6YrB,+BACC,cAGD,sBACC,cAGD,+CACC,cACA,iBAGD,mBACC,cAGD,KACC,aACA","file":"extra.css"} \ No newline at end of file diff --git a/deps/glfw-3.3.8/docs/extra.scss b/deps/glfw-3.3.8/docs/extra.scss new file mode 100644 index 0000000..6c5f3c2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/extra.scss @@ -0,0 +1,430 @@ +// NOTE: Please use this file to perform modifications on default style sheets. +// +// You need to install the official Sass CLI tool: +// npm install -g sass +// +// Run this command to regenerate extra.css after you're finished with changes: +// sass --style=compressed extra.scss extra.css +// +// Alternatively you can use online services to regenerate extra.css. + + +// Default text color for page contents +$default-text-color: hsl(0,0%,30%); + +// Page header, footer, table rows, inline codes and definition lists +$header-footer-background-color: hsl(0,0%,95%); + +// Page header, footer links and navigation bar background +$header-footer-link-color: hsl(0,0%,40%); + +// Doxygen navigation bar links +$navbar-link-color: $header-footer-background-color; + +// Page content background color +$content-background-color: hsl(0,0%,100%); + +// Bold, italic, h1, h2, ... and table of contents +$heading-color: hsl(0,0%,10%); + +// Function, enum and macro definition separator +$def-separator-color: $header-footer-background-color; + +// Base color hue +$base-hue: 24; + +// Default color used for links +$default-link-color: hsl($base-hue,100%,50%); + +// Doxygen navigation bar active tab +$tab-text-color: hsl(0,0%,100%); +$tab-background-color1: $default-link-color; +$tab-background-color2: lighten(adjust-hue($tab-background-color1, 10), 10%); + +// Table borders +$default-border-color: $default-link-color; + +// Table header +$table-text-color: $tab-text-color; +$table-background-color1: $tab-background-color1; +$table-background-color2: $tab-background-color2; + +// Table of contents, data structure index and prototypes +$toc-background-color1: hsl(0,0%,90%); +$toc-background-color2: lighten($toc-background-color1, 5%); + +// Function prototype parameters color +$prototype-param-color: darken($default-link-color, 25%); + +// Message box color: note, pre, post and invariant +$box-note-color: hsl(103,80%,85%); + +// Message box color: warning and attention +$box-warning-color: hsl(34,80%,85%); + +// Message box color: deprecated and bug +$box-bug-color: hsl(333,80%,85%); + +// Message box color: todo and test +$box-todo-color: hsl(200,80%,85%); + +// Message box helper function +@mixin message-box($base-color){ + background:linear-gradient(to bottom,lighten($base-color, 5%) 0%,$base-color 100%); + box-shadow:inset 0 0 32px darken($base-color, 5%); + color:darken($base-color, 67%); + border:2px solid desaturate(darken($base-color, 10%), 20%); +} + +.sm-dox,.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted,.sm-dox ul a:hover { + background:none; + text-shadow:none; +} + +.sm-dox a span.sub-arrow { + border-color:$navbar-link-color transparent transparent transparent; +} + +.sm-dox a span.sub-arrow:active,.sm-dox a span.sub-arrow:focus,.sm-dox a span.sub-arrow:hover,.sm-dox a:hover span.sub-arrow { + border-color:$default-link-color transparent transparent transparent; +} + +.sm-dox ul a span.sub-arrow:active,.sm-dox ul a span.sub-arrow:focus,.sm-dox ul a span.sub-arrow:hover,.sm-dox ul a:hover span.sub-arrow { + border-color:transparent transparent transparent $default-link-color; +} + +.sm-dox ul a:hover { + background:$header-footer-link-color; + text-shadow:none; +} + +.sm-dox ul.sm-nowrap a { + color:$default-text-color; + text-shadow:none; +} + +#main-nav,#main-menu,#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li,.memdoc,dl.reflist dd,div.toc li,.ah,span.lineno,span.lineno a,span.lineno a:hover,.note code,.pre code,.post code,.invariant code,.warning code,.attention code,.deprecated code,.bug code,.todo code,.test code,.doxtable code,.markdownTable code { + background:none; +} + +#titlearea,.footer,.contents,div.header,.memdoc,table.doxtable td,table.doxtable th,table.markdownTable td,table.markdownTable th,hr,.memSeparator { + border:none; +} + +#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li,.reflist dt a.el,.levels span,.directory .levels span { + text-shadow:none; +} + +.memdoc,dl.reflist dd { + box-shadow:none; +} + +div.headertitle,.note code,.pre code,.post code,.invariant code,.warning code,.attention code,.deprecated code,.bug code,.todo code,.test code,table.doxtable code,table.markdownTable code { + padding:0; +} + +#nav-path,.directory .levels,span.lineno { + display:none; +} + +html,#titlearea,.footer,tr.even,.directory tr.even,.doxtable tr:nth-child(even),tr.markdownTableBody:nth-child(even),.mdescLeft,.mdescRight,.memItemLeft,.memItemRight,code,.markdownTableRowEven { + background:$header-footer-background-color; +} + +body { + color:$default-text-color; +} + +h1,h2,h2.groupheader,h3,div.toc h3,h4,h5,h6,strong,em { + color:$heading-color; + border-bottom:none; +} + +h1 { + padding-top:0.5em; + font-size:180%; +} + +h2 { + padding-top:0.5em; + margin-bottom:0; + font-size:140%; +} + +h3 { + padding-top:0.5em; + margin-bottom:0; + font-size:110%; +} + +.glfwheader { + font-size:16px; + min-height:64px; + max-width:920px; + padding:0 32px; + margin:0 auto; + + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: flex-start; + align-items: center; + align-content: stretch; +} + +#glfwhome { + line-height:64px; + padding-right:48px; + color:$header-footer-link-color; + font-size:2.5em; + background:url("https://www.glfw.org/css/arrow.png") no-repeat right; +} + +.glfwnavbar { + list-style-type:none; + margin:0 0 0 auto; + float:right; +} + +#glfwhome,.glfwnavbar li { + float:left; +} + +.glfwnavbar a,.glfwnavbar a:visited { + line-height:64px; + margin-left:2em; + display:block; + color:$header-footer-link-color; +} + +.glfwnavbar { + padding-left: 0; +} + +#glfwhome,.glfwnavbar a,.glfwnavbar a:visited { + transition:.35s ease; +} + +#titlearea,.footer { + color:$header-footer-link-color; +} + +address.footer { + text-align:center; + padding:2em; + margin-top:3em; +} + +#top { + background:$header-footer-link-color; +} + +#main-nav { + max-width:960px; + margin:0 auto; + font-size:13px; +} + +#main-menu { + max-width:920px; + margin:0 auto; + font-size:13px; +} + +.memtitle { + display:none; +} + +.memproto,.memname { + font-weight:bold; + text-shadow:none; +} + +#main-menu { + min-height:36px; + display: flex; + flex-direction: row; + flex-wrap: wrap; + justify-content: flex-start; + align-items: center; + align-content: stretch; +} + +#main-menu a,#main-menu a:visited,#main-menu a:hover,#main-menu li { + color:$navbar-link-color; +} + +#main-menu li ul.sm-nowrap li a { + color:$default-text-color; +} + +#main-menu li ul.sm-nowrap li a:hover { + color:$default-link-color; +} + +#main-menu > li:last-child { + margin: 0 0 0 auto; +} + +.contents { + min-height:590px; +} + +div.contents,div.header { + max-width:920px; + margin:0 auto; + padding:0 32px; + background:$content-background-color none; +} + +table.doxtable th,table.markdownTable th,dl.reflist dt { + background:linear-gradient(to bottom,$table-background-color2 0%,$table-background-color1 100%); + box-shadow:inset 0 0 32px $table-background-color1; + text-shadow:0 -1px 1px darken($table-background-color1, 15%); + text-align:left; + color:$table-text-color; +} + +dl.reflist dt a.el { + color:$default-link-color; + padding:.2em; + border-radius:4px; + background-color:lighten($default-link-color, 40%); +} + +div.toc { + float:none; + width:auto; +} + +div.toc h3 { + font-size:1.17em; +} + +div.toc ul { + padding-left:1.5em; +} + +div.toc li { + font-size:1em; + padding-left:0; + list-style-type:disc; +} + +div.toc,.memproto,div.qindex,div.ah { + background:linear-gradient(to bottom,$toc-background-color2 0%,$toc-background-color1 100%); + box-shadow:inset 0 0 32px $toc-background-color1; + text-shadow:0 1px 1px lighten($toc-background-color2, 10%); + color:$heading-color; + border:2px solid $toc-background-color1; + border-radius:4px; +} + +.paramname { + color:$prototype-param-color; +} + +dl.reflist dt { + border:2px solid $default-border-color; + border-top-left-radius:4px; + border-top-right-radius:4px; + border-bottom:none; +} + +dl.reflist dd { + border:2px solid $default-border-color; + border-bottom-right-radius:4px; + border-bottom-left-radius:4px; + border-top:none; +} + +table.doxtable,table.markdownTable { + border-collapse:inherit; + border-spacing:0; + border:2px solid $default-border-color; + border-radius:4px; +} + +a,a:hover,a:visited,a:visited:hover,.contents a:visited,.el,a.el:visited,#glfwhome:hover,#main-menu a:hover,span.lineno a:hover { + color:$default-link-color; + text-decoration:none; +} + +div.directory { + border-collapse:inherit; + border-spacing:0; + border:2px solid $default-border-color; + border-radius:4px; +} + +hr,.memSeparator { + height:2px; + background:linear-gradient(to right,$def-separator-color 0%,darken($def-separator-color, 10%) 50%,$def-separator-color 100%); +} + +dl.note,dl.pre,dl.post,dl.invariant { + @include message-box($box-note-color); +} + +dl.warning,dl.attention { + @include message-box($box-warning-color); +} + +dl.deprecated,dl.bug { + @include message-box($box-bug-color); +} + +dl.todo,dl.test { + @include message-box($box-todo-color); +} + +dl.note,dl.pre,dl.post,dl.invariant,dl.warning,dl.attention,dl.deprecated,dl.bug,dl.todo,dl.test { + border-radius:4px; + padding:1em; + text-shadow:0 1px 1px hsl(0,0%,100%); + margin:1em 0; +} + +.note a,.pre a,.post a,.invariant a,.warning a,.attention a,.deprecated a,.bug a,.todo a,.test a,.note a:visited,.pre a:visited,.post a:visited,.invariant a:visited,.warning a:visited,.attention a:visited,.deprecated a:visited,.bug a:visited,.todo a:visited,.test a:visited { + color:inherit; +} + +div.line { + line-height:inherit; +} + +div.fragment,pre.fragment { + background:hsl(0,0%,95%); + border-radius:4px; + border:none; + padding:1em; + overflow:auto; + border-left:4px solid hsl(0,0%,80%); + margin:1em 0; +} + +.lineno a,.lineno a:visited,.line,pre.fragment { + color:$default-text-color; +} + +span.preprocessor,span.comment { + color:hsl(193,100%,30%); +} + +a.code,a.code:visited { + color:hsl(18,100%,45%); +} + +span.keyword,span.keywordtype,span.keywordflow { + color:darken($default-text-color, 5%); + font-weight:bold; +} + +span.stringliteral { + color:hsl(261,100%,30%); +} + +code { + padding:.1em; + border-radius:4px; +} diff --git a/deps/glfw-3.3.8/docs/footer.html b/deps/glfw-3.3.8/docs/footer.html new file mode 100644 index 0000000..b0434ca --- /dev/null +++ b/deps/glfw-3.3.8/docs/footer.html @@ -0,0 +1,7 @@ +
+

+Last update on $date for $projectname $projectnumber +

+
+ + diff --git a/deps/glfw-3.3.8/docs/header.html b/deps/glfw-3.3.8/docs/header.html new file mode 100644 index 0000000..4cefa3d --- /dev/null +++ b/deps/glfw-3.3.8/docs/header.html @@ -0,0 +1,34 @@ + + + + + + + +$projectname: $title +$title + + + +$treeview +$search +$mathjax + +$extrastylesheet + + +
+ + + + + diff --git a/deps/glfw-3.3.8/docs/html/bc_s.png b/deps/glfw-3.3.8/docs/html/bc_s.png new file mode 100644 index 0000000..224b29a Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/bc_s.png differ diff --git a/deps/glfw-3.3.8/docs/html/bdwn.png b/deps/glfw-3.3.8/docs/html/bdwn.png new file mode 100644 index 0000000..940a0b9 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/bdwn.png differ diff --git a/deps/glfw-3.3.8/docs/html/build_8dox.html b/deps/glfw-3.3.8/docs/html/build_8dox.html new file mode 100644 index 0000000..1f81575 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/build_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: build.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
build.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/build_guide.html b/deps/glfw-3.3.8/docs/html/build_guide.html new file mode 100644 index 0000000..3b09bff --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/build_guide.html @@ -0,0 +1,192 @@ + + + + + + + +GLFW: Building applications + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Building applications
+
+
+

Table of Contents

+ +
+

This is about compiling and linking applications that use GLFW. For information on how to write such applications, start with the introductory tutorial. For information on how to compile the GLFW library itself, see Compiling GLFW.

+

This is not a tutorial on compilation or linking. It assumes basic understanding of how to compile and link a C program as well as how to use the specific compiler of your chosen development environment. The compilation and linking process should be explained in your C programming material and in the documentation for your development environment.

+

+Including the GLFW header file

+

You should include the GLFW header in the source files where you use OpenGL or GLFW.

+
#include <GLFW/glfw3.h>
+
glfw3.h
The header of the GLFW 3 API.
+

This header defines all the constants and declares all the types and function prototypes of the GLFW API. By default it also includes the OpenGL header from your development environment. See option macros below for how to select OpenGL ES headers and more.

+

The GLFW header also defines any platform-specific macros needed by your OpenGL header, so that it can be included without needing any window system headers.

+

It does this only when needed, so if window system headers are included, the GLFW header does not try to redefine those symbols. The reverse is not true, i.e. windows.h cannot cope if any Win32 symbols have already been defined.

+

In other words:

+
    +
  • Use the GLFW header to include OpenGL or OpenGL ES headers portably
    • +
  • Do not include window system headers unless you will use those APIs directly
    • +
  • If you do need such headers, include them before the GLFW header
    • +
+

If you are using an OpenGL extension loading library such as glad, the extension loader header should be included before the GLFW one. GLFW attempts to detect any OpenGL or OpenGL ES header or extension loader header included before it and will then disable the inclusion of the default OpenGL header. Most extension loaders also define macros that disable similar headers below it.

+
#include <glad/gl.h>
+
#include <GLFW/glfw3.h>
+

Both of these mechanisms depend on the extension loader header defining a known macro. If yours doesn't or you don't know which one your users will pick, the GLFW_INCLUDE_NONE macro will explicitly prevent the GLFW header from including the OpenGL header. This will also allow you to include the two headers in any order.

+
#define GLFW_INCLUDE_NONE
+
#include <GLFW/glfw3.h>
+
#include <glad/gl.h>
+

+GLFW header option macros

+

These macros may be defined before the inclusion of the GLFW header and affect its behavior.

+

GLFW_DLL is required on Windows when using the GLFW DLL, to tell the compiler that the GLFW functions are defined in a DLL.

+

The following macros control which OpenGL or OpenGL ES API header is included. Only one of these may be defined at a time.

+
Note
GLFW does not provide any of the API headers mentioned below. They are provided by your development environment or your OpenGL, OpenGL ES or Vulkan SDK, and most of them can be downloaded from the Khronos Registry.
+

GLFW_INCLUDE_GLCOREARB makes the GLFW header include the modern GL/glcorearb.h header (OpenGL/gl3.h on macOS) instead of the regular OpenGL header.

+

GLFW_INCLUDE_ES1 makes the GLFW header include the OpenGL ES 1.x GLES/gl.h header instead of the regular OpenGL header.

+

GLFW_INCLUDE_ES2 makes the GLFW header include the OpenGL ES 2.0 GLES2/gl2.h header instead of the regular OpenGL header.

+

GLFW_INCLUDE_ES3 makes the GLFW header include the OpenGL ES 3.0 GLES3/gl3.h header instead of the regular OpenGL header.

+

GLFW_INCLUDE_ES31 makes the GLFW header include the OpenGL ES 3.1 GLES3/gl31.h header instead of the regular OpenGL header.

+

GLFW_INCLUDE_ES32 makes the GLFW header include the OpenGL ES 3.2 GLES3/gl32.h header instead of the regular OpenGL header.

+

GLFW_INCLUDE_NONE makes the GLFW header not include any OpenGL or OpenGL ES API header. This is useful in combination with an extension loading library.

+

If none of the above inclusion macros are defined, the standard OpenGL GL/gl.h header (OpenGL/gl.h on macOS) is included, unless GLFW detects the inclusion guards of any OpenGL, OpenGL ES or extension loader header it knows about.

+

The following macros control the inclusion of additional API headers. Any number of these may be defined simultaneously, and/or together with one of the above macros.

+

GLFW_INCLUDE_VULKAN makes the GLFW header include the Vulkan vulkan/vulkan.h header in addition to any selected OpenGL or OpenGL ES header.

+

GLFW_INCLUDE_GLEXT makes the GLFW header include the appropriate extension header for the OpenGL or OpenGL ES header selected above after and in addition to that header.

+

GLFW_INCLUDE_GLU makes the header include the GLU header in addition to the header selected above. This should only be used with the standard OpenGL header and only for compatibility with legacy code. GLU has been deprecated and should not be used in new code.

+
Note
None of these macros may be defined during the compilation of GLFW itself. If your build includes GLFW and you define any these in your build files, make sure they are not applied to the GLFW sources.
+

+Link with the right libraries

+

GLFW is essentially a wrapper of various platform-specific APIs and therefore needs to link against many different system libraries. If you are using GLFW as a shared library / dynamic library / DLL then it takes care of these links. However, if you are using GLFW as a static library then your executable will need to link against these libraries.

+

On Windows and macOS, the list of system libraries is static and can be hard-coded into your build environment. See the section for your development environment below. On Linux and other Unix-like operating systems, the list varies but can be retrieved in various ways as described below.

+

A good general introduction to linking is Beginner's Guide to Linkers by David Drysdale.

+

+With MinGW or Visual C++ on Windows

+

The static version of the GLFW library is named glfw3. When using this version, it is also necessary to link with some libraries that GLFW uses.

+

When using MinGW to link an application with the static version of GLFW, you must also explicitly link with gdi32. Other toolchains including MinGW-w64 include it in the set of default libraries along with other dependencies like user32 and kernel32.

+

The link library for the GLFW DLL is named glfw3dll. When compiling an application that uses the DLL version of GLFW, you need to define the GLFW_DLL macro before any inclusion of the GLFW header. This can be done either with a compiler switch or by defining it in your source code.

+

+With CMake and GLFW source

+

This section is about using CMake to compile and link GLFW along with your application. If you want to use an installed binary instead, see With CMake and installed GLFW binaries.

+

With a few changes to your CMakeLists.txt you can have the GLFW source tree built along with your application.

+

When including GLFW as part of your build, you probably don't want to build the GLFW tests, examples and documentation. To disable these, set the corresponding cache variables before adding the GLFW source tree.

+
set(GLFW_BUILD_DOCS OFF CACHE BOOL "" FORCE)
+
set(GLFW_BUILD_TESTS OFF CACHE BOOL "" FORCE)
+
set(GLFW_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE)
+

Add the root directory of the GLFW source tree to your project. This will add the glfw target to your project.

+
add_subdirectory(path/to/glfw)
+

Once GLFW has been added, link your application against the glfw target. This adds the GLFW library and its link-time dependencies as it is currently configured, the include directory for the GLFW header and, when applicable, the GLFW_DLL macro.

+
target_link_libraries(myapp glfw)
+

Note that the glfw target does not depend on OpenGL, as GLFW loads any OpenGL, OpenGL ES or Vulkan libraries it needs at runtime. If your application calls OpenGL directly, instead of using a modern extension loader library, use the OpenGL CMake package.

+
find_package(OpenGL REQUIRED)
+

If OpenGL is found, the OpenGL::GL target is added to your project, containing library and include directory paths. Link against this like any other library.

+
target_link_libraries(myapp OpenGL::GL)
+

For a minimal example of a program and GLFW sources built with CMake, see the GLFW CMake Starter on GitHub.

+

+With CMake and installed GLFW binaries

+

This section is about using CMake to link GLFW after it has been built and installed. If you want to build it along with your application instead, see With CMake and GLFW source.

+

With a few changes to your CMakeLists.txt you can locate the package and target files generated when GLFW is installed.

+
find_package(glfw3 3.3 REQUIRED)
+

Once GLFW has been added to the project, link against it with the glfw target. This adds the GLFW library and its link-time dependencies, the include directory for the GLFW header and, when applicable, the GLFW_DLL macro.

+
target_link_libraries(myapp glfw)
+

Note that the glfw target does not depend on OpenGL, as GLFW loads any OpenGL, OpenGL ES or Vulkan libraries it needs at runtime. If your application calls OpenGL directly, instead of using a modern extension loader library, use the OpenGL CMake package.

+
find_package(OpenGL REQUIRED)
+

If OpenGL is found, the OpenGL::GL target is added to your project, containing library and include directory paths. Link against this like any other library.

+
target_link_libraries(myapp OpenGL::GL)
+

+With makefiles and pkg-config on Unix

+

GLFW supports pkg-config, and the glfw3.pc pkg-config file is generated when the GLFW library is built and is installed along with it. A pkg-config file describes all necessary compile-time and link-time flags and dependencies needed to use a library. When they are updated or if they differ between systems, you will get the correct ones automatically.

+

A typical compile and link command-line when using the static version of the GLFW library may look like this:

+
cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --static --libs glfw3)
+

If you are using the shared version of the GLFW library, omit the --static flag.

+
cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --libs glfw3)
+

You can also use the glfw3.pc file without installing it first, by using the PKG_CONFIG_PATH environment variable.

+
env PKG_CONFIG_PATH=path/to/glfw/src cc $(pkg-config --cflags glfw3) -o myprog myprog.c $(pkg-config --libs glfw3)
+

The dependencies do not include OpenGL, as GLFW loads any OpenGL, OpenGL ES or Vulkan libraries it needs at runtime. If your application calls OpenGL directly, instead of using a modern extension loader library, you should add the gl pkg-config package.

+
cc $(pkg-config --cflags glfw3 gl) -o myprog myprog.c $(pkg-config --libs glfw3 gl)
+

+With Xcode on macOS

+

If you are using the dynamic library version of GLFW, add it to the project dependencies.

+

If you are using the static library version of GLFW, add it and the Cocoa, OpenGL and IOKit frameworks to the project as dependencies. They can all be found in /System/Library/Frameworks.

+

+With command-line on macOS

+

It is recommended that you use pkg-config when building from the command line on macOS. That way you will get any new dependencies added automatically. If you still wish to build manually, you need to add the required frameworks and libraries to your command-line yourself using the -l and -framework switches.

+

If you are using the dynamic GLFW library, which is named libglfw.3.dylib, do:

+
cc -o myprog myprog.c -lglfw -framework Cocoa -framework OpenGL -framework IOKit
+

If you are using the static library, named libglfw3.a, substitute -lglfw3 for -lglfw.

+

Note that you do not add the .framework extension to a framework when linking against it from the command-line.

+
Note
Your machine may have libGL.*.dylib style OpenGL library, but that is for the X Window System and will not work with the macOS native version of GLFW.
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/closed.png b/deps/glfw-3.3.8/docs/html/closed.png new file mode 100644 index 0000000..98cc2c9 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/closed.png differ diff --git a/deps/glfw-3.3.8/docs/html/compat_8dox.html b/deps/glfw-3.3.8/docs/html/compat_8dox.html new file mode 100644 index 0000000..64a2e2e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/compat_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: compat.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
compat.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/compat_guide.html b/deps/glfw-3.3.8/docs/html/compat_guide.html new file mode 100644 index 0000000..28e42ba --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/compat_guide.html @@ -0,0 +1,145 @@ + + + + + + + +GLFW: Standards conformance + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Standards conformance
+
+
+

Table of Contents

+ +
+

This guide describes the various API extensions used by this version of GLFW. It lists what are essentially implementation details, but which are nonetheless vital knowledge for developers intending to deploy their applications on a wide range of machines.

+

The information in this guide is not a part of GLFW API, but merely preconditions for some parts of the library to function on a given machine. Any part of this information may change in future versions of GLFW and that will not be considered a breaking API change.

+

+X11 extensions, protocols and IPC standards

+

As GLFW uses Xlib directly, without any intervening toolkit library, it has sole responsibility for interacting well with the many and varied window managers in use on Unix-like systems. In order for applications and window managers to work well together, a number of standards and conventions have been developed that regulate behavior outside the scope of the X11 API; most importantly the Inter-Client Communication Conventions Manual (ICCCM) and Extended Window Manager Hints (EWMH) standards.

+

GLFW uses the _MOTIF_WM_HINTS window property to support borderless windows. If the running window manager does not support this property, the GLFW_DECORATED hint will have no effect.

+

GLFW uses the ICCCM WM_DELETE_WINDOW protocol to intercept the user attempting to close the GLFW window. If the running window manager does not support this protocol, the close callback will never be called.

+

GLFW uses the EWMH _NET_WM_PING protocol, allowing the window manager notify the user when the application has stopped responding, i.e. when it has ceased to process events. If the running window manager does not support this protocol, the user will not be notified if the application locks up.

+

GLFW uses the EWMH _NET_WM_STATE_FULLSCREEN window state to tell the window manager to make the GLFW window full screen. If the running window manager does not support this state, full screen windows may not work properly. GLFW has a fallback code path in case this state is unavailable, but every window manager behaves slightly differently in this regard.

+

GLFW uses the EWMH _NET_WM_BYPASS_COMPOSITOR window property to tell a compositing window manager to un-redirect full screen GLFW windows. If the running window manager uses compositing but does not support this property then additional copying may be performed for each buffer swap of full screen windows.

+

GLFW uses the clipboard manager protocol to push a clipboard string (i.e. selection) owned by a GLFW window about to be destroyed to the clipboard manager. If there is no running clipboard manager, the clipboard string will be unavailable once the window has been destroyed.

+

GLFW uses the X drag-and-drop protocol to provide file drop events. If the application originating the drag does not support this protocol, drag and drop will not work.

+

GLFW uses the XRandR 1.3 extension to provide multi-monitor support. If the running X server does not support this version of this extension, multi-monitor support will not function and only a single, desktop-spanning monitor will be reported.

+

GLFW uses the XRandR 1.3 and Xf86vidmode extensions to provide gamma ramp support. If the running X server does not support either or both of these extensions, gamma ramp support will not function.

+

GLFW uses the Xkb extension and detectable auto-repeat to provide keyboard input. If the running X server does not support this extension, a non-Xkb fallback path is used.

+

GLFW uses the XInput2 extension to provide raw, non-accelerated mouse motion when the cursor is disabled. If the running X server does not support this extension, regular accelerated mouse motion will be used.

+

GLFW uses both the XRender extension and the compositing manager to support transparent window framebuffers. If the running X server does not support this extension or there is no running compositing manager, the GLFW_TRANSPARENT_FRAMEBUFFER framebuffer hint will have no effect.

+

+Wayland protocols and IPC standards

+

As GLFW uses libwayland directly, without any intervening toolkit library, it has sole responsibility for interacting well with every compositor in use on Unix-like systems. Most of the features are provided by the core protocol, while cursor support is provided by the libwayland-cursor helper library, EGL integration by libwayland-egl, and keyboard handling by libxkbcommon. In addition, GLFW uses some protocols from wayland-protocols to provide additional features if the compositor supports them.

+

GLFW uses xkbcommon 0.5.0 to provide compose key support. When it has been built against an older xkbcommon, the compose key will be disabled even if it has been configured in the compositor.

+

GLFW uses the xdg-shell protocol to provide better window management. This protocol is part of wayland-protocols 1.12, and mandatory at build time.

+

GLFW uses the relative pointer protocol alongside the pointer constraints protocol to implement disabled cursor. These two protocols are part of wayland-protocols 1.1, and mandatory at build time. If the running compositor does not support both of these protocols, disabling the cursor will have no effect.

+

GLFW uses the idle inhibit protocol to prohibit the screensaver from starting. This protocol is part of wayland-protocols 1.6, and mandatory at build time. If the running compositor does not support this protocol, the screensaver may start even for full screen windows.

+

GLFW uses the xdg-decoration protocol to request decorations to be drawn around its windows. This protocol is part of wayland-protocols 1.15, and mandatory at build time. If the running compositor does not support this protocol, a very simple frame will be drawn by GLFW itself, using the viewporter protocol alongside subsurfaces. This protocol is part of wayland-protocols 1.4, and mandatory at build time. If the running compositor does not support this protocol either, no decorations will be drawn around windows.

+

+GLX extensions

+

The GLX API is the default API used to create OpenGL contexts on Unix-like systems using the X Window System.

+

GLFW uses the GLX 1.3 GLXFBConfig functions to enumerate and select framebuffer pixel formats. If GLX 1.3 is not supported, glfwInit will fail.

+

GLFW uses the GLX_MESA_swap_control, GLX_EXT_swap_control and GLX_SGI_swap_control extensions to provide vertical retrace synchronization (or vsync), in that order of preference. Where none of these extension are available, calling glfwSwapInterval will have no effect.

+

GLFW uses the GLX_ARB_multisample extension to create contexts with multisampling anti-aliasing. Where this extension is unavailable, the GLFW_SAMPLES hint will have no effect.

+

GLFW uses the GLX_ARB_create_context extension when available, even when creating OpenGL contexts of version 2.1 and below. Where this extension is unavailable, the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints will only be partially supported, the GLFW_OPENGL_DEBUG_CONTEXT hint will have no effect, and setting the GLFW_OPENGL_PROFILE or GLFW_OPENGL_FORWARD_COMPAT hints to GLFW_TRUE will cause glfwCreateWindow to fail.

+

GLFW uses the GLX_ARB_create_context_profile extension to provide support for context profiles. Where this extension is unavailable, setting the GLFW_OPENGL_PROFILE hint to anything but GLFW_OPENGL_ANY_PROFILE, or setting GLFW_CLIENT_API to anything but GLFW_OPENGL_API or GLFW_NO_API will cause glfwCreateWindow to fail.

+

GLFW uses the GLX_ARB_context_flush_control extension to provide control over whether a context is flushed when it is released (made non-current). Where this extension is unavailable, the GLFW_CONTEXT_RELEASE_BEHAVIOR hint will have no effect and the context will always be flushed when released.

+

GLFW uses the GLX_ARB_framebuffer_sRGB and GLX_EXT_framebuffer_sRGB extensions to provide support for sRGB framebuffers. Where both of these extensions are unavailable, the GLFW_SRGB_CAPABLE hint will have no effect.

+

+WGL extensions

+

The WGL API is used to create OpenGL contexts on Microsoft Windows and other implementations of the Win32 API, such as Wine.

+

GLFW uses either the WGL_EXT_extension_string or the WGL_ARB_extension_string extension to check for the presence of all other WGL extensions listed below. If both are available, the EXT one is preferred. If neither is available, no other extensions are used and many GLFW features related to context creation will have no effect or cause errors when used.

+

GLFW uses the WGL_EXT_swap_control extension to provide vertical retrace synchronization (or vsync). Where this extension is unavailable, calling glfwSwapInterval will have no effect.

+

GLFW uses the WGL_ARB_pixel_format and WGL_ARB_multisample extensions to create contexts with multisampling anti-aliasing. Where these extensions are unavailable, the GLFW_SAMPLES hint will have no effect.

+

GLFW uses the WGL_ARB_create_context extension when available, even when creating OpenGL contexts of version 2.1 and below. Where this extension is unavailable, the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints will only be partially supported, the GLFW_OPENGL_DEBUG_CONTEXT hint will have no effect, and setting the GLFW_OPENGL_PROFILE or GLFW_OPENGL_FORWARD_COMPAT hints to GLFW_TRUE will cause glfwCreateWindow to fail.

+

GLFW uses the WGL_ARB_create_context_profile extension to provide support for context profiles. Where this extension is unavailable, setting the GLFW_OPENGL_PROFILE hint to anything but GLFW_OPENGL_ANY_PROFILE will cause glfwCreateWindow to fail.

+

GLFW uses the WGL_ARB_context_flush_control extension to provide control over whether a context is flushed when it is released (made non-current). Where this extension is unavailable, the GLFW_CONTEXT_RELEASE_BEHAVIOR hint will have no effect and the context will always be flushed when released.

+

GLFW uses the WGL_ARB_framebuffer_sRGB and WGL_EXT_framebuffer_sRGB extensions to provide support for sRGB framebuffers. Where both of these extension are unavailable, the GLFW_SRGB_CAPABLE hint will have no effect.

+

+OpenGL on macOS

+

Support for OpenGL 3.2 and above was introduced with OS X 10.7 and even then only forward-compatible, core profile contexts are supported. Support for OpenGL 4.1 was introduced with OS X 10.9, also limited to forward-compatible, core profile contexts. There is also still no mechanism for requesting debug contexts or no-error contexts. Versions of Mac OS X earlier than 10.7 support at most OpenGL version 2.1.

+

Because of this, on OS X 10.7 and later, the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints will cause glfwCreateWindow to fail if given version 3.0 or 3.1. The GLFW_OPENGL_FORWARD_COMPAT hint must be set to GLFW_TRUE and the GLFW_OPENGL_PROFILE hint must be set to GLFW_OPENGL_CORE_PROFILE when creating OpenGL 3.2 and later contexts. The GLFW_OPENGL_DEBUG_CONTEXT and GLFW_CONTEXT_NO_ERROR hints are ignored.

+

Also, on Mac OS X 10.6 and below, the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints will fail if given a version above 2.1, setting the GLFW_OPENGL_PROFILE or GLFW_OPENGL_FORWARD_COMPAT hints to a non-default value will cause glfwCreateWindow to fail and the GLFW_OPENGL_DEBUG_CONTEXT hint is ignored.

+

+Vulkan loader and API

+

By default, GLFW uses the standard system-wide Vulkan loader to access the Vulkan API on all platforms except macOS. This is installed by both graphics drivers and Vulkan SDKs. If either the loader or at least one minimally functional ICD is missing, glfwVulkanSupported will return GLFW_FALSE and all other Vulkan-related functions will fail with an GLFW_API_UNAVAILABLE error.

+

+Vulkan WSI extensions

+

The Vulkan WSI extensions are used to create Vulkan surfaces for GLFW windows on all supported platforms.

+

GLFW uses the VK_KHR_surface and VK_KHR_win32_surface extensions to create surfaces on Microsoft Windows. If any of these extensions are not available, glfwGetRequiredInstanceExtensions will return an empty list and window surface creation will fail.

+

GLFW uses the VK_KHR_surface and either the VK_MVK_macos_surface or VK_EXT_metal_surface extensions to create surfaces on macOS. If any of these extensions are not available, glfwGetRequiredInstanceExtensions will return an empty list and window surface creation will fail.

+

GLFW uses the VK_KHR_surface and either the VK_KHR_xlib_surface or VK_KHR_xcb_surface extensions to create surfaces on X11. If VK_KHR_surface or both VK_KHR_xlib_surface and VK_KHR_xcb_surface are not available, glfwGetRequiredInstanceExtensions will return an empty list and window surface creation will fail.

+

GLFW uses the VK_KHR_surface and VK_KHR_wayland_surface extensions to create surfaces on Wayland. If any of these extensions are not available, glfwGetRequiredInstanceExtensions will return an empty list and window surface creation will fail.

+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/compile_8dox.html b/deps/glfw-3.3.8/docs/html/compile_8dox.html new file mode 100644 index 0000000..35f284a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/compile_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: compile.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
compile.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/compile_guide.html b/deps/glfw-3.3.8/docs/html/compile_guide.html new file mode 100644 index 0000000..3a28819 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/compile_guide.html @@ -0,0 +1,216 @@ + + + + + + + +GLFW: Compiling GLFW + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Compiling GLFW
+
+
+

Table of Contents

+ +
+

This is about compiling the GLFW library itself. For information on how to build applications that use GLFW, see Building applications.

+

+Using CMake

+
Note
GLFW behaves like most other libraries that use CMake so this guide mostly describes the basic configure/generate/compile sequence. If you are already familiar with this from other projects, you may want to focus on the Installing dependencies and CMake options sections for GLFW-specific information.
+

GLFW uses CMake to generate project files or makefiles for your chosen development environment. To compile GLFW, first generate these files with CMake and then use them to compile the GLFW library.

+

If you are on Windows and macOS you can download CMake from their site.

+

If you are on a Unix-like system such as Linux, FreeBSD or Cygwin or have a package system like Fink, MacPorts or Homebrew, you can install its CMake package.

+

CMake is a complex tool and this guide will only show a few of the possible ways to set up and compile GLFW. The CMake project has their own much more detailed CMake user guide that includes everything in this guide not specific to GLFW. It may be a useful companion to this one.

+

+Installing dependencies

+

The C/C++ development environments in Visual Studio, Xcode and MinGW come with all necessary dependencies for compiling GLFW, but on Unix-like systems like Linux and FreeBSD you will need a few extra packages.

+

+Dependencies for X11 on Unix-like systems

+

To compile GLFW for X11, you need to have the X11 development packages installed. They are not needed to build or run programs that use GLFW.

+

On Debian and derivates like Ubuntu and Linux Mint the xorg-dev meta-package pulls in the development packages for all of X11.

+
sudo apt install xorg-dev
+

On Fedora and derivatives like Red Hat the X11 extension packages libXcursor-devel, libXi-devel, libXinerama-devel and libXrandr-devel required by GLFW pull in all its other dependencies.

+
sudo dnf install libXcursor-devel libXi-devel libXinerama-devel libXrandr-devel
+

On FreeBSD the X11 headers are installed along the end-user X11 packages, so if you have an X server running you should have the headers as well. If not, install the xorgproto package.

+
pkg install xorgproto
+

On Cygwin the libXcursor-devel, libXi-devel, libXinerama-devel, libXrandr-devel and libXrender-devel packages in the Libs section of the GUI installer will install all the headers and other development related files GLFW requires for X11.

+

Once you have the required depdendencies, move on to Generating build files with CMake.

+

+Dependencies for Wayland on Unix-like systems

+

To compile GLFW for Wayland, you need to have the Wayland and xkbcommon development packages installed. They are not needed to build or run programs that use GLFW.

+

On Debian and derivates like Ubuntu and Linux Mint you will need the libwayland-dev, libxkbcommon-dev, wayland-protocols and extra-cmake-modules packages.

+
sudo apt install libwayland-dev libxkbcommon-dev wayland-protocols extra-cmake-modules
+

On Fedora and derivatives like Red Hat you will need the wayland-devel, libxkbcommon-devel, wayland-protocols-devel and extra-cmake-modules packages.

+
sudo dnf install wayland-devel libxkbcommon-devel wayland-protocols-devel extra-cmake-modules
+

On FreeBSD you will need the wayland, libxkbcommon, wayland-protocols and kf5-extra-cmake-modules packages.

+
pkg install wayland libxkbcommon wayland-protocols kf5-extra-cmake-modules
+

Once you have the required depdendencies, move on to Generating build files with CMake.

+

+Generating build files with CMake

+

Once you have all necessary dependencies it is time to generate the project files or makefiles for your development environment. CMake needs two paths for this:

+
    +
  • the path to the root directory of the GLFW source tree (not its src subdirectory)
    • +
  • the path to the directory where the generated build files and compiled binaries will be placed
    • +
+

If these are the same, it is called an in-tree build, otherwise it is called an out-of-tree build.

+

Out-of-tree builds are recommended as they avoid cluttering up the source tree. They also allow you to have several build directories for different configurations all using the same source tree.

+

A common pattern when building a single configuration is to have a build directory named build in the root of the source tree.

+

+Generating files with the CMake GUI

+

Start the CMake GUI and set the paths to the source and build directories described above. Then press Configure and Generate.

+

If you wish change any CMake variables in the list, press Configure and then Generate to have the new values take effect. The variable list will be populated after the first configure step.

+

By default GLFW will use X11 on Linux and other Unix-like systems other than macOS. To use Wayland instead, set the GLFW_USE_WAYLAND option in the GLFW section of the variable list, then apply the new value as described above.

+

Once you have generated the project files or makefiles for your chosen development environment, move on to Compiling the library.

+

+Generating files with the CMake command-line tool

+

To make a build directory, pass the source and build directories to the cmake command. These can be relative or absolute paths. The build directory is created if it doesn't already exist.

+
cmake -S path/to/glfw -B path/to/build
+

It is common to name the build directory build and place it in the root of the source tree when only planning to build a single configuration.

+
cd path/to/glfw
+
cmake -S . -B build
+

Without other flags these will generate Visual Studio project files on Windows and makefiles on other platforms. You can choose other targets using the -G flag.

+
cmake -S path/to/glfw -B path/to/build -G Xcode
+

By default GLFW will use X11 on Linux and other Unix-like systems other than macOS. To use Wayland instead, set the GLFW_USE_WAYLAND CMake option.

+
cmake -S path/to/glfw -B path/to/build -D GLFW_USE_WAYLAND=1
+

Once you have generated the project files or makefiles for your chosen development environment, move on to Compiling the library.

+

+Compiling the library

+

You should now have all required dependencies and the project files or makefiles necessary to compile GLFW. Go ahead and compile the actual GLFW library with these files as you would with any other project.

+

With Visual Studio open GLFW.sln and use the Build menu. With Xcode open GLFW.xcodeproj and use the Project menu.

+

With Linux, macOS and other forms of Unix, run make.

+
cd path/to/build
+
make
+

With MinGW, it is mingw32-make.

+
cd path/to/build
+
mingw32-make
+

Any CMake build directory can also be built with the cmake command and the --build flag.

+
cmake --build path/to/build
+

This will run the platform specific build tool the directory was generated for.

+

Once the GLFW library is compiled you are ready to build your application, linking it to the GLFW library. See Building applications for more information.

+

+CMake options

+

The CMake files for GLFW provide a number of options, although not all are available on all supported platforms. Some of these are de facto standards among projects using CMake and so have no GLFW_ prefix.

+

If you are using the GUI version of CMake, these are listed and can be changed from there. If you are using the command-line version of CMake you can use the ccmake ncurses GUI to set options. Some package systems like Ubuntu and other distributions based on Debian GNU/Linux have this tool in a separate cmake-curses-gui package.

+

Finally, if you don't want to use any GUI, you can set options from the cmake command-line with the -D flag.

+
cmake -S path/to/glfw -B path/to/build -D BUILD_SHARED_LIBS=ON
+

+Shared CMake options

+

BUILD_SHARED_LIBS determines whether GLFW is built as a static library or as a DLL / shared library / dynamic library. This is disabled by default, producing a static GLFW library.

+

GLFW_BUILD_EXAMPLES determines whether the GLFW examples are built along with the library.

+

GLFW_BUILD_TESTS determines whether the GLFW test programs are built along with the library.

+

GLFW_BUILD_DOCS determines whether the GLFW documentation is built along with the library. This is enabled by default if Doxygen is found by CMake during configuration.

+

GLFW_VULKAN_STATIC determines whether to use the Vulkan loader linked directly with the application. This is disabled by default.

+

+Windows specific CMake options

+

USE_MSVC_RUNTIME_LIBRARY_DLL determines whether to use the DLL version or the static library version of the Visual C++ runtime library. When enabled, the DLL version of the Visual C++ library is used. This is enabled by default.

+

On CMake 3.15 and later you can set the standard CMake CMAKE_MSVC_RUNTIME_LIBRARY variable instead of this GLFW-specific option.

+

GLFW_USE_HYBRID_HPG determines whether to export the NvOptimusEnablement and AmdPowerXpressRequestHighPerformance symbols, which force the use of the high-performance GPU on Nvidia Optimus and AMD PowerXpress systems. These symbols need to be exported by the EXE to be detected by the driver, so the override will not work if GLFW is built as a DLL. This is disabled by default, letting the operating system and driver decide.

+

+Wayland specific CMake options

+

GLFW_USE_WAYLAND determines whether to compile the library for Wayland. This option is only available on Linux and other Unix-like systems other than macOS. This is disabled by default.

+

+Cross-compilation with CMake and MinGW

+

Both Cygwin and many Linux distributions have MinGW or MinGW-w64 packages. For example, Cygwin has the mingw64-i686-gcc and mingw64-x86_64-gcc packages for 32- and 64-bit version of MinGW-w64, while Debian GNU/Linux and derivatives like Ubuntu have the mingw-w64 package for both.

+

GLFW has CMake toolchain files in the CMake subdirectory that set up cross-compilation of Windows binaries. To use these files you set the CMAKE_TOOLCHAIN_FILE CMake variable with the -D flag add an option when configuring and generating the build files.

+
cmake -S path/to/glfw -B path/to/build -D CMAKE_TOOLCHAIN_FILE=path/to/file
+

The exact toolchain file to use depends on the prefix used by the MinGW or MinGW-w64 binaries on your system. You can usually see this in the /usr directory. For example, both the Ubuntu and Cygwin MinGW-w64 packages have /usr/x86_64-w64-mingw32 for the 64-bit compilers, so the correct invocation would be:

+
cmake -S path/to/glfw -B path/to/build -D CMAKE_TOOLCHAIN_FILE=CMake/x86_64-w64-mingw32.cmake
+

The path to the toolchain file is relative to the path to the GLFW source tree passed to the -S flag, not to the current directory.

+

For more details see the CMake toolchain guide.

+

+Compiling GLFW manually

+

If you wish to compile GLFW without its CMake build environment then you will have to do at least some of the platform detection yourself. GLFW needs a configuration macro to be defined in order to know what window system it is being compiled for and also has optional, platform-specific ones for various features.

+

When building with CMake, the glfw_config.h configuration header is generated based on the current platform and CMake options. The GLFW CMake environment defines GLFW_USE_CONFIG_H, which causes this header to be included by internal.h. Without this macro, GLFW will expect the necessary configuration macros to be defined on the command-line.

+

The window creation API is used to create windows, handle input, monitors, gamma ramps and clipboard. The options are:

+
    +
  • _GLFW_COCOA to use the Cocoa frameworks
    • +
  • _GLFW_WIN32 to use the Win32 API
    • +
  • _GLFW_X11 to use the X Window System
    • +
  • _GLFW_WAYLAND to use the Wayland API (experimental and incomplete)
    • +
  • _GLFW_OSMESA to use the OSMesa API (headless and non-interactive)
    • +
+

If you are building GLFW as a shared library / dynamic library / DLL then you must also define _GLFW_BUILD_DLL. Otherwise, you must not define it.

+

If you are linking the Vulkan loader directly with your application then you must also define _GLFW_VULKAN_STATIC. Otherwise, GLFW will attempt to use the external version.

+

If you are using a custom name for the Vulkan, EGL, GLX, OSMesa, OpenGL, GLESv1 or GLESv2 library, you can override the default names by defining those you need of _GLFW_VULKAN_LIBRARY, _GLFW_EGL_LIBRARY, _GLFW_GLX_LIBRARY, _GLFW_OSMESA_LIBRARY, _GLFW_OPENGL_LIBRARY, _GLFW_GLESV1_LIBRARY and _GLFW_GLESV2_LIBRARY. Otherwise, GLFW will use the built-in default names.

+
Note
None of the GLFW header option macros may be defined during the compilation of GLFW. If you define any of these in your build files, make sure they are not applied to the GLFW sources.
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/context_8dox.html b/deps/glfw-3.3.8/docs/html/context_8dox.html new file mode 100644 index 0000000..89cb318 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/context_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: context.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
context.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/context_guide.html b/deps/glfw-3.3.8/docs/html/context_guide.html new file mode 100644 index 0000000..04c9c09 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/context_guide.html @@ -0,0 +1,251 @@ + + + + + + + +GLFW: Context guide + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Context guide
+
+
+

Table of Contents

+ +
+

This guide introduces the OpenGL and OpenGL ES context related functions of GLFW. For details on a specific function in this category, see the Context reference. There are also guides for the other areas of the GLFW API.

+ +

+Context objects

+

A window object encapsulates both a top-level window and an OpenGL or OpenGL ES context. It is created with glfwCreateWindow and destroyed with glfwDestroyWindow or glfwTerminate. See Window creation for more information.

+

As the window and context are inseparably linked, the window object also serves as the context handle.

+

To test the creation of various kinds of contexts and see their properties, run the glfwinfo test program.

+
Note
Vulkan does not have a context and the Vulkan instance is created via the Vulkan API itself. If you will be using Vulkan to render to a window, disable context creation by setting the GLFW_CLIENT_API hint to GLFW_NO_API. For more information, see the Vulkan guide.
+

+Context creation hints

+

There are a number of hints, specified using glfwWindowHint, related to what kind of context is created. See context related hints in the window guide.

+

+Context object sharing

+

When creating a window and its OpenGL or OpenGL ES context with glfwCreateWindow, you can specify another window whose context the new one should share its objects (textures, vertex and element buffers, etc.) with.

+
GLFWwindow* second_window = glfwCreateWindow(640, 480, "Second Window", NULL, first_window);
+
glfwCreateWindow
GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
Creates a window and its associated context.
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+

Object sharing is implemented by the operating system and graphics driver. On platforms where it is possible to choose which types of objects are shared, GLFW requests that all types are shared.

+

See the relevant chapter of the OpenGL or OpenGL ES reference documents for more information. The name and number of this chapter unfortunately varies between versions and APIs, but has at times been named Shared Objects and Multiple Contexts.

+

GLFW comes with a barebones object sharing example program called sharing.

+

+Offscreen contexts

+

GLFW doesn't support creating contexts without an associated window. However, contexts with hidden windows can be created with the GLFW_VISIBLE window hint.

+
glfwWindowHint(GLFW_VISIBLE, GLFW_FALSE);
+
+
GLFWwindow* offscreen_context = glfwCreateWindow(640, 480, "", NULL, NULL);
+
GLFW_FALSE
#define GLFW_FALSE
Zero.
Definition: glfw3.h:321
+
glfwWindowHint
void glfwWindowHint(int hint, int value)
Sets the specified window hint to the desired value.
+
GLFW_VISIBLE
#define GLFW_VISIBLE
Window visibility window hint and attribute.
Definition: glfw3.h:814
+

The window never needs to be shown and its context can be used as a plain offscreen context. Depending on the window manager, the size of a hidden window's framebuffer may not be usable or modifiable, so framebuffer objects are recommended for rendering with such contexts.

+

You should still process events as long as you have at least one window, even if none of them are visible.

+

macOS: The first time a window is created the menu bar is created. This is not desirable for example when writing a command-line only application. Menu bar creation can be disabled with the GLFW_COCOA_MENUBAR init hint.

+

+Windows without contexts

+

You can disable context creation by setting the GLFW_CLIENT_API hint to GLFW_NO_API. Windows without contexts must not be passed to glfwMakeContextCurrent or glfwSwapBuffers.

+

+Current context

+

Before you can make OpenGL or OpenGL ES calls, you need to have a current context of the correct type. A context can only be current for a single thread at a time, and a thread can only have a single context current at a time.

+

When moving a context between threads, you must make it non-current on the old thread before making it current on the new one.

+

The context of a window is made current with glfwMakeContextCurrent.

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

The window of the current context is returned by glfwGetCurrentContext.

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

The following GLFW functions require a context to be current. Calling any these functions without a current context will generate a GLFW_NO_CURRENT_CONTEXT error.

+ +

+Buffer swapping

+

See Buffer swapping in the window guide.

+

+OpenGL and OpenGL ES extensions

+

One of the benefits of OpenGL and OpenGL ES is their extensibility. Hardware vendors may include extensions in their implementations that extend the API before that functionality is included in a new version of the OpenGL or OpenGL ES specification, and some extensions are never included and remain as extensions until they become obsolete.

+

An extension is defined by:

+
    +
  • An extension name (e.g. GL_ARB_gl_spirv)
    • +
  • New OpenGL tokens (e.g. GL_SPIR_V_BINARY_ARB)
    • +
  • New OpenGL functions (e.g. glSpecializeShaderARB)
    • +
+

Note the ARB affix, which stands for Architecture Review Board and is used for official extensions. The extension above was created by the ARB, but there are many different affixes, like NV for Nvidia and AMD for, well, AMD. Any group may also use the generic EXT affix. Lists of extensions, together with their specifications, can be found at the OpenGL Registry and OpenGL ES Registry.

+

+Loading extension with a loader library

+

An extension loader library is the easiest and best way to access both OpenGL and OpenGL ES extensions and modern versions of the core OpenGL or OpenGL ES APIs. They will take care of all the details of declaring and loading everything you need. One such library is glad and there are several others.

+

The following example will use glad but all extension loader libraries work similarly.

+

First you need to generate the source files using the glad Python script. This example generates a loader for any version of OpenGL, which is the default for both GLFW and glad, but loaders for OpenGL ES, as well as loaders for specific API versions and extension sets can be generated. The generated files are written to the output directory.

+
python main.py --generator c --no-loader --out-path output
+

The --no-loader option is added because GLFW already provides a function for loading OpenGL and OpenGL ES function pointers, one that automatically uses the selected context creation API, and glad can call this instead of having to implement its own. There are several other command-line options as well. See the glad documentation for details.

+

Add the generated output/src/glad.c, output/include/glad/glad.h and output/include/KHR/khrplatform.h files to your build. Then you need to include the glad header file, which will replace the OpenGL header of your development environment. By including the glad header before the GLFW header, it suppresses the development environment's OpenGL or OpenGL ES header.

+
#include <glad/glad.h>
+
#include <GLFW/glfw3.h>
+
glfw3.h
The header of the GLFW 3 API.
+

Finally you need to initialize glad once you have a suitable current context.

+
window = glfwCreateWindow(640, 480, "My Window", NULL, NULL);
+
if (!window)
+
{
+
...
+
}
+
+
glfwMakeContextCurrent(window);
+
+
gladLoadGLLoader((GLADloadproc) glfwGetProcAddress);
+
glfwGetProcAddress
GLFWglproc glfwGetProcAddress(const char *procname)
Returns the address of the specified function for the current context.
+

Once glad has been loaded, you have access to all OpenGL core and extension functions supported by both the context you created and the glad loader you generated and you are ready to start rendering.

+

You can specify a minimum required OpenGL or OpenGL ES version with context hints. If your needs are more complex, you can check the actual OpenGL or OpenGL ES version with context attributes, or you can check whether a specific version is supported by the current context with the GLAD_GL_VERSION_x_x booleans.

+
if (GLAD_GL_VERSION_3_2)
+
{
+
// Call OpenGL 3.2+ specific code
+
}
+

To check whether a specific extension is supported, use the GLAD_GL_xxx booleans.

+
if (GLAD_GL_ARB_gl_spirv)
+
{
+
// Use GL_ARB_gl_spirv
+
}
+

+Loading extensions manually

+

Do not use this technique unless it is absolutely necessary. An extension loader library will save you a ton of tedious, repetitive, error prone work.

+

To use a certain extension, you must first check whether the context supports that extension and then, if it introduces new functions, retrieve the pointers to those functions. GLFW provides glfwExtensionSupported and glfwGetProcAddress for manual loading of extensions and new API functions.

+

This section will demonstrate manual loading of OpenGL extensions. The loading of OpenGL ES extensions is identical except for the name of the extension header.

+

+The glext.h header

+

The glext.h extension header is a continually updated file that defines the interfaces for all OpenGL extensions. The latest version of this can always be found at the OpenGL Registry. There are also extension headers for the various versions of OpenGL ES at the OpenGL ES Registry. It it strongly recommended that you use your own copy of the extension header, as the one included in your development environment may be several years out of date and may not include the extensions you wish to use.

+

The header defines function pointer types for all functions of all extensions it supports. These have names like PFNGLSPECIALIZESHADERARBPROC (for glSpecializeShaderARB), i.e. the name is made uppercase and PFN (pointer to function) and PROC (procedure) are added to the ends.

+

To include the extension header, define GLFW_INCLUDE_GLEXT before including the GLFW header.

+
#define GLFW_INCLUDE_GLEXT
+
#include <GLFW/glfw3.h>
+

+Checking for extensions

+

A given machine may not actually support the extension (it may have older drivers or a graphics card that lacks the necessary hardware features), so it is necessary to check at run-time whether the context supports the extension. This is done with glfwExtensionSupported.

+
if (glfwExtensionSupported("GL_ARB_gl_spirv"))
+
{
+
// The extension is supported by the current context
+
}
+
glfwExtensionSupported
int glfwExtensionSupported(const char *extension)
Returns whether the specified extension is available.
+

The argument is a null terminated ASCII string with the extension name. If the extension is supported, glfwExtensionSupported returns GLFW_TRUE, otherwise it returns GLFW_FALSE.

+

+Fetching function pointers

+

Many extensions, though not all, require the use of new OpenGL functions. These functions often do not have entry points in the client API libraries of your operating system, making it necessary to fetch them at run time. You can retrieve pointers to these functions with glfwGetProcAddress.

+
PFNGLSPECIALIZESHADERARBPROC pfnSpecializeShaderARB = glfwGetProcAddress("glSpecializeShaderARB");
+

In general, you should avoid giving the function pointer variables the (exact) same name as the function, as this may confuse your linker. Instead, you can use a different prefix, like above, or some other naming scheme.

+

Now that all the pieces have been introduced, here is what they might look like when used together.

+
#define GLFW_INCLUDE_GLEXT
+
#include <GLFW/glfw3.h>
+
+
#define glSpecializeShaderARB pfnSpecializeShaderARB
+
PFNGLSPECIALIZESHADERARBPROC pfnSpecializeShaderARB;
+
+
// Flag indicating whether the extension is supported
+
int has_ARB_gl_spirv = 0;
+
+
void load_extensions(void)
+
{
+
if (glfwExtensionSupported("GL_ARB_gl_spirv"))
+
{
+
pfnSpecializeShaderARB = (PFNGLSPECIALIZESHADERARBPROC)
+
glfwGetProcAddress("glSpecializeShaderARB");
+
has_ARB_gl_spirv = 1;
+
}
+
}
+
+
void some_function(void)
+
{
+
if (has_ARB_gl_spirv)
+
{
+
// Now the extension function can be called as usual
+
glSpecializeShaderARB(...);
+
}
+
}
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/deprecated.html b/deps/glfw-3.3.8/docs/html/deprecated.html new file mode 100644 index 0000000..f516c9a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/deprecated.html @@ -0,0 +1,81 @@ + + + + + + + +GLFW: Deprecated List + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Deprecated List
+
+
+
+
Global GLFWcharmodsfun )(GLFWwindow *window, unsigned int codepoint, int mods)
+
Scheduled for removal in version 4.0.
+
Global glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun callback)
+
Scheduled for removal in version 4.0.
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/dir_1dfd43b3952c5bc1ba15d15b12afff7b.html b/deps/glfw-3.3.8/docs/html/dir_1dfd43b3952c5bc1ba15d15b12afff7b.html new file mode 100644 index 0000000..ec0844b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/dir_1dfd43b3952c5bc1ba15d15b12afff7b.html @@ -0,0 +1,88 @@ + + + + + + + +GLFW: GLFW Directory Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
GLFW Directory Reference
+
+
+ + + + + + + + +

+Files

file  glfw3.h [code]
 The header of the GLFW 3 API.
 
file  glfw3native.h [code]
 The header of the native access functions.
 
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/dir_4351554941a2744586042c1cf3cf139a.html b/deps/glfw-3.3.8/docs/html/dir_4351554941a2744586042c1cf3cf139a.html new file mode 100644 index 0000000..bb36bd1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/dir_4351554941a2744586042c1cf3cf139a.html @@ -0,0 +1,86 @@ + + + + + + + +GLFW: glfw-3.3.8 Directory Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
glfw-3.3.8 Directory Reference
+
+
+ + + + + + +

+Directories

directory  docs
 
directory  include
 
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/dir_f6ba4c3dca55a8d4e7d63c8235e0ad43.html b/deps/glfw-3.3.8/docs/html/dir_f6ba4c3dca55a8d4e7d63c8235e0ad43.html new file mode 100644 index 0000000..4a9295a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/dir_f6ba4c3dca55a8d4e7d63c8235e0ad43.html @@ -0,0 +1,84 @@ + + + + + + + +GLFW: include Directory Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
include Directory Reference
+
+
+ + + + +

+Directories

directory  GLFW
 
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/dir_fda32cf7bec00275262cb8799a618f76.html b/deps/glfw-3.3.8/docs/html/dir_fda32cf7bec00275262cb8799a618f76.html new file mode 100644 index 0000000..3464fd1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/dir_fda32cf7bec00275262cb8799a618f76.html @@ -0,0 +1,78 @@ + + + + + + + +GLFW: docs Directory Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
docs Directory Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/doc.png b/deps/glfw-3.3.8/docs/html/doc.png new file mode 100644 index 0000000..17edabf Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/doc.png differ diff --git a/deps/glfw-3.3.8/docs/html/doxygen.css b/deps/glfw-3.3.8/docs/html/doxygen.css new file mode 100644 index 0000000..2010785 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/doxygen.css @@ -0,0 +1,1841 @@ +/* The standard CSS for doxygen 1.9.4 */ + +body, table, div, p, dl { + font: 400 14px/22px Roboto,sans-serif; +} + +p.reference, p.definition { + font: 400 14px/22px Roboto,sans-serif; +} + +/* @group Heading Levels */ + +h1.groupheader { + font-size: 150%; +} + +.title { + font: 400 14px/28px Roboto,sans-serif; + font-size: 150%; + font-weight: bold; + margin: 10px 2px; +} + +h2.groupheader { + border-bottom: 1px solid #879ECB; + color: #354C7B; + font-size: 150%; + font-weight: normal; + margin-top: 1.75em; + padding-top: 8px; + padding-bottom: 4px; + width: 100%; +} + +h3.groupheader { + font-size: 100%; +} + +h1, h2, h3, h4, h5, h6 { + -webkit-transition: text-shadow 0.5s linear; + -moz-transition: text-shadow 0.5s linear; + -ms-transition: text-shadow 0.5s linear; + -o-transition: text-shadow 0.5s linear; + transition: text-shadow 0.5s linear; + margin-right: 15px; +} + +h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { + text-shadow: 0 0 15px cyan; +} + +dt { + font-weight: bold; +} + +ul.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; + column-count: 3; +} + +p.startli, p.startdd { + margin-top: 2px; +} + +th p.starttd, th p.intertd, th p.endtd { + font-size: 100%; + font-weight: 700; +} + +p.starttd { + margin-top: 0px; +} + +p.endli { + margin-bottom: 0px; +} + +p.enddd { + margin-bottom: 4px; +} + +p.endtd { + margin-bottom: 2px; +} + +p.interli { +} + +p.interdd { +} + +p.intertd { +} + +/* @end */ + +caption { + font-weight: bold; +} + +span.legend { + font-size: 70%; + text-align: center; +} + +h3.version { + font-size: 90%; + text-align: center; +} + +div.navtab { + border-right: 1px solid #A3B4D7; + padding-right: 15px; + text-align: right; + line-height: 110%; +} + +div.navtab table { + border-spacing: 0; +} + +td.navtab { + padding-right: 6px; + padding-left: 6px; +} +td.navtabHL { + background-image: url('tab_a.png'); + background-repeat:repeat-x; + padding-right: 6px; + padding-left: 6px; +} + +td.navtabHL a, td.navtabHL a:visited { + color: #fff; + text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +} + +a.navtab { + font-weight: bold; +} + +div.qindex{ + text-align: center; + width: 100%; + line-height: 140%; + font-size: 130%; + color: #A0A0A0; +} + +dt.alphachar{ + font-size: 180%; + font-weight: bold; +} + +.alphachar a{ + color: black; +} + +.alphachar a:hover, .alphachar a:visited{ + text-decoration: none; +} + +.classindex dl { + padding: 25px; + column-count:1 +} + +.classindex dd { + display:inline-block; + margin-left: 50px; + width: 90%; + line-height: 1.15em; +} + +.classindex dl.odd { + background-color: #F8F9FC; +} + +@media(min-width: 1120px) { + .classindex dl { + column-count:2 + } +} + +@media(min-width: 1320px) { + .classindex dl { + column-count:3 + } +} + + +/* @group Link Styling */ + +a { + color: #3D578C; + font-weight: normal; + text-decoration: none; +} + +.contents a:visited { + color: #4665A2; +} + +a:hover { + text-decoration: underline; +} + +.contents a.qindexHL:visited { + color: #FFFFFF; +} + +a.el { + font-weight: bold; +} + +a.elRef { +} + +a.code, a.code:visited, a.line, a.line:visited { + color: #4665A2; +} + +a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited { + color: #4665A2; +} + +a.code.hl_class { /* style for links to class names in code snippets */ } +a.code.hl_struct { /* style for links to struct names in code snippets */ } +a.code.hl_union { /* style for links to union names in code snippets */ } +a.code.hl_interface { /* style for links to interface names in code snippets */ } +a.code.hl_protocol { /* style for links to protocol names in code snippets */ } +a.code.hl_category { /* style for links to category names in code snippets */ } +a.code.hl_exception { /* style for links to exception names in code snippets */ } +a.code.hl_service { /* style for links to service names in code snippets */ } +a.code.hl_singleton { /* style for links to singleton names in code snippets */ } +a.code.hl_concept { /* style for links to concept names in code snippets */ } +a.code.hl_namespace { /* style for links to namespace names in code snippets */ } +a.code.hl_package { /* style for links to package names in code snippets */ } +a.code.hl_define { /* style for links to macro names in code snippets */ } +a.code.hl_function { /* style for links to function names in code snippets */ } +a.code.hl_variable { /* style for links to variable names in code snippets */ } +a.code.hl_typedef { /* style for links to typedef names in code snippets */ } +a.code.hl_enumvalue { /* style for links to enum value names in code snippets */ } +a.code.hl_enumeration { /* style for links to enumeration names in code snippets */ } +a.code.hl_signal { /* style for links to Qt signal names in code snippets */ } +a.code.hl_slot { /* style for links to Qt slot names in code snippets */ } +a.code.hl_friend { /* style for links to friend names in code snippets */ } +a.code.hl_dcop { /* style for links to KDE3 DCOP names in code snippets */ } +a.code.hl_property { /* style for links to property names in code snippets */ } +a.code.hl_event { /* style for links to event names in code snippets */ } +a.code.hl_sequence { /* style for links to sequence names in code snippets */ } +a.code.hl_dictionary { /* style for links to dictionary names in code snippets */ } + +/* @end */ + +dl.el { + margin-left: -1cm; +} + +ul { + overflow: visible; +} + +#side-nav ul { + overflow: visible; /* reset ul rule for scroll bar in GENERATE_TREEVIEW window */ +} + +#main-nav ul { + overflow: visible; /* reset ul rule for the navigation bar drop down lists */ +} + +.fragment { + text-align: left; + direction: ltr; + overflow-x: auto; /*Fixed: fragment lines overlap floating elements*/ + overflow-y: hidden; +} + +pre.fragment { + border: 1px solid #C4CFE5; + background-color: #FBFCFD; + padding: 4px 6px; + margin: 4px 8px 4px 2px; + overflow: auto; + word-wrap: break-word; + font-size: 9pt; + line-height: 125%; + font-family: monospace, fixed; + font-size: 105%; +} + +div.fragment { + padding: 0 0 1px 0; /*Fixed: last line underline overlap border*/ + margin: 4px 8px 4px 2px; + background-color: #FBFCFD; + border: 1px solid #C4CFE5; +} + +div.line { + font-family: monospace, fixed; + font-size: 13px; + min-height: 13px; + line-height: 1.0; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +div.line:after { + content:"\000A"; + white-space: pre; +} + +div.line.glow { + background-color: cyan; + box-shadow: 0 0 10px cyan; +} + + +span.lineno { + padding-right: 4px; + margin-right: 9px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +.lineno { + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +div.ah, span.ah { + background-color: black; + font-weight: bold; + color: #FFFFFF; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; + box-shadow: 2px 2px 3px #999; + -webkit-box-shadow: 2px 2px 3px #999; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444)); + background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000 110%); +} + +div.classindex ul { + list-style: none; + padding-left: 0; +} + +div.classindex span.ai { + display: inline-block; +} + +div.groupHeader { + margin-left: 16px; + margin-top: 12px; + font-weight: bold; +} + +div.groupText { + margin-left: 16px; + font-style: italic; +} + +body { + background-color: white; + color: black; + margin: 0; +} + +div.contents { + margin-top: 10px; + margin-left: 12px; + margin-right: 8px; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C4CFE5; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C4CFE5; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EEF1F7; +} + +p.formulaDsp { + text-align: center; +} + +img.formulaDsp { + +} + +img.formulaInl, img.inline { + vertical-align: middle; +} + +div.center { + text-align: center; + margin-top: 0px; + margin-bottom: 0px; + padding: 0px; +} + +div.center img { + border: 0px; +} + +address.footer { + text-align: right; + padding-right: 12px; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +.compoundTemplParams { + color: #4665A2; + font-size: 80%; + line-height: 120%; +} + +/* @group Code Colorization */ + +span.keyword { + color: #008000 +} + +span.keywordtype { + color: #604020 +} + +span.keywordflow { + color: #e08000 +} + +span.comment { + color: #800000 +} + +span.preprocessor { + color: #806020 +} + +span.stringliteral { + color: #002080 +} + +span.charliteral { + color: #008080 +} + +span.vhdldigit { + color: #ff00ff +} + +span.vhdlchar { + color: #000000 +} + +span.vhdlkeyword { + color: #700070 +} + +span.vhdllogic { + color: #ff0000 +} + +blockquote { + background-color: #F7F8FB; + border-left: 2px solid #9CAFD4; + margin: 0 24px 0 4px; + padding: 0 12px 0 16px; +} + +blockquote.DocNodeRTL { + border-left: 0; + border-right: 2px solid #9CAFD4; + margin: 0 4px 0 24px; + padding: 0 16px 0 12px; +} + +/* @end */ + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +.dirtab { + padding: 4px; + border-collapse: collapse; + border: 1px solid #A3B4D7; +} + +th.dirtab { + background: #EBEFF6; + font-weight: bold; +} + +hr { + height: 0px; + border: none; + border-top: 1px solid #4A6AAA; +} + +hr.footer { + height: 1px; +} + +/* @group Member Descriptions */ + +table.memberdecls { + border-spacing: 0px; + padding: 0px; +} + +.memberdecls td, .fieldtable tr { + -webkit-transition-property: background-color, box-shadow; + -webkit-transition-duration: 0.5s; + -moz-transition-property: background-color, box-shadow; + -moz-transition-duration: 0.5s; + -ms-transition-property: background-color, box-shadow; + -ms-transition-duration: 0.5s; + -o-transition-property: background-color, box-shadow; + -o-transition-duration: 0.5s; + transition-property: background-color, box-shadow; + transition-duration: 0.5s; +} + +.memberdecls td.glow, .fieldtable tr.glow { + background-color: cyan; + box-shadow: 0 0 15px cyan; +} + +.mdescLeft, .mdescRight, +.memItemLeft, .memItemRight, +.memTemplItemLeft, .memTemplItemRight, .memTemplParams { + background-color: #F9FAFC; + border: none; + margin: 4px; + padding: 1px 0 0 8px; +} + +.mdescLeft, .mdescRight { + padding: 0px 8px 4px 8px; + color: #555; +} + +.memSeparator { + border-bottom: 1px solid #DEE4F0; + line-height: 1px; + margin: 0px; + padding: 0px; +} + +.memItemLeft, .memTemplItemLeft { + white-space: nowrap; +} + +.memItemRight, .memTemplItemRight { + width: 100%; +} + +.memTemplParams { + color: #4665A2; + white-space: nowrap; + font-size: 80%; +} + +/* @end */ + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + padding: 8px; + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-image: url('nav_f.png'); + background-repeat: repeat-x; + background-color: #E2E8F2; + line-height: 1.25; + font-weight: 300; + float:left; +} + +.permalink +{ + font-size: 65%; + display: inline-block; + vertical-align: middle; +} + +.memtemplate { + font-size: 80%; + color: #4665A2; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A3B4D7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; + display: table !important; + width: 100%; +} + +.memitem.glow { + box-shadow: 0 0 15px cyan; +} + +.memname { + font-weight: 400; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} + +.memproto, dl.reflist dt { + border-top: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 0px 6px 0px; + color: #253555; + font-weight: bold; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + background-color: #DFE5F1; + /* opera specific markup */ + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + border-top-right-radius: 4px; + /* firefox specific markup */ + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + -moz-border-radius-topright: 4px; + /* webkit specific markup */ + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + -webkit-border-top-right-radius: 4px; + +} + +.overload { + font-family: "courier new",courier,monospace; + font-size: 65%; +} + +.memdoc, dl.reflist dd { + border-bottom: 1px solid #A8B8D9; + border-left: 1px solid #A8B8D9; + border-right: 1px solid #A8B8D9; + padding: 6px 10px 2px 10px; + background-color: #FBFCFD; + border-top-width: 0; + background-image:url('nav_g.png'); + background-repeat:repeat-x; + background-color: #FFFFFF; + /* opera specific markup */ + border-bottom-left-radius: 4px; + border-bottom-right-radius: 4px; + box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); + /* firefox specific markup */ + -moz-border-radius-bottomleft: 4px; + -moz-border-radius-bottomright: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px; + /* webkit specific markup */ + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: #602020; + white-space: nowrap; +} +.paramname em { + font-style: normal; +} +.paramname code { + line-height: 14px; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname, .tparams .paramname, .exception .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype, .tparams .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir, .tparams .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #728DC1; + border-top:1px solid #5373B4; + border-left:1px solid #5373B4; + border-right:1px solid #C4CFE5; + border-bottom:1px solid #C4CFE5; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; + vertical-align: middle; +} + + + +/* @end */ + +/* these are for tree view inside a (index) page */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid #9CAFD4; + border-bottom: 1px solid #9CAFD4; + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + margin: 0px; + padding: 0px; + vertical-align: top; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top: 3px; +} + +.directory td.entry a { + outline:none; +} + +.directory td.entry a img { + border: none; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top: 3px; + border-left: 1px solid rgba(0,0,0,0.05); +} + +.directory tr.even { + padding-left: 6px; + background-color: #F7F8FB; +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3D578C; +} + +.arrow { + color: #9CAFD4; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 80%; + display: inline-block; + width: 16px; + height: 22px; +} + +.icon { + font-family: Arial, Helvetica; + font-weight: bold; + font-size: 12px; + height: 14px; + width: 16px; + display: inline-block; + background-color: #728DC1; + color: white; + text-align: center; + border-radius: 4px; + margin-left: 2px; + margin-right: 2px; +} + +.icona { + width: 24px; + height: 22px; + display: inline-block; +} + +.iconfopen { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderopen.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.iconfclosed { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('folderclosed.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +.icondoc { + width: 24px; + height: 18px; + margin-bottom: 4px; + background-image:url('doc.png'); + background-position: 0px -4px; + background-repeat: repeat-y; + vertical-align:top; + display: inline-block; +} + +table.directory { + font: 400 14px Roboto,sans-serif; +} + +/* @end */ + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #2A3D61; +} + +table.doxtable caption { + caption-side: top; +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.doxtable th { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +table.fieldtable { + /*width: 100%;*/ + margin-bottom: 10px; + border: 1px solid #A8B8D9; + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px; + -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); + box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15); +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname { + white-space: nowrap; + border-right: 1px solid #A8B8D9; + border-bottom: 1px solid #A8B8D9; + vertical-align: top; +} + +.fieldtable td.fieldname { + padding-top: 3px; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid #A8B8D9; + /*width: 100%;*/ +} + +.fieldtable td.fielddoc p:first-child { + margin-top: 0px; +} + +.fieldtable td.fielddoc p:last-child { + margin-bottom: 2px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-image:url('nav_f.png'); + background-repeat:repeat-x; + background-color: #E2E8F2; + font-size: 90%; + color: #253555; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; + font-weight: 400; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-top-left-radius: 4px; + border-top-right-radius: 4px; + border-bottom: 1px solid #A8B8D9; +} + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-image:url('tab_b.png'); + background-repeat:repeat-x; + background-position: 0 -5px; + height:30px; + line-height:30px; + color:#8AA0CC; + border:solid 1px #C2CDE4; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + background-image:url('bc_s.png'); + background-repeat:no-repeat; + background-position:right; + color:#364D7C; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; + color: #283A5D; + font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif; + text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + text-decoration: none; +} + +.navpath li.navelem a:hover +{ + color:#6884BD; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + background-image:none; + background-repeat:no-repeat; + background-position:right; + color:#364D7C; + font-size: 8pt; +} + + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +table.classindex +{ + margin: 10px; + white-space: nowrap; + margin-left: 3%; + margin-right: 3%; + width: 94%; + border: 0; + border-spacing: 0; + padding: 0; +} + +div.ingroups +{ + font-size: 8pt; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + background-image:url('nav_h.png'); + background-repeat:repeat-x; + background-color: #F9FAFC; + margin: 0px; + border-bottom: 1px solid #C4CFE5; +} + +div.headertitle +{ + padding: 5px 5px 5px 10px; +} + +.PageDocRTL-title div.headertitle { + text-align: right; + direction: rtl; +} + +dl { + padding: 0 0 0 0; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug, dl.examples */ +dl.section { + margin-left: 0px; + padding-left: 0px; +} + +dl.section.DocNodeRTL { + margin-right: 0px; + padding-right: 0px; +} + +dl.note { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #D0C000; +} + +dl.note.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #FF0000; +} + +dl.warning.DocNodeRTL, dl.attention.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00D000; +} + +dl.pre.DocNodeRTL, dl.post.DocNodeRTL, dl.invariant.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00D000; +} + +dl.deprecated { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #505050; +} + +dl.deprecated.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #505050; +} + +dl.todo { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #00C0E0; +} + +dl.todo.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #00C0E0; +} + +dl.test { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #3030E0; +} + +dl.test.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #3030E0; +} + +dl.bug { + margin-left: -7px; + padding-left: 3px; + border-left: 4px solid; + border-color: #C08050; +} + +dl.bug.DocNodeRTL { + margin-left: 0; + padding-left: 0; + border-left: 0; + margin-right: -7px; + padding-right: 3px; + border-right: 4px solid; + border-color: #C08050; +} + +dl.section dd { + margin-bottom: 6px; +} + + +#projectrow +{ + height: 56px; +} + +#projectlogo +{ + text-align: center; + vertical-align: bottom; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectalign +{ + vertical-align: middle; + padding-left: 0.5em; +} + +#projectname +{ + font: 200% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 2px 0px; +} + +#projectbrief +{ + font: 90% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#projectnumber +{ + font: 50% Tahoma, Arial,sans-serif; + margin: 0px; + padding: 0px; +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid #5373B4; +} + +.image +{ + text-align: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.plantumlgraph +{ + text-align: center; +} + +.diagraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; +} + +div.zoom +{ + border: 1px solid #90A5CE; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#334975; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; + text-align:right; + width:52px; +} + +dl.citelist dd { + margin:2px 0 2px 72px; + padding:5px 0; +} + +div.toc { + padding: 14px 25px; + background-color: #F4F6FA; + border: 1px solid #D8DFEE; + border-radius: 7px 7px 7px 7px; + float: right; + height: auto; + margin: 0 8px 10px 10px; + width: 200px; +} + +.PageDocRTL-title div.toc { + float: left !important; + text-align: right; +} + +div.toc li { + background: url("bdwn.png") no-repeat scroll 0 5px transparent; + font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +.PageDocRTL-title div.toc li { + background-position-x: right !important; + padding-left: 0 !important; + padding-right: 10px; +} + +div.toc h3 { + font: bold 12px/1.2 Arial,FreeSans,sans-serif; + color: #4665A2; + border-bottom: 0 none; + margin: 0; +} + +div.toc ul { + list-style: none outside none; + border: medium none; + padding: 0px; +} + +div.toc li.level1 { + margin-left: 0px; +} + +div.toc li.level2 { + margin-left: 15px; +} + +div.toc li.level3 { + margin-left: 30px; +} + +div.toc li.level4 { + margin-left: 45px; +} + +span.emoji { + /* font family used at the site: https://unicode.org/emoji/charts/full-emoji-list.html + * font-family: "Noto Color Emoji", "Apple Color Emoji", "Segoe UI Emoji", Times, Symbola, Aegyptus, Code2000, Code2001, Code2002, Musica, serif, LastResort; + */ +} + +span.obfuscator { + display: none; +} + +.PageDocRTL-title div.toc li.level1 { + margin-left: 0 !important; + margin-right: 0; +} + +.PageDocRTL-title div.toc li.level2 { + margin-left: 0 !important; + margin-right: 15px; +} + +.PageDocRTL-title div.toc li.level3 { + margin-left: 0 !important; + margin-right: 30px; +} + +.PageDocRTL-title div.toc li.level4 { + margin-left: 0 !important; + margin-right: 45px; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +/* tooltip related style info */ + +.ttc { + position: absolute; + display: none; +} + +#powerTip { + cursor: default; + /*white-space: nowrap;*/ + background-color: white; + border: 1px solid gray; + border-radius: 4px 4px 4px 4px; + box-shadow: 1px 1px 7px gray; + display: none; + font-size: smaller; + max-width: 80%; + opacity: 0.9; + padding: 1ex 1em 1em; + position: absolute; + z-index: 2147483647; +} + +#powerTip div.ttdoc { + color: grey; + font-style: italic; +} + +#powerTip div.ttname a { + font-weight: bold; +} + +#powerTip div.ttname { + font-weight: bold; +} + +#powerTip div.ttdeci { + color: #006318; +} + +#powerTip div { + margin: 0px; + padding: 0px; + font: 12px/16px Roboto,sans-serif; +} + +#powerTip:before, #powerTip:after { + content: ""; + position: absolute; + margin: 0px; +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.s:after, #powerTip.s:before, +#powerTip.w:after, #powerTip.w:before, +#powerTip.e:after, #powerTip.e:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.nw:after, #powerTip.nw:before, +#powerTip.sw:after, #powerTip.sw:before { + border: solid transparent; + content: " "; + height: 0; + width: 0; + position: absolute; +} + +#powerTip.n:after, #powerTip.s:after, +#powerTip.w:after, #powerTip.e:after, +#powerTip.nw:after, #powerTip.ne:after, +#powerTip.sw:after, #powerTip.se:after { + border-color: rgba(255, 255, 255, 0); +} + +#powerTip.n:before, #powerTip.s:before, +#powerTip.w:before, #powerTip.e:before, +#powerTip.nw:before, #powerTip.ne:before, +#powerTip.sw:before, #powerTip.se:before { + border-color: rgba(128, 128, 128, 0); +} + +#powerTip.n:after, #powerTip.n:before, +#powerTip.ne:after, #powerTip.ne:before, +#powerTip.nw:after, #powerTip.nw:before { + top: 100%; +} + +#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after { + border-top-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} +#powerTip.n:before { + border-top-color: #808080; + border-width: 11px; + margin: 0px -11px; +} +#powerTip.n:after, #powerTip.n:before { + left: 50%; +} + +#powerTip.nw:after, #powerTip.nw:before { + right: 14px; +} + +#powerTip.ne:after, #powerTip.ne:before { + left: 14px; +} + +#powerTip.s:after, #powerTip.s:before, +#powerTip.se:after, #powerTip.se:before, +#powerTip.sw:after, #powerTip.sw:before { + bottom: 100%; +} + +#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after { + border-bottom-color: #FFFFFF; + border-width: 10px; + margin: 0px -10px; +} + +#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before { + border-bottom-color: #808080; + border-width: 11px; + margin: 0px -11px; +} + +#powerTip.s:after, #powerTip.s:before { + left: 50%; +} + +#powerTip.sw:after, #powerTip.sw:before { + right: 14px; +} + +#powerTip.se:after, #powerTip.se:before { + left: 14px; +} + +#powerTip.e:after, #powerTip.e:before { + left: 100%; +} +#powerTip.e:after { + border-left-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.e:before { + border-left-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +#powerTip.w:after, #powerTip.w:before { + right: 100%; +} +#powerTip.w:after { + border-right-color: #FFFFFF; + border-width: 10px; + top: 50%; + margin-top: -10px; +} +#powerTip.w:before { + border-right-color: #808080; + border-width: 11px; + top: 50%; + margin-top: -11px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} + +/* @group Markdown */ + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid #2D4068; + padding: 3px 7px 2px; +} + +table.markdownTable tr { +} + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + background-color: #374F7F; + color: #FFFFFF; + font-size: 110%; + padding-bottom: 4px; + padding-top: 5px; +} + +th.markdownTableHeadLeft, td.markdownTableBodyLeft { + text-align: left +} + +th.markdownTableHeadRight, td.markdownTableBodyRight { + text-align: right +} + +th.markdownTableHeadCenter, td.markdownTableBodyCenter { + text-align: center +} + +.DocNodeRTL { + text-align: right; + direction: rtl; +} + +.DocNodeLTR { + text-align: left; + direction: ltr; +} + +table.DocNodeRTL { + width: auto; + margin-right: 0; + margin-left: auto; +} + +table.DocNodeLTR { + width: auto; + margin-right: auto; + margin-left: 0; +} + +code.JavaDocCode { + direction:ltr; +} + +tt, code, kbd, samp +{ + display: inline-block; + direction:ltr; +} +/* @end */ + +u { + text-decoration: underline; +} + diff --git a/deps/glfw-3.3.8/docs/html/doxygen.svg b/deps/glfw-3.3.8/docs/html/doxygen.svg new file mode 100644 index 0000000..d42dad5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/doxygen.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/html/dynsections.js b/deps/glfw-3.3.8/docs/html/dynsections.js new file mode 100644 index 0000000..3174bd7 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/dynsections.js @@ -0,0 +1,121 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function toggleVisibility(linkObj) +{ + var base = $(linkObj).attr('id'); + var summary = $('#'+base+'-summary'); + var content = $('#'+base+'-content'); + var trigger = $('#'+base+'-trigger'); + var src=$(trigger).attr('src'); + if (content.is(':visible')===true) { + content.hide(); + summary.show(); + $(linkObj).addClass('closed').removeClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png'); + } else { + content.show(); + summary.hide(); + $(linkObj).removeClass('closed').addClass('opened'); + $(trigger).attr('src',src.substring(0,src.length-10)+'open.png'); + } + return false; +} + +function updateStripes() +{ + $('table.directory tr'). + removeClass('even').filter(':visible:even').addClass('even'); +} + +function toggleLevel(level) +{ + $('table.directory tr').each(function() { + var l = this.id.split('_').length-1; + var i = $('#img'+this.id.substring(3)); + var a = $('#arr'+this.id.substring(3)); + if (lli:last-child{margin:0 0 0 auto}.contents{min-height:590px}div.contents,div.header{max-width:920px;margin:0 auto;padding:0 32px;background:#fff none}table.doxtable th,table.markdownTable th,dl.reflist dt{background:linear-gradient(to bottom, #ffa733 0%, #ff6600 100%);box-shadow:inset 0 0 32px #f60;text-shadow:0 -1px 1px #b34700;text-align:left;color:#fff}dl.reflist dt a.el{color:#f60;padding:.2em;border-radius:4px;background-color:#ffe0cc}div.toc{float:none;width:auto}div.toc h3{font-size:1.17em}div.toc ul{padding-left:1.5em}div.toc li{font-size:1em;padding-left:0;list-style-type:disc}div.toc,.memproto,div.qindex,div.ah{background:linear-gradient(to bottom, #f2f2f2 0%, #e6e6e6 100%);box-shadow:inset 0 0 32px #e6e6e6;text-shadow:0 1px 1px #fff;color:#1a1a1a;border:2px solid #e6e6e6;border-radius:4px}.paramname{color:#803300}dl.reflist dt{border:2px solid #f60;border-top-left-radius:4px;border-top-right-radius:4px;border-bottom:none}dl.reflist dd{border:2px solid #f60;border-bottom-right-radius:4px;border-bottom-left-radius:4px;border-top:none}table.doxtable,table.markdownTable{border-collapse:inherit;border-spacing:0;border:2px solid #f60;border-radius:4px}a,a:hover,a:visited,a:visited:hover,.contents a:visited,.el,a.el:visited,#glfwhome:hover,#main-menu a:hover,span.lineno a:hover{color:#f60;text-decoration:none}div.directory{border-collapse:inherit;border-spacing:0;border:2px solid #f60;border-radius:4px}hr,.memSeparator{height:2px;background:linear-gradient(to right, #f2f2f2 0%, #d9d9d9 50%, #f2f2f2 100%)}dl.note,dl.pre,dl.post,dl.invariant{background:linear-gradient(to bottom, #ddfad1 0%, #cbf7ba 100%);box-shadow:inset 0 0 32px #baf5a3;color:#1e5309;border:2px solid #afe699}dl.warning,dl.attention{background:linear-gradient(to bottom, #fae8d1 0%, #f7ddba 100%);box-shadow:inset 0 0 32px #f5d1a3;color:#533309;border:2px solid #e6c499}dl.deprecated,dl.bug{background:linear-gradient(to bottom, #fad1e3 0%, #f7bad6 100%);box-shadow:inset 0 0 32px #f5a3c8;color:#53092a;border:2px solid #e699bb}dl.todo,dl.test{background:linear-gradient(to bottom, #d1ecfa 0%, #bae3f7 100%);box-shadow:inset 0 0 32px #a3daf5;color:#093a53;border:2px solid #99cce6}dl.note,dl.pre,dl.post,dl.invariant,dl.warning,dl.attention,dl.deprecated,dl.bug,dl.todo,dl.test{border-radius:4px;padding:1em;text-shadow:0 1px 1px #fff;margin:1em 0}.note a,.pre a,.post a,.invariant a,.warning a,.attention a,.deprecated a,.bug a,.todo a,.test a,.note a:visited,.pre a:visited,.post a:visited,.invariant a:visited,.warning a:visited,.attention a:visited,.deprecated a:visited,.bug a:visited,.todo a:visited,.test a:visited{color:inherit}div.line{line-height:inherit}div.fragment,pre.fragment{background:#f2f2f2;border-radius:4px;border:none;padding:1em;overflow:auto;border-left:4px solid #ccc;margin:1em 0}.lineno a,.lineno a:visited,.line,pre.fragment{color:#4d4d4d}span.preprocessor,span.comment{color:#007899}a.code,a.code:visited{color:#e64500}span.keyword,span.keywordtype,span.keywordflow{color:#404040;font-weight:bold}span.stringliteral{color:#360099}code{padding:.1em;border-radius:4px}/*# sourceMappingURL=extra.css.map */ diff --git a/deps/glfw-3.3.8/docs/html/files.html b/deps/glfw-3.3.8/docs/html/files.html new file mode 100644 index 0000000..3c035b1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/files.html @@ -0,0 +1,84 @@ + + + + + + + +GLFW: Files + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
Files
+
+
+
Here is a list of all files with brief descriptions:
+
[detail level 1234]
+ + + + + + +
 ▼ glfw-3.3.8
 docs
 ▼ include
 ▼ GLFW
 glfw3.hThe header of the GLFW 3 API
 glfw3native.hThe header of the native access functions
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/folderclosed.png b/deps/glfw-3.3.8/docs/html/folderclosed.png new file mode 100644 index 0000000..bb8ab35 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/folderclosed.png differ diff --git a/deps/glfw-3.3.8/docs/html/folderopen.png b/deps/glfw-3.3.8/docs/html/folderopen.png new file mode 100644 index 0000000..d6c7f67 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/folderopen.png differ diff --git a/deps/glfw-3.3.8/docs/html/glfw3_8h.html b/deps/glfw-3.3.8/docs/html/glfw3_8h.html new file mode 100644 index 0000000..b01a690 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3_8h.html @@ -0,0 +1,1619 @@ + + + + + + + +GLFW: glfw3.h File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Macros | +Typedefs | +Functions
+
glfw3.h File Reference
+
+
+

Description

+

This is the header file of the GLFW 3 API. It defines all its types and declares all its functions.

+

For more information about how to use this file, see Including the GLFW header file.

+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_APIENTRY_DEFINED
 
#define GLFW_TRUE   1
 One. More...
 
#define GLFW_FALSE   0
 Zero. More...
 
#define GLFW_HAT_CENTERED   0
 
#define GLFW_HAT_UP   1
 
#define GLFW_HAT_RIGHT   2
 
#define GLFW_HAT_DOWN   4
 
#define GLFW_HAT_LEFT   8
 
#define GLFW_HAT_RIGHT_UP   (GLFW_HAT_RIGHT | GLFW_HAT_UP)
 
#define GLFW_HAT_RIGHT_DOWN   (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)
 
#define GLFW_HAT_LEFT_UP   (GLFW_HAT_LEFT | GLFW_HAT_UP)
 
#define GLFW_HAT_LEFT_DOWN   (GLFW_HAT_LEFT | GLFW_HAT_DOWN)
 
#define GLFW_KEY_UNKNOWN   -1
 
#define GLFW_KEY_SPACE   32
 
#define GLFW_KEY_APOSTROPHE   39 /* ' */
 
#define GLFW_KEY_COMMA   44 /* , */
 
#define GLFW_KEY_MINUS   45 /* - */
 
#define GLFW_KEY_PERIOD   46 /* . */
 
#define GLFW_KEY_SLASH   47 /* / */
 
#define GLFW_KEY_0   48
 
#define GLFW_KEY_1   49
 
#define GLFW_KEY_2   50
 
#define GLFW_KEY_3   51
 
#define GLFW_KEY_4   52
 
#define GLFW_KEY_5   53
 
#define GLFW_KEY_6   54
 
#define GLFW_KEY_7   55
 
#define GLFW_KEY_8   56
 
#define GLFW_KEY_9   57
 
#define GLFW_KEY_SEMICOLON   59 /* ; */
 
#define GLFW_KEY_EQUAL   61 /* = */
 
#define GLFW_KEY_A   65
 
#define GLFW_KEY_B   66
 
#define GLFW_KEY_C   67
 
#define GLFW_KEY_D   68
 
#define GLFW_KEY_E   69
 
#define GLFW_KEY_F   70
 
#define GLFW_KEY_G   71
 
#define GLFW_KEY_H   72
 
#define GLFW_KEY_I   73
 
#define GLFW_KEY_J   74
 
#define GLFW_KEY_K   75
 
#define GLFW_KEY_L   76
 
#define GLFW_KEY_M   77
 
#define GLFW_KEY_N   78
 
#define GLFW_KEY_O   79
 
#define GLFW_KEY_P   80
 
#define GLFW_KEY_Q   81
 
#define GLFW_KEY_R   82
 
#define GLFW_KEY_S   83
 
#define GLFW_KEY_T   84
 
#define GLFW_KEY_U   85
 
#define GLFW_KEY_V   86
 
#define GLFW_KEY_W   87
 
#define GLFW_KEY_X   88
 
#define GLFW_KEY_Y   89
 
#define GLFW_KEY_Z   90
 
#define GLFW_KEY_LEFT_BRACKET   91 /* [ */
 
#define GLFW_KEY_BACKSLASH   92 /* \ */
 
#define GLFW_KEY_RIGHT_BRACKET   93 /* ] */
 
#define GLFW_KEY_GRAVE_ACCENT   96 /* ` */
 
#define GLFW_KEY_WORLD_1   161 /* non-US #1 */
 
#define GLFW_KEY_WORLD_2   162 /* non-US #2 */
 
#define GLFW_KEY_ESCAPE   256
 
#define GLFW_KEY_ENTER   257
 
#define GLFW_KEY_TAB   258
 
#define GLFW_KEY_BACKSPACE   259
 
#define GLFW_KEY_INSERT   260
 
#define GLFW_KEY_DELETE   261
 
#define GLFW_KEY_RIGHT   262
 
#define GLFW_KEY_LEFT   263
 
#define GLFW_KEY_DOWN   264
 
#define GLFW_KEY_UP   265
 
#define GLFW_KEY_PAGE_UP   266
 
#define GLFW_KEY_PAGE_DOWN   267
 
#define GLFW_KEY_HOME   268
 
#define GLFW_KEY_END   269
 
#define GLFW_KEY_CAPS_LOCK   280
 
#define GLFW_KEY_SCROLL_LOCK   281
 
#define GLFW_KEY_NUM_LOCK   282
 
#define GLFW_KEY_PRINT_SCREEN   283
 
#define GLFW_KEY_PAUSE   284
 
#define GLFW_KEY_F1   290
 
#define GLFW_KEY_F2   291
 
#define GLFW_KEY_F3   292
 
#define GLFW_KEY_F4   293
 
#define GLFW_KEY_F5   294
 
#define GLFW_KEY_F6   295
 
#define GLFW_KEY_F7   296
 
#define GLFW_KEY_F8   297
 
#define GLFW_KEY_F9   298
 
#define GLFW_KEY_F10   299
 
#define GLFW_KEY_F11   300
 
#define GLFW_KEY_F12   301
 
#define GLFW_KEY_F13   302
 
#define GLFW_KEY_F14   303
 
#define GLFW_KEY_F15   304
 
#define GLFW_KEY_F16   305
 
#define GLFW_KEY_F17   306
 
#define GLFW_KEY_F18   307
 
#define GLFW_KEY_F19   308
 
#define GLFW_KEY_F20   309
 
#define GLFW_KEY_F21   310
 
#define GLFW_KEY_F22   311
 
#define GLFW_KEY_F23   312
 
#define GLFW_KEY_F24   313
 
#define GLFW_KEY_F25   314
 
#define GLFW_KEY_KP_0   320
 
#define GLFW_KEY_KP_1   321
 
#define GLFW_KEY_KP_2   322
 
#define GLFW_KEY_KP_3   323
 
#define GLFW_KEY_KP_4   324
 
#define GLFW_KEY_KP_5   325
 
#define GLFW_KEY_KP_6   326
 
#define GLFW_KEY_KP_7   327
 
#define GLFW_KEY_KP_8   328
 
#define GLFW_KEY_KP_9   329
 
#define GLFW_KEY_KP_DECIMAL   330
 
#define GLFW_KEY_KP_DIVIDE   331
 
#define GLFW_KEY_KP_MULTIPLY   332
 
#define GLFW_KEY_KP_SUBTRACT   333
 
#define GLFW_KEY_KP_ADD   334
 
#define GLFW_KEY_KP_ENTER   335
 
#define GLFW_KEY_KP_EQUAL   336
 
#define GLFW_KEY_LEFT_SHIFT   340
 
#define GLFW_KEY_LEFT_CONTROL   341
 
#define GLFW_KEY_LEFT_ALT   342
 
#define GLFW_KEY_LEFT_SUPER   343
 
#define GLFW_KEY_RIGHT_SHIFT   344
 
#define GLFW_KEY_RIGHT_CONTROL   345
 
#define GLFW_KEY_RIGHT_ALT   346
 
#define GLFW_KEY_RIGHT_SUPER   347
 
#define GLFW_KEY_MENU   348
 
#define GLFW_KEY_LAST   GLFW_KEY_MENU
 
#define GLFW_MOD_SHIFT   0x0001
 If this bit is set one or more Shift keys were held down. More...
 
#define GLFW_MOD_CONTROL   0x0002
 If this bit is set one or more Control keys were held down. More...
 
#define GLFW_MOD_ALT   0x0004
 If this bit is set one or more Alt keys were held down. More...
 
#define GLFW_MOD_SUPER   0x0008
 If this bit is set one or more Super keys were held down. More...
 
#define GLFW_MOD_CAPS_LOCK   0x0010
 If this bit is set the Caps Lock key is enabled. More...
 
#define GLFW_MOD_NUM_LOCK   0x0020
 If this bit is set the Num Lock key is enabled. More...
 
#define GLFW_MOUSE_BUTTON_1   0
 
#define GLFW_MOUSE_BUTTON_2   1
 
#define GLFW_MOUSE_BUTTON_3   2
 
#define GLFW_MOUSE_BUTTON_4   3
 
#define GLFW_MOUSE_BUTTON_5   4
 
#define GLFW_MOUSE_BUTTON_6   5
 
#define GLFW_MOUSE_BUTTON_7   6
 
#define GLFW_MOUSE_BUTTON_8   7
 
#define GLFW_MOUSE_BUTTON_LAST   GLFW_MOUSE_BUTTON_8
 
#define GLFW_MOUSE_BUTTON_LEFT   GLFW_MOUSE_BUTTON_1
 
#define GLFW_MOUSE_BUTTON_RIGHT   GLFW_MOUSE_BUTTON_2
 
#define GLFW_MOUSE_BUTTON_MIDDLE   GLFW_MOUSE_BUTTON_3
 
#define GLFW_JOYSTICK_1   0
 
#define GLFW_JOYSTICK_2   1
 
#define GLFW_JOYSTICK_3   2
 
#define GLFW_JOYSTICK_4   3
 
#define GLFW_JOYSTICK_5   4
 
#define GLFW_JOYSTICK_6   5
 
#define GLFW_JOYSTICK_7   6
 
#define GLFW_JOYSTICK_8   7
 
#define GLFW_JOYSTICK_9   8
 
#define GLFW_JOYSTICK_10   9
 
#define GLFW_JOYSTICK_11   10
 
#define GLFW_JOYSTICK_12   11
 
#define GLFW_JOYSTICK_13   12
 
#define GLFW_JOYSTICK_14   13
 
#define GLFW_JOYSTICK_15   14
 
#define GLFW_JOYSTICK_16   15
 
#define GLFW_JOYSTICK_LAST   GLFW_JOYSTICK_16
 
#define GLFW_GAMEPAD_BUTTON_A   0
 
#define GLFW_GAMEPAD_BUTTON_B   1
 
#define GLFW_GAMEPAD_BUTTON_X   2
 
#define GLFW_GAMEPAD_BUTTON_Y   3
 
#define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER   4
 
#define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER   5
 
#define GLFW_GAMEPAD_BUTTON_BACK   6
 
#define GLFW_GAMEPAD_BUTTON_START   7
 
#define GLFW_GAMEPAD_BUTTON_GUIDE   8
 
#define GLFW_GAMEPAD_BUTTON_LEFT_THUMB   9
 
#define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB   10
 
#define GLFW_GAMEPAD_BUTTON_DPAD_UP   11
 
#define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT   12
 
#define GLFW_GAMEPAD_BUTTON_DPAD_DOWN   13
 
#define GLFW_GAMEPAD_BUTTON_DPAD_LEFT   14
 
#define GLFW_GAMEPAD_BUTTON_LAST   GLFW_GAMEPAD_BUTTON_DPAD_LEFT
 
#define GLFW_GAMEPAD_BUTTON_CROSS   GLFW_GAMEPAD_BUTTON_A
 
#define GLFW_GAMEPAD_BUTTON_CIRCLE   GLFW_GAMEPAD_BUTTON_B
 
#define GLFW_GAMEPAD_BUTTON_SQUARE   GLFW_GAMEPAD_BUTTON_X
 
#define GLFW_GAMEPAD_BUTTON_TRIANGLE   GLFW_GAMEPAD_BUTTON_Y
 
#define GLFW_GAMEPAD_AXIS_LEFT_X   0
 
#define GLFW_GAMEPAD_AXIS_LEFT_Y   1
 
#define GLFW_GAMEPAD_AXIS_RIGHT_X   2
 
#define GLFW_GAMEPAD_AXIS_RIGHT_Y   3
 
#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER   4
 
#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER   5
 
#define GLFW_GAMEPAD_AXIS_LAST   GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
 
#define GLFW_NO_ERROR   0
 No error has occurred. More...
 
#define GLFW_NOT_INITIALIZED   0x00010001
 GLFW has not been initialized. More...
 
#define GLFW_NO_CURRENT_CONTEXT   0x00010002
 No context is current for this thread. More...
 
#define GLFW_INVALID_ENUM   0x00010003
 One of the arguments to the function was an invalid enum value. More...
 
#define GLFW_INVALID_VALUE   0x00010004
 One of the arguments to the function was an invalid value. More...
 
#define GLFW_OUT_OF_MEMORY   0x00010005
 A memory allocation failed. More...
 
#define GLFW_API_UNAVAILABLE   0x00010006
 GLFW could not find support for the requested API on the system. More...
 
#define GLFW_VERSION_UNAVAILABLE   0x00010007
 The requested OpenGL or OpenGL ES version is not available. More...
 
#define GLFW_PLATFORM_ERROR   0x00010008
 A platform-specific error occurred that does not match any of the more specific categories. More...
 
#define GLFW_FORMAT_UNAVAILABLE   0x00010009
 The requested format is not supported or available. More...
 
#define GLFW_NO_WINDOW_CONTEXT   0x0001000A
 The specified window does not have an OpenGL or OpenGL ES context. More...
 
#define GLFW_FOCUSED   0x00020001
 Input focus window hint and attribute. More...
 
#define GLFW_ICONIFIED   0x00020002
 Window iconification window attribute. More...
 
#define GLFW_RESIZABLE   0x00020003
 Window resize-ability window hint and attribute. More...
 
#define GLFW_VISIBLE   0x00020004
 Window visibility window hint and attribute. More...
 
#define GLFW_DECORATED   0x00020005
 Window decoration window hint and attribute. More...
 
#define GLFW_AUTO_ICONIFY   0x00020006
 Window auto-iconification window hint and attribute. More...
 
#define GLFW_FLOATING   0x00020007
 Window decoration window hint and attribute. More...
 
#define GLFW_MAXIMIZED   0x00020008
 Window maximization window hint and attribute. More...
 
#define GLFW_CENTER_CURSOR   0x00020009
 Cursor centering window hint. More...
 
#define GLFW_TRANSPARENT_FRAMEBUFFER   0x0002000A
 Window framebuffer transparency hint and attribute. More...
 
#define GLFW_HOVERED   0x0002000B
 Mouse cursor hover window attribute. More...
 
#define GLFW_FOCUS_ON_SHOW   0x0002000C
 Input focus on calling show window hint and attribute. More...
 
#define GLFW_RED_BITS   0x00021001
 Framebuffer bit depth hint. More...
 
#define GLFW_GREEN_BITS   0x00021002
 Framebuffer bit depth hint. More...
 
#define GLFW_BLUE_BITS   0x00021003
 Framebuffer bit depth hint. More...
 
#define GLFW_ALPHA_BITS   0x00021004
 Framebuffer bit depth hint. More...
 
#define GLFW_DEPTH_BITS   0x00021005
 Framebuffer bit depth hint. More...
 
#define GLFW_STENCIL_BITS   0x00021006
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_RED_BITS   0x00021007
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_GREEN_BITS   0x00021008
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_BLUE_BITS   0x00021009
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_ALPHA_BITS   0x0002100A
 Framebuffer bit depth hint. More...
 
#define GLFW_AUX_BUFFERS   0x0002100B
 Framebuffer auxiliary buffer hint. More...
 
#define GLFW_STEREO   0x0002100C
 OpenGL stereoscopic rendering hint. More...
 
#define GLFW_SAMPLES   0x0002100D
 Framebuffer MSAA samples hint. More...
 
#define GLFW_SRGB_CAPABLE   0x0002100E
 Framebuffer sRGB hint. More...
 
#define GLFW_REFRESH_RATE   0x0002100F
 Monitor refresh rate hint. More...
 
#define GLFW_DOUBLEBUFFER   0x00021010
 Framebuffer double buffering hint. More...
 
#define GLFW_CLIENT_API   0x00022001
 Context client API hint and attribute. More...
 
#define GLFW_CONTEXT_VERSION_MAJOR   0x00022002
 Context client API major version hint and attribute. More...
 
#define GLFW_CONTEXT_VERSION_MINOR   0x00022003
 Context client API minor version hint and attribute. More...
 
#define GLFW_CONTEXT_REVISION   0x00022004
 Context client API revision number attribute. More...
 
#define GLFW_CONTEXT_ROBUSTNESS   0x00022005
 Context robustness hint and attribute. More...
 
#define GLFW_OPENGL_FORWARD_COMPAT   0x00022006
 OpenGL forward-compatibility hint and attribute. More...
 
#define GLFW_OPENGL_DEBUG_CONTEXT   0x00022007
 Debug mode context hint and attribute. More...
 
#define GLFW_OPENGL_PROFILE   0x00022008
 OpenGL profile hint and attribute. More...
 
#define GLFW_CONTEXT_RELEASE_BEHAVIOR   0x00022009
 Context flush-on-release hint and attribute. More...
 
#define GLFW_CONTEXT_NO_ERROR   0x0002200A
 Context error suppression hint and attribute. More...
 
#define GLFW_CONTEXT_CREATION_API   0x0002200B
 Context creation API hint and attribute. More...
 
#define GLFW_SCALE_TO_MONITOR   0x0002200C
 Window content area scaling window window hint. More...
 
#define GLFW_COCOA_RETINA_FRAMEBUFFER   0x00023001
 macOS specific window hint. More...
 
#define GLFW_COCOA_FRAME_NAME   0x00023002
 macOS specific window hint. More...
 
#define GLFW_COCOA_GRAPHICS_SWITCHING   0x00023003
 macOS specific window hint. More...
 
#define GLFW_X11_CLASS_NAME   0x00024001
 X11 specific window hint. More...
 
#define GLFW_X11_INSTANCE_NAME   0x00024002
 X11 specific window hint. More...
 
#define GLFW_NO_API   0
 
#define GLFW_OPENGL_API   0x00030001
 
#define GLFW_OPENGL_ES_API   0x00030002
 
#define GLFW_NO_ROBUSTNESS   0
 
#define GLFW_NO_RESET_NOTIFICATION   0x00031001
 
#define GLFW_LOSE_CONTEXT_ON_RESET   0x00031002
 
#define GLFW_OPENGL_ANY_PROFILE   0
 
#define GLFW_OPENGL_CORE_PROFILE   0x00032001
 
#define GLFW_OPENGL_COMPAT_PROFILE   0x00032002
 
#define GLFW_CURSOR   0x00033001
 
#define GLFW_STICKY_KEYS   0x00033002
 
#define GLFW_STICKY_MOUSE_BUTTONS   0x00033003
 
#define GLFW_LOCK_KEY_MODS   0x00033004
 
#define GLFW_RAW_MOUSE_MOTION   0x00033005
 
#define GLFW_CURSOR_NORMAL   0x00034001
 
#define GLFW_CURSOR_HIDDEN   0x00034002
 
#define GLFW_CURSOR_DISABLED   0x00034003
 
#define GLFW_ANY_RELEASE_BEHAVIOR   0
 
#define GLFW_RELEASE_BEHAVIOR_FLUSH   0x00035001
 
#define GLFW_RELEASE_BEHAVIOR_NONE   0x00035002
 
#define GLFW_NATIVE_CONTEXT_API   0x00036001
 
#define GLFW_EGL_CONTEXT_API   0x00036002
 
#define GLFW_OSMESA_CONTEXT_API   0x00036003
 
#define GLFW_ARROW_CURSOR   0x00036001
 The regular arrow cursor shape. More...
 
#define GLFW_IBEAM_CURSOR   0x00036002
 The text input I-beam cursor shape. More...
 
#define GLFW_CROSSHAIR_CURSOR   0x00036003
 The crosshair shape. More...
 
#define GLFW_HAND_CURSOR   0x00036004
 The hand shape. More...
 
#define GLFW_HRESIZE_CURSOR   0x00036005
 The horizontal resize arrow shape. More...
 
#define GLFW_VRESIZE_CURSOR   0x00036006
 The vertical resize arrow shape. More...
 
#define GLFW_CONNECTED   0x00040001
 
#define GLFW_DISCONNECTED   0x00040002
 
#define GLFW_JOYSTICK_HAT_BUTTONS   0x00050001
 Joystick hat buttons init hint. More...
 
#define GLFW_COCOA_CHDIR_RESOURCES   0x00051001
 macOS specific init hint. More...
 
#define GLFW_COCOA_MENUBAR   0x00051002
 macOS specific init hint. More...
 
#define GLFW_DONT_CARE   -1
 
#define GLAPIENTRY   APIENTRY
 
#define GLFW_GLAPIENTRY_DEFINED
 
GLFW version macros
#define GLFW_VERSION_MAJOR   3
 The major version number of the GLFW header. More...
 
#define GLFW_VERSION_MINOR   3
 The minor version number of the GLFW header. More...
 
#define GLFW_VERSION_REVISION   8
 The revision number of the GLFW header. More...
 
Key and button actions
#define GLFW_RELEASE   0
 The key or mouse button was released. More...
 
#define GLFW_PRESS   1
 The key or mouse button was pressed. More...
 
#define GLFW_REPEAT   2
 The key was held down until it repeated. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Typedefs

typedef void(* GLFWglproc) (void)
 Client API function pointer type. More...
 
typedef void(* GLFWvkproc) (void)
 Vulkan API function pointer type. More...
 
typedef struct GLFWmonitor GLFWmonitor
 Opaque monitor object. More...
 
typedef struct GLFWwindow GLFWwindow
 Opaque window object. More...
 
typedef struct GLFWcursor GLFWcursor
 Opaque cursor object. More...
 
typedef void(* GLFWerrorfun) (int error_code, const char *description)
 The function pointer type for error callbacks. More...
 
typedef void(* GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos)
 The function pointer type for window position callbacks. More...
 
typedef void(* GLFWwindowsizefun) (GLFWwindow *window, int width, int height)
 The function pointer type for window size callbacks. More...
 
typedef void(* GLFWwindowclosefun) (GLFWwindow *window)
 The function pointer type for window close callbacks. More...
 
typedef void(* GLFWwindowrefreshfun) (GLFWwindow *window)
 The function pointer type for window content refresh callbacks. More...
 
typedef void(* GLFWwindowfocusfun) (GLFWwindow *window, int focused)
 The function pointer type for window focus callbacks. More...
 
typedef void(* GLFWwindowiconifyfun) (GLFWwindow *window, int iconified)
 The function pointer type for window iconify callbacks. More...
 
typedef void(* GLFWwindowmaximizefun) (GLFWwindow *window, int maximized)
 The function pointer type for window maximize callbacks. More...
 
typedef void(* GLFWframebuffersizefun) (GLFWwindow *window, int width, int height)
 The function pointer type for framebuffer size callbacks. More...
 
typedef void(* GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale)
 The function pointer type for window content scale callbacks. More...
 
typedef void(* GLFWmousebuttonfun) (GLFWwindow *window, int button, int action, int mods)
 The function pointer type for mouse button callbacks. More...
 
typedef void(* GLFWcursorposfun) (GLFWwindow *window, double xpos, double ypos)
 The function pointer type for cursor position callbacks. More...
 
typedef void(* GLFWcursorenterfun) (GLFWwindow *window, int entered)
 The function pointer type for cursor enter/leave callbacks. More...
 
typedef void(* GLFWscrollfun) (GLFWwindow *window, double xoffset, double yoffset)
 The function pointer type for scroll callbacks. More...
 
typedef void(* GLFWkeyfun) (GLFWwindow *window, int key, int scancode, int action, int mods)
 The function pointer type for keyboard key callbacks. More...
 
typedef void(* GLFWcharfun) (GLFWwindow *window, unsigned int codepoint)
 The function pointer type for Unicode character callbacks. More...
 
typedef void(* GLFWcharmodsfun) (GLFWwindow *window, unsigned int codepoint, int mods)
 The function pointer type for Unicode character with modifiers callbacks. More...
 
typedef void(* GLFWdropfun) (GLFWwindow *window, int path_count, const char *paths[])
 The function pointer type for path drop callbacks. More...
 
typedef void(* GLFWmonitorfun) (GLFWmonitor *monitor, int event)
 The function pointer type for monitor configuration callbacks. More...
 
typedef void(* GLFWjoystickfun) (int jid, int event)
 The function pointer type for joystick configuration callbacks. More...
 
typedef struct GLFWvidmode GLFWvidmode
 Video mode type. More...
 
typedef struct GLFWgammaramp GLFWgammaramp
 Gamma ramp. More...
 
typedef struct GLFWimage GLFWimage
 Image data. More...
 
typedef struct GLFWgamepadstate GLFWgamepadstate
 Gamepad input state. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

int glfwInit (void)
 Initializes the GLFW library. More...
 
void glfwTerminate (void)
 Terminates the GLFW library. More...
 
void glfwInitHint (int hint, int value)
 Sets the specified init hint to the desired value. More...
 
void glfwGetVersion (int *major, int *minor, int *rev)
 Retrieves the version of the GLFW library. More...
 
const char * glfwGetVersionString (void)
 Returns a string describing the compile-time configuration. More...
 
int glfwGetError (const char **description)
 Returns and clears the last error for the calling thread. More...
 
GLFWerrorfun glfwSetErrorCallback (GLFWerrorfun callback)
 Sets the error callback. More...
 
GLFWmonitor ** glfwGetMonitors (int *count)
 Returns the currently connected monitors. More...
 
GLFWmonitor * glfwGetPrimaryMonitor (void)
 Returns the primary monitor. More...
 
void glfwGetMonitorPos (GLFWmonitor *monitor, int *xpos, int *ypos)
 Returns the position of the monitor's viewport on the virtual screen. More...
 
void glfwGetMonitorWorkarea (GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height)
 Retrieves the work area of the monitor. More...
 
void glfwGetMonitorPhysicalSize (GLFWmonitor *monitor, int *widthMM, int *heightMM)
 Returns the physical size of the monitor. More...
 
void glfwGetMonitorContentScale (GLFWmonitor *monitor, float *xscale, float *yscale)
 Retrieves the content scale for the specified monitor. More...
 
const char * glfwGetMonitorName (GLFWmonitor *monitor)
 Returns the name of the specified monitor. More...
 
void glfwSetMonitorUserPointer (GLFWmonitor *monitor, void *pointer)
 Sets the user pointer of the specified monitor. More...
 
void * glfwGetMonitorUserPointer (GLFWmonitor *monitor)
 Returns the user pointer of the specified monitor. More...
 
GLFWmonitorfun glfwSetMonitorCallback (GLFWmonitorfun callback)
 Sets the monitor configuration callback. More...
 
const GLFWvidmode * glfwGetVideoModes (GLFWmonitor *monitor, int *count)
 Returns the available video modes for the specified monitor. More...
 
const GLFWvidmode * glfwGetVideoMode (GLFWmonitor *monitor)
 Returns the current mode of the specified monitor. More...
 
void glfwSetGamma (GLFWmonitor *monitor, float gamma)
 Generates a gamma ramp and sets it for the specified monitor. More...
 
const GLFWgammaramp * glfwGetGammaRamp (GLFWmonitor *monitor)
 Returns the current gamma ramp for the specified monitor. More...
 
void glfwSetGammaRamp (GLFWmonitor *monitor, const GLFWgammaramp *ramp)
 Sets the current gamma ramp for the specified monitor. More...
 
void glfwDefaultWindowHints (void)
 Resets all window hints to their default values. More...
 
void glfwWindowHint (int hint, int value)
 Sets the specified window hint to the desired value. More...
 
void glfwWindowHintString (int hint, const char *value)
 Sets the specified window hint to the desired value. More...
 
GLFWwindow * glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
 Creates a window and its associated context. More...
 
void glfwDestroyWindow (GLFWwindow *window)
 Destroys the specified window and its context. More...
 
int glfwWindowShouldClose (GLFWwindow *window)
 Checks the close flag of the specified window. More...
 
void glfwSetWindowShouldClose (GLFWwindow *window, int value)
 Sets the close flag of the specified window. More...
 
void glfwSetWindowTitle (GLFWwindow *window, const char *title)
 Sets the title of the specified window. More...
 
void glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images)
 Sets the icon for the specified window. More...
 
void glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos)
 Retrieves the position of the content area of the specified window. More...
 
void glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos)
 Sets the position of the content area of the specified window. More...
 
void glfwGetWindowSize (GLFWwindow *window, int *width, int *height)
 Retrieves the size of the content area of the specified window. More...
 
void glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
 Sets the size limits of the specified window. More...
 
void glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom)
 Sets the aspect ratio of the specified window. More...
 
void glfwSetWindowSize (GLFWwindow *window, int width, int height)
 Sets the size of the content area of the specified window. More...
 
void glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height)
 Retrieves the size of the framebuffer of the specified window. More...
 
void glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom)
 Retrieves the size of the frame of the window. More...
 
void glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale)
 Retrieves the content scale for the specified window. More...
 
float glfwGetWindowOpacity (GLFWwindow *window)
 Returns the opacity of the whole window. More...
 
void glfwSetWindowOpacity (GLFWwindow *window, float opacity)
 Sets the opacity of the whole window. More...
 
void glfwIconifyWindow (GLFWwindow *window)
 Iconifies the specified window. More...
 
void glfwRestoreWindow (GLFWwindow *window)
 Restores the specified window. More...
 
void glfwMaximizeWindow (GLFWwindow *window)
 Maximizes the specified window. More...
 
void glfwShowWindow (GLFWwindow *window)
 Makes the specified window visible. More...
 
void glfwHideWindow (GLFWwindow *window)
 Hides the specified window. More...
 
void glfwFocusWindow (GLFWwindow *window)
 Brings the specified window to front and sets input focus. More...
 
void glfwRequestWindowAttention (GLFWwindow *window)
 Requests user attention to the specified window. More...
 
GLFWmonitor * glfwGetWindowMonitor (GLFWwindow *window)
 Returns the monitor that the window uses for full screen mode. More...
 
void glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate)
 Sets the mode, monitor, video mode and placement of a window. More...
 
int glfwGetWindowAttrib (GLFWwindow *window, int attrib)
 Returns an attribute of the specified window. More...
 
void glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value)
 Sets an attribute of the specified window. More...
 
void glfwSetWindowUserPointer (GLFWwindow *window, void *pointer)
 Sets the user pointer of the specified window. More...
 
void * glfwGetWindowUserPointer (GLFWwindow *window)
 Returns the user pointer of the specified window. More...
 
GLFWwindowposfun glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun callback)
 Sets the position callback for the specified window. More...
 
GLFWwindowsizefun glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun callback)
 Sets the size callback for the specified window. More...
 
GLFWwindowclosefun glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun callback)
 Sets the close callback for the specified window. More...
 
GLFWwindowrefreshfun glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun callback)
 Sets the refresh callback for the specified window. More...
 
GLFWwindowfocusfun glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun callback)
 Sets the focus callback for the specified window. More...
 
GLFWwindowiconifyfun glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun callback)
 Sets the iconify callback for the specified window. More...
 
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun callback)
 Sets the maximize callback for the specified window. More...
 
GLFWframebuffersizefun glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun callback)
 Sets the framebuffer resize callback for the specified window. More...
 
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun callback)
 Sets the window content scale callback for the specified window. More...
 
void glfwPollEvents (void)
 Processes all pending events. More...
 
void glfwWaitEvents (void)
 Waits until events are queued and processes them. More...
 
void glfwWaitEventsTimeout (double timeout)
 Waits with timeout until events are queued and processes them. More...
 
void glfwPostEmptyEvent (void)
 Posts an empty event to the event queue. More...
 
int glfwGetInputMode (GLFWwindow *window, int mode)
 Returns the value of an input option for the specified window. More...
 
void glfwSetInputMode (GLFWwindow *window, int mode, int value)
 Sets an input option for the specified window. More...
 
int glfwRawMouseMotionSupported (void)
 Returns whether raw mouse motion is supported. More...
 
const char * glfwGetKeyName (int key, int scancode)
 Returns the layout-specific name of the specified printable key. More...
 
int glfwGetKeyScancode (int key)
 Returns the platform-specific scancode of the specified key. More...
 
int glfwGetKey (GLFWwindow *window, int key)
 Returns the last reported state of a keyboard key for the specified window. More...
 
int glfwGetMouseButton (GLFWwindow *window, int button)
 Returns the last reported state of a mouse button for the specified window. More...
 
void glfwGetCursorPos (GLFWwindow *window, double *xpos, double *ypos)
 Retrieves the position of the cursor relative to the content area of the window. More...
 
void glfwSetCursorPos (GLFWwindow *window, double xpos, double ypos)
 Sets the position of the cursor, relative to the content area of the window. More...
 
GLFWcursor * glfwCreateCursor (const GLFWimage *image, int xhot, int yhot)
 Creates a custom cursor. More...
 
GLFWcursor * glfwCreateStandardCursor (int shape)
 Creates a cursor with a standard shape. More...
 
void glfwDestroyCursor (GLFWcursor *cursor)
 Destroys a cursor. More...
 
void glfwSetCursor (GLFWwindow *window, GLFWcursor *cursor)
 Sets the cursor for the window. More...
 
GLFWkeyfun glfwSetKeyCallback (GLFWwindow *window, GLFWkeyfun callback)
 Sets the key callback. More...
 
GLFWcharfun glfwSetCharCallback (GLFWwindow *window, GLFWcharfun callback)
 Sets the Unicode character callback. More...
 
GLFWcharmodsfun glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun callback)
 Sets the Unicode character with modifiers callback. More...
 
GLFWmousebuttonfun glfwSetMouseButtonCallback (GLFWwindow *window, GLFWmousebuttonfun callback)
 Sets the mouse button callback. More...
 
GLFWcursorposfun glfwSetCursorPosCallback (GLFWwindow *window, GLFWcursorposfun callback)
 Sets the cursor position callback. More...
 
GLFWcursorenterfun glfwSetCursorEnterCallback (GLFWwindow *window, GLFWcursorenterfun callback)
 Sets the cursor enter/leave callback. More...
 
GLFWscrollfun glfwSetScrollCallback (GLFWwindow *window, GLFWscrollfun callback)
 Sets the scroll callback. More...
 
GLFWdropfun glfwSetDropCallback (GLFWwindow *window, GLFWdropfun callback)
 Sets the path drop callback. More...
 
int glfwJoystickPresent (int jid)
 Returns whether the specified joystick is present. More...
 
const float * glfwGetJoystickAxes (int jid, int *count)
 Returns the values of all axes of the specified joystick. More...
 
const unsigned char * glfwGetJoystickButtons (int jid, int *count)
 Returns the state of all buttons of the specified joystick. More...
 
const unsigned char * glfwGetJoystickHats (int jid, int *count)
 Returns the state of all hats of the specified joystick. More...
 
const char * glfwGetJoystickName (int jid)
 Returns the name of the specified joystick. More...
 
const char * glfwGetJoystickGUID (int jid)
 Returns the SDL compatible GUID of the specified joystick. More...
 
void glfwSetJoystickUserPointer (int jid, void *pointer)
 Sets the user pointer of the specified joystick. More...
 
void * glfwGetJoystickUserPointer (int jid)
 Returns the user pointer of the specified joystick. More...
 
int glfwJoystickIsGamepad (int jid)
 Returns whether the specified joystick has a gamepad mapping. More...
 
GLFWjoystickfun glfwSetJoystickCallback (GLFWjoystickfun callback)
 Sets the joystick configuration callback. More...
 
int glfwUpdateGamepadMappings (const char *string)
 Adds the specified SDL_GameControllerDB gamepad mappings. More...
 
const char * glfwGetGamepadName (int jid)
 Returns the human-readable gamepad name for the specified joystick. More...
 
int glfwGetGamepadState (int jid, GLFWgamepadstate *state)
 Retrieves the state of the specified joystick remapped as a gamepad. More...
 
void glfwSetClipboardString (GLFWwindow *window, const char *string)
 Sets the clipboard to the specified string. More...
 
const char * glfwGetClipboardString (GLFWwindow *window)
 Returns the contents of the clipboard as a string. More...
 
double glfwGetTime (void)
 Returns the GLFW time. More...
 
void glfwSetTime (double time)
 Sets the GLFW time. More...
 
uint64_t glfwGetTimerValue (void)
 Returns the current value of the raw timer. More...
 
uint64_t glfwGetTimerFrequency (void)
 Returns the frequency, in Hz, of the raw timer. More...
 
void glfwMakeContextCurrent (GLFWwindow *window)
 Makes the context of the specified window current for the calling thread. More...
 
GLFWwindow * glfwGetCurrentContext (void)
 Returns the window whose context is current on the calling thread. More...
 
void glfwSwapBuffers (GLFWwindow *window)
 Swaps the front and back buffers of the specified window. More...
 
void glfwSwapInterval (int interval)
 Sets the swap interval for the current context. More...
 
int glfwExtensionSupported (const char *extension)
 Returns whether the specified extension is available. More...
 
GLFWglproc glfwGetProcAddress (const char *procname)
 Returns the address of the specified function for the current context. More...
 
int glfwVulkanSupported (void)
 Returns whether the Vulkan loader and an ICD have been found. More...
 
const char ** glfwGetRequiredInstanceExtensions (uint32_t *count)
 Returns the Vulkan instance extensions required by GLFW. More...
 
GLFWvkproc glfwGetInstanceProcAddress (VkInstance instance, const char *procname)
 Returns the address of the specified Vulkan instance function. More...
 
int glfwGetPhysicalDevicePresentationSupport (VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
 Returns whether the specified queue family can present images. More...
 
VkResult glfwCreateWindowSurface (VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
 Creates a Vulkan surface for the specified window. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_APIENTRY_DEFINED

+ +
+
+ + + + +
#define GLFW_APIENTRY_DEFINED
+
+ +
+
+ +

◆ GLFW_NO_API

+ +
+
+ + + + +
#define GLFW_NO_API   0
+
+ +
+
+ +

◆ GLFW_OPENGL_API

+ +
+
+ + + + +
#define GLFW_OPENGL_API   0x00030001
+
+ +
+
+ +

◆ GLFW_OPENGL_ES_API

+ +
+
+ + + + +
#define GLFW_OPENGL_ES_API   0x00030002
+
+ +
+
+ +

◆ GLFW_NO_ROBUSTNESS

+ +
+
+ + + + +
#define GLFW_NO_ROBUSTNESS   0
+
+ +
+
+ +

◆ GLFW_NO_RESET_NOTIFICATION

+ +
+
+ + + + +
#define GLFW_NO_RESET_NOTIFICATION   0x00031001
+
+ +
+
+ +

◆ GLFW_LOSE_CONTEXT_ON_RESET

+ +
+
+ + + + +
#define GLFW_LOSE_CONTEXT_ON_RESET   0x00031002
+
+ +
+
+ +

◆ GLFW_OPENGL_ANY_PROFILE

+ +
+
+ + + + +
#define GLFW_OPENGL_ANY_PROFILE   0
+
+ +
+
+ +

◆ GLFW_OPENGL_CORE_PROFILE

+ +
+
+ + + + +
#define GLFW_OPENGL_CORE_PROFILE   0x00032001
+
+ +
+
+ +

◆ GLFW_OPENGL_COMPAT_PROFILE

+ +
+
+ + + + +
#define GLFW_OPENGL_COMPAT_PROFILE   0x00032002
+
+ +
+
+ +

◆ GLFW_CURSOR

+ +
+
+ + + + +
#define GLFW_CURSOR   0x00033001
+
+ +
+
+ +

◆ GLFW_STICKY_KEYS

+ +
+
+ + + + +
#define GLFW_STICKY_KEYS   0x00033002
+
+ +
+
+ +

◆ GLFW_STICKY_MOUSE_BUTTONS

+ +
+
+ + + + +
#define GLFW_STICKY_MOUSE_BUTTONS   0x00033003
+
+ +
+
+ +

◆ GLFW_LOCK_KEY_MODS

+ +
+
+ + + + +
#define GLFW_LOCK_KEY_MODS   0x00033004
+
+ +
+
+ +

◆ GLFW_RAW_MOUSE_MOTION

+ +
+
+ + + + +
#define GLFW_RAW_MOUSE_MOTION   0x00033005
+
+ +
+
+ +

◆ GLFW_CURSOR_NORMAL

+ +
+
+ + + + +
#define GLFW_CURSOR_NORMAL   0x00034001
+
+ +
+
+ +

◆ GLFW_CURSOR_HIDDEN

+ +
+
+ + + + +
#define GLFW_CURSOR_HIDDEN   0x00034002
+
+ +
+
+ +

◆ GLFW_CURSOR_DISABLED

+ +
+
+ + + + +
#define GLFW_CURSOR_DISABLED   0x00034003
+
+ +
+
+ +

◆ GLFW_ANY_RELEASE_BEHAVIOR

+ +
+
+ + + + +
#define GLFW_ANY_RELEASE_BEHAVIOR   0
+
+ +
+
+ +

◆ GLFW_RELEASE_BEHAVIOR_FLUSH

+ +
+
+ + + + +
#define GLFW_RELEASE_BEHAVIOR_FLUSH   0x00035001
+
+ +
+
+ +

◆ GLFW_RELEASE_BEHAVIOR_NONE

+ +
+
+ + + + +
#define GLFW_RELEASE_BEHAVIOR_NONE   0x00035002
+
+ +
+
+ +

◆ GLFW_NATIVE_CONTEXT_API

+ +
+
+ + + + +
#define GLFW_NATIVE_CONTEXT_API   0x00036001
+
+ +
+
+ +

◆ GLFW_EGL_CONTEXT_API

+ +
+
+ + + + +
#define GLFW_EGL_CONTEXT_API   0x00036002
+
+ +
+
+ +

◆ GLFW_OSMESA_CONTEXT_API

+ +
+
+ + + + +
#define GLFW_OSMESA_CONTEXT_API   0x00036003
+
+ +
+
+ +

◆ GLFW_CONNECTED

+ +
+
+ + + + +
#define GLFW_CONNECTED   0x00040001
+
+ +
+
+ +

◆ GLFW_DISCONNECTED

+ +
+
+ + + + +
#define GLFW_DISCONNECTED   0x00040002
+
+ +
+
+ +

◆ GLFW_DONT_CARE

+ +
+
+ + + + +
#define GLFW_DONT_CARE   -1
+
+ +
+
+ +

◆ GLAPIENTRY

+ +
+
+ + + + +
#define GLAPIENTRY   APIENTRY
+
+ +
+
+ +

◆ GLFW_GLAPIENTRY_DEFINED

+ +
+
+ + + + +
#define GLFW_GLAPIENTRY_DEFINED
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html b/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html new file mode 100644 index 0000000..be04039 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3_8h_source.html @@ -0,0 +1,1155 @@ + + + + + + + +GLFW: glfw3.h Source File + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
glfw3.h
+
+
+Go to the documentation of this file.
1/*************************************************************************
+
2 * GLFW 3.3 - www.glfw.org
+
3 * A library for OpenGL, window and input
+
4 *------------------------------------------------------------------------
+
5 * Copyright (c) 2002-2006 Marcus Geelnard
+
6 * Copyright (c) 2006-2019 Camilla Löwy <elmindreda@glfw.org>
+
7 *
+
8 * This software is provided 'as-is', without any express or implied
+
9 * warranty. In no event will the authors be held liable for any damages
+
10 * arising from the use of this software.
+
11 *
+
12 * Permission is granted to anyone to use this software for any purpose,
+
13 * including commercial applications, and to alter it and redistribute it
+
14 * freely, subject to the following restrictions:
+
15 *
+
16 * 1. The origin of this software must not be misrepresented; you must not
+
17 * claim that you wrote the original software. If you use this software
+
18 * in a product, an acknowledgment in the product documentation would
+
19 * be appreciated but is not required.
+
20 *
+
21 * 2. Altered source versions must be plainly marked as such, and must not
+
22 * be misrepresented as being the original software.
+
23 *
+
24 * 3. This notice may not be removed or altered from any source
+
25 * distribution.
+
26 *
+
27 *************************************************************************/
+
28
+
29#ifndef _glfw3_h_
+
30#define _glfw3_h_
+
31
+
32#ifdef __cplusplus
+
33extern "C" {
+
34#endif
+
35
+
36
+
37/*************************************************************************
+
38 * Doxygen documentation
+
39 *************************************************************************/
+
40
+
89/*************************************************************************
+
90 * Compiler- and platform-specific preprocessor work
+
91 *************************************************************************/
+
92
+
93/* If we are we on Windows, we want a single define for it.
+
94 */
+
95#if !defined(_WIN32) && (defined(__WIN32__) || defined(WIN32) || defined(__MINGW32__))
+
96 #define _WIN32
+
97#endif /* _WIN32 */
+
98
+
99/* Include because most Windows GLU headers need wchar_t and
+
100 * the macOS OpenGL header blocks the definition of ptrdiff_t by glext.h.
+
101 * Include it unconditionally to avoid surprising side-effects.
+
102 */
+
103#include <stddef.h>
+
104
+
105/* Include because it is needed by Vulkan and related functions.
+
106 * Include it unconditionally to avoid surprising side-effects.
+
107 */
+
108#include <stdint.h>
+
109
+
110#if defined(GLFW_INCLUDE_VULKAN)
+
111 #include <vulkan/vulkan.h>
+
112#endif /* Vulkan header */
+
113
+
114/* The Vulkan header may have indirectly included windows.h (because of
+
115 * VK_USE_PLATFORM_WIN32_KHR) so we offer our replacement symbols after it.
+
116 */
+
117
+
118/* It is customary to use APIENTRY for OpenGL function pointer declarations on
+
119 * all platforms. Additionally, the Windows OpenGL header needs APIENTRY.
+
120 */
+
121#if !defined(APIENTRY)
+
122 #if defined(_WIN32)
+
123 #define APIENTRY __stdcall
+
124 #else
+
125 #define APIENTRY
+
126 #endif
+
127 #define GLFW_APIENTRY_DEFINED
+
128#endif /* APIENTRY */
+
129
+
130/* Some Windows OpenGL headers need this.
+
131 */
+
132#if !defined(WINGDIAPI) && defined(_WIN32)
+
133 #define WINGDIAPI __declspec(dllimport)
+
134 #define GLFW_WINGDIAPI_DEFINED
+
135#endif /* WINGDIAPI */
+
136
+
137/* Some Windows GLU headers need this.
+
138 */
+
139#if !defined(CALLBACK) && defined(_WIN32)
+
140 #define CALLBACK __stdcall
+
141 #define GLFW_CALLBACK_DEFINED
+
142#endif /* CALLBACK */
+
143
+
144/* Include the chosen OpenGL or OpenGL ES headers.
+
145 */
+
146#if defined(GLFW_INCLUDE_ES1)
+
147
+
148 #include <GLES/gl.h>
+
149 #if defined(GLFW_INCLUDE_GLEXT)
+
150 #include <GLES/glext.h>
+
151 #endif
+
152
+
153#elif defined(GLFW_INCLUDE_ES2)
+
154
+
155 #include <GLES2/gl2.h>
+
156 #if defined(GLFW_INCLUDE_GLEXT)
+
157 #include <GLES2/gl2ext.h>
+
158 #endif
+
159
+
160#elif defined(GLFW_INCLUDE_ES3)
+
161
+
162 #include <GLES3/gl3.h>
+
163 #if defined(GLFW_INCLUDE_GLEXT)
+
164 #include <GLES2/gl2ext.h>
+
165 #endif
+
166
+
167#elif defined(GLFW_INCLUDE_ES31)
+
168
+
169 #include <GLES3/gl31.h>
+
170 #if defined(GLFW_INCLUDE_GLEXT)
+
171 #include <GLES2/gl2ext.h>
+
172 #endif
+
173
+
174#elif defined(GLFW_INCLUDE_ES32)
+
175
+
176 #include <GLES3/gl32.h>
+
177 #if defined(GLFW_INCLUDE_GLEXT)
+
178 #include <GLES2/gl2ext.h>
+
179 #endif
+
180
+
181#elif defined(GLFW_INCLUDE_GLCOREARB)
+
182
+
183 #if defined(__APPLE__)
+
184
+
185 #include <OpenGL/gl3.h>
+
186 #if defined(GLFW_INCLUDE_GLEXT)
+
187 #include <OpenGL/gl3ext.h>
+
188 #endif /*GLFW_INCLUDE_GLEXT*/
+
189
+
190 #else /*__APPLE__*/
+
191
+
192 #include <GL/glcorearb.h>
+
193 #if defined(GLFW_INCLUDE_GLEXT)
+
194 #include <GL/glext.h>
+
195 #endif
+
196
+
197 #endif /*__APPLE__*/
+
198
+
199#elif defined(GLFW_INCLUDE_GLU)
+
200
+
201 #if defined(__APPLE__)
+
202
+
203 #if defined(GLFW_INCLUDE_GLU)
+
204 #include <OpenGL/glu.h>
+
205 #endif
+
206
+
207 #else /*__APPLE__*/
+
208
+
209 #if defined(GLFW_INCLUDE_GLU)
+
210 #include <GL/glu.h>
+
211 #endif
+
212
+
213 #endif /*__APPLE__*/
+
214
+
215#elif !defined(GLFW_INCLUDE_NONE) && \
+
216 !defined(__gl_h_) && \
+
217 !defined(__gles1_gl_h_) && \
+
218 !defined(__gles2_gl2_h_) && \
+
219 !defined(__gles2_gl3_h_) && \
+
220 !defined(__gles2_gl31_h_) && \
+
221 !defined(__gles2_gl32_h_) && \
+
222 !defined(__gl_glcorearb_h_) && \
+
223 !defined(__gl2_h_) /*legacy*/ && \
+
224 !defined(__gl3_h_) /*legacy*/ && \
+
225 !defined(__gl31_h_) /*legacy*/ && \
+
226 !defined(__gl32_h_) /*legacy*/ && \
+
227 !defined(__glcorearb_h_) /*legacy*/ && \
+
228 !defined(__GL_H__) /*non-standard*/ && \
+
229 !defined(__gltypes_h_) /*non-standard*/ && \
+
230 !defined(__glee_h_) /*non-standard*/
+
231
+
232 #if defined(__APPLE__)
+
233
+
234 #if !defined(GLFW_INCLUDE_GLEXT)
+
235 #define GL_GLEXT_LEGACY
+
236 #endif
+
237 #include <OpenGL/gl.h>
+
238
+
239 #else /*__APPLE__*/
+
240
+
241 #include <GL/gl.h>
+
242 #if defined(GLFW_INCLUDE_GLEXT)
+
243 #include <GL/glext.h>
+
244 #endif
+
245
+
246 #endif /*__APPLE__*/
+
247
+
248#endif /* OpenGL and OpenGL ES headers */
+
249
+
250#if defined(GLFW_DLL) && defined(_GLFW_BUILD_DLL)
+
251 /* GLFW_DLL must be defined by applications that are linking against the DLL
+
252 * version of the GLFW library. _GLFW_BUILD_DLL is defined by the GLFW
+
253 * configuration header when compiling the DLL version of the library.
+
254 */
+
255 #error "You must not have both GLFW_DLL and _GLFW_BUILD_DLL defined"
+
256#endif
+
257
+
258/* GLFWAPI is used to declare public API functions for export
+
259 * from the DLL / shared library / dynamic library.
+
260 */
+
261#if defined(_WIN32) && defined(_GLFW_BUILD_DLL)
+
262 /* We are building GLFW as a Win32 DLL */
+
263 #define GLFWAPI __declspec(dllexport)
+
264#elif defined(_WIN32) && defined(GLFW_DLL)
+
265 /* We are calling a GLFW Win32 DLL */
+
266 #define GLFWAPI __declspec(dllimport)
+
267#elif defined(__GNUC__) && defined(_GLFW_BUILD_DLL)
+
268 /* We are building GLFW as a Unix shared library */
+
269 #define GLFWAPI __attribute__((visibility("default")))
+
270#else
+
271 #define GLFWAPI
+
272#endif
+
273
+
274
+
275/*************************************************************************
+
276 * GLFW API tokens
+
277 *************************************************************************/
+
278
+
287#define GLFW_VERSION_MAJOR 3
+
294#define GLFW_VERSION_MINOR 3
+
301#define GLFW_VERSION_REVISION 8
+
312#define GLFW_TRUE 1
+
321#define GLFW_FALSE 0
+
322
+
331#define GLFW_RELEASE 0
+
338#define GLFW_PRESS 1
+
345#define GLFW_REPEAT 2
+
355#define GLFW_HAT_CENTERED 0
+
356#define GLFW_HAT_UP 1
+
357#define GLFW_HAT_RIGHT 2
+
358#define GLFW_HAT_DOWN 4
+
359#define GLFW_HAT_LEFT 8
+
360#define GLFW_HAT_RIGHT_UP (GLFW_HAT_RIGHT | GLFW_HAT_UP)
+
361#define GLFW_HAT_RIGHT_DOWN (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)
+
362#define GLFW_HAT_LEFT_UP (GLFW_HAT_LEFT | GLFW_HAT_UP)
+
363#define GLFW_HAT_LEFT_DOWN (GLFW_HAT_LEFT | GLFW_HAT_DOWN)
+
390/* The unknown key */
+
391#define GLFW_KEY_UNKNOWN -1
+
392
+
393/* Printable keys */
+
394#define GLFW_KEY_SPACE 32
+
395#define GLFW_KEY_APOSTROPHE 39 /* ' */
+
396#define GLFW_KEY_COMMA 44 /* , */
+
397#define GLFW_KEY_MINUS 45 /* - */
+
398#define GLFW_KEY_PERIOD 46 /* . */
+
399#define GLFW_KEY_SLASH 47 /* / */
+
400#define GLFW_KEY_0 48
+
401#define GLFW_KEY_1 49
+
402#define GLFW_KEY_2 50
+
403#define GLFW_KEY_3 51
+
404#define GLFW_KEY_4 52
+
405#define GLFW_KEY_5 53
+
406#define GLFW_KEY_6 54
+
407#define GLFW_KEY_7 55
+
408#define GLFW_KEY_8 56
+
409#define GLFW_KEY_9 57
+
410#define GLFW_KEY_SEMICOLON 59 /* ; */
+
411#define GLFW_KEY_EQUAL 61 /* = */
+
412#define GLFW_KEY_A 65
+
413#define GLFW_KEY_B 66
+
414#define GLFW_KEY_C 67
+
415#define GLFW_KEY_D 68
+
416#define GLFW_KEY_E 69
+
417#define GLFW_KEY_F 70
+
418#define GLFW_KEY_G 71
+
419#define GLFW_KEY_H 72
+
420#define GLFW_KEY_I 73
+
421#define GLFW_KEY_J 74
+
422#define GLFW_KEY_K 75
+
423#define GLFW_KEY_L 76
+
424#define GLFW_KEY_M 77
+
425#define GLFW_KEY_N 78
+
426#define GLFW_KEY_O 79
+
427#define GLFW_KEY_P 80
+
428#define GLFW_KEY_Q 81
+
429#define GLFW_KEY_R 82
+
430#define GLFW_KEY_S 83
+
431#define GLFW_KEY_T 84
+
432#define GLFW_KEY_U 85
+
433#define GLFW_KEY_V 86
+
434#define GLFW_KEY_W 87
+
435#define GLFW_KEY_X 88
+
436#define GLFW_KEY_Y 89
+
437#define GLFW_KEY_Z 90
+
438#define GLFW_KEY_LEFT_BRACKET 91 /* [ */
+
439#define GLFW_KEY_BACKSLASH 92 /* \ */
+
440#define GLFW_KEY_RIGHT_BRACKET 93 /* ] */
+
441#define GLFW_KEY_GRAVE_ACCENT 96 /* ` */
+
442#define GLFW_KEY_WORLD_1 161 /* non-US #1 */
+
443#define GLFW_KEY_WORLD_2 162 /* non-US #2 */
+
444
+
445/* Function keys */
+
446#define GLFW_KEY_ESCAPE 256
+
447#define GLFW_KEY_ENTER 257
+
448#define GLFW_KEY_TAB 258
+
449#define GLFW_KEY_BACKSPACE 259
+
450#define GLFW_KEY_INSERT 260
+
451#define GLFW_KEY_DELETE 261
+
452#define GLFW_KEY_RIGHT 262
+
453#define GLFW_KEY_LEFT 263
+
454#define GLFW_KEY_DOWN 264
+
455#define GLFW_KEY_UP 265
+
456#define GLFW_KEY_PAGE_UP 266
+
457#define GLFW_KEY_PAGE_DOWN 267
+
458#define GLFW_KEY_HOME 268
+
459#define GLFW_KEY_END 269
+
460#define GLFW_KEY_CAPS_LOCK 280
+
461#define GLFW_KEY_SCROLL_LOCK 281
+
462#define GLFW_KEY_NUM_LOCK 282
+
463#define GLFW_KEY_PRINT_SCREEN 283
+
464#define GLFW_KEY_PAUSE 284
+
465#define GLFW_KEY_F1 290
+
466#define GLFW_KEY_F2 291
+
467#define GLFW_KEY_F3 292
+
468#define GLFW_KEY_F4 293
+
469#define GLFW_KEY_F5 294
+
470#define GLFW_KEY_F6 295
+
471#define GLFW_KEY_F7 296
+
472#define GLFW_KEY_F8 297
+
473#define GLFW_KEY_F9 298
+
474#define GLFW_KEY_F10 299
+
475#define GLFW_KEY_F11 300
+
476#define GLFW_KEY_F12 301
+
477#define GLFW_KEY_F13 302
+
478#define GLFW_KEY_F14 303
+
479#define GLFW_KEY_F15 304
+
480#define GLFW_KEY_F16 305
+
481#define GLFW_KEY_F17 306
+
482#define GLFW_KEY_F18 307
+
483#define GLFW_KEY_F19 308
+
484#define GLFW_KEY_F20 309
+
485#define GLFW_KEY_F21 310
+
486#define GLFW_KEY_F22 311
+
487#define GLFW_KEY_F23 312
+
488#define GLFW_KEY_F24 313
+
489#define GLFW_KEY_F25 314
+
490#define GLFW_KEY_KP_0 320
+
491#define GLFW_KEY_KP_1 321
+
492#define GLFW_KEY_KP_2 322
+
493#define GLFW_KEY_KP_3 323
+
494#define GLFW_KEY_KP_4 324
+
495#define GLFW_KEY_KP_5 325
+
496#define GLFW_KEY_KP_6 326
+
497#define GLFW_KEY_KP_7 327
+
498#define GLFW_KEY_KP_8 328
+
499#define GLFW_KEY_KP_9 329
+
500#define GLFW_KEY_KP_DECIMAL 330
+
501#define GLFW_KEY_KP_DIVIDE 331
+
502#define GLFW_KEY_KP_MULTIPLY 332
+
503#define GLFW_KEY_KP_SUBTRACT 333
+
504#define GLFW_KEY_KP_ADD 334
+
505#define GLFW_KEY_KP_ENTER 335
+
506#define GLFW_KEY_KP_EQUAL 336
+
507#define GLFW_KEY_LEFT_SHIFT 340
+
508#define GLFW_KEY_LEFT_CONTROL 341
+
509#define GLFW_KEY_LEFT_ALT 342
+
510#define GLFW_KEY_LEFT_SUPER 343
+
511#define GLFW_KEY_RIGHT_SHIFT 344
+
512#define GLFW_KEY_RIGHT_CONTROL 345
+
513#define GLFW_KEY_RIGHT_ALT 346
+
514#define GLFW_KEY_RIGHT_SUPER 347
+
515#define GLFW_KEY_MENU 348
+
516
+
517#define GLFW_KEY_LAST GLFW_KEY_MENU
+
518
+
533#define GLFW_MOD_SHIFT 0x0001
+
538#define GLFW_MOD_CONTROL 0x0002
+
543#define GLFW_MOD_ALT 0x0004
+
548#define GLFW_MOD_SUPER 0x0008
+
554#define GLFW_MOD_CAPS_LOCK 0x0010
+
560#define GLFW_MOD_NUM_LOCK 0x0020
+
561
+
571#define GLFW_MOUSE_BUTTON_1 0
+
572#define GLFW_MOUSE_BUTTON_2 1
+
573#define GLFW_MOUSE_BUTTON_3 2
+
574#define GLFW_MOUSE_BUTTON_4 3
+
575#define GLFW_MOUSE_BUTTON_5 4
+
576#define GLFW_MOUSE_BUTTON_6 5
+
577#define GLFW_MOUSE_BUTTON_7 6
+
578#define GLFW_MOUSE_BUTTON_8 7
+
579#define GLFW_MOUSE_BUTTON_LAST GLFW_MOUSE_BUTTON_8
+
580#define GLFW_MOUSE_BUTTON_LEFT GLFW_MOUSE_BUTTON_1
+
581#define GLFW_MOUSE_BUTTON_RIGHT GLFW_MOUSE_BUTTON_2
+
582#define GLFW_MOUSE_BUTTON_MIDDLE GLFW_MOUSE_BUTTON_3
+
592#define GLFW_JOYSTICK_1 0
+
593#define GLFW_JOYSTICK_2 1
+
594#define GLFW_JOYSTICK_3 2
+
595#define GLFW_JOYSTICK_4 3
+
596#define GLFW_JOYSTICK_5 4
+
597#define GLFW_JOYSTICK_6 5
+
598#define GLFW_JOYSTICK_7 6
+
599#define GLFW_JOYSTICK_8 7
+
600#define GLFW_JOYSTICK_9 8
+
601#define GLFW_JOYSTICK_10 9
+
602#define GLFW_JOYSTICK_11 10
+
603#define GLFW_JOYSTICK_12 11
+
604#define GLFW_JOYSTICK_13 12
+
605#define GLFW_JOYSTICK_14 13
+
606#define GLFW_JOYSTICK_15 14
+
607#define GLFW_JOYSTICK_16 15
+
608#define GLFW_JOYSTICK_LAST GLFW_JOYSTICK_16
+
618#define GLFW_GAMEPAD_BUTTON_A 0
+
619#define GLFW_GAMEPAD_BUTTON_B 1
+
620#define GLFW_GAMEPAD_BUTTON_X 2
+
621#define GLFW_GAMEPAD_BUTTON_Y 3
+
622#define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER 4
+
623#define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER 5
+
624#define GLFW_GAMEPAD_BUTTON_BACK 6
+
625#define GLFW_GAMEPAD_BUTTON_START 7
+
626#define GLFW_GAMEPAD_BUTTON_GUIDE 8
+
627#define GLFW_GAMEPAD_BUTTON_LEFT_THUMB 9
+
628#define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB 10
+
629#define GLFW_GAMEPAD_BUTTON_DPAD_UP 11
+
630#define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT 12
+
631#define GLFW_GAMEPAD_BUTTON_DPAD_DOWN 13
+
632#define GLFW_GAMEPAD_BUTTON_DPAD_LEFT 14
+
633#define GLFW_GAMEPAD_BUTTON_LAST GLFW_GAMEPAD_BUTTON_DPAD_LEFT
+
634
+
635#define GLFW_GAMEPAD_BUTTON_CROSS GLFW_GAMEPAD_BUTTON_A
+
636#define GLFW_GAMEPAD_BUTTON_CIRCLE GLFW_GAMEPAD_BUTTON_B
+
637#define GLFW_GAMEPAD_BUTTON_SQUARE GLFW_GAMEPAD_BUTTON_X
+
638#define GLFW_GAMEPAD_BUTTON_TRIANGLE GLFW_GAMEPAD_BUTTON_Y
+
648#define GLFW_GAMEPAD_AXIS_LEFT_X 0
+
649#define GLFW_GAMEPAD_AXIS_LEFT_Y 1
+
650#define GLFW_GAMEPAD_AXIS_RIGHT_X 2
+
651#define GLFW_GAMEPAD_AXIS_RIGHT_Y 3
+
652#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER 4
+
653#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER 5
+
654#define GLFW_GAMEPAD_AXIS_LAST GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
+
670#define GLFW_NO_ERROR 0
+
679#define GLFW_NOT_INITIALIZED 0x00010001
+
689#define GLFW_NO_CURRENT_CONTEXT 0x00010002
+
697#define GLFW_INVALID_ENUM 0x00010003
+
708#define GLFW_INVALID_VALUE 0x00010004
+
716#define GLFW_OUT_OF_MEMORY 0x00010005
+
732#define GLFW_API_UNAVAILABLE 0x00010006
+
749#define GLFW_VERSION_UNAVAILABLE 0x00010007
+
760#define GLFW_PLATFORM_ERROR 0x00010008
+
779#define GLFW_FORMAT_UNAVAILABLE 0x00010009
+
787#define GLFW_NO_WINDOW_CONTEXT 0x0001000A
+
797#define GLFW_FOCUSED 0x00020001
+
802#define GLFW_ICONIFIED 0x00020002
+
808#define GLFW_RESIZABLE 0x00020003
+
814#define GLFW_VISIBLE 0x00020004
+
820#define GLFW_DECORATED 0x00020005
+
826#define GLFW_AUTO_ICONIFY 0x00020006
+
832#define GLFW_FLOATING 0x00020007
+
838#define GLFW_MAXIMIZED 0x00020008
+
843#define GLFW_CENTER_CURSOR 0x00020009
+
850#define GLFW_TRANSPARENT_FRAMEBUFFER 0x0002000A
+
855#define GLFW_HOVERED 0x0002000B
+
861#define GLFW_FOCUS_ON_SHOW 0x0002000C
+
862
+
867#define GLFW_RED_BITS 0x00021001
+
872#define GLFW_GREEN_BITS 0x00021002
+
877#define GLFW_BLUE_BITS 0x00021003
+
882#define GLFW_ALPHA_BITS 0x00021004
+
887#define GLFW_DEPTH_BITS 0x00021005
+
892#define GLFW_STENCIL_BITS 0x00021006
+
897#define GLFW_ACCUM_RED_BITS 0x00021007
+
902#define GLFW_ACCUM_GREEN_BITS 0x00021008
+
907#define GLFW_ACCUM_BLUE_BITS 0x00021009
+
912#define GLFW_ACCUM_ALPHA_BITS 0x0002100A
+
917#define GLFW_AUX_BUFFERS 0x0002100B
+
922#define GLFW_STEREO 0x0002100C
+
927#define GLFW_SAMPLES 0x0002100D
+
932#define GLFW_SRGB_CAPABLE 0x0002100E
+
937#define GLFW_REFRESH_RATE 0x0002100F
+
942#define GLFW_DOUBLEBUFFER 0x00021010
+
943
+
949#define GLFW_CLIENT_API 0x00022001
+
955#define GLFW_CONTEXT_VERSION_MAJOR 0x00022002
+
961#define GLFW_CONTEXT_VERSION_MINOR 0x00022003
+
967#define GLFW_CONTEXT_REVISION 0x00022004
+
973#define GLFW_CONTEXT_ROBUSTNESS 0x00022005
+
979#define GLFW_OPENGL_FORWARD_COMPAT 0x00022006
+
985#define GLFW_OPENGL_DEBUG_CONTEXT 0x00022007
+
991#define GLFW_OPENGL_PROFILE 0x00022008
+
997#define GLFW_CONTEXT_RELEASE_BEHAVIOR 0x00022009
+
1003#define GLFW_CONTEXT_NO_ERROR 0x0002200A
+
1009#define GLFW_CONTEXT_CREATION_API 0x0002200B
+
1013#define GLFW_SCALE_TO_MONITOR 0x0002200C
+
1017#define GLFW_COCOA_RETINA_FRAMEBUFFER 0x00023001
+
1021#define GLFW_COCOA_FRAME_NAME 0x00023002
+
1025#define GLFW_COCOA_GRAPHICS_SWITCHING 0x00023003
+
1029#define GLFW_X11_CLASS_NAME 0x00024001
+
1033#define GLFW_X11_INSTANCE_NAME 0x00024002
+
1036#define GLFW_NO_API 0
+
1037#define GLFW_OPENGL_API 0x00030001
+
1038#define GLFW_OPENGL_ES_API 0x00030002
+
1039
+
1040#define GLFW_NO_ROBUSTNESS 0
+
1041#define GLFW_NO_RESET_NOTIFICATION 0x00031001
+
1042#define GLFW_LOSE_CONTEXT_ON_RESET 0x00031002
+
1043
+
1044#define GLFW_OPENGL_ANY_PROFILE 0
+
1045#define GLFW_OPENGL_CORE_PROFILE 0x00032001
+
1046#define GLFW_OPENGL_COMPAT_PROFILE 0x00032002
+
1047
+
1048#define GLFW_CURSOR 0x00033001
+
1049#define GLFW_STICKY_KEYS 0x00033002
+
1050#define GLFW_STICKY_MOUSE_BUTTONS 0x00033003
+
1051#define GLFW_LOCK_KEY_MODS 0x00033004
+
1052#define GLFW_RAW_MOUSE_MOTION 0x00033005
+
1053
+
1054#define GLFW_CURSOR_NORMAL 0x00034001
+
1055#define GLFW_CURSOR_HIDDEN 0x00034002
+
1056#define GLFW_CURSOR_DISABLED 0x00034003
+
1057
+
1058#define GLFW_ANY_RELEASE_BEHAVIOR 0
+
1059#define GLFW_RELEASE_BEHAVIOR_FLUSH 0x00035001
+
1060#define GLFW_RELEASE_BEHAVIOR_NONE 0x00035002
+
1061
+
1062#define GLFW_NATIVE_CONTEXT_API 0x00036001
+
1063#define GLFW_EGL_CONTEXT_API 0x00036002
+
1064#define GLFW_OSMESA_CONTEXT_API 0x00036003
+
1065
+
1078#define GLFW_ARROW_CURSOR 0x00036001
+
1083#define GLFW_IBEAM_CURSOR 0x00036002
+
1088#define GLFW_CROSSHAIR_CURSOR 0x00036003
+
1093#define GLFW_HAND_CURSOR 0x00036004
+
1098#define GLFW_HRESIZE_CURSOR 0x00036005
+
1103#define GLFW_VRESIZE_CURSOR 0x00036006
+
1106#define GLFW_CONNECTED 0x00040001
+
1107#define GLFW_DISCONNECTED 0x00040002
+
1108
+
1115#define GLFW_JOYSTICK_HAT_BUTTONS 0x00050001
+
1120#define GLFW_COCOA_CHDIR_RESOURCES 0x00051001
+
1125#define GLFW_COCOA_MENUBAR 0x00051002
+
1128#define GLFW_DONT_CARE -1
+
1129
+
1130
+
1131/*************************************************************************
+
1132 * GLFW API types
+
1133 *************************************************************************/
+
1134
+
1147typedef void (*GLFWglproc)(void);
+
1148
+
1161typedef void (*GLFWvkproc)(void);
+
1162
+
1173typedef struct GLFWmonitor GLFWmonitor;
+
1174
+
1185typedef struct GLFWwindow GLFWwindow;
+
1186
+
1197typedef struct GLFWcursor GLFWcursor;
+
1198
+
1221typedef void (* GLFWerrorfun)(int error_code, const char* description);
+
1222
+
1244typedef void (* GLFWwindowposfun)(GLFWwindow* window, int xpos, int ypos);
+
1245
+
1266typedef void (* GLFWwindowsizefun)(GLFWwindow* window, int width, int height);
+
1267
+
1286typedef void (* GLFWwindowclosefun)(GLFWwindow* window);
+
1287
+
1306typedef void (* GLFWwindowrefreshfun)(GLFWwindow* window);
+
1307
+
1327typedef void (* GLFWwindowfocusfun)(GLFWwindow* window, int focused);
+
1328
+
1348typedef void (* GLFWwindowiconifyfun)(GLFWwindow* window, int iconified);
+
1349
+
1369typedef void (* GLFWwindowmaximizefun)(GLFWwindow* window, int maximized);
+
1370
+
1390typedef void (* GLFWframebuffersizefun)(GLFWwindow* window, int width, int height);
+
1391
+
1411typedef void (* GLFWwindowcontentscalefun)(GLFWwindow* window, float xscale, float yscale);
+
1412
+
1437typedef void (* GLFWmousebuttonfun)(GLFWwindow* window, int button, int action, int mods);
+
1438
+
1460typedef void (* GLFWcursorposfun)(GLFWwindow* window, double xpos, double ypos);
+
1461
+
1481typedef void (* GLFWcursorenterfun)(GLFWwindow* window, int entered);
+
1482
+
1502typedef void (* GLFWscrollfun)(GLFWwindow* window, double xoffset, double yoffset);
+
1503
+
1528typedef void (* GLFWkeyfun)(GLFWwindow* window, int key, int scancode, int action, int mods);
+
1529
+
1549typedef void (* GLFWcharfun)(GLFWwindow* window, unsigned int codepoint);
+
1550
+
1576typedef void (* GLFWcharmodsfun)(GLFWwindow* window, unsigned int codepoint, int mods);
+
1577
+
1600typedef void (* GLFWdropfun)(GLFWwindow* window, int path_count, const char* paths[]);
+
1601
+
1621typedef void (* GLFWmonitorfun)(GLFWmonitor* monitor, int event);
+
1622
+
1642typedef void (* GLFWjoystickfun)(int jid, int event);
+
1643
+
1657typedef struct GLFWvidmode
+
1658{
+
1661 int width;
+
1664 int height;
+
1667 int redBits;
+
1670 int greenBits;
+
1673 int blueBits;
+
1676 int refreshRate;
+
1677} GLFWvidmode;
+
1678
+
1691typedef struct GLFWgammaramp
+
1692{
+
1695 unsigned short* red;
+
1698 unsigned short* green;
+
1701 unsigned short* blue;
+
1704 unsigned int size;
+
1705} GLFWgammaramp;
+
1706
+
1720typedef struct GLFWimage
+
1721{
+
1724 int width;
+
1727 int height;
+
1730 unsigned char* pixels;
+
1731} GLFWimage;
+
1732
+
1744typedef struct GLFWgamepadstate
+
1745{
+
1749 unsigned char buttons[15];
+
1753 float axes[6];
+
1754} GLFWgamepadstate;
+
1755
+
1756
+
1757/*************************************************************************
+
1758 * GLFW API functions
+
1759 *************************************************************************/
+
1760
+
1797GLFWAPI int glfwInit(void);
+
1798
+
1831GLFWAPI void glfwTerminate(void);
+
1832
+
1863GLFWAPI void glfwInitHint(int hint, int value);
+
1864
+
1890GLFWAPI void glfwGetVersion(int* major, int* minor, int* rev);
+
1891
+
1921GLFWAPI const char* glfwGetVersionString(void);
+
1922
+
1952GLFWAPI int glfwGetError(const char** description);
+
1953
+
1998GLFWAPI GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback);
+
1999
+
2027GLFWAPI GLFWmonitor** glfwGetMonitors(int* count);
+
2028
+
2051GLFWAPI GLFWmonitor* glfwGetPrimaryMonitor(void);
+
2052
+
2076GLFWAPI void glfwGetMonitorPos(GLFWmonitor* monitor, int* xpos, int* ypos);
+
2077
+
2107GLFWAPI void glfwGetMonitorWorkarea(GLFWmonitor* monitor, int* xpos, int* ypos, int* width, int* height);
+
2108
+
2141GLFWAPI void glfwGetMonitorPhysicalSize(GLFWmonitor* monitor, int* widthMM, int* heightMM);
+
2142
+
2173GLFWAPI void glfwGetMonitorContentScale(GLFWmonitor* monitor, float* xscale, float* yscale);
+
2174
+
2199GLFWAPI const char* glfwGetMonitorName(GLFWmonitor* monitor);
+
2200
+
2225GLFWAPI void glfwSetMonitorUserPointer(GLFWmonitor* monitor, void* pointer);
+
2226
+
2249GLFWAPI void* glfwGetMonitorUserPointer(GLFWmonitor* monitor);
+
2250
+
2279GLFWAPI GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback);
+
2280
+
2313GLFWAPI const GLFWvidmode* glfwGetVideoModes(GLFWmonitor* monitor, int* count);
+
2314
+
2341GLFWAPI const GLFWvidmode* glfwGetVideoMode(GLFWmonitor* monitor);
+
2342
+
2374GLFWAPI void glfwSetGamma(GLFWmonitor* monitor, float gamma);
+
2375
+
2404GLFWAPI const GLFWgammaramp* glfwGetGammaRamp(GLFWmonitor* monitor);
+
2405
+
2445GLFWAPI void glfwSetGammaRamp(GLFWmonitor* monitor, const GLFWgammaramp* ramp);
+
2446
+
2464GLFWAPI void glfwDefaultWindowHints(void);
+
2465
+
2499GLFWAPI void glfwWindowHint(int hint, int value);
+
2500
+
2537GLFWAPI void glfwWindowHintString(int hint, const char* value);
+
2538
+
2691GLFWAPI GLFWwindow* glfwCreateWindow(int width, int height, const char* title, GLFWmonitor* monitor, GLFWwindow* share);
+
2692
+
2720GLFWAPI void glfwDestroyWindow(GLFWwindow* window);
+
2721
+
2740GLFWAPI int glfwWindowShouldClose(GLFWwindow* window);
+
2741
+
2762GLFWAPI void glfwSetWindowShouldClose(GLFWwindow* window, int value);
+
2763
+
2787GLFWAPI void glfwSetWindowTitle(GLFWwindow* window, const char* title);
+
2788
+
2834GLFWAPI void glfwSetWindowIcon(GLFWwindow* window, int count, const GLFWimage* images);
+
2835
+
2866GLFWAPI void glfwGetWindowPos(GLFWwindow* window, int* xpos, int* ypos);
+
2867
+
2901GLFWAPI void glfwSetWindowPos(GLFWwindow* window, int xpos, int ypos);
+
2902
+
2931GLFWAPI void glfwGetWindowSize(GLFWwindow* window, int* width, int* height);
+
2932
+
2974GLFWAPI void glfwSetWindowSizeLimits(GLFWwindow* window, int minwidth, int minheight, int maxwidth, int maxheight);
+
2975
+
3017GLFWAPI void glfwSetWindowAspectRatio(GLFWwindow* window, int numer, int denom);
+
3018
+
3058GLFWAPI void glfwSetWindowSize(GLFWwindow* window, int width, int height);
+
3059
+
3087GLFWAPI void glfwGetFramebufferSize(GLFWwindow* window, int* width, int* height);
+
3088
+
3124GLFWAPI void glfwGetWindowFrameSize(GLFWwindow* window, int* left, int* top, int* right, int* bottom);
+
3125
+
3157GLFWAPI void glfwGetWindowContentScale(GLFWwindow* window, float* xscale, float* yscale);
+
3158
+
3184GLFWAPI float glfwGetWindowOpacity(GLFWwindow* window);
+
3185
+
3213GLFWAPI void glfwSetWindowOpacity(GLFWwindow* window, float opacity);
+
3214
+
3241GLFWAPI void glfwIconifyWindow(GLFWwindow* window);
+
3242
+
3268GLFWAPI void glfwRestoreWindow(GLFWwindow* window);
+
3269
+
3293GLFWAPI void glfwMaximizeWindow(GLFWwindow* window);
+
3294
+
3325GLFWAPI void glfwShowWindow(GLFWwindow* window);
+
3326
+
3347GLFWAPI void glfwHideWindow(GLFWwindow* window);
+
3348
+
3386GLFWAPI void glfwFocusWindow(GLFWwindow* window);
+
3387
+
3413GLFWAPI void glfwRequestWindowAttention(GLFWwindow* window);
+
3414
+
3435GLFWAPI GLFWmonitor* glfwGetWindowMonitor(GLFWwindow* window);
+
3436
+
3494GLFWAPI void glfwSetWindowMonitor(GLFWwindow* window, GLFWmonitor* monitor, int xpos, int ypos, int width, int height, int refreshRate);
+
3495
+
3531GLFWAPI int glfwGetWindowAttrib(GLFWwindow* window, int attrib);
+
3532
+
3568GLFWAPI void glfwSetWindowAttrib(GLFWwindow* window, int attrib, int value);
+
3569
+
3591GLFWAPI void glfwSetWindowUserPointer(GLFWwindow* window, void* pointer);
+
3592
+
3612GLFWAPI void* glfwGetWindowUserPointer(GLFWwindow* window);
+
3613
+
3647GLFWAPI GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow* window, GLFWwindowposfun callback);
+
3648
+
3679GLFWAPI GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow* window, GLFWwindowsizefun callback);
+
3680
+
3719GLFWAPI GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow* window, GLFWwindowclosefun callback);
+
3720
+
3755GLFWAPI GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow* window, GLFWwindowrefreshfun callback);
+
3756
+
3790GLFWAPI GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow* window, GLFWwindowfocusfun callback);
+
3791
+
3823GLFWAPI GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow* window, GLFWwindowiconifyfun callback);
+
3824
+
3853GLFWAPI GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow* window, GLFWwindowmaximizefun callback);
+
3854
+
3883GLFWAPI GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow* window, GLFWframebuffersizefun callback);
+
3884
+
3914GLFWAPI GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow* window, GLFWwindowcontentscalefun callback);
+
3915
+
3952GLFWAPI void glfwPollEvents(void);
+
3953
+
3997GLFWAPI void glfwWaitEvents(void);
+
3998
+
4046GLFWAPI void glfwWaitEventsTimeout(double timeout);
+
4047
+
4066GLFWAPI void glfwPostEmptyEvent(void);
+
4067
+
4091GLFWAPI int glfwGetInputMode(GLFWwindow* window, int mode);
+
4092
+
4153GLFWAPI void glfwSetInputMode(GLFWwindow* window, int mode, int value);
+
4154
+
4182GLFWAPI int glfwRawMouseMotionSupported(void);
+
4183
+
4250GLFWAPI const char* glfwGetKeyName(int key, int scancode);
+
4251
+
4274GLFWAPI int glfwGetKeyScancode(int key);
+
4275
+
4313GLFWAPI int glfwGetKey(GLFWwindow* window, int key);
+
4314
+
4342GLFWAPI int glfwGetMouseButton(GLFWwindow* window, int button);
+
4343
+
4380GLFWAPI void glfwGetCursorPos(GLFWwindow* window, double* xpos, double* ypos);
+
4381
+
4420GLFWAPI void glfwSetCursorPos(GLFWwindow* window, double xpos, double ypos);
+
4421
+
4458GLFWAPI GLFWcursor* glfwCreateCursor(const GLFWimage* image, int xhot, int yhot);
+
4459
+
4481GLFWAPI GLFWcursor* glfwCreateStandardCursor(int shape);
+
4482
+
4508GLFWAPI void glfwDestroyCursor(GLFWcursor* cursor);
+
4509
+
4535GLFWAPI void glfwSetCursor(GLFWwindow* window, GLFWcursor* cursor);
+
4536
+
4585GLFWAPI GLFWkeyfun glfwSetKeyCallback(GLFWwindow* window, GLFWkeyfun callback);
+
4586
+
4628GLFWAPI GLFWcharfun glfwSetCharCallback(GLFWwindow* window, GLFWcharfun callback);
+
4629
+
4670GLFWAPI GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow* window, GLFWcharmodsfun callback);
+
4671
+
4707GLFWAPI GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow* window, GLFWmousebuttonfun callback);
+
4708
+
4739GLFWAPI GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow* window, GLFWcursorposfun callback);
+
4740
+
4770GLFWAPI GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow* window, GLFWcursorenterfun callback);
+
4771
+
4804GLFWAPI GLFWscrollfun glfwSetScrollCallback(GLFWwindow* window, GLFWscrollfun callback);
+
4805
+
4841GLFWAPI GLFWdropfun glfwSetDropCallback(GLFWwindow* window, GLFWdropfun callback);
+
4842
+
4865GLFWAPI int glfwJoystickPresent(int jid);
+
4866
+
4898GLFWAPI const float* glfwGetJoystickAxes(int jid, int* count);
+
4899
+
4939GLFWAPI const unsigned char* glfwGetJoystickButtons(int jid, int* count);
+
4940
+
4996GLFWAPI const unsigned char* glfwGetJoystickHats(int jid, int* count);
+
4997
+
5027GLFWAPI const char* glfwGetJoystickName(int jid);
+
5028
+
5068GLFWAPI const char* glfwGetJoystickGUID(int jid);
+
5069
+
5094GLFWAPI void glfwSetJoystickUserPointer(int jid, void* pointer);
+
5095
+
5118GLFWAPI void* glfwGetJoystickUserPointer(int jid);
+
5119
+
5146GLFWAPI int glfwJoystickIsGamepad(int jid);
+
5147
+
5182GLFWAPI GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback);
+
5183
+
5216GLFWAPI int glfwUpdateGamepadMappings(const char* string);
+
5217
+
5248GLFWAPI const char* glfwGetGamepadName(int jid);
+
5249
+
5286GLFWAPI int glfwGetGamepadState(int jid, GLFWgamepadstate* state);
+
5287
+
5311GLFWAPI void glfwSetClipboardString(GLFWwindow* window, const char* string);
+
5312
+
5341GLFWAPI const char* glfwGetClipboardString(GLFWwindow* window);
+
5342
+
5371GLFWAPI double glfwGetTime(void);
+
5372
+
5401GLFWAPI void glfwSetTime(double time);
+
5402
+
5423GLFWAPI uint64_t glfwGetTimerValue(void);
+
5424
+
5443GLFWAPI uint64_t glfwGetTimerFrequency(void);
+
5444
+
5481GLFWAPI void glfwMakeContextCurrent(GLFWwindow* window);
+
5482
+
5502GLFWAPI GLFWwindow* glfwGetCurrentContext(void);
+
5503
+
5536GLFWAPI void glfwSwapBuffers(GLFWwindow* window);
+
5537
+
5582GLFWAPI void glfwSwapInterval(int interval);
+
5583
+
5620GLFWAPI int glfwExtensionSupported(const char* extension);
+
5621
+
5662GLFWAPI GLFWglproc glfwGetProcAddress(const char* procname);
+
5663
+
5688GLFWAPI int glfwVulkanSupported(void);
+
5689
+
5732GLFWAPI const char** glfwGetRequiredInstanceExtensions(uint32_t* count);
+
5733
+
5734#if defined(VK_VERSION_1_0)
+
5735
+
5775GLFWAPI GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char* procname);
+
5776
+
5812GLFWAPI int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily);
+
5813
+
5875GLFWAPI VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow* window, const VkAllocationCallbacks* allocator, VkSurfaceKHR* surface);
+
5876
+
5877#endif /*VK_VERSION_1_0*/
+
5878
+
5879
+
5880/*************************************************************************
+
5881 * Global definition cleanup
+
5882 *************************************************************************/
+
5883
+
5884/* ------------------- BEGIN SYSTEM/COMPILER SPECIFIC -------------------- */
+
5885
+
5886#ifdef GLFW_WINGDIAPI_DEFINED
+
5887 #undef WINGDIAPI
+
5888 #undef GLFW_WINGDIAPI_DEFINED
+
5889#endif
+
5890
+
5891#ifdef GLFW_CALLBACK_DEFINED
+
5892 #undef CALLBACK
+
5893 #undef GLFW_CALLBACK_DEFINED
+
5894#endif
+
5895
+
5896/* Some OpenGL related headers need GLAPIENTRY, but it is unconditionally
+
5897 * defined by some gl.h variants (OpenBSD) so define it after if needed.
+
5898 */
+
5899#ifndef GLAPIENTRY
+
5900 #define GLAPIENTRY APIENTRY
+
5901 #define GLFW_GLAPIENTRY_DEFINED
+
5902#endif
+
5903
+
5904/* -------------------- END SYSTEM/COMPILER SPECIFIC --------------------- */
+
5905
+
5906
+
5907#ifdef __cplusplus
+
5908}
+
5909#endif
+
5910
+
5911#endif /* _glfw3_h_ */
+
5912
+
glfwMakeContextCurrent
void glfwMakeContextCurrent(GLFWwindow *window)
Makes the context of the specified window current for the calling thread.
+
glfwGetProcAddress
GLFWglproc glfwGetProcAddress(const char *procname)
Returns the address of the specified function for the current context.
+
GLFWglproc
void(* GLFWglproc)(void)
Client API function pointer type.
Definition: glfw3.h:1147
+
glfwSwapInterval
void glfwSwapInterval(int interval)
Sets the swap interval for the current context.
+
glfwExtensionSupported
int glfwExtensionSupported(const char *extension)
Returns whether the specified extension is available.
+
glfwGetCurrentContext
GLFWwindow * glfwGetCurrentContext(void)
Returns the window whose context is current on the calling thread.
+
glfwGetVersionString
const char * glfwGetVersionString(void)
Returns a string describing the compile-time configuration.
+
glfwInitHint
void glfwInitHint(int hint, int value)
Sets the specified init hint to the desired value.
+
glfwInit
int glfwInit(void)
Initializes the GLFW library.
+
GLFWerrorfun
void(* GLFWerrorfun)(int error_code, const char *description)
The function pointer type for error callbacks.
Definition: glfw3.h:1221
+
glfwGetError
int glfwGetError(const char **description)
Returns and clears the last error for the calling thread.
+
glfwGetVersion
void glfwGetVersion(int *major, int *minor, int *rev)
Retrieves the version of the GLFW library.
+
glfwTerminate
void glfwTerminate(void)
Terminates the GLFW library.
+
glfwSetErrorCallback
GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback)
Sets the error callback.
+
GLFWmousebuttonfun
void(* GLFWmousebuttonfun)(GLFWwindow *window, int button, int action, int mods)
The function pointer type for mouse button callbacks.
Definition: glfw3.h:1437
+
glfwGetCursorPos
void glfwGetCursorPos(GLFWwindow *window, double *xpos, double *ypos)
Retrieves the position of the cursor relative to the content area of the window.
+
glfwSetCursorPos
void glfwSetCursorPos(GLFWwindow *window, double xpos, double ypos)
Sets the position of the cursor, relative to the content area of the window.
+
glfwGetJoystickHats
const unsigned char * glfwGetJoystickHats(int jid, int *count)
Returns the state of all hats of the specified joystick.
+
glfwGetTimerValue
uint64_t glfwGetTimerValue(void)
Returns the current value of the raw timer.
+
glfwSetCharModsCallback
GLFWcharmodsfun glfwSetCharModsCallback(GLFWwindow *window, GLFWcharmodsfun callback)
Sets the Unicode character with modifiers callback.
+
glfwGetJoystickUserPointer
void * glfwGetJoystickUserPointer(int jid)
Returns the user pointer of the specified joystick.
+
GLFWcharfun
void(* GLFWcharfun)(GLFWwindow *window, unsigned int codepoint)
The function pointer type for Unicode character callbacks.
Definition: glfw3.h:1549
+
glfwSetKeyCallback
GLFWkeyfun glfwSetKeyCallback(GLFWwindow *window, GLFWkeyfun callback)
Sets the key callback.
+
glfwSetJoystickCallback
GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback)
Sets the joystick configuration callback.
+
glfwGetTimerFrequency
uint64_t glfwGetTimerFrequency(void)
Returns the frequency, in Hz, of the raw timer.
+
glfwCreateCursor
GLFWcursor * glfwCreateCursor(const GLFWimage *image, int xhot, int yhot)
Creates a custom cursor.
+
glfwSetScrollCallback
GLFWscrollfun glfwSetScrollCallback(GLFWwindow *window, GLFWscrollfun callback)
Sets the scroll callback.
+
GLFWkeyfun
void(* GLFWkeyfun)(GLFWwindow *window, int key, int scancode, int action, int mods)
The function pointer type for keyboard key callbacks.
Definition: glfw3.h:1528
+
glfwGetJoystickButtons
const unsigned char * glfwGetJoystickButtons(int jid, int *count)
Returns the state of all buttons of the specified joystick.
+
GLFWgamepadstate
struct GLFWgamepadstate GLFWgamepadstate
Gamepad input state.
+
glfwGetJoystickGUID
const char * glfwGetJoystickGUID(int jid)
Returns the SDL compatible GUID of the specified joystick.
+
glfwGetKeyScancode
int glfwGetKeyScancode(int key)
Returns the platform-specific scancode of the specified key.
+
glfwSetMouseButtonCallback
GLFWmousebuttonfun glfwSetMouseButtonCallback(GLFWwindow *window, GLFWmousebuttonfun callback)
Sets the mouse button callback.
+
glfwSetJoystickUserPointer
void glfwSetJoystickUserPointer(int jid, void *pointer)
Sets the user pointer of the specified joystick.
+
glfwGetClipboardString
const char * glfwGetClipboardString(GLFWwindow *window)
Returns the contents of the clipboard as a string.
+
glfwDestroyCursor
void glfwDestroyCursor(GLFWcursor *cursor)
Destroys a cursor.
+
GLFWcursor
struct GLFWcursor GLFWcursor
Opaque cursor object.
Definition: glfw3.h:1197
+
glfwGetGamepadName
const char * glfwGetGamepadName(int jid)
Returns the human-readable gamepad name for the specified joystick.
+
GLFWjoystickfun
void(* GLFWjoystickfun)(int jid, int event)
The function pointer type for joystick configuration callbacks.
Definition: glfw3.h:1642
+
glfwGetTime
double glfwGetTime(void)
Returns the GLFW time.
+
glfwSetInputMode
void glfwSetInputMode(GLFWwindow *window, int mode, int value)
Sets an input option for the specified window.
+
GLFWcursorenterfun
void(* GLFWcursorenterfun)(GLFWwindow *window, int entered)
The function pointer type for cursor enter/leave callbacks.
Definition: glfw3.h:1481
+
GLFWdropfun
void(* GLFWdropfun)(GLFWwindow *window, int path_count, const char *paths[])
The function pointer type for path drop callbacks.
Definition: glfw3.h:1600
+
glfwSetCharCallback
GLFWcharfun glfwSetCharCallback(GLFWwindow *window, GLFWcharfun callback)
Sets the Unicode character callback.
+
glfwSetDropCallback
GLFWdropfun glfwSetDropCallback(GLFWwindow *window, GLFWdropfun callback)
Sets the path drop callback.
+
glfwSetClipboardString
void glfwSetClipboardString(GLFWwindow *window, const char *string)
Sets the clipboard to the specified string.
+
glfwGetMouseButton
int glfwGetMouseButton(GLFWwindow *window, int button)
Returns the last reported state of a mouse button for the specified window.
+
glfwSetCursorPosCallback
GLFWcursorposfun glfwSetCursorPosCallback(GLFWwindow *window, GLFWcursorposfun callback)
Sets the cursor position callback.
+
GLFWcharmodsfun
void(* GLFWcharmodsfun)(GLFWwindow *window, unsigned int codepoint, int mods)
The function pointer type for Unicode character with modifiers callbacks.
Definition: glfw3.h:1576
+
glfwGetJoystickName
const char * glfwGetJoystickName(int jid)
Returns the name of the specified joystick.
+
glfwJoystickIsGamepad
int glfwJoystickIsGamepad(int jid)
Returns whether the specified joystick has a gamepad mapping.
+
glfwSetCursorEnterCallback
GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow *window, GLFWcursorenterfun callback)
Sets the cursor enter/leave callback.
+
glfwSetCursor
void glfwSetCursor(GLFWwindow *window, GLFWcursor *cursor)
Sets the cursor for the window.
+
GLFWcursorposfun
void(* GLFWcursorposfun)(GLFWwindow *window, double xpos, double ypos)
The function pointer type for cursor position callbacks.
Definition: glfw3.h:1460
+
glfwGetGamepadState
int glfwGetGamepadState(int jid, GLFWgamepadstate *state)
Retrieves the state of the specified joystick remapped as a gamepad.
+
glfwGetKey
int glfwGetKey(GLFWwindow *window, int key)
Returns the last reported state of a keyboard key for the specified window.
+
glfwRawMouseMotionSupported
int glfwRawMouseMotionSupported(void)
Returns whether raw mouse motion is supported.
+
glfwGetKeyName
const char * glfwGetKeyName(int key, int scancode)
Returns the layout-specific name of the specified printable key.
+
glfwGetJoystickAxes
const float * glfwGetJoystickAxes(int jid, int *count)
Returns the values of all axes of the specified joystick.
+
glfwJoystickPresent
int glfwJoystickPresent(int jid)
Returns whether the specified joystick is present.
+
glfwUpdateGamepadMappings
int glfwUpdateGamepadMappings(const char *string)
Adds the specified SDL_GameControllerDB gamepad mappings.
+
glfwCreateStandardCursor
GLFWcursor * glfwCreateStandardCursor(int shape)
Creates a cursor with a standard shape.
+
glfwSetTime
void glfwSetTime(double time)
Sets the GLFW time.
+
glfwGetInputMode
int glfwGetInputMode(GLFWwindow *window, int mode)
Returns the value of an input option for the specified window.
+
GLFWscrollfun
void(* GLFWscrollfun)(GLFWwindow *window, double xoffset, double yoffset)
The function pointer type for scroll callbacks.
Definition: glfw3.h:1502
+
glfwGetMonitorPos
void glfwGetMonitorPos(GLFWmonitor *monitor, int *xpos, int *ypos)
Returns the position of the monitor's viewport on the virtual screen.
+
glfwGetMonitorUserPointer
void * glfwGetMonitorUserPointer(GLFWmonitor *monitor)
Returns the user pointer of the specified monitor.
+
glfwSetGammaRamp
void glfwSetGammaRamp(GLFWmonitor *monitor, const GLFWgammaramp *ramp)
Sets the current gamma ramp for the specified monitor.
+
glfwSetGamma
void glfwSetGamma(GLFWmonitor *monitor, float gamma)
Generates a gamma ramp and sets it for the specified monitor.
+
glfwSetMonitorUserPointer
void glfwSetMonitorUserPointer(GLFWmonitor *monitor, void *pointer)
Sets the user pointer of the specified monitor.
+
glfwGetMonitors
GLFWmonitor ** glfwGetMonitors(int *count)
Returns the currently connected monitors.
+
glfwGetMonitorWorkarea
void glfwGetMonitorWorkarea(GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height)
Retrieves the work area of the monitor.
+
glfwGetGammaRamp
const GLFWgammaramp * glfwGetGammaRamp(GLFWmonitor *monitor)
Returns the current gamma ramp for the specified monitor.
+
glfwGetMonitorName
const char * glfwGetMonitorName(GLFWmonitor *monitor)
Returns the name of the specified monitor.
+
glfwGetMonitorPhysicalSize
void glfwGetMonitorPhysicalSize(GLFWmonitor *monitor, int *widthMM, int *heightMM)
Returns the physical size of the monitor.
+
GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1173
+
GLFWvidmode
struct GLFWvidmode GLFWvidmode
Video mode type.
+
GLFWgammaramp
struct GLFWgammaramp GLFWgammaramp
Gamma ramp.
+
GLFWmonitorfun
void(* GLFWmonitorfun)(GLFWmonitor *monitor, int event)
The function pointer type for monitor configuration callbacks.
Definition: glfw3.h:1621
+
glfwSetMonitorCallback
GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback)
Sets the monitor configuration callback.
+
glfwGetVideoMode
const GLFWvidmode * glfwGetVideoMode(GLFWmonitor *monitor)
Returns the current mode of the specified monitor.
+
glfwGetPrimaryMonitor
GLFWmonitor * glfwGetPrimaryMonitor(void)
Returns the primary monitor.
+
glfwGetVideoModes
const GLFWvidmode * glfwGetVideoModes(GLFWmonitor *monitor, int *count)
Returns the available video modes for the specified monitor.
+
glfwGetMonitorContentScale
void glfwGetMonitorContentScale(GLFWmonitor *monitor, float *xscale, float *yscale)
Retrieves the content scale for the specified monitor.
+
glfwCreateWindowSurface
VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
Creates a Vulkan surface for the specified window.
+
glfwVulkanSupported
int glfwVulkanSupported(void)
Returns whether the Vulkan loader and an ICD have been found.
+
GLFWvkproc
void(* GLFWvkproc)(void)
Vulkan API function pointer type.
Definition: glfw3.h:1161
+
glfwGetRequiredInstanceExtensions
const char ** glfwGetRequiredInstanceExtensions(uint32_t *count)
Returns the Vulkan instance extensions required by GLFW.
+
glfwGetInstanceProcAddress
GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char *procname)
Returns the address of the specified Vulkan instance function.
+
glfwGetPhysicalDevicePresentationSupport
int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
Returns whether the specified queue family can present images.
+
glfwSetWindowPosCallback
GLFWwindowposfun glfwSetWindowPosCallback(GLFWwindow *window, GLFWwindowposfun callback)
Sets the position callback for the specified window.
+
glfwGetFramebufferSize
void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the framebuffer of the specified window.
+
glfwSwapBuffers
void glfwSwapBuffers(GLFWwindow *window)
Swaps the front and back buffers of the specified window.
+
glfwGetWindowFrameSize
void glfwGetWindowFrameSize(GLFWwindow *window, int *left, int *top, int *right, int *bottom)
Retrieves the size of the frame of the window.
+
glfwSetWindowPos
void glfwSetWindowPos(GLFWwindow *window, int xpos, int ypos)
Sets the position of the content area of the specified window.
+
glfwIconifyWindow
void glfwIconifyWindow(GLFWwindow *window)
Iconifies the specified window.
+
glfwSetWindowRefreshCallback
GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow *window, GLFWwindowrefreshfun callback)
Sets the refresh callback for the specified window.
+
glfwWindowShouldClose
int glfwWindowShouldClose(GLFWwindow *window)
Checks the close flag of the specified window.
+
glfwRequestWindowAttention
void glfwRequestWindowAttention(GLFWwindow *window)
Requests user attention to the specified window.
+
GLFWwindowmaximizefun
void(* GLFWwindowmaximizefun)(GLFWwindow *window, int maximized)
The function pointer type for window maximize callbacks.
Definition: glfw3.h:1369
+
glfwCreateWindow
GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
Creates a window and its associated context.
+
GLFWwindowiconifyfun
void(* GLFWwindowiconifyfun)(GLFWwindow *window, int iconified)
The function pointer type for window iconify callbacks.
Definition: glfw3.h:1348
+
glfwSetWindowSize
void glfwSetWindowSize(GLFWwindow *window, int width, int height)
Sets the size of the content area of the specified window.
+
glfwPollEvents
void glfwPollEvents(void)
Processes all pending events.
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+
glfwSetWindowUserPointer
void glfwSetWindowUserPointer(GLFWwindow *window, void *pointer)
Sets the user pointer of the specified window.
+
glfwMaximizeWindow
void glfwMaximizeWindow(GLFWwindow *window)
Maximizes the specified window.
+
GLFWwindowrefreshfun
void(* GLFWwindowrefreshfun)(GLFWwindow *window)
The function pointer type for window content refresh callbacks.
Definition: glfw3.h:1306
+
glfwHideWindow
void glfwHideWindow(GLFWwindow *window)
Hides the specified window.
+
glfwSetWindowShouldClose
void glfwSetWindowShouldClose(GLFWwindow *window, int value)
Sets the close flag of the specified window.
+
glfwGetWindowMonitor
GLFWmonitor * glfwGetWindowMonitor(GLFWwindow *window)
Returns the monitor that the window uses for full screen mode.
+
glfwRestoreWindow
void glfwRestoreWindow(GLFWwindow *window)
Restores the specified window.
+
glfwWaitEvents
void glfwWaitEvents(void)
Waits until events are queued and processes them.
+
glfwSetWindowTitle
void glfwSetWindowTitle(GLFWwindow *window, const char *title)
Sets the title of the specified window.
+
glfwWaitEventsTimeout
void glfwWaitEventsTimeout(double timeout)
Waits with timeout until events are queued and processes them.
+
glfwShowWindow
void glfwShowWindow(GLFWwindow *window)
Makes the specified window visible.
+
glfwSetWindowAspectRatio
void glfwSetWindowAspectRatio(GLFWwindow *window, int numer, int denom)
Sets the aspect ratio of the specified window.
+
glfwGetWindowPos
void glfwGetWindowPos(GLFWwindow *window, int *xpos, int *ypos)
Retrieves the position of the content area of the specified window.
+
GLFWwindowcontentscalefun
void(* GLFWwindowcontentscalefun)(GLFWwindow *window, float xscale, float yscale)
The function pointer type for window content scale callbacks.
Definition: glfw3.h:1411
+
GLFWimage
struct GLFWimage GLFWimage
Image data.
+
glfwWindowHint
void glfwWindowHint(int hint, int value)
Sets the specified window hint to the desired value.
+
glfwSetWindowMonitor
void glfwSetWindowMonitor(GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate)
Sets the mode, monitor, video mode and placement of a window.
+
glfwFocusWindow
void glfwFocusWindow(GLFWwindow *window)
Brings the specified window to front and sets input focus.
+
glfwWindowHintString
void glfwWindowHintString(int hint, const char *value)
Sets the specified window hint to the desired value.
+
glfwDefaultWindowHints
void glfwDefaultWindowHints(void)
Resets all window hints to their default values.
+
glfwSetFramebufferSizeCallback
GLFWframebuffersizefun glfwSetFramebufferSizeCallback(GLFWwindow *window, GLFWframebuffersizefun callback)
Sets the framebuffer resize callback for the specified window.
+
glfwPostEmptyEvent
void glfwPostEmptyEvent(void)
Posts an empty event to the event queue.
+
GLFWwindowfocusfun
void(* GLFWwindowfocusfun)(GLFWwindow *window, int focused)
The function pointer type for window focus callbacks.
Definition: glfw3.h:1327
+
GLFWwindowposfun
void(* GLFWwindowposfun)(GLFWwindow *window, int xpos, int ypos)
The function pointer type for window position callbacks.
Definition: glfw3.h:1244
+
GLFWwindowclosefun
void(* GLFWwindowclosefun)(GLFWwindow *window)
The function pointer type for window close callbacks.
Definition: glfw3.h:1286
+
glfwSetWindowFocusCallback
GLFWwindowfocusfun glfwSetWindowFocusCallback(GLFWwindow *window, GLFWwindowfocusfun callback)
Sets the focus callback for the specified window.
+
glfwSetWindowSizeLimits
void glfwSetWindowSizeLimits(GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
Sets the size limits of the specified window.
+
glfwSetWindowOpacity
void glfwSetWindowOpacity(GLFWwindow *window, float opacity)
Sets the opacity of the whole window.
+
glfwSetWindowIconifyCallback
GLFWwindowiconifyfun glfwSetWindowIconifyCallback(GLFWwindow *window, GLFWwindowiconifyfun callback)
Sets the iconify callback for the specified window.
+
glfwSetWindowMaximizeCallback
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback(GLFWwindow *window, GLFWwindowmaximizefun callback)
Sets the maximize callback for the specified window.
+
glfwGetWindowAttrib
int glfwGetWindowAttrib(GLFWwindow *window, int attrib)
Returns an attribute of the specified window.
+
glfwDestroyWindow
void glfwDestroyWindow(GLFWwindow *window)
Destroys the specified window and its context.
+
glfwSetWindowAttrib
void glfwSetWindowAttrib(GLFWwindow *window, int attrib, int value)
Sets an attribute of the specified window.
+
glfwGetWindowOpacity
float glfwGetWindowOpacity(GLFWwindow *window)
Returns the opacity of the whole window.
+
glfwSetWindowSizeCallback
GLFWwindowsizefun glfwSetWindowSizeCallback(GLFWwindow *window, GLFWwindowsizefun callback)
Sets the size callback for the specified window.
+
glfwSetWindowCloseCallback
GLFWwindowclosefun glfwSetWindowCloseCallback(GLFWwindow *window, GLFWwindowclosefun callback)
Sets the close callback for the specified window.
+
glfwSetWindowIcon
void glfwSetWindowIcon(GLFWwindow *window, int count, const GLFWimage *images)
Sets the icon for the specified window.
+
GLFWframebuffersizefun
void(* GLFWframebuffersizefun)(GLFWwindow *window, int width, int height)
The function pointer type for framebuffer size callbacks.
Definition: glfw3.h:1390
+
glfwGetWindowUserPointer
void * glfwGetWindowUserPointer(GLFWwindow *window)
Returns the user pointer of the specified window.
+
GLFWwindowsizefun
void(* GLFWwindowsizefun)(GLFWwindow *window, int width, int height)
The function pointer type for window size callbacks.
Definition: glfw3.h:1266
+
glfwGetWindowSize
void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)
Retrieves the size of the content area of the specified window.
+
glfwSetWindowContentScaleCallback
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback(GLFWwindow *window, GLFWwindowcontentscalefun callback)
Sets the window content scale callback for the specified window.
+
glfwGetWindowContentScale
void glfwGetWindowContentScale(GLFWwindow *window, float *xscale, float *yscale)
Retrieves the content scale for the specified window.
+
GLFWgamepadstate
Gamepad input state.
Definition: glfw3.h:1745
+
GLFWgamepadstate::buttons
unsigned char buttons[15]
Definition: glfw3.h:1749
+
GLFWgamepadstate::axes
float axes[6]
Definition: glfw3.h:1753
+
GLFWgammaramp
Gamma ramp.
Definition: glfw3.h:1692
+
GLFWgammaramp::red
unsigned short * red
Definition: glfw3.h:1695
+
GLFWgammaramp::blue
unsigned short * blue
Definition: glfw3.h:1701
+
GLFWgammaramp::size
unsigned int size
Definition: glfw3.h:1704
+
GLFWgammaramp::green
unsigned short * green
Definition: glfw3.h:1698
+
GLFWimage
Image data.
Definition: glfw3.h:1721
+
GLFWimage::height
int height
Definition: glfw3.h:1727
+
GLFWimage::pixels
unsigned char * pixels
Definition: glfw3.h:1730
+
GLFWimage::width
int width
Definition: glfw3.h:1724
+
GLFWvidmode
Video mode type.
Definition: glfw3.h:1658
+
GLFWvidmode::greenBits
int greenBits
Definition: glfw3.h:1670
+
GLFWvidmode::redBits
int redBits
Definition: glfw3.h:1667
+
GLFWvidmode::width
int width
Definition: glfw3.h:1661
+
GLFWvidmode::refreshRate
int refreshRate
Definition: glfw3.h:1676
+
GLFWvidmode::height
int height
Definition: glfw3.h:1664
+
GLFWvidmode::blueBits
int blueBits
Definition: glfw3.h:1673
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/glfw3native_8h.html b/deps/glfw-3.3.8/docs/html/glfw3native_8h.html new file mode 100644 index 0000000..b990f15 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3native_8h.html @@ -0,0 +1,160 @@ + + + + + + + +GLFW: glfw3native.h File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Functions
+
glfw3native.h File Reference
+
+
+

Description

+

This is the header file of the native access functions. See Native access for more information.

+
+

Go to the source code of this file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

const char * glfwGetWin32Adapter (GLFWmonitor *monitor)
 Returns the adapter device name of the specified monitor. More...
 
const char * glfwGetWin32Monitor (GLFWmonitor *monitor)
 Returns the display device name of the specified monitor. More...
 
HWND glfwGetWin32Window (GLFWwindow *window)
 Returns the HWND of the specified window. More...
 
HGLRC glfwGetWGLContext (GLFWwindow *window)
 Returns the HGLRC of the specified window. More...
 
CGDirectDisplayID glfwGetCocoaMonitor (GLFWmonitor *monitor)
 Returns the CGDirectDisplayID of the specified monitor. More...
 
id glfwGetCocoaWindow (GLFWwindow *window)
 Returns the NSWindow of the specified window. More...
 
id glfwGetNSGLContext (GLFWwindow *window)
 Returns the NSOpenGLContext of the specified window. More...
 
Display * glfwGetX11Display (void)
 Returns the Display used by GLFW. More...
 
RRCrtc glfwGetX11Adapter (GLFWmonitor *monitor)
 Returns the RRCrtc of the specified monitor. More...
 
RROutput glfwGetX11Monitor (GLFWmonitor *monitor)
 Returns the RROutput of the specified monitor. More...
 
Window glfwGetX11Window (GLFWwindow *window)
 Returns the Window of the specified window. More...
 
void glfwSetX11SelectionString (const char *string)
 Sets the current primary selection to the specified string. More...
 
const char * glfwGetX11SelectionString (void)
 Returns the contents of the current primary selection as a string. More...
 
GLXContext glfwGetGLXContext (GLFWwindow *window)
 Returns the GLXContext of the specified window. More...
 
GLXWindow glfwGetGLXWindow (GLFWwindow *window)
 Returns the GLXWindow of the specified window. More...
 
struct wl_display * glfwGetWaylandDisplay (void)
 Returns the struct wl_display* used by GLFW. More...
 
struct wl_output * glfwGetWaylandMonitor (GLFWmonitor *monitor)
 Returns the struct wl_output* of the specified monitor. More...
 
struct wl_surface * glfwGetWaylandWindow (GLFWwindow *window)
 Returns the main struct wl_surface* of the specified window. More...
 
EGLDisplay glfwGetEGLDisplay (void)
 Returns the EGLDisplay used by GLFW. More...
 
EGLContext glfwGetEGLContext (GLFWwindow *window)
 Returns the EGLContext of the specified window. More...
 
EGLSurface glfwGetEGLSurface (GLFWwindow *window)
 Returns the EGLSurface of the specified window. More...
 
int glfwGetOSMesaColorBuffer (GLFWwindow *window, int *width, int *height, int *format, void **buffer)
 Retrieves the color buffer associated with the specified window. More...
 
int glfwGetOSMesaDepthBuffer (GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer)
 Retrieves the depth buffer associated with the specified window. More...
 
OSMesaContext glfwGetOSMesaContext (GLFWwindow *window)
 Returns the OSMesaContext of the specified window. More...
 
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html b/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html new file mode 100644 index 0000000..31a0c40 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/glfw3native_8h_source.html @@ -0,0 +1,285 @@ + + + + + + + +GLFW: glfw3native.h Source File + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ + +
+
+
glfw3native.h
+
+
+Go to the documentation of this file.
1/*************************************************************************
+
2 * GLFW 3.3 - www.glfw.org
+
3 * A library for OpenGL, window and input
+
4 *------------------------------------------------------------------------
+
5 * Copyright (c) 2002-2006 Marcus Geelnard
+
6 * Copyright (c) 2006-2018 Camilla Löwy <elmindreda@glfw.org>
+
7 *
+
8 * This software is provided 'as-is', without any express or implied
+
9 * warranty. In no event will the authors be held liable for any damages
+
10 * arising from the use of this software.
+
11 *
+
12 * Permission is granted to anyone to use this software for any purpose,
+
13 * including commercial applications, and to alter it and redistribute it
+
14 * freely, subject to the following restrictions:
+
15 *
+
16 * 1. The origin of this software must not be misrepresented; you must not
+
17 * claim that you wrote the original software. If you use this software
+
18 * in a product, an acknowledgment in the product documentation would
+
19 * be appreciated but is not required.
+
20 *
+
21 * 2. Altered source versions must be plainly marked as such, and must not
+
22 * be misrepresented as being the original software.
+
23 *
+
24 * 3. This notice may not be removed or altered from any source
+
25 * distribution.
+
26 *
+
27 *************************************************************************/
+
28
+
29#ifndef _glfw3_native_h_
+
30#define _glfw3_native_h_
+
31
+
32#ifdef __cplusplus
+
33extern "C" {
+
34#endif
+
35
+
36
+
37/*************************************************************************
+
38 * Doxygen documentation
+
39 *************************************************************************/
+
40
+
90/*************************************************************************
+
91 * System headers and types
+
92 *************************************************************************/
+
93
+
94#if !defined(GLFW_NATIVE_INCLUDE_NONE)
+
95
+
96 #if defined(GLFW_EXPOSE_NATIVE_WIN32) || defined(GLFW_EXPOSE_NATIVE_WGL)
+
97 /* This is a workaround for the fact that glfw3.h needs to export APIENTRY (for
+
98 * example to allow applications to correctly declare a GL_KHR_debug callback)
+
99 * but windows.h assumes no one will define APIENTRY before it does
+
100 */
+
101 #if defined(GLFW_APIENTRY_DEFINED)
+
102 #undef APIENTRY
+
103 #undef GLFW_APIENTRY_DEFINED
+
104 #endif
+
105 #include <windows.h>
+
106 #elif defined(GLFW_EXPOSE_NATIVE_COCOA) || defined(GLFW_EXPOSE_NATIVE_NSGL)
+
107 #if defined(__OBJC__)
+
108 #import <Cocoa/Cocoa.h>
+
109 #else
+
110 #include <ApplicationServices/ApplicationServices.h>
+
111 #include <objc/objc.h>
+
112 #endif
+
113 #elif defined(GLFW_EXPOSE_NATIVE_X11) || defined(GLFW_EXPOSE_NATIVE_GLX)
+
114 #include <X11/Xlib.h>
+
115 #include <X11/extensions/Xrandr.h>
+
116 #elif defined(GLFW_EXPOSE_NATIVE_WAYLAND)
+
117 #include <wayland-client.h>
+
118 #endif
+
119
+
120 #if defined(GLFW_EXPOSE_NATIVE_WGL)
+
121 /* WGL is declared by windows.h */
+
122 #endif
+
123 #if defined(GLFW_EXPOSE_NATIVE_NSGL)
+
124 /* NSGL is declared by Cocoa.h */
+
125 #endif
+
126 #if defined(GLFW_EXPOSE_NATIVE_GLX)
+
127 /* This is a workaround for the fact that glfw3.h defines GLAPIENTRY because by
+
128 * default it also acts as an OpenGL header
+
129 * However, glx.h will include gl.h, which will define it unconditionally
+
130 */
+
131 #if defined(GLFW_GLAPIENTRY_DEFINED)
+
132 #undef GLAPIENTRY
+
133 #undef GLFW_GLAPIENTRY_DEFINED
+
134 #endif
+
135 #include <GL/glx.h>
+
136 #endif
+
137 #if defined(GLFW_EXPOSE_NATIVE_EGL)
+
138 #include <EGL/egl.h>
+
139 #endif
+
140 #if defined(GLFW_EXPOSE_NATIVE_OSMESA)
+
141 /* This is a workaround for the fact that glfw3.h defines GLAPIENTRY because by
+
142 * default it also acts as an OpenGL header
+
143 * However, osmesa.h will include gl.h, which will define it unconditionally
+
144 */
+
145 #if defined(GLFW_GLAPIENTRY_DEFINED)
+
146 #undef GLAPIENTRY
+
147 #undef GLFW_GLAPIENTRY_DEFINED
+
148 #endif
+
149 #include <GL/osmesa.h>
+
150 #endif
+
151
+
152#endif /*GLFW_NATIVE_INCLUDE_NONE*/
+
153
+
154
+
155/*************************************************************************
+
156 * Functions
+
157 *************************************************************************/
+
158
+
159#if defined(GLFW_EXPOSE_NATIVE_WIN32)
+
175GLFWAPI const char* glfwGetWin32Adapter(GLFWmonitor* monitor);
+
176
+
192GLFWAPI const char* glfwGetWin32Monitor(GLFWmonitor* monitor);
+
193
+
216GLFWAPI HWND glfwGetWin32Window(GLFWwindow* window);
+
217#endif
+
218
+
219#if defined(GLFW_EXPOSE_NATIVE_WGL)
+
243GLFWAPI HGLRC glfwGetWGLContext(GLFWwindow* window);
+
244#endif
+
245
+
246#if defined(GLFW_EXPOSE_NATIVE_COCOA)
+
261GLFWAPI CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor* monitor);
+
262
+
277GLFWAPI id glfwGetCocoaWindow(GLFWwindow* window);
+
278#endif
+
279
+
280#if defined(GLFW_EXPOSE_NATIVE_NSGL)
+
296GLFWAPI id glfwGetNSGLContext(GLFWwindow* window);
+
297#endif
+
298
+
299#if defined(GLFW_EXPOSE_NATIVE_X11)
+
314GLFWAPI Display* glfwGetX11Display(void);
+
315
+
330GLFWAPI RRCrtc glfwGetX11Adapter(GLFWmonitor* monitor);
+
331
+
346GLFWAPI RROutput glfwGetX11Monitor(GLFWmonitor* monitor);
+
347
+
362GLFWAPI Window glfwGetX11Window(GLFWwindow* window);
+
363
+
384GLFWAPI void glfwSetX11SelectionString(const char* string);
+
385
+
412GLFWAPI const char* glfwGetX11SelectionString(void);
+
413#endif
+
414
+
415#if defined(GLFW_EXPOSE_NATIVE_GLX)
+
431GLFWAPI GLXContext glfwGetGLXContext(GLFWwindow* window);
+
432
+
448GLFWAPI GLXWindow glfwGetGLXWindow(GLFWwindow* window);
+
449#endif
+
450
+
451#if defined(GLFW_EXPOSE_NATIVE_WAYLAND)
+
466GLFWAPI struct wl_display* glfwGetWaylandDisplay(void);
+
467
+
482GLFWAPI struct wl_output* glfwGetWaylandMonitor(GLFWmonitor* monitor);
+
483
+
498GLFWAPI struct wl_surface* glfwGetWaylandWindow(GLFWwindow* window);
+
499#endif
+
500
+
501#if defined(GLFW_EXPOSE_NATIVE_EGL)
+
519GLFWAPI EGLDisplay glfwGetEGLDisplay(void);
+
520
+
536GLFWAPI EGLContext glfwGetEGLContext(GLFWwindow* window);
+
537
+
553GLFWAPI EGLSurface glfwGetEGLSurface(GLFWwindow* window);
+
554#endif
+
555
+
556#if defined(GLFW_EXPOSE_NATIVE_OSMESA)
+
579GLFWAPI int glfwGetOSMesaColorBuffer(GLFWwindow* window, int* width, int* height, int* format, void** buffer);
+
580
+
603GLFWAPI int glfwGetOSMesaDepthBuffer(GLFWwindow* window, int* width, int* height, int* bytesPerValue, void** buffer);
+
604
+
620GLFWAPI OSMesaContext glfwGetOSMesaContext(GLFWwindow* window);
+
621#endif
+
622
+
623#ifdef __cplusplus
+
624}
+
625#endif
+
626
+
627#endif /* _glfw3_native_h_ */
+
628
+
GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1173
+
glfwGetX11Adapter
RRCrtc glfwGetX11Adapter(GLFWmonitor *monitor)
Returns the RRCrtc of the specified monitor.
+
glfwGetEGLDisplay
EGLDisplay glfwGetEGLDisplay(void)
Returns the EGLDisplay used by GLFW.
+
glfwGetGLXWindow
GLXWindow glfwGetGLXWindow(GLFWwindow *window)
Returns the GLXWindow of the specified window.
+
glfwGetEGLSurface
EGLSurface glfwGetEGLSurface(GLFWwindow *window)
Returns the EGLSurface of the specified window.
+
glfwGetOSMesaColorBuffer
int glfwGetOSMesaColorBuffer(GLFWwindow *window, int *width, int *height, int *format, void **buffer)
Retrieves the color buffer associated with the specified window.
+
glfwGetWaylandMonitor
struct wl_output * glfwGetWaylandMonitor(GLFWmonitor *monitor)
Returns the struct wl_output* of the specified monitor.
+
glfwGetNSGLContext
id glfwGetNSGLContext(GLFWwindow *window)
Returns the NSOpenGLContext of the specified window.
+
glfwSetX11SelectionString
void glfwSetX11SelectionString(const char *string)
Sets the current primary selection to the specified string.
+
glfwGetWaylandWindow
struct wl_surface * glfwGetWaylandWindow(GLFWwindow *window)
Returns the main struct wl_surface* of the specified window.
+
glfwGetGLXContext
GLXContext glfwGetGLXContext(GLFWwindow *window)
Returns the GLXContext of the specified window.
+
glfwGetEGLContext
EGLContext glfwGetEGLContext(GLFWwindow *window)
Returns the EGLContext of the specified window.
+
glfwGetOSMesaDepthBuffer
int glfwGetOSMesaDepthBuffer(GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer)
Retrieves the depth buffer associated with the specified window.
+
glfwGetX11Display
Display * glfwGetX11Display(void)
Returns the Display used by GLFW.
+
glfwGetX11Window
Window glfwGetX11Window(GLFWwindow *window)
Returns the Window of the specified window.
+
glfwGetOSMesaContext
OSMesaContext glfwGetOSMesaContext(GLFWwindow *window)
Returns the OSMesaContext of the specified window.
+
glfwGetX11Monitor
RROutput glfwGetX11Monitor(GLFWmonitor *monitor)
Returns the RROutput of the specified monitor.
+
glfwGetCocoaWindow
id glfwGetCocoaWindow(GLFWwindow *window)
Returns the NSWindow of the specified window.
+
glfwGetWin32Monitor
const char * glfwGetWin32Monitor(GLFWmonitor *monitor)
Returns the display device name of the specified monitor.
+
glfwGetWaylandDisplay
struct wl_display * glfwGetWaylandDisplay(void)
Returns the struct wl_display* used by GLFW.
+
glfwGetWin32Adapter
const char * glfwGetWin32Adapter(GLFWmonitor *monitor)
Returns the adapter device name of the specified monitor.
+
glfwGetWGLContext
HGLRC glfwGetWGLContext(GLFWwindow *window)
Returns the HGLRC of the specified window.
+
glfwGetX11SelectionString
const char * glfwGetX11SelectionString(void)
Returns the contents of the current primary selection as a string.
+
glfwGetCocoaMonitor
CGDirectDisplayID glfwGetCocoaMonitor(GLFWmonitor *monitor)
Returns the CGDirectDisplayID of the specified monitor.
+
glfwGetWin32Window
HWND glfwGetWin32Window(GLFWwindow *window)
Returns the HWND of the specified window.
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__buttons.html b/deps/glfw-3.3.8/docs/html/group__buttons.html new file mode 100644 index 0000000..7f1bb3d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__buttons.html @@ -0,0 +1,275 @@ + + + + + + + +GLFW: Mouse buttons + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Mouse buttons
Input reference
+
+
+

Description

+

See mouse button input for how these are used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_MOUSE_BUTTON_1   0
 
#define GLFW_MOUSE_BUTTON_2   1
 
#define GLFW_MOUSE_BUTTON_3   2
 
#define GLFW_MOUSE_BUTTON_4   3
 
#define GLFW_MOUSE_BUTTON_5   4
 
#define GLFW_MOUSE_BUTTON_6   5
 
#define GLFW_MOUSE_BUTTON_7   6
 
#define GLFW_MOUSE_BUTTON_8   7
 
#define GLFW_MOUSE_BUTTON_LAST   GLFW_MOUSE_BUTTON_8
 
#define GLFW_MOUSE_BUTTON_LEFT   GLFW_MOUSE_BUTTON_1
 
#define GLFW_MOUSE_BUTTON_RIGHT   GLFW_MOUSE_BUTTON_2
 
#define GLFW_MOUSE_BUTTON_MIDDLE   GLFW_MOUSE_BUTTON_3
 
+

Macro Definition Documentation

+ +

◆ GLFW_MOUSE_BUTTON_1

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_1   0
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_2

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_2   1
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_3

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_3   2
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_4

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_4   3
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_5

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_5   4
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_6

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_6   5
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_7

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_7   6
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_8

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_8   7
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_LAST

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_LAST   GLFW_MOUSE_BUTTON_8
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_LEFT

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_LEFT   GLFW_MOUSE_BUTTON_1
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_RIGHT

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_RIGHT   GLFW_MOUSE_BUTTON_2
+
+ +
+
+ +

◆ GLFW_MOUSE_BUTTON_MIDDLE

+ +
+
+ + + + +
#define GLFW_MOUSE_BUTTON_MIDDLE   GLFW_MOUSE_BUTTON_3
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__context.html b/deps/glfw-3.3.8/docs/html/group__context.html new file mode 100644 index 0000000..2913ea0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__context.html @@ -0,0 +1,295 @@ + + + + + + + +GLFW: Context reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Typedefs | +Functions
+
Context reference
+
+
+

Description

+

This is the reference documentation for OpenGL and OpenGL ES context related functions. For more task-oriented information, see the Context guide.

+ + + + + +

+Typedefs

typedef void(* GLFWglproc) (void)
 Client API function pointer type. More...
 
+ + + + + + + + + + + + + + + + +

+Functions

void glfwMakeContextCurrent (GLFWwindow *window)
 Makes the context of the specified window current for the calling thread. More...
 
GLFWwindow * glfwGetCurrentContext (void)
 Returns the window whose context is current on the calling thread. More...
 
void glfwSwapInterval (int interval)
 Sets the swap interval for the current context. More...
 
int glfwExtensionSupported (const char *extension)
 Returns whether the specified extension is available. More...
 
GLFWglproc glfwGetProcAddress (const char *procname)
 Returns the address of the specified function for the current context. More...
 
+

Typedef Documentation

+ +

◆ GLFWglproc

+ +
+
+ + + + +
typedef void(* GLFWglproc) (void)
+
+

Generic function pointer used for returning client API function pointers without forcing a cast from a regular pointer.

+
See also
OpenGL and OpenGL ES extensions
+
+glfwGetProcAddress
+
Since
Added in version 3.0.
+ +
+
+

Function Documentation

+ +

◆ glfwMakeContextCurrent()

+ +
+
+ + + + + + + + +
void glfwMakeContextCurrent (GLFWwindow * window)
+
+

This function makes the OpenGL or OpenGL ES context of the specified window current on the calling thread. 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.

+

When moving a context between threads, you must 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 hint.

+

The specified window must have an OpenGL or OpenGL ES context. Specifying a window without a context will generate a GLFW_NO_WINDOW_CONTEXT error.

+
Parameters
+ + +
[in]windowThe window whose context to make current, or NULL to detach the current context.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.
+
Thread safety
This function may be called from any thread.
+
See also
Current context
+
+glfwGetCurrentContext
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetCurrentContext()

+ +
+
+ + + + + + + + +
GLFWwindow * glfwGetCurrentContext (void )
+
+

This function returns the window whose OpenGL or OpenGL ES context is current on the calling thread.

+
Returns
The window whose context is current, or NULL if no window's context is current.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread.
+
See also
Current context
+
+glfwMakeContextCurrent
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSwapInterval()

+ +
+
+ + + + + + + + +
void glfwSwapInterval (int interval)
+
+

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 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 glfwExtensionSupported.

+

A context must be current on the calling thread. Calling this function without a current context will cause a 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.

+
Parameters
+ + +
[in]intervalThe minimum number of screen updates to wait for until the buffers are swapped by glfwSwapBuffers.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT and GLFW_PLATFORM_ERROR.
+
Remarks
This function is not called during context creation, leaving the swap interval set to whatever is the default on that platform. 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.
+
+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.
+
See also
Buffer swapping
+
+glfwSwapBuffers
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwExtensionSupported()

+ +
+
+ + + + + + + + +
int glfwExtensionSupported (const char * extension)
+
+

This function returns whether the specified API extension 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 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 glfwGetRequiredInstanceExtensions, vkEnumerateInstanceExtensionProperties and vkEnumerateDeviceExtensionProperties instead.

+
Parameters
+ + +
[in]extensionThe ASCII encoded name of the extension.
+
+
+
Returns
GLFW_TRUE if the extension is available, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Thread safety
This function may be called from any thread.
+
See also
OpenGL and OpenGL ES extensions
+
+glfwGetProcAddress
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwGetProcAddress()

+ +
+
+ + + + + + + + +
GLFWglproc glfwGetProcAddress (const char * procname)
+
+

This function returns the address of the specified OpenGL or OpenGL ES core or extension function, 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 GLFW_NO_CURRENT_CONTEXT error.

+

This function does not apply to Vulkan. If you are rendering with Vulkan, see glfwGetInstanceProcAddress, vkGetInstanceProcAddr and vkGetDeviceProcAddr instead.

+
Parameters
+ + +
[in]procnameThe ASCII encoded name of the function.
+
+
+
Returns
The address of the function, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_CURRENT_CONTEXT and GLFW_PLATFORM_ERROR.
+
Remarks
The address of a given function is not guaranteed to be the same between contexts.
+
+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.
+
See also
OpenGL and OpenGL ES extensions
+
+glfwExtensionSupported
+
Since
Added in version 1.0.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__errors.html b/deps/glfw-3.3.8/docs/html/group__errors.html new file mode 100644 index 0000000..3def8eb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__errors.html @@ -0,0 +1,297 @@ + + + + + + + +GLFW: Error codes + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Error codes
Initialization, version and error reference
+
+
+

Description

+

See error handling for how these are used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_NO_ERROR   0
 No error has occurred. More...
 
#define GLFW_NOT_INITIALIZED   0x00010001
 GLFW has not been initialized. More...
 
#define GLFW_NO_CURRENT_CONTEXT   0x00010002
 No context is current for this thread. More...
 
#define GLFW_INVALID_ENUM   0x00010003
 One of the arguments to the function was an invalid enum value. More...
 
#define GLFW_INVALID_VALUE   0x00010004
 One of the arguments to the function was an invalid value. More...
 
#define GLFW_OUT_OF_MEMORY   0x00010005
 A memory allocation failed. More...
 
#define GLFW_API_UNAVAILABLE   0x00010006
 GLFW could not find support for the requested API on the system. More...
 
#define GLFW_VERSION_UNAVAILABLE   0x00010007
 The requested OpenGL or OpenGL ES version is not available. More...
 
#define GLFW_PLATFORM_ERROR   0x00010008
 A platform-specific error occurred that does not match any of the more specific categories. More...
 
#define GLFW_FORMAT_UNAVAILABLE   0x00010009
 The requested format is not supported or available. More...
 
#define GLFW_NO_WINDOW_CONTEXT   0x0001000A
 The specified window does not have an OpenGL or OpenGL ES context. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_NO_ERROR

+ +
+
+ + + + +
#define GLFW_NO_ERROR   0
+
+

No error has occurred.

+
Analysis
Yay.
+ +
+
+ +

◆ GLFW_NOT_INITIALIZED

+ +
+
+ + + + +
#define GLFW_NOT_INITIALIZED   0x00010001
+
+

This occurs if a GLFW function was called that must not be called unless the library is initialized.

+
Analysis
Application programmer error. Initialize GLFW before calling any function that requires initialization.
+ +
+
+ +

◆ GLFW_NO_CURRENT_CONTEXT

+ +
+
+ + + + +
#define GLFW_NO_CURRENT_CONTEXT   0x00010002
+
+

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 glfwSwapInterval.

+
Analysis
Application programmer error. Ensure a context is current before calling functions that require a current context.
+ +
+
+ +

◆ GLFW_INVALID_ENUM

+ +
+
+ + + + +
#define GLFW_INVALID_ENUM   0x00010003
+
+

One of the arguments to the function was an invalid enum value, for example requesting GLFW_RED_BITS with glfwGetWindowAttrib.

+
Analysis
Application programmer error. Fix the offending call.
+ +
+
+ +

◆ GLFW_INVALID_VALUE

+ +
+
+ + + + +
#define GLFW_INVALID_VALUE   0x00010004
+
+

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 GLFW_VERSION_UNAVAILABLE error.

+
Analysis
Application programmer error. Fix the offending call.
+ +
+
+ +

◆ GLFW_OUT_OF_MEMORY

+ +
+
+ + + + +
#define GLFW_OUT_OF_MEMORY   0x00010005
+
+

A memory allocation failed.

+
Analysis
A bug in GLFW or the underlying operating system. Report the bug to our issue tracker.
+ +
+
+ +

◆ GLFW_API_UNAVAILABLE

+ +
+
+ + + + +
#define GLFW_API_UNAVAILABLE   0x00010006
+
+

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 backend. Below are a few examples.
+
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.
+ +
+
+ +

◆ GLFW_VERSION_UNAVAILABLE

+ +
+
+ + + + +
#define GLFW_VERSION_UNAVAILABLE   0x00010007
+
+

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.
+
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 GLFW_INVALID_VALUE, because GLFW cannot know what future versions will exist.
+ +
+
+ +

◆ GLFW_PLATFORM_ERROR

+ +
+
+ + + + +
#define GLFW_PLATFORM_ERROR   0x00010008
+
+

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.
+ +
+
+ +

◆ GLFW_FORMAT_UNAVAILABLE

+ +
+
+ + + + +
#define GLFW_FORMAT_UNAVAILABLE   0x00010009
+
+

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 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.
+
If emitted when querying the clipboard, ignore the error or report it to the user, as appropriate.
+ +
+
+ +

◆ GLFW_NO_WINDOW_CONTEXT

+ +
+
+ + + + +
#define GLFW_NO_WINDOW_CONTEXT   0x0001000A
+
+

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.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html b/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html new file mode 100644 index 0000000..5dc84be --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__gamepad__axes.html @@ -0,0 +1,195 @@ + + + + + + + +GLFW: Gamepad axes + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Gamepad axes
Input reference
+
+
+

Description

+

See Gamepad input for how these are used.

+ + + + + + + + + + + + + + + + +

+Macros

#define GLFW_GAMEPAD_AXIS_LEFT_X   0
 
#define GLFW_GAMEPAD_AXIS_LEFT_Y   1
 
#define GLFW_GAMEPAD_AXIS_RIGHT_X   2
 
#define GLFW_GAMEPAD_AXIS_RIGHT_Y   3
 
#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER   4
 
#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER   5
 
#define GLFW_GAMEPAD_AXIS_LAST   GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
 
+

Macro Definition Documentation

+ +

◆ GLFW_GAMEPAD_AXIS_LEFT_X

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_LEFT_X   0
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_LEFT_Y

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_LEFT_Y   1
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_RIGHT_X

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_RIGHT_X   2
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_RIGHT_Y

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_RIGHT_Y   3
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_LEFT_TRIGGER

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_LEFT_TRIGGER   4
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER   5
+
+ +
+
+ +

◆ GLFW_GAMEPAD_AXIS_LAST

+ +
+
+ + + + +
#define GLFW_GAMEPAD_AXIS_LAST   GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html b/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html new file mode 100644 index 0000000..51c027d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__gamepad__buttons.html @@ -0,0 +1,403 @@ + + + + + + + +GLFW: Gamepad buttons + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Gamepad buttons
Input reference
+
+
+

Description

+

See Gamepad input for how these are used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_GAMEPAD_BUTTON_A   0
 
#define GLFW_GAMEPAD_BUTTON_B   1
 
#define GLFW_GAMEPAD_BUTTON_X   2
 
#define GLFW_GAMEPAD_BUTTON_Y   3
 
#define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER   4
 
#define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER   5
 
#define GLFW_GAMEPAD_BUTTON_BACK   6
 
#define GLFW_GAMEPAD_BUTTON_START   7
 
#define GLFW_GAMEPAD_BUTTON_GUIDE   8
 
#define GLFW_GAMEPAD_BUTTON_LEFT_THUMB   9
 
#define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB   10
 
#define GLFW_GAMEPAD_BUTTON_DPAD_UP   11
 
#define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT   12
 
#define GLFW_GAMEPAD_BUTTON_DPAD_DOWN   13
 
#define GLFW_GAMEPAD_BUTTON_DPAD_LEFT   14
 
#define GLFW_GAMEPAD_BUTTON_LAST   GLFW_GAMEPAD_BUTTON_DPAD_LEFT
 
#define GLFW_GAMEPAD_BUTTON_CROSS   GLFW_GAMEPAD_BUTTON_A
 
#define GLFW_GAMEPAD_BUTTON_CIRCLE   GLFW_GAMEPAD_BUTTON_B
 
#define GLFW_GAMEPAD_BUTTON_SQUARE   GLFW_GAMEPAD_BUTTON_X
 
#define GLFW_GAMEPAD_BUTTON_TRIANGLE   GLFW_GAMEPAD_BUTTON_Y
 
+

Macro Definition Documentation

+ +

◆ GLFW_GAMEPAD_BUTTON_A

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_A   0
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_B

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_B   1
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_X

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_X   2
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_Y

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_Y   3
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_LEFT_BUMPER

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_LEFT_BUMPER   4
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER   5
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_BACK

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_BACK   6
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_START

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_START   7
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_GUIDE

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_GUIDE   8
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_LEFT_THUMB

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_LEFT_THUMB   9
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_RIGHT_THUMB

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_RIGHT_THUMB   10
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_DPAD_UP

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_DPAD_UP   11
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_DPAD_RIGHT

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_DPAD_RIGHT   12
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_DPAD_DOWN

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_DPAD_DOWN   13
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_DPAD_LEFT

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_DPAD_LEFT   14
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_LAST

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_LAST   GLFW_GAMEPAD_BUTTON_DPAD_LEFT
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_CROSS

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_CROSS   GLFW_GAMEPAD_BUTTON_A
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_CIRCLE

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_CIRCLE   GLFW_GAMEPAD_BUTTON_B
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_SQUARE

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_SQUARE   GLFW_GAMEPAD_BUTTON_X
+
+ +
+
+ +

◆ GLFW_GAMEPAD_BUTTON_TRIANGLE

+ +
+
+ + + + +
#define GLFW_GAMEPAD_BUTTON_TRIANGLE   GLFW_GAMEPAD_BUTTON_Y
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__hat__state.html b/deps/glfw-3.3.8/docs/html/group__hat__state.html new file mode 100644 index 0000000..d08f541 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__hat__state.html @@ -0,0 +1,227 @@ + + + + + + + +GLFW: Joystick hat states + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Joystick hat states
Input reference
+
+
+

Description

+

See joystick hat input for how these are used.

+ + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_HAT_CENTERED   0
 
#define GLFW_HAT_UP   1
 
#define GLFW_HAT_RIGHT   2
 
#define GLFW_HAT_DOWN   4
 
#define GLFW_HAT_LEFT   8
 
#define GLFW_HAT_RIGHT_UP   (GLFW_HAT_RIGHT | GLFW_HAT_UP)
 
#define GLFW_HAT_RIGHT_DOWN   (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)
 
#define GLFW_HAT_LEFT_UP   (GLFW_HAT_LEFT | GLFW_HAT_UP)
 
#define GLFW_HAT_LEFT_DOWN   (GLFW_HAT_LEFT | GLFW_HAT_DOWN)
 
+

Macro Definition Documentation

+ +

◆ GLFW_HAT_CENTERED

+ +
+
+ + + + +
#define GLFW_HAT_CENTERED   0
+
+ +
+
+ +

◆ GLFW_HAT_UP

+ +
+
+ + + + +
#define GLFW_HAT_UP   1
+
+ +
+
+ +

◆ GLFW_HAT_RIGHT

+ +
+
+ + + + +
#define GLFW_HAT_RIGHT   2
+
+ +
+
+ +

◆ GLFW_HAT_DOWN

+ +
+
+ + + + +
#define GLFW_HAT_DOWN   4
+
+ +
+
+ +

◆ GLFW_HAT_LEFT

+ +
+
+ + + + +
#define GLFW_HAT_LEFT   8
+
+ +
+
+ +

◆ GLFW_HAT_RIGHT_UP

+ +
+
+ + + + +
#define GLFW_HAT_RIGHT_UP   (GLFW_HAT_RIGHT | GLFW_HAT_UP)
+
+ +
+
+ +

◆ GLFW_HAT_RIGHT_DOWN

+ +
+
+ + + + +
#define GLFW_HAT_RIGHT_DOWN   (GLFW_HAT_RIGHT | GLFW_HAT_DOWN)
+
+ +
+
+ +

◆ GLFW_HAT_LEFT_UP

+ +
+
+ + + + +
#define GLFW_HAT_LEFT_UP   (GLFW_HAT_LEFT | GLFW_HAT_UP)
+
+ +
+
+ +

◆ GLFW_HAT_LEFT_DOWN

+ +
+
+ + + + +
#define GLFW_HAT_LEFT_DOWN   (GLFW_HAT_LEFT | GLFW_HAT_DOWN)
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__init.html b/deps/glfw-3.3.8/docs/html/group__init.html new file mode 100644 index 0000000..944700b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__init.html @@ -0,0 +1,545 @@ + + + + + + + +GLFW: Initialization, version and error reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Modules | +Macros | +Typedefs | +Functions
+
Initialization, version and error reference
+
+
+

Description

+

This is the reference documentation for initialization and termination of the library, version management and error handling. For more task-oriented information, see the Introduction to the API.

+ + + + + +

+Modules

 Error codes
 Error codes.
 
+ + + + + + + + + + + + + + + + +

+Macros

#define GLFW_TRUE   1
 One. More...
 
#define GLFW_FALSE   0
 Zero. More...
 
#define GLFW_JOYSTICK_HAT_BUTTONS   0x00050001
 Joystick hat buttons init hint. More...
 
#define GLFW_COCOA_CHDIR_RESOURCES   0x00051001
 macOS specific init hint. More...
 
#define GLFW_COCOA_MENUBAR   0x00051002
 macOS specific init hint. More...
 
+ + + + +

+Typedefs

typedef void(* GLFWerrorfun) (int error_code, const char *description)
 The function pointer type for error callbacks. More...
 
+ + + + + + + + + + + + + + + + + + + + + + +

+Functions

int glfwInit (void)
 Initializes the GLFW library. More...
 
void glfwTerminate (void)
 Terminates the GLFW library. More...
 
void glfwInitHint (int hint, int value)
 Sets the specified init hint to the desired value. More...
 
void glfwGetVersion (int *major, int *minor, int *rev)
 Retrieves the version of the GLFW library. More...
 
const char * glfwGetVersionString (void)
 Returns a string describing the compile-time configuration. More...
 
int glfwGetError (const char **description)
 Returns and clears the last error for the calling thread. More...
 
GLFWerrorfun glfwSetErrorCallback (GLFWerrorfun callback)
 Sets the error callback. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_VERSION_MAJOR

+ +
+
+ + + + +
#define GLFW_VERSION_MAJOR   3
+
+

The major version number of the GLFW header. This is incremented when the API is changed in non-compatible ways.

+ +
+
+ +

◆ GLFW_VERSION_MINOR

+ +
+
+ + + + +
#define GLFW_VERSION_MINOR   3
+
+

The minor version number of the GLFW header. This is incremented when features are added to the API but it remains backward-compatible.

+ +
+
+ +

◆ GLFW_VERSION_REVISION

+ +
+
+ + + + +
#define GLFW_VERSION_REVISION   8
+
+

The revision number of the GLFW header. This is incremented when a bug fix release is made that does not contain any API changes.

+ +
+
+ +

◆ GLFW_TRUE

+ +
+
+ + + + +
#define GLFW_TRUE   1
+
+

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.

+ +
+
+ +

◆ GLFW_FALSE

+ +
+
+ + + + +
#define GLFW_FALSE   0
+
+

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.

+ +
+
+ +

◆ GLFW_JOYSTICK_HAT_BUTTONS

+ +
+
+ + + + +
#define GLFW_JOYSTICK_HAT_BUTTONS   0x00050001
+
+

Joystick hat buttons init hint.

+ +
+
+ +

◆ GLFW_COCOA_CHDIR_RESOURCES

+ +
+
+ + + + +
#define GLFW_COCOA_CHDIR_RESOURCES   0x00051001
+
+

macOS specific init hint.

+ +
+
+ +

◆ GLFW_COCOA_MENUBAR

+ +
+
+ + + + +
#define GLFW_COCOA_MENUBAR   0x00051002
+
+

macOS specific init hint.

+ +
+
+

Typedef Documentation

+ +

◆ GLFWerrorfun

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

This is the function pointer type for error callbacks. An error callback function has the following signature:

void callback_name(int error_code, const char* description)
+
Parameters
+ + + +
[in]error_codeAn error code. Future releases may add more error codes.
[in]descriptionA UTF-8 encoded string describing the error.
+
+
+
Pointer lifetime
The error description string is valid until the callback function returns.
+
See also
Error handling
+
+glfwSetErrorCallback
+
Since
Added in version 3.0.
+ +
+
+

Function Documentation

+ +

◆ glfwInit()

+ +
+
+ + + + + + + + +
int glfwInit (void )
+
+

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 glfwTerminate before returning. If it succeeds, you should call glfwTerminate before the application exits.

+

Additional calls to this function after successful initialization but before termination will return GLFW_TRUE immediately.

+
Returns
GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.
+
Errors
Possible errors include GLFW_PLATFORM_ERROR.
+
Remarks
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 GLFW_COCOA_CHDIR_RESOURCES init hint.
+
+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.
+
See also
Initialization and termination
+
+glfwTerminate
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwTerminate()

+ +
+
+ + + + + + + + +
void glfwTerminate (void )
+
+

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 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 glfwInit before it returns failure.

+

This function has no effect if GLFW is not initialized.

+
Errors
Possible errors include GLFW_PLATFORM_ERROR.
+
Remarks
This function may be called before 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.
+
See also
Initialization and termination
+
+glfwInit
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwInitHint()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwInitHint (int hint,
int 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.

+
Parameters
+ + + +
[in]hintThe init hint to set.
[in]valueThe new value of the init hint.
+
+
+
Errors
Possible errors include GLFW_INVALID_ENUM and GLFW_INVALID_VALUE.
+
Remarks
This function may be called before glfwInit.
+
Thread safety
This function must only be called from the main thread.
+
See also
init_hints
+
+glfwInit
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetVersion()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetVersion (int * major,
int * minor,
int * rev 
)
+
+

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.

+
Parameters
+ + + + +
[out]majorWhere to store the major version number, or NULL.
[out]minorWhere to store the minor version number, or NULL.
[out]revWhere to store the revision number, or NULL.
+
+
+
Errors
None.
+
Remarks
This function may be called before glfwInit.
+
Thread safety
This function may be called from any thread.
+
See also
Version management
+
+glfwGetVersionString
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwGetVersionString()

+ +
+
+ + + + + + + + +
const char * glfwGetVersionString (void )
+
+

This function returns the compile-time generated version string of the GLFW library binary. It describes the version, platform, compiler and any platform-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 glfwGetVersion function provides the version of the running library binary in numerical format.

+
Returns
The ASCII encoded GLFW version string.
+
Errors
None.
+
Remarks
This function may be called before glfwInit.
+
Pointer lifetime
The returned string is static and compile-time generated.
+
Thread safety
This function may be called from any thread.
+
See also
Version management
+
+glfwGetVersion
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetError()

+ +
+
+ + + + + + + + +
int glfwGetError (const char ** description)
+
+

This function returns and clears the error code 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 GLFW_NO_ERROR (zero) and the description pointer is set to NULL.

+
Parameters
+ + +
[in]descriptionWhere to store the error description pointer, or NULL.
+
+
+
Returns
The last error code for the calling thread, or 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.
+
Remarks
This function may be called before glfwInit.
+
Thread safety
This function may be called from any thread.
+
See also
Error handling
+
+glfwSetErrorCallback
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetErrorCallback()

+ +
+
+ + + + + + + + +
GLFWerrorfun glfwSetErrorCallback (GLFWerrorfun 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 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.

+
Parameters
+ + +
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set.
+
Callback signature
void callback_name(int error_code, const char* description)
+
For more information about the callback parameters, see the callback pointer type.
+
Errors
None.
+
Remarks
This function may be called before glfwInit.
+
Thread safety
This function must only be called from the main thread.
+
See also
Error handling
+
+glfwGetError
+
Since
Added in version 3.0.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__input.html b/deps/glfw-3.3.8/docs/html/group__input.html new file mode 100644 index 0000000..18cf6f2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__input.html @@ -0,0 +1,2228 @@ + + + + + + + +GLFW: Input reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Modules | +Typedefs | +Functions
+
Input reference
+
+
+

Description

+

This is the reference documentation for input related functions and types. For more task-oriented information, see the Input guide.

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Modules

 Gamepad axes
 Gamepad axes.
 
 Gamepad buttons
 Gamepad buttons.
 
 Joystick hat states
 Joystick hat states.
 
 Joysticks
 Joystick IDs.
 
 Keyboard keys
 Keyboard key IDs.
 
 Modifier key flags
 Modifier key flags.
 
 Mouse buttons
 Mouse button IDs.
 
 Standard cursor shapes
 Standard system cursor shapes.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Typedefs

typedef struct GLFWcursor GLFWcursor
 Opaque cursor object. More...
 
typedef void(* GLFWmousebuttonfun) (GLFWwindow *window, int button, int action, int mods)
 The function pointer type for mouse button callbacks. More...
 
typedef void(* GLFWcursorposfun) (GLFWwindow *window, double xpos, double ypos)
 The function pointer type for cursor position callbacks. More...
 
typedef void(* GLFWcursorenterfun) (GLFWwindow *window, int entered)
 The function pointer type for cursor enter/leave callbacks. More...
 
typedef void(* GLFWscrollfun) (GLFWwindow *window, double xoffset, double yoffset)
 The function pointer type for scroll callbacks. More...
 
typedef void(* GLFWkeyfun) (GLFWwindow *window, int key, int scancode, int action, int mods)
 The function pointer type for keyboard key callbacks. More...
 
typedef void(* GLFWcharfun) (GLFWwindow *window, unsigned int codepoint)
 The function pointer type for Unicode character callbacks. More...
 
typedef void(* GLFWcharmodsfun) (GLFWwindow *window, unsigned int codepoint, int mods)
 The function pointer type for Unicode character with modifiers callbacks. More...
 
typedef void(* GLFWdropfun) (GLFWwindow *window, int path_count, const char *paths[])
 The function pointer type for path drop callbacks. More...
 
typedef void(* GLFWjoystickfun) (int jid, int event)
 The function pointer type for joystick configuration callbacks. More...
 
typedef struct GLFWgamepadstate GLFWgamepadstate
 Gamepad input state. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

int glfwGetInputMode (GLFWwindow *window, int mode)
 Returns the value of an input option for the specified window. More...
 
void glfwSetInputMode (GLFWwindow *window, int mode, int value)
 Sets an input option for the specified window. More...
 
int glfwRawMouseMotionSupported (void)
 Returns whether raw mouse motion is supported. More...
 
const char * glfwGetKeyName (int key, int scancode)
 Returns the layout-specific name of the specified printable key. More...
 
int glfwGetKeyScancode (int key)
 Returns the platform-specific scancode of the specified key. More...
 
int glfwGetKey (GLFWwindow *window, int key)
 Returns the last reported state of a keyboard key for the specified window. More...
 
int glfwGetMouseButton (GLFWwindow *window, int button)
 Returns the last reported state of a mouse button for the specified window. More...
 
void glfwGetCursorPos (GLFWwindow *window, double *xpos, double *ypos)
 Retrieves the position of the cursor relative to the content area of the window. More...
 
void glfwSetCursorPos (GLFWwindow *window, double xpos, double ypos)
 Sets the position of the cursor, relative to the content area of the window. More...
 
GLFWcursor * glfwCreateCursor (const GLFWimage *image, int xhot, int yhot)
 Creates a custom cursor. More...
 
GLFWcursor * glfwCreateStandardCursor (int shape)
 Creates a cursor with a standard shape. More...
 
void glfwDestroyCursor (GLFWcursor *cursor)
 Destroys a cursor. More...
 
void glfwSetCursor (GLFWwindow *window, GLFWcursor *cursor)
 Sets the cursor for the window. More...
 
GLFWkeyfun glfwSetKeyCallback (GLFWwindow *window, GLFWkeyfun callback)
 Sets the key callback. More...
 
GLFWcharfun glfwSetCharCallback (GLFWwindow *window, GLFWcharfun callback)
 Sets the Unicode character callback. More...
 
GLFWcharmodsfun glfwSetCharModsCallback (GLFWwindow *window, GLFWcharmodsfun callback)
 Sets the Unicode character with modifiers callback. More...
 
GLFWmousebuttonfun glfwSetMouseButtonCallback (GLFWwindow *window, GLFWmousebuttonfun callback)
 Sets the mouse button callback. More...
 
GLFWcursorposfun glfwSetCursorPosCallback (GLFWwindow *window, GLFWcursorposfun callback)
 Sets the cursor position callback. More...
 
GLFWcursorenterfun glfwSetCursorEnterCallback (GLFWwindow *window, GLFWcursorenterfun callback)
 Sets the cursor enter/leave callback. More...
 
GLFWscrollfun glfwSetScrollCallback (GLFWwindow *window, GLFWscrollfun callback)
 Sets the scroll callback. More...
 
GLFWdropfun glfwSetDropCallback (GLFWwindow *window, GLFWdropfun callback)
 Sets the path drop callback. More...
 
int glfwJoystickPresent (int jid)
 Returns whether the specified joystick is present. More...
 
const float * glfwGetJoystickAxes (int jid, int *count)
 Returns the values of all axes of the specified joystick. More...
 
const unsigned char * glfwGetJoystickButtons (int jid, int *count)
 Returns the state of all buttons of the specified joystick. More...
 
const unsigned char * glfwGetJoystickHats (int jid, int *count)
 Returns the state of all hats of the specified joystick. More...
 
const char * glfwGetJoystickName (int jid)
 Returns the name of the specified joystick. More...
 
const char * glfwGetJoystickGUID (int jid)
 Returns the SDL compatible GUID of the specified joystick. More...
 
void glfwSetJoystickUserPointer (int jid, void *pointer)
 Sets the user pointer of the specified joystick. More...
 
void * glfwGetJoystickUserPointer (int jid)
 Returns the user pointer of the specified joystick. More...
 
int glfwJoystickIsGamepad (int jid)
 Returns whether the specified joystick has a gamepad mapping. More...
 
GLFWjoystickfun glfwSetJoystickCallback (GLFWjoystickfun callback)
 Sets the joystick configuration callback. More...
 
int glfwUpdateGamepadMappings (const char *string)
 Adds the specified SDL_GameControllerDB gamepad mappings. More...
 
const char * glfwGetGamepadName (int jid)
 Returns the human-readable gamepad name for the specified joystick. More...
 
int glfwGetGamepadState (int jid, GLFWgamepadstate *state)
 Retrieves the state of the specified joystick remapped as a gamepad. More...
 
void glfwSetClipboardString (GLFWwindow *window, const char *string)
 Sets the clipboard to the specified string. More...
 
const char * glfwGetClipboardString (GLFWwindow *window)
 Returns the contents of the clipboard as a string. More...
 
double glfwGetTime (void)
 Returns the GLFW time. More...
 
void glfwSetTime (double time)
 Sets the GLFW time. More...
 
uint64_t glfwGetTimerValue (void)
 Returns the current value of the raw timer. More...
 
uint64_t glfwGetTimerFrequency (void)
 Returns the frequency, in Hz, of the raw timer. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_RELEASE

+ +
+
+ + + + +
#define GLFW_RELEASE   0
+
+

The key or mouse button was released.

+ +
+
+ +

◆ GLFW_PRESS

+ +
+
+ + + + +
#define GLFW_PRESS   1
+
+

The key or mouse button was pressed.

+ +
+
+ +

◆ GLFW_REPEAT

+ +
+
+ + + + +
#define GLFW_REPEAT   2
+
+

The key was held down until it repeated.

+ +
+
+

Typedef Documentation

+ +

◆ GLFWcursor

+ +
+
+ + + + +
typedef struct GLFWcursor GLFWcursor
+
+

Opaque cursor object.

+
See also
Cursor objects
+
Since
Added in version 3.1.
+ +
+
+ +

◆ GLFWmousebuttonfun

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

This is the function pointer type for mouse button callback functions. A mouse button callback function has the following signature:

void function_name(GLFWwindow* window, int button, int action, int mods)
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+
Parameters
+ + + + + +
[in]windowThe window that received the event.
[in]buttonThe mouse button that was pressed or released.
[in]actionOne of GLFW_PRESS or GLFW_RELEASE. Future releases may add more actions.
[in]modsBit field describing which modifier keys were held down.
+
+
+
See also
Mouse button input
+
+glfwSetMouseButtonCallback
+
Since
Added in version 1.0. GLFW 3: Added window handle and modifier mask parameters.
+ +
+
+ +

◆ GLFWcursorposfun

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

This is the function pointer type for cursor position callbacks. A cursor position callback function has the following signature:

void function_name(GLFWwindow* window, double xpos, double ypos);
+
Parameters
+ + + + +
[in]windowThe window that received the event.
[in]xposThe new cursor x-coordinate, relative to the left edge of the content area.
[in]yposThe new cursor y-coordinate, relative to the top edge of the content area.
+
+
+
See also
Cursor position
+
+glfwSetCursorPosCallback
+
Since
Added in version 3.0. Replaces GLFWmouseposfun.
+ +
+
+ +

◆ GLFWcursorenterfun

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

This is the function pointer type for cursor enter/leave callbacks. A cursor enter/leave callback function has the following signature:

void function_name(GLFWwindow* window, int entered)
+
Parameters
+ + + +
[in]windowThe window that received the event.
[in]enteredGLFW_TRUE if the cursor entered the window's content area, or GLFW_FALSE if it left it.
+
+
+
See also
Cursor enter/leave events
+
+glfwSetCursorEnterCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWscrollfun

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

This is the function pointer type for scroll callbacks. A scroll callback function has the following signature:

void function_name(GLFWwindow* window, double xoffset, double yoffset)
+
Parameters
+ + + + +
[in]windowThe window that received the event.
[in]xoffsetThe scroll offset along the x-axis.
[in]yoffsetThe scroll offset along the y-axis.
+
+
+
See also
Scroll input
+
+glfwSetScrollCallback
+
Since
Added in version 3.0. Replaces GLFWmousewheelfun.
+ +
+
+ +

◆ GLFWkeyfun

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

This is the function pointer type for keyboard key callbacks. A keyboard key callback function has the following signature:

void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
+
Parameters
+ + + + + + +
[in]windowThe window that received the event.
[in]keyThe keyboard key that was pressed or released.
[in]scancodeThe system-specific scancode of the key.
[in]actionGLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT. Future releases may add more actions.
[in]modsBit field describing which modifier keys were held down.
+
+
+
See also
Key input
+
+glfwSetKeyCallback
+
Since
Added in version 1.0. GLFW 3: Added window handle, scancode and modifier mask parameters.
+ +
+
+ +

◆ GLFWcharfun

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

This is the function pointer type for Unicode character callbacks. A Unicode character callback function has the following signature:

void function_name(GLFWwindow* window, unsigned int codepoint)
+
Parameters
+ + + +
[in]windowThe window that received the event.
[in]codepointThe Unicode code point of the character.
+
+
+
See also
Text input
+
+glfwSetCharCallback
+
Since
Added in version 2.4. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ GLFWcharmodsfun

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

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:

void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
+
Parameters
+ + + + +
[in]windowThe window that received the event.
[in]codepointThe Unicode code point of the character.
[in]modsBit field describing which modifier keys were held down.
+
+
+
See also
Text input
+
+glfwSetCharModsCallback
+
Deprecated:
Scheduled for removal in version 4.0.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ GLFWdropfun

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

This is the function pointer type for path drop callbacks. A path drop callback function has the following signature:

void function_name(GLFWwindow* window, int path_count, const char* paths[])
+
Parameters
+ + + + +
[in]windowThe window that received the event.
[in]path_countThe number of dropped paths.
[in]pathsThe UTF-8 encoded file and/or directory path names.
+
+
+
Pointer lifetime
The path array and its strings are valid until the callback function returns.
+
See also
Path drop input
+
+glfwSetDropCallback
+
Since
Added in version 3.1.
+ +
+
+ +

◆ GLFWjoystickfun

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

This is the function pointer type for joystick configuration callbacks. A joystick configuration callback function has the following signature:

void function_name(int jid, int event)
+
Parameters
+ + + +
[in]jidThe joystick that was connected or disconnected.
[in]eventOne of GLFW_CONNECTED or GLFW_DISCONNECTED. Future releases may add more events.
+
+
+
See also
Joystick configuration changes
+
+glfwSetJoystickCallback
+
Since
Added in version 3.2.
+ +
+
+ +

◆ GLFWgamepadstate

+ +
+
+ + + + +
typedef struct GLFWgamepadstate GLFWgamepadstate
+
+

This describes the input state of a gamepad.

+
See also
Gamepad input
+
+glfwGetGamepadState
+
Since
Added in version 3.3.
+ +
+
+

Function Documentation

+ +

◆ glfwGetInputMode()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int glfwGetInputMode (GLFWwindow * window,
int mode 
)
+
+

This function returns the value of an input option for the specified window. The mode must be one of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.

+
Parameters
+ + + +
[in]windowThe window to query.
[in]modeOne of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
glfwSetInputMode
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetInputMode()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetInputMode (GLFWwindow * window,
int mode,
int value 
)
+
+

This function sets an input mode option for the specified window. The mode must be one of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.

+

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.
    • +
+

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 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 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 GLFW_MOD_CAPS_LOCK bit set when the event was generated with Caps Lock on, and the 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 GLFW_PLATFORM_ERROR. Call glfwRawMouseMotionSupported to check for support.

+
Parameters
+ + + + +
[in]windowThe window whose input mode to set.
[in]modeOne of GLFW_CURSOR, GLFW_STICKY_KEYS, GLFW_STICKY_MOUSE_BUTTONS, GLFW_LOCK_KEY_MODS or GLFW_RAW_MOUSE_MOTION.
[in]valueThe new value of the specified input mode.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
glfwGetInputMode
+
Since
Added in version 3.0. Replaces glfwEnable and glfwDisable.
+ +
+
+ +

◆ glfwRawMouseMotionSupported()

+ +
+
+ + + + + + + + +
int glfwRawMouseMotionSupported (void )
+
+

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, 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.

+
Returns
GLFW_TRUE if raw mouse motion is supported on the current machine, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Raw mouse motion
+
+glfwSetInputMode
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetKeyName()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const char * glfwGetKeyName (int key,
int scancode 
)
+
+

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. 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 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.

+
Parameters
+ + + +
[in]keyThe key to query, or GLFW_KEY_UNKNOWN.
[in]scancodeThe scancode of the key to query.
+
+
+
Returns
The UTF-8 encoded, layout-specific name of the key, or NULL.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
See also
Key names
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetKeyScancode()

+ +
+
+ + + + + + + + +
int glfwGetKeyScancode (int key)
+
+

This function returns the platform-specific scancode of the specified key.

+

If the key is GLFW_KEY_UNKNOWN or does not exist on the keyboard this method will return -1.

+
Parameters
+ + +
[in]keyAny named key.
+
+
+
Returns
The platform-specific scancode for the key, or -1 if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
+
Thread safety
This function may be called from any thread.
+
See also
Key input
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetKey()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int glfwGetKey (GLFWwindow * window,
int key 
)
+
+

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 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 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 are not key tokens and cannot be used with this function.

+

Do not use this function to implement text input.

+
Parameters
+ + + +
[in]windowThe desired window.
[in]keyThe desired keyboard key. GLFW_KEY_UNKNOWN is not a valid key for this function.
+
+
+
Returns
One of GLFW_PRESS or GLFW_RELEASE.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
Key input
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwGetMouseButton()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int glfwGetMouseButton (GLFWwindow * window,
int button 
)
+
+

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 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.

+
Parameters
+ + + +
[in]windowThe desired window.
[in]buttonThe desired mouse button.
+
+
+
Returns
One of GLFW_PRESS or GLFW_RELEASE.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
Mouse button input
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwGetCursorPos()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetCursorPos (GLFWwindow * window,
double * xpos,
double * ypos 
)
+
+

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.

+
Parameters
+ + + + +
[in]windowThe desired window.
[out]xposWhere to store the cursor x-coordinate, relative to the left edge of the content area, or NULL.
[out]yposWhere to store the cursor y-coordinate, relative to the to top edge of the content area, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor position
+
+glfwSetCursorPos
+
Since
Added in version 3.0. Replaces glfwGetMousePos.
+ +
+
+ +

◆ glfwSetCursorPos()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetCursorPos (GLFWwindow * window,
double xpos,
double ypos 
)
+
+

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 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.

+
Parameters
+ + + + +
[in]windowThe desired window.
[in]xposThe desired x-coordinate, relative to the left edge of the content area.
[in]yposThe desired y-coordinate, relative to the top edge of the content area.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: This function will only work when the cursor mode is GLFW_CURSOR_DISABLED, otherwise it will do nothing.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor position
+
+glfwGetCursorPos
+
Since
Added in version 3.0. Replaces glfwSetMousePos.
+ +
+
+ +

◆ glfwCreateCursor()

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

Creates a new custom cursor image that can be set for a window with glfwSetCursor. The cursor can be destroyed with glfwDestroyCursor. Any remaining cursors are destroyed by 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.

+
Parameters
+ + + + +
[in]imageThe desired cursor image.
[in]xhotThe desired x-coordinate, in pixels, of the cursor hotspot.
[in]yhotThe desired y-coordinate, in pixels, of the cursor hotspot.
+
+
+
Returns
The handle of the created cursor, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and 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.
+
See also
Cursor objects
+
+glfwDestroyCursor
+
+glfwCreateStandardCursor
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwCreateStandardCursor()

+ +
+
+ + + + + + + + +
GLFWcursor * glfwCreateStandardCursor (int shape)
+
+

Returns a cursor with a standard shape, that can be set for a window with glfwSetCursor.

+
Parameters
+ + +
[in]shapeOne of the standard shapes.
+
+
+
Returns
A new cursor ready to use or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor objects
+
+glfwCreateCursor
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwDestroyCursor()

+ +
+
+ + + + + + + + +
void glfwDestroyCursor (GLFWcursor * cursor)
+
+

This function destroys a cursor previously created with glfwCreateCursor. Any remaining cursors will be destroyed by 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.

+
Parameters
+ + +
[in]cursorThe cursor object to destroy.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Cursor objects
+
+glfwCreateCursor
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwSetCursor()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetCursor (GLFWwindow * window,
GLFWcursor * cursor 
)
+
+

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 of the window is GLFW_CURSOR_NORMAL.

+

On some platforms, the set cursor may not be visible unless the window also has input focus.

+
Parameters
+ + + +
[in]windowThe window to set the cursor for.
[in]cursorThe cursor to set, or NULL to switch back to the default arrow cursor.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor objects
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwSetKeyCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWkeyfun glfwSetKeyCallback (GLFWwindow * window,
GLFWkeyfun 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 named after their values in the standard US keyboard layout. If you want to input text, use the character callback instead.

+

When a window loses input focus, it will generate synthetic key release events for all pressed keys. 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 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 glfwGetKey.

+

Sometimes GLFW needs to generate synthetic key events, in which case the scancode may be zero.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new key callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int key, int scancode, int action, int mods)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Key input
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetCharCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWcharfun glfwSetCharCallback (GLFWwindow * window,
GLFWcharfun 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 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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, unsigned int codepoint)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Text input
+
Since
Added in version 2.4. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetCharModsCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWcharmodsfun glfwSetCharModsCallback (GLFWwindow * window,
GLFWcharmodsfun 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. 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 instead.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or an error occurred.
+
Callback signature
void function_name(GLFWwindow* window, unsigned int codepoint, int mods)
+
For more information about the callback parameters, see the function pointer type.
+
Deprecated:
Scheduled for removal in version 4.0.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Text input
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwSetMouseButtonCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWmousebuttonfun glfwSetMouseButtonCallback (GLFWwindow * window,
GLFWmousebuttonfun 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. 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 has been called.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int button, int action, int mods)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Mouse button input
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetCursorPosCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWcursorposfun glfwSetCursorPosCallback (GLFWwindow * window,
GLFWcursorposfun 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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, double xpos, double ypos);
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor position
+
Since
Added in version 3.0. Replaces glfwSetMousePosCallback.
+ +
+
+ +

◆ glfwSetCursorEnterCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWcursorenterfun glfwSetCursorEnterCallback (GLFWwindow * window,
GLFWcursorenterfun 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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int entered)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Cursor enter/leave events
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetScrollCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWscrollfun glfwSetScrollCallback (GLFWwindow * window,
GLFWscrollfun 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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new scroll callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, double xoffset, double yoffset)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Scroll input
+
Since
Added in version 3.0. Replaces glfwSetMouseWheelCallback.
+ +
+
+ +

◆ glfwSetDropCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWdropfun glfwSetDropCallback (GLFWwindow * window,
GLFWdropfun 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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new file drop callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int path_count, const char* paths[])
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
Wayland: File drop is currently unimplemented.
+
Thread safety
This function must only be called from the main thread.
+
See also
Path drop input
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwJoystickPresent()

+ +
+
+ + + + + + + + +
int glfwJoystickPresent (int jid)
+
+

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.

+
Parameters
+ + +
[in]jidThe joystick to query.
+
+
+
Returns
GLFW_TRUE if the joystick is present, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Joystick input
+
Since
Added in version 3.0. Replaces glfwGetJoystickParam.
+ +
+
+ +

◆ glfwGetJoystickAxes()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const float * glfwGetJoystickAxes (int jid,
int * count 
)
+
+

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 glfwJoystickPresent.

+
Parameters
+ + + +
[in]jidThe joystick to query.
[out]countWhere 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.
+
+
+
Returns
An array of axis values, or NULL if the joystick is not present or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and 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.
+
See also
Joystick axis states
+
Since
Added in version 3.0. Replaces glfwGetJoystickPos.
+ +
+
+ +

◆ glfwGetJoystickButtons()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const unsigned char * glfwGetJoystickButtons (int jid,
int * count 
)
+
+

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 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 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 glfwJoystickPresent.

+
Parameters
+ + + +
[in]jidThe joystick to query.
[out]countWhere 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.
+
+
+
Returns
An array of button states, or NULL if the joystick is not present or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and 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.
+
See also
Joystick button states
+
Since
Added in version 2.2. GLFW 3: Changed to return a dynamic array.
+ +
+
+ +

◆ glfwGetJoystickHats()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const unsigned char * glfwGetJoystickHats (int jid,
int * count 
)
+
+

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.

+
if (hats[2] & GLFW_HAT_RIGHT)
+
{
+
// State of hat 2 could be right-up, right or right-down
+
}
+
GLFW_HAT_RIGHT
#define GLFW_HAT_RIGHT
Definition: glfw3.h:357
+

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 glfwJoystickPresent.

+
Parameters
+ + + +
[in]jidThe joystick to query.
[out]countWhere 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.
+
+
+
Returns
An array of hat states, or NULL if the joystick is not present or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and 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.
+
See also
Joystick hat states
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetJoystickName()

+ +
+
+ + + + + + + + +
const char * glfwGetJoystickName (int jid)
+
+

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 glfwJoystickPresent.

+
Parameters
+ + +
[in]jidThe joystick to query.
+
+
+
Returns
The UTF-8 encoded name of the joystick, or NULL if the joystick is not present or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and 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.
+
See also
Joystick name
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetJoystickGUID()

+ +
+
+ + + + + + + + +
const char * glfwGetJoystickGUID (int jid)
+
+

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 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.

+
Parameters
+ + +
[in]jidThe joystick to query.
+
+
+
Returns
The UTF-8 encoded GUID of the joystick, or NULL if the joystick is not present or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and 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.
+
See also
Gamepad input
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetJoystickUserPointer()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetJoystickUserPointer (int jid,
void * pointer 
)
+
+

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.

+
Parameters
+ + + +
[in]jidThe joystick whose pointer to set.
[in]pointerThe new value.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
Joystick user pointer
+
+glfwGetJoystickUserPointer
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetJoystickUserPointer()

+ +
+
+ + + + + + + + +
void * glfwGetJoystickUserPointer (int jid)
+
+

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.

+
Parameters
+ + +
[in]jidThe joystick whose pointer to return.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
Joystick user pointer
+
+glfwSetJoystickUserPointer
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwJoystickIsGamepad()

+ +
+
+ + + + + + + + +
int glfwJoystickIsGamepad (int jid)
+
+

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 glfwJoystickPresent to check if a joystick is present regardless of whether it has a mapping.

+
Parameters
+ + +
[in]jidThe joystick to query.
+
+
+
Returns
GLFW_TRUE if a joystick is both present and has a gamepad mapping, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
Gamepad input
+
+glfwGetGamepadState
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetJoystickCallback()

+ +
+
+ + + + + + + + +
GLFWjoystickfun glfwSetJoystickCallback (GLFWjoystickfun 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 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.

+
Parameters
+ + +
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(int jid, int event)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Joystick configuration changes
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwUpdateGamepadMappings()

+ +
+
+ + + + + + + + +
int glfwUpdateGamepadMappings (const char * string)
+
+

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 Gamepad mappings 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.

+
Parameters
+ + +
[in]stringThe string containing the gamepad mappings.
+
+
+
Returns
GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_VALUE.
+
Thread safety
This function must only be called from the main thread.
+
See also
Gamepad input
+
+glfwJoystickIsGamepad
+
+glfwGetGamepadName
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetGamepadName()

+ +
+
+ + + + + + + + +
const char * glfwGetGamepadName (int jid)
+
+

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 glfwJoystickPresent to check whether it is present regardless of whether it has a mapping.

+
Parameters
+ + +
[in]jidThe joystick to query.
+
+
+
Returns
The UTF-8 encoded name of the gamepad, or NULL if the joystick is not present, does not have a mapping or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Gamepad input
+
+glfwJoystickIsGamepad
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetGamepadState()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int glfwGetGamepadState (int jid,
GLFWgamepadstate * state 
)
+
+

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 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 GLFWgamepadstate. Unavailable buttons and axes will always report GLFW_RELEASE and 0.0 respectively.

+
Parameters
+ + + +
[in]jidThe joystick to query.
[out]stateThe gamepad input state of the joystick.
+
+
+
Returns
GLFW_TRUE if successful, or GLFW_FALSE if no joystick is connected, it has no gamepad mapping or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
Gamepad input
+
+glfwUpdateGamepadMappings
+
+glfwJoystickIsGamepad
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetClipboardString()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetClipboardString (GLFWwindow * window,
const char * string 
)
+
+

This function sets the system clipboard to the specified, UTF-8 encoded string.

+
Parameters
+ + + +
[in]windowDeprecated. Any valid window or NULL.
[in]stringA UTF-8 encoded string.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Pointer lifetime
The specified string is copied before this function returns.
+
Thread safety
This function must only be called from the main thread.
+
See also
Clipboard input and output
+
+glfwGetClipboardString
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetClipboardString()

+ +
+
+ + + + + + + + +
const char * glfwGetClipboardString (GLFWwindow * window)
+
+

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 GLFW_FORMAT_UNAVAILABLE error is generated.

+
Parameters
+ + +
[in]windowDeprecated. Any valid window or NULL.
+
+
+
Returns
The contents of the clipboard as a UTF-8 encoded string, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_FORMAT_UNAVAILABLE and 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 next call to glfwGetClipboardString or glfwSetClipboardString, or until the library is terminated.
+
Thread safety
This function must only be called from the main thread.
+
See also
Clipboard input and output
+
+glfwSetClipboardString
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetTime()

+ +
+
+ + + + + + + + +
double glfwGetTime (void )
+
+

This function returns the current GLFW time, in seconds. Unless the time has been set using glfwSetTime it measures time elapsed since GLFW was initialized.

+

This function and glfwSetTime are helper functions on top of glfwGetTimerFrequency and 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 supported platform.

+
Returns
The current time, in seconds, or zero if an error occurred.
+
Errors
Possible errors include 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 glfwSetTime.
+
See also
Time input
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwSetTime()

+ +
+
+ + + + + + + + +
void glfwSetTime (double 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 glfwGetTime are helper functions on top of glfwGetTimerFrequency and glfwGetTimerValue.

+
Parameters
+ + +
[in]timeThe new value, in seconds.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_VALUE.
+
Remarks
The upper limit of GLFW time is calculated as floor((264 - 1) / 109) 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 glfwGetTime.
+
See also
Time input
+
Since
Added in version 2.2.
+ +
+
+ +

◆ glfwGetTimerValue()

+ +
+
+ + + + + + + + +
uint64_t glfwGetTimerValue (void )
+
+

This function returns the current value of the raw timer, measured in 1 / frequency seconds. To get the frequency, call glfwGetTimerFrequency.

+
Returns
The value of the timer, or zero if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread.
+
See also
Time input
+
+glfwGetTimerFrequency
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetTimerFrequency()

+ +
+
+ + + + + + + + +
uint64_t glfwGetTimerFrequency (void )
+
+

This function returns the frequency, in Hz, of the raw timer.

+
Returns
The frequency of the timer, in Hz, or zero if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread.
+
See also
Time input
+
+glfwGetTimerValue
+
Since
Added in version 3.2.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__joysticks.html b/deps/glfw-3.3.8/docs/html/group__joysticks.html new file mode 100644 index 0000000..34f86b2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__joysticks.html @@ -0,0 +1,355 @@ + + + + + + + +GLFW: Joysticks + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Joysticks
Input reference
+
+
+

Description

+

See joystick input for how these are used.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_JOYSTICK_1   0
 
#define GLFW_JOYSTICK_2   1
 
#define GLFW_JOYSTICK_3   2
 
#define GLFW_JOYSTICK_4   3
 
#define GLFW_JOYSTICK_5   4
 
#define GLFW_JOYSTICK_6   5
 
#define GLFW_JOYSTICK_7   6
 
#define GLFW_JOYSTICK_8   7
 
#define GLFW_JOYSTICK_9   8
 
#define GLFW_JOYSTICK_10   9
 
#define GLFW_JOYSTICK_11   10
 
#define GLFW_JOYSTICK_12   11
 
#define GLFW_JOYSTICK_13   12
 
#define GLFW_JOYSTICK_14   13
 
#define GLFW_JOYSTICK_15   14
 
#define GLFW_JOYSTICK_16   15
 
#define GLFW_JOYSTICK_LAST   GLFW_JOYSTICK_16
 
+

Macro Definition Documentation

+ +

◆ GLFW_JOYSTICK_1

+ +
+
+ + + + +
#define GLFW_JOYSTICK_1   0
+
+ +
+
+ +

◆ GLFW_JOYSTICK_2

+ +
+
+ + + + +
#define GLFW_JOYSTICK_2   1
+
+ +
+
+ +

◆ GLFW_JOYSTICK_3

+ +
+
+ + + + +
#define GLFW_JOYSTICK_3   2
+
+ +
+
+ +

◆ GLFW_JOYSTICK_4

+ +
+
+ + + + +
#define GLFW_JOYSTICK_4   3
+
+ +
+
+ +

◆ GLFW_JOYSTICK_5

+ +
+
+ + + + +
#define GLFW_JOYSTICK_5   4
+
+ +
+
+ +

◆ GLFW_JOYSTICK_6

+ +
+
+ + + + +
#define GLFW_JOYSTICK_6   5
+
+ +
+
+ +

◆ GLFW_JOYSTICK_7

+ +
+
+ + + + +
#define GLFW_JOYSTICK_7   6
+
+ +
+
+ +

◆ GLFW_JOYSTICK_8

+ +
+
+ + + + +
#define GLFW_JOYSTICK_8   7
+
+ +
+
+ +

◆ GLFW_JOYSTICK_9

+ +
+
+ + + + +
#define GLFW_JOYSTICK_9   8
+
+ +
+
+ +

◆ GLFW_JOYSTICK_10

+ +
+
+ + + + +
#define GLFW_JOYSTICK_10   9
+
+ +
+
+ +

◆ GLFW_JOYSTICK_11

+ +
+
+ + + + +
#define GLFW_JOYSTICK_11   10
+
+ +
+
+ +

◆ GLFW_JOYSTICK_12

+ +
+
+ + + + +
#define GLFW_JOYSTICK_12   11
+
+ +
+
+ +

◆ GLFW_JOYSTICK_13

+ +
+
+ + + + +
#define GLFW_JOYSTICK_13   12
+
+ +
+
+ +

◆ GLFW_JOYSTICK_14

+ +
+
+ + + + +
#define GLFW_JOYSTICK_14   13
+
+ +
+
+ +

◆ GLFW_JOYSTICK_15

+ +
+
+ + + + +
#define GLFW_JOYSTICK_15   14
+
+ +
+
+ +

◆ GLFW_JOYSTICK_16

+ +
+
+ + + + +
#define GLFW_JOYSTICK_16   15
+
+ +
+
+ +

◆ GLFW_JOYSTICK_LAST

+ +
+
+ + + + +
#define GLFW_JOYSTICK_LAST   GLFW_JOYSTICK_16
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__keys.html b/deps/glfw-3.3.8/docs/html/group__keys.html new file mode 100644 index 0000000..f899864 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__keys.html @@ -0,0 +1,2043 @@ + + + + + + + +GLFW: Keyboard keys + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Keyboard keys
Input reference
+
+
+

Description

+

See key input 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 alpha-numeric 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.)
    • +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_KEY_UNKNOWN   -1
 
#define GLFW_KEY_SPACE   32
 
#define GLFW_KEY_APOSTROPHE   39 /* ' */
 
#define GLFW_KEY_COMMA   44 /* , */
 
#define GLFW_KEY_MINUS   45 /* - */
 
#define GLFW_KEY_PERIOD   46 /* . */
 
#define GLFW_KEY_SLASH   47 /* / */
 
#define GLFW_KEY_0   48
 
#define GLFW_KEY_1   49
 
#define GLFW_KEY_2   50
 
#define GLFW_KEY_3   51
 
#define GLFW_KEY_4   52
 
#define GLFW_KEY_5   53
 
#define GLFW_KEY_6   54
 
#define GLFW_KEY_7   55
 
#define GLFW_KEY_8   56
 
#define GLFW_KEY_9   57
 
#define GLFW_KEY_SEMICOLON   59 /* ; */
 
#define GLFW_KEY_EQUAL   61 /* = */
 
#define GLFW_KEY_A   65
 
#define GLFW_KEY_B   66
 
#define GLFW_KEY_C   67
 
#define GLFW_KEY_D   68
 
#define GLFW_KEY_E   69
 
#define GLFW_KEY_F   70
 
#define GLFW_KEY_G   71
 
#define GLFW_KEY_H   72
 
#define GLFW_KEY_I   73
 
#define GLFW_KEY_J   74
 
#define GLFW_KEY_K   75
 
#define GLFW_KEY_L   76
 
#define GLFW_KEY_M   77
 
#define GLFW_KEY_N   78
 
#define GLFW_KEY_O   79
 
#define GLFW_KEY_P   80
 
#define GLFW_KEY_Q   81
 
#define GLFW_KEY_R   82
 
#define GLFW_KEY_S   83
 
#define GLFW_KEY_T   84
 
#define GLFW_KEY_U   85
 
#define GLFW_KEY_V   86
 
#define GLFW_KEY_W   87
 
#define GLFW_KEY_X   88
 
#define GLFW_KEY_Y   89
 
#define GLFW_KEY_Z   90
 
#define GLFW_KEY_LEFT_BRACKET   91 /* [ */
 
#define GLFW_KEY_BACKSLASH   92 /* \ */
 
#define GLFW_KEY_RIGHT_BRACKET   93 /* ] */
 
#define GLFW_KEY_GRAVE_ACCENT   96 /* ` */
 
#define GLFW_KEY_WORLD_1   161 /* non-US #1 */
 
#define GLFW_KEY_WORLD_2   162 /* non-US #2 */
 
#define GLFW_KEY_ESCAPE   256
 
#define GLFW_KEY_ENTER   257
 
#define GLFW_KEY_TAB   258
 
#define GLFW_KEY_BACKSPACE   259
 
#define GLFW_KEY_INSERT   260
 
#define GLFW_KEY_DELETE   261
 
#define GLFW_KEY_RIGHT   262
 
#define GLFW_KEY_LEFT   263
 
#define GLFW_KEY_DOWN   264
 
#define GLFW_KEY_UP   265
 
#define GLFW_KEY_PAGE_UP   266
 
#define GLFW_KEY_PAGE_DOWN   267
 
#define GLFW_KEY_HOME   268
 
#define GLFW_KEY_END   269
 
#define GLFW_KEY_CAPS_LOCK   280
 
#define GLFW_KEY_SCROLL_LOCK   281
 
#define GLFW_KEY_NUM_LOCK   282
 
#define GLFW_KEY_PRINT_SCREEN   283
 
#define GLFW_KEY_PAUSE   284
 
#define GLFW_KEY_F1   290
 
#define GLFW_KEY_F2   291
 
#define GLFW_KEY_F3   292
 
#define GLFW_KEY_F4   293
 
#define GLFW_KEY_F5   294
 
#define GLFW_KEY_F6   295
 
#define GLFW_KEY_F7   296
 
#define GLFW_KEY_F8   297
 
#define GLFW_KEY_F9   298
 
#define GLFW_KEY_F10   299
 
#define GLFW_KEY_F11   300
 
#define GLFW_KEY_F12   301
 
#define GLFW_KEY_F13   302
 
#define GLFW_KEY_F14   303
 
#define GLFW_KEY_F15   304
 
#define GLFW_KEY_F16   305
 
#define GLFW_KEY_F17   306
 
#define GLFW_KEY_F18   307
 
#define GLFW_KEY_F19   308
 
#define GLFW_KEY_F20   309
 
#define GLFW_KEY_F21   310
 
#define GLFW_KEY_F22   311
 
#define GLFW_KEY_F23   312
 
#define GLFW_KEY_F24   313
 
#define GLFW_KEY_F25   314
 
#define GLFW_KEY_KP_0   320
 
#define GLFW_KEY_KP_1   321
 
#define GLFW_KEY_KP_2   322
 
#define GLFW_KEY_KP_3   323
 
#define GLFW_KEY_KP_4   324
 
#define GLFW_KEY_KP_5   325
 
#define GLFW_KEY_KP_6   326
 
#define GLFW_KEY_KP_7   327
 
#define GLFW_KEY_KP_8   328
 
#define GLFW_KEY_KP_9   329
 
#define GLFW_KEY_KP_DECIMAL   330
 
#define GLFW_KEY_KP_DIVIDE   331
 
#define GLFW_KEY_KP_MULTIPLY   332
 
#define GLFW_KEY_KP_SUBTRACT   333
 
#define GLFW_KEY_KP_ADD   334
 
#define GLFW_KEY_KP_ENTER   335
 
#define GLFW_KEY_KP_EQUAL   336
 
#define GLFW_KEY_LEFT_SHIFT   340
 
#define GLFW_KEY_LEFT_CONTROL   341
 
#define GLFW_KEY_LEFT_ALT   342
 
#define GLFW_KEY_LEFT_SUPER   343
 
#define GLFW_KEY_RIGHT_SHIFT   344
 
#define GLFW_KEY_RIGHT_CONTROL   345
 
#define GLFW_KEY_RIGHT_ALT   346
 
#define GLFW_KEY_RIGHT_SUPER   347
 
#define GLFW_KEY_MENU   348
 
#define GLFW_KEY_LAST   GLFW_KEY_MENU
 
+

Macro Definition Documentation

+ +

◆ GLFW_KEY_UNKNOWN

+ +
+
+ + + + +
#define GLFW_KEY_UNKNOWN   -1
+
+ +
+
+ +

◆ GLFW_KEY_SPACE

+ +
+
+ + + + +
#define GLFW_KEY_SPACE   32
+
+ +
+
+ +

◆ GLFW_KEY_APOSTROPHE

+ +
+
+ + + + +
#define GLFW_KEY_APOSTROPHE   39 /* ' */
+
+ +
+
+ +

◆ GLFW_KEY_COMMA

+ +
+
+ + + + +
#define GLFW_KEY_COMMA   44 /* , */
+
+ +
+
+ +

◆ GLFW_KEY_MINUS

+ +
+
+ + + + +
#define GLFW_KEY_MINUS   45 /* - */
+
+ +
+
+ +

◆ GLFW_KEY_PERIOD

+ +
+
+ + + + +
#define GLFW_KEY_PERIOD   46 /* . */
+
+ +
+
+ +

◆ GLFW_KEY_SLASH

+ +
+
+ + + + +
#define GLFW_KEY_SLASH   47 /* / */
+
+ +
+
+ +

◆ GLFW_KEY_0

+ +
+
+ + + + +
#define GLFW_KEY_0   48
+
+ +
+
+ +

◆ GLFW_KEY_1

+ +
+
+ + + + +
#define GLFW_KEY_1   49
+
+ +
+
+ +

◆ GLFW_KEY_2

+ +
+
+ + + + +
#define GLFW_KEY_2   50
+
+ +
+
+ +

◆ GLFW_KEY_3

+ +
+
+ + + + +
#define GLFW_KEY_3   51
+
+ +
+
+ +

◆ GLFW_KEY_4

+ +
+
+ + + + +
#define GLFW_KEY_4   52
+
+ +
+
+ +

◆ GLFW_KEY_5

+ +
+
+ + + + +
#define GLFW_KEY_5   53
+
+ +
+
+ +

◆ GLFW_KEY_6

+ +
+
+ + + + +
#define GLFW_KEY_6   54
+
+ +
+
+ +

◆ GLFW_KEY_7

+ +
+
+ + + + +
#define GLFW_KEY_7   55
+
+ +
+
+ +

◆ GLFW_KEY_8

+ +
+
+ + + + +
#define GLFW_KEY_8   56
+
+ +
+
+ +

◆ GLFW_KEY_9

+ +
+
+ + + + +
#define GLFW_KEY_9   57
+
+ +
+
+ +

◆ GLFW_KEY_SEMICOLON

+ +
+
+ + + + +
#define GLFW_KEY_SEMICOLON   59 /* ; */
+
+ +
+
+ +

◆ GLFW_KEY_EQUAL

+ +
+
+ + + + +
#define GLFW_KEY_EQUAL   61 /* = */
+
+ +
+
+ +

◆ GLFW_KEY_A

+ +
+
+ + + + +
#define GLFW_KEY_A   65
+
+ +
+
+ +

◆ GLFW_KEY_B

+ +
+
+ + + + +
#define GLFW_KEY_B   66
+
+ +
+
+ +

◆ GLFW_KEY_C

+ +
+
+ + + + +
#define GLFW_KEY_C   67
+
+ +
+
+ +

◆ GLFW_KEY_D

+ +
+
+ + + + +
#define GLFW_KEY_D   68
+
+ +
+
+ +

◆ GLFW_KEY_E

+ +
+
+ + + + +
#define GLFW_KEY_E   69
+
+ +
+
+ +

◆ GLFW_KEY_F

+ +
+
+ + + + +
#define GLFW_KEY_F   70
+
+ +
+
+ +

◆ GLFW_KEY_G

+ +
+
+ + + + +
#define GLFW_KEY_G   71
+
+ +
+
+ +

◆ GLFW_KEY_H

+ +
+
+ + + + +
#define GLFW_KEY_H   72
+
+ +
+
+ +

◆ GLFW_KEY_I

+ +
+
+ + + + +
#define GLFW_KEY_I   73
+
+ +
+
+ +

◆ GLFW_KEY_J

+ +
+
+ + + + +
#define GLFW_KEY_J   74
+
+ +
+
+ +

◆ GLFW_KEY_K

+ +
+
+ + + + +
#define GLFW_KEY_K   75
+
+ +
+
+ +

◆ GLFW_KEY_L

+ +
+
+ + + + +
#define GLFW_KEY_L   76
+
+ +
+
+ +

◆ GLFW_KEY_M

+ +
+
+ + + + +
#define GLFW_KEY_M   77
+
+ +
+
+ +

◆ GLFW_KEY_N

+ +
+
+ + + + +
#define GLFW_KEY_N   78
+
+ +
+
+ +

◆ GLFW_KEY_O

+ +
+
+ + + + +
#define GLFW_KEY_O   79
+
+ +
+
+ +

◆ GLFW_KEY_P

+ +
+
+ + + + +
#define GLFW_KEY_P   80
+
+ +
+
+ +

◆ GLFW_KEY_Q

+ +
+
+ + + + +
#define GLFW_KEY_Q   81
+
+ +
+
+ +

◆ GLFW_KEY_R

+ +
+
+ + + + +
#define GLFW_KEY_R   82
+
+ +
+
+ +

◆ GLFW_KEY_S

+ +
+
+ + + + +
#define GLFW_KEY_S   83
+
+ +
+
+ +

◆ GLFW_KEY_T

+ +
+
+ + + + +
#define GLFW_KEY_T   84
+
+ +
+
+ +

◆ GLFW_KEY_U

+ +
+
+ + + + +
#define GLFW_KEY_U   85
+
+ +
+
+ +

◆ GLFW_KEY_V

+ +
+
+ + + + +
#define GLFW_KEY_V   86
+
+ +
+
+ +

◆ GLFW_KEY_W

+ +
+
+ + + + +
#define GLFW_KEY_W   87
+
+ +
+
+ +

◆ GLFW_KEY_X

+ +
+
+ + + + +
#define GLFW_KEY_X   88
+
+ +
+
+ +

◆ GLFW_KEY_Y

+ +
+
+ + + + +
#define GLFW_KEY_Y   89
+
+ +
+
+ +

◆ GLFW_KEY_Z

+ +
+
+ + + + +
#define GLFW_KEY_Z   90
+
+ +
+
+ +

◆ GLFW_KEY_LEFT_BRACKET

+ +
+
+ + + + +
#define GLFW_KEY_LEFT_BRACKET   91 /* [ */
+
+ +
+
+ +

◆ GLFW_KEY_BACKSLASH

+ +
+
+ + + + +
#define GLFW_KEY_BACKSLASH   92 /* \ */
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT_BRACKET

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT_BRACKET   93 /* ] */
+
+ +
+
+ +

◆ GLFW_KEY_GRAVE_ACCENT

+ +
+
+ + + + +
#define GLFW_KEY_GRAVE_ACCENT   96 /* ` */
+
+ +
+
+ +

◆ GLFW_KEY_WORLD_1

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

◆ GLFW_KEY_WORLD_2

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

◆ GLFW_KEY_ESCAPE

+ +
+
+ + + + +
#define GLFW_KEY_ESCAPE   256
+
+ +
+
+ +

◆ GLFW_KEY_ENTER

+ +
+
+ + + + +
#define GLFW_KEY_ENTER   257
+
+ +
+
+ +

◆ GLFW_KEY_TAB

+ +
+
+ + + + +
#define GLFW_KEY_TAB   258
+
+ +
+
+ +

◆ GLFW_KEY_BACKSPACE

+ +
+
+ + + + +
#define GLFW_KEY_BACKSPACE   259
+
+ +
+
+ +

◆ GLFW_KEY_INSERT

+ +
+
+ + + + +
#define GLFW_KEY_INSERT   260
+
+ +
+
+ +

◆ GLFW_KEY_DELETE

+ +
+
+ + + + +
#define GLFW_KEY_DELETE   261
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT   262
+
+ +
+
+ +

◆ GLFW_KEY_LEFT

+ +
+
+ + + + +
#define GLFW_KEY_LEFT   263
+
+ +
+
+ +

◆ GLFW_KEY_DOWN

+ +
+
+ + + + +
#define GLFW_KEY_DOWN   264
+
+ +
+
+ +

◆ GLFW_KEY_UP

+ +
+
+ + + + +
#define GLFW_KEY_UP   265
+
+ +
+
+ +

◆ GLFW_KEY_PAGE_UP

+ +
+
+ + + + +
#define GLFW_KEY_PAGE_UP   266
+
+ +
+
+ +

◆ GLFW_KEY_PAGE_DOWN

+ +
+
+ + + + +
#define GLFW_KEY_PAGE_DOWN   267
+
+ +
+
+ +

◆ GLFW_KEY_HOME

+ +
+
+ + + + +
#define GLFW_KEY_HOME   268
+
+ +
+
+ +

◆ GLFW_KEY_END

+ +
+
+ + + + +
#define GLFW_KEY_END   269
+
+ +
+
+ +

◆ GLFW_KEY_CAPS_LOCK

+ +
+
+ + + + +
#define GLFW_KEY_CAPS_LOCK   280
+
+ +
+
+ +

◆ GLFW_KEY_SCROLL_LOCK

+ +
+
+ + + + +
#define GLFW_KEY_SCROLL_LOCK   281
+
+ +
+
+ +

◆ GLFW_KEY_NUM_LOCK

+ +
+
+ + + + +
#define GLFW_KEY_NUM_LOCK   282
+
+ +
+
+ +

◆ GLFW_KEY_PRINT_SCREEN

+ +
+
+ + + + +
#define GLFW_KEY_PRINT_SCREEN   283
+
+ +
+
+ +

◆ GLFW_KEY_PAUSE

+ +
+
+ + + + +
#define GLFW_KEY_PAUSE   284
+
+ +
+
+ +

◆ GLFW_KEY_F1

+ +
+
+ + + + +
#define GLFW_KEY_F1   290
+
+ +
+
+ +

◆ GLFW_KEY_F2

+ +
+
+ + + + +
#define GLFW_KEY_F2   291
+
+ +
+
+ +

◆ GLFW_KEY_F3

+ +
+
+ + + + +
#define GLFW_KEY_F3   292
+
+ +
+
+ +

◆ GLFW_KEY_F4

+ +
+
+ + + + +
#define GLFW_KEY_F4   293
+
+ +
+
+ +

◆ GLFW_KEY_F5

+ +
+
+ + + + +
#define GLFW_KEY_F5   294
+
+ +
+
+ +

◆ GLFW_KEY_F6

+ +
+
+ + + + +
#define GLFW_KEY_F6   295
+
+ +
+
+ +

◆ GLFW_KEY_F7

+ +
+
+ + + + +
#define GLFW_KEY_F7   296
+
+ +
+
+ +

◆ GLFW_KEY_F8

+ +
+
+ + + + +
#define GLFW_KEY_F8   297
+
+ +
+
+ +

◆ GLFW_KEY_F9

+ +
+
+ + + + +
#define GLFW_KEY_F9   298
+
+ +
+
+ +

◆ GLFW_KEY_F10

+ +
+
+ + + + +
#define GLFW_KEY_F10   299
+
+ +
+
+ +

◆ GLFW_KEY_F11

+ +
+
+ + + + +
#define GLFW_KEY_F11   300
+
+ +
+
+ +

◆ GLFW_KEY_F12

+ +
+
+ + + + +
#define GLFW_KEY_F12   301
+
+ +
+
+ +

◆ GLFW_KEY_F13

+ +
+
+ + + + +
#define GLFW_KEY_F13   302
+
+ +
+
+ +

◆ GLFW_KEY_F14

+ +
+
+ + + + +
#define GLFW_KEY_F14   303
+
+ +
+
+ +

◆ GLFW_KEY_F15

+ +
+
+ + + + +
#define GLFW_KEY_F15   304
+
+ +
+
+ +

◆ GLFW_KEY_F16

+ +
+
+ + + + +
#define GLFW_KEY_F16   305
+
+ +
+
+ +

◆ GLFW_KEY_F17

+ +
+
+ + + + +
#define GLFW_KEY_F17   306
+
+ +
+
+ +

◆ GLFW_KEY_F18

+ +
+
+ + + + +
#define GLFW_KEY_F18   307
+
+ +
+
+ +

◆ GLFW_KEY_F19

+ +
+
+ + + + +
#define GLFW_KEY_F19   308
+
+ +
+
+ +

◆ GLFW_KEY_F20

+ +
+
+ + + + +
#define GLFW_KEY_F20   309
+
+ +
+
+ +

◆ GLFW_KEY_F21

+ +
+
+ + + + +
#define GLFW_KEY_F21   310
+
+ +
+
+ +

◆ GLFW_KEY_F22

+ +
+
+ + + + +
#define GLFW_KEY_F22   311
+
+ +
+
+ +

◆ GLFW_KEY_F23

+ +
+
+ + + + +
#define GLFW_KEY_F23   312
+
+ +
+
+ +

◆ GLFW_KEY_F24

+ +
+
+ + + + +
#define GLFW_KEY_F24   313
+
+ +
+
+ +

◆ GLFW_KEY_F25

+ +
+
+ + + + +
#define GLFW_KEY_F25   314
+
+ +
+
+ +

◆ GLFW_KEY_KP_0

+ +
+
+ + + + +
#define GLFW_KEY_KP_0   320
+
+ +
+
+ +

◆ GLFW_KEY_KP_1

+ +
+
+ + + + +
#define GLFW_KEY_KP_1   321
+
+ +
+
+ +

◆ GLFW_KEY_KP_2

+ +
+
+ + + + +
#define GLFW_KEY_KP_2   322
+
+ +
+
+ +

◆ GLFW_KEY_KP_3

+ +
+
+ + + + +
#define GLFW_KEY_KP_3   323
+
+ +
+
+ +

◆ GLFW_KEY_KP_4

+ +
+
+ + + + +
#define GLFW_KEY_KP_4   324
+
+ +
+
+ +

◆ GLFW_KEY_KP_5

+ +
+
+ + + + +
#define GLFW_KEY_KP_5   325
+
+ +
+
+ +

◆ GLFW_KEY_KP_6

+ +
+
+ + + + +
#define GLFW_KEY_KP_6   326
+
+ +
+
+ +

◆ GLFW_KEY_KP_7

+ +
+
+ + + + +
#define GLFW_KEY_KP_7   327
+
+ +
+
+ +

◆ GLFW_KEY_KP_8

+ +
+
+ + + + +
#define GLFW_KEY_KP_8   328
+
+ +
+
+ +

◆ GLFW_KEY_KP_9

+ +
+
+ + + + +
#define GLFW_KEY_KP_9   329
+
+ +
+
+ +

◆ GLFW_KEY_KP_DECIMAL

+ +
+
+ + + + +
#define GLFW_KEY_KP_DECIMAL   330
+
+ +
+
+ +

◆ GLFW_KEY_KP_DIVIDE

+ +
+
+ + + + +
#define GLFW_KEY_KP_DIVIDE   331
+
+ +
+
+ +

◆ GLFW_KEY_KP_MULTIPLY

+ +
+
+ + + + +
#define GLFW_KEY_KP_MULTIPLY   332
+
+ +
+
+ +

◆ GLFW_KEY_KP_SUBTRACT

+ +
+
+ + + + +
#define GLFW_KEY_KP_SUBTRACT   333
+
+ +
+
+ +

◆ GLFW_KEY_KP_ADD

+ +
+
+ + + + +
#define GLFW_KEY_KP_ADD   334
+
+ +
+
+ +

◆ GLFW_KEY_KP_ENTER

+ +
+
+ + + + +
#define GLFW_KEY_KP_ENTER   335
+
+ +
+
+ +

◆ GLFW_KEY_KP_EQUAL

+ +
+
+ + + + +
#define GLFW_KEY_KP_EQUAL   336
+
+ +
+
+ +

◆ GLFW_KEY_LEFT_SHIFT

+ +
+
+ + + + +
#define GLFW_KEY_LEFT_SHIFT   340
+
+ +
+
+ +

◆ GLFW_KEY_LEFT_CONTROL

+ +
+
+ + + + +
#define GLFW_KEY_LEFT_CONTROL   341
+
+ +
+
+ +

◆ GLFW_KEY_LEFT_ALT

+ +
+
+ + + + +
#define GLFW_KEY_LEFT_ALT   342
+
+ +
+
+ +

◆ GLFW_KEY_LEFT_SUPER

+ +
+
+ + + + +
#define GLFW_KEY_LEFT_SUPER   343
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT_SHIFT

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT_SHIFT   344
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT_CONTROL

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT_CONTROL   345
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT_ALT

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT_ALT   346
+
+ +
+
+ +

◆ GLFW_KEY_RIGHT_SUPER

+ +
+
+ + + + +
#define GLFW_KEY_RIGHT_SUPER   347
+
+ +
+
+ +

◆ GLFW_KEY_MENU

+ +
+
+ + + + +
#define GLFW_KEY_MENU   348
+
+ +
+
+ +

◆ GLFW_KEY_LAST

+ +
+
+ + + + +
#define GLFW_KEY_LAST   GLFW_KEY_MENU
+
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__mods.html b/deps/glfw-3.3.8/docs/html/group__mods.html new file mode 100644 index 0000000..94fc54d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__mods.html @@ -0,0 +1,191 @@ + + + + + + + +GLFW: Modifier key flags + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Modifier key flags
Input reference
+
+
+

Description

+

See key input for how these are used.

+ + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_MOD_SHIFT   0x0001
 If this bit is set one or more Shift keys were held down. More...
 
#define GLFW_MOD_CONTROL   0x0002
 If this bit is set one or more Control keys were held down. More...
 
#define GLFW_MOD_ALT   0x0004
 If this bit is set one or more Alt keys were held down. More...
 
#define GLFW_MOD_SUPER   0x0008
 If this bit is set one or more Super keys were held down. More...
 
#define GLFW_MOD_CAPS_LOCK   0x0010
 If this bit is set the Caps Lock key is enabled. More...
 
#define GLFW_MOD_NUM_LOCK   0x0020
 If this bit is set the Num Lock key is enabled. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_MOD_SHIFT

+ +
+
+ + + + +
#define GLFW_MOD_SHIFT   0x0001
+
+

If this bit is set one or more Shift keys were held down.

+ +
+
+ +

◆ GLFW_MOD_CONTROL

+ +
+
+ + + + +
#define GLFW_MOD_CONTROL   0x0002
+
+

If this bit is set one or more Control keys were held down.

+ +
+
+ +

◆ GLFW_MOD_ALT

+ +
+
+ + + + +
#define GLFW_MOD_ALT   0x0004
+
+

If this bit is set one or more Alt keys were held down.

+ +
+
+ +

◆ GLFW_MOD_SUPER

+ +
+
+ + + + +
#define GLFW_MOD_SUPER   0x0008
+
+

If this bit is set one or more Super keys were held down.

+ +
+
+ +

◆ GLFW_MOD_CAPS_LOCK

+ +
+
+ + + + +
#define GLFW_MOD_CAPS_LOCK   0x0010
+
+

If this bit is set the Caps Lock key is enabled and the GLFW_LOCK_KEY_MODS input mode is set.

+ +
+
+ +

◆ GLFW_MOD_NUM_LOCK

+ +
+
+ + + + +
#define GLFW_MOD_NUM_LOCK   0x0020
+
+

If this bit is set the Num Lock key is enabled and the GLFW_LOCK_KEY_MODS input mode is set.

+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__monitor.html b/deps/glfw-3.3.8/docs/html/group__monitor.html new file mode 100644 index 0000000..4df6209 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__monitor.html @@ -0,0 +1,841 @@ + + + + + + + +GLFW: Monitor reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Typedefs | +Functions
+
Monitor reference
+
+
+

Description

+

This is the reference documentation for monitor related functions and types. For more task-oriented information, see the Monitor guide.

+ + + + + + + + + + + + + + +

+Typedefs

typedef struct GLFWmonitor GLFWmonitor
 Opaque monitor object. More...
 
typedef void(* GLFWmonitorfun) (GLFWmonitor *monitor, int event)
 The function pointer type for monitor configuration callbacks. More...
 
typedef struct GLFWvidmode GLFWvidmode
 Video mode type. More...
 
typedef struct GLFWgammaramp GLFWgammaramp
 Gamma ramp. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

GLFWmonitor ** glfwGetMonitors (int *count)
 Returns the currently connected monitors. More...
 
GLFWmonitor * glfwGetPrimaryMonitor (void)
 Returns the primary monitor. More...
 
void glfwGetMonitorPos (GLFWmonitor *monitor, int *xpos, int *ypos)
 Returns the position of the monitor's viewport on the virtual screen. More...
 
void glfwGetMonitorWorkarea (GLFWmonitor *monitor, int *xpos, int *ypos, int *width, int *height)
 Retrieves the work area of the monitor. More...
 
void glfwGetMonitorPhysicalSize (GLFWmonitor *monitor, int *widthMM, int *heightMM)
 Returns the physical size of the monitor. More...
 
void glfwGetMonitorContentScale (GLFWmonitor *monitor, float *xscale, float *yscale)
 Retrieves the content scale for the specified monitor. More...
 
const char * glfwGetMonitorName (GLFWmonitor *monitor)
 Returns the name of the specified monitor. More...
 
void glfwSetMonitorUserPointer (GLFWmonitor *monitor, void *pointer)
 Sets the user pointer of the specified monitor. More...
 
void * glfwGetMonitorUserPointer (GLFWmonitor *monitor)
 Returns the user pointer of the specified monitor. More...
 
GLFWmonitorfun glfwSetMonitorCallback (GLFWmonitorfun callback)
 Sets the monitor configuration callback. More...
 
const GLFWvidmode * glfwGetVideoModes (GLFWmonitor *monitor, int *count)
 Returns the available video modes for the specified monitor. More...
 
const GLFWvidmode * glfwGetVideoMode (GLFWmonitor *monitor)
 Returns the current mode of the specified monitor. More...
 
void glfwSetGamma (GLFWmonitor *monitor, float gamma)
 Generates a gamma ramp and sets it for the specified monitor. More...
 
const GLFWgammaramp * glfwGetGammaRamp (GLFWmonitor *monitor)
 Returns the current gamma ramp for the specified monitor. More...
 
void glfwSetGammaRamp (GLFWmonitor *monitor, const GLFWgammaramp *ramp)
 Sets the current gamma ramp for the specified monitor. More...
 
+

Typedef Documentation

+ +

◆ GLFWmonitor

+ +
+
+ + + + +
typedef struct GLFWmonitor GLFWmonitor
+
+

Opaque monitor object.

+
See also
Monitor objects
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWmonitorfun

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

This is the function pointer type for monitor configuration callbacks. A monitor callback function has the following signature:

void function_name(GLFWmonitor* monitor, int event)
+
GLFWmonitor
struct GLFWmonitor GLFWmonitor
Opaque monitor object.
Definition: glfw3.h:1173
+
Parameters
+ + + +
[in]monitorThe monitor that was connected or disconnected.
[in]eventOne of GLFW_CONNECTED or GLFW_DISCONNECTED. Future releases may add more events.
+
+
+
See also
Monitor configuration changes
+
+glfwSetMonitorCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWvidmode

+ +
+
+ + + + +
typedef struct GLFWvidmode GLFWvidmode
+
+

This describes a single video mode.

+
See also
Video modes
+
+glfwGetVideoMode
+
+glfwGetVideoModes
+
Since
Added in version 1.0. GLFW 3: Added refresh rate member.
+ +
+
+ +

◆ GLFWgammaramp

+ +
+
+ + + + +
typedef struct GLFWgammaramp GLFWgammaramp
+
+

This describes the gamma ramp for a monitor.

+
See also
Gamma ramp
+
+glfwGetGammaRamp
+
+glfwSetGammaRamp
+
Since
Added in version 3.0.
+ +
+
+

Function Documentation

+ +

◆ glfwGetMonitors()

+ +
+
+ + + + + + + + +
GLFWmonitor ** glfwGetMonitors (int * count)
+
+

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.

+
Parameters
+ + +
[out]countWhere to store the number of monitors in the returned array. This is set to zero if an error occurred.
+
+
+
Returns
An array of monitor handles, or NULL if no monitors were found or if an error occurred.
+
Errors
Possible errors include 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.
+
See also
Retrieving monitors
+
+Monitor configuration changes
+
+glfwGetPrimaryMonitor
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetPrimaryMonitor()

+ +
+
+ + + + + + + + +
GLFWmonitor * glfwGetPrimaryMonitor (void )
+
+

This function returns the primary monitor. This is usually the monitor where elements like the task bar or global menu bar are located.

+
Returns
The primary monitor, or NULL if no monitors were found or if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
Remarks
The primary monitor is always first in the array returned by glfwGetMonitors.
+
See also
Retrieving monitors
+
+glfwGetMonitors
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetMonitorPos()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetMonitorPos (GLFWmonitor * monitor,
int * xpos,
int * ypos 
)
+
+

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.

+
Parameters
+ + + + +
[in]monitorThe monitor to query.
[out]xposWhere to store the monitor x-coordinate, or NULL.
[out]yposWhere to store the monitor y-coordinate, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Monitor properties
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetMonitorWorkarea()

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

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 operating 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.

+
Parameters
+ + + + + + +
[in]monitorThe monitor to query.
[out]xposWhere to store the monitor x-coordinate, or NULL.
[out]yposWhere to store the monitor y-coordinate, or NULL.
[out]widthWhere to store the monitor width, or NULL.
[out]heightWhere to store the monitor height, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Work area
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetMonitorPhysicalSize()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetMonitorPhysicalSize (GLFWmonitor * monitor,
int * widthMM,
int * heightMM 
)
+
+

This function returns the size, in millimetres, of the display area of the specified monitor.

+

Some systems do not provide accurate monitor size information, either because the monitor EDID data is incorrect or because the driver does not report it accurately.

+

Any or all of the size arguments may be NULL. If an error occurs, all non-NULL size arguments will be set to zero.

+
Parameters
+ + + + +
[in]monitorThe monitor to query.
[out]widthMMWhere to store the width, in millimetres, of the monitor's display area, or NULL.
[out]heightMMWhere to store the height, in millimetres, of the monitor's display area, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
Windows: 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.
+
See also
Monitor properties
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetMonitorContentScale()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetMonitorContentScale (GLFWmonitor * monitor,
float * xscale,
float * yscale 
)
+
+

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.

+
Parameters
+ + + + +
[in]monitorThe monitor to query.
[out]xscaleWhere to store the x-axis content scale, or NULL.
[out]yscaleWhere to store the y-axis content scale, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Content scale
+
+glfwGetWindowContentScale
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetMonitorName()

+ +
+
+ + + + + + + + +
const char * glfwGetMonitorName (GLFWmonitor * 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.

+
Parameters
+ + +
[in]monitorThe monitor to query.
+
+
+
Returns
The UTF-8 encoded name of the monitor, or NULL if an error occurred.
+
Errors
Possible errors include 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.
+
See also
Monitor properties
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetMonitorUserPointer()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetMonitorUserPointer (GLFWmonitor * monitor,
void * pointer 
)
+
+

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.

+
Parameters
+ + + +
[in]monitorThe monitor whose pointer to set.
[in]pointerThe new value.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
User pointer
+
+glfwGetMonitorUserPointer
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetMonitorUserPointer()

+ +
+
+ + + + + + + + +
void * glfwGetMonitorUserPointer (GLFWmonitor * 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.

+
Parameters
+ + +
[in]monitorThe monitor whose pointer to return.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
User pointer
+
+glfwSetMonitorUserPointer
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetMonitorCallback()

+ +
+
+ + + + + + + + +
GLFWmonitorfun glfwSetMonitorCallback (GLFWmonitorfun 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.

+
Parameters
+ + +
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWmonitor* monitor, int event)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Monitor configuration changes
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetVideoModes()

+ +
+
+ + + + + + + + + + + + + + + + + + +
const GLFWvidmode * glfwGetVideoModes (GLFWmonitor * monitor,
int * count 
)
+
+

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.

+
Parameters
+ + + +
[in]monitorThe monitor to query.
[out]countWhere to store the number of video modes in the returned array. This is set to zero if an error occurred.
+
+
+
Returns
An array of video modes, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Video modes
+
+glfwGetVideoMode
+
Since
Added in version 1.0. GLFW 3: Changed to return an array of modes for a specific monitor.
+ +
+
+ +

◆ glfwGetVideoMode()

+ +
+
+ + + + + + + + +
const GLFWvidmode * glfwGetVideoMode (GLFWmonitor * 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.

+
Parameters
+ + +
[in]monitorThe monitor to query.
+
+
+
Returns
The current mode of the monitor, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Video modes
+
+glfwGetVideoModes
+
Since
Added in version 3.0. Replaces glfwGetDesktopMode.
+ +
+
+ +

◆ glfwSetGamma()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetGamma (GLFWmonitor * monitor,
float gamma 
)
+
+

This function generates an appropriately sized gamma ramp from the specified exponent and then calls 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 GLFW_SRGB_CAPABLE hint.

+
Parameters
+ + + +
[in]monitorThe monitor whose gamma ramp to set.
[in]gammaThe desired exponent.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Gamma ramp
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetGammaRamp()

+ +
+
+ + + + + + + + +
const GLFWgammaramp * glfwGetGammaRamp (GLFWmonitor * monitor)
+
+

This function returns the current gamma ramp of the specified monitor.

+
Parameters
+ + +
[in]monitorThe monitor to query.
+
+
+
Returns
The current gamma ramp, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR 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.
+
See also
Gamma ramp
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetGammaRamp()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetGammaRamp (GLFWmonitor * monitor,
const GLFWgammaramp * ramp 
)
+
+

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 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 GLFW_SRGB_CAPABLE hint.

+
Parameters
+ + + +
[in]monitorThe monitor whose gamma ramp to set.
[in]rampThe gamma ramp to use.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
The size of the specified gamma ramp should match the size of the current ramp for that monitor.
+
+Windows: The gamma ramp size must be 256.
+
+Wayland: Gamma handling is a privileged protocol, this function will thus never be implemented and emits GLFW_PLATFORM_ERROR.
+
Pointer lifetime
The specified gamma ramp is copied before this function returns.
+
Thread safety
This function must only be called from the main thread.
+
See also
Gamma ramp
+
Since
Added in version 3.0.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__native.html b/deps/glfw-3.3.8/docs/html/group__native.html new file mode 100644 index 0000000..5adef3b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__native.html @@ -0,0 +1,805 @@ + + + + + + + +GLFW: Native access + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Functions
+
Native access
+
+
+

Description

+

By using the native access functions you assert that you know what you're doing and how to fix problems caused by using them. If you don't, you shouldn't be using them.

+

Before the inclusion of glfw3native.h, you may define zero or more window system API macro and zero or more context creation API macros.

+

The chosen backends must match those the library was compiled for. Failure to do this will cause a link-time error.

+

The available window API macros are:

    +
  • GLFW_EXPOSE_NATIVE_WIN32
    • +
  • GLFW_EXPOSE_NATIVE_COCOA
    • +
  • GLFW_EXPOSE_NATIVE_X11
    • +
  • GLFW_EXPOSE_NATIVE_WAYLAND
    • +
+

The available context API macros are:

    +
  • GLFW_EXPOSE_NATIVE_WGL
    • +
  • GLFW_EXPOSE_NATIVE_NSGL
    • +
  • GLFW_EXPOSE_NATIVE_GLX
    • +
  • GLFW_EXPOSE_NATIVE_EGL
    • +
  • GLFW_EXPOSE_NATIVE_OSMESA
    • +
+

These macros select which of the native access functions that are declared and which platform-specific headers to include. It is then up your (by definition platform-specific) code to handle which of these should be defined.

+

If you do not want the platform-specific headers to be included, define GLFW_NATIVE_INCLUDE_NONE before including the glfw3native.h header.

+
#define GLFW_EXPOSE_NATIVE_WIN32
+
#define GLFW_EXPOSE_NATIVE_WGL
+
#define GLFW_NATIVE_INCLUDE_NONE
+
#include <GLFW/glfw3native.h>
+
glfw3native.h
The header of the native access functions.
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

const char * glfwGetWin32Adapter (GLFWmonitor *monitor)
 Returns the adapter device name of the specified monitor. More...
 
const char * glfwGetWin32Monitor (GLFWmonitor *monitor)
 Returns the display device name of the specified monitor. More...
 
HWND glfwGetWin32Window (GLFWwindow *window)
 Returns the HWND of the specified window. More...
 
HGLRC glfwGetWGLContext (GLFWwindow *window)
 Returns the HGLRC of the specified window. More...
 
CGDirectDisplayID glfwGetCocoaMonitor (GLFWmonitor *monitor)
 Returns the CGDirectDisplayID of the specified monitor. More...
 
id glfwGetCocoaWindow (GLFWwindow *window)
 Returns the NSWindow of the specified window. More...
 
id glfwGetNSGLContext (GLFWwindow *window)
 Returns the NSOpenGLContext of the specified window. More...
 
Display * glfwGetX11Display (void)
 Returns the Display used by GLFW. More...
 
RRCrtc glfwGetX11Adapter (GLFWmonitor *monitor)
 Returns the RRCrtc of the specified monitor. More...
 
RROutput glfwGetX11Monitor (GLFWmonitor *monitor)
 Returns the RROutput of the specified monitor. More...
 
Window glfwGetX11Window (GLFWwindow *window)
 Returns the Window of the specified window. More...
 
void glfwSetX11SelectionString (const char *string)
 Sets the current primary selection to the specified string. More...
 
const char * glfwGetX11SelectionString (void)
 Returns the contents of the current primary selection as a string. More...
 
GLXContext glfwGetGLXContext (GLFWwindow *window)
 Returns the GLXContext of the specified window. More...
 
GLXWindow glfwGetGLXWindow (GLFWwindow *window)
 Returns the GLXWindow of the specified window. More...
 
struct wl_display * glfwGetWaylandDisplay (void)
 Returns the struct wl_display* used by GLFW. More...
 
struct wl_output * glfwGetWaylandMonitor (GLFWmonitor *monitor)
 Returns the struct wl_output* of the specified monitor. More...
 
struct wl_surface * glfwGetWaylandWindow (GLFWwindow *window)
 Returns the main struct wl_surface* of the specified window. More...
 
EGLDisplay glfwGetEGLDisplay (void)
 Returns the EGLDisplay used by GLFW. More...
 
EGLContext glfwGetEGLContext (GLFWwindow *window)
 Returns the EGLContext of the specified window. More...
 
EGLSurface glfwGetEGLSurface (GLFWwindow *window)
 Returns the EGLSurface of the specified window. More...
 
int glfwGetOSMesaColorBuffer (GLFWwindow *window, int *width, int *height, int *format, void **buffer)
 Retrieves the color buffer associated with the specified window. More...
 
int glfwGetOSMesaDepthBuffer (GLFWwindow *window, int *width, int *height, int *bytesPerValue, void **buffer)
 Retrieves the depth buffer associated with the specified window. More...
 
OSMesaContext glfwGetOSMesaContext (GLFWwindow *window)
 Returns the OSMesaContext of the specified window. More...
 
+

Function Documentation

+ +

◆ glfwGetWin32Adapter()

+ +
+
+ + + + + + + + +
const char * glfwGetWin32Adapter (GLFWmonitor * monitor)
+
+
Returns
The UTF-8 encoded adapter device name (for example \\.\DISPLAY1) of the specified monitor, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetWin32Monitor()

+ +
+
+ + + + + + + + +
const char * glfwGetWin32Monitor (GLFWmonitor * monitor)
+
+
Returns
The UTF-8 encoded display device name (for example \\.\DISPLAY1\Monitor0) of the specified monitor, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetWin32Window()

+ +
+
+ + + + + + + + +
HWND glfwGetWin32Window (GLFWwindow * window)
+
+
Returns
The HWND of the specified window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
The HDC associated with the window can be queried with the GetDC function.
HDC dc = GetDC(glfwGetWin32Window(window));
+
glfwGetWin32Window
HWND glfwGetWin32Window(GLFWwindow *window)
Returns the HWND of the specified window.
+
This DC is private and does not need to be released.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetWGLContext()

+ +
+
+ + + + + + + + +
HGLRC glfwGetWGLContext (GLFWwindow * window)
+
+
Returns
The HGLRC of the specified window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Remarks
The HDC associated with the window can be queried with the GetDC function.
HDC dc = GetDC(glfwGetWin32Window(window));
+
This DC is private and does not need to be released.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetCocoaMonitor()

+ +
+
+ + + + + + + + +
CGDirectDisplayID glfwGetCocoaMonitor (GLFWmonitor * monitor)
+
+
Returns
The CGDirectDisplayID of the specified monitor, or kCGNullDirectDisplay if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetCocoaWindow()

+ +
+
+ + + + + + + + +
id glfwGetCocoaWindow (GLFWwindow * window)
+
+
Returns
The NSWindow of the specified window, or nil if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetNSGLContext()

+ +
+
+ + + + + + + + +
id glfwGetNSGLContext (GLFWwindow * window)
+
+
Returns
The NSOpenGLContext of the specified window, or nil if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetX11Display()

+ +
+
+ + + + + + + + +
Display * glfwGetX11Display (void )
+
+
Returns
The Display used by GLFW, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetX11Adapter()

+ +
+
+ + + + + + + + +
RRCrtc glfwGetX11Adapter (GLFWmonitor * monitor)
+
+
Returns
The RRCrtc of the specified monitor, or None if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetX11Monitor()

+ +
+
+ + + + + + + + +
RROutput glfwGetX11Monitor (GLFWmonitor * monitor)
+
+
Returns
The RROutput of the specified monitor, or None if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetX11Window()

+ +
+
+ + + + + + + + +
Window glfwGetX11Window (GLFWwindow * window)
+
+
Returns
The Window of the specified window, or None if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetX11SelectionString()

+ +
+
+ + + + + + + + +
void glfwSetX11SelectionString (const char * string)
+
+
Parameters
+ + +
[in]stringA UTF-8 encoded string.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Pointer lifetime
The specified string is copied before this function returns.
+
Thread safety
This function must only be called from the main thread.
+
See also
Clipboard input and output
+
+glfwGetX11SelectionString
+
+glfwSetClipboardString
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetX11SelectionString()

+ +
+
+ + + + + + + + +
const char * glfwGetX11SelectionString (void )
+
+

If the selection is empty or if its contents cannot be converted, NULL is returned and a GLFW_FORMAT_UNAVAILABLE error is generated.

+
Returns
The contents of the selection as a UTF-8 encoded string, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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 next call to glfwGetX11SelectionString or glfwSetX11SelectionString, or until the library is terminated.
+
Thread safety
This function must only be called from the main thread.
+
See also
Clipboard input and output
+
+glfwSetX11SelectionString
+
+glfwGetClipboardString
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetGLXContext()

+ +
+
+ + + + + + + + +
GLXContext glfwGetGLXContext (GLFWwindow * window)
+
+
Returns
The GLXContext of the specified window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetGLXWindow()

+ +
+
+ + + + + + + + +
GLXWindow glfwGetGLXWindow (GLFWwindow * window)
+
+
Returns
The GLXWindow of the specified window, or None if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetWaylandDisplay()

+ +
+
+ + + + + + + + +
struct wl_display * glfwGetWaylandDisplay (void )
+
+
Returns
The struct wl_display* used by GLFW, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetWaylandMonitor()

+ +
+
+ + + + + + + + +
struct wl_output * glfwGetWaylandMonitor (GLFWmonitor * monitor)
+
+
Returns
The struct wl_output* of the specified monitor, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetWaylandWindow()

+ +
+
+ + + + + + + + +
struct wl_surface * glfwGetWaylandWindow (GLFWwindow * window)
+
+
Returns
The main struct wl_surface* of the specified window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetEGLDisplay()

+ +
+
+ + + + + + + + +
EGLDisplay glfwGetEGLDisplay (void )
+
+
Returns
The EGLDisplay used by GLFW, or EGL_NO_DISPLAY if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
Because EGL is initialized on demand, this function will return EGL_NO_DISPLAY until the first context has been created via EGL.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetEGLContext()

+ +
+
+ + + + + + + + +
EGLContext glfwGetEGLContext (GLFWwindow * window)
+
+
Returns
The EGLContext of the specified window, or EGL_NO_CONTEXT if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetEGLSurface()

+ +
+
+ + + + + + + + +
EGLSurface glfwGetEGLSurface (GLFWwindow * window)
+
+
Returns
The EGLSurface of the specified window, or EGL_NO_SURFACE if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetOSMesaColorBuffer()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int glfwGetOSMesaColorBuffer (GLFWwindow * window,
int * width,
int * height,
int * format,
void ** buffer 
)
+
+
Parameters
+ + + + + + +
[in]windowThe window whose color buffer to retrieve.
[out]widthWhere to store the width of the color buffer, or NULL.
[out]heightWhere to store the height of the color buffer, or NULL.
[out]formatWhere to store the OSMesa pixel format of the color buffer, or NULL.
[out]bufferWhere to store the address of the color buffer, or NULL.
+
+
+
Returns
GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetOSMesaDepthBuffer()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
int glfwGetOSMesaDepthBuffer (GLFWwindow * window,
int * width,
int * height,
int * bytesPerValue,
void ** buffer 
)
+
+
Parameters
+ + + + + + +
[in]windowThe window whose depth buffer to retrieve.
[out]widthWhere to store the width of the depth buffer, or NULL.
[out]heightWhere to store the height of the depth buffer, or NULL.
[out]bytesPerValueWhere to store the number of bytes per depth buffer element, or NULL.
[out]bufferWhere to store the address of the depth buffer, or NULL.
+
+
+
Returns
GLFW_TRUE if successful, or GLFW_FALSE if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetOSMesaContext()

+ +
+
+ + + + + + + + +
OSMesaContext glfwGetOSMesaContext (GLFWwindow * window)
+
+
Returns
The OSMesaContext of the specified window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NO_WINDOW_CONTEXT and GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
Since
Added in version 3.3.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__shapes.html b/deps/glfw-3.3.8/docs/html/group__shapes.html new file mode 100644 index 0000000..f5c1c20 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__shapes.html @@ -0,0 +1,191 @@ + + + + + + + +GLFW: Standard cursor shapes + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros
+
Standard cursor shapes
Input reference
+
+
+

Description

+

See standard cursor creation for how these are used.

+ + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_ARROW_CURSOR   0x00036001
 The regular arrow cursor shape. More...
 
#define GLFW_IBEAM_CURSOR   0x00036002
 The text input I-beam cursor shape. More...
 
#define GLFW_CROSSHAIR_CURSOR   0x00036003
 The crosshair shape. More...
 
#define GLFW_HAND_CURSOR   0x00036004
 The hand shape. More...
 
#define GLFW_HRESIZE_CURSOR   0x00036005
 The horizontal resize arrow shape. More...
 
#define GLFW_VRESIZE_CURSOR   0x00036006
 The vertical resize arrow shape. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_ARROW_CURSOR

+ +
+
+ + + + +
#define GLFW_ARROW_CURSOR   0x00036001
+
+

The regular arrow cursor.

+ +
+
+ +

◆ GLFW_IBEAM_CURSOR

+ +
+
+ + + + +
#define GLFW_IBEAM_CURSOR   0x00036002
+
+

The text input I-beam cursor shape.

+ +
+
+ +

◆ GLFW_CROSSHAIR_CURSOR

+ +
+
+ + + + +
#define GLFW_CROSSHAIR_CURSOR   0x00036003
+
+

The crosshair shape.

+ +
+
+ +

◆ GLFW_HAND_CURSOR

+ +
+
+ + + + +
#define GLFW_HAND_CURSOR   0x00036004
+
+

The hand shape.

+ +
+
+ +

◆ GLFW_HRESIZE_CURSOR

+ +
+
+ + + + +
#define GLFW_HRESIZE_CURSOR   0x00036005
+
+

The horizontal resize arrow shape.

+ +
+
+ +

◆ GLFW_VRESIZE_CURSOR

+ +
+
+ + + + +
#define GLFW_VRESIZE_CURSOR   0x00036006
+
+

The vertical resize arrow shape.

+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__vulkan.html b/deps/glfw-3.3.8/docs/html/group__vulkan.html new file mode 100644 index 0000000..f80f4a9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__vulkan.html @@ -0,0 +1,352 @@ + + + + + + + +GLFW: Vulkan support reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Typedefs | +Functions
+
Vulkan support reference
+
+
+

Description

+

This is the reference documentation for Vulkan related functions and types. For more task-oriented information, see the Vulkan guide.

+ + + + + +

+Typedefs

typedef void(* GLFWvkproc) (void)
 Vulkan API function pointer type. More...
 
+ + + + + + + + + + + + + + + + +

+Functions

int glfwVulkanSupported (void)
 Returns whether the Vulkan loader and an ICD have been found. More...
 
const char ** glfwGetRequiredInstanceExtensions (uint32_t *count)
 Returns the Vulkan instance extensions required by GLFW. More...
 
GLFWvkproc glfwGetInstanceProcAddress (VkInstance instance, const char *procname)
 Returns the address of the specified Vulkan instance function. More...
 
int glfwGetPhysicalDevicePresentationSupport (VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
 Returns whether the specified queue family can present images. More...
 
VkResult glfwCreateWindowSurface (VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
 Creates a Vulkan surface for the specified window. More...
 
+

Typedef Documentation

+ +

◆ GLFWvkproc

+ +
+
+ + + + +
typedef void(* GLFWvkproc) (void)
+
+

Generic function pointer used for returning Vulkan API function pointers without forcing a cast from a regular pointer.

+
See also
Querying Vulkan function pointers
+
+glfwGetInstanceProcAddress
+
Since
Added in version 3.2.
+ +
+
+

Function Documentation

+ +

◆ glfwVulkanSupported()

+ +
+
+ + + + + + + + +
int glfwVulkanSupported (void )
+
+

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 glfwGetRequiredInstanceExtensions to check whether the extensions necessary for Vulkan surface creation are available and glfwGetPhysicalDevicePresentationSupport to check whether a queue family of a physical device supports image presentation.

+
Returns
GLFW_TRUE if Vulkan is minimally available, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread.
+
See also
Querying for Vulkan support
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetRequiredInstanceExtensions()

+ +
+
+ + + + + + + + +
const char ** glfwGetRequiredInstanceExtensions (uint32_t * count)
+
+

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 GLFW_API_UNAVAILABLE error. Call 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.

+
Parameters
+ + +
[out]countWhere to store the number of extensions in the returned array. This is set to zero if an error occurred.
+
+
+
Returns
An array of ASCII encoded extension names, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_API_UNAVAILABLE.
+
Remarks
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.
+
See also
Querying required Vulkan extensions
+
+glfwCreateWindowSurface
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetInstanceProcAddress()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWvkproc glfwGetInstanceProcAddress (VkInstance instance,
const char * procname 
)
+
+

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 GLFW_API_UNAVAILABLE error. Call 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.

+
Parameters
+ + + +
[in]instanceThe Vulkan instance to query, or NULL to retrieve functions related to instance creation.
[in]procnameThe ASCII encoded name of the function.
+
+
+
Returns
The address of the function, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Querying Vulkan function pointers
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetPhysicalDevicePresentationSupport()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int glfwGetPhysicalDevicePresentationSupport (VkInstance instance,
VkPhysicalDevice device,
uint32_t queuefamily 
)
+
+

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 GLFW_API_UNAVAILABLE error. Call glfwVulkanSupported to check whether Vulkan is at least minimally available and glfwGetRequiredInstanceExtensions to check what instance extensions are required.

+
Parameters
+ + + + +
[in]instanceThe instance that the physical device belongs to.
[in]deviceThe physical device that the queue family belongs to.
[in]queuefamilyThe index of the queue family to query.
+
+
+
Returns
GLFW_TRUE if the queue family supports presentation, or GLFW_FALSE otherwise.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_API_UNAVAILABLE and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
See also
Querying for Vulkan presentation support
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwCreateWindowSurface()

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

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 GLFW_API_UNAVAILABLE error. Call 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 GLFW_API_UNAVAILABLE error. Call 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 set to GLFW_NO_API otherwise it generates a 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.

+
Parameters
+ + + + + +
[in]instanceThe Vulkan instance to create the surface in.
[in]windowThe window to create the surface for.
[in]allocatorThe allocator to use, or NULL to use the default allocator.
[out]surfaceWhere to store the handle of the surface. This is set to VK_NULL_HANDLE if an error occurred.
+
+
+
Returns
VK_SUCCESS if successful, or a Vulkan error code if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_API_UNAVAILABLE, GLFW_PLATFORM_ERROR and GLFW_INVALID_VALUE
+
Remarks
If an error occurs before the creation call is made, GLFW returns the Vulkan error code most appropriate for the error. Appropriate use of glfwVulkanSupported and glfwGetRequiredInstanceExtensions should eliminate almost all occurrences of these errors.
+
+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 glfwGetRequiredInstanceExtensions.
+
+macOS: This function creates and sets a CAMetalLayer instance for the window content view, which is required for MoltenVK to function.
+
Thread safety
This function may be called from any thread. For synchronization details of Vulkan objects, see the Vulkan specification.
+
See also
Creating a Vulkan window surface
+
+glfwGetRequiredInstanceExtensions
+
Since
Added in version 3.2.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/group__window.html b/deps/glfw-3.3.8/docs/html/group__window.html new file mode 100644 index 0000000..0a44b40 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/group__window.html @@ -0,0 +1,3427 @@ + + + + + + + +GLFW: Window reference + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Macros | +Typedefs | +Functions
+
Window reference
+
+
+

Description

+

This is the reference documentation for window related functions and types, including creation, deletion and event polling. For more task-oriented information, see the Window guide.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Macros

#define GLFW_FOCUSED   0x00020001
 Input focus window hint and attribute. More...
 
#define GLFW_ICONIFIED   0x00020002
 Window iconification window attribute. More...
 
#define GLFW_RESIZABLE   0x00020003
 Window resize-ability window hint and attribute. More...
 
#define GLFW_VISIBLE   0x00020004
 Window visibility window hint and attribute. More...
 
#define GLFW_DECORATED   0x00020005
 Window decoration window hint and attribute. More...
 
#define GLFW_AUTO_ICONIFY   0x00020006
 Window auto-iconification window hint and attribute. More...
 
#define GLFW_FLOATING   0x00020007
 Window decoration window hint and attribute. More...
 
#define GLFW_MAXIMIZED   0x00020008
 Window maximization window hint and attribute. More...
 
#define GLFW_CENTER_CURSOR   0x00020009
 Cursor centering window hint. More...
 
#define GLFW_TRANSPARENT_FRAMEBUFFER   0x0002000A
 Window framebuffer transparency hint and attribute. More...
 
#define GLFW_HOVERED   0x0002000B
 Mouse cursor hover window attribute. More...
 
#define GLFW_FOCUS_ON_SHOW   0x0002000C
 Input focus on calling show window hint and attribute. More...
 
#define GLFW_RED_BITS   0x00021001
 Framebuffer bit depth hint. More...
 
#define GLFW_GREEN_BITS   0x00021002
 Framebuffer bit depth hint. More...
 
#define GLFW_BLUE_BITS   0x00021003
 Framebuffer bit depth hint. More...
 
#define GLFW_ALPHA_BITS   0x00021004
 Framebuffer bit depth hint. More...
 
#define GLFW_DEPTH_BITS   0x00021005
 Framebuffer bit depth hint. More...
 
#define GLFW_STENCIL_BITS   0x00021006
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_RED_BITS   0x00021007
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_GREEN_BITS   0x00021008
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_BLUE_BITS   0x00021009
 Framebuffer bit depth hint. More...
 
#define GLFW_ACCUM_ALPHA_BITS   0x0002100A
 Framebuffer bit depth hint. More...
 
#define GLFW_AUX_BUFFERS   0x0002100B
 Framebuffer auxiliary buffer hint. More...
 
#define GLFW_STEREO   0x0002100C
 OpenGL stereoscopic rendering hint. More...
 
#define GLFW_SAMPLES   0x0002100D
 Framebuffer MSAA samples hint. More...
 
#define GLFW_SRGB_CAPABLE   0x0002100E
 Framebuffer sRGB hint. More...
 
#define GLFW_REFRESH_RATE   0x0002100F
 Monitor refresh rate hint. More...
 
#define GLFW_DOUBLEBUFFER   0x00021010
 Framebuffer double buffering hint. More...
 
#define GLFW_CLIENT_API   0x00022001
 Context client API hint and attribute. More...
 
#define GLFW_CONTEXT_VERSION_MAJOR   0x00022002
 Context client API major version hint and attribute. More...
 
#define GLFW_CONTEXT_VERSION_MINOR   0x00022003
 Context client API minor version hint and attribute. More...
 
#define GLFW_CONTEXT_REVISION   0x00022004
 Context client API revision number attribute. More...
 
#define GLFW_CONTEXT_ROBUSTNESS   0x00022005
 Context robustness hint and attribute. More...
 
#define GLFW_OPENGL_FORWARD_COMPAT   0x00022006
 OpenGL forward-compatibility hint and attribute. More...
 
#define GLFW_OPENGL_DEBUG_CONTEXT   0x00022007
 Debug mode context hint and attribute. More...
 
#define GLFW_OPENGL_PROFILE   0x00022008
 OpenGL profile hint and attribute. More...
 
#define GLFW_CONTEXT_RELEASE_BEHAVIOR   0x00022009
 Context flush-on-release hint and attribute. More...
 
#define GLFW_CONTEXT_NO_ERROR   0x0002200A
 Context error suppression hint and attribute. More...
 
#define GLFW_CONTEXT_CREATION_API   0x0002200B
 Context creation API hint and attribute. More...
 
#define GLFW_SCALE_TO_MONITOR   0x0002200C
 Window content area scaling window window hint. More...
 
#define GLFW_COCOA_RETINA_FRAMEBUFFER   0x00023001
 macOS specific window hint. More...
 
#define GLFW_COCOA_FRAME_NAME   0x00023002
 macOS specific window hint. More...
 
#define GLFW_COCOA_GRAPHICS_SWITCHING   0x00023003
 macOS specific window hint. More...
 
#define GLFW_X11_CLASS_NAME   0x00024001
 X11 specific window hint. More...
 
#define GLFW_X11_INSTANCE_NAME   0x00024002
 X11 specific window hint. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Typedefs

typedef struct GLFWwindow GLFWwindow
 Opaque window object. More...
 
typedef void(* GLFWwindowposfun) (GLFWwindow *window, int xpos, int ypos)
 The function pointer type for window position callbacks. More...
 
typedef void(* GLFWwindowsizefun) (GLFWwindow *window, int width, int height)
 The function pointer type for window size callbacks. More...
 
typedef void(* GLFWwindowclosefun) (GLFWwindow *window)
 The function pointer type for window close callbacks. More...
 
typedef void(* GLFWwindowrefreshfun) (GLFWwindow *window)
 The function pointer type for window content refresh callbacks. More...
 
typedef void(* GLFWwindowfocusfun) (GLFWwindow *window, int focused)
 The function pointer type for window focus callbacks. More...
 
typedef void(* GLFWwindowiconifyfun) (GLFWwindow *window, int iconified)
 The function pointer type for window iconify callbacks. More...
 
typedef void(* GLFWwindowmaximizefun) (GLFWwindow *window, int maximized)
 The function pointer type for window maximize callbacks. More...
 
typedef void(* GLFWframebuffersizefun) (GLFWwindow *window, int width, int height)
 The function pointer type for framebuffer size callbacks. More...
 
typedef void(* GLFWwindowcontentscalefun) (GLFWwindow *window, float xscale, float yscale)
 The function pointer type for window content scale callbacks. More...
 
typedef struct GLFWimage GLFWimage
 Image data. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

void glfwDefaultWindowHints (void)
 Resets all window hints to their default values. More...
 
void glfwWindowHint (int hint, int value)
 Sets the specified window hint to the desired value. More...
 
void glfwWindowHintString (int hint, const char *value)
 Sets the specified window hint to the desired value. More...
 
GLFWwindow * glfwCreateWindow (int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
 Creates a window and its associated context. More...
 
void glfwDestroyWindow (GLFWwindow *window)
 Destroys the specified window and its context. More...
 
int glfwWindowShouldClose (GLFWwindow *window)
 Checks the close flag of the specified window. More...
 
void glfwSetWindowShouldClose (GLFWwindow *window, int value)
 Sets the close flag of the specified window. More...
 
void glfwSetWindowTitle (GLFWwindow *window, const char *title)
 Sets the title of the specified window. More...
 
void glfwSetWindowIcon (GLFWwindow *window, int count, const GLFWimage *images)
 Sets the icon for the specified window. More...
 
void glfwGetWindowPos (GLFWwindow *window, int *xpos, int *ypos)
 Retrieves the position of the content area of the specified window. More...
 
void glfwSetWindowPos (GLFWwindow *window, int xpos, int ypos)
 Sets the position of the content area of the specified window. More...
 
void glfwGetWindowSize (GLFWwindow *window, int *width, int *height)
 Retrieves the size of the content area of the specified window. More...
 
void glfwSetWindowSizeLimits (GLFWwindow *window, int minwidth, int minheight, int maxwidth, int maxheight)
 Sets the size limits of the specified window. More...
 
void glfwSetWindowAspectRatio (GLFWwindow *window, int numer, int denom)
 Sets the aspect ratio of the specified window. More...
 
void glfwSetWindowSize (GLFWwindow *window, int width, int height)
 Sets the size of the content area of the specified window. More...
 
void glfwGetFramebufferSize (GLFWwindow *window, int *width, int *height)
 Retrieves the size of the framebuffer of the specified window. More...
 
void glfwGetWindowFrameSize (GLFWwindow *window, int *left, int *top, int *right, int *bottom)
 Retrieves the size of the frame of the window. More...
 
void glfwGetWindowContentScale (GLFWwindow *window, float *xscale, float *yscale)
 Retrieves the content scale for the specified window. More...
 
float glfwGetWindowOpacity (GLFWwindow *window)
 Returns the opacity of the whole window. More...
 
void glfwSetWindowOpacity (GLFWwindow *window, float opacity)
 Sets the opacity of the whole window. More...
 
void glfwIconifyWindow (GLFWwindow *window)
 Iconifies the specified window. More...
 
void glfwRestoreWindow (GLFWwindow *window)
 Restores the specified window. More...
 
void glfwMaximizeWindow (GLFWwindow *window)
 Maximizes the specified window. More...
 
void glfwShowWindow (GLFWwindow *window)
 Makes the specified window visible. More...
 
void glfwHideWindow (GLFWwindow *window)
 Hides the specified window. More...
 
void glfwFocusWindow (GLFWwindow *window)
 Brings the specified window to front and sets input focus. More...
 
void glfwRequestWindowAttention (GLFWwindow *window)
 Requests user attention to the specified window. More...
 
GLFWmonitor * glfwGetWindowMonitor (GLFWwindow *window)
 Returns the monitor that the window uses for full screen mode. More...
 
void glfwSetWindowMonitor (GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate)
 Sets the mode, monitor, video mode and placement of a window. More...
 
int glfwGetWindowAttrib (GLFWwindow *window, int attrib)
 Returns an attribute of the specified window. More...
 
void glfwSetWindowAttrib (GLFWwindow *window, int attrib, int value)
 Sets an attribute of the specified window. More...
 
void glfwSetWindowUserPointer (GLFWwindow *window, void *pointer)
 Sets the user pointer of the specified window. More...
 
void * glfwGetWindowUserPointer (GLFWwindow *window)
 Returns the user pointer of the specified window. More...
 
GLFWwindowposfun glfwSetWindowPosCallback (GLFWwindow *window, GLFWwindowposfun callback)
 Sets the position callback for the specified window. More...
 
GLFWwindowsizefun glfwSetWindowSizeCallback (GLFWwindow *window, GLFWwindowsizefun callback)
 Sets the size callback for the specified window. More...
 
GLFWwindowclosefun glfwSetWindowCloseCallback (GLFWwindow *window, GLFWwindowclosefun callback)
 Sets the close callback for the specified window. More...
 
GLFWwindowrefreshfun glfwSetWindowRefreshCallback (GLFWwindow *window, GLFWwindowrefreshfun callback)
 Sets the refresh callback for the specified window. More...
 
GLFWwindowfocusfun glfwSetWindowFocusCallback (GLFWwindow *window, GLFWwindowfocusfun callback)
 Sets the focus callback for the specified window. More...
 
GLFWwindowiconifyfun glfwSetWindowIconifyCallback (GLFWwindow *window, GLFWwindowiconifyfun callback)
 Sets the iconify callback for the specified window. More...
 
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback (GLFWwindow *window, GLFWwindowmaximizefun callback)
 Sets the maximize callback for the specified window. More...
 
GLFWframebuffersizefun glfwSetFramebufferSizeCallback (GLFWwindow *window, GLFWframebuffersizefun callback)
 Sets the framebuffer resize callback for the specified window. More...
 
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback (GLFWwindow *window, GLFWwindowcontentscalefun callback)
 Sets the window content scale callback for the specified window. More...
 
void glfwPollEvents (void)
 Processes all pending events. More...
 
void glfwWaitEvents (void)
 Waits until events are queued and processes them. More...
 
void glfwWaitEventsTimeout (double timeout)
 Waits with timeout until events are queued and processes them. More...
 
void glfwPostEmptyEvent (void)
 Posts an empty event to the event queue. More...
 
void glfwSwapBuffers (GLFWwindow *window)
 Swaps the front and back buffers of the specified window. More...
 
+

Macro Definition Documentation

+ +

◆ GLFW_FOCUSED

+ +
+
+ + + + +
#define GLFW_FOCUSED   0x00020001
+
+

Input focus window hint or window attribute.

+ +
+
+ +

◆ GLFW_ICONIFIED

+ +
+
+ + + + +
#define GLFW_ICONIFIED   0x00020002
+
+

Window iconification window attribute.

+ +
+
+ +

◆ GLFW_RESIZABLE

+ +
+
+ + + + +
#define GLFW_RESIZABLE   0x00020003
+
+

Window resize-ability window hint and window attribute.

+ +
+
+ +

◆ GLFW_VISIBLE

+ +
+
+ + + + +
#define GLFW_VISIBLE   0x00020004
+
+

Window visibility window hint and window attribute.

+ +
+
+ +

◆ GLFW_DECORATED

+ +
+
+ + + + +
#define GLFW_DECORATED   0x00020005
+
+

Window decoration window hint and window attribute.

+ +
+
+ +

◆ GLFW_AUTO_ICONIFY

+ +
+
+ + + + +
#define GLFW_AUTO_ICONIFY   0x00020006
+
+

Window auto-iconification window hint and window attribute.

+ +
+
+ +

◆ GLFW_FLOATING

+ +
+
+ + + + +
#define GLFW_FLOATING   0x00020007
+
+

Window decoration window hint and window attribute.

+ +
+
+ +

◆ GLFW_MAXIMIZED

+ +
+
+ + + + +
#define GLFW_MAXIMIZED   0x00020008
+
+

Window maximization window hint and window attribute.

+ +
+
+ +

◆ GLFW_CENTER_CURSOR

+ +
+
+ + + + +
#define GLFW_CENTER_CURSOR   0x00020009
+
+

Cursor centering window hint.

+ +
+
+ +

◆ GLFW_TRANSPARENT_FRAMEBUFFER

+ +
+
+ + + + +
#define GLFW_TRANSPARENT_FRAMEBUFFER   0x0002000A
+
+

Window framebuffer transparency window hint and window attribute.

+ +
+
+ +

◆ GLFW_HOVERED

+ +
+
+ + + + +
#define GLFW_HOVERED   0x0002000B
+
+

Mouse cursor hover window attribute.

+ +
+
+ +

◆ GLFW_FOCUS_ON_SHOW

+ +
+
+ + + + +
#define GLFW_FOCUS_ON_SHOW   0x0002000C
+
+

Input focus window hint or window attribute.

+ +
+
+ +

◆ GLFW_RED_BITS

+ +
+
+ + + + +
#define GLFW_RED_BITS   0x00021001
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_GREEN_BITS

+ +
+
+ + + + +
#define GLFW_GREEN_BITS   0x00021002
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_BLUE_BITS

+ +
+
+ + + + +
#define GLFW_BLUE_BITS   0x00021003
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_ALPHA_BITS

+ +
+
+ + + + +
#define GLFW_ALPHA_BITS   0x00021004
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_DEPTH_BITS

+ +
+
+ + + + +
#define GLFW_DEPTH_BITS   0x00021005
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_STENCIL_BITS

+ +
+
+ + + + +
#define GLFW_STENCIL_BITS   0x00021006
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_ACCUM_RED_BITS

+ +
+
+ + + + +
#define GLFW_ACCUM_RED_BITS   0x00021007
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_ACCUM_GREEN_BITS

+ +
+
+ + + + +
#define GLFW_ACCUM_GREEN_BITS   0x00021008
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_ACCUM_BLUE_BITS

+ +
+
+ + + + +
#define GLFW_ACCUM_BLUE_BITS   0x00021009
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_ACCUM_ALPHA_BITS

+ +
+
+ + + + +
#define GLFW_ACCUM_ALPHA_BITS   0x0002100A
+
+

Framebuffer bit depth hint.

+ +
+
+ +

◆ GLFW_AUX_BUFFERS

+ +
+
+ + + + +
#define GLFW_AUX_BUFFERS   0x0002100B
+
+

Framebuffer auxiliary buffer hint.

+ +
+
+ +

◆ GLFW_STEREO

+ +
+
+ + + + +
#define GLFW_STEREO   0x0002100C
+
+

OpenGL stereoscopic rendering hint.

+ +
+
+ +

◆ GLFW_SAMPLES

+ +
+
+ + + + +
#define GLFW_SAMPLES   0x0002100D
+
+

Framebuffer MSAA samples hint.

+ +
+
+ +

◆ GLFW_SRGB_CAPABLE

+ +
+
+ + + + +
#define GLFW_SRGB_CAPABLE   0x0002100E
+
+

Framebuffer sRGB hint.

+ +
+
+ +

◆ GLFW_REFRESH_RATE

+ +
+
+ + + + +
#define GLFW_REFRESH_RATE   0x0002100F
+
+

Monitor refresh rate hint.

+ +
+
+ +

◆ GLFW_DOUBLEBUFFER

+ +
+
+ + + + +
#define GLFW_DOUBLEBUFFER   0x00021010
+
+

Framebuffer double buffering hint.

+ +
+
+ +

◆ GLFW_CLIENT_API

+ +
+
+ + + + +
#define GLFW_CLIENT_API   0x00022001
+
+

Context client API hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_VERSION_MAJOR

+ +
+
+ + + + +
#define GLFW_CONTEXT_VERSION_MAJOR   0x00022002
+
+

Context client API major version hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_VERSION_MINOR

+ +
+
+ + + + +
#define GLFW_CONTEXT_VERSION_MINOR   0x00022003
+
+

Context client API minor version hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_REVISION

+ +
+
+ + + + +
#define GLFW_CONTEXT_REVISION   0x00022004
+
+

Context client API revision number attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_ROBUSTNESS

+ +
+
+ + + + +
#define GLFW_CONTEXT_ROBUSTNESS   0x00022005
+
+

Context client API revision number hint and attribute.

+ +
+
+ +

◆ GLFW_OPENGL_FORWARD_COMPAT

+ +
+
+ + + + +
#define GLFW_OPENGL_FORWARD_COMPAT   0x00022006
+
+

OpenGL forward-compatibility hint and attribute.

+ +
+
+ +

◆ GLFW_OPENGL_DEBUG_CONTEXT

+ +
+
+ + + + +
#define GLFW_OPENGL_DEBUG_CONTEXT   0x00022007
+
+

Debug mode context hint and attribute.

+ +
+
+ +

◆ GLFW_OPENGL_PROFILE

+ +
+
+ + + + +
#define GLFW_OPENGL_PROFILE   0x00022008
+
+

OpenGL profile hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_RELEASE_BEHAVIOR

+ +
+
+ + + + +
#define GLFW_CONTEXT_RELEASE_BEHAVIOR   0x00022009
+
+

Context flush-on-release hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_NO_ERROR

+ +
+
+ + + + +
#define GLFW_CONTEXT_NO_ERROR   0x0002200A
+
+

Context error suppression hint and attribute.

+ +
+
+ +

◆ GLFW_CONTEXT_CREATION_API

+ +
+
+ + + + +
#define GLFW_CONTEXT_CREATION_API   0x0002200B
+
+

Context creation API hint and attribute.

+ +
+
+ +

◆ GLFW_SCALE_TO_MONITOR

+ +
+
+ + + + +
#define GLFW_SCALE_TO_MONITOR   0x0002200C
+
+ +
+
+ +

◆ GLFW_COCOA_RETINA_FRAMEBUFFER

+ +
+
+ + + + +
#define GLFW_COCOA_RETINA_FRAMEBUFFER   0x00023001
+
+ +
+
+ +

◆ GLFW_COCOA_FRAME_NAME

+ +
+
+ + + + +
#define GLFW_COCOA_FRAME_NAME   0x00023002
+
+ +
+
+ +

◆ GLFW_COCOA_GRAPHICS_SWITCHING

+ +
+
+ + + + +
#define GLFW_COCOA_GRAPHICS_SWITCHING   0x00023003
+
+ +
+
+ +

◆ GLFW_X11_CLASS_NAME

+ +
+
+ + + + +
#define GLFW_X11_CLASS_NAME   0x00024001
+
+ +
+
+ +

◆ GLFW_X11_INSTANCE_NAME

+ +
+
+ + + + +
#define GLFW_X11_INSTANCE_NAME   0x00024002
+
+ +
+
+

Typedef Documentation

+ +

◆ GLFWwindow

+ +
+
+ + + + +
typedef struct GLFWwindow GLFWwindow
+
+

Opaque window object.

+
See also
Window objects
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWwindowposfun

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

This is the function pointer type for window position callbacks. A window position callback function has the following signature:

void callback_name(GLFWwindow* window, int xpos, int ypos)
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+
Parameters
+ + + + +
[in]windowThe window that was moved.
[in]xposThe new x-coordinate, in screen coordinates, of the upper-left corner of the content area of the window.
[in]yposThe new y-coordinate, in screen coordinates, of the upper-left corner of the content area of the window.
+
+
+
See also
Window position
+
+glfwSetWindowPosCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWwindowsizefun

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

This is the function pointer type for window size callbacks. A window size callback function has the following signature:

void callback_name(GLFWwindow* window, int width, int height)
+
Parameters
+ + + + +
[in]windowThe window that was resized.
[in]widthThe new width, in screen coordinates, of the window.
[in]heightThe new height, in screen coordinates, of the window.
+
+
+
See also
Window size
+
+glfwSetWindowSizeCallback
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ GLFWwindowclosefun

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

This is the function pointer type for window close callbacks. A window close callback function has the following signature:

void function_name(GLFWwindow* window)
+
Parameters
+ + +
[in]windowThe window that the user attempted to close.
+
+
+
See also
Window closing and close flag
+
+glfwSetWindowCloseCallback
+
Since
Added in version 2.5. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ GLFWwindowrefreshfun

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

This is the function pointer type for window content refresh callbacks. A window content refresh callback function has the following signature:

void function_name(GLFWwindow* window);
+
Parameters
+ + +
[in]windowThe window whose content needs to be refreshed.
+
+
+
See also
Window damage and refresh
+
+glfwSetWindowRefreshCallback
+
Since
Added in version 2.5. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ GLFWwindowfocusfun

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

This is the function pointer type for window focus callbacks. A window focus callback function has the following signature:

void function_name(GLFWwindow* window, int focused)
+
Parameters
+ + + +
[in]windowThe window that gained or lost input focus.
[in]focusedGLFW_TRUE if the window was given input focus, or GLFW_FALSE if it lost it.
+
+
+
See also
Window input focus
+
+glfwSetWindowFocusCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWwindowiconifyfun

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

This is the function pointer type for window iconify callbacks. A window iconify callback function has the following signature:

void function_name(GLFWwindow* window, int iconified)
+
Parameters
+ + + +
[in]windowThe window that was iconified or restored.
[in]iconifiedGLFW_TRUE if the window was iconified, or GLFW_FALSE if it was restored.
+
+
+
See also
Window iconification
+
+glfwSetWindowIconifyCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWwindowmaximizefun

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

This is the function pointer type for window maximize callbacks. A window maximize callback function has the following signature:

void function_name(GLFWwindow* window, int maximized)
+
Parameters
+ + + +
[in]windowThe window that was maximized or restored.
[in]maximizedGLFW_TRUE if the window was maximized, or GLFW_FALSE if it was restored.
+
+
+
See also
Window maximization
+
+glfwSetWindowMaximizeCallback
+
Since
Added in version 3.3.
+ +
+
+ +

◆ GLFWframebuffersizefun

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

This is the function pointer type for framebuffer size callbacks. A framebuffer size callback function has the following signature:

void function_name(GLFWwindow* window, int width, int height)
+
Parameters
+ + + + +
[in]windowThe window whose framebuffer was resized.
[in]widthThe new width, in pixels, of the framebuffer.
[in]heightThe new height, in pixels, of the framebuffer.
+
+
+
See also
Framebuffer size
+
+glfwSetFramebufferSizeCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ GLFWwindowcontentscalefun

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

This is the function pointer type for window content scale callbacks. A window content scale callback function has the following signature:

void function_name(GLFWwindow* window, float xscale, float yscale)
+
Parameters
+ + + + +
[in]windowThe window whose content scale changed.
[in]xscaleThe new x-axis content scale of the window.
[in]yscaleThe new y-axis content scale of the window.
+
+
+
See also
Window content scale
+
+glfwSetWindowContentScaleCallback
+
Since
Added in version 3.3.
+ +
+
+ +

◆ GLFWimage

+ +
+
+ + + + +
typedef struct GLFWimage GLFWimage
+
+

This describes a single 2D image. See the documentation for each related function what the expected pixel format is.

+
See also
Custom cursor creation
+
+Window icon
+
Since
Added in version 2.1. GLFW 3: Removed format and bytes-per-pixel members.
+ +
+
+

Function Documentation

+ +

◆ glfwDefaultWindowHints()

+ +
+
+ + + + + + + + +
void glfwDefaultWindowHints (void )
+
+

This function resets all window hints to their default values.

+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window creation hints
+
+glfwWindowHint
+
+glfwWindowHintString
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwWindowHint()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwWindowHint (int hint,
int value 
)
+
+

This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.

+

Only integer value hints can be set with this function. String value hints are set with 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 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.

+
Parameters
+ + + +
[in]hintThe window hint to set.
[in]valueThe new value of the window hint.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_INVALID_ENUM.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window creation hints
+
+glfwWindowHintString
+
+glfwDefaultWindowHints
+
Since
Added in version 3.0. Replaces glfwOpenWindowHint.
+ +
+
+ +

◆ glfwWindowHintString()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwWindowHintString (int hint,
const char * value 
)
+
+

This function sets hints for the next call to glfwCreateWindow. The hints, once set, retain their values until changed by a call to this function or glfwDefaultWindowHints, or until the library is terminated.

+

Only string type hints can be set with this function. Integer value hints are set with 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 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.

+
Parameters
+ + + +
[in]hintThe window hint to set.
[in]valueThe new value of the window hint.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Window creation hints
+
+glfwWindowHint
+
+glfwDefaultWindowHints
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwCreateWindow()

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

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.

+

Successful creation does not change which context is current. Before you can use the newly created context, you need to make it current. For information about the share parameter, see Context object sharing.

+

The created window, framebuffer and context may differ from what you requested, as not all parameters and hints are hard constraints. 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 glfwGetWindowAttrib, glfwGetWindowSize and 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 Retrieving 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 "Windowed full screen" windows.

+

Once you have created the window, you can switch it between windowed and full screen mode with 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, make it initially invisible using the GLFW_VISIBLE window hint, set its position and then show it.

+

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 after creation.

+

The swap interval is not set during window creation and the initial value may vary depending on driver settings and defaults.

+
Parameters
+ + + + + + +
[in]widthThe desired width, in screen coordinates, of the window. This must be greater than zero.
[in]heightThe desired height, in screen coordinates, of the window. This must be greater than zero.
[in]titleThe initial, UTF-8 encoded window title.
[in]monitorThe monitor to use for full screen mode, or NULL for windowed mode.
[in]shareThe window whose context to share resources with, or NULL to not share resources.
+
+
+
Returns
The handle of the created window, or NULL if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE, GLFW_API_UNAVAILABLE, GLFW_VERSION_UNAVAILABLE, GLFW_FORMAT_UNAVAILABLE and GLFW_PLATFORM_ERROR.
+
Remarks
Windows: Window creation will fail if the Microsoft GDI software OpenGL implementation is the only one available.
+
+Windows: 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 glfwSetWindowIcon.
+
+Windows: The context to share resources with must not be current on any other thread.
+
+macOS: The OS only supports forward-compatible 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_FORWARD_COMPAT and GLFW_OPENGL_PROFILE hints accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all on macOS.
+
+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 in the Mac Developer Library.
+
+macOS: The first time a window is created the menu bar is created. 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. Menu bar creation can be disabled entirely with the GLFW_COCOA_MENUBAR init hint.
+
+macOS: On OS X 10.10 and later the window frame will not be rendered at full resolution on Retina displays unless the GLFW_COCOA_RETINA_FRAMEBUFFER 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 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/MacOSXBundleInfo.plist.in in the source tree.
+
+macOS: When activating frame autosaving with GLFW_COCOA_FRAME_NAME, the specified window size and position may be overridden by previously saved values.
+
+X11: Some window managers will not respect the placement of initially hidden windows.
+
+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.
+
+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 and GLFW_X11_INSTANCE_NAME window hints to override this.
+
+Wayland: Compositors should implement the xdg-decoration protocol for GLFW to decorate the window properly. If this protocol isn't supported, or if the compositor prefers client-side decorations, a very simple fallback frame will be drawn using the wp_viewporter protocol. A compositor can still emit close, maximize or fullscreen events, using for instance a keybind mechanism. If neither of these protocols is supported, the window won't be decorated.
+
+Wayland: A full screen window will not attempt to change the mode, no matter what the requested size or refresh rate.
+
+Wayland: Screensaver inhibition requires the idle-inhibit protocol to be implemented in the user's compositor.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window creation
+
+glfwDestroyWindow
+
Since
Added in version 3.0. Replaces glfwOpenWindow.
+ +
+
+ +

◆ glfwDestroyWindow()

+ +
+
+ + + + + + + + +
void glfwDestroyWindow (GLFWwindow * window)
+
+

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.

+
Parameters
+ + +
[in]windowThe window to destroy.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and 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.
+
See also
Window creation
+
+glfwCreateWindow
+
Since
Added in version 3.0. Replaces glfwCloseWindow.
+ +
+
+ +

◆ glfwWindowShouldClose()

+ +
+
+ + + + + + + + +
int glfwWindowShouldClose (GLFWwindow * window)
+
+

This function returns the value of the close flag of the specified window.

+
Parameters
+ + +
[in]windowThe window to query.
+
+
+
Returns
The value of the close flag.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
Window closing and close flag
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowShouldClose()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetWindowShouldClose (GLFWwindow * window,
int value 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window whose flag to change.
[in]valueThe new value.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
Window closing and close flag
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowTitle()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetWindowTitle (GLFWwindow * window,
const char * title 
)
+
+

This function sets the window title, encoded as UTF-8, of the specified window.

+
Parameters
+ + + +
[in]windowThe window whose title to change.
[in]titleThe UTF-8 encoded window title.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
See also
Window title
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwSetWindowIcon()

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

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.

+
Parameters
+ + + + +
[in]windowThe window whose icon to set.
[in]countThe number of images in the specified array, or zero to revert to the default window icon.
[in]imagesThe images to create the icon from. This is ignored if count is zero.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Pointer lifetime
The specified image data is copied before this function returns.
+
Remarks
macOS: The GLFW window has no icon, as it is not a document window, so this function does nothing. The dock icon will be the same as the application bundle's icon. For more information on bundles, see the Bundle Programming Guide in the Mac Developer Library.
+
+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 always emits GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window icon
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetWindowPos()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetWindowPos (GLFWwindow * window,
int * xpos,
int * ypos 
)
+
+

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.

+
Parameters
+ + + + +
[in]windowThe window to query.
[out]xposWhere to store the x-coordinate of the upper-left corner of the content area, or NULL.
[out]yposWhere to store the y-coordinate of the upper-left corner of the content area, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: There is no way for an application to retrieve the global position of its windows, this function will always emit GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window position
+
+glfwSetWindowPos
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowPos()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetWindowPos (GLFWwindow * window,
int xpos,
int ypos 
)
+
+

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.

+
Parameters
+ + + + +
[in]windowThe window to query.
[in]xposThe x-coordinate of the upper-left corner of the content area.
[in]yposThe y-coordinate of the upper-left corner of the content area.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: There is no way for an application to set the global position of its windows, this function will always emit GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window position
+
+glfwGetWindowPos
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwGetWindowSize()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetWindowSize (GLFWwindow * window,
int * width,
int * height 
)
+
+

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 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.

+
Parameters
+ + + + +
[in]windowThe window whose size to retrieve.
[out]widthWhere to store the width, in screen coordinates, of the content area, or NULL.
[out]heightWhere to store the height, in screen coordinates, of the content area, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window size
+
+glfwSetWindowSize
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwSetWindowSizeLimits()

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

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.

+
Parameters
+ + + + + + +
[in]windowThe window to set limits for.
[in]minwidthThe minimum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.
[in]minheightThe minimum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.
[in]maxwidthThe maximum width, in screen coordinates, of the content area, or GLFW_DONT_CARE.
[in]maxheightThe maximum height, in screen coordinates, of the content area, or GLFW_DONT_CARE.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Remarks
If you set size limits and an aspect ratio that conflict, the results are undefined.
+
+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.
+
See also
Window size limits
+
+glfwSetWindowAspectRatio
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwSetWindowAspectRatio()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetWindowAspectRatio (GLFWwindow * window,
int numer,
int denom 
)
+
+

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.

+
Parameters
+ + + + +
[in]windowThe window to set limits for.
[in]numerThe numerator of the desired aspect ratio, or GLFW_DONT_CARE.
[in]denomThe denominator of the desired aspect ratio, or GLFW_DONT_CARE.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Remarks
If you set size limits and an aspect ratio that conflict, the results are undefined.
+
+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.
+
See also
Window size limits
+
+glfwSetWindowSizeLimits
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwSetWindowSize()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetWindowSize (GLFWwindow * window,
int width,
int height 
)
+
+

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 glfwSetWindowMonitor.

+

The window manager may put limits on what sizes are allowed. GLFW cannot and should not override these limits.

+
Parameters
+ + + + +
[in]windowThe window to resize.
[in]widthThe desired width, in screen coordinates, of the window content area.
[in]heightThe desired height, in screen coordinates, of the window content area.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: A full screen window will not attempt to change the mode, no matter what the requested size.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window size
+
+glfwGetWindowSize
+
+glfwSetWindowMonitor
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwGetFramebufferSize()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetFramebufferSize (GLFWwindow * window,
int * width,
int * height 
)
+
+

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 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.

+
Parameters
+ + + + +
[in]windowThe window whose framebuffer to query.
[out]widthWhere to store the width, in pixels, of the framebuffer, or NULL.
[out]heightWhere to store the height, in pixels, of the framebuffer, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Framebuffer size
+
+glfwSetFramebufferSizeCallback
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetWindowFrameSize()

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

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 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.

+
Parameters
+ + + + + + +
[in]windowThe window whose frame size to query.
[out]leftWhere to store the size, in screen coordinates, of the left edge of the window frame, or NULL.
[out]topWhere to store the size, in screen coordinates, of the top edge of the window frame, or NULL.
[out]rightWhere to store the size, in screen coordinates, of the right edge of the window frame, or NULL.
[out]bottomWhere to store the size, in screen coordinates, of the bottom edge of the window frame, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window size
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwGetWindowContentScale()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwGetWindowContentScale (GLFWwindow * window,
float * xscale,
float * yscale 
)
+
+

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 systems 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.

+
Parameters
+ + + + +
[in]windowThe window to query.
[out]xscaleWhere to store the x-axis content scale, or NULL.
[out]yscaleWhere to store the y-axis content scale, or NULL.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window content scale
+
+glfwSetWindowContentScaleCallback
+
+glfwGetMonitorContentScale
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetWindowOpacity()

+ +
+
+ + + + + + + + +
float glfwGetWindowOpacity (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to query.
+
+
+
Returns
The opacity value of the specified window.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window transparency
+
+glfwSetWindowOpacity
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetWindowOpacity()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetWindowOpacity (GLFWwindow * window,
float opacity 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window to set the opacity for.
[in]opacityThe desired opacity of the specified window.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window transparency
+
+glfwGetWindowOpacity
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwIconifyWindow()

+ +
+
+ + + + + + + + +
void glfwIconifyWindow (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to iconify.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window iconification
+
+glfwRestoreWindow
+
+glfwMaximizeWindow
+
Since
Added in version 2.1. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwRestoreWindow()

+ +
+
+ + + + + + + + +
void glfwRestoreWindow (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to restore.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window iconification
+
+glfwIconifyWindow
+
+glfwMaximizeWindow
+
Since
Added in version 2.1. GLFW 3: Added window handle parameter.
+ +
+
+ +

◆ glfwMaximizeWindow()

+ +
+
+ + + + + + + + +
void glfwMaximizeWindow (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to maximize.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread Safety
This function may only be called from the main thread.
+
See also
Window iconification
+
+glfwIconifyWindow
+
+glfwRestoreWindow
+
Since
Added in GLFW 3.2.
+ +
+
+ +

◆ glfwShowWindow()

+ +
+
+ + + + + + + + +
void glfwShowWindow (GLFWwindow * window)
+
+

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 window hint to change this behavior for all newly created windows, or change the behavior for an existing window with glfwSetWindowAttrib.

+
Parameters
+ + +
[in]windowThe window to make visible.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
See also
Window visibility
+
+glfwHideWindow
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwHideWindow()

+ +
+
+ + + + + + + + +
void glfwHideWindow (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to hide.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window visibility
+
+glfwShowWindow
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwFocusWindow()

+ +
+
+ + + + + + + + +
void glfwFocusWindow (GLFWwindow * window)
+
+

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 to disable this behavior.

+

Also by default, windowed mode windows are focused when shown with glfwShowWindow. Set the GLFW_FOCUS_ON_SHOW 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.

+
Parameters
+ + +
[in]windowThe window to give input focus.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
Wayland: It is not possible for an application to bring its windows to front, this function will always emit GLFW_PLATFORM_ERROR.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window input focus
+
+Window attention request
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwRequestWindowAttention()

+ +
+
+ + + + + + + + +
void glfwRequestWindowAttention (GLFWwindow * 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.

+
Parameters
+ + +
[in]windowThe window to request attention to.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
See also
Window attention request
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwGetWindowMonitor()

+ +
+
+ + + + + + + + +
GLFWmonitor * glfwGetWindowMonitor (GLFWwindow * window)
+
+

This function returns the handle of the monitor that the specified window is in full screen on.

+
Parameters
+ + +
[in]windowThe window to query.
+
+
+
Returns
The monitor, or NULL if the window is in windowed mode or an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window monitor
+
+glfwSetWindowMonitor
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowMonitor()

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

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 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.

+
Parameters
+ + + + + + + + +
[in]windowThe window whose monitor, size or video mode to set.
[in]monitorThe desired monitor, or NULL to set windowed mode.
[in]xposThe desired x-coordinate of the upper-left corner of the content area.
[in]yposThe desired y-coordinate of the upper-left corner of the content area.
[in]widthThe desired with, in screen coordinates, of the content area or video mode.
[in]heightThe desired height, in screen coordinates, of the content area or video mode.
[in]refreshRateThe desired refresh rate, in Hz, of the video mode, or GLFW_DONT_CARE.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Remarks
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.
+
+Wayland: The desired window position is ignored, as there is no way for an application to set this property.
+
+Wayland: Setting the window to full screen will not attempt to change the mode, no matter what the requested size or refresh rate.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window monitor
+
+Full screen windows
+
+glfwGetWindowMonitor
+
+glfwSetWindowSize
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwGetWindowAttrib()

+ +
+
+ + + + + + + + + + + + + + + + + + +
int glfwGetWindowAttrib (GLFWwindow * window,
int attrib 
)
+
+

This function returns the value of an attribute of the specified window or its OpenGL or OpenGL ES context.

+
Parameters
+ + + +
[in]windowThe window to query.
[in]attribThe window attribute whose value to return.
+
+
+
Returns
The value of the attribute, or zero if an error occurred.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM and GLFW_PLATFORM_ERROR.
+
Remarks
Framebuffer related hints are not window attributes. See Framebuffer related attributes for more information.
+
+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.
+
+Wayland: The Wayland protocol provides no way to check whether a window is iconfied, so GLFW_ICONIFIED always returns GLFW_FALSE.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window attributes
+
+glfwSetWindowAttrib
+
Since
Added in version 3.0. Replaces glfwGetWindowParam and glfwGetGLVersion.
+ +
+
+ +

◆ glfwSetWindowAttrib()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void glfwSetWindowAttrib (GLFWwindow * window,
int attrib,
int value 
)
+
+

This function sets the value of an attribute of the specified window.

+

The supported attributes are GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW.

+

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.

+
Parameters
+ + + + +
[in]windowThe window to set the attribute for.
[in]attribA supported window attribute.
[in]valueGLFW_TRUE or GLFW_FALSE.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_ENUM, GLFW_INVALID_VALUE and GLFW_PLATFORM_ERROR.
+
Remarks
Calling glfwGetWindowAttrib will always return the latest value, even if that value is ignored by the current mode of the window.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window attributes
+
+glfwGetWindowAttrib
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetWindowUserPointer()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void glfwSetWindowUserPointer (GLFWwindow * window,
void * pointer 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window whose pointer to set.
[in]pointerThe new value.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
User pointer
+
+glfwGetWindowUserPointer
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwGetWindowUserPointer()

+ +
+
+ + + + + + + + +
void * glfwGetWindowUserPointer (GLFWwindow * window)
+
+

This function returns the current value of the user-defined pointer of the specified window. The initial value is NULL.

+
Parameters
+ + +
[in]windowThe window whose pointer to return.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function may be called from any thread. Access is not synchronized.
+
See also
User pointer
+
+glfwSetWindowUserPointer
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowPosCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowposfun glfwSetWindowPosCallback (GLFWwindow * window,
GLFWwindowposfun callback 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int xpos, int ypos)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
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.
+
See also
Window position
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowSizeCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowsizefun glfwSetWindowSizeCallback (GLFWwindow * window,
GLFWwindowsizefun callback 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int width, int height)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window size
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetWindowCloseCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowclosefun glfwSetWindowCloseCallback (GLFWwindow * window,
GLFWwindowclosefun callback 
)
+
+

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 glfwSetWindowShouldClose.

+

The close callback is not triggered by glfwDestroyWindow.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
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.
+
See also
Window closing and close flag
+
Since
Added in version 2.5. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetWindowRefreshCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowrefreshfun glfwSetWindowRefreshCallback (GLFWwindow * window,
GLFWwindowrefreshfun callback 
)
+
+

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.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window);
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window damage and refresh
+
Since
Added in version 2.5. GLFW 3: Added window handle parameter and return value.
+ +
+
+ +

◆ glfwSetWindowFocusCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowfocusfun glfwSetWindowFocusCallback (GLFWwindow * window,
GLFWwindowfocusfun callback 
)
+
+

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 glfwSetKeyCallback and glfwSetMouseButtonCallback.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int focused)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window input focus
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowIconifyCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowiconifyfun glfwSetWindowIconifyCallback (GLFWwindow * window,
GLFWwindowiconifyfun callback 
)
+
+

This function sets the iconification callback of the specified window, which is called when the window is iconified or restored.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int iconified)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Remarks
Wayland: The XDG-shell protocol has no event for iconification, so this callback will never be called.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window iconification
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowMaximizeCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowmaximizefun glfwSetWindowMaximizeCallback (GLFWwindow * window,
GLFWwindowmaximizefun callback 
)
+
+

This function sets the maximization callback of the specified window, which is called when the window is maximized or restored.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int maximized)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window maximization
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwSetFramebufferSizeCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWframebuffersizefun glfwSetFramebufferSizeCallback (GLFWwindow * window,
GLFWframebuffersizefun callback 
)
+
+

This function sets the framebuffer resize callback of the specified window, which is called when the framebuffer of the specified window is resized.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, int width, int height)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Framebuffer size
+
Since
Added in version 3.0.
+ +
+
+ +

◆ glfwSetWindowContentScaleCallback()

+ +
+
+ + + + + + + + + + + + + + + + + + +
GLFWwindowcontentscalefun glfwSetWindowContentScaleCallback (GLFWwindow * window,
GLFWwindowcontentscalefun callback 
)
+
+

This function sets the window content scale callback of the specified window, which is called when the content scale of the specified window changes.

+
Parameters
+ + + +
[in]windowThe window whose callback to set.
[in]callbackThe new callback, or NULL to remove the currently set callback.
+
+
+
Returns
The previously set callback, or NULL if no callback was set or the library had not been initialized.
+
Callback signature
void function_name(GLFWwindow* window, float xscale, float yscale)
+
For more information about the callback parameters, see the function pointer type.
+
Errors
Possible errors include GLFW_NOT_INITIALIZED.
+
Thread safety
This function must only be called from the main thread.
+
See also
Window content scale
+
+glfwGetWindowContentScale
+
Since
Added in version 3.3.
+ +
+
+ +

◆ glfwPollEvents()

+ +
+
+ + + + + + + + +
void glfwPollEvents (void )
+
+

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 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 GLFW_NOT_INITIALIZED and 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.
+
See also
Event processing
+
+glfwWaitEvents
+
+glfwWaitEventsTimeout
+
Since
Added in version 1.0.
+ +
+
+ +

◆ glfwWaitEvents()

+ +
+
+ + + + + + + + +
void glfwWaitEvents (void )
+
+

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 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 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 GLFW_NOT_INITIALIZED and 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.
+
See also
Event processing
+
+glfwPollEvents
+
+glfwWaitEventsTimeout
+
Since
Added in version 2.5.
+ +
+
+ +

◆ glfwWaitEventsTimeout()

+ +
+
+ + + + + + + + +
void glfwWaitEventsTimeout (double timeout)
+
+

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 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 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.

+
Parameters
+ + +
[in]timeoutThe maximum amount of time, in seconds, to wait.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_INVALID_VALUE and 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.
+
See also
Event processing
+
+glfwPollEvents
+
+glfwWaitEvents
+
Since
Added in version 3.2.
+ +
+
+ +

◆ glfwPostEmptyEvent()

+ +
+
+ + + + + + + + +
void glfwPostEmptyEvent (void )
+
+

This function posts an empty event from the current thread to the event queue, causing glfwWaitEvents or glfwWaitEventsTimeout to return.

+
Errors
Possible errors include GLFW_NOT_INITIALIZED and GLFW_PLATFORM_ERROR.
+
Thread safety
This function may be called from any thread.
+
See also
Event processing
+
+glfwWaitEvents
+
+glfwWaitEventsTimeout
+
Since
Added in version 3.1.
+ +
+
+ +

◆ glfwSwapBuffers()

+ +
+
+ + + + + + + + +
void glfwSwapBuffers (GLFWwindow * 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 GLFW_NO_WINDOW_CONTEXT error.

+

This function does not apply to Vulkan. If you are rendering with Vulkan, see vkQueuePresentKHR instead.

+
Parameters
+ + +
[in]windowThe window whose buffers to swap.
+
+
+
Errors
Possible errors include GLFW_NOT_INITIALIZED, GLFW_NO_WINDOW_CONTEXT and GLFW_PLATFORM_ERROR.
+
Remarks
EGL: The context of the specified window must be current on the calling thread.
+
Thread safety
This function may be called from any thread.
+
See also
Buffer swapping
+
+glfwSwapInterval
+
Since
Added in version 1.0. GLFW 3: Added window handle parameter.
+ +
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/index.html b/deps/glfw-3.3.8/docs/html/index.html new file mode 100644 index 0000000..072fcc5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/index.html @@ -0,0 +1,93 @@ + + + + + + + +GLFW: Main Page + + + + + + + + + + +
+ + + + + + + + +
+ +
+
+ + +
+ +
+ +
+

+Introduction

+

GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and Vulkan application development. It provides a simple, platform-independent API for creating windows, contexts and surfaces, reading input, handling events, etc.

+

Release notes for version 3.3 list new features, caveats and deprecations.

+

Getting started is a guide for users new to GLFW. It takes you through how to write a small but complete program.

+

There are guides for each section of the API:

+ +

Once you have written a program, see Compiling GLFW and Building applications.

+

The reference documentation provides more detailed information about specific functions.

+

Moving from GLFW 2 to 3 explains what has changed and how to update existing code to use the new API.

+

There is a section on Guarantees and limitations for pointer lifetimes, reentrancy, thread safety, event order and backward and forward compatibility.

+

The FAQ answers many common questions about the design, implementation and use of GLFW.

+

Finally, Standards conformance explains what APIs, standards and protocols GLFW uses and what happens when they are not present on a given machine.

+

This documentation was generated with Doxygen. The sources for it are available in both the source distribution and GitHub repository.

+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/input_8dox.html b/deps/glfw-3.3.8/docs/html/input_8dox.html new file mode 100644 index 0000000..3765672 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/input_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: input.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
input.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/input_guide.html b/deps/glfw-3.3.8/docs/html/input_guide.html new file mode 100644 index 0000000..9c8c25f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/input_guide.html @@ -0,0 +1,562 @@ + + + + + + + +GLFW: Input guide + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Input guide
+
+
+

Table of Contents

+ +
+

This guide introduces the input related functions of GLFW. For details on a specific function in this category, see the Input reference. There are also guides for the other areas of GLFW.

+ +

GLFW provides many kinds of input. While some can only be polled, like time, or only received via callbacks, like scrolling, many provide both callbacks and polling. Callbacks are more work to use than polling but is less CPU intensive and guarantees that you do not miss state changes.

+

All input callbacks receive a window handle. By using the window user pointer, you can access non-global structures or objects from your callbacks.

+

To get a better feel for how the various events callbacks behave, run the events test program. It register every callback supported by GLFW and prints out all arguments provided for every event, along with time and sequence information.

+

+Event processing

+

GLFW needs to poll the window system for events both to provide input to the application and to prove to the window system that the application hasn't locked up. Event processing is normally done each frame after buffer swapping. Even when you have no windows, event polling needs to be done in order to receive monitor and joystick connection events.

+

There are three functions for processing pending events. glfwPollEvents, processes only those events that have already been received and then returns immediately.

+
glfwPollEvents();
+
glfwPollEvents
void glfwPollEvents(void)
Processes all pending events.
+

This is the best choice when rendering continuously, like most games do.

+

If you only need to update the contents of the window when you receive new input, glfwWaitEvents is a better choice.

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

It puts the thread to sleep until at least one event has been received and then processes all received events. This saves a great deal of CPU cycles and is useful for, for example, editing tools.

+

If you want to wait for events but have UI elements or other tasks that need periodic updates, glfwWaitEventsTimeout lets you specify a timeout.

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

It puts the thread to sleep until at least one event has been received, or until the specified number of seconds have elapsed. It then processes any received events.

+

If the main thread is sleeping in glfwWaitEvents, you can wake it from another thread by posting an empty event to the event queue with glfwPostEmptyEvent.

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

Do not assume that callbacks will only be called in response to the above functions. While it is necessary to process events in one or more of the ways above, 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.

+

For example, on Windows the system function that glfwSetWindowSize is implemented with will send window size events directly to the event callback that every window has and that GLFW implements for its windows. If you have set a window size callback GLFW will call it in turn with the new size before everything returns back out of the glfwSetWindowSize call.

+

+Keyboard input

+

GLFW divides keyboard input into two categories; key events and character events. Key events relate to actual physical keyboard keys, whereas character events relate to the Unicode code points generated by pressing some of them.

+

Keys and characters do not map 1:1. A single key press may produce several characters, and a single character may require several keys to produce. This may not be the case on your machine, but your users are likely not all using the same keyboard layout, input method or even operating system as you.

+

+Key input

+

If you wish to be notified when a physical key is pressed or released or when it repeats, set a key callback.

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

The callback function receives the keyboard key, platform-specific scancode, key action and modifier bits.

+
void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
+
{
+
if (key == GLFW_KEY_E && action == GLFW_PRESS)
+
activate_airship();
+
}
+
GLFW_PRESS
#define GLFW_PRESS
The key or mouse button was pressed.
Definition: glfw3.h:338
+
GLFW_KEY_E
#define GLFW_KEY_E
Definition: glfw3.h:416
+
GLFWwindow
struct GLFWwindow GLFWwindow
Opaque window object.
Definition: glfw3.h:1185
+

The action is one of GLFW_PRESS, GLFW_REPEAT or GLFW_RELEASE. Events with GLFW_PRESS and GLFW_RELEASE actions are emitted for every key press. Most keys will also emit events with GLFW_REPEAT actions while a key is held down.

+

Key events with GLFW_REPEAT actions are intended for text input. They are emitted at the rate set in the user's keyboard settings. At most one key is repeated even if several keys are held down. GLFW_REPEAT actions should not be relied on to know which keys are being held down or to drive animation. Instead you should either save the state of relevant keys based on GLFW_PRESS and GLFW_RELEASE actions, or call glfwGetKey, which provides basic cached key state.

+

The key will be one of the existing key tokens, or GLFW_KEY_UNKNOWN if GLFW lacks a token for it, for example E-mail and Play keys.

+

The scancode is unique for every key, regardless of whether it has a key token. Scancodes are platform-specific but consistent over time, so keys will have different scancodes depending on the platform but they are safe to save to disk. You can query the scancode for any named key on the current platform with glfwGetKeyScancode.

+
const int scancode = glfwGetKeyScancode(GLFW_KEY_X);
+
set_key_mapping(scancode, swap_weapons);
+
glfwGetKeyScancode
int glfwGetKeyScancode(int key)
Returns the platform-specific scancode of the specified key.
+
GLFW_KEY_X
#define GLFW_KEY_X
Definition: glfw3.h:435
+

The last reported state for every named key is also saved in per-window state arrays that can be polled with glfwGetKey.

+
int state = glfwGetKey(window, GLFW_KEY_E);
+
if (state == GLFW_PRESS)
+
{
+
activate_airship();
+
}
+
glfwGetKey
int glfwGetKey(GLFWwindow *window, int key)
Returns the last reported state of a keyboard key for the specified window.
+

The returned state is one of GLFW_PRESS or GLFW_RELEASE.

+

This function only returns cached key event state. It does not poll the system for the current physical state of the key.

+

Whenever you poll state, you risk missing the state change you are looking for. If a pressed key is released again before you poll its state, you will have missed the key press. The recommended solution for this is to use a key callback, but there is also the GLFW_STICKY_KEYS input mode.

+
glfwSetInputMode(window, GLFW_STICKY_KEYS, GLFW_TRUE);
+
GLFW_STICKY_KEYS
#define GLFW_STICKY_KEYS
Definition: glfw3.h:1049
+
GLFW_TRUE
#define GLFW_TRUE
One.
Definition: glfw3.h:312
+
glfwSetInputMode
void glfwSetInputMode(GLFWwindow *window, int mode, int value)
Sets an input option for the specified window.
+

When sticky keys mode is enabled, the pollable state of a key will remain GLFW_PRESS until the state of that key is polled with glfwGetKey. Once it has been polled, if a key release event had been processed in the meantime, the state will reset to GLFW_RELEASE, otherwise it will remain GLFW_PRESS.

+

If you wish to know what the state of the Caps Lock and Num Lock keys was when input events were generated, set the GLFW_LOCK_KEY_MODS input mode.

+
glfwSetInputMode(window, GLFW_LOCK_KEY_MODS, GLFW_TRUE);
+
GLFW_LOCK_KEY_MODS
#define GLFW_LOCK_KEY_MODS
Definition: glfw3.h:1051
+

When this input mode is enabled, any callback that receives modifier bits will have the GLFW_MOD_CAPS_LOCK bit set if Caps Lock was on when the event occurred and the GLFW_MOD_NUM_LOCK bit set if Num Lock was on.

+

The GLFW_KEY_LAST constant holds the highest value of any named key.

+

+Text input

+

GLFW supports text input in the form of a stream of Unicode code points, as produced by the operating system text input system. Unlike key input, text input obeys keyboard layouts and modifier keys and supports composing characters using dead keys. Once received, you can encode the code points into UTF-8 or any other encoding you prefer.

+

Because an unsigned int is 32 bits long on all platforms supported by GLFW, you can treat the code point argument as native endian UTF-32.

+

If you wish to offer regular text input, set a character callback.

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

The callback function receives Unicode code points for key events that would have led to regular text input and generally behaves as a standard text field on that platform.

+
void character_callback(GLFWwindow* window, unsigned int codepoint)
+
{
+
}
+

+Key names

+

If you wish to refer to keys by name, you can query the keyboard layout dependent name of printable keys with glfwGetKeyName.

+
const char* key_name = glfwGetKeyName(GLFW_KEY_W, 0);
+
show_tutorial_hint("Press %s to move forward", key_name);
+
glfwGetKeyName
const char * glfwGetKeyName(int key, int scancode)
Returns the layout-specific name of the specified printable key.
+
GLFW_KEY_W
#define GLFW_KEY_W
Definition: glfw3.h:434
+

This function can handle both keys and scancodes. If the specified key is GLFW_KEY_UNKNOWN then the scancode is used, otherwise it is ignored. This matches the behavior of the key callback, meaning the callback arguments can always be passed unmodified to this function.

+

+Mouse input

+

Mouse input comes in many forms, including mouse motion, button presses and scrolling offsets. The cursor appearance can also be changed, either to a custom image or a standard cursor shape from the system theme.

+

+Cursor position

+

If you wish to be notified when the cursor moves over the window, set a cursor position callback.

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

The callback functions receives the cursor position, measured in screen coordinates but relative to the top-left corner of the window content area. On platforms that provide it, the full sub-pixel cursor position is passed on.

+
static void cursor_position_callback(GLFWwindow* window, double xpos, double ypos)
+
{
+
}
+

The cursor position is also saved per-window and can be polled with glfwGetCursorPos.

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

+Cursor mode

+

The GLFW_CURSOR input mode provides several cursor modes for special forms of mouse motion input. By default, the cursor mode is GLFW_CURSOR_NORMAL, meaning the regular arrow cursor (or another cursor set with glfwSetCursor) is used and cursor motion is not limited.

+

If you wish to implement mouse motion based camera controls or other input schemes that require unlimited mouse movement, set the cursor mode to GLFW_CURSOR_DISABLED.

+
glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_DISABLED);
+
GLFW_CURSOR_DISABLED
#define GLFW_CURSOR_DISABLED
Definition: glfw3.h:1056
+
GLFW_CURSOR
#define GLFW_CURSOR
Definition: glfw3.h:1048
+

This will hide the cursor and lock it to the specified window. GLFW will then take care of all the details of cursor re-centering and offset calculation and providing the application with a virtual cursor position. This virtual position is provided normally via both the cursor position callback and through polling.

+
Note
You should not implement your own version of this functionality using other features of GLFW. It is not supported and will not work as robustly as GLFW_CURSOR_DISABLED.
+

If you only wish the cursor to become hidden when it is over a window but still want it to behave normally, set the cursor mode to GLFW_CURSOR_HIDDEN.

+
glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_HIDDEN);
+
GLFW_CURSOR_HIDDEN
#define GLFW_CURSOR_HIDDEN
Definition: glfw3.h:1055
+

This mode puts no limit on the motion of the cursor.

+

To exit out of either of these special modes, restore the GLFW_CURSOR_NORMAL cursor mode.

+
glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_NORMAL);
+
GLFW_CURSOR_NORMAL
#define GLFW_CURSOR_NORMAL
Definition: glfw3.h:1054
+

+

+Raw mouse motion

+

When the cursor is disabled, raw (unscaled and unaccelerated) mouse motion can be enabled if available.

+

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.

+

Call glfwRawMouseMotionSupported to check if the current machine provides raw motion and set the GLFW_RAW_MOUSE_MOTION input mode to enable it. It is disabled by default.

+
if (glfwRawMouseMotionSupported())
+
glfwSetInputMode(window, GLFW_RAW_MOUSE_MOTION, GLFW_TRUE);
+
GLFW_RAW_MOUSE_MOTION
#define GLFW_RAW_MOUSE_MOTION
Definition: glfw3.h:1052
+
glfwRawMouseMotionSupported
int glfwRawMouseMotionSupported(void)
Returns whether raw mouse motion is supported.
+

If supported, raw mouse motion can be enabled or disabled per-window and at any time but it will only be provided when the cursor is disabled.

+

+Cursor objects

+

GLFW supports creating both custom and system theme cursor images, encapsulated as GLFWcursor objects. They are created with glfwCreateCursor or glfwCreateStandardCursor and destroyed with glfwDestroyCursor, or glfwTerminate, if any remain.

+

+Custom cursor creation

+

A custom cursor is created with glfwCreateCursor, which returns a handle to the created cursor object. For example, this creates a 16x16 white square cursor with the hot-spot in the upper-left corner:

+
unsigned char pixels[16 * 16 * 4];
+
memset(pixels, 0xff, sizeof(pixels));
+
+
GLFWimage image;
+
image.width = 16;
+
image.height = 16;
+
image.pixels = pixels;
+
+
GLFWcursor* cursor = glfwCreateCursor(&image, 0, 0);
+
glfwCreateCursor
GLFWcursor * glfwCreateCursor(const GLFWimage *image, int xhot, int yhot)
Creates a custom cursor.
+
GLFWcursor
struct GLFWcursor GLFWcursor
Opaque cursor object.
Definition: glfw3.h:1197
+
GLFWimage
Image data.
Definition: glfw3.h:1721
+
GLFWimage::height
int height
Definition: glfw3.h:1727
+
GLFWimage::pixels
unsigned char * pixels
Definition: glfw3.h:1730
+
GLFWimage::width
int width
Definition: glfw3.h:1724
+

If cursor creation fails, NULL will be returned, so it is necessary to check the return value.

+

The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. The pixels are arranged canonically as sequential rows, starting from the top-left corner.

+

+Standard cursor creation

+

A cursor with a standard shape from the current system cursor theme can be can be created with glfwCreateStandardCursor.

+
GLFWcursor* cursor = glfwCreateStandardCursor(GLFW_HRESIZE_CURSOR);
+
glfwCreateStandardCursor
GLFWcursor * glfwCreateStandardCursor(int shape)
Creates a cursor with a standard shape.
+
GLFW_HRESIZE_CURSOR
#define GLFW_HRESIZE_CURSOR
The horizontal resize arrow shape.
Definition: glfw3.h:1098
+

These cursor objects behave in the exact same way as those created with glfwCreateCursor except that the system cursor theme provides the actual image.

+

+Cursor destruction

+

When a cursor is no longer needed, destroy it with glfwDestroyCursor.

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

Cursor destruction always succeeds. If the cursor is current for any window, that window will revert to the default cursor. This does not affect the cursor mode. All remaining cursors are destroyed when glfwTerminate is called.

+

+Cursor setting

+

A cursor can be set as current for a window with glfwSetCursor.

+
glfwSetCursor(window, cursor);
+
glfwSetCursor
void glfwSetCursor(GLFWwindow *window, GLFWcursor *cursor)
Sets the cursor for the window.
+

Once set, the cursor image will be used as long as the system cursor is over the content area of the window and the cursor mode is set to GLFW_CURSOR_NORMAL.

+

A single cursor may be set for any number of windows.

+

To revert to the default cursor, set the cursor of that window to NULL.

+
glfwSetCursor(window, NULL);
+

When a cursor is destroyed, any window that has it set will revert to the default cursor. This does not affect the cursor mode.

+

+Cursor enter/leave events

+

If you wish to be notified when the cursor enters or leaves the content area of a window, set a cursor enter/leave callback.

+
glfwSetCursorEnterCallback(window, cursor_enter_callback);
+
glfwSetCursorEnterCallback
GLFWcursorenterfun glfwSetCursorEnterCallback(GLFWwindow *window, GLFWcursorenterfun callback)
Sets the cursor enter/leave callback.
+

The callback function receives the new classification of the cursor.

+
void cursor_enter_callback(GLFWwindow* window, int entered)
+
{
+
if (entered)
+
{
+
// The cursor entered the content area of the window
+
}
+
else
+
{
+
// The cursor left the content area of the window
+
}
+
}
+

You can query whether the cursor is currently inside the content area of the window with the GLFW_HOVERED window attribute.

+
if (glfwGetWindowAttrib(window, GLFW_HOVERED))
+
{
+
highlight_interface();
+
}
+
GLFW_HOVERED
#define GLFW_HOVERED
Mouse cursor hover window attribute.
Definition: glfw3.h:855
+
glfwGetWindowAttrib
int glfwGetWindowAttrib(GLFWwindow *window, int attrib)
Returns an attribute of the specified window.
+

+Mouse button input

+

If you wish to be notified when a mouse button is pressed or released, set a mouse button callback.

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

The callback function receives the mouse button, button action and modifier bits.

+
void mouse_button_callback(GLFWwindow* window, int button, int action, int mods)
+
{
+
if (button == GLFW_MOUSE_BUTTON_RIGHT && action == GLFW_PRESS)
+
popup_menu();
+
}
+
GLFW_MOUSE_BUTTON_RIGHT
#define GLFW_MOUSE_BUTTON_RIGHT
Definition: glfw3.h:581
+

The action is one of GLFW_PRESS or GLFW_RELEASE.

+

Mouse button states for named buttons are also saved in per-window state arrays that can be polled with glfwGetMouseButton.

+
int state = glfwGetMouseButton(window, GLFW_MOUSE_BUTTON_LEFT);
+
if (state == GLFW_PRESS)
+
{
+
upgrade_cow();
+
}
+
GLFW_MOUSE_BUTTON_LEFT
#define GLFW_MOUSE_BUTTON_LEFT
Definition: glfw3.h:580
+
glfwGetMouseButton
int glfwGetMouseButton(GLFWwindow *window, int button)
Returns the last reported state of a mouse button for the specified window.
+

The returned state is one of GLFW_PRESS or GLFW_RELEASE.

+

This function only returns cached mouse button event state. It does not poll the system for the current state of the mouse button.

+

Whenever you poll state, you risk missing the state change you are looking for. If a pressed mouse button is released again before you poll its state, you will have missed the button press. The recommended solution for this is to use a mouse button callback, but there is also the GLFW_STICKY_MOUSE_BUTTONS input mode.

+
glfwSetInputMode(window, GLFW_STICKY_MOUSE_BUTTONS, GLFW_TRUE);
+
GLFW_STICKY_MOUSE_BUTTONS
#define GLFW_STICKY_MOUSE_BUTTONS
Definition: glfw3.h:1050
+

When sticky mouse buttons mode is enabled, the pollable state of a mouse button will remain GLFW_PRESS until the state of that button is polled with glfwGetMouseButton. Once it has been polled, if a mouse button release event had been processed in the meantime, the state will reset to GLFW_RELEASE, otherwise it will remain GLFW_PRESS.

+

The GLFW_MOUSE_BUTTON_LAST constant holds the highest value of any named button.

+

+Scroll input

+

If you wish to be notified when the user scrolls, whether with a mouse wheel or touchpad gesture, set a scroll callback.

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

The callback function receives two-dimensional scroll offsets.

+
void scroll_callback(GLFWwindow* window, double xoffset, double yoffset)
+
{
+
}
+

A normal mouse wheel, being vertical, provides offsets along the Y-axis.

+

+Joystick input

+

The joystick functions expose connected joysticks and controllers, with both referred to as joysticks. It supports up to sixteen joysticks, ranging from GLFW_JOYSTICK_1, GLFW_JOYSTICK_2 up to and including GLFW_JOYSTICK_16 or GLFW_JOYSTICK_LAST. You can test whether a joystick is present with glfwJoystickPresent.

+
int present = glfwJoystickPresent(GLFW_JOYSTICK_1);
+
glfwJoystickPresent
int glfwJoystickPresent(int jid)
Returns whether the specified joystick is present.
+
GLFW_JOYSTICK_1
#define GLFW_JOYSTICK_1
Definition: glfw3.h:592
+

Each joystick has zero or more axes, zero or more buttons, zero or more hats, a human-readable name, a user pointer and an SDL compatible GUID.

+

When GLFW is initialized, detected joysticks are added to the beginning of the array. Once a joystick is detected, it keeps its assigned ID until it is disconnected or the library is terminated, so as joysticks are connected and disconnected, there may appear gaps in the IDs.

+

Joystick axis, button and hat state is updated when polled and does not require a window to be created or events to be processed. However, if you want joystick connection and disconnection events reliably delivered to the joystick callback then you must process events.

+

To see all the properties of all connected joysticks in real-time, run the joysticks test program.

+

+Joystick axis states

+

The positions of all axes of a joystick are returned by glfwGetJoystickAxes. See the reference documentation for the lifetime of the returned array.

+
int count;
+
const float* axes = glfwGetJoystickAxes(GLFW_JOYSTICK_5, &count);
+
glfwGetJoystickAxes
const float * glfwGetJoystickAxes(int jid, int *count)
Returns the values of all axes of the specified joystick.
+
GLFW_JOYSTICK_5
#define GLFW_JOYSTICK_5
Definition: glfw3.h:596
+

Each element in the returned array is a value between -1.0 and 1.0.

+

+Joystick button states

+

The states of all buttons of a joystick are returned by glfwGetJoystickButtons. See the reference documentation for the lifetime of the returned array.

+
int count;
+
const unsigned char* buttons = glfwGetJoystickButtons(GLFW_JOYSTICK_3, &count);
+
glfwGetJoystickButtons
const unsigned char * glfwGetJoystickButtons(int jid, int *count)
Returns the state of all buttons of the specified joystick.
+
GLFW_JOYSTICK_3
#define GLFW_JOYSTICK_3
Definition: glfw3.h:594
+

Each element in the returned array is either GLFW_PRESS or GLFW_RELEASE.

+

For backward compatibility with earlier versions that did not have glfwGetJoystickHats, the button array by default also includes all hats. See the reference documentation for glfwGetJoystickButtons for details.

+

+Joystick hat states

+

The states of all hats are returned by glfwGetJoystickHats. See the reference documentation for the lifetime of the returned array.

+
int count;
+
const unsigned char* hats = glfwGetJoystickHats(GLFW_JOYSTICK_7, &count);
+
glfwGetJoystickHats
const unsigned char * glfwGetJoystickHats(int jid, int *count)
Returns the state of all hats of the specified joystick.
+
GLFW_JOYSTICK_7
#define GLFW_JOYSTICK_7
Definition: glfw3.h:598
+

Each element in the returned array is one of the following:

+ + + + + + + + + + + + + + + + + + + + + +
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.

+
if (hats[2] & GLFW_HAT_RIGHT)
+
{
+
// State of hat 2 could be right-up, right or right-down
+
}
+
GLFW_HAT_RIGHT
#define GLFW_HAT_RIGHT
Definition: glfw3.h:357
+

For backward compatibility with earlier versions that did not have glfwGetJoystickHats, all hats are by default also included in the button array. See the reference documentation for glfwGetJoystickButtons for details.

+

+Joystick name

+

The human-readable, UTF-8 encoded name of a joystick is returned by glfwGetJoystickName. See the reference documentation for the lifetime of the returned string.

+
const char* name = glfwGetJoystickName(GLFW_JOYSTICK_4);
+
glfwGetJoystickName
const char * glfwGetJoystickName(int jid)
Returns the name of the specified joystick.
+
GLFW_JOYSTICK_4
#define GLFW_JOYSTICK_4
Definition: glfw3.h:595
+

Joystick names are not guaranteed to be unique. Two joysticks of the same model and make may have the same name. Only the joystick ID is guaranteed to be unique, and only until that joystick is disconnected.

+

+Joystick user pointer

+

Each joystick has a user pointer that can be set with glfwSetJoystickUserPointer and queried with glfwGetJoystickUserPointer. This can be used for any purpose you need and will not be modified by GLFW. The value will be kept until the joystick is disconnected or until the library is terminated.

+

The initial value of the pointer is NULL.

+

+Joystick configuration changes

+

If you wish to be notified when a joystick is connected or disconnected, set a joystick callback.

+
glfwSetJoystickCallback(joystick_callback);
+
glfwSetJoystickCallback
GLFWjoystickfun glfwSetJoystickCallback(GLFWjoystickfun callback)
Sets the joystick configuration callback.
+

The callback function receives the ID of the joystick that has been connected and disconnected and the event that occurred.

+
void joystick_callback(int jid, int event)
+
{
+
if (event == GLFW_CONNECTED)
+
{
+
// The joystick was connected
+
}
+
else if (event == GLFW_DISCONNECTED)
+
{
+
// The joystick was disconnected
+
}
+
}
+
GLFW_DISCONNECTED
#define GLFW_DISCONNECTED
Definition: glfw3.h:1107
+
GLFW_CONNECTED
#define GLFW_CONNECTED
Definition: glfw3.h:1106
+

For joystick connection and disconnection events to be delivered on all platforms, you need to call one of the event processing functions. Joystick disconnection may also be detected and the callback called by joystick functions. The function will then return whatever it returns for a disconnected joystick.

+

Only glfwGetJoystickName and glfwGetJoystickUserPointer will return useful values for a disconnected joystick and only before the monitor callback returns.

+

+Gamepad input

+

The joystick functions provide unlabeled axes, buttons and hats, with no indication of where they are located on the device. Their order may also vary between platforms even with the same device.

+

To solve this problem the SDL community crowdsourced the SDL_GameControllerDB project, a database of mappings from many different devices to an Xbox-like gamepad.

+

GLFW supports this mapping format and contains a copy of the mappings available at the time of release. See Gamepad mappings for how to update this at runtime. Mappings will be assigned to joysticks automatically any time a joystick is connected or the mappings are updated.

+

You can check whether a joystick is both present and has a gamepad mapping with glfwJoystickIsGamepad.

+
if (glfwJoystickIsGamepad(GLFW_JOYSTICK_2))
+
{
+
// Use as gamepad
+
}
+
glfwJoystickIsGamepad
int glfwJoystickIsGamepad(int jid)
Returns whether the specified joystick has a gamepad mapping.
+
GLFW_JOYSTICK_2
#define GLFW_JOYSTICK_2
Definition: glfw3.h:593
+

If you are only interested in gamepad input you can use this function instead of glfwJoystickPresent.

+

You can query the human-readable name provided by the gamepad mapping with glfwGetGamepadName. This may or may not be the same as the joystick name.

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

To retrieve the gamepad state of a joystick, call glfwGetGamepadState.

+
GLFWgamepadstate state;
+
+
if (glfwGetGamepadState(GLFW_JOYSTICK_3, &state))
+
{
+
if (state.buttons[GLFW_GAMEPAD_BUTTON_A])
+
{
+
input_jump();
+
}
+
+
input_speed(state.axes[GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER]);
+
}
+
GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
#define GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER
Definition: glfw3.h:653
+
GLFW_GAMEPAD_BUTTON_A
#define GLFW_GAMEPAD_BUTTON_A
Definition: glfw3.h:618
+
glfwGetGamepadState
int glfwGetGamepadState(int jid, GLFWgamepadstate *state)
Retrieves the state of the specified joystick remapped as a gamepad.
+
GLFWgamepadstate
Gamepad input state.
Definition: glfw3.h:1745
+
GLFWgamepadstate::buttons
unsigned char buttons[15]
Definition: glfw3.h:1749
+
GLFWgamepadstate::axes
float axes[6]
Definition: glfw3.h:1753
+

The GLFWgamepadstate struct has two arrays; one for button states and one for axis states. The values for each button and axis are the same as for the glfwGetJoystickButtons and glfwGetJoystickAxes functions, i.e. GLFW_PRESS or GLFW_RELEASE for buttons and -1.0 to 1.0 inclusive for axes.

+

The sizes of the arrays and the positions within each array are fixed.

+

The button indices are GLFW_GAMEPAD_BUTTON_A, GLFW_GAMEPAD_BUTTON_B, GLFW_GAMEPAD_BUTTON_X, GLFW_GAMEPAD_BUTTON_Y, GLFW_GAMEPAD_BUTTON_LEFT_BUMPER, GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER, GLFW_GAMEPAD_BUTTON_BACK, GLFW_GAMEPAD_BUTTON_START, GLFW_GAMEPAD_BUTTON_GUIDE, GLFW_GAMEPAD_BUTTON_LEFT_THUMB, GLFW_GAMEPAD_BUTTON_RIGHT_THUMB, GLFW_GAMEPAD_BUTTON_DPAD_UP, GLFW_GAMEPAD_BUTTON_DPAD_RIGHT, GLFW_GAMEPAD_BUTTON_DPAD_DOWN and GLFW_GAMEPAD_BUTTON_DPAD_LEFT.

+

For those who prefer, there are also the GLFW_GAMEPAD_BUTTON_CROSS, GLFW_GAMEPAD_BUTTON_CIRCLE, GLFW_GAMEPAD_BUTTON_SQUARE and GLFW_GAMEPAD_BUTTON_TRIANGLE aliases for the A, B, X and Y button indices.

+

The axis indices are GLFW_GAMEPAD_AXIS_LEFT_X, GLFW_GAMEPAD_AXIS_LEFT_Y, GLFW_GAMEPAD_AXIS_RIGHT_X, GLFW_GAMEPAD_AXIS_RIGHT_Y, GLFW_GAMEPAD_AXIS_LEFT_TRIGGER and GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER.

+

The GLFW_GAMEPAD_BUTTON_LAST and GLFW_GAMEPAD_AXIS_LAST constants equal the largest available index for each array.

+

+Gamepad mappings

+

GLFW contains a copy of the mappings available in SDL_GameControllerDB at the time of release. Newer ones can be added at runtime with glfwUpdateGamepadMappings.

+
const char* mappings = load_file_contents("game/data/gamecontrollerdb.txt");
+
+
glfwUpdateGamepadMappings(mappings);
+
glfwUpdateGamepadMappings
int glfwUpdateGamepadMappings(const char *string)
Adds the specified SDL_GameControllerDB gamepad mappings.
+

This function supports everything from single lines up to and including the unmodified contents of the whole gamecontrollerdb.txt file.

+

If you are compiling GLFW from source with CMake you can update the built-in mappings by building the update_mappings target. This runs the GenerateMappings.cmake CMake script, which downloads gamecontrollerdb.txt and regenerates the mappings.h header file.

+

Below is a description of the mapping format. Please keep in mind that this description is not authoritative. The format is defined by the SDL and SDL_GameControllerDB projects and their documentation and code takes precedence.

+

Each mapping is a single line of comma-separated values describing the GUID, name and layout of the gamepad. Lines that do not begin with a hexadecimal digit are ignored.

+

The first value is always the gamepad GUID, a 32 character long hexadecimal string that typically identifies its make, model, revision and the type of connection to the computer. When this information is not available, the GUID is generated using the gamepad name. GLFW uses the SDL 2.0.5+ GUID format but can convert from the older formats.

+

The second value is always the human-readable name of the gamepad.

+

All subsequent values are in the form <field>:<value> and describe the layout of the mapping. These fields may not all be present and may occur in any order.

+

The button fields are a, b, x, y, back, start, guide, dpup, dpright, dpdown, dpleft, leftshoulder, rightshoulder, leftstick and rightstick.

+

The axis fields are leftx, lefty, rightx, righty, lefttrigger and righttrigger.

+

The value of an axis or button field can be a joystick button, a joystick axis, a hat bitmask or empty. Joystick buttons are specified as bN, for example b2 for the third button. Joystick axes are specified as aN, for example a7 for the eighth button. Joystick hat bit masks are specified as hN.N, for example h0.8 for left on the first hat. More than one bit may be set in the mask.

+

Before an axis there may be a + or - range modifier, for example +a3 for the positive half of the fourth axis. This restricts input to only the positive or negative halves of the joystick axis. After an axis or half-axis there may be the ~ inversion modifier, for example a2~ or -a7~. This negates the values of the gamepad axis.

+

The hat bit mask match the hat states in the joystick functions.

+

There is also the special platform field that specifies which platform the mapping is valid for. Possible values are Windows, Mac OS X and Linux.

+

Below is an example of what a gamepad mapping might look like. It is the one built into GLFW for Xbox controllers accessed via the XInput API on Windows. This example has been broken into several lines to fit on the page, but real gamepad mappings must be a single line.

+
78696e70757401000000000000000000,XInput Gamepad (GLFW),platform:Windows,a:b0,
+
b:b1,x:b2,y:b3,leftshoulder:b4,rightshoulder:b5,back:b6,start:b7,leftstick:b8,
+
rightstick:b9,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:a4,
+
righttrigger:a5,dpup:h0.1,dpright:h0.2,dpdown:h0.4,dpleft:h0.8,
+
Note
GLFW does not yet support the output range and modifiers + and - that were recently added to SDL. The input modifiers +, - and ~ are supported and described above.
+

+Time input

+

GLFW provides high-resolution time input, in seconds, with glfwGetTime.

+
double seconds = glfwGetTime();
+
glfwGetTime
double glfwGetTime(void)
Returns the GLFW time.
+

It returns the number of seconds since the library was initialized with glfwInit. The platform-specific time sources used typically have micro- or nanosecond resolution.

+

You can modify the base time with glfwSetTime.

+
glfwSetTime(4.0);
+
glfwSetTime
void glfwSetTime(double time)
Sets the GLFW time.
+

This sets the time to the specified time, in seconds, and it continues to count from there.

+

You can also access the raw timer used to implement the functions above, with glfwGetTimerValue.

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

This value is in 1 / frequency seconds. The frequency of the raw timer varies depending on the operating system and hardware. You can query the frequency, in Hz, with glfwGetTimerFrequency.

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

+Clipboard input and output

+

If the system clipboard contains a UTF-8 encoded string or if it can be converted to one, you can retrieve it with glfwGetClipboardString. See the reference documentation for the lifetime of the returned string.

+
const char* text = glfwGetClipboardString(NULL);
+
if (text)
+
{
+
insert_text(text);
+
}
+
glfwGetClipboardString
const char * glfwGetClipboardString(GLFWwindow *window)
Returns the contents of the clipboard as a string.
+

If the clipboard is empty or if its contents could not be converted, NULL is returned.

+

The contents of the system clipboard can be set to a UTF-8 encoded string with glfwSetClipboardString.

+
glfwSetClipboardString(NULL, "A string with words in it");
+
glfwSetClipboardString
void glfwSetClipboardString(GLFWwindow *window, const char *string)
Sets the clipboard to the specified string.
+

+Path drop input

+

If you wish to receive the paths of files and/or directories dropped on a window, set a file drop callback.

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

The callback function receives an array of paths encoded as UTF-8.

+
void drop_callback(GLFWwindow* window, int count, const char** paths)
+
{
+
int i;
+
for (i = 0; i < count; i++)
+
handle_dropped_file(paths[i]);
+
}
+

The path array and its strings are only valid until the file drop callback returns, as they may have been generated specifically for that event. You need to make a deep copy of the array if you want to keep the paths.

+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/internal_8dox.html b/deps/glfw-3.3.8/docs/html/internal_8dox.html new file mode 100644 index 0000000..9c401ab --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/internal_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: internal.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
internal.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/internals_guide.html b/deps/glfw-3.3.8/docs/html/internals_guide.html new file mode 100644 index 0000000..6d96b4d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/internals_guide.html @@ -0,0 +1,125 @@ + + + + + + + +GLFW: Internal structure + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Internal structure
+
+
+

Table of Contents

+ +
+

There are several interfaces inside GLFW. Each interface has its own area of responsibility and its own naming conventions.

+

+Public interface

+

The most well-known is the public interface, described in the glfw3.h header file. This is implemented in source files shared by all platforms and these files contain no platform-specific code. This code usually ends up calling the platform and internal interfaces to do the actual work.

+

The public interface uses the OpenGL naming conventions except with GLFW and glfw instead of GL and gl. For struct members, where OpenGL sets no precedent, it use headless camel case.

+

Examples: glfwCreateWindow, GLFWwindow, GLFW_RED_BITS

+

+Native interface

+

The native interface is a small set of publicly available but platform-specific functions, described in the glfw3native.h header file and used to gain access to the underlying window, context and (on some platforms) display handles used by the platform interface.

+

The function names of the native interface are similar to those of the public interface, but embeds the name of the interface that the returned handle is from.

+

Examples: glfwGetX11Window, glfwGetWGLContext

+

+Internal interface

+

The internal interface consists of utility functions used by all other interfaces. It is shared code implemented in the same shared source files as the public and event interfaces. The internal interface is described in the internal.h header file.

+

The internal interface is in charge of GLFW's global data, which it stores in a _GLFWlibrary struct named _glfw.

+

The internal interface uses the same style as the public interface, except all global names have a leading underscore.

+

Examples: _glfwIsValidContextConfig, _GLFWwindow, _glfw.monitorCount

+

+Platform interface

+

The platform interface implements all platform-specific operations as a service to the public interface. This includes event processing. The platform interface is never directly called by application code and never directly calls application-provided callbacks. It is also prohibited from modifying the platform-independent part of the internal structs. Instead, it calls the event interface when events interesting to GLFW are received.

+

The platform interface mirrors those parts of the public interface that needs to perform platform-specific operations on some or all platforms. The are also named the same except that the glfw function prefix is replaced by _glfwPlatform.

+

Examples: _glfwPlatformCreateWindow

+

The platform interface also defines structs that contain platform-specific global and per-object state. Their names mirror those of the internal interface, except that an interface-specific suffix is added.

+

Examples: _GLFWwindowX11, _GLFWcontextWGL

+

These structs are incorporated as members into the internal interface structs using special macros that name them after the specific interface used. This prevents shared code from accidentally using these members.

+

Examples: window->win32.handle, _glfw.x11.display

+

+Event interface

+

The event interface is implemented in the same shared source files as the public interface and is responsible for delivering the events it receives to the application, either via callbacks, via window state changes or both.

+

The function names of the event interface use a _glfwInput prefix and the ObjectEvent pattern.

+

Examples: _glfwInputWindowFocus, _glfwInputCursorPos

+

+Static functions

+

Static functions may be used by any interface and have no prefixes or suffixes. These use headless camel case.

+

Examples: isValidElementForJoystick

+

+Configuration macros

+

GLFW uses a number of configuration macros to select at compile time which interfaces and code paths to use. They are defined in the glfw_config.h header file, which is generated from the glfw_config.h.in file by CMake.

+

Configuration macros the same style as tokens in the public interface, except with a leading underscore.

+

Examples: _GLFW_WIN32, _GLFW_BUILD_DLL

+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/intro_8dox.html b/deps/glfw-3.3.8/docs/html/intro_8dox.html new file mode 100644 index 0000000..6bf836e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/intro_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: intro.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
intro.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/intro_guide.html b/deps/glfw-3.3.8/docs/html/intro_guide.html new file mode 100644 index 0000000..7ca3f1e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/intro_guide.html @@ -0,0 +1,329 @@ + + + + + + + +GLFW: Introduction to the API + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
Introduction to the API
+
+
+

Table of Contents

+ +
+

This guide introduces the basic concepts of GLFW and describes initialization, error handling and API guarantees and limitations. For a broad but shallow tutorial, see Getting started instead. For details on a specific function in this category, see the Initialization, version and error reference.

+

There are also guides for the other areas of GLFW.

+ +

+Initialization and termination

+

Before most GLFW functions may be called, the library must be initialized. This initialization checks what features are available on the machine, enumerates monitors and joysticks, initializes the timer and performs any required platform-specific initialization.

+

Only the following functions may be called before the library has been successfully initialized, and only from the main thread.

+ +

Calling any other function before successful initialization will cause a GLFW_NOT_INITIALIZED error.

+

+Initializing GLFW

+

The library is initialized with glfwInit, which returns GLFW_FALSE if an error occurred.

+
if (!glfwInit())
+
{
+
// Handle initialization failure
+
}
+
glfwInit
int glfwInit(void)
Initializes the GLFW library.
+

If any part of initialization fails, any parts that succeeded are terminated as if glfwTerminate had been called. The library only needs to be initialized once and additional calls to an already initialized library will return GLFW_TRUE immediately.

+

Once the library has been successfully initialized, it should be terminated before the application exits. Modern systems are very good at freeing resources allocated by programs that exit, but GLFW sometimes has to change global system settings and these might not be restored without termination.

+

+Initialization hints

+

Initialization hints are set before glfwInit and affect how the library behaves until termination. Hints are set with glfwInitHint.

+
glfwInitHint(GLFW_JOYSTICK_HAT_BUTTONS, GLFW_FALSE);
+
glfwInitHint
void glfwInitHint(int hint, int value)
Sets the specified init hint to the desired value.
+
GLFW_JOYSTICK_HAT_BUTTONS
#define GLFW_JOYSTICK_HAT_BUTTONS
Joystick hat buttons init hint.
Definition: glfw3.h:1115
+
GLFW_FALSE
#define GLFW_FALSE
Zero.
Definition: glfw3.h:321
+

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.

+

+Shared init hints

+

GLFW_JOYSTICK_HAT_BUTTONS specifies whether to also expose joystick hats as buttons, for compatibility with earlier versions of GLFW that did not have glfwGetJoystickHats. Possible values are GLFW_TRUE and GLFW_FALSE.

+

+macOS specific init hints

+

GLFW_COCOA_CHDIR_RESOURCES specifies whether to set the current directory to the application to the Contents/Resources subdirectory of the application's bundle, if present. Set this with glfwInitHint.

+

GLFW_COCOA_MENUBAR specifies whether to create a basic menu bar, either from a nib or manually, when the first window is created, which is when AppKit is initialized. Set this with glfwInitHint.

+

+Supported and default values

+ + + + + + + + + +
Initialization hint Default value Supported values
GLFW_JOYSTICK_HAT_BUTTONS GLFW_TRUE GLFW_TRUE or GLFW_FALSE
GLFW_COCOA_CHDIR_RESOURCES GLFW_TRUE GLFW_TRUE or GLFW_FALSE
GLFW_COCOA_MENUBAR GLFW_TRUE GLFW_TRUE or GLFW_FALSE
+

+Terminating GLFW

+

Before your application exits, you should terminate the GLFW library if it has been initialized. This is done with glfwTerminate.

+
glfwTerminate();
+
glfwTerminate
void glfwTerminate(void)
Terminates the GLFW library.
+

This will destroy any remaining window, monitor and cursor objects, restore any modified gamma ramps, re-enable the screensaver if it had been disabled and free any other resources allocated by GLFW.

+

Once the library is terminated, it is as if it had never been initialized and you will need to initialize it again before being able to use GLFW. If the library was not initialized or had already been terminated, it return immediately.

+

+Error handling

+

Some GLFW functions have return values that indicate an error, but this is often not very helpful when trying to figure out what happened or why it occurred. Other functions have no return value reserved for errors, so error notification needs a separate channel. Finally, far from all GLFW functions have return values.

+

The last error code for the calling thread can be queried at any time with glfwGetError.

+
int code = glfwGetError(NULL);
+
+
if (code != GLFW_NO_ERROR)
+
handle_error(code);
+
GLFW_NO_ERROR
#define GLFW_NO_ERROR
No error has occurred.
Definition: glfw3.h:670
+
glfwGetError
int glfwGetError(const char **description)
Returns and clears the last error for the calling thread.
+

If no error has occurred since the last call, GLFW_NO_ERROR (zero) is returned. The error is cleared before the function returns.

+

The error code indicates the general category of the error. Some error codes, such as GLFW_NOT_INITIALIZED has only a single meaning, whereas others like GLFW_PLATFORM_ERROR are used for many different errors.

+

GLFW often has more information about an error than its general category. You can retrieve a UTF-8 encoded human-readable description along with the error code. If no error has occurred since the last call, the description is set to NULL.

+
const char* description;
+
int code = glfwGetError(&description);
+
+
if (description)
+
display_error_message(code, description);
+

The retrieved description string is only valid until the next error occurs. This means you must make a copy of it if you want to keep it.

+

You can also set an error callback, which will be called each time an error occurs. It is set with glfwSetErrorCallback.

+
glfwSetErrorCallback(error_callback);
+
glfwSetErrorCallback
GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback)
Sets the error callback.
+

The error callback receives the same error code and human-readable description returned by glfwGetError.

+
void error_callback(int code, const char* description)
+
{
+
display_error_message(code, description);
+
}
+

The error callback is called after the error is stored, so calling glfwGetError from within the error callback returns the same values as the callback argument.

+

The description string passed to the callback is only valid until the error callback returns. This means you must make a copy of it if you want to keep it.

+

Reported errors are never fatal. As long as GLFW was successfully initialized, it will remain initialized and in a safe state until terminated regardless of how many errors occur. If an error occurs during initialization that causes glfwInit to fail, any part of the library that was initialized will be safely terminated.

+

Do not rely on a currently invalid call to generate a specific error, as in the future that same call may generate a different error or become valid.

+

+Coordinate systems

+

GLFW has two primary coordinate systems: the virtual screen and the window content area or content area. Both use the same unit: virtual screen coordinates, or just screen coordinates, which don't necessarily correspond to pixels.

+

+

Both the virtual screen and the content area coordinate systems have the X-axis pointing to the right and the Y-axis pointing down.

+

Window and monitor positions are specified as the position of the upper-left corners of their content areas relative to the virtual screen, while cursor positions are specified relative to a window's content area.

+

Because the origin of the window's content area coordinate system is also the point from which the window position is specified, you can translate content area coordinates to the virtual screen by adding the window position. The window frame, when present, extends out from the content area but does not affect the window position.

+

Almost all positions and sizes in GLFW are measured in screen coordinates relative to one of the two origins above. This includes cursor positions, window positions and sizes, window frame sizes, monitor positions and video mode resolutions.

+

Two exceptions are the monitor physical size, which is measured in millimetres, and framebuffer size, which is measured in pixels.

+

Pixels and screen coordinates may map 1:1 on your machine, but they won't on every other machine, for example on a Mac with a Retina display. The ratio between screen coordinates and pixels may also change at run-time depending on which monitor the window is currently considered to be on.

+

+Guarantees and limitations

+

This section describes the conditions under which GLFW can be expected to function, barring bugs in the operating system or drivers. Use of GLFW outside of these limits may work on some platforms, or on some machines, or some of the time, or on some versions of GLFW, but it may break at any time and this will not be considered a bug.

+

+Pointer lifetimes

+

GLFW will never free any pointer you provide to it and you must never free any pointer it provides to you.

+

Many GLFW functions return pointers to dynamically allocated structures, strings or arrays, and some callbacks are provided with strings or arrays. These are always managed by GLFW and should never be freed by the application. The lifetime of these pointers is documented for each GLFW function and callback. If you need to keep this data, you must copy it before its lifetime expires.

+

Many GLFW functions accept pointers to structures or strings allocated by the application. These are never freed by GLFW and are always the responsibility of the application. If GLFW needs to keep the data in these structures or strings, it is copied before the function returns.

+

Pointer lifetimes are guaranteed not to be shortened in future minor or patch releases.

+

+Reentrancy

+

GLFW event processing and object destruction are not reentrant. This means that the following functions must not be called from any callback function:

+ +

These functions may be made reentrant in future minor or patch releases, but functions not on this list will not be made non-reentrant.

+

+Thread safety

+

Most GLFW functions must only be called from the main thread (the thread that calls main), but some may be called from any thread once the library has been initialized. Before initialization the whole library is thread-unsafe.

+

The reference documentation for every GLFW function states whether it is limited to the main thread.

+

Initialization, termination, event processing and the creation and destruction of windows, cursors and OpenGL and OpenGL ES contexts are all restricted to the main thread due to limitations of one or several platforms.

+

Because event processing must be performed on the main thread, all callbacks except for the error callback will only be called on that thread. The error callback may be called on any thread, as any GLFW function may generate errors.

+

The error code and description may be queried from any thread.

+ +

Empty events may be posted from any thread.

+ +

The window user pointer and close flag may be read and written from any thread, but this is not synchronized by GLFW.

+ +

These functions for working with OpenGL and OpenGL ES contexts may be called from any thread, but the window object is not synchronized by GLFW.

+ +

The raw timer functions may be called from any thread.

+ +

The regular timer may be used from any thread, but reading and writing the timer offset is not synchronized by GLFW.

+ +

Library version information may be queried from any thread.

+ +

All Vulkan related functions may be called from any thread.

+ +

GLFW uses synchronization objects internally only to manage the per-thread context and error states. Additional synchronization is left to the application.

+

Functions that may currently be called from any thread will always remain so, but functions that are currently limited to the main thread may be updated to allow calls from any thread in future releases.

+

+Version compatibility

+

GLFW uses Semantic Versioning. This guarantees source and binary backward compatibility with earlier minor versions of the API. This means that you can drop in a newer version of the library and existing programs will continue to compile and existing binaries will continue to run.

+

Once a function or constant has been added, the signature of that function or value of that constant will remain unchanged until the next major version of GLFW. No compatibility of any kind is guaranteed between major versions.

+

Undocumented behavior, i.e. behavior that is not described in the documentation, may change at any time until it is documented.

+

If the reference documentation and the implementation differ, the reference documentation will almost always take precedence and the implementation will be fixed in the next release. The reference documentation will also take precedence over anything stated in a guide.

+

+Event order

+

The order of arrival of related events is not guaranteed to be consistent across platforms. The exception is synthetic key and mouse button release events, which are always delivered after the window defocus event.

+

+Version management

+

GLFW provides mechanisms for identifying what version of GLFW your application was compiled against as well as what version it is currently running against. If you are loading GLFW dynamically (not just linking dynamically), you can use this to verify that the library binary is compatible with your application.

+

+Compile-time version

+

The compile-time version of GLFW is provided by the GLFW header with the GLFW_VERSION_MAJOR, GLFW_VERSION_MINOR and GLFW_VERSION_REVISION macros.

+
printf("Compiled against GLFW %i.%i.%i\n",
+
GLFW_VERSION_MAJOR,
+
GLFW_VERSION_MINOR,
+
GLFW_VERSION_REVISION);
+
GLFW_VERSION_MAJOR
#define GLFW_VERSION_MAJOR
The major version number of the GLFW header.
Definition: glfw3.h:287
+
GLFW_VERSION_REVISION
#define GLFW_VERSION_REVISION
The revision number of the GLFW header.
Definition: glfw3.h:301
+
GLFW_VERSION_MINOR
#define GLFW_VERSION_MINOR
The minor version number of the GLFW header.
Definition: glfw3.h:294
+

+Run-time version

+

The run-time version can be retrieved with glfwGetVersion, a function that may be called regardless of whether GLFW is initialized.

+
int major, minor, revision;
+
glfwGetVersion(&major, &minor, &revision);
+
+
printf("Running against GLFW %i.%i.%i\n", major, minor, revision);
+
glfwGetVersion
void glfwGetVersion(int *major, int *minor, int *rev)
Retrieves the version of the GLFW library.
+

+Version string

+

GLFW 3 also provides a compile-time generated version string that describes the version, platform, compiler and any platform-specific compile-time options. This is primarily intended for submitting bug reports, to allow developers to see which code paths are enabled in a binary.

+

The version string is returned by glfwGetVersionString, a function that may be called regardless of whether GLFW is initialized.

+

Do not use the version string to parse the GLFW library version. The glfwGetVersion function already provides the version of the running library binary.

+

The format of the string is as follows:

    +
  • The version of GLFW
    • +
  • The name of the window system API
    • +
  • The name of the context creation API
    • +
  • Any additional options or APIs
    • +
+

For example, when compiling GLFW 3.0 with MinGW using the Win32 and WGL back ends, the version string may look something like this:

+
3.0.0 Win32 WGL MinGW
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/jquery.js b/deps/glfw-3.3.8/docs/html/jquery.js new file mode 100644 index 0000000..c9ed3d9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/jquery.js @@ -0,0 +1,35 @@ +/*! jQuery v3.6.0 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.0",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0a;a++)for(i in o[a])n=o[a][i],o[a].hasOwnProperty(i)&&void 0!==n&&(e[i]=t.isPlainObject(n)?t.isPlainObject(e[i])?t.widget.extend({},e[i],n):t.widget.extend({},n):n);return e},t.widget.bridge=function(e,i){var n=i.prototype.widgetFullName||e;t.fn[e]=function(o){var a="string"==typeof o,r=s.call(arguments,1),h=this;return a?this.length||"instance"!==o?this.each(function(){var i,s=t.data(this,n);return"instance"===o?(h=s,!1):s?t.isFunction(s[o])&&"_"!==o.charAt(0)?(i=s[o].apply(s,r),i!==s&&void 0!==i?(h=i&&i.jquery?h.pushStack(i.get()):i,!1):void 0):t.error("no such method '"+o+"' for "+e+" widget instance"):t.error("cannot call methods on "+e+" prior to initialization; "+"attempted to call method '"+o+"'")}):h=void 0:(r.length&&(o=t.widget.extend.apply(null,[o].concat(r))),this.each(function(){var e=t.data(this,n);e?(e.option(o||{}),e._init&&e._init()):t.data(this,n,new i(o,this))})),h}},t.Widget=function(){},t.Widget._childConstructors=[],t.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",defaultElement:"
",options:{classes:{},disabled:!1,create:null},_createWidget:function(e,s){s=t(s||this.defaultElement||this)[0],this.element=t(s),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=t(),this.hoverable=t(),this.focusable=t(),this.classesElementLookup={},s!==this&&(t.data(s,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===s&&this.destroy()}}),this.document=t(s.style?s.ownerDocument:s.document||s),this.window=t(this.document[0].defaultView||this.document[0].parentWindow)),this.options=t.widget.extend({},this.options,this._getCreateOptions(),e),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:t.noop,_create:t.noop,_init:t.noop,destroy:function(){var e=this;this._destroy(),t.each(this.classesElementLookup,function(t,i){e._removeClass(i,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:t.noop,widget:function(){return this.element},option:function(e,i){var s,n,o,a=e;if(0===arguments.length)return t.widget.extend({},this.options);if("string"==typeof e)if(a={},s=e.split("."),e=s.shift(),s.length){for(n=a[e]=t.widget.extend({},this.options[e]),o=0;s.length-1>o;o++)n[s[o]]=n[s[o]]||{},n=n[s[o]];if(e=s.pop(),1===arguments.length)return void 0===n[e]?null:n[e];n[e]=i}else{if(1===arguments.length)return void 0===this.options[e]?null:this.options[e];a[e]=i}return this._setOptions(a),this},_setOptions:function(t){var e;for(e in t)this._setOption(e,t[e]);return this},_setOption:function(t,e){return"classes"===t&&this._setOptionClasses(e),this.options[t]=e,"disabled"===t&&this._setOptionDisabled(e),this},_setOptionClasses:function(e){var i,s,n;for(i in e)n=this.classesElementLookup[i],e[i]!==this.options.classes[i]&&n&&n.length&&(s=t(n.get()),this._removeClass(n,i),s.addClass(this._classes({element:s,keys:i,classes:e,add:!0})))},_setOptionDisabled:function(t){this._toggleClass(this.widget(),this.widgetFullName+"-disabled",null,!!t),t&&(this._removeClass(this.hoverable,null,"ui-state-hover"),this._removeClass(this.focusable,null,"ui-state-focus"))},enable:function(){return this._setOptions({disabled:!1})},disable:function(){return this._setOptions({disabled:!0})},_classes:function(e){function i(i,o){var a,r;for(r=0;i.length>r;r++)a=n.classesElementLookup[i[r]]||t(),a=e.add?t(t.unique(a.get().concat(e.element.get()))):t(a.not(e.element).get()),n.classesElementLookup[i[r]]=a,s.push(i[r]),o&&e.classes[i[r]]&&s.push(e.classes[i[r]])}var s=[],n=this;return e=t.extend({element:this.element,classes:this.options.classes||{}},e),this._on(e.element,{remove:"_untrackClassesElement"}),e.keys&&i(e.keys.match(/\S+/g)||[],!0),e.extra&&i(e.extra.match(/\S+/g)||[]),s.join(" ")},_untrackClassesElement:function(e){var i=this;t.each(i.classesElementLookup,function(s,n){-1!==t.inArray(e.target,n)&&(i.classesElementLookup[s]=t(n.not(e.target).get()))})},_removeClass:function(t,e,i){return this._toggleClass(t,e,i,!1)},_addClass:function(t,e,i){return this._toggleClass(t,e,i,!0)},_toggleClass:function(t,e,i,s){s="boolean"==typeof s?s:i;var n="string"==typeof t||null===t,o={extra:n?e:i,keys:n?t:e,element:n?this.element:t,add:s};return o.element.toggleClass(this._classes(o),s),this},_on:function(e,i,s){var n,o=this;"boolean"!=typeof e&&(s=i,i=e,e=!1),s?(i=n=t(i),this.bindings=this.bindings.add(i)):(s=i,i=this.element,n=this.widget()),t.each(s,function(s,a){function r(){return e||o.options.disabled!==!0&&!t(this).hasClass("ui-state-disabled")?("string"==typeof a?o[a]:a).apply(o,arguments):void 0}"string"!=typeof a&&(r.guid=a.guid=a.guid||r.guid||t.guid++);var h=s.match(/^([\w:-]*)\s*(.*)$/),l=h[1]+o.eventNamespace,c=h[2];c?n.on(l,c,r):i.on(l,r)})},_off:function(e,i){i=(i||"").split(" ").join(this.eventNamespace+" ")+this.eventNamespace,e.off(i).off(i),this.bindings=t(this.bindings.not(e).get()),this.focusable=t(this.focusable.not(e).get()),this.hoverable=t(this.hoverable.not(e).get())},_delay:function(t,e){function i(){return("string"==typeof t?s[t]:t).apply(s,arguments)}var s=this;return setTimeout(i,e||0)},_hoverable:function(e){this.hoverable=this.hoverable.add(e),this._on(e,{mouseenter:function(e){this._addClass(t(e.currentTarget),null,"ui-state-hover")},mouseleave:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-hover")}})},_focusable:function(e){this.focusable=this.focusable.add(e),this._on(e,{focusin:function(e){this._addClass(t(e.currentTarget),null,"ui-state-focus")},focusout:function(e){this._removeClass(t(e.currentTarget),null,"ui-state-focus")}})},_trigger:function(e,i,s){var n,o,a=this.options[e];if(s=s||{},i=t.Event(i),i.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase(),i.target=this.element[0],o=i.originalEvent)for(n in o)n in i||(i[n]=o[n]);return this.element.trigger(i,s),!(t.isFunction(a)&&a.apply(this.element[0],[i].concat(s))===!1||i.isDefaultPrevented())}},t.each({show:"fadeIn",hide:"fadeOut"},function(e,i){t.Widget.prototype["_"+e]=function(s,n,o){"string"==typeof n&&(n={effect:n});var a,r=n?n===!0||"number"==typeof n?i:n.effect||i:e;n=n||{},"number"==typeof n&&(n={duration:n}),a=!t.isEmptyObject(n),n.complete=o,n.delay&&s.delay(n.delay),a&&t.effects&&t.effects.effect[r]?s[e](n):r!==e&&s[r]?s[r](n.duration,n.easing,o):s.queue(function(i){t(this)[e](),o&&o.call(s[0]),i()})}}),t.widget,function(){function e(t,e,i){return[parseFloat(t[0])*(u.test(t[0])?e/100:1),parseFloat(t[1])*(u.test(t[1])?i/100:1)]}function i(e,i){return parseInt(t.css(e,i),10)||0}function s(e){var i=e[0];return 9===i.nodeType?{width:e.width(),height:e.height(),offset:{top:0,left:0}}:t.isWindow(i)?{width:e.width(),height:e.height(),offset:{top:e.scrollTop(),left:e.scrollLeft()}}:i.preventDefault?{width:0,height:0,offset:{top:i.pageY,left:i.pageX}}:{width:e.outerWidth(),height:e.outerHeight(),offset:e.offset()}}var n,o=Math.max,a=Math.abs,r=/left|center|right/,h=/top|center|bottom/,l=/[\+\-]\d+(\.[\d]+)?%?/,c=/^\w+/,u=/%$/,d=t.fn.position;t.position={scrollbarWidth:function(){if(void 0!==n)return n;var e,i,s=t("
"),o=s.children()[0];return t("body").append(s),e=o.offsetWidth,s.css("overflow","scroll"),i=o.offsetWidth,e===i&&(i=s[0].clientWidth),s.remove(),n=e-i},getScrollInfo:function(e){var i=e.isWindow||e.isDocument?"":e.element.css("overflow-x"),s=e.isWindow||e.isDocument?"":e.element.css("overflow-y"),n="scroll"===i||"auto"===i&&e.widthi?"left":e>0?"right":"center",vertical:0>r?"top":s>0?"bottom":"middle"};l>p&&p>a(e+i)&&(u.horizontal="center"),c>f&&f>a(s+r)&&(u.vertical="middle"),u.important=o(a(e),a(i))>o(a(s),a(r))?"horizontal":"vertical",n.using.call(this,t,u)}),h.offset(t.extend(D,{using:r}))})},t.ui.position={fit:{left:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollLeft:s.offset.left,a=s.width,r=t.left-e.collisionPosition.marginLeft,h=n-r,l=r+e.collisionWidth-a-n;e.collisionWidth>a?h>0&&0>=l?(i=t.left+h+e.collisionWidth-a-n,t.left+=h-i):t.left=l>0&&0>=h?n:h>l?n+a-e.collisionWidth:n:h>0?t.left+=h:l>0?t.left-=l:t.left=o(t.left-r,t.left)},top:function(t,e){var i,s=e.within,n=s.isWindow?s.scrollTop:s.offset.top,a=e.within.height,r=t.top-e.collisionPosition.marginTop,h=n-r,l=r+e.collisionHeight-a-n;e.collisionHeight>a?h>0&&0>=l?(i=t.top+h+e.collisionHeight-a-n,t.top+=h-i):t.top=l>0&&0>=h?n:h>l?n+a-e.collisionHeight:n:h>0?t.top+=h:l>0?t.top-=l:t.top=o(t.top-r,t.top)}},flip:{left:function(t,e){var i,s,n=e.within,o=n.offset.left+n.scrollLeft,r=n.width,h=n.isWindow?n.scrollLeft:n.offset.left,l=t.left-e.collisionPosition.marginLeft,c=l-h,u=l+e.collisionWidth-r-h,d="left"===e.my[0]?-e.elemWidth:"right"===e.my[0]?e.elemWidth:0,p="left"===e.at[0]?e.targetWidth:"right"===e.at[0]?-e.targetWidth:0,f=-2*e.offset[0];0>c?(i=t.left+d+p+f+e.collisionWidth-r-o,(0>i||a(c)>i)&&(t.left+=d+p+f)):u>0&&(s=t.left-e.collisionPosition.marginLeft+d+p+f-h,(s>0||u>a(s))&&(t.left+=d+p+f))},top:function(t,e){var i,s,n=e.within,o=n.offset.top+n.scrollTop,r=n.height,h=n.isWindow?n.scrollTop:n.offset.top,l=t.top-e.collisionPosition.marginTop,c=l-h,u=l+e.collisionHeight-r-h,d="top"===e.my[1],p=d?-e.elemHeight:"bottom"===e.my[1]?e.elemHeight:0,f="top"===e.at[1]?e.targetHeight:"bottom"===e.at[1]?-e.targetHeight:0,m=-2*e.offset[1];0>c?(s=t.top+p+f+m+e.collisionHeight-r-o,(0>s||a(c)>s)&&(t.top+=p+f+m)):u>0&&(i=t.top-e.collisionPosition.marginTop+p+f+m-h,(i>0||u>a(i))&&(t.top+=p+f+m))}},flipfit:{left:function(){t.ui.position.flip.left.apply(this,arguments),t.ui.position.fit.left.apply(this,arguments)},top:function(){t.ui.position.flip.top.apply(this,arguments),t.ui.position.fit.top.apply(this,arguments)}}}}(),t.ui.position,t.extend(t.expr[":"],{data:t.expr.createPseudo?t.expr.createPseudo(function(e){return function(i){return!!t.data(i,e)}}):function(e,i,s){return!!t.data(e,s[3])}}),t.fn.extend({disableSelection:function(){var t="onselectstart"in document.createElement("div")?"selectstart":"mousedown";return function(){return this.on(t+".ui-disableSelection",function(t){t.preventDefault()})}}(),enableSelection:function(){return this.off(".ui-disableSelection")}}),t.ui.focusable=function(i,s){var n,o,a,r,h,l=i.nodeName.toLowerCase();return"area"===l?(n=i.parentNode,o=n.name,i.href&&o&&"map"===n.nodeName.toLowerCase()?(a=t("img[usemap='#"+o+"']"),a.length>0&&a.is(":visible")):!1):(/^(input|select|textarea|button|object)$/.test(l)?(r=!i.disabled,r&&(h=t(i).closest("fieldset")[0],h&&(r=!h.disabled))):r="a"===l?i.href||s:s,r&&t(i).is(":visible")&&e(t(i)))},t.extend(t.expr[":"],{focusable:function(e){return t.ui.focusable(e,null!=t.attr(e,"tabindex"))}}),t.ui.focusable,t.fn.form=function(){return"string"==typeof this[0].form?this.closest("form"):t(this[0].form)},t.ui.formResetMixin={_formResetHandler:function(){var e=t(this);setTimeout(function(){var i=e.data("ui-form-reset-instances");t.each(i,function(){this.refresh()})})},_bindFormResetHandler:function(){if(this.form=this.element.form(),this.form.length){var t=this.form.data("ui-form-reset-instances")||[];t.length||this.form.on("reset.ui-form-reset",this._formResetHandler),t.push(this),this.form.data("ui-form-reset-instances",t)}},_unbindFormResetHandler:function(){if(this.form.length){var e=this.form.data("ui-form-reset-instances");e.splice(t.inArray(this,e),1),e.length?this.form.data("ui-form-reset-instances",e):this.form.removeData("ui-form-reset-instances").off("reset.ui-form-reset")}}},"1.7"===t.fn.jquery.substring(0,3)&&(t.each(["Width","Height"],function(e,i){function s(e,i,s,o){return t.each(n,function(){i-=parseFloat(t.css(e,"padding"+this))||0,s&&(i-=parseFloat(t.css(e,"border"+this+"Width"))||0),o&&(i-=parseFloat(t.css(e,"margin"+this))||0)}),i}var n="Width"===i?["Left","Right"]:["Top","Bottom"],o=i.toLowerCase(),a={innerWidth:t.fn.innerWidth,innerHeight:t.fn.innerHeight,outerWidth:t.fn.outerWidth,outerHeight:t.fn.outerHeight};t.fn["inner"+i]=function(e){return void 0===e?a["inner"+i].call(this):this.each(function(){t(this).css(o,s(this,e)+"px")})},t.fn["outer"+i]=function(e,n){return"number"!=typeof e?a["outer"+i].call(this,e):this.each(function(){t(this).css(o,s(this,e,!0,n)+"px")})}}),t.fn.addBack=function(t){return this.add(null==t?this.prevObject:this.prevObject.filter(t))}),t.ui.keyCode={BACKSPACE:8,COMMA:188,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,LEFT:37,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SPACE:32,TAB:9,UP:38},t.ui.escapeSelector=function(){var t=/([!"#$%&'()*+,./:;<=>?@[\]^`{|}~])/g;return function(e){return e.replace(t,"\\$1")}}(),t.fn.labels=function(){var e,i,s,n,o;return this[0].labels&&this[0].labels.length?this.pushStack(this[0].labels):(n=this.eq(0).parents("label"),s=this.attr("id"),s&&(e=this.eq(0).parents().last(),o=e.add(e.length?e.siblings():this.siblings()),i="label[for='"+t.ui.escapeSelector(s)+"']",n=n.add(o.find(i).addBack(i))),this.pushStack(n))},t.fn.scrollParent=function(e){var i=this.css("position"),s="absolute"===i,n=e?/(auto|scroll|hidden)/:/(auto|scroll)/,o=this.parents().filter(function(){var e=t(this);return s&&"static"===e.css("position")?!1:n.test(e.css("overflow")+e.css("overflow-y")+e.css("overflow-x"))}).eq(0);return"fixed"!==i&&o.length?o:t(this[0].ownerDocument||document)},t.extend(t.expr[":"],{tabbable:function(e){var i=t.attr(e,"tabindex"),s=null!=i;return(!s||i>=0)&&t.ui.focusable(e,s)}}),t.fn.extend({uniqueId:function(){var t=0;return function(){return this.each(function(){this.id||(this.id="ui-id-"+ ++t)})}}(),removeUniqueId:function(){return this.each(function(){/^ui-id-\d+$/.test(this.id)&&t(this).removeAttr("id")})}}),t.ui.ie=!!/msie [\w.]+/.exec(navigator.userAgent.toLowerCase());var n=!1;t(document).on("mouseup",function(){n=!1}),t.widget("ui.mouse",{version:"1.12.1",options:{cancel:"input, textarea, button, select, option",distance:1,delay:0},_mouseInit:function(){var e=this;this.element.on("mousedown."+this.widgetName,function(t){return e._mouseDown(t)}).on("click."+this.widgetName,function(i){return!0===t.data(i.target,e.widgetName+".preventClickEvent")?(t.removeData(i.target,e.widgetName+".preventClickEvent"),i.stopImmediatePropagation(),!1):void 0}),this.started=!1},_mouseDestroy:function(){this.element.off("."+this.widgetName),this._mouseMoveDelegate&&this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate)},_mouseDown:function(e){if(!n){this._mouseMoved=!1,this._mouseStarted&&this._mouseUp(e),this._mouseDownEvent=e;var i=this,s=1===e.which,o="string"==typeof this.options.cancel&&e.target.nodeName?t(e.target).closest(this.options.cancel).length:!1;return s&&!o&&this._mouseCapture(e)?(this.mouseDelayMet=!this.options.delay,this.mouseDelayMet||(this._mouseDelayTimer=setTimeout(function(){i.mouseDelayMet=!0},this.options.delay)),this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(e)!==!1,!this._mouseStarted)?(e.preventDefault(),!0):(!0===t.data(e.target,this.widgetName+".preventClickEvent")&&t.removeData(e.target,this.widgetName+".preventClickEvent"),this._mouseMoveDelegate=function(t){return i._mouseMove(t)},this._mouseUpDelegate=function(t){return i._mouseUp(t)},this.document.on("mousemove."+this.widgetName,this._mouseMoveDelegate).on("mouseup."+this.widgetName,this._mouseUpDelegate),e.preventDefault(),n=!0,!0)):!0}},_mouseMove:function(e){if(this._mouseMoved){if(t.ui.ie&&(!document.documentMode||9>document.documentMode)&&!e.button)return this._mouseUp(e);if(!e.which)if(e.originalEvent.altKey||e.originalEvent.ctrlKey||e.originalEvent.metaKey||e.originalEvent.shiftKey)this.ignoreMissingWhich=!0;else if(!this.ignoreMissingWhich)return this._mouseUp(e)}return(e.which||e.button)&&(this._mouseMoved=!0),this._mouseStarted?(this._mouseDrag(e),e.preventDefault()):(this._mouseDistanceMet(e)&&this._mouseDelayMet(e)&&(this._mouseStarted=this._mouseStart(this._mouseDownEvent,e)!==!1,this._mouseStarted?this._mouseDrag(e):this._mouseUp(e)),!this._mouseStarted)},_mouseUp:function(e){this.document.off("mousemove."+this.widgetName,this._mouseMoveDelegate).off("mouseup."+this.widgetName,this._mouseUpDelegate),this._mouseStarted&&(this._mouseStarted=!1,e.target===this._mouseDownEvent.target&&t.data(e.target,this.widgetName+".preventClickEvent",!0),this._mouseStop(e)),this._mouseDelayTimer&&(clearTimeout(this._mouseDelayTimer),delete this._mouseDelayTimer),this.ignoreMissingWhich=!1,n=!1,e.preventDefault()},_mouseDistanceMet:function(t){return Math.max(Math.abs(this._mouseDownEvent.pageX-t.pageX),Math.abs(this._mouseDownEvent.pageY-t.pageY))>=this.options.distance},_mouseDelayMet:function(){return this.mouseDelayMet},_mouseStart:function(){},_mouseDrag:function(){},_mouseStop:function(){},_mouseCapture:function(){return!0}}),t.ui.plugin={add:function(e,i,s){var n,o=t.ui[e].prototype;for(n in s)o.plugins[n]=o.plugins[n]||[],o.plugins[n].push([i,s[n]])},call:function(t,e,i,s){var n,o=t.plugins[e];if(o&&(s||t.element[0].parentNode&&11!==t.element[0].parentNode.nodeType))for(n=0;o.length>n;n++)t.options[o[n][0]]&&o[n][1].apply(t.element,i)}},t.widget("ui.resizable",t.ui.mouse,{version:"1.12.1",widgetEventPrefix:"resize",options:{alsoResize:!1,animate:!1,animateDuration:"slow",animateEasing:"swing",aspectRatio:!1,autoHide:!1,classes:{"ui-resizable-se":"ui-icon ui-icon-gripsmall-diagonal-se"},containment:!1,ghost:!1,grid:!1,handles:"e,s,se",helper:!1,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:90,resize:null,start:null,stop:null},_num:function(t){return parseFloat(t)||0},_isNumber:function(t){return!isNaN(parseFloat(t))},_hasScroll:function(e,i){if("hidden"===t(e).css("overflow"))return!1;var s=i&&"left"===i?"scrollLeft":"scrollTop",n=!1;return e[s]>0?!0:(e[s]=1,n=e[s]>0,e[s]=0,n)},_create:function(){var e,i=this.options,s=this;this._addClass("ui-resizable"),t.extend(this,{_aspectRatio:!!i.aspectRatio,aspectRatio:i.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:i.helper||i.ghost||i.animate?i.helper||"ui-resizable-helper":null}),this.element[0].nodeName.match(/^(canvas|textarea|input|select|button|img)$/i)&&(this.element.wrap(t("
").css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")})),this.element=this.element.parent().data("ui-resizable",this.element.resizable("instance")),this.elementIsWrapper=!0,e={marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom"),marginLeft:this.originalElement.css("marginLeft")},this.element.css(e),this.originalElement.css("margin",0),this.originalResizeStyle=this.originalElement.css("resize"),this.originalElement.css("resize","none"),this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"})),this.originalElement.css(e),this._proportionallyResize()),this._setupHandles(),i.autoHide&&t(this.element).on("mouseenter",function(){i.disabled||(s._removeClass("ui-resizable-autohide"),s._handles.show())}).on("mouseleave",function(){i.disabled||s.resizing||(s._addClass("ui-resizable-autohide"),s._handles.hide())}),this._mouseInit()},_destroy:function(){this._mouseDestroy();var e,i=function(e){t(e).removeData("resizable").removeData("ui-resizable").off(".resizable").find(".ui-resizable-handle").remove()};return this.elementIsWrapper&&(i(this.element),e=this.element,this.originalElement.css({position:e.css("position"),width:e.outerWidth(),height:e.outerHeight(),top:e.css("top"),left:e.css("left")}).insertAfter(e),e.remove()),this.originalElement.css("resize",this.originalResizeStyle),i(this.originalElement),this},_setOption:function(t,e){switch(this._super(t,e),t){case"handles":this._removeHandles(),this._setupHandles();break;default:}},_setupHandles:function(){var e,i,s,n,o,a=this.options,r=this;if(this.handles=a.handles||(t(".ui-resizable-handle",this.element).length?{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"}:"e,s,se"),this._handles=t(),this.handles.constructor===String)for("all"===this.handles&&(this.handles="n,e,s,w,se,sw,ne,nw"),s=this.handles.split(","),this.handles={},i=0;s.length>i;i++)e=t.trim(s[i]),n="ui-resizable-"+e,o=t("
"),this._addClass(o,"ui-resizable-handle "+n),o.css({zIndex:a.zIndex}),this.handles[e]=".ui-resizable-"+e,this.element.append(o);this._renderAxis=function(e){var i,s,n,o;e=e||this.element;for(i in this.handles)this.handles[i].constructor===String?this.handles[i]=this.element.children(this.handles[i]).first().show():(this.handles[i].jquery||this.handles[i].nodeType)&&(this.handles[i]=t(this.handles[i]),this._on(this.handles[i],{mousedown:r._mouseDown})),this.elementIsWrapper&&this.originalElement[0].nodeName.match(/^(textarea|input|select|button)$/i)&&(s=t(this.handles[i],this.element),o=/sw|ne|nw|se|n|s/.test(i)?s.outerHeight():s.outerWidth(),n=["padding",/ne|nw|n/.test(i)?"Top":/se|sw|s/.test(i)?"Bottom":/^e$/.test(i)?"Right":"Left"].join(""),e.css(n,o),this._proportionallyResize()),this._handles=this._handles.add(this.handles[i])},this._renderAxis(this.element),this._handles=this._handles.add(this.element.find(".ui-resizable-handle")),this._handles.disableSelection(),this._handles.on("mouseover",function(){r.resizing||(this.className&&(o=this.className.match(/ui-resizable-(se|sw|ne|nw|n|e|s|w)/i)),r.axis=o&&o[1]?o[1]:"se")}),a.autoHide&&(this._handles.hide(),this._addClass("ui-resizable-autohide"))},_removeHandles:function(){this._handles.remove()},_mouseCapture:function(e){var i,s,n=!1;for(i in this.handles)s=t(this.handles[i])[0],(s===e.target||t.contains(s,e.target))&&(n=!0);return!this.options.disabled&&n},_mouseStart:function(e){var i,s,n,o=this.options,a=this.element;return this.resizing=!0,this._renderProxy(),i=this._num(this.helper.css("left")),s=this._num(this.helper.css("top")),o.containment&&(i+=t(o.containment).scrollLeft()||0,s+=t(o.containment).scrollTop()||0),this.offset=this.helper.offset(),this.position={left:i,top:s},this.size=this._helper?{width:this.helper.width(),height:this.helper.height()}:{width:a.width(),height:a.height()},this.originalSize=this._helper?{width:a.outerWidth(),height:a.outerHeight()}:{width:a.width(),height:a.height()},this.sizeDiff={width:a.outerWidth()-a.width(),height:a.outerHeight()-a.height()},this.originalPosition={left:i,top:s},this.originalMousePosition={left:e.pageX,top:e.pageY},this.aspectRatio="number"==typeof o.aspectRatio?o.aspectRatio:this.originalSize.width/this.originalSize.height||1,n=t(".ui-resizable-"+this.axis).css("cursor"),t("body").css("cursor","auto"===n?this.axis+"-resize":n),this._addClass("ui-resizable-resizing"),this._propagate("start",e),!0},_mouseDrag:function(e){var i,s,n=this.originalMousePosition,o=this.axis,a=e.pageX-n.left||0,r=e.pageY-n.top||0,h=this._change[o];return this._updatePrevProperties(),h?(i=h.apply(this,[e,a,r]),this._updateVirtualBoundaries(e.shiftKey),(this._aspectRatio||e.shiftKey)&&(i=this._updateRatio(i,e)),i=this._respectSize(i,e),this._updateCache(i),this._propagate("resize",e),s=this._applyChanges(),!this._helper&&this._proportionallyResizeElements.length&&this._proportionallyResize(),t.isEmptyObject(s)||(this._updatePrevProperties(),this._trigger("resize",e,this.ui()),this._applyChanges()),!1):!1},_mouseStop:function(e){this.resizing=!1;var i,s,n,o,a,r,h,l=this.options,c=this;return this._helper&&(i=this._proportionallyResizeElements,s=i.length&&/textarea/i.test(i[0].nodeName),n=s&&this._hasScroll(i[0],"left")?0:c.sizeDiff.height,o=s?0:c.sizeDiff.width,a={width:c.helper.width()-o,height:c.helper.height()-n},r=parseFloat(c.element.css("left"))+(c.position.left-c.originalPosition.left)||null,h=parseFloat(c.element.css("top"))+(c.position.top-c.originalPosition.top)||null,l.animate||this.element.css(t.extend(a,{top:h,left:r})),c.helper.height(c.size.height),c.helper.width(c.size.width),this._helper&&!l.animate&&this._proportionallyResize()),t("body").css("cursor","auto"),this._removeClass("ui-resizable-resizing"),this._propagate("stop",e),this._helper&&this.helper.remove(),!1},_updatePrevProperties:function(){this.prevPosition={top:this.position.top,left:this.position.left},this.prevSize={width:this.size.width,height:this.size.height}},_applyChanges:function(){var t={};return this.position.top!==this.prevPosition.top&&(t.top=this.position.top+"px"),this.position.left!==this.prevPosition.left&&(t.left=this.position.left+"px"),this.size.width!==this.prevSize.width&&(t.width=this.size.width+"px"),this.size.height!==this.prevSize.height&&(t.height=this.size.height+"px"),this.helper.css(t),t},_updateVirtualBoundaries:function(t){var e,i,s,n,o,a=this.options;o={minWidth:this._isNumber(a.minWidth)?a.minWidth:0,maxWidth:this._isNumber(a.maxWidth)?a.maxWidth:1/0,minHeight:this._isNumber(a.minHeight)?a.minHeight:0,maxHeight:this._isNumber(a.maxHeight)?a.maxHeight:1/0},(this._aspectRatio||t)&&(e=o.minHeight*this.aspectRatio,s=o.minWidth/this.aspectRatio,i=o.maxHeight*this.aspectRatio,n=o.maxWidth/this.aspectRatio,e>o.minWidth&&(o.minWidth=e),s>o.minHeight&&(o.minHeight=s),o.maxWidth>i&&(o.maxWidth=i),o.maxHeight>n&&(o.maxHeight=n)),this._vBoundaries=o},_updateCache:function(t){this.offset=this.helper.offset(),this._isNumber(t.left)&&(this.position.left=t.left),this._isNumber(t.top)&&(this.position.top=t.top),this._isNumber(t.height)&&(this.size.height=t.height),this._isNumber(t.width)&&(this.size.width=t.width)},_updateRatio:function(t){var e=this.position,i=this.size,s=this.axis;return this._isNumber(t.height)?t.width=t.height*this.aspectRatio:this._isNumber(t.width)&&(t.height=t.width/this.aspectRatio),"sw"===s&&(t.left=e.left+(i.width-t.width),t.top=null),"nw"===s&&(t.top=e.top+(i.height-t.height),t.left=e.left+(i.width-t.width)),t},_respectSize:function(t){var e=this._vBoundaries,i=this.axis,s=this._isNumber(t.width)&&e.maxWidth&&e.maxWidtht.width,a=this._isNumber(t.height)&&e.minHeight&&e.minHeight>t.height,r=this.originalPosition.left+this.originalSize.width,h=this.originalPosition.top+this.originalSize.height,l=/sw|nw|w/.test(i),c=/nw|ne|n/.test(i);return o&&(t.width=e.minWidth),a&&(t.height=e.minHeight),s&&(t.width=e.maxWidth),n&&(t.height=e.maxHeight),o&&l&&(t.left=r-e.minWidth),s&&l&&(t.left=r-e.maxWidth),a&&c&&(t.top=h-e.minHeight),n&&c&&(t.top=h-e.maxHeight),t.width||t.height||t.left||!t.top?t.width||t.height||t.top||!t.left||(t.left=null):t.top=null,t},_getPaddingPlusBorderDimensions:function(t){for(var e=0,i=[],s=[t.css("borderTopWidth"),t.css("borderRightWidth"),t.css("borderBottomWidth"),t.css("borderLeftWidth")],n=[t.css("paddingTop"),t.css("paddingRight"),t.css("paddingBottom"),t.css("paddingLeft")];4>e;e++)i[e]=parseFloat(s[e])||0,i[e]+=parseFloat(n[e])||0;return{height:i[0]+i[2],width:i[1]+i[3]}},_proportionallyResize:function(){if(this._proportionallyResizeElements.length)for(var t,e=0,i=this.helper||this.element;this._proportionallyResizeElements.length>e;e++)t=this._proportionallyResizeElements[e],this.outerDimensions||(this.outerDimensions=this._getPaddingPlusBorderDimensions(t)),t.css({height:i.height()-this.outerDimensions.height||0,width:i.width()-this.outerDimensions.width||0})},_renderProxy:function(){var e=this.element,i=this.options;this.elementOffset=e.offset(),this._helper?(this.helper=this.helper||t("
"),this._addClass(this.helper,this._helper),this.helper.css({width:this.element.outerWidth(),height:this.element.outerHeight(),position:"absolute",left:this.elementOffset.left+"px",top:this.elementOffset.top+"px",zIndex:++i.zIndex}),this.helper.appendTo("body").disableSelection()):this.helper=this.element +},_change:{e:function(t,e){return{width:this.originalSize.width+e}},w:function(t,e){var i=this.originalSize,s=this.originalPosition;return{left:s.left+e,width:i.width-e}},n:function(t,e,i){var s=this.originalSize,n=this.originalPosition;return{top:n.top+i,height:s.height-i}},s:function(t,e,i){return{height:this.originalSize.height+i}},se:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},sw:function(e,i,s){return t.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[e,i,s]))},ne:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[e,i,s]))},nw:function(e,i,s){return t.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[e,i,s]))}},_propagate:function(e,i){t.ui.plugin.call(this,e,[i,this.ui()]),"resize"!==e&&this._trigger(e,i,this.ui())},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}}),t.ui.plugin.add("resizable","animate",{stop:function(e){var i=t(this).resizable("instance"),s=i.options,n=i._proportionallyResizeElements,o=n.length&&/textarea/i.test(n[0].nodeName),a=o&&i._hasScroll(n[0],"left")?0:i.sizeDiff.height,r=o?0:i.sizeDiff.width,h={width:i.size.width-r,height:i.size.height-a},l=parseFloat(i.element.css("left"))+(i.position.left-i.originalPosition.left)||null,c=parseFloat(i.element.css("top"))+(i.position.top-i.originalPosition.top)||null;i.element.animate(t.extend(h,c&&l?{top:c,left:l}:{}),{duration:s.animateDuration,easing:s.animateEasing,step:function(){var s={width:parseFloat(i.element.css("width")),height:parseFloat(i.element.css("height")),top:parseFloat(i.element.css("top")),left:parseFloat(i.element.css("left"))};n&&n.length&&t(n[0]).css({width:s.width,height:s.height}),i._updateCache(s),i._propagate("resize",e)}})}}),t.ui.plugin.add("resizable","containment",{start:function(){var e,i,s,n,o,a,r,h=t(this).resizable("instance"),l=h.options,c=h.element,u=l.containment,d=u instanceof t?u.get(0):/parent/.test(u)?c.parent().get(0):u;d&&(h.containerElement=t(d),/document/.test(u)||u===document?(h.containerOffset={left:0,top:0},h.containerPosition={left:0,top:0},h.parentData={element:t(document),left:0,top:0,width:t(document).width(),height:t(document).height()||document.body.parentNode.scrollHeight}):(e=t(d),i=[],t(["Top","Right","Left","Bottom"]).each(function(t,s){i[t]=h._num(e.css("padding"+s))}),h.containerOffset=e.offset(),h.containerPosition=e.position(),h.containerSize={height:e.innerHeight()-i[3],width:e.innerWidth()-i[1]},s=h.containerOffset,n=h.containerSize.height,o=h.containerSize.width,a=h._hasScroll(d,"left")?d.scrollWidth:o,r=h._hasScroll(d)?d.scrollHeight:n,h.parentData={element:d,left:s.left,top:s.top,width:a,height:r}))},resize:function(e){var i,s,n,o,a=t(this).resizable("instance"),r=a.options,h=a.containerOffset,l=a.position,c=a._aspectRatio||e.shiftKey,u={top:0,left:0},d=a.containerElement,p=!0;d[0]!==document&&/static/.test(d.css("position"))&&(u=h),l.left<(a._helper?h.left:0)&&(a.size.width=a.size.width+(a._helper?a.position.left-h.left:a.position.left-u.left),c&&(a.size.height=a.size.width/a.aspectRatio,p=!1),a.position.left=r.helper?h.left:0),l.top<(a._helper?h.top:0)&&(a.size.height=a.size.height+(a._helper?a.position.top-h.top:a.position.top),c&&(a.size.width=a.size.height*a.aspectRatio,p=!1),a.position.top=a._helper?h.top:0),n=a.containerElement.get(0)===a.element.parent().get(0),o=/relative|absolute/.test(a.containerElement.css("position")),n&&o?(a.offset.left=a.parentData.left+a.position.left,a.offset.top=a.parentData.top+a.position.top):(a.offset.left=a.element.offset().left,a.offset.top=a.element.offset().top),i=Math.abs(a.sizeDiff.width+(a._helper?a.offset.left-u.left:a.offset.left-h.left)),s=Math.abs(a.sizeDiff.height+(a._helper?a.offset.top-u.top:a.offset.top-h.top)),i+a.size.width>=a.parentData.width&&(a.size.width=a.parentData.width-i,c&&(a.size.height=a.size.width/a.aspectRatio,p=!1)),s+a.size.height>=a.parentData.height&&(a.size.height=a.parentData.height-s,c&&(a.size.width=a.size.height*a.aspectRatio,p=!1)),p||(a.position.left=a.prevPosition.left,a.position.top=a.prevPosition.top,a.size.width=a.prevSize.width,a.size.height=a.prevSize.height)},stop:function(){var e=t(this).resizable("instance"),i=e.options,s=e.containerOffset,n=e.containerPosition,o=e.containerElement,a=t(e.helper),r=a.offset(),h=a.outerWidth()-e.sizeDiff.width,l=a.outerHeight()-e.sizeDiff.height;e._helper&&!i.animate&&/relative/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l}),e._helper&&!i.animate&&/static/.test(o.css("position"))&&t(this).css({left:r.left-n.left-s.left,width:h,height:l})}}),t.ui.plugin.add("resizable","alsoResize",{start:function(){var e=t(this).resizable("instance"),i=e.options;t(i.alsoResize).each(function(){var e=t(this);e.data("ui-resizable-alsoresize",{width:parseFloat(e.width()),height:parseFloat(e.height()),left:parseFloat(e.css("left")),top:parseFloat(e.css("top"))})})},resize:function(e,i){var s=t(this).resizable("instance"),n=s.options,o=s.originalSize,a=s.originalPosition,r={height:s.size.height-o.height||0,width:s.size.width-o.width||0,top:s.position.top-a.top||0,left:s.position.left-a.left||0};t(n.alsoResize).each(function(){var e=t(this),s=t(this).data("ui-resizable-alsoresize"),n={},o=e.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];t.each(o,function(t,e){var i=(s[e]||0)+(r[e]||0);i&&i>=0&&(n[e]=i||null)}),e.css(n)})},stop:function(){t(this).removeData("ui-resizable-alsoresize")}}),t.ui.plugin.add("resizable","ghost",{start:function(){var e=t(this).resizable("instance"),i=e.size;e.ghost=e.originalElement.clone(),e.ghost.css({opacity:.25,display:"block",position:"relative",height:i.height,width:i.width,margin:0,left:0,top:0}),e._addClass(e.ghost,"ui-resizable-ghost"),t.uiBackCompat!==!1&&"string"==typeof e.options.ghost&&e.ghost.addClass(this.options.ghost),e.ghost.appendTo(e.helper)},resize:function(){var e=t(this).resizable("instance");e.ghost&&e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})},stop:function(){var e=t(this).resizable("instance");e.ghost&&e.helper&&e.helper.get(0).removeChild(e.ghost.get(0))}}),t.ui.plugin.add("resizable","grid",{resize:function(){var e,i=t(this).resizable("instance"),s=i.options,n=i.size,o=i.originalSize,a=i.originalPosition,r=i.axis,h="number"==typeof s.grid?[s.grid,s.grid]:s.grid,l=h[0]||1,c=h[1]||1,u=Math.round((n.width-o.width)/l)*l,d=Math.round((n.height-o.height)/c)*c,p=o.width+u,f=o.height+d,m=s.maxWidth&&p>s.maxWidth,g=s.maxHeight&&f>s.maxHeight,_=s.minWidth&&s.minWidth>p,v=s.minHeight&&s.minHeight>f;s.grid=h,_&&(p+=l),v&&(f+=c),m&&(p-=l),g&&(f-=c),/^(se|s|e)$/.test(r)?(i.size.width=p,i.size.height=f):/^(ne)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.top=a.top-d):/^(sw)$/.test(r)?(i.size.width=p,i.size.height=f,i.position.left=a.left-u):((0>=f-c||0>=p-l)&&(e=i._getPaddingPlusBorderDimensions(this)),f-c>0?(i.size.height=f,i.position.top=a.top-d):(f=c-e.height,i.size.height=f,i.position.top=a.top+o.height-f),p-l>0?(i.size.width=p,i.position.left=a.left-u):(p=l-e.width,i.size.width=p,i.position.left=a.left+o.width-p))}}),t.ui.resizable});/** + * Copyright (c) 2007 Ariel Flesler - aflesler ○ gmail • com | https://github.com/flesler + * Licensed under MIT + * @author Ariel Flesler + * @version 2.1.2 + */ +;(function(f){"use strict";"function"===typeof define&&define.amd?define(["jquery"],f):"undefined"!==typeof module&&module.exports?module.exports=f(require("jquery")):f(jQuery)})(function($){"use strict";function n(a){return!a.nodeName||-1!==$.inArray(a.nodeName.toLowerCase(),["iframe","#document","html","body"])}function h(a){return $.isFunction(a)||$.isPlainObject(a)?a:{top:a,left:a}}var p=$.scrollTo=function(a,d,b){return $(window).scrollTo(a,d,b)};p.defaults={axis:"xy",duration:0,limit:!0};$.fn.scrollTo=function(a,d,b){"object"=== typeof d&&(b=d,d=0);"function"===typeof b&&(b={onAfter:b});"max"===a&&(a=9E9);b=$.extend({},p.defaults,b);d=d||b.duration;var u=b.queue&&1=f[g]?0:Math.min(f[g],n));!a&&1-1){targetElements.on(evt+EVENT_NAMESPACE,function elementToggle(event){$.powerTip.toggle(this,event)})}else{targetElements.on(evt+EVENT_NAMESPACE,function elementOpen(event){$.powerTip.show(this,event)})}});$.each(options.closeEvents,function(idx,evt){if($.inArray(evt,options.openEvents)<0){targetElements.on(evt+EVENT_NAMESPACE,function elementClose(event){$.powerTip.hide(this,!isMouseEvent(event))})}});targetElements.on("keydown"+EVENT_NAMESPACE,function elementKeyDown(event){if(event.keyCode===27){$.powerTip.hide(this,true)}})}return targetElements};$.fn.powerTip.defaults={fadeInTime:200,fadeOutTime:100,followMouse:false,popupId:"powerTip",popupClass:null,intentSensitivity:7,intentPollInterval:100,closeDelay:100,placement:"n",smartPlacement:false,offset:10,mouseOnToPopup:false,manual:false,openEvents:["mouseenter","focus"],closeEvents:["mouseleave","blur"]};$.fn.powerTip.smartPlacementLists={n:["n","ne","nw","s"],e:["e","ne","se","w","nw","sw","n","s","e"],s:["s","se","sw","n"],w:["w","nw","sw","e","ne","se","n","s","w"],nw:["nw","w","sw","n","s","se","nw"],ne:["ne","e","se","n","s","sw","ne"],sw:["sw","w","nw","s","n","ne","sw"],se:["se","e","ne","s","n","nw","se"],"nw-alt":["nw-alt","n","ne-alt","sw-alt","s","se-alt","w","e"],"ne-alt":["ne-alt","n","nw-alt","se-alt","s","sw-alt","e","w"],"sw-alt":["sw-alt","s","se-alt","nw-alt","n","ne-alt","w","e"],"se-alt":["se-alt","s","sw-alt","ne-alt","n","nw-alt","e","w"]};$.powerTip={show:function apiShowTip(element,event){if(isMouseEvent(event)){trackMouse(event);session.previousX=event.pageX;session.previousY=event.pageY;$(element).data(DATA_DISPLAYCONTROLLER).show()}else{$(element).first().data(DATA_DISPLAYCONTROLLER).show(true,true)}return element},reposition:function apiResetPosition(element){$(element).first().data(DATA_DISPLAYCONTROLLER).resetPosition();return element},hide:function apiCloseTip(element,immediate){var displayController;immediate=element?immediate:true;if(element){displayController=$(element).first().data(DATA_DISPLAYCONTROLLER)}else if(session.activeHover){displayController=session.activeHover.data(DATA_DISPLAYCONTROLLER)}if(displayController){displayController.hide(immediate)}return element},toggle:function apiToggle(element,event){if(session.activeHover&&session.activeHover.is(element)){$.powerTip.hide(element,!isMouseEvent(event))}else{$.powerTip.show(element,event)}return element}};$.powerTip.showTip=$.powerTip.show;$.powerTip.closeTip=$.powerTip.hide;function CSSCoordinates(){var me=this;me.top="auto";me.left="auto";me.right="auto";me.bottom="auto";me.set=function(property,value){if($.isNumeric(value)){me[property]=Math.round(value)}}}function DisplayController(element,options,tipController){var hoverTimer=null,myCloseDelay=null;function openTooltip(immediate,forceOpen){cancelTimer();if(!element.data(DATA_HASACTIVEHOVER)){if(!immediate){session.tipOpenImminent=true;hoverTimer=setTimeout(function intentDelay(){hoverTimer=null;checkForIntent()},options.intentPollInterval)}else{if(forceOpen){element.data(DATA_FORCEDOPEN,true)}closeAnyDelayed();tipController.showTip(element)}}else{cancelClose()}}function closeTooltip(disableDelay){if(myCloseDelay){myCloseDelay=session.closeDelayTimeout=clearTimeout(myCloseDelay);session.delayInProgress=false}cancelTimer();session.tipOpenImminent=false;if(element.data(DATA_HASACTIVEHOVER)){element.data(DATA_FORCEDOPEN,false);if(!disableDelay){session.delayInProgress=true;session.closeDelayTimeout=setTimeout(function closeDelay(){session.closeDelayTimeout=null;tipController.hideTip(element);session.delayInProgress=false;myCloseDelay=null},options.closeDelay);myCloseDelay=session.closeDelayTimeout}else{tipController.hideTip(element)}}}function checkForIntent(){var xDifference=Math.abs(session.previousX-session.currentX),yDifference=Math.abs(session.previousY-session.currentY),totalDifference=xDifference+yDifference;if(totalDifference",{id:options.popupId});if($body.length===0){$body=$("body")}$body.append(tipElement);session.tooltips=session.tooltips?session.tooltips.add(tipElement):tipElement}if(options.followMouse){if(!tipElement.data(DATA_HASMOUSEMOVE)){$document.on("mousemove"+EVENT_NAMESPACE,positionTipOnCursor);$window.on("scroll"+EVENT_NAMESPACE,positionTipOnCursor);tipElement.data(DATA_HASMOUSEMOVE,true)}}function beginShowTip(element){element.data(DATA_HASACTIVEHOVER,true);tipElement.queue(function queueTipInit(next){showTip(element);next()})}function showTip(element){var tipContent;if(!element.data(DATA_HASACTIVEHOVER)){return}if(session.isTipOpen){if(!session.isClosing){hideTip(session.activeHover)}tipElement.delay(100).queue(function queueTipAgain(next){showTip(element);next()});return}element.trigger("powerTipPreRender");tipContent=getTooltipContent(element);if(tipContent){tipElement.empty().append(tipContent)}else{return}element.trigger("powerTipRender");session.activeHover=element;session.isTipOpen=true;tipElement.data(DATA_MOUSEONTOTIP,options.mouseOnToPopup);tipElement.addClass(options.popupClass);if(!options.followMouse||element.data(DATA_FORCEDOPEN)){positionTipOnElement(element);session.isFixedTipOpen=true}else{positionTipOnCursor()}if(!element.data(DATA_FORCEDOPEN)&&!options.followMouse){$document.on("click"+EVENT_NAMESPACE,function documentClick(event){var target=event.target;if(target!==element[0]){if(options.mouseOnToPopup){if(target!==tipElement[0]&&!$.contains(tipElement[0],target)){$.powerTip.hide()}}else{$.powerTip.hide()}}})}if(options.mouseOnToPopup&&!options.manual){tipElement.on("mouseenter"+EVENT_NAMESPACE,function tipMouseEnter(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).cancel()}});tipElement.on("mouseleave"+EVENT_NAMESPACE,function tipMouseLeave(){if(session.activeHover){session.activeHover.data(DATA_DISPLAYCONTROLLER).hide()}})}tipElement.fadeIn(options.fadeInTime,function fadeInCallback(){if(!session.desyncTimeout){session.desyncTimeout=setInterval(closeDesyncedTip,500)}element.trigger("powerTipOpen")})}function hideTip(element){session.isClosing=true;session.isTipOpen=false;session.desyncTimeout=clearInterval(session.desyncTimeout);element.data(DATA_HASACTIVEHOVER,false);element.data(DATA_FORCEDOPEN,false);$document.off("click"+EVENT_NAMESPACE);tipElement.off(EVENT_NAMESPACE);tipElement.fadeOut(options.fadeOutTime,function fadeOutCallback(){var coords=new CSSCoordinates;session.activeHover=null;session.isClosing=false;session.isFixedTipOpen=false;tipElement.removeClass();coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);tipElement.css(coords);element.trigger("powerTipClose")})}function positionTipOnCursor(){var tipWidth,tipHeight,coords,collisions,collisionCount;if(!session.isFixedTipOpen&&(session.isTipOpen||session.tipOpenImminent&&tipElement.data(DATA_HASMOUSEMOVE))){tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=new CSSCoordinates;coords.set("top",session.currentY+options.offset);coords.set("left",session.currentX+options.offset);collisions=getViewportCollisions(coords,tipWidth,tipHeight);if(collisions!==Collision.none){collisionCount=countFlags(collisions);if(collisionCount===1){if(collisions===Collision.right){coords.set("left",session.scrollLeft+session.windowWidth-tipWidth)}else if(collisions===Collision.bottom){coords.set("top",session.scrollTop+session.windowHeight-tipHeight)}}else{coords.set("left",session.currentX-tipWidth-options.offset);coords.set("top",session.currentY-tipHeight-options.offset)}}tipElement.css(coords)}}function positionTipOnElement(element){var priorityList,finalPlacement;if(options.smartPlacement||options.followMouse&&element.data(DATA_FORCEDOPEN)){priorityList=$.fn.powerTip.smartPlacementLists[options.placement];$.each(priorityList,function(idx,pos){var collisions=getViewportCollisions(placeTooltip(element,pos),tipElement.outerWidth(),tipElement.outerHeight());finalPlacement=pos;return collisions!==Collision.none})}else{placeTooltip(element,options.placement);finalPlacement=options.placement}tipElement.removeClass("w nw sw e ne se n s w se-alt sw-alt ne-alt nw-alt");tipElement.addClass(finalPlacement)}function placeTooltip(element,placement){var iterationCount=0,tipWidth,tipHeight,coords=new CSSCoordinates;coords.set("top",0);coords.set("left",0);tipElement.css(coords);do{tipWidth=tipElement.outerWidth();tipHeight=tipElement.outerHeight();coords=placementCalculator.compute(element,placement,tipWidth,tipHeight,options.offset);tipElement.css(coords)}while(++iterationCount<=5&&(tipWidth!==tipElement.outerWidth()||tipHeight!==tipElement.outerHeight()));return coords}function closeDesyncedTip(){var isDesynced=false,hasDesyncableCloseEvent=$.grep(["mouseleave","mouseout","blur","focusout"],function(eventType){return $.inArray(eventType,options.closeEvents)!==-1}).length>0;if(session.isTipOpen&&!session.isClosing&&!session.delayInProgress&&hasDesyncableCloseEvent){if(session.activeHover.data(DATA_HASACTIVEHOVER)===false||session.activeHover.is(":disabled")){isDesynced=true}else if(!isMouseOver(session.activeHover)&&!session.activeHover.is(":focus")&&!session.activeHover.data(DATA_FORCEDOPEN)){if(tipElement.data(DATA_MOUSEONTOTIP)){if(!isMouseOver(tipElement)){isDesynced=true}}else{isDesynced=true}}if(isDesynced){hideTip(session.activeHover)}}}this.showTip=beginShowTip;this.hideTip=hideTip;this.resetPosition=positionTipOnElement}function isSvgElement(element){return Boolean(window.SVGElement&&element[0]instanceof SVGElement)}function isMouseEvent(event){return Boolean(event&&$.inArray(event.type,MOUSE_EVENTS)>-1&&typeof event.pageX==="number")}function initTracking(){if(!session.mouseTrackingActive){session.mouseTrackingActive=true;getViewportDimensions();$(getViewportDimensions);$document.on("mousemove"+EVENT_NAMESPACE,trackMouse);$window.on("resize"+EVENT_NAMESPACE,trackResize);$window.on("scroll"+EVENT_NAMESPACE,trackScroll)}}function getViewportDimensions(){session.scrollLeft=$window.scrollLeft();session.scrollTop=$window.scrollTop();session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackResize(){session.windowWidth=$window.width();session.windowHeight=$window.height()}function trackScroll(){var x=$window.scrollLeft(),y=$window.scrollTop();if(x!==session.scrollLeft){session.currentX+=x-session.scrollLeft;session.scrollLeft=x}if(y!==session.scrollTop){session.currentY+=y-session.scrollTop;session.scrollTop=y}}function trackMouse(event){session.currentX=event.pageX;session.currentY=event.pageY}function isMouseOver(element){var elementPosition=element.offset(),elementBox=element[0].getBoundingClientRect(),elementWidth=elementBox.right-elementBox.left,elementHeight=elementBox.bottom-elementBox.top;return session.currentX>=elementPosition.left&&session.currentX<=elementPosition.left+elementWidth&&session.currentY>=elementPosition.top&&session.currentY<=elementPosition.top+elementHeight}function getTooltipContent(element){var tipText=element.data(DATA_POWERTIP),tipObject=element.data(DATA_POWERTIPJQ),tipTarget=element.data(DATA_POWERTIPTARGET),targetElement,content;if(tipText){if($.isFunction(tipText)){tipText=tipText.call(element[0])}content=tipText}else if(tipObject){if($.isFunction(tipObject)){tipObject=tipObject.call(element[0])}if(tipObject.length>0){content=tipObject.clone(true,true)}}else if(tipTarget){targetElement=$("#"+tipTarget);if(targetElement.length>0){content=targetElement.html()}}return content}function getViewportCollisions(coords,elementWidth,elementHeight){var viewportTop=session.scrollTop,viewportLeft=session.scrollLeft,viewportBottom=viewportTop+session.windowHeight,viewportRight=viewportLeft+session.windowWidth,collisions=Collision.none;if(coords.topviewportBottom||Math.abs(coords.bottom-session.windowHeight)>viewportBottom){collisions|=Collision.bottom}if(coords.leftviewportRight){collisions|=Collision.left}if(coords.left+elementWidth>viewportRight||coords.right1)){a.preventDefault();var c=a.originalEvent.changedTouches[0],d=document.createEvent("MouseEvents");d.initMouseEvent(b,!0,!0,window,1,c.screenX,c.screenY,c.clientX,c.clientY,!1,!1,!1,!1,0,null),a.target.dispatchEvent(d)}}if(a.support.touch="ontouchend"in document,a.support.touch){var e,b=a.ui.mouse.prototype,c=b._mouseInit,d=b._mouseDestroy;b._touchStart=function(a){var b=this;!e&&b._mouseCapture(a.originalEvent.changedTouches[0])&&(e=!0,b._touchMoved=!1,f(a,"mouseover"),f(a,"mousemove"),f(a,"mousedown"))},b._touchMove=function(a){e&&(this._touchMoved=!0,f(a,"mousemove"))},b._touchEnd=function(a){e&&(f(a,"mouseup"),f(a,"mouseout"),this._touchMoved||f(a,"click"),e=!1)},b._mouseInit=function(){var b=this;b.element.bind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),c.call(b)},b._mouseDestroy=function(){var b=this;b.element.unbind({touchstart:a.proxy(b,"_touchStart"),touchmove:a.proxy(b,"_touchMove"),touchend:a.proxy(b,"_touchEnd")}),d.call(b)}}}(jQuery);/*! SmartMenus jQuery Plugin - v1.1.0 - September 17, 2017 + * http://www.smartmenus.org/ + * Copyright Vasil Dinkov, Vadikom Web Ltd. http://vadikom.com; Licensed MIT */(function(t){"function"==typeof define&&define.amd?define(["jquery"],t):"object"==typeof module&&"object"==typeof module.exports?module.exports=t(require("jquery")):t(jQuery)})(function($){function initMouseDetection(t){var e=".smartmenus_mouse";if(mouseDetectionEnabled||t)mouseDetectionEnabled&&t&&($(document).off(e),mouseDetectionEnabled=!1);else{var i=!0,s=null,o={mousemove:function(t){var e={x:t.pageX,y:t.pageY,timeStamp:(new Date).getTime()};if(s){var o=Math.abs(s.x-e.x),a=Math.abs(s.y-e.y);if((o>0||a>0)&&2>=o&&2>=a&&300>=e.timeStamp-s.timeStamp&&(mouse=!0,i)){var n=$(t.target).closest("a");n.is("a")&&$.each(menuTrees,function(){return $.contains(this.$root[0],n[0])?(this.itemEnter({currentTarget:n[0]}),!1):void 0}),i=!1}}s=e}};o[touchEvents?"touchstart":"pointerover pointermove pointerout MSPointerOver MSPointerMove MSPointerOut"]=function(t){isTouchEvent(t.originalEvent)&&(mouse=!1)},$(document).on(getEventsNS(o,e)),mouseDetectionEnabled=!0}}function isTouchEvent(t){return!/^(4|mouse)$/.test(t.pointerType)}function getEventsNS(t,e){e||(e="");var i={};for(var s in t)i[s.split(" ").join(e+" ")+e]=t[s];return i}var menuTrees=[],mouse=!1,touchEvents="ontouchstart"in window,mouseDetectionEnabled=!1,requestAnimationFrame=window.requestAnimationFrame||function(t){return setTimeout(t,1e3/60)},cancelAnimationFrame=window.cancelAnimationFrame||function(t){clearTimeout(t)},canAnimate=!!$.fn.animate;return $.SmartMenus=function(t,e){this.$root=$(t),this.opts=e,this.rootId="",this.accessIdPrefix="",this.$subArrow=null,this.activatedItems=[],this.visibleSubMenus=[],this.showTimeout=0,this.hideTimeout=0,this.scrollTimeout=0,this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.idInc=0,this.$firstLink=null,this.$firstSub=null,this.disabled=!1,this.$disableOverlay=null,this.$touchScrollingSub=null,this.cssTransforms3d="perspective"in t.style||"webkitPerspective"in t.style,this.wasCollapsible=!1,this.init()},$.extend($.SmartMenus,{hideAll:function(){$.each(menuTrees,function(){this.menuHideAll()})},destroy:function(){for(;menuTrees.length;)menuTrees[0].destroy();initMouseDetection(!0)},prototype:{init:function(t){var e=this;if(!t){menuTrees.push(this),this.rootId=((new Date).getTime()+Math.random()+"").replace(/\D/g,""),this.accessIdPrefix="sm-"+this.rootId+"-",this.$root.hasClass("sm-rtl")&&(this.opts.rightToLeftSubMenus=!0);var i=".smartmenus";this.$root.data("smartmenus",this).attr("data-smartmenus-id",this.rootId).dataSM("level",1).on(getEventsNS({"mouseover focusin":$.proxy(this.rootOver,this),"mouseout focusout":$.proxy(this.rootOut,this),keydown:$.proxy(this.rootKeyDown,this)},i)).on(getEventsNS({mouseenter:$.proxy(this.itemEnter,this),mouseleave:$.proxy(this.itemLeave,this),mousedown:$.proxy(this.itemDown,this),focus:$.proxy(this.itemFocus,this),blur:$.proxy(this.itemBlur,this),click:$.proxy(this.itemClick,this)},i),"a"),i+=this.rootId,this.opts.hideOnClick&&$(document).on(getEventsNS({touchstart:$.proxy(this.docTouchStart,this),touchmove:$.proxy(this.docTouchMove,this),touchend:$.proxy(this.docTouchEnd,this),click:$.proxy(this.docClick,this)},i)),$(window).on(getEventsNS({"resize orientationchange":$.proxy(this.winResize,this)},i)),this.opts.subIndicators&&(this.$subArrow=$("").addClass("sub-arrow"),this.opts.subIndicatorsText&&this.$subArrow.html(this.opts.subIndicatorsText)),initMouseDetection()}if(this.$firstSub=this.$root.find("ul").each(function(){e.menuInit($(this))}).eq(0),this.$firstLink=this.$root.find("a").eq(0),this.opts.markCurrentItem){var s=/(index|default)\.[^#\?\/]*/i,o=/#.*/,a=window.location.href.replace(s,""),n=a.replace(o,"");this.$root.find("a").each(function(){var t=this.href.replace(s,""),i=$(this);(t==a||t==n)&&(i.addClass("current"),e.opts.markCurrentTree&&i.parentsUntil("[data-smartmenus-id]","ul").each(function(){$(this).dataSM("parent-a").addClass("current")}))})}this.wasCollapsible=this.isCollapsible()},destroy:function(t){if(!t){var e=".smartmenus";this.$root.removeData("smartmenus").removeAttr("data-smartmenus-id").removeDataSM("level").off(e),e+=this.rootId,$(document).off(e),$(window).off(e),this.opts.subIndicators&&(this.$subArrow=null)}this.menuHideAll();var i=this;this.$root.find("ul").each(function(){var t=$(this);t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.dataSM("shown-before")&&((i.opts.subMenusMinWidth||i.opts.subMenusMaxWidth)&&t.css({width:"",minWidth:"",maxWidth:""}).removeClass("sm-nowrap"),t.dataSM("scroll-arrows")&&t.dataSM("scroll-arrows").remove(),t.css({zIndex:"",top:"",left:"",marginLeft:"",marginTop:"",display:""})),0==(t.attr("id")||"").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeDataSM("in-mega").removeDataSM("shown-before").removeDataSM("scroll-arrows").removeDataSM("parent-a").removeDataSM("level").removeDataSM("beforefirstshowfired").removeAttr("role").removeAttr("aria-hidden").removeAttr("aria-labelledby").removeAttr("aria-expanded"),this.$root.find("a.has-submenu").each(function(){var t=$(this);0==t.attr("id").indexOf(i.accessIdPrefix)&&t.removeAttr("id")}).removeClass("has-submenu").removeDataSM("sub").removeAttr("aria-haspopup").removeAttr("aria-controls").removeAttr("aria-expanded").closest("li").removeDataSM("sub"),this.opts.subIndicators&&this.$root.find("span.sub-arrow").remove(),this.opts.markCurrentItem&&this.$root.find("a.current").removeClass("current"),t||(this.$root=null,this.$firstLink=null,this.$firstSub=null,this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),menuTrees.splice($.inArray(this,menuTrees),1))},disable:function(t){if(!this.disabled){if(this.menuHideAll(),!t&&!this.opts.isPopup&&this.$root.is(":visible")){var e=this.$root.offset();this.$disableOverlay=$('
').css({position:"absolute",top:e.top,left:e.left,width:this.$root.outerWidth(),height:this.$root.outerHeight(),zIndex:this.getStartZIndex(!0),opacity:0}).appendTo(document.body)}this.disabled=!0}},docClick:function(t){return this.$touchScrollingSub?(this.$touchScrollingSub=null,void 0):((this.visibleSubMenus.length&&!$.contains(this.$root[0],t.target)||$(t.target).closest("a").length)&&this.menuHideAll(),void 0)},docTouchEnd:function(){if(this.lastTouch){if(!(!this.visibleSubMenus.length||void 0!==this.lastTouch.x2&&this.lastTouch.x1!=this.lastTouch.x2||void 0!==this.lastTouch.y2&&this.lastTouch.y1!=this.lastTouch.y2||this.lastTouch.target&&$.contains(this.$root[0],this.lastTouch.target))){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var t=this;this.hideTimeout=setTimeout(function(){t.menuHideAll()},350)}this.lastTouch=null}},docTouchMove:function(t){if(this.lastTouch){var e=t.originalEvent.touches[0];this.lastTouch.x2=e.pageX,this.lastTouch.y2=e.pageY}},docTouchStart:function(t){var e=t.originalEvent.touches[0];this.lastTouch={x1:e.pageX,y1:e.pageY,target:e.target}},enable:function(){this.disabled&&(this.$disableOverlay&&(this.$disableOverlay.remove(),this.$disableOverlay=null),this.disabled=!1)},getClosestMenu:function(t){for(var e=$(t).closest("ul");e.dataSM("in-mega");)e=e.parent().closest("ul");return e[0]||null},getHeight:function(t){return this.getOffset(t,!0)},getOffset:function(t,e){var i;"none"==t.css("display")&&(i={position:t[0].style.position,visibility:t[0].style.visibility},t.css({position:"absolute",visibility:"hidden"}).show());var s=t[0].getBoundingClientRect&&t[0].getBoundingClientRect(),o=s&&(e?s.height||s.bottom-s.top:s.width||s.right-s.left);return o||0===o||(o=e?t[0].offsetHeight:t[0].offsetWidth),i&&t.hide().css(i),o},getStartZIndex:function(t){var e=parseInt(this[t?"$root":"$firstSub"].css("z-index"));return!t&&isNaN(e)&&(e=parseInt(this.$root.css("z-index"))),isNaN(e)?1:e},getTouchPoint:function(t){return t.touches&&t.touches[0]||t.changedTouches&&t.changedTouches[0]||t},getViewport:function(t){var e=t?"Height":"Width",i=document.documentElement["client"+e],s=window["inner"+e];return s&&(i=Math.min(i,s)),i},getViewportHeight:function(){return this.getViewport(!0)},getViewportWidth:function(){return this.getViewport()},getWidth:function(t){return this.getOffset(t)},handleEvents:function(){return!this.disabled&&this.isCSSOn()},handleItemEvents:function(t){return this.handleEvents()&&!this.isLinkInMegaMenu(t)},isCollapsible:function(){return"static"==this.$firstSub.css("position")},isCSSOn:function(){return"inline"!=this.$firstLink.css("display")},isFixed:function(){var t="fixed"==this.$root.css("position");return t||this.$root.parentsUntil("body").each(function(){return"fixed"==$(this).css("position")?(t=!0,!1):void 0}),t},isLinkInMegaMenu:function(t){return $(this.getClosestMenu(t[0])).hasClass("mega-menu")},isTouchMode:function(){return!mouse||this.opts.noMouseOver||this.isCollapsible()},itemActivate:function(t,e){var i=t.closest("ul"),s=i.dataSM("level");if(s>1&&(!this.activatedItems[s-2]||this.activatedItems[s-2][0]!=i.dataSM("parent-a")[0])){var o=this;$(i.parentsUntil("[data-smartmenus-id]","ul").get().reverse()).add(i).each(function(){o.itemActivate($(this).dataSM("parent-a"))})}if((!this.isCollapsible()||e)&&this.menuHideSubMenus(this.activatedItems[s-1]&&this.activatedItems[s-1][0]==t[0]?s:s-1),this.activatedItems[s-1]=t,this.$root.triggerHandler("activate.smapi",t[0])!==!1){var a=t.dataSM("sub");a&&(this.isTouchMode()||!this.opts.showOnClick||this.clickActivated)&&this.menuShow(a)}},itemBlur:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&this.$root.triggerHandler("blur.smapi",e[0])},itemClick:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(this.$touchScrollingSub&&this.$touchScrollingSub[0]==e.closest("ul")[0])return this.$touchScrollingSub=null,t.stopPropagation(),!1;if(this.$root.triggerHandler("click.smapi",e[0])===!1)return!1;var i=$(t.target).is(".sub-arrow"),s=e.dataSM("sub"),o=s?2==s.dataSM("level"):!1,a=this.isCollapsible(),n=/toggle$/.test(this.opts.collapsibleBehavior),r=/link$/.test(this.opts.collapsibleBehavior),h=/^accordion/.test(this.opts.collapsibleBehavior);if(s&&!s.is(":visible")){if((!r||!a||i)&&(this.opts.showOnClick&&o&&(this.clickActivated=!0),this.itemActivate(e,h),s.is(":visible")))return this.focusActivated=!0,!1}else if(a&&(n||i))return this.itemActivate(e,h),this.menuHide(s),n&&(this.focusActivated=!1),!1;return this.opts.showOnClick&&o||e.hasClass("disabled")||this.$root.triggerHandler("select.smapi",e[0])===!1?!1:void 0}},itemDown:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&e.dataSM("mousedown",!0)},itemEnter:function(t){var e=$(t.currentTarget);if(this.handleItemEvents(e)){if(!this.isTouchMode()){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);var i=this;this.showTimeout=setTimeout(function(){i.itemActivate(e)},this.opts.showOnClick&&1==e.closest("ul").dataSM("level")?1:this.opts.showTimeout)}this.$root.triggerHandler("mouseenter.smapi",e[0])}},itemFocus:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(!this.focusActivated||this.isTouchMode()&&e.dataSM("mousedown")||this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0]==e[0]||this.itemActivate(e,!0),this.$root.triggerHandler("focus.smapi",e[0]))},itemLeave:function(t){var e=$(t.currentTarget);this.handleItemEvents(e)&&(this.isTouchMode()||(e[0].blur(),this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0)),e.removeDataSM("mousedown"),this.$root.triggerHandler("mouseleave.smapi",e[0]))},menuHide:function(t){if(this.$root.triggerHandler("beforehide.smapi",t[0])!==!1&&(canAnimate&&t.stop(!0,!0),"none"!=t.css("display"))){var e=function(){t.css("z-index","")};this.isCollapsible()?canAnimate&&this.opts.collapsibleHideFunction?this.opts.collapsibleHideFunction.call(this,t,e):t.hide(this.opts.collapsibleHideDuration,e):canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,t,e):t.hide(this.opts.hideDuration,e),t.dataSM("scroll")&&(this.menuScrollStop(t),t.css({"touch-action":"","-ms-touch-action":"","-webkit-transform":"",transform:""}).off(".smartmenus_scroll").removeDataSM("scroll").dataSM("scroll-arrows").hide()),t.dataSM("parent-a").removeClass("highlighted").attr("aria-expanded","false"),t.attr({"aria-expanded":"false","aria-hidden":"true"});var i=t.dataSM("level");this.activatedItems.splice(i-1,1),this.visibleSubMenus.splice($.inArray(t,this.visibleSubMenus),1),this.$root.triggerHandler("hide.smapi",t[0])}},menuHideAll:function(){this.showTimeout&&(clearTimeout(this.showTimeout),this.showTimeout=0);for(var t=this.opts.isPopup?1:0,e=this.visibleSubMenus.length-1;e>=t;e--)this.menuHide(this.visibleSubMenus[e]);this.opts.isPopup&&(canAnimate&&this.$root.stop(!0,!0),this.$root.is(":visible")&&(canAnimate&&this.opts.hideFunction?this.opts.hideFunction.call(this,this.$root):this.$root.hide(this.opts.hideDuration))),this.activatedItems=[],this.visibleSubMenus=[],this.clickActivated=!1,this.focusActivated=!1,this.zIndexInc=0,this.$root.triggerHandler("hideAll.smapi")},menuHideSubMenus:function(t){for(var e=this.activatedItems.length-1;e>=t;e--){var i=this.activatedItems[e].dataSM("sub");i&&this.menuHide(i)}},menuInit:function(t){if(!t.dataSM("in-mega")){t.hasClass("mega-menu")&&t.find("ul").dataSM("in-mega",!0);for(var e=2,i=t[0];(i=i.parentNode.parentNode)!=this.$root[0];)e++;var s=t.prevAll("a").eq(-1);s.length||(s=t.prevAll().find("a").eq(-1)),s.addClass("has-submenu").dataSM("sub",t),t.dataSM("parent-a",s).dataSM("level",e).parent().dataSM("sub",t);var o=s.attr("id")||this.accessIdPrefix+ ++this.idInc,a=t.attr("id")||this.accessIdPrefix+ ++this.idInc;s.attr({id:o,"aria-haspopup":"true","aria-controls":a,"aria-expanded":"false"}),t.attr({id:a,role:"group","aria-hidden":"true","aria-labelledby":o,"aria-expanded":"false"}),this.opts.subIndicators&&s[this.opts.subIndicatorsPos](this.$subArrow.clone())}},menuPosition:function(t){var e,i,s=t.dataSM("parent-a"),o=s.closest("li"),a=o.parent(),n=t.dataSM("level"),r=this.getWidth(t),h=this.getHeight(t),u=s.offset(),l=u.left,c=u.top,d=this.getWidth(s),m=this.getHeight(s),p=$(window),f=p.scrollLeft(),v=p.scrollTop(),b=this.getViewportWidth(),S=this.getViewportHeight(),g=a.parent().is("[data-sm-horizontal-sub]")||2==n&&!a.hasClass("sm-vertical"),M=this.opts.rightToLeftSubMenus&&!o.is("[data-sm-reverse]")||!this.opts.rightToLeftSubMenus&&o.is("[data-sm-reverse]"),w=2==n?this.opts.mainMenuSubOffsetX:this.opts.subMenusSubOffsetX,T=2==n?this.opts.mainMenuSubOffsetY:this.opts.subMenusSubOffsetY;if(g?(e=M?d-r-w:w,i=this.opts.bottomToTopSubMenus?-h-T:m+T):(e=M?w-r:d-w,i=this.opts.bottomToTopSubMenus?m-T-h:T),this.opts.keepInViewport){var y=l+e,I=c+i;if(M&&f>y?e=g?f-y+e:d-w:!M&&y+r>f+b&&(e=g?f+b-r-y+e:w-r),g||(S>h&&I+h>v+S?i+=v+S-h-I:(h>=S||v>I)&&(i+=v-I)),g&&(I+h>v+S+.49||v>I)||!g&&h>S+.49){var x=this;t.dataSM("scroll-arrows")||t.dataSM("scroll-arrows",$([$('')[0],$('')[0]]).on({mouseenter:function(){t.dataSM("scroll").up=$(this).hasClass("scroll-up"),x.menuScroll(t)},mouseleave:function(e){x.menuScrollStop(t),x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(t){t.preventDefault()}}).insertAfter(t));var A=".smartmenus_scroll";if(t.dataSM("scroll",{y:this.cssTransforms3d?0:i-m,step:1,itemH:m,subH:h,arrowDownH:this.getHeight(t.dataSM("scroll-arrows").eq(1))}).on(getEventsNS({mouseover:function(e){x.menuScrollOver(t,e)},mouseout:function(e){x.menuScrollOut(t,e)},"mousewheel DOMMouseScroll":function(e){x.menuScrollMousewheel(t,e)}},A)).dataSM("scroll-arrows").css({top:"auto",left:"0",marginLeft:e+(parseInt(t.css("border-left-width"))||0),width:r-(parseInt(t.css("border-left-width"))||0)-(parseInt(t.css("border-right-width"))||0),zIndex:t.css("z-index")}).eq(g&&this.opts.bottomToTopSubMenus?0:1).show(),this.isFixed()){var C={};C[touchEvents?"touchstart touchmove touchend":"pointerdown pointermove pointerup MSPointerDown MSPointerMove MSPointerUp"]=function(e){x.menuScrollTouch(t,e)},t.css({"touch-action":"none","-ms-touch-action":"none"}).on(getEventsNS(C,A))}}}t.css({top:"auto",left:"0",marginLeft:e,marginTop:i-m})},menuScroll:function(t,e,i){var s,o=t.dataSM("scroll"),a=t.dataSM("scroll-arrows"),n=o.up?o.upEnd:o.downEnd;if(!e&&o.momentum){if(o.momentum*=.92,s=o.momentum,.5>s)return this.menuScrollStop(t),void 0}else s=i||(e||!this.opts.scrollAccelerate?this.opts.scrollStep:Math.floor(o.step));var r=t.dataSM("level");if(this.activatedItems[r-1]&&this.activatedItems[r-1].dataSM("sub")&&this.activatedItems[r-1].dataSM("sub").is(":visible")&&this.menuHideSubMenus(r-1),o.y=o.up&&o.y>=n||!o.up&&n>=o.y?o.y:Math.abs(n-o.y)>s?o.y+(o.up?s:-s):n,t.css(this.cssTransforms3d?{"-webkit-transform":"translate3d(0, "+o.y+"px, 0)",transform:"translate3d(0, "+o.y+"px, 0)"}:{marginTop:o.y}),mouse&&(o.up&&o.y>o.downEnd||!o.up&&o.y0;t.dataSM("scroll-arrows").eq(i?0:1).is(":visible")&&(t.dataSM("scroll").up=i,this.menuScroll(t,!0))}e.preventDefault()},menuScrollOut:function(t,e){mouse&&(/^scroll-(up|down)/.test((e.relatedTarget||"").className)||(t[0]==e.relatedTarget||$.contains(t[0],e.relatedTarget))&&this.getClosestMenu(e.relatedTarget)==t[0]||t.dataSM("scroll-arrows").css("visibility","hidden"))},menuScrollOver:function(t,e){if(mouse&&!/^scroll-(up|down)/.test(e.target.className)&&this.getClosestMenu(e.target)==t[0]){this.menuScrollRefreshData(t);var i=t.dataSM("scroll"),s=$(window).scrollTop()-t.dataSM("parent-a").offset().top-i.itemH;t.dataSM("scroll-arrows").eq(0).css("margin-top",s).end().eq(1).css("margin-top",s+this.getViewportHeight()-i.arrowDownH).end().css("visibility","visible")}},menuScrollRefreshData:function(t){var e=t.dataSM("scroll"),i=$(window).scrollTop()-t.dataSM("parent-a").offset().top-e.itemH;this.cssTransforms3d&&(i=-(parseFloat(t.css("margin-top"))-i)),$.extend(e,{upEnd:i,downEnd:i+this.getViewportHeight()-e.subH})},menuScrollStop:function(t){return this.scrollTimeout?(cancelAnimationFrame(this.scrollTimeout),this.scrollTimeout=0,t.dataSM("scroll").step=1,!0):void 0},menuScrollTouch:function(t,e){if(e=e.originalEvent,isTouchEvent(e)){var i=this.getTouchPoint(e);if(this.getClosestMenu(i.target)==t[0]){var s=t.dataSM("scroll");if(/(start|down)$/i.test(e.type))this.menuScrollStop(t)?(e.preventDefault(),this.$touchScrollingSub=t):this.$touchScrollingSub=null,this.menuScrollRefreshData(t),$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp});else if(/move$/i.test(e.type)){var o=void 0!==s.touchY?s.touchY:s.touchStartY;if(void 0!==o&&o!=i.pageY){this.$touchScrollingSub=t;var a=i.pageY>o;void 0!==s.up&&s.up!=a&&$.extend(s,{touchStartY:i.pageY,touchStartTime:e.timeStamp}),$.extend(s,{up:a,touchY:i.pageY}),this.menuScroll(t,!0,Math.abs(i.pageY-o))}e.preventDefault()}else void 0!==s.touchY&&((s.momentum=15*Math.pow(Math.abs(i.pageY-s.touchStartY)/(e.timeStamp-s.touchStartTime),2))&&(this.menuScrollStop(t),this.menuScroll(t),e.preventDefault()),delete s.touchY)}}},menuShow:function(t){if((t.dataSM("beforefirstshowfired")||(t.dataSM("beforefirstshowfired",!0),this.$root.triggerHandler("beforefirstshow.smapi",t[0])!==!1))&&this.$root.triggerHandler("beforeshow.smapi",t[0])!==!1&&(t.dataSM("shown-before",!0),canAnimate&&t.stop(!0,!0),!t.is(":visible"))){var e=t.dataSM("parent-a"),i=this.isCollapsible();if((this.opts.keepHighlighted||i)&&e.addClass("highlighted"),i)t.removeClass("sm-nowrap").css({zIndex:"",width:"auto",minWidth:"",maxWidth:"",top:"",left:"",marginLeft:"",marginTop:""});else{if(t.css("z-index",this.zIndexInc=(this.zIndexInc||this.getStartZIndex())+1),(this.opts.subMenusMinWidth||this.opts.subMenusMaxWidth)&&(t.css({width:"auto",minWidth:"",maxWidth:""}).addClass("sm-nowrap"),this.opts.subMenusMinWidth&&t.css("min-width",this.opts.subMenusMinWidth),this.opts.subMenusMaxWidth)){var s=this.getWidth(t);t.css("max-width",this.opts.subMenusMaxWidth),s>this.getWidth(t)&&t.removeClass("sm-nowrap").css("width",this.opts.subMenusMaxWidth)}this.menuPosition(t)}var o=function(){t.css("overflow","")};i?canAnimate&&this.opts.collapsibleShowFunction?this.opts.collapsibleShowFunction.call(this,t,o):t.show(this.opts.collapsibleShowDuration,o):canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,t,o):t.show(this.opts.showDuration,o),e.attr("aria-expanded","true"),t.attr({"aria-expanded":"true","aria-hidden":"false"}),this.visibleSubMenus.push(t),this.$root.triggerHandler("show.smapi",t[0])}},popupHide:function(t){this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0);var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},t?1:this.opts.hideTimeout)},popupShow:function(t,e){if(!this.opts.isPopup)return alert('SmartMenus jQuery Error:\n\nIf you want to show this menu via the "popupShow" method, set the isPopup:true option.'),void 0;if(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),this.$root.dataSM("shown-before",!0),canAnimate&&this.$root.stop(!0,!0),!this.$root.is(":visible")){this.$root.css({left:t,top:e});var i=this,s=function(){i.$root.css("overflow","")};canAnimate&&this.opts.showFunction?this.opts.showFunction.call(this,this.$root,s):this.$root.show(this.opts.showDuration,s),this.visibleSubMenus[0]=this.$root}},refresh:function(){this.destroy(!0),this.init(!0)},rootKeyDown:function(t){if(this.handleEvents())switch(t.keyCode){case 27:var e=this.activatedItems[0];if(e){this.menuHideAll(),e[0].focus();var i=e.dataSM("sub");i&&this.menuHide(i)}break;case 32:var s=$(t.target);if(s.is("a")&&this.handleItemEvents(s)){var i=s.dataSM("sub");i&&!i.is(":visible")&&(this.itemClick({currentTarget:t.target}),t.preventDefault())}}},rootOut:function(t){if(this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&(this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0),!this.opts.showOnClick||!this.opts.hideOnClick)){var e=this;this.hideTimeout=setTimeout(function(){e.menuHideAll()},this.opts.hideTimeout)}},rootOver:function(t){this.handleEvents()&&!this.isTouchMode()&&t.target!=this.$root[0]&&this.hideTimeout&&(clearTimeout(this.hideTimeout),this.hideTimeout=0)},winResize:function(t){if(this.handleEvents()){if(!("onorientationchange"in window)||"orientationchange"==t.type){var e=this.isCollapsible();this.wasCollapsible&&e||(this.activatedItems.length&&this.activatedItems[this.activatedItems.length-1][0].blur(),this.menuHideAll()),this.wasCollapsible=e}}else if(this.$disableOverlay){var i=this.$root.offset();this.$disableOverlay.css({top:i.top,left:i.left,width:this.$root.outerWidth(),height:this.$root.outerHeight()})}}}}),$.fn.dataSM=function(t,e){return e?this.data(t+"_smartmenus",e):this.data(t+"_smartmenus")},$.fn.removeDataSM=function(t){return this.removeData(t+"_smartmenus")},$.fn.smartmenus=function(options){if("string"==typeof options){var args=arguments,method=options;return Array.prototype.shift.call(args),this.each(function(){var t=$(this).data("smartmenus");t&&t[method]&&t[method].apply(t,args)})}return this.each(function(){var dataOpts=$(this).data("sm-options")||null;if(dataOpts)try{dataOpts=eval("("+dataOpts+")")}catch(e){dataOpts=null,alert('ERROR\n\nSmartMenus jQuery init:\nInvalid "data-sm-options" attribute value syntax.')}new $.SmartMenus(this,$.extend({},$.fn.smartmenus.defaults,options,dataOpts))})},$.fn.smartmenus.defaults={isPopup:!1,mainMenuSubOffsetX:0,mainMenuSubOffsetY:0,subMenusSubOffsetX:0,subMenusSubOffsetY:0,subMenusMinWidth:"10em",subMenusMaxWidth:"20em",subIndicators:!0,subIndicatorsPos:"append",subIndicatorsText:"",scrollStep:30,scrollAccelerate:!0,showTimeout:250,hideTimeout:500,showDuration:0,showFunction:null,hideDuration:0,hideFunction:function(t,e){t.fadeOut(200,e)},collapsibleShowDuration:0,collapsibleShowFunction:function(t,e){t.slideDown(200,e)},collapsibleHideDuration:0,collapsibleHideFunction:function(t,e){t.slideUp(200,e)},showOnClick:!1,hideOnClick:!0,noMouseOver:!1,keepInViewport:!0,keepHighlighted:!0,markCurrentItem:!1,markCurrentTree:!0,rightToLeftSubMenus:!1,bottomToTopSubMenus:!1,collapsibleBehavior:"default"},$}); \ No newline at end of file diff --git a/deps/glfw-3.3.8/docs/html/main_8dox.html b/deps/glfw-3.3.8/docs/html/main_8dox.html new file mode 100644 index 0000000..9a4c58b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/main_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: main.dox File Reference + + + + + + + + + + +
+ + + + + + + + + +
+
+ + +
+ +
+ +
+
+
main.dox File Reference
+
+
+
+
+

+Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

+
+ + diff --git a/deps/glfw-3.3.8/docs/html/menu.js b/deps/glfw-3.3.8/docs/html/menu.js new file mode 100644 index 0000000..818b859 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/menu.js @@ -0,0 +1,135 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function initMenu(relPath,searchEnabled,serverSide,searchPage,search) { + function makeTree(data,relPath) { + var result=''; + if ('children' in data) { + result+='
    '; + for (var i in data.children) { + var url; + var link; + link = data.children[i].url; + if (link.substring(0,1)=='^') { + url = link.substring(1); + } else { + url = relPath+link; + } + result+='
  • '+ + data.children[i].text+''+ + makeTree(data.children[i],relPath)+'
    • '; + } + result+='
'; + } + return result; + } + var searchBox; + if (searchEnabled) { + if (serverSide) { + searchBox='
'+ + '
'+ + '
'+ + ''+ + '
'+ + '
'+ + '
'+ + '
'; + } else { + searchBox='
'+ + ''+ + ''+ + ''+ + ''+ + ''+ + '' + '' + '
'; + } + } + + $('#main-nav').before('
'+ + ''+ + ''+ + '
'); + $('#main-nav').append(makeTree(menudata,relPath)); + $('#main-nav').children(':first').addClass('sm sm-dox').attr('id','main-menu'); + if (searchBox) { + $('#main-menu').append('
  • '); + } + var $mainMenuState = $('#main-menu-state'); + var prevWidth = 0; + if ($mainMenuState.length) { + function initResizableIfExists() { + if (typeof initResizable==='function') initResizable(); + } + // animate mobile menu + $mainMenuState.change(function(e) { + var $menu = $('#main-menu'); + var options = { duration: 250, step: initResizableIfExists }; + if (this.checked) { + options['complete'] = function() { $menu.css('display', 'block') }; + $menu.hide().slideDown(options); + } else { + options['complete'] = function() { $menu.css('display', 'none') }; + $menu.show().slideUp(options); + } + }); + // set default menu visibility + function resetState() { + var $menu = $('#main-menu'); + var $mainMenuState = $('#main-menu-state'); + var newWidth = $(window).outerWidth(); + if (newWidth!=prevWidth) { + if ($(window).outerWidth()<768) { + $mainMenuState.prop('checked',false); $menu.hide(); + $('#searchBoxPos1').html(searchBox); + $('#searchBoxPos2').hide(); + } else { + $menu.show(); + $('#searchBoxPos1').empty(); + $('#searchBoxPos2').html(searchBox); + $('#searchBoxPos2').show(); + } + prevWidth = newWidth; + } + } + $(window).ready(function() { resetState(); initResizableIfExists(); }); + $(window).resize(resetState); + } + $('#main-menu').smartmenus(); +} +/* @license-end */ diff --git a/deps/glfw-3.3.8/docs/html/menudata.js b/deps/glfw-3.3.8/docs/html/menudata.js new file mode 100644 index 0000000..082dbe1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/menudata.js @@ -0,0 +1,30 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file +*/ +var menudata={children:[ +{text:"Introduction",url:"index.html"}, +{text:"Tutorial",url:"quick_guide.html"}, +{text:"Guides",url:"pages.html"}, +{text:"Reference",url:"modules.html"}, +{text:"Files",url:"files.html"}]} diff --git a/deps/glfw-3.3.8/docs/html/modules.html b/deps/glfw-3.3.8/docs/html/modules.html new file mode 100644 index 0000000..1ef55b0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/modules.html @@ -0,0 +1,94 @@ + + + + + + + +GLFW: Reference + + + + + + + + + + +
    + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Reference
    +
    +
    +
    Here is a list of all modules:
    +
    [detail level 12]
    + + + + + + + + + + + + + + + + +
     Context referenceFunctions and types related to OpenGL and OpenGL ES contexts
     ▼Initialization, version and error referenceFunctions and types related to initialization and error handling
     Error codesError codes
     ▼Input referenceFunctions and types related to input handling
     Gamepad axesGamepad axes
     Gamepad buttonsGamepad buttons
     Joystick hat statesJoystick hat states
     JoysticksJoystick IDs
     Keyboard keysKeyboard key IDs
     Modifier key flagsModifier key flags
     Mouse buttonsMouse button IDs
     Standard cursor shapesStandard system cursor shapes
     Monitor referenceFunctions and types related to monitors
     Native accessFunctions related to accessing native handles
     Vulkan support referenceFunctions and types related to Vulkan
     Window referenceFunctions and types related to windows
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/monitor_8dox.html b/deps/glfw-3.3.8/docs/html/monitor_8dox.html new file mode 100644 index 0000000..82aff6b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/monitor_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: monitor.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    monitor.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/monitor_guide.html b/deps/glfw-3.3.8/docs/html/monitor_guide.html new file mode 100644 index 0000000..76f47a5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/monitor_guide.html @@ -0,0 +1,222 @@ + + + + + + + +GLFW: Monitor guide + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Monitor guide
    +
    +
    +

    Table of Contents

    + +
    +

    This guide introduces the monitor related functions of GLFW. For details on a specific function in this category, see the Monitor reference. There are also guides for the other areas of GLFW.

    + +

    +Monitor objects

    +

    A monitor object represents a currently connected monitor and is represented as a pointer to the opaque type GLFWmonitor. Monitor objects cannot be created or destroyed by the application and retain their addresses until the monitors they represent are disconnected or until the library is terminated.

    +

    Each monitor has a current video mode, a list of supported video modes, a virtual position, a human-readable name, an estimated physical size and a gamma ramp. One of the monitors is the primary monitor.

    +

    The virtual position of a monitor is in screen coordinates and, together with the current video mode, describes the viewports that the connected monitors provide into the virtual desktop that spans them.

    +

    To see how GLFW views your monitor setup and its available video modes, run the monitors test program.

    +

    +Retrieving monitors

    +

    The primary monitor is returned by glfwGetPrimaryMonitor. It is the user's preferred monitor and is usually the one with global UI elements like task bar or menu bar.

    +
    GLFWmonitor* primary = glfwGetPrimaryMonitor();
    +
    GLFWmonitor
    struct GLFWmonitor GLFWmonitor
    Opaque monitor object.
    Definition: glfw3.h:1173
    +
    glfwGetPrimaryMonitor
    GLFWmonitor * glfwGetPrimaryMonitor(void)
    Returns the primary monitor.
    +

    You can retrieve all currently connected monitors with glfwGetMonitors. See the reference documentation for the lifetime of the returned array.

    +
    int count;
    +
    GLFWmonitor** monitors = glfwGetMonitors(&count);
    +
    glfwGetMonitors
    GLFWmonitor ** glfwGetMonitors(int *count)
    Returns the currently connected monitors.
    +

    The primary monitor is always the first monitor in the returned array, but other monitors may be moved to a different index when a monitor is connected or disconnected.

    +

    +Monitor configuration changes

    +

    If you wish to be notified when a monitor is connected or disconnected, set a monitor callback.

    +
    glfwSetMonitorCallback(monitor_callback);
    +
    glfwSetMonitorCallback
    GLFWmonitorfun glfwSetMonitorCallback(GLFWmonitorfun callback)
    Sets the monitor configuration callback.
    +

    The callback function receives the handle for the monitor that has been connected or disconnected and the event that occurred.

    +
    void monitor_callback(GLFWmonitor* monitor, int event)
    +
    {
    +
    if (event == GLFW_CONNECTED)
    +
    {
    +
    // The monitor was connected
    +
    }
    +
    else if (event == GLFW_DISCONNECTED)
    +
    {
    +
    // The monitor was disconnected
    +
    }
    +
    }
    +
    GLFW_DISCONNECTED
    #define GLFW_DISCONNECTED
    Definition: glfw3.h:1107
    +
    GLFW_CONNECTED
    #define GLFW_CONNECTED
    Definition: glfw3.h:1106
    +

    If a monitor is disconnected, all windows that are full screen on it will be switched to windowed mode before the callback is called. Only glfwGetMonitorName and glfwGetMonitorUserPointer will return useful values for a disconnected monitor and only before the monitor callback returns.

    +

    +Monitor properties

    +

    Each monitor has a current video mode, a list of supported video modes, a virtual position, a content scale, a human-readable name, a user pointer, an estimated physical size and a gamma ramp.

    +

    +Video modes

    +

    GLFW generally does a good job selecting a suitable video mode when you create a full screen window, change its video mode or make a windowed one full screen, but it is sometimes useful to know exactly which video modes are supported.

    +

    Video modes are represented as GLFWvidmode structures. You can get an array of the video modes supported by a monitor with glfwGetVideoModes. See the reference documentation for the lifetime of the returned array.

    +
    int count;
    +
    GLFWvidmode* modes = glfwGetVideoModes(monitor, &count);
    +
    glfwGetVideoModes
    const GLFWvidmode * glfwGetVideoModes(GLFWmonitor *monitor, int *count)
    Returns the available video modes for the specified monitor.
    +
    GLFWvidmode
    Video mode type.
    Definition: glfw3.h:1658
    +

    To get the current video mode of a monitor call glfwGetVideoMode. See the reference documentation for the lifetime of the returned pointer.

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

    The resolution of a video mode is specified in screen coordinates, not pixels.

    +

    +Physical size

    +

    The physical size of a monitor in millimetres, or an estimation of it, can be retrieved with glfwGetMonitorPhysicalSize. This has no relation to its current resolution, i.e. the width and height of its current video mode.

    +
    int width_mm, height_mm;
    +
    glfwGetMonitorPhysicalSize(monitor, &width_mm, &height_mm);
    +
    glfwGetMonitorPhysicalSize
    void glfwGetMonitorPhysicalSize(GLFWmonitor *monitor, int *widthMM, int *heightMM)
    Returns the physical size of the monitor.
    +

    While this can be used to calculate the raw DPI of a monitor, this is often not useful. Instead use the monitor content scale and window content scale to scale your content.

    +

    +Content scale

    +

    The content scale for a monitor can be retrieved with glfwGetMonitorContentScale.

    +
    float xscale, yscale;
    +
    glfwGetMonitorContentScale(monitor, &xscale, &yscale);
    +
    glfwGetMonitorContentScale
    void glfwGetMonitorContentScale(GLFWmonitor *monitor, float *xscale, float *yscale)
    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.

    +

    +Virtual position

    +

    The position of the monitor on the virtual desktop, in screen coordinates, can be retrieved with glfwGetMonitorPos.

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

    +Work area

    +

    The area of a monitor not occupied by global task bars or menu bars is the work area. This is specified in screen coordinates and can be retrieved with glfwGetMonitorWorkarea.

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

    +Human-readable name

    +

    The human-readable, UTF-8 encoded name of a monitor is returned by glfwGetMonitorName. See the reference documentation for the lifetime of the returned string.

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

    Monitor names are not guaranteed to be unique. Two monitors of the same model and make may have the same name. Only the monitor handle is guaranteed to be unique, and only until that monitor is disconnected.

    +

    +User pointer

    +

    Each monitor has a user pointer that can be set with glfwSetMonitorUserPointer and queried with glfwGetMonitorUserPointer. This can be used for any purpose you need and will not be modified by GLFW. The value will be kept until the monitor is disconnected or until the library is terminated.

    +

    The initial value of the pointer is NULL.

    +

    +Gamma ramp

    +

    The gamma ramp of a monitor can be set with glfwSetGammaRamp, which accepts a monitor handle and a pointer to a GLFWgammaramp structure.

    +
    GLFWgammaramp ramp;
    +
    unsigned short red[256], green[256], blue[256];
    +
    +
    ramp.size = 256;
    +
    ramp.red = red;
    +
    ramp.green = green;
    +
    ramp.blue = blue;
    +
    +
    for (i = 0; i < ramp.size; i++)
    +
    {
    +
    // Fill out gamma ramp arrays as desired
    +
    }
    +
    +
    glfwSetGammaRamp(monitor, &ramp);
    +
    glfwSetGammaRamp
    void glfwSetGammaRamp(GLFWmonitor *monitor, const GLFWgammaramp *ramp)
    Sets the current gamma ramp for the specified monitor.
    +
    GLFWgammaramp
    Gamma ramp.
    Definition: glfw3.h:1692
    +
    GLFWgammaramp::red
    unsigned short * red
    Definition: glfw3.h:1695
    +
    GLFWgammaramp::blue
    unsigned short * blue
    Definition: glfw3.h:1701
    +
    GLFWgammaramp::size
    unsigned int size
    Definition: glfw3.h:1704
    +
    GLFWgammaramp::green
    unsigned short * green
    Definition: glfw3.h:1698
    +

    The gamma ramp data is copied before the function returns, so there is no need to keep it around once the ramp has been set.

    +

    It is recommended that your gamma ramp have the same size as the current gamma ramp for that monitor.

    +

    The current gamma ramp for a monitor is returned by glfwGetGammaRamp. See the reference documentation for the lifetime of the returned structure.

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

    If you wish to set a regular gamma ramp, you can have GLFW calculate it for you from the desired exponent with glfwSetGamma, which in turn calls glfwSetGammaRamp with the resulting ramp.

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

    To experiment with gamma correction via the glfwSetGamma function, run the gamma test program.

    +
    Note
    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.
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/moving_8dox.html b/deps/glfw-3.3.8/docs/html/moving_8dox.html new file mode 100644 index 0000000..4d3a225 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/moving_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: moving.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    moving.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/moving_guide.html b/deps/glfw-3.3.8/docs/html/moving_guide.html new file mode 100644 index 0000000..d8b1a2b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/moving_guide.html @@ -0,0 +1,367 @@ + + + + + + + +GLFW: Moving from GLFW 2 to 3 + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Moving from GLFW 2 to 3
    +
    +
    +

    Table of Contents

    + +
    +

    This is a transition guide for moving from GLFW 2 to 3. It describes what has changed or been removed, but does not include new features unless they are required when moving an existing code base onto the new API. For example, the new multi-monitor functions are required to create full screen windows with GLFW 3.

    +

    +Changed and removed features

    +

    +Renamed library and header file

    +

    The GLFW 3 header is named glfw3.h and moved to the GLFW directory, to avoid collisions with the headers of other major versions. Similarly, the GLFW 3 library is named glfw3, except when it's installed as a shared library on Unix-like systems, where it uses the soname libglfw.so.3.

    +
    Old syntax
    #include <GL/glfw.h>
    +
    +
    New syntax
    #include <GLFW/glfw3.h>
    +
    glfw3.h
    The header of the GLFW 3 API.
    +
    +

    +Removal of threading functions

    +

    The threading functions have been removed, including the per-thread sleep function. They were fairly primitive, under-used, poorly integrated and took time away from the focus of GLFW (i.e. context, input and window). There are better threading libraries available and native threading support is available in both C++11 and C11, both of which are gaining traction.

    +

    If you wish to use the C++11 or C11 facilities but your compiler doesn't yet support them, see the TinyThread++ and TinyCThread projects created by the original author of GLFW. These libraries implement a usable subset of the threading APIs in C++11 and C11, and in fact some GLFW 3 test programs use TinyCThread.

    +

    However, GLFW 3 has better support for use from multiple threads than GLFW 2 had. Contexts can be made current on any thread, although only a single thread at a time, and the documentation explicitly states which functions may be used from any thread and which must only be used from the main thread.

    +
    Removed functions
    glfwSleep, glfwCreateThread, glfwDestroyThread, glfwWaitThread, glfwGetThreadID, glfwCreateMutex, glfwDestroyMutex, glfwLockMutex, glfwUnlockMutex, glfwCreateCond, glfwDestroyCond, glfwWaitCond, glfwSignalCond, glfwBroadcastCond and glfwGetNumberOfProcessors.
    +
    Removed types
    GLFWthreadfun
    +

    +Removal of image and texture loading

    +

    The image and texture loading functions have been removed. They only supported the Targa image format, making them mostly useful for beginner level examples. To become of sufficiently high quality to warrant keeping them in GLFW 3, they would need not only to support other formats, but also modern extensions to OpenGL texturing. This would either add a number of external dependencies (libjpeg, libpng, etc.), or force GLFW to ship with inline versions of these libraries.

    +

    As there already are libraries doing this, it is unnecessary both to duplicate the work and to tie the duplicate to GLFW. The resulting library would also be platform-independent, as both OpenGL and stdio are available wherever GLFW is.

    +
    Removed functions
    glfwReadImage, glfwReadMemoryImage, glfwFreeImage, glfwLoadTexture2D, glfwLoadMemoryTexture2D and glfwLoadTextureImage2D.
    +

    +Removal of GLFWCALL macro

    +

    The GLFWCALL macro, which made callback functions use __stdcall on Windows, has been removed. GLFW is written in C, not Pascal. Removing this macro means there's one less thing for application programmers to remember, i.e. the requirement to mark all callback functions with GLFWCALL. It also simplifies the creation of DLLs and DLL link libraries, as there's no need to explicitly disable @n entry point suffixes.

    +
    Old syntax
    void GLFWCALL callback_function(...);
    +
    +
    New syntax
    void callback_function(...);
    +
    +

    +Window handle parameters

    +

    Because GLFW 3 supports multiple windows, window handle parameters have been added to all window-related GLFW functions and callbacks. The handle of a newly created window is returned by glfwCreateWindow (formerly glfwOpenWindow). Window handles are pointers to the opaque type GLFWwindow.

    +
    Old syntax
    glfwSetWindowTitle("New Window Title");
    +
    glfwSetWindowTitle
    void glfwSetWindowTitle(GLFWwindow *window, const char *title)
    Sets the title of the specified window.
    +
    +
    New syntax
    glfwSetWindowTitle(window, "New Window Title");
    +
    +

    +Explicit monitor selection

    +

    GLFW 3 provides support for multiple monitors. To request a full screen mode window, instead of passing GLFW_FULLSCREEN you specify which monitor you wish the window to use. The glfwGetPrimaryMonitor function returns the monitor that GLFW 2 would have selected, but there are many other monitor functions. Monitor handles are pointers to the opaque type GLFWmonitor.

    +
    Old basic full screen
    glfwOpenWindow(640, 480, 8, 8, 8, 0, 24, 0, GLFW_FULLSCREEN);
    +
    +
    New basic full screen
    window = glfwCreateWindow(640, 480, "My Window", glfwGetPrimaryMonitor(), NULL);
    +
    glfwGetPrimaryMonitor
    GLFWmonitor * glfwGetPrimaryMonitor(void)
    Returns the primary monitor.
    +
    glfwCreateWindow
    GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
    Creates a window and its associated context.
    +
    +
    Note
    The framebuffer bit depth parameters of glfwOpenWindow have been turned into window hints, but as they have been given sane defaults you rarely need to set these hints.
    +

    +Removal of automatic event polling

    +

    GLFW 3 does not automatically poll for events in glfwSwapBuffers, meaning you need to call glfwPollEvents or glfwWaitEvents yourself. Unlike buffer swap, which acts on a single window, the event processing functions act on all windows at once.

    +
    Old basic main loop
    while (...)
    +
    {
    +
    // Process input
    +
    // Render output
    +
    glfwSwapBuffers();
    +
    }
    +
    glfwSwapBuffers
    void glfwSwapBuffers(GLFWwindow *window)
    Swaps the front and back buffers of the specified window.
    +
    +
    New basic main loop
    while (...)
    +
    {
    +
    // Process input
    +
    // Render output
    +
    glfwSwapBuffers(window);
    +
    glfwPollEvents();
    +
    }
    +
    glfwPollEvents
    void glfwPollEvents(void)
    Processes all pending events.
    +
    +

    +Explicit context management

    +

    Each GLFW 3 window has its own OpenGL context and only you, the application programmer, can know which context should be current on which thread at any given time. Therefore, GLFW 3 leaves that decision to you.

    +

    This means that you need to call glfwMakeContextCurrent after creating a window before you can call any OpenGL functions.

    +

    +Separation of window and framebuffer sizes

    +

    Window positions and sizes now use screen coordinates, which may not be the same as pixels on machines with high-DPI monitors. This is important as OpenGL uses pixels, not screen coordinates. For example, the rectangle specified with glViewport needs to use pixels. Therefore, framebuffer size functions have been added. You can retrieve the size of the framebuffer of a window with glfwGetFramebufferSize function. A framebuffer size callback has also been added, which can be set with glfwSetFramebufferSizeCallback.

    +
    Old basic viewport setup
    glfwGetWindowSize(&width, &height);
    +
    glViewport(0, 0, width, height);
    +
    glfwGetWindowSize
    void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)
    Retrieves the size of the content area of the specified window.
    +
    +
    New basic viewport setup
    glfwGetFramebufferSize(window, &width, &height);
    +
    glViewport(0, 0, width, height);
    +
    glfwGetFramebufferSize
    void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
    Retrieves the size of the framebuffer of the specified window.
    +
    +

    +Window closing changes

    +

    The GLFW_OPENED window parameter has been removed. As long as the window has not been destroyed, whether through glfwDestroyWindow or glfwTerminate, the window is "open".

    +

    A user attempting to close a window is now just an event like any other. Unlike GLFW 2, windows and contexts created with GLFW 3 will never be destroyed unless you choose them to be. Each window now has a close flag that is set to GLFW_TRUE when the user attempts to close that window. By default, nothing else happens and the window stays visible. It is then up to you to either destroy the window, take some other action or ignore the request.

    +

    You can query the close flag at any time with glfwWindowShouldClose and set it at any time with glfwSetWindowShouldClose.

    +
    Old basic main loop
    while (glfwGetWindowParam(GLFW_OPENED))
    +
    {
    +
    ...
    +
    }
    +
    +
    New basic main loop
    while (!glfwWindowShouldClose(window))
    +
    {
    +
    ...
    +
    }
    +
    glfwWindowShouldClose
    int glfwWindowShouldClose(GLFWwindow *window)
    Checks the close flag of the specified window.
    +
    +

    The close callback no longer returns a value. Instead, it is called after the close flag has been set so it can override its value, if it chooses to, before event processing completes. You may however not call glfwDestroyWindow from the close callback (or any other window related callback).

    +
    Old syntax
    int GLFWCALL window_close_callback(void);
    +
    +
    New syntax
    void window_close_callback(GLFWwindow* window);
    +
    GLFWwindow
    struct GLFWwindow GLFWwindow
    Opaque window object.
    Definition: glfw3.h:1185
    +
    +
    Note
    GLFW never clears the close flag to GLFW_FALSE, meaning you can use it for other reasons to close the window as well, for example the user choosing Quit from an in-game menu.
    +

    +Persistent window hints

    +

    The glfwOpenWindowHint function has been renamed to glfwWindowHint.

    +

    Window hints are no longer reset to their default values on window creation, but instead retain their values until modified by glfwWindowHint or glfwDefaultWindowHints, or until the library is terminated and re-initialized.

    +

    +Video mode enumeration

    +

    Video mode enumeration is now per-monitor. The glfwGetVideoModes function now returns all available modes for a specific monitor instead of requiring you to guess how large an array you need. The glfwGetDesktopMode function, which had poorly defined behavior, has been replaced by glfwGetVideoMode, which returns the current mode of a monitor.

    +

    +Removal of character actions

    +

    The action parameter of the character callback has been removed. This was an artefact of the origin of GLFW, i.e. being developed in English by a Swede. However, many keyboard layouts require more than one key to produce characters with diacritical marks. Even the Swedish keyboard layout requires this for uncommon cases like ü.

    +
    Old syntax
    void GLFWCALL character_callback(int character, int action);
    +
    +
    New syntax
    void character_callback(GLFWwindow* window, int character);
    +
    +

    +Cursor position changes

    +

    The glfwGetMousePos function has been renamed to glfwGetCursorPos, glfwSetMousePos to glfwSetCursorPos and glfwSetMousePosCallback to glfwSetCursorPosCallback.

    +

    The cursor position is now double instead of int, both for the direct functions and for the callback. Some platforms can provide sub-pixel cursor movement and this data is now passed on to the application where available. On platforms where this is not provided, the decimal part is zero.

    +

    GLFW 3 only allows you to position the cursor within a window using glfwSetCursorPos (formerly glfwSetMousePos) when that window is active. Unless the window is active, the function fails silently.

    +

    +Wheel position replaced by scroll offsets

    +

    The glfwGetMouseWheel function has been removed. Scrolling is the input of offsets and has no absolute position. The mouse wheel callback has been replaced by a scroll callback that receives two-dimensional floating point scroll offsets. This allows you to receive precise scroll data from for example modern touchpads.

    +
    Old syntax
    void GLFWCALL mouse_wheel_callback(int position);
    +
    +
    New syntax
    void scroll_callback(GLFWwindow* window, double xoffset, double yoffset);
    +
    +
    Removed functions
    glfwGetMouseWheel
    +

    +Key repeat action

    +

    The GLFW_KEY_REPEAT enable has been removed and key repeat is always enabled for both keys and characters. A new key action, GLFW_REPEAT, has been added to allow the key callback to distinguish an initial key press from a repeat. Note that glfwGetKey still returns only GLFW_PRESS or GLFW_RELEASE.

    +

    +Physical key input

    +

    GLFW 3 key tokens map to physical keys, unlike in GLFW 2 where they mapped to the values generated by the current keyboard layout. The tokens are named according to the values they would have using the standard US layout, but this is only a convenience, as most programmers are assumed to know that layout. This means that (for example) GLFW_KEY_LEFT_BRACKET is always a single key and is the same key in the same place regardless of what keyboard layouts the users of your program has.

    +

    The key input facility was never meant for text input, although using it that way worked slightly better in GLFW 2. If you were using it to input text, you should be using the character callback instead, on both GLFW 2 and 3. This will give you the characters being input, as opposed to the keys being pressed.

    +

    GLFW 3 has key tokens for all keys on a standard 105 key keyboard, so instead of having to remember whether to check for a or A, you now check for GLFW_KEY_A.

    +

    +Joystick function changes

    +

    The glfwGetJoystickPos function has been renamed to glfwGetJoystickAxes.

    +

    The glfwGetJoystickParam function and the GLFW_PRESENT, GLFW_AXES and GLFW_BUTTONS tokens have been replaced by the glfwJoystickPresent function as well as axis and button counts returned by the glfwGetJoystickAxes and glfwGetJoystickButtons functions.

    +

    +Win32 MBCS support

    +

    The Win32 port of GLFW 3 will not compile in MBCS mode. However, because the use of the Unicode version of the Win32 API doesn't affect the process as a whole, but only those windows created using it, it's perfectly possible to call MBCS functions from other parts of the same application. Therefore, even if an application using GLFW has MBCS mode code, there's no need for GLFW itself to support it.

    +

    +Support for versions of Windows older than XP

    +

    All explicit support for version of Windows older than XP has been removed. There is no code that actively prevents GLFW 3 from running on these earlier versions, but it uses Win32 functions that those versions lack.

    +

    Windows XP was released in 2001, and by now (January 2015) it has not only replaced almost all earlier versions of Windows, but is itself rapidly being replaced by Windows 7 and 8. The MSDN library doesn't even provide documentation for version older than Windows 2000, making it difficult to maintain compatibility with these versions even if it was deemed worth the effort.

    +

    The Win32 API has also not stood still, and GLFW 3 uses many functions only present on Windows XP or later. Even supporting an OS as new as XP (new from the perspective of GLFW 2, which still supports Windows 95) requires runtime checking for a number of functions that are present only on modern version of Windows.

    +

    +Capture of system-wide hotkeys

    +

    The ability to disable and capture system-wide hotkeys like Alt+Tab has been removed. Modern applications, whether they're games, scientific visualisations or something else, are nowadays expected to be good desktop citizens and allow these hotkeys to function even when running in full screen mode.

    +

    +Automatic termination

    +

    GLFW 3 does not register glfwTerminate with atexit at initialization, because exit calls registered functions from the calling thread and while it is permitted to call exit from any thread, glfwTerminate must only be called from the main thread.

    +

    To release all resources allocated by GLFW, you should call glfwTerminate yourself, from the main thread, before the program terminates. Note that this destroys all windows not already destroyed with glfwDestroyWindow, invalidating any window handles you may still have.

    +

    +GLU header inclusion

    +

    GLFW 3 does not by default include the GLU header and GLU itself has been deprecated by Khronos. New projects should not use GLU, but if you need it for legacy code that has been moved to GLFW 3, you can request that the GLFW header includes it by defining GLFW_INCLUDE_GLU before the inclusion of the GLFW header.

    +
    Old syntax
    #include <GL/glfw.h>
    +
    +
    New syntax
    #define GLFW_INCLUDE_GLU
    +
    #include <GLFW/glfw3.h>
    +
    +

    There are many libraries that offer replacements for the functionality offered by GLU. For the matrix helper functions, see math libraries like GLM (for C++), linmath.h (for C) and others. For the tessellation functions, see for example libtess2.

    +

    +Name change tables

    +

    +Renamed functions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    GLFW 2 GLFW 3 Notes
    glfwOpenWindow glfwCreateWindow All channel bit depths are now hints
    glfwCloseWindow glfwDestroyWindow
    glfwOpenWindowHint glfwWindowHint Now accepts all GLFW_*_BITS tokens
    glfwEnable glfwSetInputMode
    glfwDisable glfwSetInputMode
    glfwGetMousePos glfwGetCursorPos
    glfwSetMousePos glfwSetCursorPos
    glfwSetMousePosCallback glfwSetCursorPosCallback
    glfwSetMouseWheelCallback glfwSetScrollCallback Accepts two-dimensional scroll offsets as doubles
    glfwGetJoystickPos glfwGetJoystickAxes
    glfwGetWindowParam glfwGetWindowAttrib
    glfwGetGLVersion glfwGetWindowAttrib Use GLFW_CONTEXT_VERSION_MAJOR, GLFW_CONTEXT_VERSION_MINOR and GLFW_CONTEXT_REVISION
    glfwGetDesktopMode glfwGetVideoMode Returns the current mode of a monitor
    glfwGetJoystickParam glfwJoystickPresent The axis and button counts are provided by glfwGetJoystickAxes and glfwGetJoystickButtons
    +

    +Renamed types

    + + + + + + + +
    GLFW 2 GLFW 3 Notes
    GLFWmousewheelfun GLFWscrollfun
    GLFWmouseposfun GLFWcursorposfun
    +

    +Renamed tokens

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    GLFW 2 GLFW 3 Notes
    GLFW_OPENGL_VERSION_MAJOR GLFW_CONTEXT_VERSION_MAJOR Renamed as it applies to OpenGL ES as well
    GLFW_OPENGL_VERSION_MINOR GLFW_CONTEXT_VERSION_MINOR Renamed as it applies to OpenGL ES as well
    GLFW_FSAA_SAMPLES GLFW_SAMPLES Renamed to match the OpenGL API
    GLFW_ACTIVE GLFW_FOCUSED Renamed to match the window focus callback
    GLFW_WINDOW_NO_RESIZE GLFW_RESIZABLE The default has been inverted
    GLFW_MOUSE_CURSOR GLFW_CURSOR Used with glfwSetInputMode
    GLFW_KEY_ESC GLFW_KEY_ESCAPE
    GLFW_KEY_DEL GLFW_KEY_DELETE
    GLFW_KEY_PAGEUP GLFW_KEY_PAGE_UP
    GLFW_KEY_PAGEDOWN GLFW_KEY_PAGE_DOWN
    GLFW_KEY_KP_NUM_LOCK GLFW_KEY_NUM_LOCK
    GLFW_KEY_LCTRL GLFW_KEY_LEFT_CONTROL
    GLFW_KEY_LSHIFT GLFW_KEY_LEFT_SHIFT
    GLFW_KEY_LALT GLFW_KEY_LEFT_ALT
    GLFW_KEY_LSUPER GLFW_KEY_LEFT_SUPER
    GLFW_KEY_RCTRL GLFW_KEY_RIGHT_CONTROL
    GLFW_KEY_RSHIFT GLFW_KEY_RIGHT_SHIFT
    GLFW_KEY_RALT GLFW_KEY_RIGHT_ALT
    GLFW_KEY_RSUPER GLFW_KEY_RIGHT_SUPER
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/nav_f.png b/deps/glfw-3.3.8/docs/html/nav_f.png new file mode 100644 index 0000000..72a58a5 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_f.png differ diff --git a/deps/glfw-3.3.8/docs/html/nav_g.png b/deps/glfw-3.3.8/docs/html/nav_g.png new file mode 100644 index 0000000..2093a23 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_g.png differ diff --git a/deps/glfw-3.3.8/docs/html/nav_h.png b/deps/glfw-3.3.8/docs/html/nav_h.png new file mode 100644 index 0000000..33389b1 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/nav_h.png differ diff --git a/deps/glfw-3.3.8/docs/html/news.html b/deps/glfw-3.3.8/docs/html/news.html new file mode 100644 index 0000000..0bf7e28 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/news.html @@ -0,0 +1,614 @@ + + + + + + + +GLFW: Release notes + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Release notes
    +
    +
    +

    Table of Contents

    + +
    +

    +Release notes for version 3.3

    +

    These are the release notes for version 3.3. For a more detailed view including all fixed bugs see the version history.

    +

    Please review the caveats, deprecations and removals if your project was written against an earlier version of GLFW 3.

    +

    +New features in version 3.3

    +

    +Gamepad input via SDL_GameControllerDB

    +

    GLFW can now remap game controllers to a standard Xbox-like layout using a built-in copy of SDL_GameControllerDB. Call glfwJoystickIsGamepad to check if a joystick has a mapping, glfwGetGamepadState to retrieve its input state, glfwUpdateGamepadMappings to add newer mappings and glfwGetGamepadName and glfwGetJoystickGUID for mapping related information.

    +

    For more information see Gamepad input.

    +

    +Support for Vulkan on macOS via MoltenVK

    +

    GLFW now supports MoltenVK, a Vulkan implementation on top of the Metal API, and its VK_MVK_macos_surface window surface creation extension. MoltenVK is included in the macOS Vulkan SDK.

    +

    For more information see Vulkan guide.

    +

    +Content scale queries for DPI-aware rendering

    +

    GLFW now provides content scales for windows and monitors, i.e. the ratio between their current DPI and the platform's default DPI, with glfwGetWindowContentScale and glfwGetMonitorContentScale.

    +

    Changes of the content scale of a window can be received with the window content scale callback, set with glfwSetWindowContentScaleCallback.

    +

    The GLFW_SCALE_TO_MONITOR window hint enables automatic resizing of a window by the content scale of the monitor it is placed, on platforms like Windows where this is necessary. This takes effect both on creation and when the window is moved between monitors. It is related to but different from GLFW_COCOA_RETINA_FRAMEBUFFER.

    +

    For more information see Window content scale.

    +

    +Support for updating window attributes

    +

    GLFW now supports changing the GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW attributes for existing windows with glfwSetWindowAttrib.

    +

    For more information see Window attributes.

    +

    +Support for raw mouse motion

    +

    GLFW now supports raw (unscaled and unaccelerated) mouse motion in disabled cursor mode with the GLFW_RAW_MOUSE_MOTION input mode. Raw mouse motion input is not yet implemented on macOS. Call glfwRawMouseMotionSupported to check if GLFW can provide raw mouse motion on the current system.

    +

    For more information see Raw mouse motion.

    +

    +Joystick hats

    +

    GLFW can now return the state of hats (i.e. POVs or D-pads) of a joystick with glfwGetJoystickHats. For compatibility, hats are also exposed as buttons. This can be disabled with the GLFW_JOYSTICK_HAT_BUTTONS initialization hint.

    +

    For more information see Joystick hat states.

    +

    +Error query

    +

    GLFW now supports querying the last error code for the calling thread and its human-readable description with glfwGetError. This can be used instead of or together with the error callback.

    +

    For more information see Error handling.

    +

    +Support for initialization hints

    +

    GLFW now supports setting library initialization hints with glfwInitHint. These must be set before initialization to take effect. Some of these hints are platform specific but are safe to set on any platform.

    +

    For more information see Initialization hints.

    +

    +User attention request

    +

    GLFW now supports requesting user attention with glfwRequestWindowAttention. Where possible this calls attention to the specified window. On platforms like macOS it calls attention to the whole application.

    +

    For more information see Window attention request.

    +

    +Window maximization callback

    +

    GLFW now supports notifying the application that the window has been maximized glfwSetWindowMaximizeCallback. This is called both when the window was maximized by the user and when it was done with glfwMaximizeWindow.

    +

    For more information see Window maximization.

    +

    +Query for the monitor work area

    +

    GLFW now supports querying the work area of a monitor, i.e. the area not occupied by task bars or global menu bars, with glfwGetMonitorWorkarea. On platforms that lack this concept, the whole area of the monitor is returned.

    +

    For more information see Work area.

    +

    +Transparent windows and framebuffers

    +

    GLFW now supports the creation of windows with transparent framebuffers on systems with desktop compositing enabled with the GLFW_TRANSPARENT_FRAMEBUFFER window hint and attribute. This hint must be set before window creation and leaves any window decorations opaque.

    +

    GLFW now also supports whole window transparency with glfwGetWindowOpacity and glfwSetWindowOpacity. This value controls the opacity of the whole window including decorations and unlike framebuffer transparency can be changed at any time after window creation.

    +

    For more information see Window transparency.

    +

    +Query for the scancode of a key

    +

    GLFW now supports querying the platform dependent scancode of any physical key with glfwGetKeyScancode.

    +

    For more information see Key input.

    +

    +Cursor centering window hint

    +

    GLFW now supports controlling whether the cursor is centered over newly created full screen windows with the GLFW_CENTER_CURSOR window hint. It is enabled by default.

    +

    +Mouse cursor hover window attribute

    +

    GLFW now supports polling whether the cursor is hovering over the window content area with the GLFW_HOVERED window attribute. This attribute corresponds to the cursor enter/leave event.

    +

    +Window hint and attribute for input focus on show

    +

    GLFW now has the GLFW_FOCUS_ON_SHOW window hint and attribute for controlling whether a window gets input focus when shown. It is enabled by default. It applies both when creating an visible window with glfwCreateWindow and when showing it with glfwShowWindow.

    +

    This is a workaround for GLFW 3.0 lacking glfwFocusWindow and will be corrected in the next major version.

    +

    For more information see Window visibility.

    +

    +Monitor and joystick user pointers

    +

    GLFW now supports setting and querying user pointers for connected monitors and joysticks with glfwSetMonitorUserPointer, glfwGetMonitorUserPointer, glfwSetJoystickUserPointer and glfwGetJoystickUserPointer.

    +

    For more information see User pointer and Joystick user pointer.

    +

    +macOS menu bar from nib file

    +

    GLFW will now load a MainMenu.nib file if found in the Contents/Resources directory of the application bundle, as a way to replace the GLFW menu bar without recompiling GLFW. This behavior can be disabled with the GLFW_COCOA_MENUBAR initialization hint.

    +

    +Support for more context creation extensions

    +

    The context hint GLFW_SRGB_CAPABLE now supports OpenGL ES via WGL_EXT_colorspace, the context hint GLFW_CONTEXT_NO_ERROR now supports WGL_ARB_create_context_no_error and GLX_ARB_create_context_no_error, the context hint GLFW_CONTEXT_RELEASE_BEHAVIOR now supports EGL_KHR_context_flush_control and glfwGetProcAddress now supports EGL_KHR_get_all_proc_addresses.

    +

    +OSMesa off-screen context creation support

    +

    GLFW now supports creating off-screen OpenGL contexts using OSMesa by setting GLFW_CONTEXT_CREATION_API to GLFW_OSMESA_CONTEXT_API. Native access function have been added to retrieve the OSMesa color and depth buffers.

    +

    There is also a new null backend that uses OSMesa as its native context creation API, intended for automated testing. This backend does not provide input.

    +

    +Caveats for version 3.3

    +

    +Layout of joysticks have changed

    +

    The way joystick elements are arranged have changed to match SDL2 in order to support SDL_GameControllerDB mappings. The layout of joysticks may change again if required for compatibility with SDL2. If you need a known and stable layout for game controllers, see if you can switch to Gamepad input.

    +

    Existing code that depends on a specific joystick layout will likely have to be updated.

    +

    +No window required to wait for events

    +

    The glfwWaitEvents and glfwWaitEventsTimeout functions no longer need a window to be created to wait for events. Before version 3.3 these functions would return immediately if there were no user-created windows. On platforms where only windows can receive events, an internal helper window is used.

    +

    Existing code that depends on the earlier behavior will likely have to be updated.

    +

    +Gamma ramp size of 256 may be rejected

    +

    The documentation for versions before 3.3 stated that a gamma ramp size of 256 would always be accepted. This was never the case on X11 and could lead to artifacts on macOS. The glfwSetGamma function has been updated to always generate a ramp of the correct size.

    +

    Existing code that hardcodes a size of 256 should be updated to use the size of the current ramp of a monitor when setting a new ramp for that monitor.

    +

    +Windows XInput deadzone removed

    +

    GLFW no longer applies any deadzone to the input state received from the XInput API. This was never done for any other platform joystick API so this change makes the behavior more consistent but you will need to apply your own deadzone if desired.

    +

    +X11 clipboard transfer limits

    +

    GLFW now supports reading clipboard text via the INCR method, which removes the limit on how much text can be read with glfwGetClipboardString. However, writing via this method is not yet supported, so you may not be able to write a very large string with glfwSetClipboardString even if you read it from the clipboard earlier.

    +

    The exact size limit for writing to the clipboard is negotiated with each receiving application but is at least several tens of kilobytes. Note that only the read limit has changed. Any string that could be written before still can be.

    +

    +X11 extension libraries are loaded dynamically

    +

    GLFW now loads all X11 extension libraries at initialization. The only X11 library you need to link against is libX11. The header files for the extension libraries are still required for compilation.

    +

    Existing projects and makefiles that link GLFW directly against the extension libraries should still build correctly but will add these libraries as load-time dependencies.

    +

    +CMake 3.0 or later is required

    +

    The minimum CMake version has been raised from 2.8.12 to 3.0. This is only a requirement of the GLFW CMake files. The GLFW source files do not depend on CMake.

    +

    +Framebuffer transparency requires DWM transparency

    +

    GLFW no longer supports framebuffer transparency enabled via GLFW_TRANSPARENT_FRAMEBUFFER on Windows 7 if DWM transparency is off (the Transparency setting under Personalization > Window Color).

    +

    +Empty events on X11 no longer roundtrip to server

    +

    Starting with GLFW 3.3.7, events posted with glfwPostEmptyEvent now use a separate unnamed pipe instead of sending an X11 client event to the helper window.

    +

    +Deprecations in version 3.3

    +

    +Character with modifiers callback

    +

    The character with modifiers callback set with glfwSetCharModsCallback has been deprecated and should if possible not be used.

    +

    Existing code should still work but further bug fixes will likely not be made. The callback will be removed in the next major version.

    +

    +Window parameter to clipboard functions

    +

    The window parameter of the clipboard functions glfwGetClipboardString and glfwSetClipboardString has been deprecated and is no longer used on any platform. On platforms where the clipboard must be owned by a specific window, an internal helper window is used.

    +

    Existing code should still work unless it depends on a specific window owning the clipboard. New code may pass NULL as the window argument. The parameter will be removed in a future release.

    +

    +Removals in 3.3

    +

    +macOS specific CMake options and macros

    +

    The GLFW_USE_RETINA, GLFW_USE_CHDIR and GLFW_USE_MENUBAR CMake options and the _GLFW_USE_RETINA, _GLFW_USE_CHDIR and _GLFW_USE_MENUBAR compile-time macros have been removed.

    +

    These options and macros are replaced by the window hint GLFW_COCOA_RETINA_FRAMEBUFFER and the init hints GLFW_COCOA_CHDIR_RESOURCES and GLFW_COCOA_MENUBAR.

    +

    Existing projects and makefiles that set these options or define these macros during compilation of GLFW will still build but it will have no effect and the default behaviors will be used.

    +

    +LunarG Vulkan SDK dependency

    +

    The GLFW test programs that previously depended on the LunarG Vulkan SDK now instead uses a Vulkan loader generated by glad2. This means the GLFW CMake files no longer look for the Vulkan SDK.

    +

    Existing CMake projects that depended on the Vulkan SDK cache variables from GLFW will need to call find_package(Vulkan) themselves. CMake 3.7 and later already comes with a Vulkan find module similar to the one GLFW previously included.

    +

    +CMake option LIB_SUFFIX

    +

    The LIB_SUFFIX CMake option has been removed. GLFW now uses the GNUInstallDirs CMake package to handle platform specific details like the library directory suffix and the LIB_SUFFIX CMake option has been removed.

    +

    Existing projects and makefiles that set the LIB_SUFFIX option will use the suffix chosen by the GNUInstallDirs package and the option will be ignored.

    +

    +Support for the wl_shell protocol

    +

    Support for the wl_shell protocol has been removed and GLFW now only supports the XDG-Shell protocol. If your Wayland compositor does not support XDG-Shell then GLFW will fail to initialize.

    +

    +Mir support

    +

    The experimental Mir support has been completely removed as the Mir project has implemented support for the Wayland protocol and is recommending that applications use that instead.

    +

    Existing projects and makefiles that select Mir when compiling GLFW will fail. Use Wayland or X11 instead.

    +

    +New symbols in version 3.3

    +

    +New functions in version 3.3

    + +

    +New types in version 3.3

    + +

    +New constants in version 3.3

    + +

    +Release notes for 3.2

    +

    These are the release notes for version 3.2. For a more detailed view including all fixed bugs see the version history.

    +

    +New features in version 3.2

    +

    +Support for Vulkan

    +

    GLFW now supports basic integration with Vulkan with glfwVulkanSupported, glfwGetRequiredInstanceExtensions, glfwGetInstanceProcAddress, glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface. Vulkan header inclusion can be selected with GLFW_INCLUDE_VULKAN.

    +

    +Window mode switching

    +

    GLFW now supports switching between windowed and full screen modes and updating the monitor and desired resolution and refresh rate of full screen windows with glfwSetWindowMonitor.

    +

    +Window maxmimization support

    +

    GLFW now supports window maximization with glfwMaximizeWindow and the GLFW_MAXIMIZED window hint and attribute.

    +

    +Window input focus control

    +

    GLFW now supports giving windows input focus with glfwFocusWindow.

    +

    +Window size limit support

    +

    GLFW now supports setting both absolute and relative window size limits with glfwSetWindowSizeLimits and glfwSetWindowAspectRatio.

    +

    +Localized key names

    +

    GLFW now supports querying the localized name of printable keys with glfwGetKeyName, either by key token or by scancode.

    +

    +Wait for events with timeout

    +

    GLFW now supports waiting for events for a set amount of time with glfwWaitEventsTimeout.

    +

    +Window icon support

    +

    GLFW now supports setting the icon of windows with glfwSetWindowIcon.

    +

    +Raw timer access

    +

    GLFW now supports raw timer values with glfwGetTimerValue and glfwGetTimerFrequency.

    +

    +Joystick connection callback

    +

    GLFW now supports notifying when a joystick has been connected or disconnected with glfwSetJoystickCallback.

    +

    +Context-less windows

    +

    GLFW now supports creating windows without a OpenGL or OpenGL ES context by setting the GLFW_CLIENT_API hint to GLFW_NO_API.

    +

    +Run-time context creation API selection

    +

    GLFW now supports selecting and querying the context creation API at run-time with the GLFW_CONTEXT_CREATION_API hint and attribute.

    +

    +Error-free context creation

    +

    GLFW now supports creating and querying OpenGL and OpenGL ES contexts that do not emit errors with the GLFW_CONTEXT_NO_ERROR hint, provided the machine supports the GL_KHR_no_error extension.

    +

    +CMake config-file package support

    +

    GLFW now supports being used as a config-file package from other projects for easy linking with the library and its dependencies.

    +

    +Release notes for 3.1

    +

    These are the release notes for version 3.1. For a more detailed view including all fixed bugs see the version history.

    +

    +New features in version 3.1

    +

    +Custom mouse cursor images

    +

    GLFW now supports creating and setting both custom cursor images and standard cursor shapes. They are created with glfwCreateCursor or glfwCreateStandardCursor, set with glfwSetCursor and destroyed with glfwDestroyCursor.

    +
    See also
    Cursor objects
    +

    +Path drop event

    +

    GLFW now provides a callback for receiving the paths of files and directories dropped onto GLFW windows. The callback is set with glfwSetDropCallback.

    +
    See also
    Path drop input
    +

    +Main thread wake-up

    +

    GLFW now provides the glfwPostEmptyEvent function for posting an empty event from another thread to the main thread event queue, causing glfwWaitEvents to return.

    +
    See also
    Event processing
    +

    +Window frame size query

    +

    GLFW now supports querying the size, on each side, of the frame around the content area of a window, with glfwGetWindowFrameSize.

    +
    See also
    Window size
    +

    +Simultaneous multi-monitor rendering

    +

    GLFW now supports disabling auto-iconification of full screen windows with the GLFW_AUTO_ICONIFY window hint. This is intended for people building multi-monitor installations, where you need windows to stay in full screen despite losing input focus.

    +

    +Floating windows

    +

    GLFW now supports floating windows, also called topmost or always on top, for easier debugging with the GLFW_FLOATING window hint and attribute.

    +

    +Initially unfocused windows

    +

    GLFW now supports preventing a windowed mode window from gaining input focus on creation, with the GLFW_FOCUSED window hint.

    +

    +Direct access for window attributes and cursor position

    +

    GLFW now queries the window input focus, visibility and iconification attributes and the cursor position directly instead of returning cached data.

    +

    +Character with modifiers callback

    +

    GLFW now provides a callback for character events with modifier key bits. The callback is set with glfwSetCharModsCallback. Unlike the regular character callback, this will report character events that will not result in a character being input, for example if the Control key is held down.

    +
    See also
    Text input
    +

    +Single buffered framebuffers

    +

    GLFW now supports the creation of single buffered windows, with the GLFW_DOUBLEBUFFER hint.

    +

    +Macro for including extension header

    +

    GLFW now includes the extension header appropriate for the chosen OpenGL or OpenGL ES header when GLFW_INCLUDE_GLEXT is defined. GLFW does not provide these headers. They must be provided by your development environment or your OpenGL or OpenGL ES SDK.

    +

    +Context release behaviors

    +

    GLFW now supports controlling and querying whether the pipeline is flushed when a context is made non-current, with the GLFW_CONTEXT_RELEASE_BEHAVIOR hint and attribute, provided the machine supports the GL_KHR_context_flush_control extension.

    +

    +(Experimental) Wayland support

    +

    GLFW now has an experimental Wayland display protocol backend that can be selected on Linux with a CMake option.

    +

    +(Experimental) Mir support

    +

    GLFW now has an experimental Mir display server backend that can be selected on Linux with a CMake option.

    +

    +Release notes for 3.0

    +

    These are the release notes for version 3.0. For a more detailed view including all fixed bugs see the version history.

    +

    +New features in version 3.0

    +

    +CMake build system

    +

    GLFW now uses the CMake build system instead of the various makefiles and project files used by earlier versions. CMake is available for all platforms supported by GLFW, is present in most package systems and can generate makefiles and/or project files for most popular development environments.

    +

    For more information on how to use CMake, see the CMake manual.

    +

    +Multi-window support

    +

    GLFW now supports the creation of multiple windows, each with their own OpenGL or OpenGL ES context, and all window functions now take a window handle. Event callbacks are now per-window and are provided with the handle of the window that received the event. The glfwMakeContextCurrent function has been added to select which context is current on a given thread.

    +

    +Multi-monitor support

    +

    GLFW now explicitly supports multiple monitors. They can be enumerated with glfwGetMonitors, queried with glfwGetVideoModes, glfwGetMonitorPos, glfwGetMonitorName and glfwGetMonitorPhysicalSize, and specified at window creation to make the newly created window full screen on that specific monitor.

    +

    +Unicode support

    +

    All string arguments to GLFW functions and all strings returned by GLFW now use the UTF-8 encoding. This includes the window title, error string, clipboard text, monitor and joystick names as well as the extension function arguments (as ASCII is a subset of UTF-8).

    +

    +Clipboard text I/O

    +

    GLFW now supports reading and writing plain text to and from the system clipboard, with the glfwGetClipboardString and glfwSetClipboardString functions.

    +

    +Gamma ramp support

    +

    GLFW now supports setting and reading back the gamma ramp of monitors, with the glfwGetGammaRamp and glfwSetGammaRamp functions. There is also glfwSetGamma, which generates a ramp from a gamma value and then sets it.

    +

    +OpenGL ES support

    +

    GLFW now supports the creation of OpenGL ES contexts, by setting the GLFW_CLIENT_API hint to GLFW_OPENGL_ES_API, where creation of such contexts are supported. Note that GLFW does not implement OpenGL ES, so your driver must provide support in a way usable by GLFW. Modern Nvidia and Intel drivers support creation of OpenGL ES context using the GLX and WGL APIs, while AMD provides an EGL implementation instead.

    +

    +(Experimental) EGL support

    +

    GLFW now has an experimental EGL context creation back end that can be selected through CMake options.

    +

    +High-DPI support

    +

    GLFW now supports high-DPI monitors on both Windows and macOS, giving windows full resolution framebuffers where other UI elements are scaled up. To achieve this, glfwGetFramebufferSize and glfwSetFramebufferSizeCallback have been added. These work with pixels, while the rest of the GLFW API works with screen coordinates. This is important as OpenGL uses pixels, not screen coordinates.

    +

    +Error callback

    +

    GLFW now has an error callback, which can provide your application with much more detailed diagnostics than was previously possible. The callback is passed an error code and a description string.

    +

    +Per-window user pointer

    +

    Each window now has a user-defined pointer, retrieved with glfwGetWindowUserPointer and set with glfwSetWindowUserPointer, to make it easier to integrate GLFW into C++ code.

    +

    +Window iconification callback

    +

    Each window now has a callback for iconification and restoration events, which is set with glfwSetWindowIconifyCallback.

    +

    +Window position callback

    +

    Each window now has a callback for position events, which is set with glfwSetWindowPosCallback.

    +

    +Window position query

    +

    The position of a window can now be retrieved using glfwGetWindowPos.

    +

    +Window focus callback

    +

    Each windows now has a callback for focus events, which is set with glfwSetWindowFocusCallback.

    +

    +Cursor enter/leave callback

    +

    Each window now has a callback for when the mouse cursor enters or leaves its content area, which is set with glfwSetCursorEnterCallback.

    +

    +Initial window title

    +

    The title of a window is now specified at creation time, as one of the arguments to glfwCreateWindow.

    +

    +Hidden windows

    +

    Windows can now be hidden with glfwHideWindow, shown using glfwShowWindow and created initially hidden with the GLFW_VISIBLE window hint and attribute. This allows for off-screen rendering in a way compatible with most drivers, as well as moving a window to a specific position before showing it.

    +

    +Undecorated windows

    +

    Windowed mode windows can now be created without decorations, e.g. things like a frame, a title bar, with the GLFW_DECORATED window hint and attribute. This allows for the creation of things like splash screens.

    +

    +Modifier key bit masks

    +

    Modifier key bit mask parameters have been added to the mouse button and key callbacks.

    +

    +Platform-specific scancodes

    +

    A scancode parameter has been added to the key callback. Keys that don't have a key token still get passed on with the key parameter set to GLFW_KEY_UNKNOWN. These scancodes will vary between machines and are intended to be used for key bindings.

    +

    +Joystick names

    +

    The name of a joystick can now be retrieved using glfwGetJoystickName.

    +

    +Doxygen documentation

    +

    You are reading it.

    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/news_8dox.html b/deps/glfw-3.3.8/docs/html/news_8dox.html new file mode 100644 index 0000000..e200170 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/news_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: news.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    news.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/open.png b/deps/glfw-3.3.8/docs/html/open.png new file mode 100644 index 0000000..30f75c7 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/open.png differ diff --git a/deps/glfw-3.3.8/docs/html/pages.html b/deps/glfw-3.3.8/docs/html/pages.html new file mode 100644 index 0000000..6f2d4eb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/pages.html @@ -0,0 +1,92 @@ + + + + + + + +GLFW: Guides + + + + + + + + + + +
    + + + + + + + + +
    + +
    +
    + + +
    + +
    + +
    +
    Guides
    +
    +
    +
    Here is a list of all related documentation pages:
    + + + + + + + + + + + + + + + +
     Release notes
     Getting started
     Moving from GLFW 2 to 3
     Compiling GLFW
     Building applications
     Introduction to the API
     Context guide
     Monitor guide
     Window guide
     Input guide
     Vulkan guide
     Standards conformance
     Internal structure
     Deprecated List
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/quick_8dox.html b/deps/glfw-3.3.8/docs/html/quick_8dox.html new file mode 100644 index 0000000..f65bd4c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/quick_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: quick.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    quick.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/quick_guide.html b/deps/glfw-3.3.8/docs/html/quick_guide.html new file mode 100644 index 0000000..6a31489 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/quick_guide.html @@ -0,0 +1,391 @@ + + + + + + + +GLFW: Getting started + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Getting started
    +
    +
    +

    Table of Contents

    + +
    +

    This guide takes you through writing a simple application using GLFW 3. The application will create a window and OpenGL context, render a rotating triangle and exit when the user closes the window or presses Escape. This guide will introduce a few of the most commonly used functions, but there are many more.

    +

    This guide assumes no experience with earlier versions of GLFW. If you have used GLFW 2 in the past, read Moving from GLFW 2 to 3, as some functions behave differently in GLFW 3.

    +

    +Step by step

    +

    +Including the GLFW header

    +

    In the source files of your application where you use GLFW, you need to include its header file.

    +
    #include <GLFW/glfw3.h>
    +
    glfw3.h
    The header of the GLFW 3 API.
    +

    This header provides all the constants, types and function prototypes of the GLFW API.

    +

    By default it also includes the OpenGL header from your development environment. On some platforms this header only supports older versions of OpenGL. The most extreme case is Windows, where it typically only supports OpenGL 1.2.

    +

    Most programs will instead use an extension loader library and include its header. This example uses files generated by glad. The GLFW header can detect most such headers if they are included first and will then not include the one from your development environment.

    +
    #include <glad/gl.h>
    +
    #include <GLFW/glfw3.h>
    +

    To make sure there will be no header conflicts, you can define GLFW_INCLUDE_NONE before the GLFW header to explicitly disable inclusion of the development environment header. This also allows the two headers to be included in any order.

    +
    #define GLFW_INCLUDE_NONE
    +
    #include <GLFW/glfw3.h>
    +
    #include <glad/gl.h>
    +

    +Initializing and terminating GLFW

    +

    Before you can use most GLFW functions, the library must be initialized. On successful initialization, GLFW_TRUE is returned. If an error occurred, GLFW_FALSE is returned.

    +
    if (!glfwInit())
    +
    {
    +
    // Initialization failed
    +
    }
    +
    glfwInit
    int glfwInit(void)
    Initializes the GLFW library.
    +

    Note that GLFW_TRUE and GLFW_FALSE are and will always be one and zero.

    +

    When you are done using GLFW, typically just before the application exits, you need to terminate GLFW.

    +
    glfwTerminate();
    +
    glfwTerminate
    void glfwTerminate(void)
    Terminates the GLFW library.
    +

    This destroys any remaining windows and releases any other resources allocated by GLFW. After this call, you must initialize GLFW again before using any GLFW functions that require it.

    +

    +Setting an error callback

    +

    Most events are reported through callbacks, whether it's a key being pressed, a GLFW window being moved, or an error occurring. Callbacks are C functions (or C++ static methods) that are called by GLFW with arguments describing the event.

    +

    In case a GLFW function fails, an error is reported to the GLFW error callback. You can receive these reports with an error callback. This function must have the signature below but may do anything permitted in other callbacks.

    +
    void error_callback(int error, const char* description)
    +
    {
    +
    fprintf(stderr, "Error: %s\n", description);
    +
    }
    +

    Callback functions must be set, so GLFW knows to call them. The function to set the error callback is one of the few GLFW functions that may be called before initialization, which lets you be notified of errors both during and after initialization.

    +
    glfwSetErrorCallback(error_callback);
    +
    glfwSetErrorCallback
    GLFWerrorfun glfwSetErrorCallback(GLFWerrorfun callback)
    Sets the error callback.
    +

    +Creating a window and context

    +

    The window and its OpenGL context are created with a single call to glfwCreateWindow, which returns a handle to the created combined window and context object

    +
    GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL);
    +
    if (!window)
    +
    {
    +
    // Window or OpenGL context creation failed
    +
    }
    +
    glfwCreateWindow
    GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
    Creates a window and its associated context.
    +
    GLFWwindow
    struct GLFWwindow GLFWwindow
    Opaque window object.
    Definition: glfw3.h:1185
    +

    This creates a 640 by 480 windowed mode window with an OpenGL context. If window or OpenGL context creation fails, NULL will be returned. You should always check the return value. While window creation rarely fails, context creation depends on properly installed drivers and may fail even on machines with the necessary hardware.

    +

    By default, the OpenGL context GLFW creates may have any version. You can require a minimum OpenGL version by setting the GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR hints before creation. If the required minimum version is not supported on the machine, context (and window) creation fails.

    +
    glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 2);
    +
    glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 0);
    +
    GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL);
    +
    if (!window)
    +
    {
    +
    // Window or context creation failed
    +
    }
    +
    GLFW_CONTEXT_VERSION_MINOR
    #define GLFW_CONTEXT_VERSION_MINOR
    Context client API minor version hint and attribute.
    Definition: glfw3.h:961
    +
    glfwWindowHint
    void glfwWindowHint(int hint, int value)
    Sets the specified window hint to the desired value.
    +
    GLFW_CONTEXT_VERSION_MAJOR
    #define GLFW_CONTEXT_VERSION_MAJOR
    Context client API major version hint and attribute.
    Definition: glfw3.h:955
    +

    The window handle is passed to all window related functions and is provided to along to all window related callbacks, so they can tell which window received the event.

    +

    When a window and context is no longer needed, destroy it.

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

    Once this function is called, no more events will be delivered for that window and its handle becomes invalid.

    +

    +Making the OpenGL context current

    +

    Before you can use the OpenGL API, you must have a current OpenGL context.

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

    The context will remain current until you make another context current or until the window owning the current context is destroyed.

    +

    If you are using an extension loader library to access modern OpenGL then this is when to initialize it, as the loader needs a current context to load from. This example uses glad, but the same rule applies to all such libraries.

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

    +Checking the window close flag

    +

    Each window has a flag indicating whether the window should be closed.

    +

    When the user attempts to close the window, either by pressing the close widget in the title bar or using a key combination like Alt+F4, this flag is set to 1. Note that the window isn't actually closed, so you are expected to monitor this flag and either destroy the window or give some kind of feedback to the user.

    +
    while (!glfwWindowShouldClose(window))
    +
    {
    +
    // Keep running
    +
    }
    +
    glfwWindowShouldClose
    int glfwWindowShouldClose(GLFWwindow *window)
    Checks the close flag of the specified window.
    +

    You can be notified when the user is attempting to close the window by setting a close callback with glfwSetWindowCloseCallback. The callback will be called immediately after the close flag has been set.

    +

    You can also set it yourself with glfwSetWindowShouldClose. This can be useful if you want to interpret other kinds of input as closing the window, like for example pressing the Escape key.

    +

    +Receiving input events

    +

    Each window has a large number of callbacks that can be set to receive all the various kinds of events. To receive key press and release events, create a key callback function.

    +
    static void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
    +
    {
    +
    if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS)
    +
    glfwSetWindowShouldClose(window, GLFW_TRUE);
    +
    }
    +
    GLFW_TRUE
    #define GLFW_TRUE
    One.
    Definition: glfw3.h:312
    +
    GLFW_PRESS
    #define GLFW_PRESS
    The key or mouse button was pressed.
    Definition: glfw3.h:338
    +
    GLFW_KEY_ESCAPE
    #define GLFW_KEY_ESCAPE
    Definition: glfw3.h:446
    +
    glfwSetWindowShouldClose
    void glfwSetWindowShouldClose(GLFWwindow *window, int value)
    Sets the close flag of the specified window.
    +

    The key callback, like other window related callbacks, are set per-window.

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

    In order for event callbacks to be called when events occur, you need to process events as described below.

    +

    +Rendering with OpenGL

    +

    Once you have a current OpenGL context, you can use OpenGL normally. In this tutorial, a multi-colored rotating triangle will be rendered. The framebuffer size needs to be retrieved for glViewport.

    +
    int width, height;
    +
    glfwGetFramebufferSize(window, &width, &height);
    +
    glViewport(0, 0, width, height);
    +
    glfwGetFramebufferSize
    void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
    Retrieves the size of the framebuffer of the specified window.
    +

    You can also set a framebuffer size callback using glfwSetFramebufferSizeCallback and be notified when the size changes.

    +

    The details of how to render with OpenGL is outside the scope of this tutorial, but there are many excellent resources for learning modern OpenGL. Here are a few of them:

    + +

    These all happen to use GLFW, but OpenGL itself works the same whatever API you use to create the window and context.

    +

    +Reading the timer

    +

    To create smooth animation, a time source is needed. GLFW provides a timer that returns the number of seconds since initialization. The time source used is the most accurate on each platform and generally has micro- or nanosecond resolution.

    +
    double time = glfwGetTime();
    +
    glfwGetTime
    double glfwGetTime(void)
    Returns the GLFW time.
    +

    +Swapping buffers

    +

    GLFW windows by default use double buffering. That means that each window has two rendering buffers; a front buffer and a back buffer. The front buffer is the one being displayed and the back buffer the one you render to.

    +

    When the entire frame has been rendered, the buffers need to be swapped with one another, so the back buffer becomes the front buffer and vice versa.

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

    The swap interval indicates how many frames to wait until swapping the buffers, commonly known as vsync. By default, the swap interval is zero, meaning buffer swapping will occur immediately. On fast machines, many of those frames will never be seen, as the screen is still only updated typically 60-75 times per second, so this wastes a lot of CPU and GPU cycles.

    +

    Also, because the buffers will be swapped in the middle the screen update, leading to screen tearing.

    +

    For these reasons, applications will typically want to set the swap interval to one. It can be set to higher values, but this is usually not recommended, because of the input latency it leads to.

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

    This function acts on the current context and will fail unless a context is current.

    +

    +Processing events

    +

    GLFW needs to communicate regularly with the window system both in order to receive events and to show that the application hasn't locked up. Event processing must be done regularly while you have visible windows and is normally done each frame after buffer swapping.

    +

    There are two methods for processing pending events; polling and waiting. This example will use event polling, which processes only those events that have already been received and then returns immediately.

    +
    glfwPollEvents();
    +
    glfwPollEvents
    void glfwPollEvents(void)
    Processes all pending events.
    +

    This is the best choice when rendering continually, like most games do. If instead you only need to update your rendering once you have received new input, glfwWaitEvents is a better choice. It waits until at least one event has been received, putting the thread to sleep in the meantime, and then processes all received events. This saves a great deal of CPU cycles and is useful for, for example, many kinds of editing tools.

    +

    +Putting it together

    +

    Now that you know how to initialize GLFW, create a window and poll for keyboard input, it's possible to create a simple program.

    +

    This program creates a 640 by 480 windowed mode window and starts a loop that clears the screen, renders a triangle and processes events until the user either presses Escape or closes the window.

    +
    +
    #include <glad/gl.h>
    +
    #define GLFW_INCLUDE_NONE
    +
    #include <GLFW/glfw3.h>
    +
    +
    #include "linmath.h"
    +
    +
    #include <stdlib.h>
    +
    #include <stdio.h>
    +
    +
    static const struct
    +
    {
    +
    float x, y;
    +
    float r, g, b;
    +
    } vertices[3] =
    +
    {
    +
    { -0.6f, -0.4f, 1.f, 0.f, 0.f },
    +
    { 0.6f, -0.4f, 0.f, 1.f, 0.f },
    +
    { 0.f, 0.6f, 0.f, 0.f, 1.f }
    +
    };
    +
    +
    static const char* vertex_shader_text =
    +
    "#version 110\n"
    +
    "uniform mat4 MVP;\n"
    +
    "attribute vec3 vCol;\n"
    +
    "attribute vec2 vPos;\n"
    +
    "varying vec3 color;\n"
    +
    "void main()\n"
    +
    "{\n"
    +
    " gl_Position = MVP * vec4(vPos, 0.0, 1.0);\n"
    +
    " color = vCol;\n"
    +
    "}\n";
    +
    +
    static const char* fragment_shader_text =
    +
    "#version 110\n"
    +
    "varying vec3 color;\n"
    +
    "void main()\n"
    +
    "{\n"
    +
    " gl_FragColor = vec4(color, 1.0);\n"
    +
    "}\n";
    +
    +
    static void error_callback(int error, const char* description)
    +
    {
    +
    fprintf(stderr, "Error: %s\n", description);
    +
    }
    +
    +
    static void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods)
    +
    {
    +
    if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS)
    +
    glfwSetWindowShouldClose(window, GLFW_TRUE);
    +
    }
    +
    +
    int main(void)
    +
    {
    +
    GLFWwindow* window;
    +
    GLuint vertex_buffer, vertex_shader, fragment_shader, program;
    +
    GLint mvp_location, vpos_location, vcol_location;
    +
    +
    glfwSetErrorCallback(error_callback);
    +
    +
    if (!glfwInit())
    +
    exit(EXIT_FAILURE);
    +
    +
    glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 2);
    +
    glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 0);
    +
    +
    window = glfwCreateWindow(640, 480, "Simple example", NULL, NULL);
    +
    if (!window)
    +
    {
    +
    glfwTerminate();
    +
    exit(EXIT_FAILURE);
    +
    }
    +
    +
    glfwSetKeyCallback(window, key_callback);
    +
    +
    glfwMakeContextCurrent(window);
    +
    gladLoadGL(glfwGetProcAddress);
    +
    glfwSwapInterval(1);
    +
    +
    // NOTE: OpenGL error checks have been omitted for brevity
    +
    +
    glGenBuffers(1, &vertex_buffer);
    +
    glBindBuffer(GL_ARRAY_BUFFER, vertex_buffer);
    +
    glBufferData(GL_ARRAY_BUFFER, sizeof(vertices), vertices, GL_STATIC_DRAW);
    +
    +
    vertex_shader = glCreateShader(GL_VERTEX_SHADER);
    +
    glShaderSource(vertex_shader, 1, &vertex_shader_text, NULL);
    +
    glCompileShader(vertex_shader);
    +
    +
    fragment_shader = glCreateShader(GL_FRAGMENT_SHADER);
    +
    glShaderSource(fragment_shader, 1, &fragment_shader_text, NULL);
    +
    glCompileShader(fragment_shader);
    +
    +
    program = glCreateProgram();
    +
    glAttachShader(program, vertex_shader);
    +
    glAttachShader(program, fragment_shader);
    +
    glLinkProgram(program);
    +
    +
    mvp_location = glGetUniformLocation(program, "MVP");
    +
    vpos_location = glGetAttribLocation(program, "vPos");
    +
    vcol_location = glGetAttribLocation(program, "vCol");
    +
    +
    glEnableVertexAttribArray(vpos_location);
    +
    glVertexAttribPointer(vpos_location, 2, GL_FLOAT, GL_FALSE,
    +
    sizeof(vertices[0]), (void*) 0);
    +
    glEnableVertexAttribArray(vcol_location);
    +
    glVertexAttribPointer(vcol_location, 3, GL_FLOAT, GL_FALSE,
    +
    sizeof(vertices[0]), (void*) (sizeof(float) * 2));
    +
    +
    while (!glfwWindowShouldClose(window))
    +
    {
    +
    float ratio;
    +
    int width, height;
    +
    mat4x4 m, p, mvp;
    +
    +
    glfwGetFramebufferSize(window, &width, &height);
    +
    ratio = width / (float) height;
    +
    +
    glViewport(0, 0, width, height);
    +
    glClear(GL_COLOR_BUFFER_BIT);
    +
    +
    mat4x4_identity(m);
    +
    mat4x4_rotate_Z(m, m, (float) glfwGetTime());
    +
    mat4x4_ortho(p, -ratio, ratio, -1.f, 1.f, 1.f, -1.f);
    +
    mat4x4_mul(mvp, p, m);
    +
    +
    glUseProgram(program);
    +
    glUniformMatrix4fv(mvp_location, 1, GL_FALSE, (const GLfloat*) mvp);
    +
    glDrawArrays(GL_TRIANGLES, 0, 3);
    +
    +
    glfwSwapBuffers(window);
    +
    glfwPollEvents();
    +
    }
    +
    +
    glfwDestroyWindow(window);
    +
    +
    glfwTerminate();
    +
    exit(EXIT_SUCCESS);
    +
    }
    +
    +

    The program above can be found in the source package as examples/simple.c and is compiled along with all other examples when you build GLFW. If you built GLFW from the source package then you already have this as simple.exe on Windows, simple on Linux or simple.app on macOS.

    +

    This tutorial used only a few of the many functions GLFW provides. There are guides for each of the areas covered by GLFW. Each guide will introduce all the functions for that category.

    + +

    You can access reference documentation for any GLFW function by clicking it and the reference for each function links to related functions and guide sections.

    +

    The tutorial ends here. Once you have written a program that uses GLFW, you will need to compile and link it. How to do that depends on the development environment you are using and is best explained by the documentation for that environment. To learn about the details that are specific to GLFW, see Building applications.

    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_0.html b/deps/glfw-3.3.8/docs/html/search/all_0.html new file mode 100644 index 0000000..bb9e364 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_0.js b/deps/glfw-3.3.8/docs/html/search/all_0.js new file mode 100644 index 0000000..c61320f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['axes_0',['axes',['../structGLFWgamepadstate.html#a8b2c8939b1d31458de5359998375c189',1,'GLFWgamepadstate']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_1.html b/deps/glfw-3.3.8/docs/html/search/all_1.html new file mode 100644 index 0000000..8989416 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_1.js b/deps/glfw-3.3.8/docs/html/search/all_1.js new file mode 100644 index 0000000..30bfd28 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_1.js @@ -0,0 +1,8 @@ +var searchData= +[ + ['blue_0',['blue',['../structGLFWgammaramp.html#acf0c836d0efe29c392fe8d1a1042744b',1,'GLFWgammaramp']]], + ['bluebits_1',['blueBits',['../structGLFWvidmode.html#af310977f58d2e3b188175b6e3d314047',1,'GLFWvidmode']]], + ['build_2edox_2',['build.dox',['../build_8dox.html',1,'']]], + ['building_20applications_3',['Building applications',['../build_guide.html',1,'']]], + ['buttons_4',['buttons',['../structGLFWgamepadstate.html#a27e9896b51c65df15fba2c7139bfdb9a',1,'GLFWgamepadstate']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_10.html b/deps/glfw-3.3.8/docs/html/search/all_10.html new file mode 100644 index 0000000..a7c1f9c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_10.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_10.js b/deps/glfw-3.3.8/docs/html/search/all_10.js new file mode 100644 index 0000000..f129247 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_10.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['vulkan_20guide_0',['Vulkan guide',['../vulkan_guide.html',1,'']]], + ['vulkan_20support_20reference_1',['Vulkan support reference',['../group__vulkan.html',1,'']]], + ['vulkan_2edox_2',['vulkan.dox',['../vulkan_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_11.html b/deps/glfw-3.3.8/docs/html/search/all_11.html new file mode 100644 index 0000000..8f86146 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_11.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_11.js b/deps/glfw-3.3.8/docs/html/search/all_11.js new file mode 100644 index 0000000..c21189f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_11.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['width_0',['width',['../structGLFWvidmode.html#a698dcb200562051a7249cb6ae154c71d',1,'GLFWvidmode::width()'],['../structGLFWimage.html#af6a71cc999fe6d3aea31dd7e9687d835',1,'GLFWimage::width()']]], + ['window_20guide_1',['Window guide',['../window_guide.html',1,'']]], + ['window_20reference_2',['Window reference',['../group__window.html',1,'']]], + ['window_2edox_3',['window.dox',['../window_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_2.html b/deps/glfw-3.3.8/docs/html/search/all_2.html new file mode 100644 index 0000000..98e648c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_2.js b/deps/glfw-3.3.8/docs/html/search/all_2.js new file mode 100644 index 0000000..2055dca --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_2.js @@ -0,0 +1,9 @@ +var searchData= +[ + ['compat_2edox_0',['compat.dox',['../compat_8dox.html',1,'']]], + ['compile_2edox_1',['compile.dox',['../compile_8dox.html',1,'']]], + ['compiling_20glfw_2',['Compiling GLFW',['../compile_guide.html',1,'']]], + ['context_20guide_3',['Context guide',['../context_guide.html',1,'']]], + ['context_20reference_4',['Context reference',['../group__context.html',1,'']]], + ['context_2edox_5',['context.dox',['../context_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_3.html b/deps/glfw-3.3.8/docs/html/search/all_3.html new file mode 100644 index 0000000..f4e8da7 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_3.js b/deps/glfw-3.3.8/docs/html/search/all_3.js new file mode 100644 index 0000000..4d85845 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['deprecated_20list_0',['Deprecated List',['../deprecated.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_4.html b/deps/glfw-3.3.8/docs/html/search/all_4.html new file mode 100644 index 0000000..678d3a2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_4.js b/deps/glfw-3.3.8/docs/html/search/all_4.js new file mode 100644 index 0000000..eedfab6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['error_20codes_0',['Error codes',['../group__errors.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_5.html b/deps/glfw-3.3.8/docs/html/search/all_5.html new file mode 100644 index 0000000..aa9af78 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_5.js b/deps/glfw-3.3.8/docs/html/search/all_5.js new file mode 100644 index 0000000..f73f5bc --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_5.js @@ -0,0 +1,477 @@ +var searchData= +[ + ['gamepad_20axes_0',['Gamepad axes',['../group__gamepad__axes.html',1,'']]], + ['gamepad_20buttons_1',['Gamepad buttons',['../group__gamepad__buttons.html',1,'']]], + ['getting_20started_2',['Getting started',['../quick_guide.html',1,'']]], + ['glapientry_3',['GLAPIENTRY',['../glfw3_8h.html#aa97755eb47e4bf2727ad45d610e18206',1,'glfw3.h']]], + ['glfw3_2eh_4',['glfw3.h',['../glfw3_8h.html',1,'']]], + ['glfw3native_2eh_5',['glfw3native.h',['../glfw3native_8h.html',1,'']]], + ['glfw_5faccum_5falpha_5fbits_6',['GLFW_ACCUM_ALPHA_BITS',['../group__window.html#gae829b55591c18169a40ab4067a041b1f',1,'glfw3.h']]], + ['glfw_5faccum_5fblue_5fbits_7',['GLFW_ACCUM_BLUE_BITS',['../group__window.html#ga22bbe9104a8ce1f8b88fb4f186aa36ce',1,'glfw3.h']]], + ['glfw_5faccum_5fgreen_5fbits_8',['GLFW_ACCUM_GREEN_BITS',['../group__window.html#ga65713cee1326f8e9d806fdf93187b471',1,'glfw3.h']]], + ['glfw_5faccum_5fred_5fbits_9',['GLFW_ACCUM_RED_BITS',['../group__window.html#gaead34a9a683b2bc20eecf30ba738bfc6',1,'glfw3.h']]], + ['glfw_5falpha_5fbits_10',['GLFW_ALPHA_BITS',['../group__window.html#gafed79a3f468997877da86c449bd43e8c',1,'glfw3.h']]], + ['glfw_5fany_5frelease_5fbehavior_11',['GLFW_ANY_RELEASE_BEHAVIOR',['../glfw3_8h.html#a6b47d806f285efe9bfd7aeec667297ee',1,'glfw3.h']]], + ['glfw_5fapi_5funavailable_12',['GLFW_API_UNAVAILABLE',['../group__errors.html#ga56882b290db23261cc6c053c40c2d08e',1,'glfw3.h']]], + ['glfw_5fapientry_5fdefined_13',['GLFW_APIENTRY_DEFINED',['../glfw3_8h.html#a8a8538c5500308b4211844f2fb26c7b9',1,'glfw3.h']]], + ['glfw_5farrow_5fcursor_14',['GLFW_ARROW_CURSOR',['../group__shapes.html#ga8ab0e717245b85506cb0eaefdea39d0a',1,'glfw3.h']]], + ['glfw_5fauto_5ficonify_15',['GLFW_AUTO_ICONIFY',['../group__window.html#ga9d9874fc928200136a6dcdad726aa252',1,'glfw3.h']]], + ['glfw_5faux_5fbuffers_16',['GLFW_AUX_BUFFERS',['../group__window.html#gab05108c5029443b371112b031d1fa174',1,'glfw3.h']]], + ['glfw_5fblue_5fbits_17',['GLFW_BLUE_BITS',['../group__window.html#gab292ea403db6d514537b515311bf9ae3',1,'glfw3.h']]], + ['glfw_5fcenter_5fcursor_18',['GLFW_CENTER_CURSOR',['../group__window.html#ga5ac0847c0aa0b3619f2855707b8a7a77',1,'glfw3.h']]], + ['glfw_5fclient_5fapi_19',['GLFW_CLIENT_API',['../group__window.html#ga649309cf72a3d3de5b1348ca7936c95b',1,'glfw3.h']]], + ['glfw_5fcocoa_5fchdir_5fresources_20',['GLFW_COCOA_CHDIR_RESOURCES',['../group__init.html#gab937983147a3158d45f88fad7129d9f2',1,'glfw3.h']]], + ['glfw_5fcocoa_5fframe_5fname_21',['GLFW_COCOA_FRAME_NAME',['../group__window.html#ga70fa0fbc745de6aa824df79a580e84b5',1,'glfw3.h']]], + ['glfw_5fcocoa_5fgraphics_5fswitching_22',['GLFW_COCOA_GRAPHICS_SWITCHING',['../group__window.html#ga53c84ed2ddd94e15bbd44b1f6f7feafc',1,'glfw3.h']]], + ['glfw_5fcocoa_5fmenubar_23',['GLFW_COCOA_MENUBAR',['../group__init.html#ga71e0b4ce2f2696a84a9b8c5e12dc70cf',1,'glfw3.h']]], + ['glfw_5fcocoa_5fretina_5fframebuffer_24',['GLFW_COCOA_RETINA_FRAMEBUFFER',['../group__window.html#gab6ef2d02eb55800d249ccf1af253c35e',1,'glfw3.h']]], + ['glfw_5fconnected_25',['GLFW_CONNECTED',['../glfw3_8h.html#abe11513fd1ffbee5bb9b173f06028b9e',1,'glfw3.h']]], + ['glfw_5fcontext_5fcreation_5fapi_26',['GLFW_CONTEXT_CREATION_API',['../group__window.html#ga5154cebfcd831c1cc63a4d5ac9bb4486',1,'glfw3.h']]], + ['glfw_5fcontext_5fno_5ferror_27',['GLFW_CONTEXT_NO_ERROR',['../group__window.html#ga5a52fdfd46d8249c211f923675728082',1,'glfw3.h']]], + ['glfw_5fcontext_5frelease_5fbehavior_28',['GLFW_CONTEXT_RELEASE_BEHAVIOR',['../group__window.html#ga72b648a8378fe3310c7c7bbecc0f7be6',1,'glfw3.h']]], + ['glfw_5fcontext_5frevision_29',['GLFW_CONTEXT_REVISION',['../group__window.html#gafb9475071aa77c6fb05ca5a5c8678a08',1,'glfw3.h']]], + ['glfw_5fcontext_5frobustness_30',['GLFW_CONTEXT_ROBUSTNESS',['../group__window.html#gade3593916b4c507900aa2d6844810e00',1,'glfw3.h']]], + ['glfw_5fcontext_5fversion_5fmajor_31',['GLFW_CONTEXT_VERSION_MAJOR',['../group__window.html#gafe5e4922de1f9932d7e9849bb053b0c0',1,'glfw3.h']]], + ['glfw_5fcontext_5fversion_5fminor_32',['GLFW_CONTEXT_VERSION_MINOR',['../group__window.html#ga31aca791e4b538c4e4a771eb95cc2d07',1,'glfw3.h']]], + ['glfw_5fcrosshair_5fcursor_33',['GLFW_CROSSHAIR_CURSOR',['../group__shapes.html#ga8af88c0ea05ab9e8f9ac1530e8873c22',1,'glfw3.h']]], + ['glfw_5fcursor_34',['GLFW_CURSOR',['../glfw3_8h.html#aade31da5b884a84a7625c6b059b9132c',1,'glfw3.h']]], + ['glfw_5fcursor_5fdisabled_35',['GLFW_CURSOR_DISABLED',['../glfw3_8h.html#a2315b99a329ce53e6a13a9d46fd5ca88',1,'glfw3.h']]], + ['glfw_5fcursor_5fhidden_36',['GLFW_CURSOR_HIDDEN',['../glfw3_8h.html#ac4d5cb9d78de8573349c58763d53bf11',1,'glfw3.h']]], + ['glfw_5fcursor_5fnormal_37',['GLFW_CURSOR_NORMAL',['../glfw3_8h.html#ae04dd25c8577e19fa8c97368561f6c68',1,'glfw3.h']]], + ['glfw_5fdecorated_38',['GLFW_DECORATED',['../group__window.html#ga21b854d36314c94d65aed84405b2f25e',1,'glfw3.h']]], + ['glfw_5fdepth_5fbits_39',['GLFW_DEPTH_BITS',['../group__window.html#ga318a55eac1fee57dfe593b6d38149d07',1,'glfw3.h']]], + ['glfw_5fdisconnected_40',['GLFW_DISCONNECTED',['../glfw3_8h.html#aab64b25921ef21d89252d6f0a71bfc32',1,'glfw3.h']]], + ['glfw_5fdont_5fcare_41',['GLFW_DONT_CARE',['../glfw3_8h.html#a7a2edf2c18446833d27d07f1b7f3d571',1,'glfw3.h']]], + ['glfw_5fdoublebuffer_42',['GLFW_DOUBLEBUFFER',['../group__window.html#ga714a5d569e8a274ea58fdfa020955339',1,'glfw3.h']]], + ['glfw_5fegl_5fcontext_5fapi_43',['GLFW_EGL_CONTEXT_API',['../glfw3_8h.html#a03cf65c9ab01fc8b872ba58842c531c9',1,'glfw3.h']]], + ['glfw_5ffalse_44',['GLFW_FALSE',['../group__init.html#gac877fe3b627d21ef3a0a23e0a73ba8c5',1,'glfw3.h']]], + ['glfw_5ffloating_45',['GLFW_FLOATING',['../group__window.html#ga7fb0be51407783b41adbf5bec0b09d80',1,'glfw3.h']]], + ['glfw_5ffocus_5fon_5fshow_46',['GLFW_FOCUS_ON_SHOW',['../group__window.html#gafa94b1da34bfd6488c0d709761504dfc',1,'glfw3.h']]], + ['glfw_5ffocused_47',['GLFW_FOCUSED',['../group__window.html#ga54ddb14825a1541a56e22afb5f832a9e',1,'glfw3.h']]], + ['glfw_5fformat_5funavailable_48',['GLFW_FORMAT_UNAVAILABLE',['../group__errors.html#ga196e125ef261d94184e2b55c05762f14',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5flast_49',['GLFW_GAMEPAD_AXIS_LAST',['../group__gamepad__axes.html#ga0818fd9433e1359692b7443293e5ac86',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fleft_5ftrigger_50',['GLFW_GAMEPAD_AXIS_LEFT_TRIGGER',['../group__gamepad__axes.html#ga6d79561dd8907c37354426242901b86e',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fleft_5fx_51',['GLFW_GAMEPAD_AXIS_LEFT_X',['../group__gamepad__axes.html#ga544e396d092036a7d80c1e5f233f7a38',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fleft_5fy_52',['GLFW_GAMEPAD_AXIS_LEFT_Y',['../group__gamepad__axes.html#ga64dcf2c6e9be50b7c556ff7671996dd5',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fright_5ftrigger_53',['GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER',['../group__gamepad__axes.html#ga121a7d5d20589a423cd1634dd6ee6eab',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fright_5fx_54',['GLFW_GAMEPAD_AXIS_RIGHT_X',['../group__gamepad__axes.html#gabd6785106cd3c5a044a6e49a395ee2fc',1,'glfw3.h']]], + ['glfw_5fgamepad_5faxis_5fright_5fy_55',['GLFW_GAMEPAD_AXIS_RIGHT_Y',['../group__gamepad__axes.html#ga1cc20566d44d521b7183681a8e88e2e4',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fa_56',['GLFW_GAMEPAD_BUTTON_A',['../group__gamepad__buttons.html#gae055a12fbf4b48b5954c8e1cd129b810',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fb_57',['GLFW_GAMEPAD_BUTTON_B',['../group__gamepad__buttons.html#ga2228a6512fd5950cdb51ba07846546fa',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fback_58',['GLFW_GAMEPAD_BUTTON_BACK',['../group__gamepad__buttons.html#gabc7c0264ce778835b516a472b47f6caf',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fcircle_59',['GLFW_GAMEPAD_BUTTON_CIRCLE',['../group__gamepad__buttons.html#gaaef094b3dacbf15f272b274516839b82',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fcross_60',['GLFW_GAMEPAD_BUTTON_CROSS',['../group__gamepad__buttons.html#gaf08d0df26527c9305253422bd98ed63a',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fdpad_5fdown_61',['GLFW_GAMEPAD_BUTTON_DPAD_DOWN',['../group__gamepad__buttons.html#ga8f2b731b97d80f90f11967a83207665c',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fdpad_5fleft_62',['GLFW_GAMEPAD_BUTTON_DPAD_LEFT',['../group__gamepad__buttons.html#gaf0697e0e8607b2ebe1c93b0c6befe301',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fdpad_5fright_63',['GLFW_GAMEPAD_BUTTON_DPAD_RIGHT',['../group__gamepad__buttons.html#gae2a780d2a8c79e0b77c0b7b601ca57c6',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fdpad_5fup_64',['GLFW_GAMEPAD_BUTTON_DPAD_UP',['../group__gamepad__buttons.html#ga4f1ed6f974a47bc8930d4874a283476a',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fguide_65',['GLFW_GAMEPAD_BUTTON_GUIDE',['../group__gamepad__buttons.html#ga7fa48c32e5b2f5db2f080aa0b8b573dc',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5flast_66',['GLFW_GAMEPAD_BUTTON_LAST',['../group__gamepad__buttons.html#ga5cc98882f4f81dacf761639a567f61eb',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fleft_5fbumper_67',['GLFW_GAMEPAD_BUTTON_LEFT_BUMPER',['../group__gamepad__buttons.html#ga17d67b4f39a39d6b813bd1567a3507c3',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fleft_5fthumb_68',['GLFW_GAMEPAD_BUTTON_LEFT_THUMB',['../group__gamepad__buttons.html#ga3e089787327454f7bfca7364d6ca206a',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fright_5fbumper_69',['GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER',['../group__gamepad__buttons.html#gadfbc9ea9bf3aae896b79fa49fdc85c7f',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fright_5fthumb_70',['GLFW_GAMEPAD_BUTTON_RIGHT_THUMB',['../group__gamepad__buttons.html#ga1c003f52b5aebb45272475b48953b21a',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fsquare_71',['GLFW_GAMEPAD_BUTTON_SQUARE',['../group__gamepad__buttons.html#gafc7821e87d77d41ed2cd3e1f726ec35f',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fstart_72',['GLFW_GAMEPAD_BUTTON_START',['../group__gamepad__buttons.html#ga04606949dd9139434b8a1bedf4ac1021',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5ftriangle_73',['GLFW_GAMEPAD_BUTTON_TRIANGLE',['../group__gamepad__buttons.html#ga3a7ef6bcb768a08cd3bf142f7f09f802',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fx_74',['GLFW_GAMEPAD_BUTTON_X',['../group__gamepad__buttons.html#ga52cc94785cf3fe9a12e246539259887c',1,'glfw3.h']]], + ['glfw_5fgamepad_5fbutton_5fy_75',['GLFW_GAMEPAD_BUTTON_Y',['../group__gamepad__buttons.html#gafc931248bda494b530cbe057f386a5ed',1,'glfw3.h']]], + ['glfw_5fglapientry_5fdefined_76',['GLFW_GLAPIENTRY_DEFINED',['../glfw3_8h.html#a3b526ac796be993406ea2f1642c25fc3',1,'glfw3.h']]], + ['glfw_5fgreen_5fbits_77',['GLFW_GREEN_BITS',['../group__window.html#gafba3b72638c914e5fb8a237dd4c50d4d',1,'glfw3.h']]], + ['glfw_5fhand_5fcursor_78',['GLFW_HAND_CURSOR',['../group__shapes.html#ga1db35e20849e0837c82e3dc1fd797263',1,'glfw3.h']]], + ['glfw_5fhat_5fcentered_79',['GLFW_HAT_CENTERED',['../group__hat__state.html#gae2c0bcb7aec609e4736437554f6638fd',1,'glfw3.h']]], + ['glfw_5fhat_5fdown_80',['GLFW_HAT_DOWN',['../group__hat__state.html#gad60d1fd0dc85c18f2642cbae96d3deff',1,'glfw3.h']]], + ['glfw_5fhat_5fleft_81',['GLFW_HAT_LEFT',['../group__hat__state.html#gac775f4b3154fdf5db93eb432ba546dff',1,'glfw3.h']]], + ['glfw_5fhat_5fleft_5fdown_82',['GLFW_HAT_LEFT_DOWN',['../group__hat__state.html#ga76c02baf1ea345fcbe3e8ff176a73e19',1,'glfw3.h']]], + ['glfw_5fhat_5fleft_5fup_83',['GLFW_HAT_LEFT_UP',['../group__hat__state.html#ga638f0e20dc5de90de21a33564e8ce129',1,'glfw3.h']]], + ['glfw_5fhat_5fright_84',['GLFW_HAT_RIGHT',['../group__hat__state.html#ga252586e3bbde75f4b0e07ad3124867f5',1,'glfw3.h']]], + ['glfw_5fhat_5fright_5fdown_85',['GLFW_HAT_RIGHT_DOWN',['../group__hat__state.html#gad7f0e4f52fd68d734863aaeadab3a3f5',1,'glfw3.h']]], + ['glfw_5fhat_5fright_5fup_86',['GLFW_HAT_RIGHT_UP',['../group__hat__state.html#ga94aea0ae241a8b902883536c592ee693',1,'glfw3.h']]], + ['glfw_5fhat_5fup_87',['GLFW_HAT_UP',['../group__hat__state.html#ga8c9720c76cd1b912738159ed74c85b36',1,'glfw3.h']]], + ['glfw_5fhovered_88',['GLFW_HOVERED',['../group__window.html#ga8665c71c6fa3d22425c6a0e8a3f89d8a',1,'glfw3.h']]], + ['glfw_5fhresize_5fcursor_89',['GLFW_HRESIZE_CURSOR',['../group__shapes.html#gabb3eb0109f11bb808fc34659177ca962',1,'glfw3.h']]], + ['glfw_5fibeam_5fcursor_90',['GLFW_IBEAM_CURSOR',['../group__shapes.html#ga36185f4375eaada1b04e431244774c86',1,'glfw3.h']]], + ['glfw_5ficonified_91',['GLFW_ICONIFIED',['../group__window.html#ga39d44b7c056e55e581355a92d240b58a',1,'glfw3.h']]], + ['glfw_5finvalid_5fenum_92',['GLFW_INVALID_ENUM',['../group__errors.html#ga76f6bb9c4eea73db675f096b404593ce',1,'glfw3.h']]], + ['glfw_5finvalid_5fvalue_93',['GLFW_INVALID_VALUE',['../group__errors.html#gaaf2ef9aa8202c2b82ac2d921e554c687',1,'glfw3.h']]], + ['glfw_5fjoystick_5f1_94',['GLFW_JOYSTICK_1',['../group__joysticks.html#ga34a0443d059e9f22272cd4669073f73d',1,'glfw3.h']]], + ['glfw_5fjoystick_5f10_95',['GLFW_JOYSTICK_10',['../group__joysticks.html#gaef55389ee605d6dfc31aef6fe98c54ec',1,'glfw3.h']]], + ['glfw_5fjoystick_5f11_96',['GLFW_JOYSTICK_11',['../group__joysticks.html#gae7d26e3df447c2c14a569fcc18516af4',1,'glfw3.h']]], + ['glfw_5fjoystick_5f12_97',['GLFW_JOYSTICK_12',['../group__joysticks.html#gab91bbf5b7ca6be8d3ac5c4d89ff48ac7',1,'glfw3.h']]], + ['glfw_5fjoystick_5f13_98',['GLFW_JOYSTICK_13',['../group__joysticks.html#ga5c84fb4e49bf661d7d7c78eb4018c508',1,'glfw3.h']]], + ['glfw_5fjoystick_5f14_99',['GLFW_JOYSTICK_14',['../group__joysticks.html#ga89540873278ae5a42b3e70d64164dc74',1,'glfw3.h']]], + ['glfw_5fjoystick_5f15_100',['GLFW_JOYSTICK_15',['../group__joysticks.html#ga7b02ab70daf7a78bcc942d5d4cc1dcf9',1,'glfw3.h']]], + ['glfw_5fjoystick_5f16_101',['GLFW_JOYSTICK_16',['../group__joysticks.html#ga453edeeabf350827646b6857df4f80ce',1,'glfw3.h']]], + ['glfw_5fjoystick_5f2_102',['GLFW_JOYSTICK_2',['../group__joysticks.html#ga6eab65ec88e65e0850ef8413504cb50c',1,'glfw3.h']]], + ['glfw_5fjoystick_5f3_103',['GLFW_JOYSTICK_3',['../group__joysticks.html#gae6f3eedfeb42424c2f5e3161efb0b654',1,'glfw3.h']]], + ['glfw_5fjoystick_5f4_104',['GLFW_JOYSTICK_4',['../group__joysticks.html#ga97ddbcad02b7f48d74fad4ddb08fff59',1,'glfw3.h']]], + ['glfw_5fjoystick_5f5_105',['GLFW_JOYSTICK_5',['../group__joysticks.html#gae43281bc66d3fa5089fb50c3e7a28695',1,'glfw3.h']]], + ['glfw_5fjoystick_5f6_106',['GLFW_JOYSTICK_6',['../group__joysticks.html#ga74771620aa53bd68a487186dea66fd77',1,'glfw3.h']]], + ['glfw_5fjoystick_5f7_107',['GLFW_JOYSTICK_7',['../group__joysticks.html#ga20a9f4f3aaefed9ea5e66072fc588b87',1,'glfw3.h']]], + ['glfw_5fjoystick_5f8_108',['GLFW_JOYSTICK_8',['../group__joysticks.html#ga21a934c940bcf25db0e4c8fe9b364bdb',1,'glfw3.h']]], + ['glfw_5fjoystick_5f9_109',['GLFW_JOYSTICK_9',['../group__joysticks.html#ga87689d47df0ba6f9f5fcbbcaf7b3cecf',1,'glfw3.h']]], + ['glfw_5fjoystick_5fhat_5fbuttons_110',['GLFW_JOYSTICK_HAT_BUTTONS',['../group__init.html#gab9c0534709fda03ec8959201da3a9a18',1,'glfw3.h']]], + ['glfw_5fjoystick_5flast_111',['GLFW_JOYSTICK_LAST',['../group__joysticks.html#ga9ca13ebf24c331dd98df17d84a4b72c9',1,'glfw3.h']]], + ['glfw_5fkey_5f0_112',['GLFW_KEY_0',['../group__keys.html#ga50391730e9d7112ad4fd42d0bd1597c1',1,'glfw3.h']]], + ['glfw_5fkey_5f1_113',['GLFW_KEY_1',['../group__keys.html#ga05e4cae9ddb8d40cf6d82c8f11f2502f',1,'glfw3.h']]], + ['glfw_5fkey_5f2_114',['GLFW_KEY_2',['../group__keys.html#gadc8e66b3a4c4b5c39ad1305cf852863c',1,'glfw3.h']]], + ['glfw_5fkey_5f3_115',['GLFW_KEY_3',['../group__keys.html#ga812f0273fe1a981e1fa002ae73e92271',1,'glfw3.h']]], + ['glfw_5fkey_5f4_116',['GLFW_KEY_4',['../group__keys.html#ga9e14b6975a9cc8f66cdd5cb3d3861356',1,'glfw3.h']]], + ['glfw_5fkey_5f5_117',['GLFW_KEY_5',['../group__keys.html#ga4d74ddaa5d4c609993b4d4a15736c924',1,'glfw3.h']]], + ['glfw_5fkey_5f6_118',['GLFW_KEY_6',['../group__keys.html#ga9ea4ab80c313a227b14d0a7c6f810b5d',1,'glfw3.h']]], + ['glfw_5fkey_5f7_119',['GLFW_KEY_7',['../group__keys.html#gab79b1cfae7bd630cfc4604c1f263c666',1,'glfw3.h']]], + ['glfw_5fkey_5f8_120',['GLFW_KEY_8',['../group__keys.html#gadeaa109a0f9f5afc94fe4a108e686f6f',1,'glfw3.h']]], + ['glfw_5fkey_5f9_121',['GLFW_KEY_9',['../group__keys.html#ga2924cb5349ebbf97c8987f3521c44f39',1,'glfw3.h']]], + ['glfw_5fkey_5fa_122',['GLFW_KEY_A',['../group__keys.html#ga03e842608e1ea323370889d33b8f70ff',1,'glfw3.h']]], + ['glfw_5fkey_5fapostrophe_123',['GLFW_KEY_APOSTROPHE',['../group__keys.html#ga6059b0b048ba6980b6107fffbd3b4b24',1,'glfw3.h']]], + ['glfw_5fkey_5fb_124',['GLFW_KEY_B',['../group__keys.html#ga8e3fb647ff3aca9e8dbf14fe66332941',1,'glfw3.h']]], + ['glfw_5fkey_5fbackslash_125',['GLFW_KEY_BACKSLASH',['../group__keys.html#gab8155ea99d1ab27ff56f24f8dc73f8d1',1,'glfw3.h']]], + ['glfw_5fkey_5fbackspace_126',['GLFW_KEY_BACKSPACE',['../group__keys.html#ga6c0df1fe2f156bbd5a98c66d76ff3635',1,'glfw3.h']]], + ['glfw_5fkey_5fc_127',['GLFW_KEY_C',['../group__keys.html#ga00ccf3475d9ee2e679480d540d554669',1,'glfw3.h']]], + ['glfw_5fkey_5fcaps_5flock_128',['GLFW_KEY_CAPS_LOCK',['../group__keys.html#ga92c1d2c9d63485f3d70f94f688d48672',1,'glfw3.h']]], + ['glfw_5fkey_5fcomma_129',['GLFW_KEY_COMMA',['../group__keys.html#gab3d5d72e59d3055f494627b0a524926c',1,'glfw3.h']]], + ['glfw_5fkey_5fd_130',['GLFW_KEY_D',['../group__keys.html#ga011f7cdc9a654da984a2506479606933',1,'glfw3.h']]], + ['glfw_5fkey_5fdelete_131',['GLFW_KEY_DELETE',['../group__keys.html#gadb111e4df74b8a715f2c05dad58d2682',1,'glfw3.h']]], + ['glfw_5fkey_5fdown_132',['GLFW_KEY_DOWN',['../group__keys.html#gae2e3958c71595607416aa7bf082be2f9',1,'glfw3.h']]], + ['glfw_5fkey_5fe_133',['GLFW_KEY_E',['../group__keys.html#gabf48fcc3afbe69349df432b470c96ef2',1,'glfw3.h']]], + ['glfw_5fkey_5fend_134',['GLFW_KEY_END',['../group__keys.html#ga86587ea1df19a65978d3e3b8439bedd9',1,'glfw3.h']]], + ['glfw_5fkey_5fenter_135',['GLFW_KEY_ENTER',['../group__keys.html#ga9555a92ecbecdbc1f3435219c571d667',1,'glfw3.h']]], + ['glfw_5fkey_5fequal_136',['GLFW_KEY_EQUAL',['../group__keys.html#gae1a2de47240d6664423c204bdd91bd17',1,'glfw3.h']]], + ['glfw_5fkey_5fescape_137',['GLFW_KEY_ESCAPE',['../group__keys.html#gaac6596c350b635c245113b81c2123b93',1,'glfw3.h']]], + ['glfw_5fkey_5ff_138',['GLFW_KEY_F',['../group__keys.html#ga5df402e02aca08444240058fd9b42a55',1,'glfw3.h']]], + ['glfw_5fkey_5ff1_139',['GLFW_KEY_F1',['../group__keys.html#gafb8d66c573acf22e364049477dcbea30',1,'glfw3.h']]], + ['glfw_5fkey_5ff10_140',['GLFW_KEY_F10',['../group__keys.html#ga718d11d2f7d57471a2f6a894235995b1',1,'glfw3.h']]], + ['glfw_5fkey_5ff11_141',['GLFW_KEY_F11',['../group__keys.html#ga0bc04b11627e7d69339151e7306b2832',1,'glfw3.h']]], + ['glfw_5fkey_5ff12_142',['GLFW_KEY_F12',['../group__keys.html#gaf5908fa9b0a906ae03fc2c61ac7aa3e2',1,'glfw3.h']]], + ['glfw_5fkey_5ff13_143',['GLFW_KEY_F13',['../group__keys.html#gad637f4308655e1001bd6ad942bc0fd4b',1,'glfw3.h']]], + ['glfw_5fkey_5ff14_144',['GLFW_KEY_F14',['../group__keys.html#gaf14c66cff3396e5bd46e803c035e6c1f',1,'glfw3.h']]], + ['glfw_5fkey_5ff15_145',['GLFW_KEY_F15',['../group__keys.html#ga7f70970db6e8be1794da8516a6d14058',1,'glfw3.h']]], + ['glfw_5fkey_5ff16_146',['GLFW_KEY_F16',['../group__keys.html#gaa582dbb1d2ba2050aa1dca0838095b27',1,'glfw3.h']]], + ['glfw_5fkey_5ff17_147',['GLFW_KEY_F17',['../group__keys.html#ga972ce5c365e2394b36104b0e3125c748',1,'glfw3.h']]], + ['glfw_5fkey_5ff18_148',['GLFW_KEY_F18',['../group__keys.html#gaebf6391058d5566601e357edc5ea737c',1,'glfw3.h']]], + ['glfw_5fkey_5ff19_149',['GLFW_KEY_F19',['../group__keys.html#gaec011d9ba044058cb54529da710e9791',1,'glfw3.h']]], + ['glfw_5fkey_5ff2_150',['GLFW_KEY_F2',['../group__keys.html#ga0900750aff94889b940f5e428c07daee',1,'glfw3.h']]], + ['glfw_5fkey_5ff20_151',['GLFW_KEY_F20',['../group__keys.html#ga82b9c721ada04cd5ca8de767da38022f',1,'glfw3.h']]], + ['glfw_5fkey_5ff21_152',['GLFW_KEY_F21',['../group__keys.html#ga356afb14d3440ff2bb378f74f7ebc60f',1,'glfw3.h']]], + ['glfw_5fkey_5ff22_153',['GLFW_KEY_F22',['../group__keys.html#ga90960bd2a155f2b09675324d3dff1565',1,'glfw3.h']]], + ['glfw_5fkey_5ff23_154',['GLFW_KEY_F23',['../group__keys.html#ga43c21099aac10952d1be909a8ddee4d5',1,'glfw3.h']]], + ['glfw_5fkey_5ff24_155',['GLFW_KEY_F24',['../group__keys.html#ga8150374677b5bed3043408732152dea2',1,'glfw3.h']]], + ['glfw_5fkey_5ff25_156',['GLFW_KEY_F25',['../group__keys.html#gaa4bbd93ed73bb4c6ae7d83df880b7199',1,'glfw3.h']]], + ['glfw_5fkey_5ff3_157',['GLFW_KEY_F3',['../group__keys.html#gaed7cd729c0147a551bb8b7bb36c17015',1,'glfw3.h']]], + ['glfw_5fkey_5ff4_158',['GLFW_KEY_F4',['../group__keys.html#ga9b61ebd0c63b44b7332fda2c9763eaa6',1,'glfw3.h']]], + ['glfw_5fkey_5ff5_159',['GLFW_KEY_F5',['../group__keys.html#gaf258dda9947daa428377938ed577c8c2',1,'glfw3.h']]], + ['glfw_5fkey_5ff6_160',['GLFW_KEY_F6',['../group__keys.html#ga6dc2d3f87b9d51ffbbbe2ef0299d8e1d',1,'glfw3.h']]], + ['glfw_5fkey_5ff7_161',['GLFW_KEY_F7',['../group__keys.html#gacca6ef8a2162c52a0ac1d881e8d9c38a',1,'glfw3.h']]], + ['glfw_5fkey_5ff8_162',['GLFW_KEY_F8',['../group__keys.html#gac9d39390336ae14e4a93e295de43c7e8',1,'glfw3.h']]], + ['glfw_5fkey_5ff9_163',['GLFW_KEY_F9',['../group__keys.html#gae40de0de1c9f21cd26c9afa3d7050851',1,'glfw3.h']]], + ['glfw_5fkey_5fg_164',['GLFW_KEY_G',['../group__keys.html#gae74ecddf7cc96104ab23989b1cdab536',1,'glfw3.h']]], + ['glfw_5fkey_5fgrave_5faccent_165',['GLFW_KEY_GRAVE_ACCENT',['../group__keys.html#ga7a3701fb4e2a0b136ff4b568c3c8d668',1,'glfw3.h']]], + ['glfw_5fkey_5fh_166',['GLFW_KEY_H',['../group__keys.html#gad4cc98fc8f35f015d9e2fb94bf136076',1,'glfw3.h']]], + ['glfw_5fkey_5fhome_167',['GLFW_KEY_HOME',['../group__keys.html#ga41452c7287195d481e43207318c126a7',1,'glfw3.h']]], + ['glfw_5fkey_5fi_168',['GLFW_KEY_I',['../group__keys.html#ga274655c8bfe39742684ca393cf8ed093',1,'glfw3.h']]], + ['glfw_5fkey_5finsert_169',['GLFW_KEY_INSERT',['../group__keys.html#ga373ac7365435d6b0eb1068f470e34f47',1,'glfw3.h']]], + ['glfw_5fkey_5fj_170',['GLFW_KEY_J',['../group__keys.html#ga65ff2aedb129a3149ad9cb3e4159a75f',1,'glfw3.h']]], + ['glfw_5fkey_5fk_171',['GLFW_KEY_K',['../group__keys.html#ga4ae8debadf6d2a691badae0b53ea3ba0',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f0_172',['GLFW_KEY_KP_0',['../group__keys.html#ga10515dafc55b71e7683f5b4fedd1c70d',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f1_173',['GLFW_KEY_KP_1',['../group__keys.html#gaf3a29a334402c5eaf0b3439edf5587c3',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f2_174',['GLFW_KEY_KP_2',['../group__keys.html#gaf82d5a802ab8213c72653d7480c16f13',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f3_175',['GLFW_KEY_KP_3',['../group__keys.html#ga7e25ff30d56cd512828c1d4ae8d54ef2',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f4_176',['GLFW_KEY_KP_4',['../group__keys.html#gada7ec86778b85e0b4de0beea72234aea',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f5_177',['GLFW_KEY_KP_5',['../group__keys.html#ga9a5be274434866c51738cafbb6d26b45',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f6_178',['GLFW_KEY_KP_6',['../group__keys.html#gafc141b0f8450519084c01092a3157faa',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f7_179',['GLFW_KEY_KP_7',['../group__keys.html#ga8882f411f05d04ec77a9563974bbfa53',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f8_180',['GLFW_KEY_KP_8',['../group__keys.html#gab2ea2e6a12f89d315045af520ac78cec',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5f9_181',['GLFW_KEY_KP_9',['../group__keys.html#gafb21426b630ed4fcc084868699ba74c1',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fadd_182',['GLFW_KEY_KP_ADD',['../group__keys.html#gad09c7c98acc79e89aa6a0a91275becac',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fdecimal_183',['GLFW_KEY_KP_DECIMAL',['../group__keys.html#ga4e231d968796331a9ea0dbfb98d4005b',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fdivide_184',['GLFW_KEY_KP_DIVIDE',['../group__keys.html#gabca1733780a273d549129ad0f250d1e5',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fenter_185',['GLFW_KEY_KP_ENTER',['../group__keys.html#ga4f728f8738f2986bd63eedd3d412e8cf',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fequal_186',['GLFW_KEY_KP_EQUAL',['../group__keys.html#gaebdc76d4a808191e6d21b7e4ad2acd97',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fmultiply_187',['GLFW_KEY_KP_MULTIPLY',['../group__keys.html#ga9ada267eb0e78ed2ada8701dd24a56ef',1,'glfw3.h']]], + ['glfw_5fkey_5fkp_5fsubtract_188',['GLFW_KEY_KP_SUBTRACT',['../group__keys.html#gaa3dbd60782ff93d6082a124bce1fa236',1,'glfw3.h']]], + ['glfw_5fkey_5fl_189',['GLFW_KEY_L',['../group__keys.html#gaaa8b54a13f6b1eed85ac86f82d550db2',1,'glfw3.h']]], + ['glfw_5fkey_5flast_190',['GLFW_KEY_LAST',['../group__keys.html#ga442cbaef7bfb9a4ba13594dd7fbf2789',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_191',['GLFW_KEY_LEFT',['../group__keys.html#gae12a010d33c309a67ab9460c51eb2462',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_5falt_192',['GLFW_KEY_LEFT_ALT',['../group__keys.html#ga7f27dabf63a7789daa31e1c96790219b',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_5fbracket_193',['GLFW_KEY_LEFT_BRACKET',['../group__keys.html#gad1c8d9adac53925276ecb1d592511d8a',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_5fcontrol_194',['GLFW_KEY_LEFT_CONTROL',['../group__keys.html#ga9f97b743e81460ac4b2deddecd10a464',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_5fshift_195',['GLFW_KEY_LEFT_SHIFT',['../group__keys.html#ga8a530a28a65c44ab5d00b759b756d3f6',1,'glfw3.h']]], + ['glfw_5fkey_5fleft_5fsuper_196',['GLFW_KEY_LEFT_SUPER',['../group__keys.html#gafb1207c91997fc295afd1835fbc5641a',1,'glfw3.h']]], + ['glfw_5fkey_5fm_197',['GLFW_KEY_M',['../group__keys.html#ga4d7f0260c82e4ea3d6ebc7a21d6e3716',1,'glfw3.h']]], + ['glfw_5fkey_5fmenu_198',['GLFW_KEY_MENU',['../group__keys.html#ga9845be48a745fc232045c9ec174d8820',1,'glfw3.h']]], + ['glfw_5fkey_5fminus_199',['GLFW_KEY_MINUS',['../group__keys.html#gac556b360f7f6fca4b70ba0aecf313fd4',1,'glfw3.h']]], + ['glfw_5fkey_5fn_200',['GLFW_KEY_N',['../group__keys.html#gae00856dfeb5d13aafebf59d44de5cdda',1,'glfw3.h']]], + ['glfw_5fkey_5fnum_5flock_201',['GLFW_KEY_NUM_LOCK',['../group__keys.html#ga3946edc362aeff213b2be6304296cf43',1,'glfw3.h']]], + ['glfw_5fkey_5fo_202',['GLFW_KEY_O',['../group__keys.html#gaecbbb79130df419d58dd7f09a169efe9',1,'glfw3.h']]], + ['glfw_5fkey_5fp_203',['GLFW_KEY_P',['../group__keys.html#ga8fc15819c1094fb2afa01d84546b33e1',1,'glfw3.h']]], + ['glfw_5fkey_5fpage_5fdown_204',['GLFW_KEY_PAGE_DOWN',['../group__keys.html#gaee0a8fa442001cc2147812f84b59041c',1,'glfw3.h']]], + ['glfw_5fkey_5fpage_5fup_205',['GLFW_KEY_PAGE_UP',['../group__keys.html#ga3ab731f9622f0db280178a5f3cc6d586',1,'glfw3.h']]], + ['glfw_5fkey_5fpause_206',['GLFW_KEY_PAUSE',['../group__keys.html#ga8116b9692d87382afb5849b6d8907f18',1,'glfw3.h']]], + ['glfw_5fkey_5fperiod_207',['GLFW_KEY_PERIOD',['../group__keys.html#ga37e296b650eab419fc474ff69033d927',1,'glfw3.h']]], + ['glfw_5fkey_5fprint_5fscreen_208',['GLFW_KEY_PRINT_SCREEN',['../group__keys.html#gaf964c2e65e97d0cf785a5636ee8df642',1,'glfw3.h']]], + ['glfw_5fkey_5fq_209',['GLFW_KEY_Q',['../group__keys.html#gafdd01e38b120d67cf51e348bb47f3964',1,'glfw3.h']]], + ['glfw_5fkey_5fr_210',['GLFW_KEY_R',['../group__keys.html#ga4ce6c70a0c98c50b3fe4ab9a728d4d36',1,'glfw3.h']]], + ['glfw_5fkey_5fright_211',['GLFW_KEY_RIGHT',['../group__keys.html#ga06ba07662e8c291a4a84535379ffc7ac',1,'glfw3.h']]], + ['glfw_5fkey_5fright_5falt_212',['GLFW_KEY_RIGHT_ALT',['../group__keys.html#ga687b38009131cfdd07a8d05fff8fa446',1,'glfw3.h']]], + ['glfw_5fkey_5fright_5fbracket_213',['GLFW_KEY_RIGHT_BRACKET',['../group__keys.html#ga86ef225fd6a66404caae71044cdd58d8',1,'glfw3.h']]], + ['glfw_5fkey_5fright_5fcontrol_214',['GLFW_KEY_RIGHT_CONTROL',['../group__keys.html#gad1ca2094b2694e7251d0ab1fd34f8519',1,'glfw3.h']]], + ['glfw_5fkey_5fright_5fshift_215',['GLFW_KEY_RIGHT_SHIFT',['../group__keys.html#gaffca36b99c9dce1a19cb9befbadce691',1,'glfw3.h']]], + ['glfw_5fkey_5fright_5fsuper_216',['GLFW_KEY_RIGHT_SUPER',['../group__keys.html#gad4547a3e8e247594acb60423fe6502db',1,'glfw3.h']]], + ['glfw_5fkey_5fs_217',['GLFW_KEY_S',['../group__keys.html#ga1570e2ccaab036ea82bed66fc1dab2a9',1,'glfw3.h']]], + ['glfw_5fkey_5fscroll_5flock_218',['GLFW_KEY_SCROLL_LOCK',['../group__keys.html#gaf622b63b9537f7084c2ab649b8365630',1,'glfw3.h']]], + ['glfw_5fkey_5fsemicolon_219',['GLFW_KEY_SEMICOLON',['../group__keys.html#ga84233de9ee5bb3e8788a5aa07d80af7d',1,'glfw3.h']]], + ['glfw_5fkey_5fslash_220',['GLFW_KEY_SLASH',['../group__keys.html#gadf3d753b2d479148d711de34b83fd0db',1,'glfw3.h']]], + ['glfw_5fkey_5fspace_221',['GLFW_KEY_SPACE',['../group__keys.html#gaddb2c23772b97fd7e26e8ee66f1ad014',1,'glfw3.h']]], + ['glfw_5fkey_5ft_222',['GLFW_KEY_T',['../group__keys.html#ga90e0560422ec7a30e7f3f375bc9f37f9',1,'glfw3.h']]], + ['glfw_5fkey_5ftab_223',['GLFW_KEY_TAB',['../group__keys.html#ga6908a4bda9950a3e2b73f794bbe985df',1,'glfw3.h']]], + ['glfw_5fkey_5fu_224',['GLFW_KEY_U',['../group__keys.html#gacad52f3bf7d378fc0ffa72a76769256d',1,'glfw3.h']]], + ['glfw_5fkey_5funknown_225',['GLFW_KEY_UNKNOWN',['../group__keys.html#ga99aacc875b6b27a072552631e13775c7',1,'glfw3.h']]], + ['glfw_5fkey_5fup_226',['GLFW_KEY_UP',['../group__keys.html#ga2f3342b194020d3544c67e3506b6f144',1,'glfw3.h']]], + ['glfw_5fkey_5fv_227',['GLFW_KEY_V',['../group__keys.html#ga22c7763899ecf7788862e5f90eacce6b',1,'glfw3.h']]], + ['glfw_5fkey_5fw_228',['GLFW_KEY_W',['../group__keys.html#gaa06a712e6202661fc03da5bdb7b6e545',1,'glfw3.h']]], + ['glfw_5fkey_5fworld_5f1_229',['GLFW_KEY_WORLD_1',['../group__keys.html#gadc78dad3dab76bcd4b5c20114052577a',1,'glfw3.h']]], + ['glfw_5fkey_5fworld_5f2_230',['GLFW_KEY_WORLD_2',['../group__keys.html#ga20494bfebf0bb4fc9503afca18ab2c5e',1,'glfw3.h']]], + ['glfw_5fkey_5fx_231',['GLFW_KEY_X',['../group__keys.html#gac1c42c0bf4192cea713c55598b06b744',1,'glfw3.h']]], + ['glfw_5fkey_5fy_232',['GLFW_KEY_Y',['../group__keys.html#gafd9f115a549effdf8e372a787c360313',1,'glfw3.h']]], + ['glfw_5fkey_5fz_233',['GLFW_KEY_Z',['../group__keys.html#gac489e208c26afda8d4938ed88718760a',1,'glfw3.h']]], + ['glfw_5flock_5fkey_5fmods_234',['GLFW_LOCK_KEY_MODS',['../glfw3_8h.html#a07b84de0b52143e1958f88a7d9105947',1,'glfw3.h']]], + ['glfw_5flose_5fcontext_5fon_5freset_235',['GLFW_LOSE_CONTEXT_ON_RESET',['../glfw3_8h.html#aec1132f245143fc915b2f0995228564c',1,'glfw3.h']]], + ['glfw_5fmaximized_236',['GLFW_MAXIMIZED',['../group__window.html#gad8ccb396253ad0b72c6d4c917eb38a03',1,'glfw3.h']]], + ['glfw_5fmod_5falt_237',['GLFW_MOD_ALT',['../group__mods.html#gad2acd5633463c29e07008687ea73c0f4',1,'glfw3.h']]], + ['glfw_5fmod_5fcaps_5flock_238',['GLFW_MOD_CAPS_LOCK',['../group__mods.html#gaefeef8fcf825a6e43e241b337897200f',1,'glfw3.h']]], + ['glfw_5fmod_5fcontrol_239',['GLFW_MOD_CONTROL',['../group__mods.html#ga6ed94871c3208eefd85713fa929d45aa',1,'glfw3.h']]], + ['glfw_5fmod_5fnum_5flock_240',['GLFW_MOD_NUM_LOCK',['../group__mods.html#ga64e020b8a42af8376e944baf61feecbe',1,'glfw3.h']]], + ['glfw_5fmod_5fshift_241',['GLFW_MOD_SHIFT',['../group__mods.html#ga14994d3196c290aaa347248e51740274',1,'glfw3.h']]], + ['glfw_5fmod_5fsuper_242',['GLFW_MOD_SUPER',['../group__mods.html#ga6b64ba10ea0227cf6f42efd0a220aba1',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f1_243',['GLFW_MOUSE_BUTTON_1',['../group__buttons.html#ga181a6e875251fd8671654eff00f9112e',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f2_244',['GLFW_MOUSE_BUTTON_2',['../group__buttons.html#ga604b39b92c88ce9bd332e97fc3f4156c',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f3_245',['GLFW_MOUSE_BUTTON_3',['../group__buttons.html#ga0130d505563d0236a6f85545f19e1721',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f4_246',['GLFW_MOUSE_BUTTON_4',['../group__buttons.html#ga53f4097bb01d5521c7d9513418c91ca9',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f5_247',['GLFW_MOUSE_BUTTON_5',['../group__buttons.html#gaf08c4ddecb051d3d9667db1d5e417c9c',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f6_248',['GLFW_MOUSE_BUTTON_6',['../group__buttons.html#gae8513e06aab8aa393b595f22c6d8257a',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f7_249',['GLFW_MOUSE_BUTTON_7',['../group__buttons.html#ga8b02a1ab55dde45b3a3883d54ffd7dc7',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5f8_250',['GLFW_MOUSE_BUTTON_8',['../group__buttons.html#ga35d5c4263e0dc0d0a4731ca6c562f32c',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5flast_251',['GLFW_MOUSE_BUTTON_LAST',['../group__buttons.html#gab1fd86a4518a9141ec7bcde2e15a2fdf',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5fleft_252',['GLFW_MOUSE_BUTTON_LEFT',['../group__buttons.html#gaf37100431dcd5082d48f95ee8bc8cd56',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5fmiddle_253',['GLFW_MOUSE_BUTTON_MIDDLE',['../group__buttons.html#ga34a4d2a701434f763fd93a2ff842b95a',1,'glfw3.h']]], + ['glfw_5fmouse_5fbutton_5fright_254',['GLFW_MOUSE_BUTTON_RIGHT',['../group__buttons.html#ga3e2f2cf3c4942df73cc094247d275e74',1,'glfw3.h']]], + ['glfw_5fnative_5fcontext_5fapi_255',['GLFW_NATIVE_CONTEXT_API',['../glfw3_8h.html#a0494c9bfd3f584ab41e6dbeeaa0e6a19',1,'glfw3.h']]], + ['glfw_5fno_5fapi_256',['GLFW_NO_API',['../glfw3_8h.html#a8f6dcdc968d214ff14779564f1389264',1,'glfw3.h']]], + ['glfw_5fno_5fcurrent_5fcontext_257',['GLFW_NO_CURRENT_CONTEXT',['../group__errors.html#gaa8290386e9528ccb9e42a3a4e16fc0d0',1,'glfw3.h']]], + ['glfw_5fno_5ferror_258',['GLFW_NO_ERROR',['../group__errors.html#gafa30deee5db4d69c4c93d116ed87dbf4',1,'glfw3.h']]], + ['glfw_5fno_5freset_5fnotification_259',['GLFW_NO_RESET_NOTIFICATION',['../glfw3_8h.html#aee84a679230d205005e22487ff678a85',1,'glfw3.h']]], + ['glfw_5fno_5frobustness_260',['GLFW_NO_ROBUSTNESS',['../glfw3_8h.html#a8b306cb27f5bb0d6d67c7356a0e0fc34',1,'glfw3.h']]], + ['glfw_5fno_5fwindow_5fcontext_261',['GLFW_NO_WINDOW_CONTEXT',['../group__errors.html#gacff24d2757da752ae4c80bf452356487',1,'glfw3.h']]], + ['glfw_5fnot_5finitialized_262',['GLFW_NOT_INITIALIZED',['../group__errors.html#ga2374ee02c177f12e1fa76ff3ed15e14a',1,'glfw3.h']]], + ['glfw_5fopengl_5fany_5fprofile_263',['GLFW_OPENGL_ANY_PROFILE',['../glfw3_8h.html#ad6f2335d6f21cc9bab96633b1c111d5f',1,'glfw3.h']]], + ['glfw_5fopengl_5fapi_264',['GLFW_OPENGL_API',['../glfw3_8h.html#a01b3f66db266341425e9abee6b257db2',1,'glfw3.h']]], + ['glfw_5fopengl_5fcompat_5fprofile_265',['GLFW_OPENGL_COMPAT_PROFILE',['../glfw3_8h.html#ac06b663d79c8fcf04669cc8fcc0b7670',1,'glfw3.h']]], + ['glfw_5fopengl_5fcore_5fprofile_266',['GLFW_OPENGL_CORE_PROFILE',['../glfw3_8h.html#af094bb16da76f66ebceb19ee213b3de8',1,'glfw3.h']]], + ['glfw_5fopengl_5fdebug_5fcontext_267',['GLFW_OPENGL_DEBUG_CONTEXT',['../group__window.html#ga87ec2df0b915201e950ca42d5d0831e1',1,'glfw3.h']]], + ['glfw_5fopengl_5fes_5fapi_268',['GLFW_OPENGL_ES_API',['../glfw3_8h.html#a28d9b3bc6c2a522d815c8e146595051f',1,'glfw3.h']]], + ['glfw_5fopengl_5fforward_5fcompat_269',['GLFW_OPENGL_FORWARD_COMPAT',['../group__window.html#ga13d24b12465da8b28985f46c8557925b',1,'glfw3.h']]], + ['glfw_5fopengl_5fprofile_270',['GLFW_OPENGL_PROFILE',['../group__window.html#ga44f3a6b4261fbe351e0b950b0f372e12',1,'glfw3.h']]], + ['glfw_5fosmesa_5fcontext_5fapi_271',['GLFW_OSMESA_CONTEXT_API',['../glfw3_8h.html#afd34a473af9fa81f317910ea371b19e3',1,'glfw3.h']]], + ['glfw_5fout_5fof_5fmemory_272',['GLFW_OUT_OF_MEMORY',['../group__errors.html#ga9023953a2bcb98c2906afd071d21ee7f',1,'glfw3.h']]], + ['glfw_5fplatform_5ferror_273',['GLFW_PLATFORM_ERROR',['../group__errors.html#gad44162d78100ea5e87cdd38426b8c7a1',1,'glfw3.h']]], + ['glfw_5fpress_274',['GLFW_PRESS',['../group__input.html#ga2485743d0b59df3791c45951c4195265',1,'glfw3.h']]], + ['glfw_5fraw_5fmouse_5fmotion_275',['GLFW_RAW_MOUSE_MOTION',['../glfw3_8h.html#aeeda1be76a44a1fc97c1282e06281fbb',1,'glfw3.h']]], + ['glfw_5fred_5fbits_276',['GLFW_RED_BITS',['../group__window.html#gaf78ed8e417dbcc1e354906cc2708c982',1,'glfw3.h']]], + ['glfw_5frefresh_5frate_277',['GLFW_REFRESH_RATE',['../group__window.html#ga0f20825e6e47ee8ba389024519682212',1,'glfw3.h']]], + ['glfw_5frelease_278',['GLFW_RELEASE',['../group__input.html#gada11d965c4da13090ad336e030e4d11f',1,'glfw3.h']]], + ['glfw_5frelease_5fbehavior_5fflush_279',['GLFW_RELEASE_BEHAVIOR_FLUSH',['../glfw3_8h.html#a999961d391db49cb4f949c1dece0e13b',1,'glfw3.h']]], + ['glfw_5frelease_5fbehavior_5fnone_280',['GLFW_RELEASE_BEHAVIOR_NONE',['../glfw3_8h.html#afca09088eccacdce4b59036cfae349c5',1,'glfw3.h']]], + ['glfw_5frepeat_281',['GLFW_REPEAT',['../group__input.html#gac96fd3b9fc66c6f0eebaf6532595338f',1,'glfw3.h']]], + ['glfw_5fresizable_282',['GLFW_RESIZABLE',['../group__window.html#gadba13c7a1b3aa40831eb2beedbd5bd1d',1,'glfw3.h']]], + ['glfw_5fsamples_283',['GLFW_SAMPLES',['../group__window.html#ga2cdf86fdcb7722fb8829c4e201607535',1,'glfw3.h']]], + ['glfw_5fscale_5fto_5fmonitor_284',['GLFW_SCALE_TO_MONITOR',['../group__window.html#ga620bc4280c7eab81ac9f02204500ed47',1,'glfw3.h']]], + ['glfw_5fsrgb_5fcapable_285',['GLFW_SRGB_CAPABLE',['../group__window.html#ga444a8f00414a63220591f9fdb7b5642b',1,'glfw3.h']]], + ['glfw_5fstencil_5fbits_286',['GLFW_STENCIL_BITS',['../group__window.html#ga5339890a45a1fb38e93cb9fcc5fd069d',1,'glfw3.h']]], + ['glfw_5fstereo_287',['GLFW_STEREO',['../group__window.html#ga83d991efca02537e2d69969135b77b03',1,'glfw3.h']]], + ['glfw_5fsticky_5fkeys_288',['GLFW_STICKY_KEYS',['../glfw3_8h.html#ae3bbe2315b7691ab088159eb6c9110fc',1,'glfw3.h']]], + ['glfw_5fsticky_5fmouse_5fbuttons_289',['GLFW_STICKY_MOUSE_BUTTONS',['../glfw3_8h.html#a4d7ce8ce71030c3b04e2b78145bc59d1',1,'glfw3.h']]], + ['glfw_5ftransparent_5fframebuffer_290',['GLFW_TRANSPARENT_FRAMEBUFFER',['../group__window.html#ga60a0578c3b9449027d683a9c6abb9f14',1,'glfw3.h']]], + ['glfw_5ftrue_291',['GLFW_TRUE',['../group__init.html#ga2744fbb29b5631bb28802dbe0cf36eba',1,'glfw3.h']]], + ['glfw_5fversion_5fmajor_292',['GLFW_VERSION_MAJOR',['../group__init.html#ga6337d9ea43b22fc529b2bba066b4a576',1,'glfw3.h']]], + ['glfw_5fversion_5fminor_293',['GLFW_VERSION_MINOR',['../group__init.html#gaf80d40f0aea7088ff337606e9c48f7a3',1,'glfw3.h']]], + ['glfw_5fversion_5frevision_294',['GLFW_VERSION_REVISION',['../group__init.html#gab72ae2e2035d9ea461abc3495eac0502',1,'glfw3.h']]], + ['glfw_5fversion_5funavailable_295',['GLFW_VERSION_UNAVAILABLE',['../group__errors.html#gad16c5565b4a69f9c2a9ac2c0dbc89462',1,'glfw3.h']]], + ['glfw_5fvisible_296',['GLFW_VISIBLE',['../group__window.html#gafb3cdc45297e06d8f1eb13adc69ca6c4',1,'glfw3.h']]], + ['glfw_5fvresize_5fcursor_297',['GLFW_VRESIZE_CURSOR',['../group__shapes.html#gaf024f0e1ff8366fb2b5c260509a1fce5',1,'glfw3.h']]], + ['glfw_5fx11_5fclass_5fname_298',['GLFW_X11_CLASS_NAME',['../group__window.html#gae5a9ea2fccccd92edbd343fc56461114',1,'glfw3.h']]], + ['glfw_5fx11_5finstance_5fname_299',['GLFW_X11_INSTANCE_NAME',['../group__window.html#ga494c3c0d911e4b860b946530a3e389e8',1,'glfw3.h']]], + ['glfwcharfun_300',['GLFWcharfun',['../group__input.html#ga1ab90a55cf3f58639b893c0f4118cb6e',1,'glfw3.h']]], + ['glfwcharmodsfun_301',['GLFWcharmodsfun',['../group__input.html#gac3cf64f90b6219c05ac7b7822d5a4b8f',1,'glfw3.h']]], + ['glfwcreatecursor_302',['glfwCreateCursor',['../group__input.html#ga556f604f73af156c0db0e97c081373c3',1,'glfw3.h']]], + ['glfwcreatestandardcursor_303',['glfwCreateStandardCursor',['../group__input.html#gaf2fb2eb2c9dd842d1cef8a34e3c6403e',1,'glfw3.h']]], + ['glfwcreatewindow_304',['glfwCreateWindow',['../group__window.html#ga3555a418df92ad53f917597fe2f64aeb',1,'glfw3.h']]], + ['glfwcreatewindowsurface_305',['glfwCreateWindowSurface',['../group__vulkan.html#ga1a24536bec3f80b08ead18e28e6ae965',1,'glfw3.h']]], + ['glfwcursor_306',['GLFWcursor',['../group__input.html#ga89261ae18c75e863aaf2656ecdd238f4',1,'glfw3.h']]], + ['glfwcursorenterfun_307',['GLFWcursorenterfun',['../group__input.html#gaa93dc4818ac9ab32532909d53a337cbe',1,'glfw3.h']]], + ['glfwcursorposfun_308',['GLFWcursorposfun',['../group__input.html#gad6fae41b3ac2e4209aaa87b596c57f68',1,'glfw3.h']]], + ['glfwdefaultwindowhints_309',['glfwDefaultWindowHints',['../group__window.html#gaa77c4898dfb83344a6b4f76aa16b9a4a',1,'glfw3.h']]], + ['glfwdestroycursor_310',['glfwDestroyCursor',['../group__input.html#ga81b952cd1764274d0db7fb3c5a79ba6a',1,'glfw3.h']]], + ['glfwdestroywindow_311',['glfwDestroyWindow',['../group__window.html#gacdf43e51376051d2c091662e9fe3d7b2',1,'glfw3.h']]], + ['glfwdropfun_312',['GLFWdropfun',['../group__input.html#gaaba73c3274062c18723b7f05862d94b2',1,'glfw3.h']]], + ['glfwerrorfun_313',['GLFWerrorfun',['../group__init.html#ga8184701785c096b3862a75cda1bf44a3',1,'glfw3.h']]], + ['glfwextensionsupported_314',['glfwExtensionSupported',['../group__context.html#ga87425065c011cef1ebd6aac75e059dfa',1,'glfw3.h']]], + ['glfwfocuswindow_315',['glfwFocusWindow',['../group__window.html#ga873780357abd3f3a081d71a40aae45a1',1,'glfw3.h']]], + ['glfwframebuffersizefun_316',['GLFWframebuffersizefun',['../group__window.html#gae18026e294dde685ed2e5f759533144d',1,'glfw3.h']]], + ['glfwgamepadstate_317',['GLFWgamepadstate',['../group__input.html#ga61acfb1f28f751438dd221225c5e725d',1,'GLFWgamepadstate(): glfw3.h'],['../structGLFWgamepadstate.html',1,'GLFWgamepadstate']]], + ['glfwgammaramp_318',['GLFWgammaramp',['../structGLFWgammaramp.html',1,'GLFWgammaramp'],['../group__monitor.html#ga939cf093cb0af0498b7b54dc2e181404',1,'GLFWgammaramp(): glfw3.h']]], + ['glfwgetclipboardstring_319',['glfwGetClipboardString',['../group__input.html#ga71a5b20808ea92193d65c21b82580355',1,'glfw3.h']]], + ['glfwgetcocoamonitor_320',['glfwGetCocoaMonitor',['../group__native.html#gaf22f429aec4b1aab316142d66d9be3e6',1,'glfw3native.h']]], + ['glfwgetcocoawindow_321',['glfwGetCocoaWindow',['../group__native.html#gac3ed9d495d0c2bb9652de5a50c648715',1,'glfw3native.h']]], + ['glfwgetcurrentcontext_322',['glfwGetCurrentContext',['../group__context.html#gad94e80185397a6cf5fe2ab30567af71c',1,'glfw3.h']]], + ['glfwgetcursorpos_323',['glfwGetCursorPos',['../group__input.html#ga01d37b6c40133676b9cea60ca1d7c0cc',1,'glfw3.h']]], + ['glfwgeteglcontext_324',['glfwGetEGLContext',['../group__native.html#ga671c5072becd085f4ab5771a9c8efcf1',1,'glfw3native.h']]], + ['glfwgetegldisplay_325',['glfwGetEGLDisplay',['../group__native.html#ga1cd8d973f47aacb5532d368147cc3138',1,'glfw3native.h']]], + ['glfwgeteglsurface_326',['glfwGetEGLSurface',['../group__native.html#ga2199b36117a6a695fec8441d8052eee6',1,'glfw3native.h']]], + ['glfwgeterror_327',['glfwGetError',['../group__init.html#ga944986b4ec0b928d488141f92982aa18',1,'glfw3.h']]], + ['glfwgetframebuffersize_328',['glfwGetFramebufferSize',['../group__window.html#ga0e2637a4161afb283f5300c7f94785c9',1,'glfw3.h']]], + ['glfwgetgamepadname_329',['glfwGetGamepadName',['../group__input.html#ga8aea73a1a25cc6c0486a617019f56728',1,'glfw3.h']]], + ['glfwgetgamepadstate_330',['glfwGetGamepadState',['../group__input.html#gadccddea8bce6113fa459de379ddaf051',1,'glfw3.h']]], + ['glfwgetgammaramp_331',['glfwGetGammaRamp',['../group__monitor.html#ga76ba90debcf0062b5c4b73052b24f96f',1,'glfw3.h']]], + ['glfwgetglxcontext_332',['glfwGetGLXContext',['../group__native.html#ga62d884114b0abfcdc2930e89f20867e2',1,'glfw3native.h']]], + ['glfwgetglxwindow_333',['glfwGetGLXWindow',['../group__native.html#ga1ed27b8766e859a21381e8f8ce18d049',1,'glfw3native.h']]], + ['glfwgetinputmode_334',['glfwGetInputMode',['../group__input.html#gaf5b859dbe19bdf434e42695ea45cc5f4',1,'glfw3.h']]], + ['glfwgetinstanceprocaddress_335',['glfwGetInstanceProcAddress',['../group__vulkan.html#gadf228fac94c5fd8f12423ec9af9ff1e9',1,'glfw3.h']]], + ['glfwgetjoystickaxes_336',['glfwGetJoystickAxes',['../group__input.html#gaeb1c0191d3140a233a682987c61eb408',1,'glfw3.h']]], + ['glfwgetjoystickbuttons_337',['glfwGetJoystickButtons',['../group__input.html#ga5ffe34739d3dc97efe432ed2d81d9938',1,'glfw3.h']]], + ['glfwgetjoystickguid_338',['glfwGetJoystickGUID',['../group__input.html#ga6659411aec3c7fcef27780e2cb2d9600',1,'glfw3.h']]], + ['glfwgetjoystickhats_339',['glfwGetJoystickHats',['../group__input.html#ga06e660841b3e79c54da4f54a932c5a2c',1,'glfw3.h']]], + ['glfwgetjoystickname_340',['glfwGetJoystickName',['../group__input.html#gac6a8e769e18e0bcfa9097793fc2c3978',1,'glfw3.h']]], + ['glfwgetjoystickuserpointer_341',['glfwGetJoystickUserPointer',['../group__input.html#ga18cefd7265d1fa04f3fd38a6746db5f3',1,'glfw3.h']]], + ['glfwgetkey_342',['glfwGetKey',['../group__input.html#gadd341da06bc8d418b4dc3a3518af9ad2',1,'glfw3.h']]], + ['glfwgetkeyname_343',['glfwGetKeyName',['../group__input.html#gaeaed62e69c3bd62b7ff8f7b19913ce4f',1,'glfw3.h']]], + ['glfwgetkeyscancode_344',['glfwGetKeyScancode',['../group__input.html#ga67ddd1b7dcbbaff03e4a76c0ea67103a',1,'glfw3.h']]], + ['glfwgetmonitorcontentscale_345',['glfwGetMonitorContentScale',['../group__monitor.html#gad3152e84465fa620b601265ebfcdb21b',1,'glfw3.h']]], + ['glfwgetmonitorname_346',['glfwGetMonitorName',['../group__monitor.html#ga7af83e13489d90379588fb331b9e4b68',1,'glfw3.h']]], + ['glfwgetmonitorphysicalsize_347',['glfwGetMonitorPhysicalSize',['../group__monitor.html#ga7d8bffc6c55539286a6bd20d32a8d7ea',1,'glfw3.h']]], + ['glfwgetmonitorpos_348',['glfwGetMonitorPos',['../group__monitor.html#ga102f54e7acc9149edbcf0997152df8c9',1,'glfw3.h']]], + ['glfwgetmonitors_349',['glfwGetMonitors',['../group__monitor.html#ga70b1156d5d24e9928f145d6c864369d2',1,'glfw3.h']]], + ['glfwgetmonitoruserpointer_350',['glfwGetMonitorUserPointer',['../group__monitor.html#ga1adbfbfb8cd58b23cfee82e574fbbdc5',1,'glfw3.h']]], + ['glfwgetmonitorworkarea_351',['glfwGetMonitorWorkarea',['../group__monitor.html#ga7387a3bdb64bfe8ebf2b9e54f5b6c9d0',1,'glfw3.h']]], + ['glfwgetmousebutton_352',['glfwGetMouseButton',['../group__input.html#gac1473feacb5996c01a7a5a33b5066704',1,'glfw3.h']]], + ['glfwgetnsglcontext_353',['glfwGetNSGLContext',['../group__native.html#ga559e002e3cd63c979881770cd4dc63bc',1,'glfw3native.h']]], + ['glfwgetosmesacolorbuffer_354',['glfwGetOSMesaColorBuffer',['../group__native.html#ga3b36e3e3dcf308b776427b6bd73cc132',1,'glfw3native.h']]], + ['glfwgetosmesacontext_355',['glfwGetOSMesaContext',['../group__native.html#ga9e47700080094eb569cb053afaa88773',1,'glfw3native.h']]], + ['glfwgetosmesadepthbuffer_356',['glfwGetOSMesaDepthBuffer',['../group__native.html#ga6b64039ffc88a7a2f57f0956c0c75d53',1,'glfw3native.h']]], + ['glfwgetphysicaldevicepresentationsupport_357',['glfwGetPhysicalDevicePresentationSupport',['../group__vulkan.html#gaff3823355cdd7e2f3f9f4d9ea9518d92',1,'glfw3.h']]], + ['glfwgetprimarymonitor_358',['glfwGetPrimaryMonitor',['../group__monitor.html#gac3adb24947eb709e1874028272e5dfc5',1,'glfw3.h']]], + ['glfwgetprocaddress_359',['glfwGetProcAddress',['../group__context.html#ga35f1837e6f666781842483937612f163',1,'glfw3.h']]], + ['glfwgetrequiredinstanceextensions_360',['glfwGetRequiredInstanceExtensions',['../group__vulkan.html#ga99ad342d82f4a3421e2864978cb6d1d6',1,'glfw3.h']]], + ['glfwgettime_361',['glfwGetTime',['../group__input.html#gaa6cf4e7a77158a3b8fd00328b1720a4a',1,'glfw3.h']]], + ['glfwgettimerfrequency_362',['glfwGetTimerFrequency',['../group__input.html#ga3289ee876572f6e91f06df3a24824443',1,'glfw3.h']]], + ['glfwgettimervalue_363',['glfwGetTimerValue',['../group__input.html#ga09b2bd37d328e0b9456c7ec575cc26aa',1,'glfw3.h']]], + ['glfwgetversion_364',['glfwGetVersion',['../group__init.html#ga9f8ffaacf3c269cc48eafbf8b9b71197',1,'glfw3.h']]], + ['glfwgetversionstring_365',['glfwGetVersionString',['../group__init.html#ga026abd003c8e6501981ab1662062f1c0',1,'glfw3.h']]], + ['glfwgetvideomode_366',['glfwGetVideoMode',['../group__monitor.html#gaba376fa7e76634b4788bddc505d6c9d5',1,'glfw3.h']]], + ['glfwgetvideomodes_367',['glfwGetVideoModes',['../group__monitor.html#gad2e24d2843cb7d6c26202cddd530fc1b',1,'glfw3.h']]], + ['glfwgetwaylanddisplay_368',['glfwGetWaylandDisplay',['../group__native.html#gacbe11f93ce20621de82989bbba94e62a',1,'glfw3native.h']]], + ['glfwgetwaylandmonitor_369',['glfwGetWaylandMonitor',['../group__native.html#ga4f16066bd4c59e2f99418adfcb43dd16',1,'glfw3native.h']]], + ['glfwgetwaylandwindow_370',['glfwGetWaylandWindow',['../group__native.html#ga5c597f2841229d9626f0811cca41ceb3',1,'glfw3native.h']]], + ['glfwgetwglcontext_371',['glfwGetWGLContext',['../group__native.html#gadc4010d91d9cc1134d040eeb1202a143',1,'glfw3native.h']]], + ['glfwgetwin32adapter_372',['glfwGetWin32Adapter',['../group__native.html#gad4d3e9242536c0ba6be88a98f4c73a41',1,'glfw3native.h']]], + ['glfwgetwin32monitor_373',['glfwGetWin32Monitor',['../group__native.html#gac845f7dbe4c1d7fdd682a3c6fdae6766',1,'glfw3native.h']]], + ['glfwgetwin32window_374',['glfwGetWin32Window',['../group__native.html#gafe5079aa79038b0079fc09d5f0a8e667',1,'glfw3native.h']]], + ['glfwgetwindowattrib_375',['glfwGetWindowAttrib',['../group__window.html#gacccb29947ea4b16860ebef42c2cb9337',1,'glfw3.h']]], + ['glfwgetwindowcontentscale_376',['glfwGetWindowContentScale',['../group__window.html#gaf5d31de9c19c4f994facea64d2b3106c',1,'glfw3.h']]], + ['glfwgetwindowframesize_377',['glfwGetWindowFrameSize',['../group__window.html#ga1a9fd382058c53101b21cf211898f1f1',1,'glfw3.h']]], + ['glfwgetwindowmonitor_378',['glfwGetWindowMonitor',['../group__window.html#ga4d766499ac02c60f02221a9dfab87299',1,'glfw3.h']]], + ['glfwgetwindowopacity_379',['glfwGetWindowOpacity',['../group__window.html#gad09f0bd7a6307c4533b7061828480a84',1,'glfw3.h']]], + ['glfwgetwindowpos_380',['glfwGetWindowPos',['../group__window.html#ga73cb526c000876fd8ddf571570fdb634',1,'glfw3.h']]], + ['glfwgetwindowsize_381',['glfwGetWindowSize',['../group__window.html#gaeea7cbc03373a41fb51cfbf9f2a5d4c6',1,'glfw3.h']]], + ['glfwgetwindowuserpointer_382',['glfwGetWindowUserPointer',['../group__window.html#gae77a4add0d2023ca21ff1443ced01653',1,'glfw3.h']]], + ['glfwgetx11adapter_383',['glfwGetX11Adapter',['../group__native.html#ga088fbfa80f50569402b41be71ad66e40',1,'glfw3native.h']]], + ['glfwgetx11display_384',['glfwGetX11Display',['../group__native.html#ga6e7822385cc8a1cc3b18f60352830189',1,'glfw3native.h']]], + ['glfwgetx11monitor_385',['glfwGetX11Monitor',['../group__native.html#gab2f8cc043905e9fa9b12bfdbbcfe874c',1,'glfw3native.h']]], + ['glfwgetx11selectionstring_386',['glfwGetX11SelectionString',['../group__native.html#gae084ef64dc0db140b455b1427256d3f7',1,'glfw3native.h']]], + ['glfwgetx11window_387',['glfwGetX11Window',['../group__native.html#ga90ca676322740842db446999a1b1f21d',1,'glfw3native.h']]], + ['glfwglproc_388',['GLFWglproc',['../group__context.html#ga3d47c2d2fbe0be9c505d0e04e91a133c',1,'glfw3.h']]], + ['glfwhidewindow_389',['glfwHideWindow',['../group__window.html#ga49401f82a1ba5f15db5590728314d47c',1,'glfw3.h']]], + ['glfwiconifywindow_390',['glfwIconifyWindow',['../group__window.html#ga1bb559c0ebaad63c5c05ad2a066779c4',1,'glfw3.h']]], + ['glfwimage_391',['GLFWimage',['../group__window.html#ga7cc0a09de172fa7250872046f8c4d2ca',1,'GLFWimage(): glfw3.h'],['../structGLFWimage.html',1,'GLFWimage']]], + ['glfwinit_392',['glfwInit',['../group__init.html#ga317aac130a235ab08c6db0834907d85e',1,'glfw3.h']]], + ['glfwinithint_393',['glfwInitHint',['../group__init.html#ga110fd1d3f0412822b4f1908c026f724a',1,'glfw3.h']]], + ['glfwjoystickfun_394',['GLFWjoystickfun',['../group__input.html#gaa21ad5986ae9a26077a40142efb56243',1,'glfw3.h']]], + ['glfwjoystickisgamepad_395',['glfwJoystickIsGamepad',['../group__input.html#gad0f676860f329d80f7e47e9f06a96f00',1,'glfw3.h']]], + ['glfwjoystickpresent_396',['glfwJoystickPresent',['../group__input.html#gaed0966cee139d815317f9ffcba64c9f1',1,'glfw3.h']]], + ['glfwkeyfun_397',['GLFWkeyfun',['../group__input.html#ga5bd751b27b90f865d2ea613533f0453c',1,'glfw3.h']]], + ['glfwmakecontextcurrent_398',['glfwMakeContextCurrent',['../group__context.html#ga1c04dc242268f827290fe40aa1c91157',1,'glfw3.h']]], + ['glfwmaximizewindow_399',['glfwMaximizeWindow',['../group__window.html#ga3f541387449d911274324ae7f17ec56b',1,'glfw3.h']]], + ['glfwmonitor_400',['GLFWmonitor',['../group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3',1,'glfw3.h']]], + ['glfwmonitorfun_401',['GLFWmonitorfun',['../group__monitor.html#gaabe16caca8dea952504dfdebdf4cd249',1,'glfw3.h']]], + ['glfwmousebuttonfun_402',['GLFWmousebuttonfun',['../group__input.html#ga0184dcb59f6d85d735503dcaae809727',1,'glfw3.h']]], + ['glfwpollevents_403',['glfwPollEvents',['../group__window.html#ga37bd57223967b4211d60ca1a0bf3c832',1,'glfw3.h']]], + ['glfwpostemptyevent_404',['glfwPostEmptyEvent',['../group__window.html#gab5997a25187e9fd5c6f2ecbbc8dfd7e9',1,'glfw3.h']]], + ['glfwrawmousemotionsupported_405',['glfwRawMouseMotionSupported',['../group__input.html#gae4ee0dbd0d256183e1ea4026d897e1c2',1,'glfw3.h']]], + ['glfwrequestwindowattention_406',['glfwRequestWindowAttention',['../group__window.html#ga2f8d59323fc4692c1d54ba08c863a703',1,'glfw3.h']]], + ['glfwrestorewindow_407',['glfwRestoreWindow',['../group__window.html#ga52527a5904b47d802b6b4bb519cdebc7',1,'glfw3.h']]], + ['glfwscrollfun_408',['GLFWscrollfun',['../group__input.html#gaf656112c33de3efdb227fa58f0134cf5',1,'glfw3.h']]], + ['glfwsetcharcallback_409',['glfwSetCharCallback',['../group__input.html#gab25c4a220fd8f5717718dbc487828996',1,'glfw3.h']]], + ['glfwsetcharmodscallback_410',['glfwSetCharModsCallback',['../group__input.html#ga0b7f4ad13c2b17435ff13b6dcfb4e43c',1,'glfw3.h']]], + ['glfwsetclipboardstring_411',['glfwSetClipboardString',['../group__input.html#gaba1f022c5eb07dfac421df34cdcd31dd',1,'glfw3.h']]], + ['glfwsetcursor_412',['glfwSetCursor',['../group__input.html#gad3b4f38c8d5dae036bc8fa959e18343e',1,'glfw3.h']]], + ['glfwsetcursorentercallback_413',['glfwSetCursorEnterCallback',['../group__input.html#gad27f8ad0142c038a281466c0966817d8',1,'glfw3.h']]], + ['glfwsetcursorpos_414',['glfwSetCursorPos',['../group__input.html#ga04b03af936d906ca123c8f4ee08b39e7',1,'glfw3.h']]], + ['glfwsetcursorposcallback_415',['glfwSetCursorPosCallback',['../group__input.html#gac1f879ab7435d54d4d79bb469fe225d7',1,'glfw3.h']]], + ['glfwsetdropcallback_416',['glfwSetDropCallback',['../group__input.html#gab773f0ee0a07cff77a210cea40bc1f6b',1,'glfw3.h']]], + ['glfwseterrorcallback_417',['glfwSetErrorCallback',['../group__init.html#gaff45816610d53f0b83656092a4034f40',1,'glfw3.h']]], + ['glfwsetframebuffersizecallback_418',['glfwSetFramebufferSizeCallback',['../group__window.html#gab3fb7c3366577daef18c0023e2a8591f',1,'glfw3.h']]], + ['glfwsetgamma_419',['glfwSetGamma',['../group__monitor.html#ga6ac582625c990220785ddd34efa3169a',1,'glfw3.h']]], + ['glfwsetgammaramp_420',['glfwSetGammaRamp',['../group__monitor.html#ga583f0ffd0d29613d8cd172b996bbf0dd',1,'glfw3.h']]], + ['glfwsetinputmode_421',['glfwSetInputMode',['../group__input.html#gaa92336e173da9c8834558b54ee80563b',1,'glfw3.h']]], + ['glfwsetjoystickcallback_422',['glfwSetJoystickCallback',['../group__input.html#ga2f60a0e5b7bd8d1b7344dc0a7cb32b4c',1,'glfw3.h']]], + ['glfwsetjoystickuserpointer_423',['glfwSetJoystickUserPointer',['../group__input.html#ga6b2f72d64d636b48a727b437cbb7489e',1,'glfw3.h']]], + ['glfwsetkeycallback_424',['glfwSetKeyCallback',['../group__input.html#ga1caf18159767e761185e49a3be019f8d',1,'glfw3.h']]], + ['glfwsetmonitorcallback_425',['glfwSetMonitorCallback',['../group__monitor.html#gab39df645587c8518192aa746c2fb06c3',1,'glfw3.h']]], + ['glfwsetmonitoruserpointer_426',['glfwSetMonitorUserPointer',['../group__monitor.html#ga702750e24313a686d3637297b6e85fda',1,'glfw3.h']]], + ['glfwsetmousebuttoncallback_427',['glfwSetMouseButtonCallback',['../group__input.html#ga6ab84420974d812bee700e45284a723c',1,'glfw3.h']]], + ['glfwsetscrollcallback_428',['glfwSetScrollCallback',['../group__input.html#ga571e45a030ae4061f746ed56cb76aede',1,'glfw3.h']]], + ['glfwsettime_429',['glfwSetTime',['../group__input.html#gaf59589ef6e8b8c8b5ad184b25afd4dc0',1,'glfw3.h']]], + ['glfwsetwindowaspectratio_430',['glfwSetWindowAspectRatio',['../group__window.html#ga72ac8cb1ee2e312a878b55153d81b937',1,'glfw3.h']]], + ['glfwsetwindowattrib_431',['glfwSetWindowAttrib',['../group__window.html#gace2afda29b4116ec012e410a6819033e',1,'glfw3.h']]], + ['glfwsetwindowclosecallback_432',['glfwSetWindowCloseCallback',['../group__window.html#gada646d775a7776a95ac000cfc1885331',1,'glfw3.h']]], + ['glfwsetwindowcontentscalecallback_433',['glfwSetWindowContentScaleCallback',['../group__window.html#gaf2832ebb5aa6c252a2d261de002c92d6',1,'glfw3.h']]], + ['glfwsetwindowfocuscallback_434',['glfwSetWindowFocusCallback',['../group__window.html#gac2d83c4a10f071baf841f6730528e66c',1,'glfw3.h']]], + ['glfwsetwindowicon_435',['glfwSetWindowIcon',['../group__window.html#gadd7ccd39fe7a7d1f0904666ae5932dc5',1,'glfw3.h']]], + ['glfwsetwindowiconifycallback_436',['glfwSetWindowIconifyCallback',['../group__window.html#gac793e9efd255567b5fb8b445052cfd3e',1,'glfw3.h']]], + ['glfwsetwindowmaximizecallback_437',['glfwSetWindowMaximizeCallback',['../group__window.html#gacbe64c339fbd94885e62145563b6dc93',1,'glfw3.h']]], + ['glfwsetwindowmonitor_438',['glfwSetWindowMonitor',['../group__window.html#ga81c76c418af80a1cce7055bccb0ae0a7',1,'glfw3.h']]], + ['glfwsetwindowopacity_439',['glfwSetWindowOpacity',['../group__window.html#gac31caeb3d1088831b13d2c8a156802e9',1,'glfw3.h']]], + ['glfwsetwindowpos_440',['glfwSetWindowPos',['../group__window.html#ga1abb6d690e8c88e0c8cd1751356dbca8',1,'glfw3.h']]], + ['glfwsetwindowposcallback_441',['glfwSetWindowPosCallback',['../group__window.html#ga08bdfbba88934f9c4f92fd757979ac74',1,'glfw3.h']]], + ['glfwsetwindowrefreshcallback_442',['glfwSetWindowRefreshCallback',['../group__window.html#ga1c5c7eb889c33c7f4d10dd35b327654e',1,'glfw3.h']]], + ['glfwsetwindowshouldclose_443',['glfwSetWindowShouldClose',['../group__window.html#ga49c449dde2a6f87d996f4daaa09d6708',1,'glfw3.h']]], + ['glfwsetwindowsize_444',['glfwSetWindowSize',['../group__window.html#ga371911f12c74c504dd8d47d832d095cb',1,'glfw3.h']]], + ['glfwsetwindowsizecallback_445',['glfwSetWindowSizeCallback',['../group__window.html#gad91b8b047a0c4c6033c38853864c34f8',1,'glfw3.h']]], + ['glfwsetwindowsizelimits_446',['glfwSetWindowSizeLimits',['../group__window.html#gac314fa6cec7d2d307be9963e2709cc90',1,'glfw3.h']]], + ['glfwsetwindowtitle_447',['glfwSetWindowTitle',['../group__window.html#ga5d877f09e968cef7a360b513306f17ff',1,'glfw3.h']]], + ['glfwsetwindowuserpointer_448',['glfwSetWindowUserPointer',['../group__window.html#ga3d2fc6026e690ab31a13f78bc9fd3651',1,'glfw3.h']]], + ['glfwsetx11selectionstring_449',['glfwSetX11SelectionString',['../group__native.html#ga55f879ab02d93367f966186b6f0133f7',1,'glfw3native.h']]], + ['glfwshowwindow_450',['glfwShowWindow',['../group__window.html#ga61be47917b72536a148300f46494fc66',1,'glfw3.h']]], + ['glfwswapbuffers_451',['glfwSwapBuffers',['../group__window.html#ga15a5a1ee5b3c2ca6b15ca209a12efd14',1,'glfw3.h']]], + ['glfwswapinterval_452',['glfwSwapInterval',['../group__context.html#ga6d4e0cdf151b5e579bd67f13202994ed',1,'glfw3.h']]], + ['glfwterminate_453',['glfwTerminate',['../group__init.html#gaaae48c0a18607ea4a4ba951d939f0901',1,'glfw3.h']]], + ['glfwupdategamepadmappings_454',['glfwUpdateGamepadMappings',['../group__input.html#gaed5104612f2fa8e66aa6e846652ad00f',1,'glfw3.h']]], + ['glfwvidmode_455',['GLFWvidmode',['../structGLFWvidmode.html',1,'GLFWvidmode'],['../group__monitor.html#ga902c2816ac9b34b757282daab59b2565',1,'GLFWvidmode(): glfw3.h']]], + ['glfwvkproc_456',['GLFWvkproc',['../group__vulkan.html#ga70c01918dc9d233a4fbe0681a43018af',1,'glfw3.h']]], + ['glfwvulkansupported_457',['glfwVulkanSupported',['../group__vulkan.html#ga2e7f30931e02464b5bc8d0d4b6f9fe2b',1,'glfw3.h']]], + ['glfwwaitevents_458',['glfwWaitEvents',['../group__window.html#ga554e37d781f0a997656c26b2c56c835e',1,'glfw3.h']]], + ['glfwwaiteventstimeout_459',['glfwWaitEventsTimeout',['../group__window.html#ga605a178db92f1a7f1a925563ef3ea2cf',1,'glfw3.h']]], + ['glfwwindow_460',['GLFWwindow',['../group__window.html#ga3c96d80d363e67d13a41b5d1821f3242',1,'glfw3.h']]], + ['glfwwindowclosefun_461',['GLFWwindowclosefun',['../group__window.html#gabf859b936d80961b7d39013a9694cc3e',1,'glfw3.h']]], + ['glfwwindowcontentscalefun_462',['GLFWwindowcontentscalefun',['../group__window.html#ga77f288a2d04bb3c77c7d9615d08cf70e',1,'glfw3.h']]], + ['glfwwindowfocusfun_463',['GLFWwindowfocusfun',['../group__window.html#gabc58c47e9d93f6eb1862d615c3680f46',1,'glfw3.h']]], + ['glfwwindowhint_464',['glfwWindowHint',['../group__window.html#ga7d9c8c62384b1e2821c4dc48952d2033',1,'glfw3.h']]], + ['glfwwindowhintstring_465',['glfwWindowHintString',['../group__window.html#ga8cb2782861c9d997bcf2dea97f363e5f',1,'glfw3.h']]], + ['glfwwindowiconifyfun_466',['GLFWwindowiconifyfun',['../group__window.html#ga35c658cccba236f26e7adee0e25f6a4f',1,'glfw3.h']]], + ['glfwwindowmaximizefun_467',['GLFWwindowmaximizefun',['../group__window.html#ga3017196fdaec33ac3e095765176c2a90',1,'glfw3.h']]], + ['glfwwindowposfun_468',['GLFWwindowposfun',['../group__window.html#gabe287973a21a8f927cde4db06b8dcbe9',1,'glfw3.h']]], + ['glfwwindowrefreshfun_469',['GLFWwindowrefreshfun',['../group__window.html#ga431663a1427d2eb3a273bc398b6737b5',1,'glfw3.h']]], + ['glfwwindowshouldclose_470',['glfwWindowShouldClose',['../group__window.html#ga24e02fbfefbb81fc45320989f8140ab5',1,'glfw3.h']]], + ['glfwwindowsizefun_471',['GLFWwindowsizefun',['../group__window.html#gaec0282944bb810f6f3163ec02da90350',1,'glfw3.h']]], + ['green_472',['green',['../structGLFWgammaramp.html#affccc6f5df47820b6562d709da3a5a3a',1,'GLFWgammaramp']]], + ['greenbits_473',['greenBits',['../structGLFWvidmode.html#a292fdd281f3485fb3ff102a5bda43faa',1,'GLFWvidmode']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_6.html b/deps/glfw-3.3.8/docs/html/search/all_6.html new file mode 100644 index 0000000..d3026a7 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_6.js b/deps/glfw-3.3.8/docs/html/search/all_6.js new file mode 100644 index 0000000..c7cee75 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['height_0',['height',['../structGLFWvidmode.html#ac65942a5f6981695517437a9d571d03c',1,'GLFWvidmode::height()'],['../structGLFWimage.html#a0b7d95368f0c80d5e5c9875057c7dbec',1,'GLFWimage::height()']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_7.html b/deps/glfw-3.3.8/docs/html/search/all_7.html new file mode 100644 index 0000000..b2ee042 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_7.js b/deps/glfw-3.3.8/docs/html/search/all_7.js new file mode 100644 index 0000000..e3d9927 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_7.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['initialization_2c_20version_20and_20error_20reference_0',['Initialization, version and error reference',['../group__init.html',1,'']]], + ['input_20guide_1',['Input guide',['../input_guide.html',1,'']]], + ['input_20reference_2',['Input reference',['../group__input.html',1,'']]], + ['input_2edox_3',['input.dox',['../input_8dox.html',1,'']]], + ['internal_20structure_4',['Internal structure',['../internals_guide.html',1,'']]], + ['internal_2edox_5',['internal.dox',['../internal_8dox.html',1,'']]], + ['intro_2edox_6',['intro.dox',['../intro_8dox.html',1,'']]], + ['introduction_20to_20the_20api_7',['Introduction to the API',['../intro_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_8.html b/deps/glfw-3.3.8/docs/html/search/all_8.html new file mode 100644 index 0000000..40a0b3f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_8.js b/deps/glfw-3.3.8/docs/html/search/all_8.js new file mode 100644 index 0000000..13c7e1c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_8.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['joystick_20hat_20states_0',['Joystick hat states',['../group__hat__state.html',1,'']]], + ['joysticks_1',['Joysticks',['../group__joysticks.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_9.html b/deps/glfw-3.3.8/docs/html/search/all_9.html new file mode 100644 index 0000000..7c49144 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_9.js b/deps/glfw-3.3.8/docs/html/search/all_9.js new file mode 100644 index 0000000..85dae9f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['keyboard_20keys_0',['Keyboard keys',['../group__keys.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_a.html b/deps/glfw-3.3.8/docs/html/search/all_a.html new file mode 100644 index 0000000..fc9d79c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_a.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_a.js b/deps/glfw-3.3.8/docs/html/search/all_a.js new file mode 100644 index 0000000..07d4bf9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_a.js @@ -0,0 +1,11 @@ +var searchData= +[ + ['main_2edox_0',['main.dox',['../main_8dox.html',1,'']]], + ['modifier_20key_20flags_1',['Modifier key flags',['../group__mods.html',1,'']]], + ['monitor_20guide_2',['Monitor guide',['../monitor_guide.html',1,'']]], + ['monitor_20reference_3',['Monitor reference',['../group__monitor.html',1,'']]], + ['monitor_2edox_4',['monitor.dox',['../monitor_8dox.html',1,'']]], + ['mouse_20buttons_5',['Mouse buttons',['../group__buttons.html',1,'']]], + ['moving_20from_20glfw_202_20to_203_6',['Moving from GLFW 2 to 3',['../moving_guide.html',1,'']]], + ['moving_2edox_7',['moving.dox',['../moving_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_b.html b/deps/glfw-3.3.8/docs/html/search/all_b.html new file mode 100644 index 0000000..dafb1fa --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_b.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_b.js b/deps/glfw-3.3.8/docs/html/search/all_b.js new file mode 100644 index 0000000..acfdc50 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_b.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['native_20access_0',['Native access',['../group__native.html',1,'']]], + ['news_2edox_1',['news.dox',['../news_8dox.html',1,'']]], + ['notitle_2',['notitle',['../index.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_c.html b/deps/glfw-3.3.8/docs/html/search/all_c.html new file mode 100644 index 0000000..9df619d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_c.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_c.js b/deps/glfw-3.3.8/docs/html/search/all_c.js new file mode 100644 index 0000000..6414492 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pixels_0',['pixels',['../structGLFWimage.html#a0c532a5c2bb715555279b7817daba0fb',1,'GLFWimage']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_d.html b/deps/glfw-3.3.8/docs/html/search/all_d.html new file mode 100644 index 0000000..95d8eec --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_d.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_d.js b/deps/glfw-3.3.8/docs/html/search/all_d.js new file mode 100644 index 0000000..65523fe --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_d.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['quick_2edox_0',['quick.dox',['../quick_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_e.html b/deps/glfw-3.3.8/docs/html/search/all_e.html new file mode 100644 index 0000000..a54e120 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_e.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_e.js b/deps/glfw-3.3.8/docs/html/search/all_e.js new file mode 100644 index 0000000..7d07f0f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_e.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['red_0',['red',['../structGLFWgammaramp.html#a2cce5d968734b685623eef913e635138',1,'GLFWgammaramp']]], + ['redbits_1',['redBits',['../structGLFWvidmode.html#a6066c4ecd251098700062d3b735dba1b',1,'GLFWvidmode']]], + ['refreshrate_2',['refreshRate',['../structGLFWvidmode.html#a791bdd6c7697b09f7e9c97054bf05649',1,'GLFWvidmode']]], + ['release_20notes_3',['Release notes',['../news.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/all_f.html b/deps/glfw-3.3.8/docs/html/search/all_f.html new file mode 100644 index 0000000..8d0aed3 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_f.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/all_f.js b/deps/glfw-3.3.8/docs/html/search/all_f.js new file mode 100644 index 0000000..58da740 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/all_f.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['size_0',['size',['../structGLFWgammaramp.html#ad620e1cffbff9a32c51bca46301b59a5',1,'GLFWgammaramp']]], + ['standard_20cursor_20shapes_1',['Standard cursor shapes',['../group__shapes.html',1,'']]], + ['standards_20conformance_2',['Standards conformance',['../compat_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/classes_0.html b/deps/glfw-3.3.8/docs/html/search/classes_0.html new file mode 100644 index 0000000..9d4f871 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/classes_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/classes_0.js b/deps/glfw-3.3.8/docs/html/search/classes_0.js new file mode 100644 index 0000000..14cc25b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/classes_0.js @@ -0,0 +1,7 @@ +var searchData= +[ + ['glfwgamepadstate_0',['GLFWgamepadstate',['../structGLFWgamepadstate.html',1,'']]], + ['glfwgammaramp_1',['GLFWgammaramp',['../structGLFWgammaramp.html',1,'']]], + ['glfwimage_2',['GLFWimage',['../structGLFWimage.html',1,'']]], + ['glfwvidmode_3',['GLFWvidmode',['../structGLFWvidmode.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/close.svg b/deps/glfw-3.3.8/docs/html/search/close.svg new file mode 100644 index 0000000..a933eea --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/close.svg @@ -0,0 +1,31 @@ + + + + + + image/svg+xml + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/html/search/defines_0.html b/deps/glfw-3.3.8/docs/html/search/defines_0.html new file mode 100644 index 0000000..d0cf633 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/defines_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/defines_0.js b/deps/glfw-3.3.8/docs/html/search/defines_0.js new file mode 100644 index 0000000..13e688a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/defines_0.js @@ -0,0 +1,32 @@ +var searchData= +[ + ['glapientry_0',['GLAPIENTRY',['../glfw3_8h.html#aa97755eb47e4bf2727ad45d610e18206',1,'glfw3.h']]], + ['glfw_5fany_5frelease_5fbehavior_1',['GLFW_ANY_RELEASE_BEHAVIOR',['../glfw3_8h.html#a6b47d806f285efe9bfd7aeec667297ee',1,'glfw3.h']]], + ['glfw_5fapientry_5fdefined_2',['GLFW_APIENTRY_DEFINED',['../glfw3_8h.html#a8a8538c5500308b4211844f2fb26c7b9',1,'glfw3.h']]], + ['glfw_5fconnected_3',['GLFW_CONNECTED',['../glfw3_8h.html#abe11513fd1ffbee5bb9b173f06028b9e',1,'glfw3.h']]], + ['glfw_5fcursor_4',['GLFW_CURSOR',['../glfw3_8h.html#aade31da5b884a84a7625c6b059b9132c',1,'glfw3.h']]], + ['glfw_5fcursor_5fdisabled_5',['GLFW_CURSOR_DISABLED',['../glfw3_8h.html#a2315b99a329ce53e6a13a9d46fd5ca88',1,'glfw3.h']]], + ['glfw_5fcursor_5fhidden_6',['GLFW_CURSOR_HIDDEN',['../glfw3_8h.html#ac4d5cb9d78de8573349c58763d53bf11',1,'glfw3.h']]], + ['glfw_5fcursor_5fnormal_7',['GLFW_CURSOR_NORMAL',['../glfw3_8h.html#ae04dd25c8577e19fa8c97368561f6c68',1,'glfw3.h']]], + ['glfw_5fdisconnected_8',['GLFW_DISCONNECTED',['../glfw3_8h.html#aab64b25921ef21d89252d6f0a71bfc32',1,'glfw3.h']]], + ['glfw_5fdont_5fcare_9',['GLFW_DONT_CARE',['../glfw3_8h.html#a7a2edf2c18446833d27d07f1b7f3d571',1,'glfw3.h']]], + ['glfw_5fegl_5fcontext_5fapi_10',['GLFW_EGL_CONTEXT_API',['../glfw3_8h.html#a03cf65c9ab01fc8b872ba58842c531c9',1,'glfw3.h']]], + ['glfw_5fglapientry_5fdefined_11',['GLFW_GLAPIENTRY_DEFINED',['../glfw3_8h.html#a3b526ac796be993406ea2f1642c25fc3',1,'glfw3.h']]], + ['glfw_5flock_5fkey_5fmods_12',['GLFW_LOCK_KEY_MODS',['../glfw3_8h.html#a07b84de0b52143e1958f88a7d9105947',1,'glfw3.h']]], + ['glfw_5flose_5fcontext_5fon_5freset_13',['GLFW_LOSE_CONTEXT_ON_RESET',['../glfw3_8h.html#aec1132f245143fc915b2f0995228564c',1,'glfw3.h']]], + ['glfw_5fnative_5fcontext_5fapi_14',['GLFW_NATIVE_CONTEXT_API',['../glfw3_8h.html#a0494c9bfd3f584ab41e6dbeeaa0e6a19',1,'glfw3.h']]], + ['glfw_5fno_5fapi_15',['GLFW_NO_API',['../glfw3_8h.html#a8f6dcdc968d214ff14779564f1389264',1,'glfw3.h']]], + ['glfw_5fno_5freset_5fnotification_16',['GLFW_NO_RESET_NOTIFICATION',['../glfw3_8h.html#aee84a679230d205005e22487ff678a85',1,'glfw3.h']]], + ['glfw_5fno_5frobustness_17',['GLFW_NO_ROBUSTNESS',['../glfw3_8h.html#a8b306cb27f5bb0d6d67c7356a0e0fc34',1,'glfw3.h']]], + ['glfw_5fopengl_5fany_5fprofile_18',['GLFW_OPENGL_ANY_PROFILE',['../glfw3_8h.html#ad6f2335d6f21cc9bab96633b1c111d5f',1,'glfw3.h']]], + ['glfw_5fopengl_5fapi_19',['GLFW_OPENGL_API',['../glfw3_8h.html#a01b3f66db266341425e9abee6b257db2',1,'glfw3.h']]], + ['glfw_5fopengl_5fcompat_5fprofile_20',['GLFW_OPENGL_COMPAT_PROFILE',['../glfw3_8h.html#ac06b663d79c8fcf04669cc8fcc0b7670',1,'glfw3.h']]], + ['glfw_5fopengl_5fcore_5fprofile_21',['GLFW_OPENGL_CORE_PROFILE',['../glfw3_8h.html#af094bb16da76f66ebceb19ee213b3de8',1,'glfw3.h']]], + ['glfw_5fopengl_5fes_5fapi_22',['GLFW_OPENGL_ES_API',['../glfw3_8h.html#a28d9b3bc6c2a522d815c8e146595051f',1,'glfw3.h']]], + ['glfw_5fosmesa_5fcontext_5fapi_23',['GLFW_OSMESA_CONTEXT_API',['../glfw3_8h.html#afd34a473af9fa81f317910ea371b19e3',1,'glfw3.h']]], + ['glfw_5fraw_5fmouse_5fmotion_24',['GLFW_RAW_MOUSE_MOTION',['../glfw3_8h.html#aeeda1be76a44a1fc97c1282e06281fbb',1,'glfw3.h']]], + ['glfw_5frelease_5fbehavior_5fflush_25',['GLFW_RELEASE_BEHAVIOR_FLUSH',['../glfw3_8h.html#a999961d391db49cb4f949c1dece0e13b',1,'glfw3.h']]], + ['glfw_5frelease_5fbehavior_5fnone_26',['GLFW_RELEASE_BEHAVIOR_NONE',['../glfw3_8h.html#afca09088eccacdce4b59036cfae349c5',1,'glfw3.h']]], + ['glfw_5fsticky_5fkeys_27',['GLFW_STICKY_KEYS',['../glfw3_8h.html#ae3bbe2315b7691ab088159eb6c9110fc',1,'glfw3.h']]], + ['glfw_5fsticky_5fmouse_5fbuttons_28',['GLFW_STICKY_MOUSE_BUTTONS',['../glfw3_8h.html#a4d7ce8ce71030c3b04e2b78145bc59d1',1,'glfw3.h']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_0.html b/deps/glfw-3.3.8/docs/html/search/files_0.html new file mode 100644 index 0000000..2dbb4c2 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_0.js b/deps/glfw-3.3.8/docs/html/search/files_0.js new file mode 100644 index 0000000..cb6c601 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['build_2edox_0',['build.dox',['../build_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_1.html b/deps/glfw-3.3.8/docs/html/search/files_1.html new file mode 100644 index 0000000..18ccd15 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_1.js b/deps/glfw-3.3.8/docs/html/search/files_1.js new file mode 100644 index 0000000..73b293d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['compat_2edox_0',['compat.dox',['../compat_8dox.html',1,'']]], + ['compile_2edox_1',['compile.dox',['../compile_8dox.html',1,'']]], + ['context_2edox_2',['context.dox',['../context_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_2.html b/deps/glfw-3.3.8/docs/html/search/files_2.html new file mode 100644 index 0000000..a4c2be4 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_2.js b/deps/glfw-3.3.8/docs/html/search/files_2.js new file mode 100644 index 0000000..f35780d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['glfw3_2eh_0',['glfw3.h',['../glfw3_8h.html',1,'']]], + ['glfw3native_2eh_1',['glfw3native.h',['../glfw3native_8h.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_3.html b/deps/glfw-3.3.8/docs/html/search/files_3.html new file mode 100644 index 0000000..3ac4cfb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_3.js b/deps/glfw-3.3.8/docs/html/search/files_3.js new file mode 100644 index 0000000..f3b77c0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_3.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['input_2edox_0',['input.dox',['../input_8dox.html',1,'']]], + ['internal_2edox_1',['internal.dox',['../internal_8dox.html',1,'']]], + ['intro_2edox_2',['intro.dox',['../intro_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_4.html b/deps/glfw-3.3.8/docs/html/search/files_4.html new file mode 100644 index 0000000..eb19ecf --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_4.js b/deps/glfw-3.3.8/docs/html/search/files_4.js new file mode 100644 index 0000000..03c9f8e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['main_2edox_0',['main.dox',['../main_8dox.html',1,'']]], + ['monitor_2edox_1',['monitor.dox',['../monitor_8dox.html',1,'']]], + ['moving_2edox_2',['moving.dox',['../moving_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_5.html b/deps/glfw-3.3.8/docs/html/search/files_5.html new file mode 100644 index 0000000..61d86d0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_5.js b/deps/glfw-3.3.8/docs/html/search/files_5.js new file mode 100644 index 0000000..6f6eee1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['news_2edox_0',['news.dox',['../news_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_6.html b/deps/glfw-3.3.8/docs/html/search/files_6.html new file mode 100644 index 0000000..333517d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_6.js b/deps/glfw-3.3.8/docs/html/search/files_6.js new file mode 100644 index 0000000..65523fe --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['quick_2edox_0',['quick.dox',['../quick_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_7.html b/deps/glfw-3.3.8/docs/html/search/files_7.html new file mode 100644 index 0000000..ad481b0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_7.js b/deps/glfw-3.3.8/docs/html/search/files_7.js new file mode 100644 index 0000000..82f1459 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['vulkan_2edox_0',['vulkan.dox',['../vulkan_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/files_8.html b/deps/glfw-3.3.8/docs/html/search/files_8.html new file mode 100644 index 0000000..2af8404 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/files_8.js b/deps/glfw-3.3.8/docs/html/search/files_8.js new file mode 100644 index 0000000..cb9a6d6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/files_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['window_2edox_0',['window.dox',['../window_8dox.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/functions_0.html b/deps/glfw-3.3.8/docs/html/search/functions_0.html new file mode 100644 index 0000000..3b739c7 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/functions_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/functions_0.js b/deps/glfw-3.3.8/docs/html/search/functions_0.js new file mode 100644 index 0000000..07b0dcd --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/functions_0.js @@ -0,0 +1,146 @@ +var searchData= +[ + ['glfwcreatecursor_0',['glfwCreateCursor',['../group__input.html#ga556f604f73af156c0db0e97c081373c3',1,'glfw3.h']]], + ['glfwcreatestandardcursor_1',['glfwCreateStandardCursor',['../group__input.html#gaf2fb2eb2c9dd842d1cef8a34e3c6403e',1,'glfw3.h']]], + ['glfwcreatewindow_2',['glfwCreateWindow',['../group__window.html#ga3555a418df92ad53f917597fe2f64aeb',1,'glfw3.h']]], + ['glfwcreatewindowsurface_3',['glfwCreateWindowSurface',['../group__vulkan.html#ga1a24536bec3f80b08ead18e28e6ae965',1,'glfw3.h']]], + ['glfwdefaultwindowhints_4',['glfwDefaultWindowHints',['../group__window.html#gaa77c4898dfb83344a6b4f76aa16b9a4a',1,'glfw3.h']]], + ['glfwdestroycursor_5',['glfwDestroyCursor',['../group__input.html#ga81b952cd1764274d0db7fb3c5a79ba6a',1,'glfw3.h']]], + ['glfwdestroywindow_6',['glfwDestroyWindow',['../group__window.html#gacdf43e51376051d2c091662e9fe3d7b2',1,'glfw3.h']]], + ['glfwextensionsupported_7',['glfwExtensionSupported',['../group__context.html#ga87425065c011cef1ebd6aac75e059dfa',1,'glfw3.h']]], + ['glfwfocuswindow_8',['glfwFocusWindow',['../group__window.html#ga873780357abd3f3a081d71a40aae45a1',1,'glfw3.h']]], + ['glfwgetclipboardstring_9',['glfwGetClipboardString',['../group__input.html#ga71a5b20808ea92193d65c21b82580355',1,'glfw3.h']]], + ['glfwgetcocoamonitor_10',['glfwGetCocoaMonitor',['../group__native.html#gaf22f429aec4b1aab316142d66d9be3e6',1,'glfw3native.h']]], + ['glfwgetcocoawindow_11',['glfwGetCocoaWindow',['../group__native.html#gac3ed9d495d0c2bb9652de5a50c648715',1,'glfw3native.h']]], + ['glfwgetcurrentcontext_12',['glfwGetCurrentContext',['../group__context.html#gad94e80185397a6cf5fe2ab30567af71c',1,'glfw3.h']]], + ['glfwgetcursorpos_13',['glfwGetCursorPos',['../group__input.html#ga01d37b6c40133676b9cea60ca1d7c0cc',1,'glfw3.h']]], + ['glfwgeteglcontext_14',['glfwGetEGLContext',['../group__native.html#ga671c5072becd085f4ab5771a9c8efcf1',1,'glfw3native.h']]], + ['glfwgetegldisplay_15',['glfwGetEGLDisplay',['../group__native.html#ga1cd8d973f47aacb5532d368147cc3138',1,'glfw3native.h']]], + ['glfwgeteglsurface_16',['glfwGetEGLSurface',['../group__native.html#ga2199b36117a6a695fec8441d8052eee6',1,'glfw3native.h']]], + ['glfwgeterror_17',['glfwGetError',['../group__init.html#ga944986b4ec0b928d488141f92982aa18',1,'glfw3.h']]], + ['glfwgetframebuffersize_18',['glfwGetFramebufferSize',['../group__window.html#ga0e2637a4161afb283f5300c7f94785c9',1,'glfw3.h']]], + ['glfwgetgamepadname_19',['glfwGetGamepadName',['../group__input.html#ga8aea73a1a25cc6c0486a617019f56728',1,'glfw3.h']]], + ['glfwgetgamepadstate_20',['glfwGetGamepadState',['../group__input.html#gadccddea8bce6113fa459de379ddaf051',1,'glfw3.h']]], + ['glfwgetgammaramp_21',['glfwGetGammaRamp',['../group__monitor.html#ga76ba90debcf0062b5c4b73052b24f96f',1,'glfw3.h']]], + ['glfwgetglxcontext_22',['glfwGetGLXContext',['../group__native.html#ga62d884114b0abfcdc2930e89f20867e2',1,'glfw3native.h']]], + ['glfwgetglxwindow_23',['glfwGetGLXWindow',['../group__native.html#ga1ed27b8766e859a21381e8f8ce18d049',1,'glfw3native.h']]], + ['glfwgetinputmode_24',['glfwGetInputMode',['../group__input.html#gaf5b859dbe19bdf434e42695ea45cc5f4',1,'glfw3.h']]], + ['glfwgetinstanceprocaddress_25',['glfwGetInstanceProcAddress',['../group__vulkan.html#gadf228fac94c5fd8f12423ec9af9ff1e9',1,'glfw3.h']]], + ['glfwgetjoystickaxes_26',['glfwGetJoystickAxes',['../group__input.html#gaeb1c0191d3140a233a682987c61eb408',1,'glfw3.h']]], + ['glfwgetjoystickbuttons_27',['glfwGetJoystickButtons',['../group__input.html#ga5ffe34739d3dc97efe432ed2d81d9938',1,'glfw3.h']]], + ['glfwgetjoystickguid_28',['glfwGetJoystickGUID',['../group__input.html#ga6659411aec3c7fcef27780e2cb2d9600',1,'glfw3.h']]], + ['glfwgetjoystickhats_29',['glfwGetJoystickHats',['../group__input.html#ga06e660841b3e79c54da4f54a932c5a2c',1,'glfw3.h']]], + ['glfwgetjoystickname_30',['glfwGetJoystickName',['../group__input.html#gac6a8e769e18e0bcfa9097793fc2c3978',1,'glfw3.h']]], + ['glfwgetjoystickuserpointer_31',['glfwGetJoystickUserPointer',['../group__input.html#ga18cefd7265d1fa04f3fd38a6746db5f3',1,'glfw3.h']]], + ['glfwgetkey_32',['glfwGetKey',['../group__input.html#gadd341da06bc8d418b4dc3a3518af9ad2',1,'glfw3.h']]], + ['glfwgetkeyname_33',['glfwGetKeyName',['../group__input.html#gaeaed62e69c3bd62b7ff8f7b19913ce4f',1,'glfw3.h']]], + ['glfwgetkeyscancode_34',['glfwGetKeyScancode',['../group__input.html#ga67ddd1b7dcbbaff03e4a76c0ea67103a',1,'glfw3.h']]], + ['glfwgetmonitorcontentscale_35',['glfwGetMonitorContentScale',['../group__monitor.html#gad3152e84465fa620b601265ebfcdb21b',1,'glfw3.h']]], + ['glfwgetmonitorname_36',['glfwGetMonitorName',['../group__monitor.html#ga7af83e13489d90379588fb331b9e4b68',1,'glfw3.h']]], + ['glfwgetmonitorphysicalsize_37',['glfwGetMonitorPhysicalSize',['../group__monitor.html#ga7d8bffc6c55539286a6bd20d32a8d7ea',1,'glfw3.h']]], + ['glfwgetmonitorpos_38',['glfwGetMonitorPos',['../group__monitor.html#ga102f54e7acc9149edbcf0997152df8c9',1,'glfw3.h']]], + ['glfwgetmonitors_39',['glfwGetMonitors',['../group__monitor.html#ga70b1156d5d24e9928f145d6c864369d2',1,'glfw3.h']]], + ['glfwgetmonitoruserpointer_40',['glfwGetMonitorUserPointer',['../group__monitor.html#ga1adbfbfb8cd58b23cfee82e574fbbdc5',1,'glfw3.h']]], + ['glfwgetmonitorworkarea_41',['glfwGetMonitorWorkarea',['../group__monitor.html#ga7387a3bdb64bfe8ebf2b9e54f5b6c9d0',1,'glfw3.h']]], + ['glfwgetmousebutton_42',['glfwGetMouseButton',['../group__input.html#gac1473feacb5996c01a7a5a33b5066704',1,'glfw3.h']]], + ['glfwgetnsglcontext_43',['glfwGetNSGLContext',['../group__native.html#ga559e002e3cd63c979881770cd4dc63bc',1,'glfw3native.h']]], + ['glfwgetosmesacolorbuffer_44',['glfwGetOSMesaColorBuffer',['../group__native.html#ga3b36e3e3dcf308b776427b6bd73cc132',1,'glfw3native.h']]], + ['glfwgetosmesacontext_45',['glfwGetOSMesaContext',['../group__native.html#ga9e47700080094eb569cb053afaa88773',1,'glfw3native.h']]], + ['glfwgetosmesadepthbuffer_46',['glfwGetOSMesaDepthBuffer',['../group__native.html#ga6b64039ffc88a7a2f57f0956c0c75d53',1,'glfw3native.h']]], + ['glfwgetphysicaldevicepresentationsupport_47',['glfwGetPhysicalDevicePresentationSupport',['../group__vulkan.html#gaff3823355cdd7e2f3f9f4d9ea9518d92',1,'glfw3.h']]], + ['glfwgetprimarymonitor_48',['glfwGetPrimaryMonitor',['../group__monitor.html#gac3adb24947eb709e1874028272e5dfc5',1,'glfw3.h']]], + ['glfwgetprocaddress_49',['glfwGetProcAddress',['../group__context.html#ga35f1837e6f666781842483937612f163',1,'glfw3.h']]], + ['glfwgetrequiredinstanceextensions_50',['glfwGetRequiredInstanceExtensions',['../group__vulkan.html#ga99ad342d82f4a3421e2864978cb6d1d6',1,'glfw3.h']]], + ['glfwgettime_51',['glfwGetTime',['../group__input.html#gaa6cf4e7a77158a3b8fd00328b1720a4a',1,'glfw3.h']]], + ['glfwgettimerfrequency_52',['glfwGetTimerFrequency',['../group__input.html#ga3289ee876572f6e91f06df3a24824443',1,'glfw3.h']]], + ['glfwgettimervalue_53',['glfwGetTimerValue',['../group__input.html#ga09b2bd37d328e0b9456c7ec575cc26aa',1,'glfw3.h']]], + ['glfwgetversion_54',['glfwGetVersion',['../group__init.html#ga9f8ffaacf3c269cc48eafbf8b9b71197',1,'glfw3.h']]], + ['glfwgetversionstring_55',['glfwGetVersionString',['../group__init.html#ga026abd003c8e6501981ab1662062f1c0',1,'glfw3.h']]], + ['glfwgetvideomode_56',['glfwGetVideoMode',['../group__monitor.html#gaba376fa7e76634b4788bddc505d6c9d5',1,'glfw3.h']]], + ['glfwgetvideomodes_57',['glfwGetVideoModes',['../group__monitor.html#gad2e24d2843cb7d6c26202cddd530fc1b',1,'glfw3.h']]], + ['glfwgetwaylanddisplay_58',['glfwGetWaylandDisplay',['../group__native.html#gacbe11f93ce20621de82989bbba94e62a',1,'glfw3native.h']]], + ['glfwgetwaylandmonitor_59',['glfwGetWaylandMonitor',['../group__native.html#ga4f16066bd4c59e2f99418adfcb43dd16',1,'glfw3native.h']]], + ['glfwgetwaylandwindow_60',['glfwGetWaylandWindow',['../group__native.html#ga5c597f2841229d9626f0811cca41ceb3',1,'glfw3native.h']]], + ['glfwgetwglcontext_61',['glfwGetWGLContext',['../group__native.html#gadc4010d91d9cc1134d040eeb1202a143',1,'glfw3native.h']]], + ['glfwgetwin32adapter_62',['glfwGetWin32Adapter',['../group__native.html#gad4d3e9242536c0ba6be88a98f4c73a41',1,'glfw3native.h']]], + ['glfwgetwin32monitor_63',['glfwGetWin32Monitor',['../group__native.html#gac845f7dbe4c1d7fdd682a3c6fdae6766',1,'glfw3native.h']]], + ['glfwgetwin32window_64',['glfwGetWin32Window',['../group__native.html#gafe5079aa79038b0079fc09d5f0a8e667',1,'glfw3native.h']]], + ['glfwgetwindowattrib_65',['glfwGetWindowAttrib',['../group__window.html#gacccb29947ea4b16860ebef42c2cb9337',1,'glfw3.h']]], + ['glfwgetwindowcontentscale_66',['glfwGetWindowContentScale',['../group__window.html#gaf5d31de9c19c4f994facea64d2b3106c',1,'glfw3.h']]], + ['glfwgetwindowframesize_67',['glfwGetWindowFrameSize',['../group__window.html#ga1a9fd382058c53101b21cf211898f1f1',1,'glfw3.h']]], + ['glfwgetwindowmonitor_68',['glfwGetWindowMonitor',['../group__window.html#ga4d766499ac02c60f02221a9dfab87299',1,'glfw3.h']]], + ['glfwgetwindowopacity_69',['glfwGetWindowOpacity',['../group__window.html#gad09f0bd7a6307c4533b7061828480a84',1,'glfw3.h']]], + ['glfwgetwindowpos_70',['glfwGetWindowPos',['../group__window.html#ga73cb526c000876fd8ddf571570fdb634',1,'glfw3.h']]], + ['glfwgetwindowsize_71',['glfwGetWindowSize',['../group__window.html#gaeea7cbc03373a41fb51cfbf9f2a5d4c6',1,'glfw3.h']]], + ['glfwgetwindowuserpointer_72',['glfwGetWindowUserPointer',['../group__window.html#gae77a4add0d2023ca21ff1443ced01653',1,'glfw3.h']]], + ['glfwgetx11adapter_73',['glfwGetX11Adapter',['../group__native.html#ga088fbfa80f50569402b41be71ad66e40',1,'glfw3native.h']]], + ['glfwgetx11display_74',['glfwGetX11Display',['../group__native.html#ga6e7822385cc8a1cc3b18f60352830189',1,'glfw3native.h']]], + ['glfwgetx11monitor_75',['glfwGetX11Monitor',['../group__native.html#gab2f8cc043905e9fa9b12bfdbbcfe874c',1,'glfw3native.h']]], + ['glfwgetx11selectionstring_76',['glfwGetX11SelectionString',['../group__native.html#gae084ef64dc0db140b455b1427256d3f7',1,'glfw3native.h']]], + ['glfwgetx11window_77',['glfwGetX11Window',['../group__native.html#ga90ca676322740842db446999a1b1f21d',1,'glfw3native.h']]], + ['glfwhidewindow_78',['glfwHideWindow',['../group__window.html#ga49401f82a1ba5f15db5590728314d47c',1,'glfw3.h']]], + ['glfwiconifywindow_79',['glfwIconifyWindow',['../group__window.html#ga1bb559c0ebaad63c5c05ad2a066779c4',1,'glfw3.h']]], + ['glfwinit_80',['glfwInit',['../group__init.html#ga317aac130a235ab08c6db0834907d85e',1,'glfw3.h']]], + ['glfwinithint_81',['glfwInitHint',['../group__init.html#ga110fd1d3f0412822b4f1908c026f724a',1,'glfw3.h']]], + ['glfwjoystickisgamepad_82',['glfwJoystickIsGamepad',['../group__input.html#gad0f676860f329d80f7e47e9f06a96f00',1,'glfw3.h']]], + ['glfwjoystickpresent_83',['glfwJoystickPresent',['../group__input.html#gaed0966cee139d815317f9ffcba64c9f1',1,'glfw3.h']]], + ['glfwmakecontextcurrent_84',['glfwMakeContextCurrent',['../group__context.html#ga1c04dc242268f827290fe40aa1c91157',1,'glfw3.h']]], + ['glfwmaximizewindow_85',['glfwMaximizeWindow',['../group__window.html#ga3f541387449d911274324ae7f17ec56b',1,'glfw3.h']]], + ['glfwpollevents_86',['glfwPollEvents',['../group__window.html#ga37bd57223967b4211d60ca1a0bf3c832',1,'glfw3.h']]], + ['glfwpostemptyevent_87',['glfwPostEmptyEvent',['../group__window.html#gab5997a25187e9fd5c6f2ecbbc8dfd7e9',1,'glfw3.h']]], + ['glfwrawmousemotionsupported_88',['glfwRawMouseMotionSupported',['../group__input.html#gae4ee0dbd0d256183e1ea4026d897e1c2',1,'glfw3.h']]], + ['glfwrequestwindowattention_89',['glfwRequestWindowAttention',['../group__window.html#ga2f8d59323fc4692c1d54ba08c863a703',1,'glfw3.h']]], + ['glfwrestorewindow_90',['glfwRestoreWindow',['../group__window.html#ga52527a5904b47d802b6b4bb519cdebc7',1,'glfw3.h']]], + ['glfwsetcharcallback_91',['glfwSetCharCallback',['../group__input.html#gab25c4a220fd8f5717718dbc487828996',1,'glfw3.h']]], + ['glfwsetcharmodscallback_92',['glfwSetCharModsCallback',['../group__input.html#ga0b7f4ad13c2b17435ff13b6dcfb4e43c',1,'glfw3.h']]], + ['glfwsetclipboardstring_93',['glfwSetClipboardString',['../group__input.html#gaba1f022c5eb07dfac421df34cdcd31dd',1,'glfw3.h']]], + ['glfwsetcursor_94',['glfwSetCursor',['../group__input.html#gad3b4f38c8d5dae036bc8fa959e18343e',1,'glfw3.h']]], + ['glfwsetcursorentercallback_95',['glfwSetCursorEnterCallback',['../group__input.html#gad27f8ad0142c038a281466c0966817d8',1,'glfw3.h']]], + ['glfwsetcursorpos_96',['glfwSetCursorPos',['../group__input.html#ga04b03af936d906ca123c8f4ee08b39e7',1,'glfw3.h']]], + ['glfwsetcursorposcallback_97',['glfwSetCursorPosCallback',['../group__input.html#gac1f879ab7435d54d4d79bb469fe225d7',1,'glfw3.h']]], + ['glfwsetdropcallback_98',['glfwSetDropCallback',['../group__input.html#gab773f0ee0a07cff77a210cea40bc1f6b',1,'glfw3.h']]], + ['glfwseterrorcallback_99',['glfwSetErrorCallback',['../group__init.html#gaff45816610d53f0b83656092a4034f40',1,'glfw3.h']]], + ['glfwsetframebuffersizecallback_100',['glfwSetFramebufferSizeCallback',['../group__window.html#gab3fb7c3366577daef18c0023e2a8591f',1,'glfw3.h']]], + ['glfwsetgamma_101',['glfwSetGamma',['../group__monitor.html#ga6ac582625c990220785ddd34efa3169a',1,'glfw3.h']]], + ['glfwsetgammaramp_102',['glfwSetGammaRamp',['../group__monitor.html#ga583f0ffd0d29613d8cd172b996bbf0dd',1,'glfw3.h']]], + ['glfwsetinputmode_103',['glfwSetInputMode',['../group__input.html#gaa92336e173da9c8834558b54ee80563b',1,'glfw3.h']]], + ['glfwsetjoystickcallback_104',['glfwSetJoystickCallback',['../group__input.html#ga2f60a0e5b7bd8d1b7344dc0a7cb32b4c',1,'glfw3.h']]], + ['glfwsetjoystickuserpointer_105',['glfwSetJoystickUserPointer',['../group__input.html#ga6b2f72d64d636b48a727b437cbb7489e',1,'glfw3.h']]], + ['glfwsetkeycallback_106',['glfwSetKeyCallback',['../group__input.html#ga1caf18159767e761185e49a3be019f8d',1,'glfw3.h']]], + ['glfwsetmonitorcallback_107',['glfwSetMonitorCallback',['../group__monitor.html#gab39df645587c8518192aa746c2fb06c3',1,'glfw3.h']]], + ['glfwsetmonitoruserpointer_108',['glfwSetMonitorUserPointer',['../group__monitor.html#ga702750e24313a686d3637297b6e85fda',1,'glfw3.h']]], + ['glfwsetmousebuttoncallback_109',['glfwSetMouseButtonCallback',['../group__input.html#ga6ab84420974d812bee700e45284a723c',1,'glfw3.h']]], + ['glfwsetscrollcallback_110',['glfwSetScrollCallback',['../group__input.html#ga571e45a030ae4061f746ed56cb76aede',1,'glfw3.h']]], + ['glfwsettime_111',['glfwSetTime',['../group__input.html#gaf59589ef6e8b8c8b5ad184b25afd4dc0',1,'glfw3.h']]], + ['glfwsetwindowaspectratio_112',['glfwSetWindowAspectRatio',['../group__window.html#ga72ac8cb1ee2e312a878b55153d81b937',1,'glfw3.h']]], + ['glfwsetwindowattrib_113',['glfwSetWindowAttrib',['../group__window.html#gace2afda29b4116ec012e410a6819033e',1,'glfw3.h']]], + ['glfwsetwindowclosecallback_114',['glfwSetWindowCloseCallback',['../group__window.html#gada646d775a7776a95ac000cfc1885331',1,'glfw3.h']]], + ['glfwsetwindowcontentscalecallback_115',['glfwSetWindowContentScaleCallback',['../group__window.html#gaf2832ebb5aa6c252a2d261de002c92d6',1,'glfw3.h']]], + ['glfwsetwindowfocuscallback_116',['glfwSetWindowFocusCallback',['../group__window.html#gac2d83c4a10f071baf841f6730528e66c',1,'glfw3.h']]], + ['glfwsetwindowicon_117',['glfwSetWindowIcon',['../group__window.html#gadd7ccd39fe7a7d1f0904666ae5932dc5',1,'glfw3.h']]], + ['glfwsetwindowiconifycallback_118',['glfwSetWindowIconifyCallback',['../group__window.html#gac793e9efd255567b5fb8b445052cfd3e',1,'glfw3.h']]], + ['glfwsetwindowmaximizecallback_119',['glfwSetWindowMaximizeCallback',['../group__window.html#gacbe64c339fbd94885e62145563b6dc93',1,'glfw3.h']]], + ['glfwsetwindowmonitor_120',['glfwSetWindowMonitor',['../group__window.html#ga81c76c418af80a1cce7055bccb0ae0a7',1,'glfw3.h']]], + ['glfwsetwindowopacity_121',['glfwSetWindowOpacity',['../group__window.html#gac31caeb3d1088831b13d2c8a156802e9',1,'glfw3.h']]], + ['glfwsetwindowpos_122',['glfwSetWindowPos',['../group__window.html#ga1abb6d690e8c88e0c8cd1751356dbca8',1,'glfw3.h']]], + ['glfwsetwindowposcallback_123',['glfwSetWindowPosCallback',['../group__window.html#ga08bdfbba88934f9c4f92fd757979ac74',1,'glfw3.h']]], + ['glfwsetwindowrefreshcallback_124',['glfwSetWindowRefreshCallback',['../group__window.html#ga1c5c7eb889c33c7f4d10dd35b327654e',1,'glfw3.h']]], + ['glfwsetwindowshouldclose_125',['glfwSetWindowShouldClose',['../group__window.html#ga49c449dde2a6f87d996f4daaa09d6708',1,'glfw3.h']]], + ['glfwsetwindowsize_126',['glfwSetWindowSize',['../group__window.html#ga371911f12c74c504dd8d47d832d095cb',1,'glfw3.h']]], + ['glfwsetwindowsizecallback_127',['glfwSetWindowSizeCallback',['../group__window.html#gad91b8b047a0c4c6033c38853864c34f8',1,'glfw3.h']]], + ['glfwsetwindowsizelimits_128',['glfwSetWindowSizeLimits',['../group__window.html#gac314fa6cec7d2d307be9963e2709cc90',1,'glfw3.h']]], + ['glfwsetwindowtitle_129',['glfwSetWindowTitle',['../group__window.html#ga5d877f09e968cef7a360b513306f17ff',1,'glfw3.h']]], + ['glfwsetwindowuserpointer_130',['glfwSetWindowUserPointer',['../group__window.html#ga3d2fc6026e690ab31a13f78bc9fd3651',1,'glfw3.h']]], + ['glfwsetx11selectionstring_131',['glfwSetX11SelectionString',['../group__native.html#ga55f879ab02d93367f966186b6f0133f7',1,'glfw3native.h']]], + ['glfwshowwindow_132',['glfwShowWindow',['../group__window.html#ga61be47917b72536a148300f46494fc66',1,'glfw3.h']]], + ['glfwswapbuffers_133',['glfwSwapBuffers',['../group__window.html#ga15a5a1ee5b3c2ca6b15ca209a12efd14',1,'glfw3.h']]], + ['glfwswapinterval_134',['glfwSwapInterval',['../group__context.html#ga6d4e0cdf151b5e579bd67f13202994ed',1,'glfw3.h']]], + ['glfwterminate_135',['glfwTerminate',['../group__init.html#gaaae48c0a18607ea4a4ba951d939f0901',1,'glfw3.h']]], + ['glfwupdategamepadmappings_136',['glfwUpdateGamepadMappings',['../group__input.html#gaed5104612f2fa8e66aa6e846652ad00f',1,'glfw3.h']]], + ['glfwvulkansupported_137',['glfwVulkanSupported',['../group__vulkan.html#ga2e7f30931e02464b5bc8d0d4b6f9fe2b',1,'glfw3.h']]], + ['glfwwaitevents_138',['glfwWaitEvents',['../group__window.html#ga554e37d781f0a997656c26b2c56c835e',1,'glfw3.h']]], + ['glfwwaiteventstimeout_139',['glfwWaitEventsTimeout',['../group__window.html#ga605a178db92f1a7f1a925563ef3ea2cf',1,'glfw3.h']]], + ['glfwwindowhint_140',['glfwWindowHint',['../group__window.html#ga7d9c8c62384b1e2821c4dc48952d2033',1,'glfw3.h']]], + ['glfwwindowhintstring_141',['glfwWindowHintString',['../group__window.html#ga8cb2782861c9d997bcf2dea97f363e5f',1,'glfw3.h']]], + ['glfwwindowshouldclose_142',['glfwWindowShouldClose',['../group__window.html#ga24e02fbfefbb81fc45320989f8140ab5',1,'glfw3.h']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_0.html b/deps/glfw-3.3.8/docs/html/search/groups_0.html new file mode 100644 index 0000000..76e992a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_0.js b/deps/glfw-3.3.8/docs/html/search/groups_0.js new file mode 100644 index 0000000..93c0706 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['context_20reference_0',['Context reference',['../group__context.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_1.html b/deps/glfw-3.3.8/docs/html/search/groups_1.html new file mode 100644 index 0000000..38ad74b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_1.js b/deps/glfw-3.3.8/docs/html/search/groups_1.js new file mode 100644 index 0000000..eedfab6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['error_20codes_0',['Error codes',['../group__errors.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_2.html b/deps/glfw-3.3.8/docs/html/search/groups_2.html new file mode 100644 index 0000000..8152426 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_2.js b/deps/glfw-3.3.8/docs/html/search/groups_2.js new file mode 100644 index 0000000..fa4eb8e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['gamepad_20axes_0',['Gamepad axes',['../group__gamepad__axes.html',1,'']]], + ['gamepad_20buttons_1',['Gamepad buttons',['../group__gamepad__buttons.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_3.html b/deps/glfw-3.3.8/docs/html/search/groups_3.html new file mode 100644 index 0000000..c73a37c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_3.js b/deps/glfw-3.3.8/docs/html/search/groups_3.js new file mode 100644 index 0000000..8dd9d34 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_3.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['initialization_2c_20version_20and_20error_20reference_0',['Initialization, version and error reference',['../group__init.html',1,'']]], + ['input_20reference_1',['Input reference',['../group__input.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_4.html b/deps/glfw-3.3.8/docs/html/search/groups_4.html new file mode 100644 index 0000000..d42aefb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_4.js b/deps/glfw-3.3.8/docs/html/search/groups_4.js new file mode 100644 index 0000000..13c7e1c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_4.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['joystick_20hat_20states_0',['Joystick hat states',['../group__hat__state.html',1,'']]], + ['joysticks_1',['Joysticks',['../group__joysticks.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_5.html b/deps/glfw-3.3.8/docs/html/search/groups_5.html new file mode 100644 index 0000000..cf1d61a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_5.js b/deps/glfw-3.3.8/docs/html/search/groups_5.js new file mode 100644 index 0000000..85dae9f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_5.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['keyboard_20keys_0',['Keyboard keys',['../group__keys.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_6.html b/deps/glfw-3.3.8/docs/html/search/groups_6.html new file mode 100644 index 0000000..16ccc00 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_6.js b/deps/glfw-3.3.8/docs/html/search/groups_6.js new file mode 100644 index 0000000..ecd175e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_6.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['modifier_20key_20flags_0',['Modifier key flags',['../group__mods.html',1,'']]], + ['monitor_20reference_1',['Monitor reference',['../group__monitor.html',1,'']]], + ['mouse_20buttons_2',['Mouse buttons',['../group__buttons.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_7.html b/deps/glfw-3.3.8/docs/html/search/groups_7.html new file mode 100644 index 0000000..3e24bea --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_7.js b/deps/glfw-3.3.8/docs/html/search/groups_7.js new file mode 100644 index 0000000..423f6a5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['native_20access_0',['Native access',['../group__native.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_8.html b/deps/glfw-3.3.8/docs/html/search/groups_8.html new file mode 100644 index 0000000..7c2c286 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_8.js b/deps/glfw-3.3.8/docs/html/search/groups_8.js new file mode 100644 index 0000000..92f24a5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['standard_20cursor_20shapes_0',['Standard cursor shapes',['../group__shapes.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_9.html b/deps/glfw-3.3.8/docs/html/search/groups_9.html new file mode 100644 index 0000000..c7d6799 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_9.js b/deps/glfw-3.3.8/docs/html/search/groups_9.js new file mode 100644 index 0000000..7b5ed3f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['vulkan_20support_20reference_0',['Vulkan support reference',['../group__vulkan.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/groups_a.html b/deps/glfw-3.3.8/docs/html/search/groups_a.html new file mode 100644 index 0000000..7abe5e7 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_a.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/groups_a.js b/deps/glfw-3.3.8/docs/html/search/groups_a.js new file mode 100644 index 0000000..b9c307f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/groups_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['window_20reference_0',['Window reference',['../group__window.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/mag_sel.svg b/deps/glfw-3.3.8/docs/html/search/mag_sel.svg new file mode 100644 index 0000000..03626f6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/mag_sel.svg @@ -0,0 +1,74 @@ + + + + + + + + image/svg+xml + + + + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/html/search/nomatches.html b/deps/glfw-3.3.8/docs/html/search/nomatches.html new file mode 100644 index 0000000..2b9360b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/nomatches.html @@ -0,0 +1,13 @@ + + + + + + + + +
    +
    No Matches
    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_0.html b/deps/glfw-3.3.8/docs/html/search/pages_0.html new file mode 100644 index 0000000..1981712 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_0.js b/deps/glfw-3.3.8/docs/html/search/pages_0.js new file mode 100644 index 0000000..22546b5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['building_20applications_0',['Building applications',['../build_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_1.html b/deps/glfw-3.3.8/docs/html/search/pages_1.html new file mode 100644 index 0000000..320e4a4 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_1.js b/deps/glfw-3.3.8/docs/html/search/pages_1.js new file mode 100644 index 0000000..8585995 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_1.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['compiling_20glfw_0',['Compiling GLFW',['../compile_guide.html',1,'']]], + ['context_20guide_1',['Context guide',['../context_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_2.html b/deps/glfw-3.3.8/docs/html/search/pages_2.html new file mode 100644 index 0000000..396bc18 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_2.js b/deps/glfw-3.3.8/docs/html/search/pages_2.js new file mode 100644 index 0000000..4d85845 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_2.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['deprecated_20list_0',['Deprecated List',['../deprecated.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_3.html b/deps/glfw-3.3.8/docs/html/search/pages_3.html new file mode 100644 index 0000000..7a70856 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_3.js b/deps/glfw-3.3.8/docs/html/search/pages_3.js new file mode 100644 index 0000000..c8458cc --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['getting_20started_0',['Getting started',['../quick_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_4.html b/deps/glfw-3.3.8/docs/html/search/pages_4.html new file mode 100644 index 0000000..b43cefb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_4.js b/deps/glfw-3.3.8/docs/html/search/pages_4.js new file mode 100644 index 0000000..f6548e8 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['input_20guide_0',['Input guide',['../input_guide.html',1,'']]], + ['internal_20structure_1',['Internal structure',['../internals_guide.html',1,'']]], + ['introduction_20to_20the_20api_2',['Introduction to the API',['../intro_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_5.html b/deps/glfw-3.3.8/docs/html/search/pages_5.html new file mode 100644 index 0000000..6a95553 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_5.js b/deps/glfw-3.3.8/docs/html/search/pages_5.js new file mode 100644 index 0000000..1a7683e --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['monitor_20guide_0',['Monitor guide',['../monitor_guide.html',1,'']]], + ['moving_20from_20glfw_202_20to_203_1',['Moving from GLFW 2 to 3',['../moving_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_6.html b/deps/glfw-3.3.8/docs/html/search/pages_6.html new file mode 100644 index 0000000..6432c81 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_6.js b/deps/glfw-3.3.8/docs/html/search/pages_6.js new file mode 100644 index 0000000..ea1a4d1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['notitle_0',['notitle',['../index.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_7.html b/deps/glfw-3.3.8/docs/html/search/pages_7.html new file mode 100644 index 0000000..33d7d8b --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_7.js b/deps/glfw-3.3.8/docs/html/search/pages_7.js new file mode 100644 index 0000000..322b61a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['release_20notes_0',['Release notes',['../news.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_8.html b/deps/glfw-3.3.8/docs/html/search/pages_8.html new file mode 100644 index 0000000..c634607 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_8.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_8.js b/deps/glfw-3.3.8/docs/html/search/pages_8.js new file mode 100644 index 0000000..e46b235 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['standards_20conformance_0',['Standards conformance',['../compat_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_9.html b/deps/glfw-3.3.8/docs/html/search/pages_9.html new file mode 100644 index 0000000..3473073 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_9.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_9.js b/deps/glfw-3.3.8/docs/html/search/pages_9.js new file mode 100644 index 0000000..8cae3f5 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_9.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['vulkan_20guide_0',['Vulkan guide',['../vulkan_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/pages_a.html b/deps/glfw-3.3.8/docs/html/search/pages_a.html new file mode 100644 index 0000000..acc508a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_a.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/pages_a.js b/deps/glfw-3.3.8/docs/html/search/pages_a.js new file mode 100644 index 0000000..8078165 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/pages_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['window_20guide_0',['Window guide',['../window_guide.html',1,'']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/search.css b/deps/glfw-3.3.8/docs/html/search/search.css new file mode 100644 index 0000000..648a792 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/search.css @@ -0,0 +1,263 @@ +/*---------------- Search Box */ + +#MSearchBox { + white-space : nowrap; + background: white; + border-radius: 0.65em; + box-shadow: inset 0.5px 0.5px 3px 0px #555; + z-index: 102; +} + +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; +} + +#MSearchSelect { + display: inline-block; + vertical-align: middle; + height: 19px; + padding: 0 0 0 0.3em; + margin: 0; +} + +#MSearchField { + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 19px; + margin: 0 0.15em; + padding: 0; + line-height: 1em; + border:none; + color: #909090; + outline: none; + font-family: Arial, Verdana, sans-serif; + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; +} + +@media(hover: none) { + /* to avoid zooming on iOS */ + #MSearchField { + font-size: 16px; + } +} + +#MSearchBox .right { + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; +} + +#MSearchClose { + display: none; + font-size: inherit; + background : none; + border: none; + margin: 0; + padding: 0; + outline: none; + +} + +#MSearchCloseImg { + height: 1.4em; + padding: 0.3em; + margin: 0; +} + +.MSearchBoxActive #MSearchField { + color: #000000; +} + +#main-menu > li:last-child { + /* This
  • object is the parent of the search bar */ + display: flex; + justify-content: center; + align-items: center; + height: 36px; + margin-right: 1em; +} + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #90A5CE; + background-color: #F9FAFC; + z-index: 10001; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt Arial, Verdana, sans-serif; + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: monospace; + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: #000000; + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: #000000; + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: #FFFFFF; + background-color: #3D578C; + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + /*width: 60ex;*/ + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid #000; + background-color: #EEF1F7; + z-index:10000; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; + padding-bottom: 15px; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +body.SRPage { + margin: 5px 2px; +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: #425E97; + font-family: Arial, Verdana, sans-serif; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; + font-family: Arial, Verdana, sans-serif; +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; + font-family: Arial, Verdana, sans-serif; +} + +.SRResult { + display: none; +} + +div.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.searchresult { + background-color: #F0F3F8; +} + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: url("../tab_a.png"); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/deps/glfw-3.3.8/docs/html/search/search.js b/deps/glfw-3.3.8/docs/html/search/search.js new file mode 100644 index 0000000..607f4e1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/search.js @@ -0,0 +1,802 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +function convertToId(search) +{ + var result = ''; + for (i=0;i do a search + { + this.Search(); + } + } + + this.OnSearchSelectKey = function(evt) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==40 && this.searchIndex0) // Up + { + this.searchIndex--; + this.OnSelectItem(this.searchIndex); + } + else if (e.keyCode==13 || e.keyCode==27) + { + this.OnSelectItem(this.searchIndex); + this.CloseSelectionWindow(); + this.DOMSearchField().focus(); + } + return false; + } + + // --------- Actions + + // Closes the results window. + this.CloseResultsWindow = function() + { + this.DOMPopupSearchResultsWindow().style.display = 'none'; + this.DOMSearchClose().style.display = 'none'; + this.Activate(false); + } + + this.CloseSelectionWindow = function() + { + this.DOMSearchSelectWindow().style.display = 'none'; + } + + // Performs a search. + this.Search = function() + { + this.keyTimeout = 0; + + // strip leading whitespace + var searchValue = this.DOMSearchField().value.replace(/^ +/, ""); + + var code = searchValue.toLowerCase().charCodeAt(0); + var idxChar = searchValue.substr(0, 1).toLowerCase(); + if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair + { + idxChar = searchValue.substr(0, 2); + } + + var resultsPage; + var resultsPageWithSearch; + var hasResultsPage; + + var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar); + if (idx!=-1) + { + var hexCode=idx.toString(16); + resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + this.extension; + resultsPageWithSearch = resultsPage+'?'+escape(searchValue); + hasResultsPage = true; + } + else // nothing available for this search term + { + resultsPage = this.resultsPath + '/nomatches' + this.extension; + resultsPageWithSearch = resultsPage; + hasResultsPage = false; + } + + window.frames.MSearchResults.location = resultsPageWithSearch; + var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow(); + + if (domPopupSearchResultsWindow.style.display!='block') + { + var domSearchBox = this.DOMSearchBox(); + this.DOMSearchClose().style.display = 'inline-block'; + var domPopupSearchResults = this.DOMPopupSearchResults(); + var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth; + var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1; + domPopupSearchResultsWindow.style.display = 'block'; + left -= domPopupSearchResults.offsetWidth; + var maxWidth = document.body.clientWidth; + var width = 400; + if (left<10) left=10; + if (width+left+8>maxWidth) width=maxWidth-left-8; + domPopupSearchResultsWindow.style.top = top + 'px'; + domPopupSearchResultsWindow.style.left = left + 'px'; + domPopupSearchResultsWindow.style.width = width + 'px'; + } + + this.lastSearchValue = searchValue; + this.lastResultsPage = resultsPage; + } + + // -------- Activation Functions + + // Activates or deactivates the search panel, resetting things to + // their default values if necessary. + this.Activate = function(isActive) + { + if (isActive || // open it + this.DOMPopupSearchResultsWindow().style.display == 'block' + ) + { + this.DOMSearchBox().className = 'MSearchBoxActive'; + + var searchField = this.DOMSearchField(); + + if (searchField.value == this.searchLabel) // clear "Search" term upon entry + { + searchField.value = ''; + this.searchActive = true; + } + } + else if (!isActive) // directly remove the panel + { + this.DOMSearchBox().className = 'MSearchBoxInactive'; + this.DOMSearchField().value = this.searchLabel; + this.searchActive = false; + this.lastSearchValue = '' + this.lastResultsPage = ''; + } + } +} + +// ----------------------------------------------------------------------- + +// The class that handles everything on the search results page. +function SearchResults(name) +{ + // The number of matches from the last run of . + this.lastMatchCount = 0; + this.lastKey = 0; + this.repeatOn = false; + + // Toggles the visibility of the passed element ID. + this.FindChildElement = function(id) + { + var parentElement = document.getElementById(id); + var element = parentElement.firstChild; + + while (element && element!=parentElement) + { + if (element.nodeName.toLowerCase() == 'div' && element.className == 'SRChildren') + { + return element; + } + + if (element.nodeName.toLowerCase() == 'div' && element.hasChildNodes()) + { + element = element.firstChild; + } + else if (element.nextSibling) + { + element = element.nextSibling; + } + else + { + do + { + element = element.parentNode; + } + while (element && element!=parentElement && !element.nextSibling); + + if (element && element!=parentElement) + { + element = element.nextSibling; + } + } + } + } + + this.Toggle = function(id) + { + var element = this.FindChildElement(id); + if (element) + { + if (element.style.display == 'block') + { + element.style.display = 'none'; + } + else + { + element.style.display = 'block'; + } + } + } + + // Searches for the passed string. If there is no parameter, + // it takes it from the URL query. + // + // Always returns true, since other documents may try to call it + // and that may or may not be possible. + this.Search = function(search) + { + if (!search) // get search word from URL + { + search = window.location.search; + search = search.substring(1); // Remove the leading '?' + search = unescape(search); + } + + search = search.replace(/^ +/, ""); // strip leading spaces + search = search.replace(/ +$/, ""); // strip trailing spaces + search = search.toLowerCase(); + search = convertToId(search); + + var resultRows = document.getElementsByTagName("div"); + var matches = 0; + + var i = 0; + while (i < resultRows.length) + { + var row = resultRows.item(i); + if (row.className == "SRResult") + { + var rowMatchName = row.id.toLowerCase(); + rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_' + + if (search.length<=rowMatchName.length && + rowMatchName.substr(0, search.length)==search) + { + row.style.display = 'block'; + matches++; + } + else + { + row.style.display = 'none'; + } + } + i++; + } + document.getElementById("Searching").style.display='none'; + if (matches == 0) // no results + { + document.getElementById("NoMatches").style.display='block'; + } + else // at least one result + { + document.getElementById("NoMatches").style.display='none'; + } + this.lastMatchCount = matches; + return true; + } + + // return the first item with index index or higher that is visible + this.NavNext = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index++; + } + return focusItem; + } + + this.NavPrev = function(index) + { + var focusItem; + while (1) + { + var focusName = 'Item'+index; + focusItem = document.getElementById(focusName); + if (focusItem && focusItem.parentNode.parentNode.style.display=='block') + { + break; + } + else if (!focusItem) // last element + { + break; + } + focusItem=null; + index--; + } + return focusItem; + } + + this.ProcessKeys = function(e) + { + if (e.type == "keydown") + { + this.repeatOn = false; + this.lastKey = e.keyCode; + } + else if (e.type == "keypress") + { + if (!this.repeatOn) + { + if (this.lastKey) this.repeatOn = true; + return false; // ignore first keypress after keydown + } + } + else if (e.type == "keyup") + { + this.lastKey = 0; + this.repeatOn = false; + } + return this.lastKey!=0; + } + + this.Nav = function(evt,itemIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + var newIndex = itemIndex-1; + var focusItem = this.NavPrev(newIndex); + if (focusItem) + { + var child = this.FindChildElement(focusItem.parentNode.parentNode.id); + if (child && child.style.display == 'block') // children visible + { + var n=0; + var tmpElem; + while (1) // search for last child + { + tmpElem = document.getElementById('Item'+newIndex+'_c'+n); + if (tmpElem) + { + focusItem = tmpElem; + } + else // found it! + { + break; + } + n++; + } + } + } + if (focusItem) + { + focusItem.focus(); + } + else // return focus to search field + { + parent.document.getElementById("MSearchField").focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = itemIndex+1; + var focusItem; + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem && elem.style.display == 'block') // children visible + { + focusItem = document.getElementById('Item'+itemIndex+'_c0'); + } + if (!focusItem) focusItem = this.NavNext(newIndex); + if (focusItem) focusItem.focus(); + } + else if (this.lastKey==39) // Right + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'block'; + } + else if (this.lastKey==37) // Left + { + var item = document.getElementById('Item'+itemIndex); + var elem = this.FindChildElement(item.parentNode.parentNode.id); + if (elem) elem.style.display = 'none'; + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } + + this.NavChild = function(evt,itemIndex,childIndex) + { + var e = (evt) ? evt : window.event; // for IE + if (e.keyCode==13) return true; + if (!this.ProcessKeys(e)) return false; + + if (this.lastKey==38) // Up + { + if (childIndex>0) + { + var newIndex = childIndex-1; + document.getElementById('Item'+itemIndex+'_c'+newIndex).focus(); + } + else // already at first child, jump to parent + { + document.getElementById('Item'+itemIndex).focus(); + } + } + else if (this.lastKey==40) // Down + { + var newIndex = childIndex+1; + var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex); + if (!elem) // last child, jump to parent next parent + { + elem = this.NavNext(itemIndex+1); + } + if (elem) + { + elem.focus(); + } + } + else if (this.lastKey==27) // Escape + { + parent.searchBox.CloseResultsWindow(); + parent.document.getElementById("MSearchField").focus(); + } + else if (this.lastKey==13) // Enter + { + return true; + } + return false; + } +} + +function setKeyActions(elem,action) +{ + elem.setAttribute('onkeydown',action); + elem.setAttribute('onkeypress',action); + elem.setAttribute('onkeyup',action); +} + +function setClassAttr(elem,attr) +{ + elem.setAttribute('class',attr); + elem.setAttribute('className',attr); +} + +function createResults() +{ + var results = document.getElementById("SRResults"); + for (var e=0; e + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/typedefs_0.js b/deps/glfw-3.3.8/docs/html/search/typedefs_0.js new file mode 100644 index 0000000..4ce15bc --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/typedefs_0.js @@ -0,0 +1,32 @@ +var searchData= +[ + ['glfwcharfun_0',['GLFWcharfun',['../group__input.html#ga1ab90a55cf3f58639b893c0f4118cb6e',1,'glfw3.h']]], + ['glfwcharmodsfun_1',['GLFWcharmodsfun',['../group__input.html#gac3cf64f90b6219c05ac7b7822d5a4b8f',1,'glfw3.h']]], + ['glfwcursor_2',['GLFWcursor',['../group__input.html#ga89261ae18c75e863aaf2656ecdd238f4',1,'glfw3.h']]], + ['glfwcursorenterfun_3',['GLFWcursorenterfun',['../group__input.html#gaa93dc4818ac9ab32532909d53a337cbe',1,'glfw3.h']]], + ['glfwcursorposfun_4',['GLFWcursorposfun',['../group__input.html#gad6fae41b3ac2e4209aaa87b596c57f68',1,'glfw3.h']]], + ['glfwdropfun_5',['GLFWdropfun',['../group__input.html#gaaba73c3274062c18723b7f05862d94b2',1,'glfw3.h']]], + ['glfwerrorfun_6',['GLFWerrorfun',['../group__init.html#ga8184701785c096b3862a75cda1bf44a3',1,'glfw3.h']]], + ['glfwframebuffersizefun_7',['GLFWframebuffersizefun',['../group__window.html#gae18026e294dde685ed2e5f759533144d',1,'glfw3.h']]], + ['glfwgamepadstate_8',['GLFWgamepadstate',['../group__input.html#ga61acfb1f28f751438dd221225c5e725d',1,'glfw3.h']]], + ['glfwgammaramp_9',['GLFWgammaramp',['../group__monitor.html#ga939cf093cb0af0498b7b54dc2e181404',1,'glfw3.h']]], + ['glfwglproc_10',['GLFWglproc',['../group__context.html#ga3d47c2d2fbe0be9c505d0e04e91a133c',1,'glfw3.h']]], + ['glfwimage_11',['GLFWimage',['../group__window.html#ga7cc0a09de172fa7250872046f8c4d2ca',1,'glfw3.h']]], + ['glfwjoystickfun_12',['GLFWjoystickfun',['../group__input.html#gaa21ad5986ae9a26077a40142efb56243',1,'glfw3.h']]], + ['glfwkeyfun_13',['GLFWkeyfun',['../group__input.html#ga5bd751b27b90f865d2ea613533f0453c',1,'glfw3.h']]], + ['glfwmonitor_14',['GLFWmonitor',['../group__monitor.html#ga8d9efd1cde9426692c73fe40437d0ae3',1,'glfw3.h']]], + ['glfwmonitorfun_15',['GLFWmonitorfun',['../group__monitor.html#gaabe16caca8dea952504dfdebdf4cd249',1,'glfw3.h']]], + ['glfwmousebuttonfun_16',['GLFWmousebuttonfun',['../group__input.html#ga0184dcb59f6d85d735503dcaae809727',1,'glfw3.h']]], + ['glfwscrollfun_17',['GLFWscrollfun',['../group__input.html#gaf656112c33de3efdb227fa58f0134cf5',1,'glfw3.h']]], + ['glfwvidmode_18',['GLFWvidmode',['../group__monitor.html#ga902c2816ac9b34b757282daab59b2565',1,'glfw3.h']]], + ['glfwvkproc_19',['GLFWvkproc',['../group__vulkan.html#ga70c01918dc9d233a4fbe0681a43018af',1,'glfw3.h']]], + ['glfwwindow_20',['GLFWwindow',['../group__window.html#ga3c96d80d363e67d13a41b5d1821f3242',1,'glfw3.h']]], + ['glfwwindowclosefun_21',['GLFWwindowclosefun',['../group__window.html#gabf859b936d80961b7d39013a9694cc3e',1,'glfw3.h']]], + ['glfwwindowcontentscalefun_22',['GLFWwindowcontentscalefun',['../group__window.html#ga77f288a2d04bb3c77c7d9615d08cf70e',1,'glfw3.h']]], + ['glfwwindowfocusfun_23',['GLFWwindowfocusfun',['../group__window.html#gabc58c47e9d93f6eb1862d615c3680f46',1,'glfw3.h']]], + ['glfwwindowiconifyfun_24',['GLFWwindowiconifyfun',['../group__window.html#ga35c658cccba236f26e7adee0e25f6a4f',1,'glfw3.h']]], + ['glfwwindowmaximizefun_25',['GLFWwindowmaximizefun',['../group__window.html#ga3017196fdaec33ac3e095765176c2a90',1,'glfw3.h']]], + ['glfwwindowposfun_26',['GLFWwindowposfun',['../group__window.html#gabe287973a21a8f927cde4db06b8dcbe9',1,'glfw3.h']]], + ['glfwwindowrefreshfun_27',['GLFWwindowrefreshfun',['../group__window.html#ga431663a1427d2eb3a273bc398b6737b5',1,'glfw3.h']]], + ['glfwwindowsizefun_28',['GLFWwindowsizefun',['../group__window.html#gaec0282944bb810f6f3163ec02da90350',1,'glfw3.h']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_0.html b/deps/glfw-3.3.8/docs/html/search/variables_0.html new file mode 100644 index 0000000..fd893a6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_0.js b/deps/glfw-3.3.8/docs/html/search/variables_0.js new file mode 100644 index 0000000..c61320f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['axes_0',['axes',['../structGLFWgamepadstate.html#a8b2c8939b1d31458de5359998375c189',1,'GLFWgamepadstate']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_1.html b/deps/glfw-3.3.8/docs/html/search/variables_1.html new file mode 100644 index 0000000..5f8e440 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_1.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_1.js b/deps/glfw-3.3.8/docs/html/search/variables_1.js new file mode 100644 index 0000000..20af6e6 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_1.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['blue_0',['blue',['../structGLFWgammaramp.html#acf0c836d0efe29c392fe8d1a1042744b',1,'GLFWgammaramp']]], + ['bluebits_1',['blueBits',['../structGLFWvidmode.html#af310977f58d2e3b188175b6e3d314047',1,'GLFWvidmode']]], + ['buttons_2',['buttons',['../structGLFWgamepadstate.html#a27e9896b51c65df15fba2c7139bfdb9a',1,'GLFWgamepadstate']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_2.html b/deps/glfw-3.3.8/docs/html/search/variables_2.html new file mode 100644 index 0000000..77a7f48 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_2.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_2.js b/deps/glfw-3.3.8/docs/html/search/variables_2.js new file mode 100644 index 0000000..ee6bfb1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_2.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['green_0',['green',['../structGLFWgammaramp.html#affccc6f5df47820b6562d709da3a5a3a',1,'GLFWgammaramp']]], + ['greenbits_1',['greenBits',['../structGLFWvidmode.html#a292fdd281f3485fb3ff102a5bda43faa',1,'GLFWvidmode']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_3.html b/deps/glfw-3.3.8/docs/html/search/variables_3.html new file mode 100644 index 0000000..3ee62ba --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_3.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_3.js b/deps/glfw-3.3.8/docs/html/search/variables_3.js new file mode 100644 index 0000000..c7cee75 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['height_0',['height',['../structGLFWvidmode.html#ac65942a5f6981695517437a9d571d03c',1,'GLFWvidmode::height()'],['../structGLFWimage.html#a0b7d95368f0c80d5e5c9875057c7dbec',1,'GLFWimage::height()']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_4.html b/deps/glfw-3.3.8/docs/html/search/variables_4.html new file mode 100644 index 0000000..640713f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_4.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_4.js b/deps/glfw-3.3.8/docs/html/search/variables_4.js new file mode 100644 index 0000000..6414492 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['pixels_0',['pixels',['../structGLFWimage.html#a0c532a5c2bb715555279b7817daba0fb',1,'GLFWimage']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_5.html b/deps/glfw-3.3.8/docs/html/search/variables_5.html new file mode 100644 index 0000000..7b2ba97 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_5.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_5.js b/deps/glfw-3.3.8/docs/html/search/variables_5.js new file mode 100644 index 0000000..1bbbe9f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_5.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['red_0',['red',['../structGLFWgammaramp.html#a2cce5d968734b685623eef913e635138',1,'GLFWgammaramp']]], + ['redbits_1',['redBits',['../structGLFWvidmode.html#a6066c4ecd251098700062d3b735dba1b',1,'GLFWvidmode']]], + ['refreshrate_2',['refreshRate',['../structGLFWvidmode.html#a791bdd6c7697b09f7e9c97054bf05649',1,'GLFWvidmode']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_6.html b/deps/glfw-3.3.8/docs/html/search/variables_6.html new file mode 100644 index 0000000..fb1de8f --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_6.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_6.js b/deps/glfw-3.3.8/docs/html/search/variables_6.js new file mode 100644 index 0000000..406842a --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['size_0',['size',['../structGLFWgammaramp.html#ad620e1cffbff9a32c51bca46301b59a5',1,'GLFWgammaramp']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/search/variables_7.html b/deps/glfw-3.3.8/docs/html/search/variables_7.html new file mode 100644 index 0000000..cf8dcf4 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_7.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
    +
    Loading...
    +
    + +
    Searching...
    +
    No Matches
    + +
    + + diff --git a/deps/glfw-3.3.8/docs/html/search/variables_7.js b/deps/glfw-3.3.8/docs/html/search/variables_7.js new file mode 100644 index 0000000..7d2fabb --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/search/variables_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['width_0',['width',['../structGLFWvidmode.html#a698dcb200562051a7249cb6ae154c71d',1,'GLFWvidmode::width()'],['../structGLFWimage.html#af6a71cc999fe6d3aea31dd7e9687d835',1,'GLFWimage::width()']]] +]; diff --git a/deps/glfw-3.3.8/docs/html/spaces.svg b/deps/glfw-3.3.8/docs/html/spaces.svg new file mode 100644 index 0000000..5b32646 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/spaces.svg @@ -0,0 +1,877 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +   + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/html/splitbar.png b/deps/glfw-3.3.8/docs/html/splitbar.png new file mode 100644 index 0000000..fe895f2 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/splitbar.png differ diff --git a/deps/glfw-3.3.8/docs/html/structGLFWgamepadstate.html b/deps/glfw-3.3.8/docs/html/structGLFWgamepadstate.html new file mode 100644 index 0000000..aa66b91 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWgamepadstate.html @@ -0,0 +1,129 @@ + + + + + + + +GLFW: GLFWgamepadstate Struct Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    GLFWgamepadstate Struct Reference
    Input reference
    +
    +
    + +

    Gamepad input state. + More...

    + +

    #include <glfw3.h>

    + + + + + + +

    +Data Fields

    unsigned char buttons [15]
     
    float axes [6]
     
    +

    Detailed Description

    +

    This describes the input state of a gamepad.

    +
    See also
    Gamepad input
    +
    +glfwGetGamepadState
    +
    Since
    Added in version 3.3.
    +

    Field Documentation

    + +

    ◆ buttons

    + +
    +
    + + + + +
    unsigned char GLFWgamepadstate::buttons[15]
    +
    +

    The states of each gamepad button, GLFW_PRESS or GLFW_RELEASE.

    + +
    +
    + +

    ◆ axes

    + +
    +
    + + + + +
    float GLFWgamepadstate::axes[6]
    +
    +

    The states of each gamepad axis, in the range -1.0 to 1.0 inclusive.

    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html b/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html new file mode 100644 index 0000000..310d1cc --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWgammaramp.html @@ -0,0 +1,165 @@ + + + + + + + +GLFW: GLFWgammaramp Struct Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    GLFWgammaramp Struct Reference
    Monitor reference
    +
    +
    + +

    Gamma ramp. + More...

    + +

    #include <glfw3.h>

    + + + + + + + + + + +

    +Data Fields

    unsigned short * red
     
    unsigned short * green
     
    unsigned short * blue
     
    unsigned int size
     
    +

    Detailed Description

    +

    This describes the gamma ramp for a monitor.

    +
    See also
    Gamma ramp
    +
    +glfwGetGammaRamp
    +
    +glfwSetGammaRamp
    +
    Since
    Added in version 3.0.
    +

    Field Documentation

    + +

    ◆ red

    + +
    +
    + + + + +
    unsigned short* GLFWgammaramp::red
    +
    +

    An array of value describing the response of the red channel.

    + +
    +
    + +

    ◆ green

    + +
    +
    + + + + +
    unsigned short* GLFWgammaramp::green
    +
    +

    An array of value describing the response of the green channel.

    + +
    +
    + +

    ◆ blue

    + +
    +
    + + + + +
    unsigned short* GLFWgammaramp::blue
    +
    +

    An array of value describing the response of the blue channel.

    + +
    +
    + +

    ◆ size

    + +
    +
    + + + + +
    unsigned int GLFWgammaramp::size
    +
    +

    The number of elements in each array.

    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWimage.html b/deps/glfw-3.3.8/docs/html/structGLFWimage.html new file mode 100644 index 0000000..672209d --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWimage.html @@ -0,0 +1,146 @@ + + + + + + + +GLFW: GLFWimage Struct Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    GLFWimage Struct Reference
    Window reference
    +
    +
    + +

    Image data. + More...

    + +

    #include <glfw3.h>

    + + + + + + + + +

    +Data Fields

    int width
     
    int height
     
    unsigned char * pixels
     
    +

    Detailed Description

    +

    This describes a single 2D image. See the documentation for each related function what the expected pixel format is.

    +
    See also
    Custom cursor creation
    +
    +Window icon
    +
    Since
    Added in version 2.1. GLFW 3: Removed format and bytes-per-pixel members.
    +

    Field Documentation

    + +

    ◆ width

    + +
    +
    + + + + +
    int GLFWimage::width
    +
    +

    The width, in pixels, of this image.

    + +
    +
    + +

    ◆ height

    + +
    +
    + + + + +
    int GLFWimage::height
    +
    +

    The height, in pixels, of this image.

    + +
    +
    + +

    ◆ pixels

    + +
    +
    + + + + +
    unsigned char* GLFWimage::pixels
    +
    +

    The pixel data of this image, arranged left-to-right, top-to-bottom.

    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html b/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html new file mode 100644 index 0000000..c367377 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/structGLFWvidmode.html @@ -0,0 +1,199 @@ + + + + + + + +GLFW: GLFWvidmode Struct Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    +Data Fields
    +
    GLFWvidmode Struct Reference
    Monitor reference
    +
    +
    + +

    Video mode type. + More...

    + +

    #include <glfw3.h>

    + + + + + + + + + + + + + + +

    +Data Fields

    int width
     
    int height
     
    int redBits
     
    int greenBits
     
    int blueBits
     
    int refreshRate
     
    +

    Detailed Description

    +

    This describes a single video mode.

    +
    See also
    Video modes
    +
    +glfwGetVideoMode
    +
    +glfwGetVideoModes
    +
    Since
    Added in version 1.0. GLFW 3: Added refresh rate member.
    +

    Field Documentation

    + +

    ◆ width

    + +
    +
    + + + + +
    int GLFWvidmode::width
    +
    +

    The width, in screen coordinates, of the video mode.

    + +
    +
    + +

    ◆ height

    + +
    +
    + + + + +
    int GLFWvidmode::height
    +
    +

    The height, in screen coordinates, of the video mode.

    + +
    +
    + +

    ◆ redBits

    + +
    +
    + + + + +
    int GLFWvidmode::redBits
    +
    +

    The bit depth of the red channel of the video mode.

    + +
    +
    + +

    ◆ greenBits

    + +
    +
    + + + + +
    int GLFWvidmode::greenBits
    +
    +

    The bit depth of the green channel of the video mode.

    + +
    +
    + +

    ◆ blueBits

    + +
    +
    + + + + +
    int GLFWvidmode::blueBits
    +
    +

    The bit depth of the blue channel of the video mode.

    + +
    +
    + +

    ◆ refreshRate

    + +
    +
    + + + + +
    int GLFWvidmode::refreshRate
    +
    +

    The refresh rate, in Hz, of the video mode.

    + +
    +
    +
    The documentation for this struct was generated from the following file: +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/sync_off.png b/deps/glfw-3.3.8/docs/html/sync_off.png new file mode 100644 index 0000000..3b443fc Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/sync_off.png differ diff --git a/deps/glfw-3.3.8/docs/html/sync_on.png b/deps/glfw-3.3.8/docs/html/sync_on.png new file mode 100644 index 0000000..e08320f Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/sync_on.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_a.png b/deps/glfw-3.3.8/docs/html/tab_a.png new file mode 100644 index 0000000..3b725c4 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_a.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_b.png b/deps/glfw-3.3.8/docs/html/tab_b.png new file mode 100644 index 0000000..e2b4a86 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_b.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_h.png b/deps/glfw-3.3.8/docs/html/tab_h.png new file mode 100644 index 0000000..fd5cb70 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_h.png differ diff --git a/deps/glfw-3.3.8/docs/html/tab_s.png b/deps/glfw-3.3.8/docs/html/tab_s.png new file mode 100644 index 0000000..ab478c9 Binary files /dev/null and b/deps/glfw-3.3.8/docs/html/tab_s.png differ diff --git a/deps/glfw-3.3.8/docs/html/tabs.css b/deps/glfw-3.3.8/docs/html/tabs.css new file mode 100644 index 0000000..00d1c60 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/tabs.css @@ -0,0 +1 @@ +.sm{position:relative;z-index:9999}.sm,.sm ul,.sm li{display:block;list-style:none;margin:0;padding:0;line-height:normal;direction:ltr;text-align:left;-webkit-tap-highlight-color:rgba(0,0,0,0)}.sm-rtl,.sm-rtl ul,.sm-rtl li{direction:rtl;text-align:right}.sm>li>h1,.sm>li>h2,.sm>li>h3,.sm>li>h4,.sm>li>h5,.sm>li>h6{margin:0;padding:0}.sm ul{display:none}.sm li,.sm a{position:relative}.sm a{display:block}.sm a.disabled{cursor:not-allowed}.sm:after{content:"\00a0";display:block;height:0;font:0/0 serif;clear:both;visibility:hidden;overflow:hidden}.sm,.sm *,.sm *:before,.sm *:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}.main-menu-btn{position:relative;display:inline-block;width:36px;height:36px;text-indent:36px;margin-left:8px;white-space:nowrap;overflow:hidden;cursor:pointer;-webkit-tap-highlight-color:rgba(0,0,0,0)}.main-menu-btn-icon,.main-menu-btn-icon:before,.main-menu-btn-icon:after{position:absolute;top:50%;left:2px;height:2px;width:24px;background:#666;-webkit-transition:all .25s;transition:all .25s}.main-menu-btn-icon:before{content:'';top:-7px;left:0}.main-menu-btn-icon:after{content:'';top:7px;left:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon{height:0}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:before{top:0;-webkit-transform:rotate(-45deg);transform:rotate(-45deg)}#main-menu-state:checked ~ .main-menu-btn .main-menu-btn-icon:after{top:0;-webkit-transform:rotate(45deg);transform:rotate(45deg)}#main-menu-state{position:absolute;width:1px;height:1px;margin:-1px;border:0;padding:0;overflow:hidden;clip:rect(1px,1px,1px,1px)}#main-menu-state:not(:checked) ~ #main-menu{display:none}#main-menu-state:checked ~ #main-menu{display:block}@media(min-width:768px){.main-menu-btn{position:absolute;top:-99999px}#main-menu-state:not(:checked) ~ #main-menu{display:block}}.sm-dox{background-image:url("tab_b.png")}.sm-dox a,.sm-dox a:focus,.sm-dox a:hover,.sm-dox a:active{padding:0 12px;padding-right:43px;font-family:"Lucida Grande","Geneva","Helvetica",Arial,sans-serif;font-size:13px;font-weight:bold;line-height:36px;text-decoration:none;text-shadow:0 1px 1px rgba(255,255,255,0.9);color:#283a5d;outline:0}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a.current{color:#d23600}.sm-dox a.disabled{color:#bbb}.sm-dox a span.sub-arrow{position:absolute;top:50%;margin-top:-14px;left:auto;right:3px;width:28px;height:28px;overflow:hidden;font:bold 12px/28px monospace !important;text-align:center;text-shadow:none;background:rgba(255,255,255,0.5);-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox a span.sub-arrow:before{display:block;content:'+'}.sm-dox a.highlighted span.sub-arrow:before{display:block;content:'-'}.sm-dox>li:first-child>a,.sm-dox>li:first-child>:not(ul) a{-moz-border-radius:5px 5px 0 0;-webkit-border-radius:5px;border-radius:5px 5px 0 0}.sm-dox>li:last-child>a,.sm-dox>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul{-moz-border-radius:0 0 5px 5px;-webkit-border-radius:0;border-radius:0 0 5px 5px}.sm-dox>li:last-child>a.highlighted,.sm-dox>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>a.highlighted,.sm-dox>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>ul>li:last-child>*:not(ul) a.highlighted{-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox ul{background:rgba(162,162,162,0.1)}.sm-dox ul a,.sm-dox ul a:focus,.sm-dox ul a:hover,.sm-dox ul a:active{font-size:12px;border-left:8px solid transparent;line-height:36px;text-shadow:none;background-color:white;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul ul a,.sm-dox ul ul a:hover,.sm-dox ul ul a:focus,.sm-dox ul ul a:active{border-left:16px solid transparent}.sm-dox ul ul ul a,.sm-dox ul ul ul a:hover,.sm-dox ul ul ul a:focus,.sm-dox ul ul ul a:active{border-left:24px solid transparent}.sm-dox ul ul ul ul a,.sm-dox ul ul ul ul a:hover,.sm-dox ul ul ul ul a:focus,.sm-dox ul ul ul ul a:active{border-left:32px solid transparent}.sm-dox ul ul ul ul ul a,.sm-dox ul ul ul ul ul a:hover,.sm-dox ul ul ul ul ul a:focus,.sm-dox ul ul ul ul ul a:active{border-left:40px solid transparent}@media(min-width:768px){.sm-dox ul{position:absolute;width:12em}.sm-dox li{float:left}.sm-dox.sm-rtl li{float:right}.sm-dox ul li,.sm-dox.sm-rtl ul li,.sm-dox.sm-vertical li{float:none}.sm-dox a{white-space:nowrap}.sm-dox ul a,.sm-dox.sm-vertical a{white-space:normal}.sm-dox .sm-nowrap>li>a,.sm-dox .sm-nowrap>li>:not(ul) a{white-space:nowrap}.sm-dox{padding:0 10px;background-image:url("tab_b.png");line-height:36px}.sm-dox a span.sub-arrow{top:50%;margin-top:-2px;right:12px;width:0;height:0;border-width:4px;border-style:solid dashed dashed dashed;border-color:#283a5d transparent transparent transparent;background:transparent;-moz-border-radius:0;-webkit-border-radius:0;border-radius:0}.sm-dox a,.sm-dox a:focus,.sm-dox a:active,.sm-dox a:hover,.sm-dox a.highlighted{padding:0 12px;background-image:url("tab_s.png");background-repeat:no-repeat;background-position:right;-moz-border-radius:0 !important;-webkit-border-radius:0;border-radius:0 !important}.sm-dox a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox a:hover span.sub-arrow{border-color:white transparent transparent transparent}.sm-dox a.has-submenu{padding-right:24px}.sm-dox li{border-top:0}.sm-dox>li>ul:before,.sm-dox>li>ul:after{content:'';position:absolute;top:-18px;left:30px;width:0;height:0;overflow:hidden;border-width:9px;border-style:dashed dashed solid dashed;border-color:transparent transparent #bbb transparent}.sm-dox>li>ul:after{top:-16px;left:31px;border-width:8px;border-color:transparent transparent #fff transparent}.sm-dox ul{border:1px solid #bbb;padding:5px 0;background:#fff;-moz-border-radius:5px !important;-webkit-border-radius:5px;border-radius:5px !important;-moz-box-shadow:0 5px 9px rgba(0,0,0,0.2);-webkit-box-shadow:0 5px 9px rgba(0,0,0,0.2);box-shadow:0 5px 9px rgba(0,0,0,0.2)}.sm-dox ul a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-color:transparent transparent transparent #555;border-style:dashed dashed dashed solid}.sm-dox ul a,.sm-dox ul a:hover,.sm-dox ul a:focus,.sm-dox ul a:active,.sm-dox ul a.highlighted{color:#555;background-image:none;border:0 !important;color:#555;background-image:none}.sm-dox ul a:hover{background-image:url("tab_a.png");background-repeat:repeat-x;color:white;text-shadow:0 1px 1px black}.sm-dox ul a:hover span.sub-arrow{border-color:transparent transparent transparent white}.sm-dox span.scroll-up,.sm-dox span.scroll-down{position:absolute;display:none;visibility:hidden;overflow:hidden;background:#fff;height:36px}.sm-dox span.scroll-up:hover,.sm-dox span.scroll-down:hover{background:#eee}.sm-dox span.scroll-up:hover span.scroll-up-arrow,.sm-dox span.scroll-up:hover span.scroll-down-arrow{border-color:transparent transparent #d23600 transparent}.sm-dox span.scroll-down:hover span.scroll-down-arrow{border-color:#d23600 transparent transparent transparent}.sm-dox span.scroll-up-arrow,.sm-dox span.scroll-down-arrow{position:absolute;top:0;left:50%;margin-left:-6px;width:0;height:0;overflow:hidden;border-width:6px;border-style:dashed dashed solid dashed;border-color:transparent transparent #555 transparent}.sm-dox span.scroll-down-arrow{top:8px;border-style:solid dashed dashed dashed;border-color:#555 transparent transparent transparent}.sm-dox.sm-rtl a.has-submenu{padding-right:12px;padding-left:24px}.sm-dox.sm-rtl a span.sub-arrow{right:auto;left:12px}.sm-dox.sm-rtl.sm-vertical a.has-submenu{padding:10px 20px}.sm-dox.sm-rtl.sm-vertical a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-rtl>li>ul:before{left:auto;right:30px}.sm-dox.sm-rtl>li>ul:after{left:auto;right:31px}.sm-dox.sm-rtl ul a.has-submenu{padding:10px 20px !important}.sm-dox.sm-rtl ul a span.sub-arrow{right:auto;left:8px;border-style:dashed solid dashed dashed;border-color:transparent #555 transparent transparent}.sm-dox.sm-vertical{padding:10px 0;-moz-border-radius:5px;-webkit-border-radius:5px;border-radius:5px}.sm-dox.sm-vertical a{padding:10px 20px}.sm-dox.sm-vertical a:hover,.sm-dox.sm-vertical a:focus,.sm-dox.sm-vertical a:active,.sm-dox.sm-vertical a.highlighted{background:#fff}.sm-dox.sm-vertical a.disabled{background-image:url("tab_b.png")}.sm-dox.sm-vertical a span.sub-arrow{right:8px;top:50%;margin-top:-5px;border-width:5px;border-style:dashed dashed dashed solid;border-color:transparent transparent transparent #555}.sm-dox.sm-vertical>li>ul:before,.sm-dox.sm-vertical>li>ul:after{display:none}.sm-dox.sm-vertical ul a{padding:10px 20px}.sm-dox.sm-vertical ul a:hover,.sm-dox.sm-vertical ul a:focus,.sm-dox.sm-vertical ul a:active,.sm-dox.sm-vertical ul a.highlighted{background:#eee}.sm-dox.sm-vertical ul a.disabled{background:#fff}} \ No newline at end of file diff --git a/deps/glfw-3.3.8/docs/html/vulkan_8dox.html b/deps/glfw-3.3.8/docs/html/vulkan_8dox.html new file mode 100644 index 0000000..a4fb097 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/vulkan_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: vulkan.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    vulkan.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/vulkan_guide.html b/deps/glfw-3.3.8/docs/html/vulkan_guide.html new file mode 100644 index 0000000..1159aa0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/vulkan_guide.html @@ -0,0 +1,189 @@ + + + + + + + +GLFW: Vulkan guide + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Vulkan guide
    +
    +
    +

    Table of Contents

    + +
    +

    This guide is intended to fill the gaps between the official Vulkan resources and the rest of the GLFW documentation and is not a replacement for either. It assumes some familiarity with Vulkan concepts like loaders, devices, queues and surfaces and leaves it to the Vulkan documentation to explain the details of Vulkan functions.

    +

    To develop for Vulkan you should download the LunarG Vulkan SDK for your platform. Apart from headers and link libraries, they also provide the validation layers necessary for development.

    +

    The Vulkan Tutorial has more information on how to use GLFW and Vulkan. The Khronos Vulkan Samples also use GLFW, although with a small framework in between.

    +

    For details on a specific Vulkan support function, see the Vulkan support reference. There are also guides for the other areas of the GLFW API.

    + +

    +Linking against the Vulkan loader

    +

    By default, GLFW will look for the Vulkan loader on demand at runtime via its standard name (vulkan-1.dll on Windows, libvulkan.so.1 on Linux and other Unix-like systems and libvulkan.1.dylib on macOS). This means that GLFW does not need to be linked against the loader. However, it also means that if you are using the static library form of the Vulkan loader GLFW will either fail to find it or (worse) use the wrong one.

    +

    The GLFW_VULKAN_STATIC CMake option makes GLFW call the Vulkan loader directly instead of dynamically loading it at runtime. Not linking against the Vulkan loader will then be a compile-time error.

    +

    macOS: To make your application be redistributable you will need to set up the application bundle according to the LunarG SDK documentation. This is explained in more detail in the SDK documentation for macOS.

    +

    +Including the Vulkan and GLFW header files

    +

    To include the Vulkan header, define GLFW_INCLUDE_VULKAN before including the GLFW header.

    +
    #define GLFW_INCLUDE_VULKAN
    +
    #include <GLFW/glfw3.h>
    +
    glfw3.h
    The header of the GLFW 3 API.
    +

    If you instead want to include the Vulkan header from a custom location or use your own custom Vulkan header then do this before the GLFW header.

    +
    #include <path/to/vulkan.h>
    +
    #include <GLFW/glfw3.h>
    +

    Unless a Vulkan header is included, either by the GLFW header or above it, any GLFW functions that take or return Vulkan types will not be declared.

    +

    The VK_USE_PLATFORM_*_KHR macros do not need to be defined for the Vulkan part of GLFW to work. Define them only if you are using these extensions directly.

    +

    +Querying for Vulkan support

    +

    If you are linking directly against the Vulkan loader then you can skip this section. The canonical desktop loader library exports all Vulkan core and Khronos extension functions, allowing them to be called directly.

    +

    If you are loading the Vulkan loader dynamically instead of linking directly against it, you can check for the availability of a loader and ICD with glfwVulkanSupported.

    +
    if (glfwVulkanSupported())
    +
    {
    +
    // Vulkan is available, at least for compute
    +
    }
    +
    glfwVulkanSupported
    int glfwVulkanSupported(void)
    Returns whether the Vulkan loader and an ICD have been found.
    +

    This function returns GLFW_TRUE if the Vulkan loader and any minimally functional ICD was found.

    +

    If one or both were not found, calling any other Vulkan related GLFW function will generate a GLFW_API_UNAVAILABLE error.

    +

    +Querying Vulkan function pointers

    +

    To load any Vulkan core or extension function from the found loader, call glfwGetInstanceProcAddress. To load functions needed for instance creation, pass NULL as the instance.

    +
    PFN_vkCreateInstance pfnCreateInstance = (PFN_vkCreateInstance)
    +
    glfwGetInstanceProcAddress(NULL, "vkCreateInstance");
    +
    glfwGetInstanceProcAddress
    GLFWvkproc glfwGetInstanceProcAddress(VkInstance instance, const char *procname)
    Returns the address of the specified Vulkan instance function.
    +

    Once you have created an instance, you can load from it all other Vulkan core functions and functions from any instance extensions you enabled.

    +
    PFN_vkCreateDevice pfnCreateDevice = (PFN_vkCreateDevice)
    +
    glfwGetInstanceProcAddress(instance, "vkCreateDevice");
    +

    This function in turn calls vkGetInstanceProcAddr. If that fails, the function falls back to a platform-specific query of the Vulkan loader (i.e. dlsym or GetProcAddress). If that also fails, the function returns NULL. For more information about vkGetInstanceProcAddr, see the Vulkan documentation.

    +

    Vulkan also provides vkGetDeviceProcAddr for loading device-specific versions of Vulkan function. This function can be retrieved from an instance with glfwGetInstanceProcAddress.

    +
    PFN_vkGetDeviceProcAddr pfnGetDeviceProcAddr = (PFN_vkGetDeviceProcAddr)
    +
    glfwGetInstanceProcAddress(instance, "vkGetDeviceProcAddr");
    +

    Device-specific functions may execute a little bit faster, due to not having to dispatch internally based on the device passed to them. For more information about vkGetDeviceProcAddr, see the Vulkan documentation.

    +

    +Querying required Vulkan extensions

    +

    To do anything useful with Vulkan you need to create an instance. If you want to use Vulkan to render to a window, you must enable the instance extensions GLFW requires to create Vulkan surfaces.

    +

    To query the instance extensions required, call glfwGetRequiredInstanceExtensions.

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

    These extensions must all be enabled when creating instances that are going to be passed to glfwGetPhysicalDevicePresentationSupport and glfwCreateWindowSurface. The set of extensions will vary depending on platform and may also vary depending on graphics drivers and other factors.

    +

    If it fails it will return NULL and GLFW will not be able to create Vulkan window surfaces. You can still use Vulkan for off-screen rendering and compute work.

    +

    If successful the returned array will always include VK_KHR_surface, so if you don't require any additional extensions you can pass this list directly to the VkInstanceCreateInfo struct.

    +
    VkInstanceCreateInfo ici;
    +
    +
    memset(&ici, 0, sizeof(ici));
    +
    ici.enabledExtensionCount = count;
    +
    ici.ppEnabledExtensionNames = extensions;
    +
    ...
    +

    Additional extensions may be required by future versions of GLFW. You should check whether 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.

    +

    macOS: MoltenVK is (as of July 2022) not yet a fully conformant implementation of Vulkan. As of Vulkan SDK 1.3.216.0, this means you must also enable the VK_KHR_portability_enumeration instance extension and set the VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR bit in the instance creation info flags for MoltenVK to show up in the list of physical devices. For more information, see the Vulkan and MoltenVK documentation.

    +

    +Querying for Vulkan presentation support

    +

    Not every queue family of every Vulkan device can present images to surfaces. To check whether a specific queue family of a physical device supports image presentation without first having to create a window and surface, call glfwGetPhysicalDevicePresentationSupport.

    +
    if (glfwGetPhysicalDevicePresentationSupport(instance, physical_device, queue_family_index))
    +
    {
    +
    // Queue family supports image presentation
    +
    }
    +
    glfwGetPhysicalDevicePresentationSupport
    int glfwGetPhysicalDevicePresentationSupport(VkInstance instance, VkPhysicalDevice device, uint32_t queuefamily)
    Returns whether the specified queue family can present images.
    +

    The VK_KHR_surface extension additionally provides the vkGetPhysicalDeviceSurfaceSupportKHR function, which performs the same test on an existing Vulkan surface.

    +

    +Creating the window

    +

    Unless you will be using OpenGL or OpenGL ES with the same window as Vulkan, there is no need to create a context. You can disable context creation with the GLFW_CLIENT_API hint.

    +
    glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API);
    +
    GLFWwindow* window = glfwCreateWindow(640, 480, "Window Title", NULL, NULL);
    +
    GLFW_NO_API
    #define GLFW_NO_API
    Definition: glfw3.h:1036
    +
    glfwCreateWindow
    GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
    Creates a window and its associated context.
    +
    GLFWwindow
    struct GLFWwindow GLFWwindow
    Opaque window object.
    Definition: glfw3.h:1185
    +
    GLFW_CLIENT_API
    #define GLFW_CLIENT_API
    Context client API hint and attribute.
    Definition: glfw3.h:949
    +
    glfwWindowHint
    void glfwWindowHint(int hint, int value)
    Sets the specified window hint to the desired value.
    +

    See Windows without contexts for more information.

    +

    +Creating a Vulkan window surface

    +

    You can create a Vulkan surface (as defined by the VK_KHR_surface extension) for a GLFW window with glfwCreateWindowSurface.

    +
    VkSurfaceKHR surface;
    +
    VkResult err = glfwCreateWindowSurface(instance, window, NULL, &surface);
    +
    if (err)
    +
    {
    +
    // Window surface creation failed
    +
    }
    +
    glfwCreateWindowSurface
    VkResult glfwCreateWindowSurface(VkInstance instance, GLFWwindow *window, const VkAllocationCallbacks *allocator, VkSurfaceKHR *surface)
    Creates a Vulkan surface for the specified window.
    +

    If an OpenGL or OpenGL ES context was created on the window, the context has ownership of the presentation on the window and a Vulkan surface cannot be created.

    +

    It is your responsibility to destroy the surface. GLFW does not destroy it for you. Call vkDestroySurfaceKHR function from the same extension to destroy it.

    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/window_8dox.html b/deps/glfw-3.3.8/docs/html/window_8dox.html new file mode 100644 index 0000000..3ca2913 --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/window_8dox.html @@ -0,0 +1,74 @@ + + + + + + + +GLFW: window.dox File Reference + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    window.dox File Reference
    +
    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/html/window_guide.html b/deps/glfw-3.3.8/docs/html/window_guide.html new file mode 100644 index 0000000..f7d0c2c --- /dev/null +++ b/deps/glfw-3.3.8/docs/html/window_guide.html @@ -0,0 +1,756 @@ + + + + + + + +GLFW: Window guide + + + + + + + + + + +
    + + + + + + + + + +
    +
    + + +
    + +
    + +
    +
    +
    Window guide
    +
    +
    +

    Table of Contents

    + +
    +

    This guide introduces the window related functions of GLFW. For details on a specific function in this category, see the Window reference. There are also guides for the other areas of GLFW.

    + +

    +Window objects

    +

    The GLFWwindow object encapsulates both a window and a context. They are created with glfwCreateWindow and destroyed with glfwDestroyWindow, or glfwTerminate, if any remain. As the window and context are inseparably linked, the object pointer is used as both a context and window handle.

    +

    To see the event stream provided to the various window related callbacks, run the events test program.

    +

    +Window creation

    +

    A window and its OpenGL or OpenGL ES context are created with glfwCreateWindow, which returns a handle to the created window object. For example, this creates a 640 by 480 windowed mode window:

    +
    GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL);
    +
    glfwCreateWindow
    GLFWwindow * glfwCreateWindow(int width, int height, const char *title, GLFWmonitor *monitor, GLFWwindow *share)
    Creates a window and its associated context.
    +
    GLFWwindow
    struct GLFWwindow GLFWwindow
    Opaque window object.
    Definition: glfw3.h:1185
    +

    If window creation fails, NULL will be returned, so it is necessary to check the return value.

    +

    The window handle is passed to all window related functions and is provided to along with all input events, so event handlers can tell which window received the event.

    +

    +Full screen windows

    +

    To create a full screen window, you need to specify which monitor the window should use. In most cases, the user's primary monitor is a good choice. For more information about retrieving monitors, see Retrieving monitors.

    +
    GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", glfwGetPrimaryMonitor(), NULL);
    +
    glfwGetPrimaryMonitor
    GLFWmonitor * glfwGetPrimaryMonitor(void)
    Returns the primary monitor.
    +

    Full screen windows cover the entire display area of a monitor, have no border or decorations.

    +

    Windowed mode windows can be made full screen by setting a monitor with glfwSetWindowMonitor, and full screen ones can be made windowed by unsetting it with the same function.

    +

    Each field of the GLFWvidmode structure corresponds to a function parameter or window hint and combine to form the desired video mode for that window. The supported video mode most closely matching the desired video mode will be set for the chosen monitor as long as the window has input focus. For more information about retrieving video modes, see Video modes.

    + + + + + + + + + + + + + + + +
    Video mode field Corresponds to
    GLFWvidmode.width width parameter of glfwCreateWindow
    GLFWvidmode.height height parameter of glfwCreateWindow
    GLFWvidmode.redBits GLFW_RED_BITS hint
    GLFWvidmode.greenBits GLFW_GREEN_BITS hint
    GLFWvidmode.blueBits GLFW_BLUE_BITS hint
    GLFWvidmode.refreshRate GLFW_REFRESH_RATE hint
    +

    Once you have a full screen window, you can change its resolution, refresh rate and monitor with glfwSetWindowMonitor. If you only need change its resolution you can also call glfwSetWindowSize. In all cases, the new video mode will be selected the same way as the video mode chosen by glfwCreateWindow. If the window has an OpenGL or OpenGL ES context, it will be unaffected.

    +

    By default, the original video mode of the monitor will be restored and the window iconified if it loses input focus, to allow the user to switch back to the desktop. This behavior can be disabled with the GLFW_AUTO_ICONIFY window hint, for example if you wish to simultaneously cover multiple monitors with full screen windows.

    +

    If a monitor is disconnected, all windows that are full screen on that monitor will be switched to windowed mode. See Monitor configuration changes for more information.

    +

    +"Windowed full screen" windows

    +

    If the closest match for the desired video mode is the current one, the video mode will not be changed, making window creation faster and application switching much smoother. This is sometimes called windowed full screen or borderless full screen window and counts as a full screen window. To create such a window, request the current video mode.

    +
    const GLFWvidmode* mode = glfwGetVideoMode(monitor);
    +
    +
    glfwWindowHint(GLFW_RED_BITS, mode->redBits);
    +
    glfwWindowHint(GLFW_GREEN_BITS, mode->greenBits);
    +
    glfwWindowHint(GLFW_BLUE_BITS, mode->blueBits);
    +
    glfwWindowHint(GLFW_REFRESH_RATE, mode->refreshRate);
    +
    +
    GLFWwindow* window = glfwCreateWindow(mode->width, mode->height, "My Title", monitor, NULL);
    +
    glfwGetVideoMode
    const GLFWvidmode * glfwGetVideoMode(GLFWmonitor *monitor)
    Returns the current mode of the specified monitor.
    +
    GLFW_REFRESH_RATE
    #define GLFW_REFRESH_RATE
    Monitor refresh rate hint.
    Definition: glfw3.h:937
    +
    glfwWindowHint
    void glfwWindowHint(int hint, int value)
    Sets the specified window hint to the desired value.
    +
    GLFW_BLUE_BITS
    #define GLFW_BLUE_BITS
    Framebuffer bit depth hint.
    Definition: glfw3.h:877
    +
    GLFW_RED_BITS
    #define GLFW_RED_BITS
    Framebuffer bit depth hint.
    Definition: glfw3.h:867
    +
    GLFW_GREEN_BITS
    #define GLFW_GREEN_BITS
    Framebuffer bit depth hint.
    Definition: glfw3.h:872
    +
    GLFWvidmode
    Video mode type.
    Definition: glfw3.h:1658
    +
    GLFWvidmode::greenBits
    int greenBits
    Definition: glfw3.h:1670
    +
    GLFWvidmode::redBits
    int redBits
    Definition: glfw3.h:1667
    +
    GLFWvidmode::width
    int width
    Definition: glfw3.h:1661
    +
    GLFWvidmode::refreshRate
    int refreshRate
    Definition: glfw3.h:1676
    +
    GLFWvidmode::height
    int height
    Definition: glfw3.h:1664
    +
    GLFWvidmode::blueBits
    int blueBits
    Definition: glfw3.h:1673
    +

    This also works for windowed mode windows that are made full screen.

    +
    const GLFWvidmode* mode = glfwGetVideoMode(monitor);
    +
    +
    glfwSetWindowMonitor(window, monitor, 0, 0, mode->width, mode->height, mode->refreshRate);
    +
    glfwSetWindowMonitor
    void glfwSetWindowMonitor(GLFWwindow *window, GLFWmonitor *monitor, int xpos, int ypos, int width, int height, int refreshRate)
    Sets the mode, monitor, video mode and placement of a window.
    +

    Note that glfwGetVideoMode returns the current video mode of a monitor, so if you already have a full screen window on that monitor that you want to make windowed full screen, you need to have saved the desktop resolution before.

    +

    +Window destruction

    +

    When a window is no longer needed, destroy it with glfwDestroyWindow.

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

    Window destruction always succeeds. Before the actual destruction, all callbacks are removed so no further events will be delivered for the window. All windows remaining when glfwTerminate is called are destroyed as well.

    +

    When a full screen window is destroyed, the original video mode of its monitor is restored, but the gamma ramp is left untouched.

    +

    +Window creation hints

    +

    There are a number of hints that can be set before the creation of a window and context. Some affect the window itself, others affect the framebuffer or context. These hints are set to their default values each time the library is initialized with glfwInit. Integer value hints can be set individually with glfwWindowHint and string value hints with glfwWindowHintString. You can reset all at once to their defaults with glfwDefaultWindowHints.

    +

    Some hints are platform specific. These are always valid to 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 calls.

    +
    Note
    Window hints need to be set before the creation of the window and context you wish to have the specified attributes. They function as additional arguments to glfwCreateWindow.
    +

    +Hard and soft constraints

    +

    Some window hints are hard constraints. These must match the available capabilities exactly for window and context creation to succeed. Hints that are not hard constraints are matched as closely as possible, but the resulting context and framebuffer may differ from what these hints requested.

    +

    The following hints are always hard constraints:

    +

    The following additional hints are hard constraints when requesting an OpenGL context, but are ignored when requesting an OpenGL ES context:

    +

    +Window related hints

    +

    GLFW_RESIZABLE specifies whether the windowed mode window will be resizable by the user. The window will still be resizable using the glfwSetWindowSize function. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen and undecorated windows.

    +

    GLFW_VISIBLE specifies whether the windowed mode window will be initially visible. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.

    +

    GLFW_DECORATED specifies whether the windowed mode window will have window decorations such as a border, a close widget, etc. An undecorated window will not be resizable by the user but will still allow the user to generate close events on some platforms. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.

    +

    GLFW_FOCUSED specifies whether the windowed mode window will be given input focus when created. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen and initially hidden windows.

    +

    GLFW_AUTO_ICONIFY specifies whether the full screen window will automatically iconify and restore the previous video mode on input focus loss. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for windowed mode windows.

    +

    GLFW_FLOATING specifies whether the windowed mode window will be floating above other regular windows, also called topmost or always-on-top. This is intended primarily for debugging purposes and cannot be used to implement proper full screen windows. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.

    +

    GLFW_MAXIMIZED specifies whether the windowed mode window will be maximized when created. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for full screen windows.

    +

    GLFW_CENTER_CURSOR specifies whether the cursor should be centered over newly created full screen windows. Possible values are GLFW_TRUE and GLFW_FALSE. This hint is ignored for windowed mode windows.

    +

    GLFW_TRANSPARENT_FRAMEBUFFER specifies whether the window framebuffer will be transparent. If enabled and supported by the system, the window framebuffer alpha channel will be used to combine the framebuffer with the background. This does not affect window decorations. Possible values are GLFW_TRUE and GLFW_FALSE.

    +

    GLFW_FOCUS_ON_SHOW specifies whether the window will be given input focus when glfwShowWindow is called. Possible values are GLFW_TRUE and GLFW_FALSE.

    +

    GLFW_SCALE_TO_MONITOR specified whether the window content area should be resized based on the monitor content scale of any monitor it is placed on. This includes the initial placement when the window is created. Possible values are GLFW_TRUE and GLFW_FALSE.

    +

    This hint only has an effect on platforms where screen coordinates and pixels always map 1:1 such as Windows and X11. On platforms like macOS the resolution of the framebuffer is changed independently of the window size.

    +

    +Framebuffer related hints

    +

    GLFW_RED_BITS, GLFW_GREEN_BITS, GLFW_BLUE_BITS, GLFW_ALPHA_BITS, GLFW_DEPTH_BITS and GLFW_STENCIL_BITS specify the desired bit depths of the various components of the default framebuffer. A value of GLFW_DONT_CARE means the application has no preference.

    +

    GLFW_ACCUM_RED_BITS, GLFW_ACCUM_GREEN_BITS, GLFW_ACCUM_BLUE_BITS and GLFW_ACCUM_ALPHA_BITS specify the desired bit depths of the various components of the accumulation buffer. A value of GLFW_DONT_CARE means the application has no preference.

    +

    Accumulation buffers are a legacy OpenGL feature and should not be used in new code.

    +

    GLFW_AUX_BUFFERS specifies the desired number of auxiliary buffers. A value of GLFW_DONT_CARE means the application has no preference.

    +

    Auxiliary buffers are a legacy OpenGL feature and should not be used in new code.

    +

    GLFW_STEREO specifies whether to use OpenGL stereoscopic rendering. Possible values are GLFW_TRUE and GLFW_FALSE. This is a hard constraint.

    +

    GLFW_SAMPLES specifies the desired number of samples to use for multisampling. Zero disables multisampling. A value of GLFW_DONT_CARE means the application has no preference.

    +

    GLFW_SRGB_CAPABLE specifies whether the framebuffer should be sRGB capable. Possible values are GLFW_TRUE and GLFW_FALSE.

    +
    Note
    OpenGL: If enabled and supported by the system, the GL_FRAMEBUFFER_SRGB enable will control sRGB rendering. By default, sRGB rendering will be disabled.
    +
    +OpenGL ES: If enabled and supported by the system, the context will always have sRGB rendering enabled.
    +

    GLFW_DOUBLEBUFFER specifies whether the framebuffer should be double buffered. You nearly always want to use double buffering. This is a hard constraint. Possible values are GLFW_TRUE and GLFW_FALSE.

    +

    +Monitor related hints

    +

    GLFW_REFRESH_RATE specifies the desired refresh rate for full screen windows. A value of GLFW_DONT_CARE means the highest available refresh rate will be used. This hint is ignored for windowed mode windows.

    +

    +Context related hints

    +

    GLFW_CLIENT_API specifies which client API to create the context for. Possible values are GLFW_OPENGL_API, GLFW_OPENGL_ES_API and GLFW_NO_API. This is a hard constraint.

    +

    GLFW_CONTEXT_CREATION_API specifies which context creation API to use to create the context. Possible values are GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API and GLFW_OSMESA_CONTEXT_API. This is a hard constraint. If no client API is requested, this hint is ignored.

    +

    An extension loader library that assumes it knows which API was used to create the current context may fail if you change this hint. This can be resolved by having it load functions via glfwGetProcAddress.

    +
    Note
    Wayland: The EGL API is the native context creation API, so this hint will have no effect.
    +
    +X11: On some Linux systems, creating contexts via both the native and EGL APIs in a single process will cause the application to segfault. Stick to one API or the other on Linux for now.
    +
    +OSMesa: As its name implies, an OpenGL context created with OSMesa does not update the window contents when its buffers are swapped. Use OpenGL functions or the OSMesa native access functions glfwGetOSMesaColorBuffer and glfwGetOSMesaDepthBuffer to retrieve the framebuffer contents.
    +

    GLFW_CONTEXT_VERSION_MAJOR and GLFW_CONTEXT_VERSION_MINOR specify the client API version that the created context must be compatible with. The exact behavior of these hints depend on the requested client API.

    +

    While there is no way to ask the driver for a context of the highest supported version, GLFW will attempt to provide this when you ask for a version 1.0 context, which is the default for these hints.

    +

    Do not confuse these hints with GLFW_VERSION_MAJOR and GLFW_VERSION_MINOR, which provide the API version of the GLFW header.

    +
    Note
    OpenGL: These hints are not hard constraints, but creation will fail if the OpenGL version of the created context is less than the one requested. It is therefore perfectly safe to use the default of version 1.0 for legacy code and you will still get backwards-compatible contexts of version 3.0 and above when available.
    +
    +OpenGL ES: These hints are not hard constraints, but creation will fail if the OpenGL ES version of the created context is less than the one requested. Additionally, OpenGL ES 1.x cannot be returned if 2.0 or later was requested, and vice versa. This is because OpenGL ES 3.x is backward compatible with 2.0, but OpenGL ES 2.0 is not backward compatible with 1.x.
    +
    +macOS: The OS only supports forward-compatible 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_FORWARD_COMPAT and GLFW_OPENGL_PROFILE hints accordingly. OpenGL 3.0 and 3.1 contexts are not supported at all on macOS.
    +

    GLFW_OPENGL_FORWARD_COMPAT specifies whether the OpenGL context should be forward-compatible, i.e. one where all functionality deprecated in the requested version of OpenGL is removed. This must only be used if the requested OpenGL version is 3.0 or above. If OpenGL ES is requested, this hint is ignored.

    +

    Forward-compatibility is described in detail in the OpenGL Reference Manual.

    +

    GLFW_OPENGL_DEBUG_CONTEXT specifies whether the context should be created in debug mode, which may provide additional error and diagnostic reporting functionality. Possible values are GLFW_TRUE and GLFW_FALSE.

    +

    Debug contexts for OpenGL and OpenGL ES are described in detail by the GL_KHR_debug extension.

    +

    GLFW_OPENGL_PROFILE specifies which OpenGL profile to create the context for. Possible values are one of GLFW_OPENGL_CORE_PROFILE or GLFW_OPENGL_COMPAT_PROFILE, or GLFW_OPENGL_ANY_PROFILE to not request a specific profile. If requesting an OpenGL version below 3.2, GLFW_OPENGL_ANY_PROFILE must be used. If OpenGL ES is requested, this hint is ignored.

    +

    OpenGL profiles are described in detail in the OpenGL Reference Manual.

    +

    GLFW_CONTEXT_ROBUSTNESS specifies the robustness strategy to be used by the context. This can be one of GLFW_NO_RESET_NOTIFICATION or GLFW_LOSE_CONTEXT_ON_RESET, or GLFW_NO_ROBUSTNESS to not request a robustness strategy.

    +

    GLFW_CONTEXT_RELEASE_BEHAVIOR specifies the release behavior to be used by the context. Possible values are one of GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE. If the behavior is GLFW_ANY_RELEASE_BEHAVIOR, the default behavior of the context creation API will be used. If the behavior is GLFW_RELEASE_BEHAVIOR_FLUSH, the pipeline will be flushed whenever the context is released from being the current one. If the behavior is GLFW_RELEASE_BEHAVIOR_NONE, the pipeline will not be flushed on release.

    +

    Context release behaviors are described in detail by the GL_KHR_context_flush_control extension.

    +

    GLFW_CONTEXT_NO_ERROR specifies whether errors should be generated by the context. Possible values are GLFW_TRUE and GLFW_FALSE. If enabled, situations that would have generated errors instead cause undefined behavior.

    +

    The no error mode for OpenGL and OpenGL ES is described in detail by the GL_KHR_no_error extension.

    +

    +macOS specific window hints

    +

    GLFW_COCOA_RETINA_FRAMEBUFFER specifies whether to use full resolution framebuffers on Retina displays. Possible values are GLFW_TRUE and GLFW_FALSE. This is ignored on other platforms.

    +

    GLFW_COCOA_FRAME_NAME specifies the UTF-8 encoded name to use for autosaving the window frame, or if empty disables frame autosaving for the window. This is ignored on other platforms. This is set with glfwWindowHintString.

    +

    GLFW_COCOA_GRAPHICS_SWITCHING specifies whether to in Automatic Graphics Switching, i.e. to allow the system to choose the integrated GPU for the OpenGL context and move it between GPUs if necessary or whether to force it to always run on the discrete GPU. This only affects systems with both integrated and discrete GPUs. Possible values are GLFW_TRUE and GLFW_FALSE. This is ignored on other platforms.

    +

    Simpler programs and tools may want to enable this to save power, while games and other applications performing advanced rendering will want to leave it disabled.

    +

    A bundled application that wishes to participate in Automatic Graphics Switching should also declare this in its Info.plist by setting the NSSupportsAutomaticGraphicsSwitching key to true.

    +

    +X11 specific window hints

    +

    GLFW_X11_CLASS_NAME and GLFW_X11_INSTANCE_NAME specifies the desired ASCII encoded class and instance parts of the ICCCM WM_CLASS window property. These are set with glfwWindowHintString.

    +

    +Supported and default values

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Window hint Default value Supported values
    GLFW_RESIZABLE GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_VISIBLE GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_DECORATED GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_FOCUSED GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_AUTO_ICONIFY GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_FLOATING GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_MAXIMIZED GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_CENTER_CURSOR GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_TRANSPARENT_FRAMEBUFFER GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_FOCUS_ON_SHOW GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_SCALE_TO_MONITOR GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_RED_BITS 8 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_GREEN_BITS 8 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_BLUE_BITS 8 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_ALPHA_BITS 8 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_DEPTH_BITS 24 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_STENCIL_BITS 8 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_ACCUM_RED_BITS 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_ACCUM_GREEN_BITS 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_ACCUM_BLUE_BITS 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_ACCUM_ALPHA_BITS 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_AUX_BUFFERS 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_SAMPLES 0 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_REFRESH_RATE GLFW_DONT_CARE 0 to INT_MAX or GLFW_DONT_CARE
    GLFW_STEREO GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_SRGB_CAPABLE GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_DOUBLEBUFFER GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_CLIENT_API GLFW_OPENGL_API GLFW_OPENGL_API, GLFW_OPENGL_ES_API or GLFW_NO_API
    GLFW_CONTEXT_CREATION_API GLFW_NATIVE_CONTEXT_API GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API or GLFW_OSMESA_CONTEXT_API
    GLFW_CONTEXT_VERSION_MAJOR 1 Any valid major version number of the chosen client API
    GLFW_CONTEXT_VERSION_MINOR 0 Any valid minor version number of the chosen client API
    GLFW_CONTEXT_ROBUSTNESS GLFW_NO_ROBUSTNESS GLFW_NO_ROBUSTNESS, GLFW_NO_RESET_NOTIFICATION or GLFW_LOSE_CONTEXT_ON_RESET
    GLFW_CONTEXT_RELEASE_BEHAVIOR GLFW_ANY_RELEASE_BEHAVIOR GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE
    GLFW_OPENGL_FORWARD_COMPAT GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_OPENGL_DEBUG_CONTEXT GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_OPENGL_PROFILE GLFW_OPENGL_ANY_PROFILE GLFW_OPENGL_ANY_PROFILE, GLFW_OPENGL_COMPAT_PROFILE or GLFW_OPENGL_CORE_PROFILE
    GLFW_COCOA_RETINA_FRAMEBUFFER GLFW_TRUE GLFW_TRUE or GLFW_FALSE
    GLFW_COCOA_FRAME_NAME "" A UTF-8 encoded frame autosave name
    GLFW_COCOA_GRAPHICS_SWITCHING GLFW_FALSE GLFW_TRUE or GLFW_FALSE
    GLFW_X11_CLASS_NAME "" An ASCII encoded WM_CLASS class name
    GLFW_X11_INSTANCE_NAME "" An ASCII encoded WM_CLASS instance name
    +

    +Window event processing

    +

    See Event processing.

    +

    +Window properties and events

    +

    +User pointer

    +

    Each window has a user pointer that can be set with glfwSetWindowUserPointer and queried with glfwGetWindowUserPointer. This can be used for any purpose you need and will not be modified by GLFW throughout the life-time of the window.

    +

    The initial value of the pointer is NULL.

    +

    +Window closing and close flag

    +

    When the user attempts to close the window, for example by clicking the close widget or using a key chord like Alt+F4, the close flag of the window is set. The window is however not actually destroyed and, unless you watch for this state change, nothing further happens.

    +

    The current state of the close flag is returned by glfwWindowShouldClose and can be set or cleared directly with glfwSetWindowShouldClose. A common pattern is to use the close flag as a main loop condition.

    +
    while (!glfwWindowShouldClose(window))
    +
    {
    +
    render(window);
    +
    +
    glfwSwapBuffers(window);
    +
    glfwPollEvents();
    +
    }
    +
    glfwSwapBuffers
    void glfwSwapBuffers(GLFWwindow *window)
    Swaps the front and back buffers of the specified window.
    +
    glfwWindowShouldClose
    int glfwWindowShouldClose(GLFWwindow *window)
    Checks the close flag of the specified window.
    +
    glfwPollEvents
    void glfwPollEvents(void)
    Processes all pending events.
    +

    If you wish to be notified when the user attempts to close a window, set a close callback.

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

    The callback function is called directly after the close flag has been set. It can be used for example to filter close requests and clear the close flag again unless certain conditions are met.

    +
    void window_close_callback(GLFWwindow* window)
    +
    {
    +
    if (!time_to_close)
    +
    glfwSetWindowShouldClose(window, GLFW_FALSE);
    +
    }
    +
    GLFW_FALSE
    #define GLFW_FALSE
    Zero.
    Definition: glfw3.h:321
    +
    glfwSetWindowShouldClose
    void glfwSetWindowShouldClose(GLFWwindow *window, int value)
    Sets the close flag of the specified window.
    +

    +Window size

    +

    The size of a window can be changed with glfwSetWindowSize. For windowed mode windows, this sets the size, in screen coordinates of the content area or content area of the window. The window system may impose limits on window size.

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

    For full screen windows, the specified size becomes the new resolution of the window's desired video mode. The video mode most closely matching the new desired video mode is set immediately. The window is resized to fit the resolution of the set video mode.

    +

    If you wish to be notified when a window is resized, whether by the user, the system or your own code, set a size callback.

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

    The callback function receives the new size, in screen coordinates, of the content area of the window when the window is resized.

    +
    void window_size_callback(GLFWwindow* window, int width, int height)
    +
    {
    +
    }
    +

    There is also glfwGetWindowSize for directly retrieving the current size of a window.

    +
    int width, height;
    +
    glfwGetWindowSize(window, &width, &height);
    +
    glfwGetWindowSize
    void glfwGetWindowSize(GLFWwindow *window, int *width, int *height)
    Retrieves the size of the content area of the specified window.
    +
    Note
    Do not pass the window size to glViewport or other pixel-based OpenGL calls. The window size is in screen coordinates, not pixels. Use the framebuffer size, which is in pixels, for pixel-based calls.
    +

    The above functions work with the size of the content area, but decorated windows typically have title bars and window frames around this rectangle. You can retrieve the extents of these with glfwGetWindowFrameSize.

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

    The returned values are the distances, in screen coordinates, from the edges of the content area to the corresponding edges of the full window. As they are distances and not coordinates, they are always zero or positive.

    +

    +Framebuffer size

    +

    While the size of a window is measured in screen coordinates, OpenGL works with pixels. The size you pass into glViewport, for example, should be in pixels. On some machines screen coordinates and pixels are the same, but on others they will not be. There is a second set of functions to retrieve the size, in pixels, of the framebuffer of a window.

    +

    If you wish to be notified when the framebuffer of a window is resized, whether by the user or the system, set a size callback.

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

    The callback function receives the new size of the framebuffer when it is resized, which can for example be used to update the OpenGL viewport.

    +
    void framebuffer_size_callback(GLFWwindow* window, int width, int height)
    +
    {
    +
    glViewport(0, 0, width, height);
    +
    }
    +

    There is also glfwGetFramebufferSize for directly retrieving the current size of the framebuffer of a window.

    +
    int width, height;
    +
    glfwGetFramebufferSize(window, &width, &height);
    +
    glViewport(0, 0, width, height);
    +
    glfwGetFramebufferSize
    void glfwGetFramebufferSize(GLFWwindow *window, int *width, int *height)
    Retrieves the size of the framebuffer of the specified window.
    +

    The size of a framebuffer may change independently of the size of a window, for example if the window is dragged between a regular monitor and a high-DPI one.

    +

    +Window content scale

    +

    The content scale for a window can be retrieved with glfwGetWindowContentScale.

    +
    float xscale, yscale;
    +
    glfwGetWindowContentScale(window, &xscale, &yscale);
    +
    glfwGetWindowContentScale
    void glfwGetWindowContentScale(GLFWwindow *window, float *xscale, float *yscale)
    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 systems 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.

    +

    If you wish to be notified when the content scale of a window changes, whether because of a system setting change or because it was moved to a monitor with a different scale, set a content scale callback.

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

    The callback function receives the new content scale of the window.

    +
    void window_content_scale_callback(GLFWwindow* window, float xscale, float yscale)
    +
    {
    +
    set_interface_scale(xscale, yscale);
    +
    }
    +

    On platforms where pixels and screen coordinates always map 1:1, the window will need to be resized to appear the same size when it is moved to a monitor with a different content scale. To have this done automatically both when the window is created and when its content scale later changes, set the GLFW_SCALE_TO_MONITOR window hint.

    +

    +Window size limits

    +

    The minimum and maximum size of the content area of a windowed mode window can be enforced with glfwSetWindowSizeLimits. The user may resize the window to any size and aspect ratio within the specified limits, unless the aspect ratio is also set.

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

    To specify only a minimum size or only a maximum one, set the other pair to GLFW_DONT_CARE.

    +
    glfwSetWindowSizeLimits(window, 640, 480, GLFW_DONT_CARE, GLFW_DONT_CARE);
    +
    GLFW_DONT_CARE
    #define GLFW_DONT_CARE
    Definition: glfw3.h:1128
    +

    To disable size limits for a window, set them all to GLFW_DONT_CARE.

    +

    The aspect ratio of the content area of a windowed mode window can be enforced with glfwSetWindowAspectRatio. The user may resize the window freely unless size limits are also set, but the size will be constrained to maintain the aspect ratio.

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

    The aspect ratio is specified as a numerator and denominator, corresponding to the width and height, respectively. If you want a window to maintain its current aspect ratio, use its current size as the ratio.

    +
    int width, height;
    +
    glfwGetWindowSize(window, &width, &height);
    +
    glfwSetWindowAspectRatio(window, width, height);
    +

    To disable the aspect ratio limit for a window, set both terms to GLFW_DONT_CARE.

    +

    You can have both size limits and aspect ratio set for a window, but the results are undefined if they conflict.

    +

    +Window position

    +

    The position of a windowed-mode window can be changed with glfwSetWindowPos. This moves the window so that the upper-left corner of its content area has the specified screen coordinates. The window system may put limitations on window placement.

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

    If you wish to be notified when a window is moved, whether by the user, the system or your own code, set a position callback.

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

    The callback function receives the new position, in screen coordinates, of the upper-left corner of the content area when the window is moved.

    +
    void window_pos_callback(GLFWwindow* window, int xpos, int ypos)
    +
    {
    +
    }
    +

    There is also glfwGetWindowPos for directly retrieving the current position of the content area of the window.

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

    +Window title

    +

    All GLFW windows have a title, although undecorated or full screen windows may not display it or only display it in a task bar or similar interface. You can set a UTF-8 encoded window title with glfwSetWindowTitle.

    +
    glfwSetWindowTitle(window, "My Window");
    +
    glfwSetWindowTitle
    void glfwSetWindowTitle(GLFWwindow *window, const char *title)
    Sets the title of the specified window.
    +

    The specified string is copied before the function returns, so there is no need to keep it around.

    +

    As long as your source file is encoded as UTF-8, you can use any Unicode characters directly in the source.

    +
    glfwSetWindowTitle(window, "ラストエグザイル");
    +

    If you are using C++11 or C11, you can use a UTF-8 string literal.

    +
    glfwSetWindowTitle(window, u8"This is always a UTF-8 string");
    +

    +Window icon

    +

    Decorated windows have icons on some platforms. You can set this icon by specifying a list of candidate images with glfwSetWindowIcon.

    +
    GLFWimage images[2];
    +
    images[0] = load_icon("my_icon.png");
    +
    images[1] = load_icon("my_icon_small.png");
    +
    +
    glfwSetWindowIcon(window, 2, images);
    +
    glfwSetWindowIcon
    void glfwSetWindowIcon(GLFWwindow *window, int count, const GLFWimage *images)
    Sets the icon for the specified window.
    +
    GLFWimage
    Image data.
    Definition: glfw3.h:1721
    +

    The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits per channel with the red channel first. The pixels are arranged canonically as sequential rows, starting from the top-left corner.

    +

    To revert to the default window icon, pass in an empty image array.

    +
    glfwSetWindowIcon(window, 0, NULL);
    +

    +Window monitor

    +

    Full screen windows are associated with a specific monitor. You can get the handle for this monitor with glfwGetWindowMonitor.

    +
    GLFWmonitor* monitor = glfwGetWindowMonitor(window);
    +
    GLFWmonitor
    struct GLFWmonitor GLFWmonitor
    Opaque monitor object.
    Definition: glfw3.h:1173
    +
    glfwGetWindowMonitor
    GLFWmonitor * glfwGetWindowMonitor(GLFWwindow *window)
    Returns the monitor that the window uses for full screen mode.
    +

    This monitor handle is one of those returned by glfwGetMonitors.

    +

    For windowed mode windows, this function returns NULL. This is how to tell full screen windows from windowed mode windows.

    +

    You can move windows between monitors or between full screen and windowed mode with glfwSetWindowMonitor. When making a window full screen on the same or on a different monitor, specify the desired monitor, resolution and refresh rate. The position arguments are ignored.

    +
    const GLFWvidmode* mode = glfwGetVideoMode(monitor);
    +
    +
    glfwSetWindowMonitor(window, monitor, 0, 0, mode->width, mode->height, mode->refreshRate);
    +

    When making the window windowed, specify the desired position and size. The refresh rate argument is ignored.

    +
    glfwSetWindowMonitor(window, NULL, xpos, ypos, width, height, 0);
    +

    This restores any previous window settings such as whether it is decorated, floating, resizable, has size or aspect ratio limits, etc.. To restore a window that was originally windowed to its original size and position, save these before making it full screen and then pass them in as above.

    +

    +Window iconification

    +

    Windows can be iconified (i.e. minimized) with glfwIconifyWindow.

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

    When a full screen window is iconified, the original video mode of its monitor is restored until the user or application restores the window.

    +

    Iconified windows can be restored with glfwRestoreWindow. This function also restores windows from maximization.

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

    When a full screen window is restored, the desired video mode is restored to its monitor as well.

    +

    If you wish to be notified when a window is iconified or restored, whether by the user, system or your own code, set an iconify callback.

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

    The callback function receives changes in the iconification state of the window.

    +
    void window_iconify_callback(GLFWwindow* window, int iconified)
    +
    {
    +
    if (iconified)
    +
    {
    +
    // The window was iconified
    +
    }
    +
    else
    +
    {
    +
    // The window was restored
    +
    }
    +
    }
    +

    You can also get the current iconification state with glfwGetWindowAttrib.

    +
    int iconified = glfwGetWindowAttrib(window, GLFW_ICONIFIED);
    +
    GLFW_ICONIFIED
    #define GLFW_ICONIFIED
    Window iconification window attribute.
    Definition: glfw3.h:802
    +
    glfwGetWindowAttrib
    int glfwGetWindowAttrib(GLFWwindow *window, int attrib)
    Returns an attribute of the specified window.
    +

    +Window maximization

    +

    Windows can be maximized (i.e. zoomed) with glfwMaximizeWindow.

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

    Full screen windows cannot be maximized and passing a full screen window to this function does nothing.

    +

    Maximized windows can be restored with glfwRestoreWindow. This function also restores windows from iconification.

    +
    glfwRestoreWindow(window);
    +

    If you wish to be notified when a window is maximized or restored, whether by the user, system or your own code, set a maximize callback.

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

    The callback function receives changes in the maximization state of the window.

    +
    void window_maximize_callback(GLFWwindow* window, int maximized)
    +
    {
    +
    if (maximized)
    +
    {
    +
    // The window was maximized
    +
    }
    +
    else
    +
    {
    +
    // The window was restored
    +
    }
    +
    }
    +

    You can also get the current maximization state with glfwGetWindowAttrib.

    +
    int maximized = glfwGetWindowAttrib(window, GLFW_MAXIMIZED);
    +
    GLFW_MAXIMIZED
    #define GLFW_MAXIMIZED
    Window maximization window hint and attribute.
    Definition: glfw3.h:838
    +

    By default, newly created windows are not maximized. You can change this behavior by setting the GLFW_MAXIMIZED window hint before creating the window.

    +
    glfwWindowHint(GLFW_MAXIMIZED, GLFW_TRUE);
    +
    GLFW_TRUE
    #define GLFW_TRUE
    One.
    Definition: glfw3.h:312
    +

    +Window visibility

    +

    Windowed mode windows can be hidden with glfwHideWindow.

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

    This makes the window completely invisible to the user, including removing it from the task bar, dock or window list. Full screen windows cannot be hidden and calling glfwHideWindow on a full screen window does nothing.

    +

    Hidden windows can be shown with glfwShowWindow.

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

    By default, this function will also set the input focus to that window. Set the GLFW_FOCUS_ON_SHOW window hint to change this behavior for all newly created windows, or change the behavior for an existing window with glfwSetWindowAttrib.

    +

    You can also get the current visibility state with glfwGetWindowAttrib.

    +
    int visible = glfwGetWindowAttrib(window, GLFW_VISIBLE);
    +
    GLFW_VISIBLE
    #define GLFW_VISIBLE
    Window visibility window hint and attribute.
    Definition: glfw3.h:814
    +

    By default, newly created windows are visible. You can change this behavior by setting the GLFW_VISIBLE window hint before creating the window.

    +
    glfwWindowHint(GLFW_VISIBLE, GLFW_FALSE);
    +

    Windows created hidden are completely invisible to the user until shown. This can be useful if you need to set up your window further before showing it, for example moving it to a specific location.

    +

    +Window input focus

    +

    Windows can be given input focus and brought to the front with glfwFocusWindow.

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

    Keep in mind that it can be very disruptive to the user when a window is forced to the top. For a less disruptive way of getting the user's attention, see attention requests.

    +

    If you wish to be notified when a window gains or loses input focus, whether by the user, system or your own code, set a focus callback.

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

    The callback function receives changes in the input focus state of the window.

    +
    void window_focus_callback(GLFWwindow* window, int focused)
    +
    {
    +
    if (focused)
    +
    {
    +
    // The window gained input focus
    +
    }
    +
    else
    +
    {
    +
    // The window lost input focus
    +
    }
    +
    }
    +

    You can also get the current input focus state with glfwGetWindowAttrib.

    +
    int focused = glfwGetWindowAttrib(window, GLFW_FOCUSED);
    +
    GLFW_FOCUSED
    #define GLFW_FOCUSED
    Input focus window hint and attribute.
    Definition: glfw3.h:797
    +

    By default, newly created windows are given input focus. You can change this behavior by setting the GLFW_FOCUSED window hint before creating the window.

    +
    glfwWindowHint(GLFW_FOCUSED, GLFW_FALSE);
    +

    +Window attention request

    +

    If you wish to notify the user of an event without interrupting, you can request attention with glfwRequestWindowAttention.

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

    The system will highlight the specified window, or on platforms where this is not supported, the application as a whole. Once the user has given it attention, the system will automatically end the request.

    +

    +Window damage and refresh

    +

    If you wish to be notified when the contents of a window is damaged and needs to be refreshed, set a window refresh callback.

    +
    glfwSetWindowRefreshCallback(m_handle, window_refresh_callback);
    +
    glfwSetWindowRefreshCallback
    GLFWwindowrefreshfun glfwSetWindowRefreshCallback(GLFWwindow *window, GLFWwindowrefreshfun callback)
    Sets the refresh callback for the specified window.
    +

    The callback function is called when the contents of the window needs to be refreshed.

    +
    void window_refresh_callback(GLFWwindow* window)
    +
    {
    +
    draw_editor_ui(window);
    +
    glfwSwapBuffers(window);
    +
    }
    +
    Note
    On compositing window systems such as Aero, Compiz or Aqua, where the window contents are saved off-screen, this callback might only be called when the window or framebuffer is resized.
    +

    +Window transparency

    +

    GLFW supports two kinds of transparency for windows; framebuffer transparency and whole window transparency. A single window may not use both methods. The results of doing this are undefined.

    +

    Both methods require the platform to support it and not every version of every platform GLFW supports does this, so there are mechanisms to check whether the window really is transparent.

    +

    Window framebuffers can be made transparent on a per-pixel per-frame basis with the GLFW_TRANSPARENT_FRAMEBUFFER window hint.

    +
    glfwWindowHint(GLFW_TRANSPARENT_FRAMEBUFFER, GLFW_TRUE);
    +
    GLFW_TRANSPARENT_FRAMEBUFFER
    #define GLFW_TRANSPARENT_FRAMEBUFFER
    Window framebuffer transparency hint and attribute.
    Definition: glfw3.h:850
    +

    If supported by the system, the window content area will be composited with the background using the framebuffer per-pixel alpha channel. This requires desktop compositing to be enabled on the system. It does not affect window decorations.

    +

    You can check whether the window framebuffer was successfully made transparent with the GLFW_TRANSPARENT_FRAMEBUFFER window attribute.

    +
    if (glfwGetWindowAttrib(window, GLFW_TRANSPARENT_FRAMEBUFFER))
    +
    {
    +
    // window framebuffer is currently transparent
    +
    }
    +

    GLFW comes with an example that enabled framebuffer transparency called gears.

    +

    The opacity of the whole window, including any decorations, can be set with glfwSetWindowOpacity.

    +
    glfwSetWindowOpacity(window, 0.5f);
    +
    glfwSetWindowOpacity
    void glfwSetWindowOpacity(GLFWwindow *window, float opacity)
    Sets the opacity of the whole window.
    +

    The opacity (or alpha) value is a positive finite number between zero and one, where 0 (zero) is fully transparent and 1 (one) is fully opaque. The initial opacity value for newly created windows is 1.

    +

    The current opacity of a window can be queried with glfwGetWindowOpacity.

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

    If the system does not support whole window transparency, this function always returns one.

    +

    GLFW comes with a test program that lets you control whole window transparency at run-time called opacity.

    +

    +Window attributes

    +

    Windows have a number of attributes that can be returned using glfwGetWindowAttrib. Some reflect state that may change as a result of user interaction, (e.g. whether it has input focus), while others reflect inherent properties of the window (e.g. what kind of border it has). Some are related to the window and others to its OpenGL or OpenGL ES context.

    +
    if (glfwGetWindowAttrib(window, GLFW_FOCUSED))
    +
    {
    +
    // window has input focus
    +
    }
    +

    The GLFW_DECORATED, GLFW_RESIZABLE, GLFW_FLOATING, GLFW_AUTO_ICONIFY and GLFW_FOCUS_ON_SHOW window attributes can be changed with glfwSetWindowAttrib.

    +
    glfwSetWindowAttrib(window, GLFW_RESIZABLE, GLFW_FALSE);
    +
    glfwSetWindowAttrib
    void glfwSetWindowAttrib(GLFWwindow *window, int attrib, int value)
    Sets an attribute of the specified window.
    +
    GLFW_RESIZABLE
    #define GLFW_RESIZABLE
    Window resize-ability window hint and attribute.
    Definition: glfw3.h:808
    +

    +Window related attributes

    +

    GLFW_FOCUSED indicates whether the specified window has input focus. See Window input focus for details.

    +

    GLFW_ICONIFIED indicates whether the specified window is iconified. See Window iconification for details.

    +

    GLFW_MAXIMIZED indicates whether the specified window is maximized. See Window maximization for details.

    +

    GLFW_HOVERED indicates whether the cursor is currently directly over the content area of the window, with no other windows between. See Cursor enter/leave events for details.

    +

    GLFW_VISIBLE indicates whether the specified window is visible. See Window visibility for details.

    +

    GLFW_RESIZABLE indicates whether the specified window is resizable by the user. This can be set before creation with the GLFW_RESIZABLE window hint or after with glfwSetWindowAttrib.

    +

    GLFW_DECORATED indicates whether the specified window has decorations such as a border, a close widget, etc. This can be set before creation with the GLFW_DECORATED window hint or after with glfwSetWindowAttrib.

    +

    GLFW_AUTO_ICONIFY indicates whether the specified full screen window is iconified on focus loss, a close widget, etc. This can be set before creation with the GLFW_AUTO_ICONIFY window hint or after with glfwSetWindowAttrib.

    +

    GLFW_FLOATING indicates whether the specified window is floating, also called topmost or always-on-top. This can be set before creation with the GLFW_FLOATING window hint or after with glfwSetWindowAttrib.

    +

    GLFW_TRANSPARENT_FRAMEBUFFER indicates whether the specified window has a transparent framebuffer, i.e. the window contents is composited with the background using the window framebuffer alpha channel. See Window transparency for details.

    +

    GLFW_FOCUS_ON_SHOW specifies whether the window will be given input focus when glfwShowWindow is called. This can be set before creation with the GLFW_FOCUS_ON_SHOW window hint or after with glfwSetWindowAttrib.

    +

    +Context related attributes

    +

    GLFW_CLIENT_API indicates the client API provided by the window's context; either GLFW_OPENGL_API, GLFW_OPENGL_ES_API or GLFW_NO_API.

    +

    GLFW_CONTEXT_CREATION_API indicates the context creation API used to create the window's context; either GLFW_NATIVE_CONTEXT_API, GLFW_EGL_CONTEXT_API or GLFW_OSMESA_CONTEXT_API.

    +

    GLFW_CONTEXT_VERSION_MAJOR, GLFW_CONTEXT_VERSION_MINOR and GLFW_CONTEXT_REVISION indicate the client API version of the window's context.

    +
    Note
    Do not confuse these attributes with GLFW_VERSION_MAJOR, GLFW_VERSION_MINOR and GLFW_VERSION_REVISION which provide the API version of the GLFW header.
    +

    GLFW_OPENGL_FORWARD_COMPAT is GLFW_TRUE if the window's context is an OpenGL forward-compatible one, or GLFW_FALSE otherwise.

    +

    GLFW_OPENGL_DEBUG_CONTEXT is GLFW_TRUE if the window's context is in debug mode, or GLFW_FALSE otherwise.

    +

    GLFW_OPENGL_PROFILE indicates the OpenGL profile used by the context. This is GLFW_OPENGL_CORE_PROFILE or GLFW_OPENGL_COMPAT_PROFILE if the context uses a known profile, or GLFW_OPENGL_ANY_PROFILE if the OpenGL profile is unknown or the context is an OpenGL ES context. Note that the returned profile may not match the profile bits of the context flags, as GLFW will try other means of detecting the profile when no bits are set.

    +

    GLFW_CONTEXT_RELEASE_BEHAVIOR indicates the release used by the context. Possible values are one of GLFW_ANY_RELEASE_BEHAVIOR, GLFW_RELEASE_BEHAVIOR_FLUSH or GLFW_RELEASE_BEHAVIOR_NONE. If the behavior is GLFW_ANY_RELEASE_BEHAVIOR, the default behavior of the context creation API will be used. If the behavior is GLFW_RELEASE_BEHAVIOR_FLUSH, the pipeline will be flushed whenever the context is released from being the current one. If the behavior is GLFW_RELEASE_BEHAVIOR_NONE, the pipeline will not be flushed on release.

    +

    GLFW_CONTEXT_NO_ERROR indicates whether errors are generated by the context. Possible values are GLFW_TRUE and GLFW_FALSE. If enabled, situations that would have generated errors instead cause undefined behavior.

    +

    GLFW_CONTEXT_ROBUSTNESS indicates the robustness strategy used by the context. This is GLFW_LOSE_CONTEXT_ON_RESET or GLFW_NO_RESET_NOTIFICATION if the window's context supports robustness, or GLFW_NO_ROBUSTNESS otherwise.

    +

    +Framebuffer related attributes

    +

    GLFW does not expose attributes of the default framebuffer (i.e. the framebuffer attached to the window) as these can be queried directly with either OpenGL, OpenGL ES or Vulkan.

    +

    If you are using version 3.0 or later of OpenGL or OpenGL ES, the glGetFramebufferAttachmentParameteriv function can be used to retrieve the number of bits for the red, green, blue, alpha, depth and stencil buffer channels. Otherwise, the glGetIntegerv function can be used.

    +

    The number of MSAA samples are always retrieved with glGetIntegerv. For contexts supporting framebuffer objects, the number of samples of the currently bound framebuffer is returned.

    + + + + + + + + + + + + + + + + + +
    Attribute glGetIntegerv glGetFramebufferAttachmentParameteriv
    Red bits GL_RED_BITS GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE
    Green bits GL_GREEN_BITS GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE
    Blue bits GL_BLUE_BITS GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE
    Alpha bits GL_ALPHA_BITS GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE
    Depth bits GL_DEPTH_BITS GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE
    Stencil bits GL_STENCIL_BITS GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE
    MSAA samples GL_SAMPLES Not provided by this function
    +

    When calling glGetFramebufferAttachmentParameteriv, the red, green, blue and alpha sizes are queried from the GL_BACK_LEFT, while the depth and stencil sizes are queried from the GL_DEPTH and GL_STENCIL attachments, respectively.

    +

    +Buffer swapping

    +

    GLFW windows are by default double buffered. That means that you have two rendering buffers; a front buffer and a back buffer. The front buffer is the one being displayed and the back buffer the one you render to.

    +

    When the entire frame has been rendered, it is time to swap the back and the front buffers in order to display what has been rendered and begin rendering a new frame. This is done with glfwSwapBuffers.

    +
    glfwSwapBuffers(window);
    +

    Sometimes it can be useful to select when the buffer swap will occur. With the function glfwSwapInterval it is possible to select the minimum number of monitor refreshes the driver should wait from the time glfwSwapBuffers was called before swapping the buffers:

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

    If the interval is zero, the swap will take place immediately when glfwSwapBuffers is called without waiting for a refresh. Otherwise at least interval retraces will pass between each buffer swap. Using a swap interval of zero can be useful for benchmarking purposes, when it is not desirable to measure the time it takes to wait for the vertical retrace. However, a swap interval of one lets you avoid tearing.

    +

    Note that this may not work on all machines, as some drivers have user-controlled settings that override any swap interval the application requests.

    +

    A context that supports either the WGL_EXT_swap_control_tear or the GLX_EXT_swap_control_tear extension also accepts negative swap intervals, which allows the driver to swap immediately even if a frame arrives a little bit late. This trades the risk of visible tears for greater framerate stability. You can check for these extensions with glfwExtensionSupported.

    +
    +
    +
    +

    +Last update on Fri Jul 22 2022 for GLFW 3.3.8 +

    +
    + + diff --git a/deps/glfw-3.3.8/docs/input.dox b/deps/glfw-3.3.8/docs/input.dox new file mode 100644 index 0000000..1d61e5b --- /dev/null +++ b/deps/glfw-3.3.8/docs/input.dox @@ -0,0 +1,962 @@ +/*! + +@page input_guide Input guide + +@tableofcontents + +This guide introduces the input related functions of GLFW. For details on +a specific function in this category, see the @ref input. There are also guides +for the other areas of GLFW. + + - @ref intro_guide + - @ref window_guide + - @ref context_guide + - @ref vulkan_guide + - @ref monitor_guide + +GLFW provides many kinds of input. While some can only be polled, like time, or +only received via callbacks, like scrolling, many provide both callbacks and +polling. Callbacks are more work to use than polling but is less CPU intensive +and guarantees that you do not miss state changes. + +All input callbacks receive a window handle. By using the +[window user pointer](@ref window_userptr), you can access non-global structures +or objects from your callbacks. + +To get a better feel for how the various events callbacks behave, run the +`events` test program. It register every callback supported by GLFW and prints +out all arguments provided for every event, along with time and sequence +information. + + +@section events Event processing + +GLFW needs to poll the window system for events both to provide input to the +application and to prove to the window system that the application hasn't locked +up. Event processing is normally done each frame after +[buffer swapping](@ref buffer_swap). Even when you have no windows, event +polling needs to be done in order to receive monitor and joystick connection +events. + +There are three functions for processing pending events. @ref glfwPollEvents, +processes only those events that have already been received and then returns +immediately. + +@code +glfwPollEvents(); +@endcode + +This is the best choice when rendering continuously, like most games do. + +If you only need to update the contents of the window when you receive new +input, @ref glfwWaitEvents is a better choice. + +@code +glfwWaitEvents(); +@endcode + +It puts the thread to sleep until at least one event has been received and then +processes all received events. This saves a great deal of CPU cycles and is +useful for, for example, editing tools. + +If you want to wait for events but have UI elements or other tasks that need +periodic updates, @ref glfwWaitEventsTimeout lets you specify a timeout. + +@code +glfwWaitEventsTimeout(0.7); +@endcode + +It puts the thread to sleep until at least one event has been received, or until +the specified number of seconds have elapsed. It then processes any received +events. + +If the main thread is sleeping in @ref glfwWaitEvents, you can wake it from +another thread by posting an empty event to the event queue with @ref +glfwPostEmptyEvent. + +@code +glfwPostEmptyEvent(); +@endcode + +Do not assume that callbacks will _only_ be called in response to the above +functions. While it is necessary to process events in one or more of the ways +above, 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. + +For example, on Windows the system function that @ref glfwSetWindowSize is +implemented with will send window size events directly to the event callback +that every window has and that GLFW implements for its windows. If you have set +a [window size callback](@ref window_size) GLFW will call it in turn with the +new size before everything returns back out of the @ref glfwSetWindowSize call. + + +@section input_keyboard Keyboard input + +GLFW divides keyboard input into two categories; key events and character +events. Key events relate to actual physical keyboard keys, whereas character +events relate to the Unicode code points generated by pressing some of them. + +Keys and characters do not map 1:1. A single key press may produce several +characters, and a single character may require several keys to produce. This +may not be the case on your machine, but your users are likely not all using the +same keyboard layout, input method or even operating system as you. + + +@subsection input_key Key input + +If you wish to be notified when a physical key is pressed or released or when it +repeats, set a key callback. + +@code +glfwSetKeyCallback(window, key_callback); +@endcode + +The callback function receives the [keyboard key](@ref keys), platform-specific +scancode, key action and [modifier bits](@ref mods). + +@code +void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods) +{ + if (key == GLFW_KEY_E && action == GLFW_PRESS) + activate_airship(); +} +@endcode + +The action is one of `GLFW_PRESS`, `GLFW_REPEAT` or `GLFW_RELEASE`. Events with +`GLFW_PRESS` and `GLFW_RELEASE` actions are emitted for every key press. Most +keys will also emit events with `GLFW_REPEAT` actions while a key is held down. + +Key events with `GLFW_REPEAT` actions are intended for text input. They are +emitted at the rate set in the user's keyboard settings. At most one key is +repeated even if several keys are held down. `GLFW_REPEAT` actions should not +be relied on to know which keys are being held down or to drive animation. +Instead you should either save the state of relevant keys based on `GLFW_PRESS` +and `GLFW_RELEASE` actions, or call @ref glfwGetKey, which provides basic cached +key state. + +The key will be one of the existing [key tokens](@ref keys), or +`GLFW_KEY_UNKNOWN` if GLFW lacks a token for it, for example _E-mail_ and _Play_ +keys. + +The scancode is unique for every key, regardless of whether it has a key token. +Scancodes are platform-specific but consistent over time, so keys will have +different scancodes depending on the platform but they are safe to save to disk. +You can query the scancode for any [named key](@ref keys) on the current +platform with @ref glfwGetKeyScancode. + +@code +const int scancode = glfwGetKeyScancode(GLFW_KEY_X); +set_key_mapping(scancode, swap_weapons); +@endcode + +The last reported state for every [named key](@ref keys) is also saved in +per-window state arrays that can be polled with @ref glfwGetKey. + +@code +int state = glfwGetKey(window, GLFW_KEY_E); +if (state == GLFW_PRESS) +{ + activate_airship(); +} +@endcode + +The returned state is one of `GLFW_PRESS` or `GLFW_RELEASE`. + +This function only returns cached key event state. It does not poll the +system for the current physical state of the key. + +@anchor GLFW_STICKY_KEYS +Whenever you poll state, you risk missing the state change you are looking for. +If a pressed key is released again before you poll its state, you will have +missed the key press. The recommended solution for this is to use a +key callback, but there is also the `GLFW_STICKY_KEYS` input mode. + +@code +glfwSetInputMode(window, GLFW_STICKY_KEYS, GLFW_TRUE); +@endcode + +When sticky keys mode is enabled, the pollable state of a key will remain +`GLFW_PRESS` until the state of that key is polled with @ref glfwGetKey. Once +it has been polled, if a key release event had been processed in the meantime, +the state will reset to `GLFW_RELEASE`, otherwise it will remain `GLFW_PRESS`. + +@anchor GLFW_LOCK_KEY_MODS +If you wish to know what the state of the Caps Lock and Num Lock keys was when +input events were generated, set the `GLFW_LOCK_KEY_MODS` input mode. + +@code +glfwSetInputMode(window, GLFW_LOCK_KEY_MODS, GLFW_TRUE); +@endcode + +When this input mode is enabled, any callback that receives +[modifier bits](@ref mods) will have the @ref GLFW_MOD_CAPS_LOCK bit set if Caps +Lock was on when the event occurred and the @ref GLFW_MOD_NUM_LOCK bit set if +Num Lock was on. + +The `GLFW_KEY_LAST` constant holds the highest value of any +[named key](@ref keys). + + +@subsection input_char Text input + +GLFW supports text input in the form of a stream of +[Unicode code points](https://en.wikipedia.org/wiki/Unicode), as produced by the +operating system text input system. Unlike key input, text input obeys keyboard +layouts and modifier keys and supports composing characters using +[dead keys](https://en.wikipedia.org/wiki/Dead_key). Once received, you can +encode the code points into UTF-8 or any other encoding you prefer. + +Because an `unsigned int` is 32 bits long on all platforms supported by GLFW, +you can treat the code point argument as native endian UTF-32. + +If you wish to offer regular text input, set a character callback. + +@code +glfwSetCharCallback(window, character_callback); +@endcode + +The callback function receives Unicode code points for key events that would +have led to regular text input and generally behaves as a standard text field on +that platform. + +@code +void character_callback(GLFWwindow* window, unsigned int codepoint) +{ +} +@endcode + + +@subsection input_key_name Key names + +If you wish to refer to keys by name, you can query the keyboard layout +dependent name of printable keys with @ref glfwGetKeyName. + +@code +const char* key_name = glfwGetKeyName(GLFW_KEY_W, 0); +show_tutorial_hint("Press %s to move forward", key_name); +@endcode + +This function can handle both [keys and scancodes](@ref input_key). If the +specified key is `GLFW_KEY_UNKNOWN` then the scancode is used, otherwise it is +ignored. This matches the behavior of the key callback, meaning the callback +arguments can always be passed unmodified to this function. + + +@section input_mouse Mouse input + +Mouse input comes in many forms, including mouse motion, button presses and +scrolling offsets. The cursor appearance can also be changed, either to +a custom image or a standard cursor shape from the system theme. + + +@subsection cursor_pos Cursor position + +If you wish to be notified when the cursor moves over the window, set a cursor +position callback. + +@code +glfwSetCursorPosCallback(window, cursor_position_callback); +@endcode + +The callback functions receives the cursor position, measured in screen +coordinates but relative to the top-left corner of the window content area. On +platforms that provide it, the full sub-pixel cursor position is passed on. + +@code +static void cursor_position_callback(GLFWwindow* window, double xpos, double ypos) +{ +} +@endcode + +The cursor position is also saved per-window and can be polled with @ref +glfwGetCursorPos. + +@code +double xpos, ypos; +glfwGetCursorPos(window, &xpos, &ypos); +@endcode + + +@subsection cursor_mode Cursor mode + +@anchor GLFW_CURSOR +The `GLFW_CURSOR` input mode provides several cursor modes for special forms of +mouse motion input. By default, the cursor mode is `GLFW_CURSOR_NORMAL`, +meaning the regular arrow cursor (or another cursor set with @ref glfwSetCursor) +is used and cursor motion is not limited. + +If you wish to implement mouse motion based camera controls or other input +schemes that require unlimited mouse movement, set the cursor mode to +`GLFW_CURSOR_DISABLED`. + +@code +glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_DISABLED); +@endcode + +This will hide the cursor and lock it to the specified window. GLFW will then +take care of all the details of cursor re-centering and offset calculation and +providing the application with a virtual cursor position. This virtual position +is provided normally via both the cursor position callback and through polling. + +@note You should not implement your own version of this functionality using +other features of GLFW. It is not supported and will not work as robustly as +`GLFW_CURSOR_DISABLED`. + +If you only wish the cursor to become hidden when it is over a window but still +want it to behave normally, set the cursor mode to `GLFW_CURSOR_HIDDEN`. + +@code +glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_HIDDEN); +@endcode + +This mode puts no limit on the motion of the cursor. + +To exit out of either of these special modes, restore the `GLFW_CURSOR_NORMAL` +cursor mode. + +@code +glfwSetInputMode(window, GLFW_CURSOR, GLFW_CURSOR_NORMAL); +@endcode + + +@anchor GLFW_RAW_MOUSE_MOTION +@subsection raw_mouse_motion Raw mouse motion + +When the cursor is disabled, raw (unscaled and unaccelerated) mouse motion can +be enabled if available. + +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. + +Call @ref glfwRawMouseMotionSupported to check if the current machine provides +raw motion and set the `GLFW_RAW_MOUSE_MOTION` input mode to enable it. It is +disabled by default. + +@code +if (glfwRawMouseMotionSupported()) + glfwSetInputMode(window, GLFW_RAW_MOUSE_MOTION, GLFW_TRUE); +@endcode + +If supported, raw mouse motion can be enabled or disabled per-window and at any +time but it will only be provided when the cursor is disabled. + + +@subsection cursor_object Cursor objects + +GLFW supports creating both custom and system theme cursor images, encapsulated +as @ref GLFWcursor objects. They are created with @ref glfwCreateCursor or @ref +glfwCreateStandardCursor and destroyed with @ref glfwDestroyCursor, or @ref +glfwTerminate, if any remain. + + +@subsubsection cursor_custom Custom cursor creation + +A custom cursor is created with @ref glfwCreateCursor, which returns a handle to +the created cursor object. For example, this creates a 16x16 white square +cursor with the hot-spot in the upper-left corner: + +@code +unsigned char pixels[16 * 16 * 4]; +memset(pixels, 0xff, sizeof(pixels)); + +GLFWimage image; +image.width = 16; +image.height = 16; +image.pixels = pixels; + +GLFWcursor* cursor = glfwCreateCursor(&image, 0, 0); +@endcode + +If cursor creation fails, `NULL` will be returned, so it is necessary to check +the return value. + +The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits +per channel with the red channel first. The pixels are arranged canonically as +sequential rows, starting from the top-left corner. + + +@subsubsection cursor_standard Standard cursor creation + +A cursor with a [standard shape](@ref shapes) from the current system cursor +theme can be can be created with @ref glfwCreateStandardCursor. + +@code +GLFWcursor* cursor = glfwCreateStandardCursor(GLFW_HRESIZE_CURSOR); +@endcode + +These cursor objects behave in the exact same way as those created with @ref +glfwCreateCursor except that the system cursor theme provides the actual image. + + +@subsubsection cursor_destruction Cursor destruction + +When a cursor is no longer needed, destroy it with @ref glfwDestroyCursor. + +@code +glfwDestroyCursor(cursor); +@endcode + +Cursor destruction always succeeds. If the cursor is current for any window, +that window will revert to the default cursor. This does not affect the cursor +mode. All remaining cursors are destroyed when @ref glfwTerminate is called. + + +@subsubsection cursor_set Cursor setting + +A cursor can be set as current for a window with @ref glfwSetCursor. + +@code +glfwSetCursor(window, cursor); +@endcode + +Once set, the cursor image will be used as long as the system cursor is over the +content area of the window and the [cursor mode](@ref cursor_mode) is set +to `GLFW_CURSOR_NORMAL`. + +A single cursor may be set for any number of windows. + +To revert to the default cursor, set the cursor of that window to `NULL`. + +@code +glfwSetCursor(window, NULL); +@endcode + +When a cursor is destroyed, any window that has it set will revert to the +default cursor. This does not affect the cursor mode. + + +@subsection cursor_enter Cursor enter/leave events + +If you wish to be notified when the cursor enters or leaves the content area of +a window, set a cursor enter/leave callback. + +@code +glfwSetCursorEnterCallback(window, cursor_enter_callback); +@endcode + +The callback function receives the new classification of the cursor. + +@code +void cursor_enter_callback(GLFWwindow* window, int entered) +{ + if (entered) + { + // The cursor entered the content area of the window + } + else + { + // The cursor left the content area of the window + } +} +@endcode + +You can query whether the cursor is currently inside the content area of the +window with the [GLFW_HOVERED](@ref GLFW_HOVERED_attrib) window attribute. + +@code +if (glfwGetWindowAttrib(window, GLFW_HOVERED)) +{ + highlight_interface(); +} +@endcode + + +@subsection input_mouse_button Mouse button input + +If you wish to be notified when a mouse button is pressed or released, set +a mouse button callback. + +@code +glfwSetMouseButtonCallback(window, mouse_button_callback); +@endcode + +The callback function receives the [mouse button](@ref buttons), button action +and [modifier bits](@ref mods). + +@code +void mouse_button_callback(GLFWwindow* window, int button, int action, int mods) +{ + if (button == GLFW_MOUSE_BUTTON_RIGHT && action == GLFW_PRESS) + popup_menu(); +} +@endcode + +The action is one of `GLFW_PRESS` or `GLFW_RELEASE`. + +Mouse button states for [named buttons](@ref buttons) are also saved in +per-window state arrays that can be polled with @ref glfwGetMouseButton. + +@code +int state = glfwGetMouseButton(window, GLFW_MOUSE_BUTTON_LEFT); +if (state == GLFW_PRESS) +{ + upgrade_cow(); +} +@endcode + +The returned state is one of `GLFW_PRESS` or `GLFW_RELEASE`. + +This function only returns cached mouse button event state. It does not poll +the system for the current state of the mouse button. + +@anchor GLFW_STICKY_MOUSE_BUTTONS +Whenever you poll state, you risk missing the state change you are looking for. +If a pressed mouse button is released again before you poll its state, you will have +missed the button press. The recommended solution for this is to use a +mouse button callback, but there is also the `GLFW_STICKY_MOUSE_BUTTONS` +input mode. + +@code +glfwSetInputMode(window, GLFW_STICKY_MOUSE_BUTTONS, GLFW_TRUE); +@endcode + +When sticky mouse buttons mode is enabled, the pollable state of a mouse button +will remain `GLFW_PRESS` until the state of that button is polled with @ref +glfwGetMouseButton. Once it has been polled, if a mouse button release event +had been processed in the meantime, the state will reset to `GLFW_RELEASE`, +otherwise it will remain `GLFW_PRESS`. + +The `GLFW_MOUSE_BUTTON_LAST` constant holds the highest value of any +[named button](@ref buttons). + + +@subsection scrolling Scroll input + +If you wish to be notified when the user scrolls, whether with a mouse wheel or +touchpad gesture, set a scroll callback. + +@code +glfwSetScrollCallback(window, scroll_callback); +@endcode + +The callback function receives two-dimensional scroll offsets. + +@code +void scroll_callback(GLFWwindow* window, double xoffset, double yoffset) +{ +} +@endcode + +A normal mouse wheel, being vertical, provides offsets along the Y-axis. + + +@section joystick Joystick input + +The joystick functions expose connected joysticks and controllers, with both +referred to as joysticks. It supports up to sixteen joysticks, ranging from +`GLFW_JOYSTICK_1`, `GLFW_JOYSTICK_2` up to and including `GLFW_JOYSTICK_16` or +`GLFW_JOYSTICK_LAST`. You can test whether a [joystick](@ref joysticks) is +present with @ref glfwJoystickPresent. + +@code +int present = glfwJoystickPresent(GLFW_JOYSTICK_1); +@endcode + +Each joystick has zero or more axes, zero or more buttons, zero or more hats, +a human-readable name, a user pointer and an SDL compatible GUID. + +When GLFW is initialized, detected joysticks are added to the beginning of +the array. Once a joystick is detected, it keeps its assigned ID until it is +disconnected or the library is terminated, so as joysticks are connected and +disconnected, there may appear gaps in the IDs. + +Joystick axis, button and hat state is updated when polled and does not require +a window to be created or events to be processed. However, if you want joystick +connection and disconnection events reliably delivered to the +[joystick callback](@ref joystick_event) then you must +[process events](@ref events). + +To see all the properties of all connected joysticks in real-time, run the +`joysticks` test program. + + +@subsection joystick_axis Joystick axis states + +The positions of all axes of a joystick are returned by @ref +glfwGetJoystickAxes. See the reference documentation for the lifetime of the +returned array. + +@code +int count; +const float* axes = glfwGetJoystickAxes(GLFW_JOYSTICK_5, &count); +@endcode + +Each element in the returned array is a value between -1.0 and 1.0. + + +@subsection joystick_button Joystick button states + +The states of all buttons of a joystick are returned by @ref +glfwGetJoystickButtons. See the reference documentation for the lifetime of the +returned array. + +@code +int count; +const unsigned char* buttons = glfwGetJoystickButtons(GLFW_JOYSTICK_3, &count); +@endcode + +Each element in the returned array is either `GLFW_PRESS` or `GLFW_RELEASE`. + +For backward compatibility with earlier versions that did not have @ref +glfwGetJoystickHats, the button array by default also includes all hats. See +the reference documentation for @ref glfwGetJoystickButtons for details. + + +@subsection joystick_hat Joystick hat states + +The states of all hats are returned by @ref glfwGetJoystickHats. See the +reference documentation for the lifetime of the returned array. + +@code +int count; +const unsigned char* hats = glfwGetJoystickHats(GLFW_JOYSTICK_7, &count); +@endcode + +Each element in the returned array is one of the following: + +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 + +For backward compatibility with earlier versions that did not have @ref +glfwGetJoystickHats, all hats are by default also included in the button array. +See the reference documentation for @ref glfwGetJoystickButtons for details. + + +@subsection joystick_name Joystick name + +The human-readable, UTF-8 encoded name of a joystick is returned by @ref +glfwGetJoystickName. See the reference documentation for the lifetime of the +returned string. + +@code +const char* name = glfwGetJoystickName(GLFW_JOYSTICK_4); +@endcode + +Joystick names are not guaranteed to be unique. Two joysticks of the same model +and make may have the same name. Only the [joystick ID](@ref joysticks) is +guaranteed to be unique, and only until that joystick is disconnected. + + +@subsection joystick_userptr Joystick user pointer + +Each joystick has a user pointer that can be set with @ref +glfwSetJoystickUserPointer and queried with @ref glfwGetJoystickUserPointer. +This can be used for any purpose you need and will not be modified by GLFW. The +value will be kept until the joystick is disconnected or until the library is +terminated. + +The initial value of the pointer is `NULL`. + + +@subsection joystick_event Joystick configuration changes + +If you wish to be notified when a joystick is connected or disconnected, set +a joystick callback. + +@code +glfwSetJoystickCallback(joystick_callback); +@endcode + +The callback function receives the ID of the joystick that has been connected +and disconnected and the event that occurred. + +@code +void joystick_callback(int jid, int event) +{ + if (event == GLFW_CONNECTED) + { + // The joystick was connected + } + else if (event == GLFW_DISCONNECTED) + { + // The joystick was disconnected + } +} +@endcode + +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 for a disconnected joystick. + +Only @ref glfwGetJoystickName and @ref glfwGetJoystickUserPointer will return +useful values for a disconnected joystick and only before the monitor callback +returns. + + +@subsection gamepad Gamepad input + +The joystick functions provide unlabeled axes, buttons and hats, with no +indication of where they are located on the device. Their order may also vary +between platforms even with the same device. + +To solve this problem the SDL community crowdsourced the +[SDL_GameControllerDB](https://github.com/gabomdq/SDL_GameControllerDB) project, +a database of mappings from many different devices to an Xbox-like gamepad. + +GLFW supports this mapping format and contains a copy of the mappings +available at the time of release. See @ref gamepad_mapping for how to update +this at runtime. Mappings will be assigned to joysticks automatically any time +a joystick is connected or the mappings are updated. + +You can check whether a joystick is both present and has a gamepad mapping with +@ref glfwJoystickIsGamepad. + +@code +if (glfwJoystickIsGamepad(GLFW_JOYSTICK_2)) +{ + // Use as gamepad +} +@endcode + +If you are only interested in gamepad input you can use this function instead of +@ref glfwJoystickPresent. + +You can query the human-readable name provided by the gamepad mapping with @ref +glfwGetGamepadName. This may or may not be the same as the +[joystick name](@ref joystick_name). + +@code +const char* name = glfwGetGamepadName(GLFW_JOYSTICK_7); +@endcode + +To retrieve the gamepad state of a joystick, call @ref glfwGetGamepadState. + +@code +GLFWgamepadstate state; + +if (glfwGetGamepadState(GLFW_JOYSTICK_3, &state)) +{ + if (state.buttons[GLFW_GAMEPAD_BUTTON_A]) + { + input_jump(); + } + + input_speed(state.axes[GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER]); +} +@endcode + +The @ref GLFWgamepadstate struct has two arrays; one for button states and one +for axis states. The values for each button and axis are the same as for the +@ref glfwGetJoystickButtons and @ref glfwGetJoystickAxes functions, i.e. +`GLFW_PRESS` or `GLFW_RELEASE` for buttons and -1.0 to 1.0 inclusive for axes. + +The sizes of the arrays and the positions within each array are fixed. + +The [button indices](@ref gamepad_buttons) are `GLFW_GAMEPAD_BUTTON_A`, +`GLFW_GAMEPAD_BUTTON_B`, `GLFW_GAMEPAD_BUTTON_X`, `GLFW_GAMEPAD_BUTTON_Y`, +`GLFW_GAMEPAD_BUTTON_LEFT_BUMPER`, `GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER`, +`GLFW_GAMEPAD_BUTTON_BACK`, `GLFW_GAMEPAD_BUTTON_START`, +`GLFW_GAMEPAD_BUTTON_GUIDE`, `GLFW_GAMEPAD_BUTTON_LEFT_THUMB`, +`GLFW_GAMEPAD_BUTTON_RIGHT_THUMB`, `GLFW_GAMEPAD_BUTTON_DPAD_UP`, +`GLFW_GAMEPAD_BUTTON_DPAD_RIGHT`, `GLFW_GAMEPAD_BUTTON_DPAD_DOWN` and +`GLFW_GAMEPAD_BUTTON_DPAD_LEFT`. + +For those who prefer, there are also the `GLFW_GAMEPAD_BUTTON_CROSS`, +`GLFW_GAMEPAD_BUTTON_CIRCLE`, `GLFW_GAMEPAD_BUTTON_SQUARE` and +`GLFW_GAMEPAD_BUTTON_TRIANGLE` aliases for the A, B, X and Y button indices. + +The [axis indices](@ref gamepad_axes) are `GLFW_GAMEPAD_AXIS_LEFT_X`, +`GLFW_GAMEPAD_AXIS_LEFT_Y`, `GLFW_GAMEPAD_AXIS_RIGHT_X`, +`GLFW_GAMEPAD_AXIS_RIGHT_Y`, `GLFW_GAMEPAD_AXIS_LEFT_TRIGGER` and +`GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER`. + +The `GLFW_GAMEPAD_BUTTON_LAST` and `GLFW_GAMEPAD_AXIS_LAST` constants equal +the largest available index for each array. + + +@subsection gamepad_mapping Gamepad mappings + +GLFW contains a copy of the mappings available in +[SDL_GameControllerDB](https://github.com/gabomdq/SDL_GameControllerDB) at the +time of release. Newer ones can be added at runtime with @ref +glfwUpdateGamepadMappings. + +@code +const char* mappings = load_file_contents("game/data/gamecontrollerdb.txt"); + +glfwUpdateGamepadMappings(mappings); +@endcode + +This function supports everything from single lines up to and including the +unmodified contents of the whole `gamecontrollerdb.txt` file. + +If you are compiling GLFW from source with CMake you can update the built-in mappings by +building the _update_mappings_ target. This runs the `GenerateMappings.cmake` CMake +script, which downloads `gamecontrollerdb.txt` and regenerates the `mappings.h` header +file. + +Below is a description of the mapping format. Please keep in mind that __this +description is not authoritative__. The format is defined by the SDL and +SDL_GameControllerDB projects and their documentation and code takes precedence. + +Each mapping is a single line of comma-separated values describing the GUID, +name and layout of the gamepad. Lines that do not begin with a hexadecimal +digit are ignored. + +The first value is always the gamepad GUID, a 32 character long hexadecimal +string that typically identifies its make, model, revision and the type of +connection to the computer. When this information is not available, the GUID is +generated using the gamepad name. GLFW uses the SDL 2.0.5+ GUID format but can +convert from the older formats. + +The second value is always the human-readable name of the gamepad. + +All subsequent values are in the form `:` and describe the layout +of the mapping. These fields may not all be present and may occur in any order. + +The button fields are `a`, `b`, `x`, `y`, `back`, `start`, `guide`, `dpup`, +`dpright`, `dpdown`, `dpleft`, `leftshoulder`, `rightshoulder`, `leftstick` and +`rightstick`. + +The axis fields are `leftx`, `lefty`, `rightx`, `righty`, `lefttrigger` and +`righttrigger`. + +The value of an axis or button field can be a joystick button, a joystick axis, +a hat bitmask or empty. Joystick buttons are specified as `bN`, for example +`b2` for the third button. Joystick axes are specified as `aN`, for example +`a7` for the eighth button. Joystick hat bit masks are specified as `hN.N`, for +example `h0.8` for left on the first hat. More than one bit may be set in the +mask. + +Before an axis there may be a `+` or `-` range modifier, for example `+a3` for +the positive half of the fourth axis. This restricts input to only the positive +or negative halves of the joystick axis. After an axis or half-axis there may +be the `~` inversion modifier, for example `a2~` or `-a7~`. This negates the +values of the gamepad axis. + +The hat bit mask match the [hat states](@ref hat_state) in the joystick +functions. + +There is also the special `platform` field that specifies which platform the +mapping is valid for. Possible values are `Windows`, `Mac OS X` and `Linux`. + +Below is an example of what a gamepad mapping might look like. It is the +one built into GLFW for Xbox controllers accessed via the XInput API on Windows. +This example has been broken into several lines to fit on the page, but real +gamepad mappings must be a single line. + +@code{.unparsed} +78696e70757401000000000000000000,XInput Gamepad (GLFW),platform:Windows,a:b0, +b:b1,x:b2,y:b3,leftshoulder:b4,rightshoulder:b5,back:b6,start:b7,leftstick:b8, +rightstick:b9,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:a4, +righttrigger:a5,dpup:h0.1,dpright:h0.2,dpdown:h0.4,dpleft:h0.8, +@endcode + +@note GLFW does not yet support the output range and modifiers `+` and `-` that +were recently added to SDL. The input modifiers `+`, `-` and `~` are supported +and described above. + + +@section time Time input + +GLFW provides high-resolution time input, in seconds, with @ref glfwGetTime. + +@code +double seconds = glfwGetTime(); +@endcode + +It returns the number of seconds since the library was initialized with @ref +glfwInit. The platform-specific time sources used typically have micro- or +nanosecond resolution. + +You can modify the base time with @ref glfwSetTime. + +@code +glfwSetTime(4.0); +@endcode + +This sets the time to the specified time, in seconds, and it continues to count +from there. + +You can also access the raw timer used to implement the functions above, +with @ref glfwGetTimerValue. + +@code +uint64_t value = glfwGetTimerValue(); +@endcode + +This value is in 1 / frequency seconds. The frequency of the raw +timer varies depending on the operating system and hardware. You can query the +frequency, in Hz, with @ref glfwGetTimerFrequency. + +@code +uint64_t frequency = glfwGetTimerFrequency(); +@endcode + + +@section clipboard Clipboard input and output + +If the system clipboard contains a UTF-8 encoded string or if it can be +converted to one, you can retrieve it with @ref glfwGetClipboardString. See the +reference documentation for the lifetime of the returned string. + +@code +const char* text = glfwGetClipboardString(NULL); +if (text) +{ + insert_text(text); +} +@endcode + +If the clipboard is empty or if its contents could not be converted, `NULL` is +returned. + +The contents of the system clipboard can be set to a UTF-8 encoded string with +@ref glfwSetClipboardString. + +@code +glfwSetClipboardString(NULL, "A string with words in it"); +@endcode + + +@section path_drop Path drop input + +If you wish to receive the paths of files and/or directories dropped on +a window, set a file drop callback. + +@code +glfwSetDropCallback(window, drop_callback); +@endcode + +The callback function receives an array of paths encoded as UTF-8. + +@code +void drop_callback(GLFWwindow* window, int count, const char** paths) +{ + int i; + for (i = 0; i < count; i++) + handle_dropped_file(paths[i]); +} +@endcode + +The path array and its strings are only valid until the file drop callback +returns, as they may have been generated specifically for that event. You need +to make a deep copy of the array if you want to keep the paths. + +*/ diff --git a/deps/glfw-3.3.8/docs/internal.dox b/deps/glfw-3.3.8/docs/internal.dox new file mode 100644 index 0000000..685c6d1 --- /dev/null +++ b/deps/glfw-3.3.8/docs/internal.dox @@ -0,0 +1,115 @@ +/*! + +@page internals_guide Internal structure + +@tableofcontents + +There are several interfaces inside GLFW. Each interface has its own area of +responsibility and its own naming conventions. + + +@section internals_public Public interface + +The most well-known is the public interface, described in the glfw3.h header +file. This is implemented in source files shared by all platforms and these +files contain no platform-specific code. This code usually ends up calling the +platform and internal interfaces to do the actual work. + +The public interface uses the OpenGL naming conventions except with GLFW and +glfw instead of GL and gl. For struct members, where OpenGL sets no precedent, +it use headless camel case. + +Examples: `glfwCreateWindow`, `GLFWwindow`, `GLFW_RED_BITS` + + +@section internals_native Native interface + +The [native interface](@ref native) is a small set of publicly available +but platform-specific functions, described in the glfw3native.h header file and +used to gain access to the underlying window, context and (on some platforms) +display handles used by the platform interface. + +The function names of the native interface are similar to those of the public +interface, but embeds the name of the interface that the returned handle is +from. + +Examples: `glfwGetX11Window`, `glfwGetWGLContext` + + +@section internals_internal Internal interface + +The internal interface consists of utility functions used by all other +interfaces. It is shared code implemented in the same shared source files as +the public and event interfaces. The internal interface is described in the +internal.h header file. + +The internal interface is in charge of GLFW's global data, which it stores in +a `_GLFWlibrary` struct named `_glfw`. + +The internal interface uses the same style as the public interface, except all +global names have a leading underscore. + +Examples: `_glfwIsValidContextConfig`, `_GLFWwindow`, `_glfw.monitorCount` + + +@section internals_platform Platform interface + +The platform interface implements all platform-specific operations as a service +to the public interface. This includes event processing. The platform +interface is never directly called by application code and never directly calls +application-provided callbacks. It is also prohibited from modifying the +platform-independent part of the internal structs. Instead, it calls the event +interface when events interesting to GLFW are received. + +The platform interface mirrors those parts of the public interface that needs to +perform platform-specific operations on some or all platforms. The are also +named the same except that the glfw function prefix is replaced by +_glfwPlatform. + +Examples: `_glfwPlatformCreateWindow` + +The platform interface also defines structs that contain platform-specific +global and per-object state. Their names mirror those of the internal +interface, except that an interface-specific suffix is added. + +Examples: `_GLFWwindowX11`, `_GLFWcontextWGL` + +These structs are incorporated as members into the internal interface structs +using special macros that name them after the specific interface used. This +prevents shared code from accidentally using these members. + +Examples: `window->win32.handle`, `_glfw.x11.display` + + +@section internals_event Event interface + +The event interface is implemented in the same shared source files as the public +interface and is responsible for delivering the events it receives to the +application, either via callbacks, via window state changes or both. + +The function names of the event interface use a `_glfwInput` prefix and the +ObjectEvent pattern. + +Examples: `_glfwInputWindowFocus`, `_glfwInputCursorPos` + + +@section internals_static Static functions + +Static functions may be used by any interface and have no prefixes or suffixes. +These use headless camel case. + +Examples: `isValidElementForJoystick` + + +@section internals_config Configuration macros + +GLFW uses a number of configuration macros to select at compile time which +interfaces and code paths to use. They are defined in the glfw_config.h header file, +which is generated from the `glfw_config.h.in` file by CMake. + +Configuration macros the same style as tokens in the public interface, except +with a leading underscore. + +Examples: `_GLFW_WIN32`, `_GLFW_BUILD_DLL` + +*/ diff --git a/deps/glfw-3.3.8/docs/intro.dox b/deps/glfw-3.3.8/docs/intro.dox new file mode 100644 index 0000000..e563b50 --- /dev/null +++ b/deps/glfw-3.3.8/docs/intro.dox @@ -0,0 +1,454 @@ +/*! + +@page intro_guide Introduction to the API + +@tableofcontents + +This guide introduces the basic concepts of GLFW and describes initialization, +error handling and API guarantees and limitations. For a broad but shallow +tutorial, see @ref quick_guide instead. For details on a specific function in +this category, see the @ref init. + +There are also guides for the other areas of GLFW. + + - @ref window_guide + - @ref context_guide + - @ref vulkan_guide + - @ref monitor_guide + - @ref input_guide + + +@section intro_init Initialization and termination + +Before most GLFW functions may be called, the library must be initialized. +This initialization checks what features are available on the machine, +enumerates monitors and joysticks, initializes the timer and performs any +required platform-specific initialization. + +Only the following functions may be called before the library has been +successfully initialized, and only from the main thread. + + - @ref glfwGetVersion + - @ref glfwGetVersionString + - @ref glfwGetError + - @ref glfwSetErrorCallback + - @ref glfwInitHint + - @ref glfwInit + - @ref glfwTerminate + +Calling any other function before successful initialization will cause a @ref +GLFW_NOT_INITIALIZED error. + + +@subsection intro_init_init Initializing GLFW + +The library is initialized with @ref glfwInit, which returns `GLFW_FALSE` if an +error occurred. + +@code +if (!glfwInit()) +{ + // Handle initialization failure +} +@endcode + +If any part of initialization fails, any parts that succeeded are terminated as +if @ref glfwTerminate had been called. The library only needs to be initialized +once and additional calls to an already initialized library will return +`GLFW_TRUE` immediately. + +Once the library has been successfully initialized, it should be terminated +before the application exits. Modern systems are very good at freeing resources +allocated by programs that exit, but GLFW sometimes has to change global system +settings and these might not be restored without termination. + + +@subsection init_hints Initialization hints + +Initialization hints are set before @ref glfwInit and affect how the library +behaves until termination. Hints are set with @ref glfwInitHint. + +@code +glfwInitHint(GLFW_JOYSTICK_HAT_BUTTONS, GLFW_FALSE); +@endcode + +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. + + +@subsubsection init_hints_shared Shared init hints + +@anchor GLFW_JOYSTICK_HAT_BUTTONS +__GLFW_JOYSTICK_HAT_BUTTONS__ specifies whether to also expose joystick hats as +buttons, for compatibility with earlier versions of GLFW that did not have @ref +glfwGetJoystickHats. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. + + +@subsubsection init_hints_osx macOS specific init hints + +@anchor GLFW_COCOA_CHDIR_RESOURCES_hint +__GLFW_COCOA_CHDIR_RESOURCES__ specifies whether to set the current directory to +the application to the `Contents/Resources` subdirectory of the application's +bundle, if present. Set this with @ref glfwInitHint. + +@anchor GLFW_COCOA_MENUBAR_hint +__GLFW_COCOA_MENUBAR__ specifies whether to create a basic menu bar, either from +a nib or manually, when the first window is created, which is when AppKit is +initialized. Set this with @ref glfwInitHint. + + +@subsubsection init_hints_values Supported and default values + +Initialization hint | Default value | Supported values +------------------------------- | ------------- | ---------------- +@ref GLFW_JOYSTICK_HAT_BUTTONS | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +@ref GLFW_COCOA_CHDIR_RESOURCES | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +@ref GLFW_COCOA_MENUBAR | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` + + +@subsection intro_init_terminate Terminating GLFW + +Before your application exits, you should terminate the GLFW library if it has +been initialized. This is done with @ref glfwTerminate. + +@code +glfwTerminate(); +@endcode + +This will destroy any remaining window, monitor and cursor objects, restore any +modified gamma ramps, re-enable the screensaver if it had been disabled and free +any other resources allocated by GLFW. + +Once the library is terminated, it is as if it had never been initialized and +you will need to initialize it again before being able to use GLFW. If the +library was not initialized or had already been terminated, it return +immediately. + + +@section error_handling Error handling + +Some GLFW functions have return values that indicate an error, but this is often +not very helpful when trying to figure out what happened or why it occurred. +Other functions have no return value reserved for errors, so error notification +needs a separate channel. Finally, far from all GLFW functions have return +values. + +The last [error code](@ref errors) for the calling thread can be queried at any +time with @ref glfwGetError. + +@code +int code = glfwGetError(NULL); + +if (code != GLFW_NO_ERROR) + handle_error(code); +@endcode + +If no error has occurred since the last call, @ref GLFW_NO_ERROR (zero) is +returned. The error is cleared before the function returns. + +The error code indicates the general category of the error. Some error codes, +such as @ref GLFW_NOT_INITIALIZED has only a single meaning, whereas others like +@ref GLFW_PLATFORM_ERROR are used for many different errors. + +GLFW often has more information about an error than its general category. You +can retrieve a UTF-8 encoded human-readable description along with the error +code. If no error has occurred since the last call, the description is set to +`NULL`. + +@code +const char* description; +int code = glfwGetError(&description); + +if (description) + display_error_message(code, description); +@endcode + +The retrieved description string is only valid until the next error occurs. +This means you must make a copy of it if you want to keep it. + +You can also set an error callback, which will be called each time an error +occurs. It is set with @ref glfwSetErrorCallback. + +@code +glfwSetErrorCallback(error_callback); +@endcode + +The error callback receives the same error code and human-readable description +returned by @ref glfwGetError. + +@code +void error_callback(int code, const char* description) +{ + display_error_message(code, description); +} +@endcode + +The error callback is called after the error is stored, so calling @ref +glfwGetError from within the error callback returns the same values as the +callback argument. + +The description string passed to the callback is only valid until the error +callback returns. This means you must make a copy of it if you want to keep it. + +__Reported errors are never fatal.__ As long as GLFW was successfully +initialized, it will remain initialized and in a safe state until terminated +regardless of how many errors occur. If an error occurs during initialization +that causes @ref glfwInit to fail, any part of the library that was initialized +will be safely terminated. + +Do not rely on a currently invalid call to generate a specific error, as in the +future that same call may generate a different error or become valid. + + +@section coordinate_systems Coordinate systems + +GLFW has two primary coordinate systems: the _virtual screen_ and the window +_content area_ or _content area_. Both use the same unit: _virtual screen +coordinates_, or just _screen coordinates_, which don't necessarily correspond +to pixels. + + + +Both the virtual screen and the content area coordinate systems have the X-axis +pointing to the right and the Y-axis pointing down. + +Window and monitor positions are specified as the position of the upper-left +corners of their content areas relative to the virtual screen, while cursor +positions are specified relative to a window's content area. + +Because the origin of the window's content area coordinate system is also the +point from which the window position is specified, you can translate content +area coordinates to the virtual screen by adding the window position. The +window frame, when present, extends out from the content area but does not +affect the window position. + +Almost all positions and sizes in GLFW are measured in screen coordinates +relative to one of the two origins above. This includes cursor positions, +window positions and sizes, window frame sizes, monitor positions and video mode +resolutions. + +Two exceptions are the [monitor physical size](@ref monitor_size), which is +measured in millimetres, and [framebuffer size](@ref window_fbsize), which is +measured in pixels. + +Pixels and screen coordinates may map 1:1 on your machine, but they won't on +every other machine, for example on a Mac with a Retina display. The ratio +between screen coordinates and pixels may also change at run-time depending on +which monitor the window is currently considered to be on. + + +@section guarantees_limitations Guarantees and limitations + +This section describes the conditions under which GLFW can be expected to +function, barring bugs in the operating system or drivers. Use of GLFW outside +of these limits may work on some platforms, or on some machines, or some of the +time, or on some versions of GLFW, but it may break at any time and this will +not be considered a bug. + + +@subsection lifetime Pointer lifetimes + +GLFW will never free any pointer you provide to it and you must never free any +pointer it provides to you. + +Many GLFW functions return pointers to dynamically allocated structures, strings +or arrays, and some callbacks are provided with strings or arrays. These are +always managed by GLFW and should never be freed by the application. The +lifetime of these pointers is documented for each GLFW function and callback. +If you need to keep this data, you must copy it before its lifetime expires. + +Many GLFW functions accept pointers to structures or strings allocated by the +application. These are never freed by GLFW and are always the responsibility of +the application. If GLFW needs to keep the data in these structures or strings, +it is copied before the function returns. + +Pointer lifetimes are guaranteed not to be shortened in future minor or patch +releases. + + +@subsection reentrancy Reentrancy + +GLFW event processing and object destruction are not reentrant. This means that +the following functions must not be called from any callback function: + + - @ref glfwDestroyWindow + - @ref glfwDestroyCursor + - @ref glfwPollEvents + - @ref glfwWaitEvents + - @ref glfwWaitEventsTimeout + - @ref glfwTerminate + +These functions may be made reentrant in future minor or patch releases, but +functions not on this list will not be made non-reentrant. + + +@subsection thread_safety Thread safety + +Most GLFW functions must only be called from the main thread (the thread that +calls main), but some may be called from any thread once the library has been +initialized. Before initialization the whole library is thread-unsafe. + +The reference documentation for every GLFW function states whether it is limited +to the main thread. + +Initialization, termination, event processing and the creation and +destruction of windows, cursors and OpenGL and OpenGL ES contexts are all +restricted to the main thread due to limitations of one or several platforms. + +Because event processing must be performed on the main thread, all callbacks +except for the error callback will only be called on that thread. The error +callback may be called on any thread, as any GLFW function may generate errors. + +The error code and description may be queried from any thread. + + - @ref glfwGetError + +Empty events may be posted from any thread. + + - @ref glfwPostEmptyEvent + +The window user pointer and close flag may be read and written from any thread, +but this is not synchronized by GLFW. + + - @ref glfwGetWindowUserPointer + - @ref glfwSetWindowUserPointer + - @ref glfwWindowShouldClose + - @ref glfwSetWindowShouldClose + +These functions for working with OpenGL and OpenGL ES contexts may be called +from any thread, but the window object is not synchronized by GLFW. + + - @ref glfwMakeContextCurrent + - @ref glfwGetCurrentContext + - @ref glfwSwapBuffers + - @ref glfwSwapInterval + - @ref glfwExtensionSupported + - @ref glfwGetProcAddress + +The raw timer functions may be called from any thread. + + - @ref glfwGetTimerFrequency + - @ref glfwGetTimerValue + +The regular timer may be used from any thread, but reading and writing the timer +offset is not synchronized by GLFW. + + - @ref glfwGetTime + - @ref glfwSetTime + +Library version information may be queried from any thread. + + - @ref glfwGetVersion + - @ref glfwGetVersionString + +All Vulkan related functions may be called from any thread. + + - @ref glfwVulkanSupported + - @ref glfwGetRequiredInstanceExtensions + - @ref glfwGetInstanceProcAddress + - @ref glfwGetPhysicalDevicePresentationSupport + - @ref glfwCreateWindowSurface + +GLFW uses synchronization objects internally only to manage the per-thread +context and error states. Additional synchronization is left to the +application. + +Functions that may currently be called from any thread will always remain so, +but functions that are currently limited to the main thread may be updated to +allow calls from any thread in future releases. + + +@subsection compatibility Version compatibility + +GLFW uses [Semantic Versioning](https://semver.org/). This guarantees source +and binary backward compatibility with earlier minor versions of the API. This +means that you can drop in a newer version of the library and existing programs +will continue to compile and existing binaries will continue to run. + +Once a function or constant has been added, the signature of that function or +value of that constant will remain unchanged until the next major version of +GLFW. No compatibility of any kind is guaranteed between major versions. + +Undocumented behavior, i.e. behavior that is not described in the documentation, +may change at any time until it is documented. + +If the reference documentation and the implementation differ, the reference +documentation will almost always take precedence and the implementation will be +fixed in the next release. The reference documentation will also take +precedence over anything stated in a guide. + + +@subsection event_order Event order + +The order of arrival of related events is not guaranteed to be consistent +across platforms. The exception is synthetic key and mouse button release +events, which are always delivered after the window defocus event. + + +@section intro_version Version management + +GLFW provides mechanisms for identifying what version of GLFW your application +was compiled against as well as what version it is currently running against. +If you are loading GLFW dynamically (not just linking dynamically), you can use +this to verify that the library binary is compatible with your application. + + +@subsection intro_version_compile Compile-time version + +The compile-time version of GLFW is provided by the GLFW header with the +`GLFW_VERSION_MAJOR`, `GLFW_VERSION_MINOR` and `GLFW_VERSION_REVISION` macros. + +@code +printf("Compiled against GLFW %i.%i.%i\n", + GLFW_VERSION_MAJOR, + GLFW_VERSION_MINOR, + GLFW_VERSION_REVISION); +@endcode + + +@subsection intro_version_runtime Run-time version + +The run-time version can be retrieved with @ref glfwGetVersion, a function that +may be called regardless of whether GLFW is initialized. + +@code +int major, minor, revision; +glfwGetVersion(&major, &minor, &revision); + +printf("Running against GLFW %i.%i.%i\n", major, minor, revision); +@endcode + + +@subsection intro_version_string Version string + +GLFW 3 also provides a compile-time generated version string that describes the +version, platform, compiler and any platform-specific compile-time options. +This is primarily intended for submitting bug reports, to allow developers to +see which code paths are enabled in a binary. + +The version string is returned by @ref glfwGetVersionString, a function that may +be called regardless of whether GLFW is initialized. + +__Do not use the version string__ to parse the GLFW library version. The @ref +glfwGetVersion function already provides the version of the running library +binary. + +The format of the string is as follows: + - The version of GLFW + - The name of the window system API + - The name of the context creation API + - Any additional options or APIs + +For example, when compiling GLFW 3.0 with MinGW using the Win32 and WGL +back ends, the version string may look something like this: + +@code +3.0.0 Win32 WGL MinGW +@endcode + +*/ diff --git a/deps/glfw-3.3.8/docs/main.dox b/deps/glfw-3.3.8/docs/main.dox new file mode 100644 index 0000000..bd563d9 --- /dev/null +++ b/deps/glfw-3.3.8/docs/main.dox @@ -0,0 +1,46 @@ +/*! + +@mainpage notitle + +@section main_intro Introduction + +GLFW is a free, Open Source, multi-platform library for OpenGL, OpenGL ES and +Vulkan application development. It provides a simple, platform-independent API +for creating windows, contexts and surfaces, reading input, handling events, etc. + +@ref news_33 list new features, caveats and deprecations. + +@ref quick_guide is a guide for users new to GLFW. It takes you through how to +write a small but complete program. + +There are guides for each section of the API: + + - @ref intro_guide – initialization, error handling and high-level design + - @ref window_guide – creating and working with windows and framebuffers + - @ref context_guide – working with OpenGL and OpenGL ES contexts + - @ref vulkan_guide - working with Vulkan objects and extensions + - @ref monitor_guide – enumerating and working with monitors and video modes + - @ref input_guide – receiving events, polling and processing input + +Once you have written a program, see @ref compile_guide and @ref build_guide. + +The [reference documentation](modules.html) provides more detailed information +about specific functions. + +@ref moving_guide explains what has changed and how to update existing code to +use the new API. + +There is a section on @ref guarantees_limitations for pointer lifetimes, +reentrancy, thread safety, event order and backward and forward compatibility. + +The [FAQ](https://www.glfw.org/faq.html) answers many common questions about the +design, implementation and use of GLFW. + +Finally, @ref compat_guide explains what APIs, standards and protocols GLFW uses +and what happens when they are not present on a given machine. + +This documentation was generated with Doxygen. The sources for it are available +in both the [source distribution](https://www.glfw.org/download.html) and +[GitHub repository](https://github.com/glfw/glfw). + +*/ diff --git a/deps/glfw-3.3.8/docs/monitor.dox b/deps/glfw-3.3.8/docs/monitor.dox new file mode 100644 index 0000000..86eb454 --- /dev/null +++ b/deps/glfw-3.3.8/docs/monitor.dox @@ -0,0 +1,268 @@ +/*! + +@page monitor_guide Monitor guide + +@tableofcontents + +This guide introduces the monitor related functions of GLFW. For details on +a specific function in this category, see the @ref monitor. There are also +guides for the other areas of GLFW. + + - @ref intro_guide + - @ref window_guide + - @ref context_guide + - @ref vulkan_guide + - @ref input_guide + + +@section monitor_object Monitor objects + +A monitor object represents a currently connected monitor and is represented as +a pointer to the [opaque](https://en.wikipedia.org/wiki/Opaque_data_type) type +@ref GLFWmonitor. Monitor objects cannot be created or destroyed by the +application and retain their addresses until the monitors they represent are +disconnected or until the library is [terminated](@ref intro_init_terminate). + +Each monitor has a current video mode, a list of supported video modes, +a virtual position, a human-readable name, an estimated physical size and +a gamma ramp. One of the monitors is the primary monitor. + +The virtual position of a monitor is in +[screen coordinates](@ref coordinate_systems) and, together with the current +video mode, describes the viewports that the connected monitors provide into the +virtual desktop that spans them. + +To see how GLFW views your monitor setup and its available video modes, run the +`monitors` test program. + + +@subsection monitor_monitors Retrieving monitors + +The primary monitor is returned by @ref glfwGetPrimaryMonitor. It is the user's +preferred monitor and is usually the one with global UI elements like task bar +or menu bar. + +@code +GLFWmonitor* primary = glfwGetPrimaryMonitor(); +@endcode + +You can retrieve all currently connected monitors with @ref glfwGetMonitors. +See the reference documentation for the lifetime of the returned array. + +@code +int count; +GLFWmonitor** monitors = glfwGetMonitors(&count); +@endcode + +The primary monitor is always the first monitor in the returned array, but other +monitors may be moved to a different index when a monitor is connected or +disconnected. + + +@subsection monitor_event Monitor configuration changes + +If you wish to be notified when a monitor is connected or disconnected, set +a monitor callback. + +@code +glfwSetMonitorCallback(monitor_callback); +@endcode + +The callback function receives the handle for the monitor that has been +connected or disconnected and the event that occurred. + +@code +void monitor_callback(GLFWmonitor* monitor, int event) +{ + if (event == GLFW_CONNECTED) + { + // The monitor was connected + } + else if (event == GLFW_DISCONNECTED) + { + // The monitor was disconnected + } +} +@endcode + +If a monitor is disconnected, all windows that are full screen on it will be +switched to windowed mode before the callback is called. Only @ref +glfwGetMonitorName and @ref glfwGetMonitorUserPointer will return useful values +for a disconnected monitor and only before the monitor callback returns. + + +@section monitor_properties Monitor properties + +Each monitor has a current video mode, a list of supported video modes, +a virtual position, a content scale, a human-readable name, a user pointer, an +estimated physical size and a gamma ramp. + + +@subsection monitor_modes Video modes + +GLFW generally does a good job selecting a suitable video mode when you create +a full screen window, change its video mode or make a windowed one full +screen, but it is sometimes useful to know exactly which video modes are +supported. + +Video modes are represented as @ref GLFWvidmode structures. You can get an +array of the video modes supported by a monitor with @ref glfwGetVideoModes. +See the reference documentation for the lifetime of the returned array. + +@code +int count; +GLFWvidmode* modes = glfwGetVideoModes(monitor, &count); +@endcode + +To get the current video mode of a monitor call @ref glfwGetVideoMode. See the +reference documentation for the lifetime of the returned pointer. + +@code +const GLFWvidmode* mode = glfwGetVideoMode(monitor); +@endcode + +The resolution of a video mode is specified in +[screen coordinates](@ref coordinate_systems), not pixels. + + +@subsection monitor_size Physical size + +The physical size of a monitor in millimetres, or an estimation of it, can be +retrieved with @ref glfwGetMonitorPhysicalSize. This has no relation to its +current _resolution_, i.e. the width and height of its current +[video mode](@ref monitor_modes). + +@code +int width_mm, height_mm; +glfwGetMonitorPhysicalSize(monitor, &width_mm, &height_mm); +@endcode + +While this can be used to calculate the raw DPI of a monitor, this is often not +useful. Instead use the [monitor content scale](@ref monitor_scale) and +[window content scale](@ref window_scale) to scale your content. + + +@subsection monitor_scale Content scale + +The content scale for a monitor can be retrieved with @ref +glfwGetMonitorContentScale. + +@code +float xscale, yscale; +glfwGetMonitorContentScale(monitor, &xscale, &yscale); +@endcode + +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. + + +@subsection monitor_pos Virtual position + +The position of the monitor on the virtual desktop, in +[screen coordinates](@ref coordinate_systems), can be retrieved with @ref +glfwGetMonitorPos. + +@code +int xpos, ypos; +glfwGetMonitorPos(monitor, &xpos, &ypos); +@endcode + + +@subsection monitor_workarea Work area + +The area of a monitor not occupied by global task bars or menu bars is the work +area. This is specified in [screen coordinates](@ref coordinate_systems) and +can be retrieved with @ref glfwGetMonitorWorkarea. + +@code +int xpos, ypos, width, height; +glfwGetMonitorWorkarea(monitor, &xpos, &ypos, &width, &height); +@endcode + + +@subsection monitor_name Human-readable name + +The human-readable, UTF-8 encoded name of a monitor is returned by @ref +glfwGetMonitorName. See the reference documentation for the lifetime of the +returned string. + +@code +const char* name = glfwGetMonitorName(monitor); +@endcode + +Monitor names are not guaranteed to be unique. Two monitors of the same model +and make may have the same name. Only the monitor handle is guaranteed to be +unique, and only until that monitor is disconnected. + + +@subsection monitor_userptr User pointer + +Each monitor has a user pointer that can be set with @ref +glfwSetMonitorUserPointer and queried with @ref glfwGetMonitorUserPointer. This +can be used for any purpose you need and will not be modified by GLFW. The +value will be kept until the monitor is disconnected or until the library is +terminated. + +The initial value of the pointer is `NULL`. + + +@subsection monitor_gamma Gamma ramp + +The gamma ramp of a monitor can be set with @ref glfwSetGammaRamp, which accepts +a monitor handle and a pointer to a @ref GLFWgammaramp structure. + +@code +GLFWgammaramp ramp; +unsigned short red[256], green[256], blue[256]; + +ramp.size = 256; +ramp.red = red; +ramp.green = green; +ramp.blue = blue; + +for (i = 0; i < ramp.size; i++) +{ + // Fill out gamma ramp arrays as desired +} + +glfwSetGammaRamp(monitor, &ramp); +@endcode + +The gamma ramp data is copied before the function returns, so there is no need +to keep it around once the ramp has been set. + +It is recommended that your gamma ramp have the same size as the current gamma +ramp for that monitor. + +The current gamma ramp for a monitor is returned by @ref glfwGetGammaRamp. See +the reference documentation for the lifetime of the returned structure. + +@code +const GLFWgammaramp* ramp = glfwGetGammaRamp(monitor); +@endcode + +If you wish to set a regular gamma ramp, you can have GLFW calculate it for you +from the desired exponent with @ref glfwSetGamma, which in turn calls @ref +glfwSetGammaRamp with the resulting ramp. + +@code +glfwSetGamma(monitor, 1.0); +@endcode + +To experiment with gamma correction via the @ref glfwSetGamma function, run the +`gamma` test program. + +@note 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. + +*/ diff --git a/deps/glfw-3.3.8/docs/moving.dox b/deps/glfw-3.3.8/docs/moving.dox new file mode 100644 index 0000000..b80d84a --- /dev/null +++ b/deps/glfw-3.3.8/docs/moving.dox @@ -0,0 +1,513 @@ +/*! + +@page moving_guide Moving from GLFW 2 to 3 + +@tableofcontents + +This is a transition guide for moving from GLFW 2 to 3. It describes what has +changed or been removed, but does _not_ include +[new features](@ref news) unless they are required when moving an existing code +base onto the new API. For example, the new multi-monitor functions are +required to create full screen windows with GLFW 3. + + +@section moving_removed Changed and removed features + +@subsection moving_renamed_files Renamed library and header file + +The GLFW 3 header is named @ref glfw3.h and moved to the `GLFW` directory, to +avoid collisions with the headers of other major versions. Similarly, the GLFW +3 library is named `glfw3,` except when it's installed as a shared library on +Unix-like systems, where it uses the +[soname](https://en.wikipedia.org/wiki/soname) `libglfw.so.3`. + +@par Old syntax +@code +#include +@endcode + +@par New syntax +@code +#include +@endcode + + +@subsection moving_threads Removal of threading functions + +The threading functions have been removed, including the per-thread sleep +function. They were fairly primitive, under-used, poorly integrated and took +time away from the focus of GLFW (i.e. context, input and window). There are +better threading libraries available and native threading support is available +in both [C++11](https://en.cppreference.com/w/cpp/thread) and +[C11](https://en.cppreference.com/w/c/thread), both of which are gaining +traction. + +If you wish to use the C++11 or C11 facilities but your compiler doesn't yet +support them, see the +[TinyThread++](https://gitorious.org/tinythread/tinythreadpp) and +[TinyCThread](https://github.com/tinycthread/tinycthread) projects created by +the original author of GLFW. These libraries implement a usable subset of the +threading APIs in C++11 and C11, and in fact some GLFW 3 test programs use +TinyCThread. + +However, GLFW 3 has better support for _use from multiple threads_ than GLFW +2 had. Contexts can be made current on any thread, although only a single +thread at a time, and the documentation explicitly states which functions may be +used from any thread and which must only be used from the main thread. + +@par Removed functions +`glfwSleep`, `glfwCreateThread`, `glfwDestroyThread`, `glfwWaitThread`, +`glfwGetThreadID`, `glfwCreateMutex`, `glfwDestroyMutex`, `glfwLockMutex`, +`glfwUnlockMutex`, `glfwCreateCond`, `glfwDestroyCond`, `glfwWaitCond`, +`glfwSignalCond`, `glfwBroadcastCond` and `glfwGetNumberOfProcessors`. + +@par Removed types +`GLFWthreadfun` + + +@subsection moving_image Removal of image and texture loading + +The image and texture loading functions have been removed. They only supported +the Targa image format, making them mostly useful for beginner level examples. +To become of sufficiently high quality to warrant keeping them in GLFW 3, they +would need not only to support other formats, but also modern extensions to +OpenGL texturing. This would either add a number of external +dependencies (libjpeg, libpng, etc.), or force GLFW to ship with inline versions +of these libraries. + +As there already are libraries doing this, it is unnecessary both to duplicate +the work and to tie the duplicate to GLFW. The resulting library would also be +platform-independent, as both OpenGL and stdio are available wherever GLFW is. + +@par Removed functions +`glfwReadImage`, `glfwReadMemoryImage`, `glfwFreeImage`, `glfwLoadTexture2D`, +`glfwLoadMemoryTexture2D` and `glfwLoadTextureImage2D`. + + +@subsection moving_stdcall Removal of GLFWCALL macro + +The `GLFWCALL` macro, which made callback functions use +[__stdcall](https://msdn.microsoft.com/en-us/library/zxk0tw93.aspx) on Windows, +has been removed. GLFW is written in C, not Pascal. Removing this macro means +there's one less thing for application programmers to remember, i.e. the +requirement to mark all callback functions with `GLFWCALL`. It also simplifies +the creation of DLLs and DLL link libraries, as there's no need to explicitly +disable `@n` entry point suffixes. + +@par Old syntax +@code +void GLFWCALL callback_function(...); +@endcode + +@par New syntax +@code +void callback_function(...); +@endcode + + +@subsection moving_window_handles Window handle parameters + +Because GLFW 3 supports multiple windows, window handle parameters have been +added to all window-related GLFW functions and callbacks. The handle of +a newly created window is returned by @ref glfwCreateWindow (formerly +`glfwOpenWindow`). Window handles are pointers to the +[opaque](https://en.wikipedia.org/wiki/Opaque_data_type) type @ref GLFWwindow. + +@par Old syntax +@code +glfwSetWindowTitle("New Window Title"); +@endcode + +@par New syntax +@code +glfwSetWindowTitle(window, "New Window Title"); +@endcode + + +@subsection moving_monitor Explicit monitor selection + +GLFW 3 provides support for multiple monitors. To request a full screen mode window, +instead of passing `GLFW_FULLSCREEN` you specify which monitor you wish the +window to use. The @ref glfwGetPrimaryMonitor function returns the monitor that +GLFW 2 would have selected, but there are many other +[monitor functions](@ref monitor_guide). Monitor handles are pointers to the +[opaque](https://en.wikipedia.org/wiki/Opaque_data_type) type @ref GLFWmonitor. + +@par Old basic full screen +@code +glfwOpenWindow(640, 480, 8, 8, 8, 0, 24, 0, GLFW_FULLSCREEN); +@endcode + +@par New basic full screen +@code +window = glfwCreateWindow(640, 480, "My Window", glfwGetPrimaryMonitor(), NULL); +@endcode + +@note The framebuffer bit depth parameters of `glfwOpenWindow` have been turned +into [window hints](@ref window_hints), but as they have been given +[sane defaults](@ref window_hints_values) you rarely need to set these hints. + + +@subsection moving_autopoll Removal of automatic event polling + +GLFW 3 does not automatically poll for events in @ref glfwSwapBuffers, meaning +you need to call @ref glfwPollEvents or @ref glfwWaitEvents yourself. Unlike +buffer swap, which acts on a single window, the event processing functions act +on all windows at once. + +@par Old basic main loop +@code +while (...) +{ + // Process input + // Render output + glfwSwapBuffers(); +} +@endcode + +@par New basic main loop +@code +while (...) +{ + // Process input + // Render output + glfwSwapBuffers(window); + glfwPollEvents(); +} +@endcode + + +@subsection moving_context Explicit context management + +Each GLFW 3 window has its own OpenGL context and only you, the application +programmer, can know which context should be current on which thread at any +given time. Therefore, GLFW 3 leaves that decision to you. + +This means that you need to call @ref glfwMakeContextCurrent after creating +a window before you can call any OpenGL functions. + + +@subsection moving_hidpi Separation of window and framebuffer sizes + +Window positions and sizes now use screen coordinates, which may not be the same +as pixels on machines with high-DPI monitors. This is important as OpenGL uses +pixels, not screen coordinates. For example, the rectangle specified with +`glViewport` needs to use pixels. Therefore, framebuffer size functions have +been added. You can retrieve the size of the framebuffer of a window with @ref +glfwGetFramebufferSize function. A framebuffer size callback has also been +added, which can be set with @ref glfwSetFramebufferSizeCallback. + +@par Old basic viewport setup +@code +glfwGetWindowSize(&width, &height); +glViewport(0, 0, width, height); +@endcode + +@par New basic viewport setup +@code +glfwGetFramebufferSize(window, &width, &height); +glViewport(0, 0, width, height); +@endcode + + +@subsection moving_window_close Window closing changes + +The `GLFW_OPENED` window parameter has been removed. As long as the window has +not been destroyed, whether through @ref glfwDestroyWindow or @ref +glfwTerminate, the window is "open". + +A user attempting to close a window is now just an event like any other. Unlike +GLFW 2, windows and contexts created with GLFW 3 will never be destroyed unless +you choose them to be. Each window now has a close flag that is set to +`GLFW_TRUE` when the user attempts to close that window. By default, nothing else +happens and the window stays visible. It is then up to you to either destroy +the window, take some other action or ignore the request. + +You can query the close flag at any time with @ref glfwWindowShouldClose and set +it at any time with @ref glfwSetWindowShouldClose. + +@par Old basic main loop +@code +while (glfwGetWindowParam(GLFW_OPENED)) +{ + ... +} +@endcode + +@par New basic main loop +@code +while (!glfwWindowShouldClose(window)) +{ + ... +} +@endcode + +The close callback no longer returns a value. Instead, it is called after the +close flag has been set so it can override its value, if it chooses to, before +event processing completes. You may however not call @ref glfwDestroyWindow +from the close callback (or any other window related callback). + +@par Old syntax +@code +int GLFWCALL window_close_callback(void); +@endcode + +@par New syntax +@code +void window_close_callback(GLFWwindow* window); +@endcode + +@note GLFW never clears the close flag to `GLFW_FALSE`, meaning you can use it +for other reasons to close the window as well, for example the user choosing +Quit from an in-game menu. + + +@subsection moving_hints Persistent window hints + +The `glfwOpenWindowHint` function has been renamed to @ref glfwWindowHint. + +Window hints are no longer reset to their default values on window creation, but +instead retain their values until modified by @ref glfwWindowHint or @ref +glfwDefaultWindowHints, or until the library is terminated and re-initialized. + + +@subsection moving_video_modes Video mode enumeration + +Video mode enumeration is now per-monitor. The @ref glfwGetVideoModes function +now returns all available modes for a specific monitor instead of requiring you +to guess how large an array you need. The `glfwGetDesktopMode` function, which +had poorly defined behavior, has been replaced by @ref glfwGetVideoMode, which +returns the current mode of a monitor. + + +@subsection moving_char_up Removal of character actions + +The action parameter of the [character callback](@ref GLFWcharfun) has been +removed. This was an artefact of the origin of GLFW, i.e. being developed in +English by a Swede. However, many keyboard layouts require more than one key to +produce characters with diacritical marks. Even the Swedish keyboard layout +requires this for uncommon cases like ü. + +@par Old syntax +@code +void GLFWCALL character_callback(int character, int action); +@endcode + +@par New syntax +@code +void character_callback(GLFWwindow* window, int character); +@endcode + + +@subsection moving_cursorpos Cursor position changes + +The `glfwGetMousePos` function has been renamed to @ref glfwGetCursorPos, +`glfwSetMousePos` to @ref glfwSetCursorPos and `glfwSetMousePosCallback` to @ref +glfwSetCursorPosCallback. + +The cursor position is now `double` instead of `int`, both for the direct +functions and for the callback. Some platforms can provide sub-pixel cursor +movement and this data is now passed on to the application where available. On +platforms where this is not provided, the decimal part is zero. + +GLFW 3 only allows you to position the cursor within a window using @ref +glfwSetCursorPos (formerly `glfwSetMousePos`) when that window is active. +Unless the window is active, the function fails silently. + + +@subsection moving_wheel Wheel position replaced by scroll offsets + +The `glfwGetMouseWheel` function has been removed. Scrolling is the input of +offsets and has no absolute position. The mouse wheel callback has been +replaced by a [scroll callback](@ref GLFWscrollfun) that receives +two-dimensional floating point scroll offsets. This allows you to receive +precise scroll data from for example modern touchpads. + +@par Old syntax +@code +void GLFWCALL mouse_wheel_callback(int position); +@endcode + +@par New syntax +@code +void scroll_callback(GLFWwindow* window, double xoffset, double yoffset); +@endcode + +@par Removed functions +`glfwGetMouseWheel` + + +@subsection moving_repeat Key repeat action + +The `GLFW_KEY_REPEAT` enable has been removed and key repeat is always enabled +for both keys and characters. A new key action, `GLFW_REPEAT`, has been added +to allow the [key callback](@ref GLFWkeyfun) to distinguish an initial key press +from a repeat. Note that @ref glfwGetKey still returns only `GLFW_PRESS` or +`GLFW_RELEASE`. + + +@subsection moving_keys Physical key input + +GLFW 3 key tokens map to physical keys, unlike in GLFW 2 where they mapped to +the values generated by the current keyboard layout. The tokens are named +according to the values they would have using the standard US layout, but this +is only a convenience, as most programmers are assumed to know that layout. +This means that (for example) `GLFW_KEY_LEFT_BRACKET` is always a single key and +is the same key in the same place regardless of what keyboard layouts the users +of your program has. + +The key input facility was never meant for text input, although using it that +way worked slightly better in GLFW 2. If you were using it to input text, you +should be using the character callback instead, on both GLFW 2 and 3. This will +give you the characters being input, as opposed to the keys being pressed. + +GLFW 3 has key tokens for all keys on a standard 105 key keyboard, so instead of +having to remember whether to check for `a` or `A`, you now check for +@ref GLFW_KEY_A. + + +@subsection moving_joystick Joystick function changes + +The `glfwGetJoystickPos` function has been renamed to @ref glfwGetJoystickAxes. + +The `glfwGetJoystickParam` function and the `GLFW_PRESENT`, `GLFW_AXES` and +`GLFW_BUTTONS` tokens have been replaced by the @ref glfwJoystickPresent +function as well as axis and button counts returned by the @ref +glfwGetJoystickAxes and @ref glfwGetJoystickButtons functions. + + +@subsection moving_mbcs Win32 MBCS support + +The Win32 port of GLFW 3 will not compile in +[MBCS mode](https://msdn.microsoft.com/en-us/library/5z097dxa.aspx). +However, because the use of the Unicode version of the Win32 API doesn't affect +the process as a whole, but only those windows created using it, it's perfectly +possible to call MBCS functions from other parts of the same application. +Therefore, even if an application using GLFW has MBCS mode code, there's no need +for GLFW itself to support it. + + +@subsection moving_windows Support for versions of Windows older than XP + +All explicit support for version of Windows older than XP has been removed. +There is no code that actively prevents GLFW 3 from running on these earlier +versions, but it uses Win32 functions that those versions lack. + +Windows XP was released in 2001, and by now (January 2015) it has not only +replaced almost all earlier versions of Windows, but is itself rapidly being +replaced by Windows 7 and 8. The MSDN library doesn't even provide +documentation for version older than Windows 2000, making it difficult to +maintain compatibility with these versions even if it was deemed worth the +effort. + +The Win32 API has also not stood still, and GLFW 3 uses many functions only +present on Windows XP or later. Even supporting an OS as new as XP (new +from the perspective of GLFW 2, which still supports Windows 95) requires +runtime checking for a number of functions that are present only on modern +version of Windows. + + +@subsection moving_syskeys Capture of system-wide hotkeys + +The ability to disable and capture system-wide hotkeys like Alt+Tab has been +removed. Modern applications, whether they're games, scientific visualisations +or something else, are nowadays expected to be good desktop citizens and allow +these hotkeys to function even when running in full screen mode. + + +@subsection moving_terminate Automatic termination + +GLFW 3 does not register @ref glfwTerminate with `atexit` at initialization, +because `exit` calls registered functions from the calling thread and while it +is permitted to call `exit` from any thread, @ref glfwTerminate must only be +called from the main thread. + +To release all resources allocated by GLFW, you should call @ref glfwTerminate +yourself, from the main thread, before the program terminates. Note that this +destroys all windows not already destroyed with @ref glfwDestroyWindow, +invalidating any window handles you may still have. + + +@subsection moving_glu GLU header inclusion + +GLFW 3 does not by default include the GLU header and GLU itself has been +deprecated by [Khronos](https://en.wikipedia.org/wiki/Khronos_Group). __New +projects should not use GLU__, but if you need it for legacy code that +has been moved to GLFW 3, you can request that the GLFW header includes it by +defining @ref GLFW_INCLUDE_GLU before the inclusion of the GLFW header. + +@par Old syntax +@code +#include +@endcode + +@par New syntax +@code +#define GLFW_INCLUDE_GLU +#include +@endcode + +There are many libraries that offer replacements for the functionality offered +by GLU. For the matrix helper functions, see math libraries like +[GLM](https://github.com/g-truc/glm) (for C++), +[linmath.h](https://github.com/datenwolf/linmath.h) (for C) and others. For the +tessellation functions, see for example +[libtess2](https://github.com/memononen/libtess2). + + +@section moving_tables Name change tables + + +@subsection moving_renamed_functions Renamed functions + +| GLFW 2 | GLFW 3 | Notes | +| --------------------------- | ----------------------------- | ----- | +| `glfwOpenWindow` | @ref glfwCreateWindow | All channel bit depths are now hints +| `glfwCloseWindow` | @ref glfwDestroyWindow | | +| `glfwOpenWindowHint` | @ref glfwWindowHint | Now accepts all `GLFW_*_BITS` tokens | +| `glfwEnable` | @ref glfwSetInputMode | | +| `glfwDisable` | @ref glfwSetInputMode | | +| `glfwGetMousePos` | @ref glfwGetCursorPos | | +| `glfwSetMousePos` | @ref glfwSetCursorPos | | +| `glfwSetMousePosCallback` | @ref glfwSetCursorPosCallback | | +| `glfwSetMouseWheelCallback` | @ref glfwSetScrollCallback | Accepts two-dimensional scroll offsets as doubles | +| `glfwGetJoystickPos` | @ref glfwGetJoystickAxes | | +| `glfwGetWindowParam` | @ref glfwGetWindowAttrib | | +| `glfwGetGLVersion` | @ref glfwGetWindowAttrib | Use `GLFW_CONTEXT_VERSION_MAJOR`, `GLFW_CONTEXT_VERSION_MINOR` and `GLFW_CONTEXT_REVISION` | +| `glfwGetDesktopMode` | @ref glfwGetVideoMode | Returns the current mode of a monitor | +| `glfwGetJoystickParam` | @ref glfwJoystickPresent | The axis and button counts are provided by @ref glfwGetJoystickAxes and @ref glfwGetJoystickButtons | + + +@subsection moving_renamed_types Renamed types + +| GLFW 2 | GLFW 3 | Notes | +| ------------------- | --------------------- | | +| `GLFWmousewheelfun` | @ref GLFWscrollfun | | +| `GLFWmouseposfun` | @ref GLFWcursorposfun | | + + +@subsection moving_renamed_tokens Renamed tokens + +| GLFW 2 | GLFW 3 | Notes | +| --------------------------- | ---------------------------- | ----- | +| `GLFW_OPENGL_VERSION_MAJOR` | `GLFW_CONTEXT_VERSION_MAJOR` | Renamed as it applies to OpenGL ES as well | +| `GLFW_OPENGL_VERSION_MINOR` | `GLFW_CONTEXT_VERSION_MINOR` | Renamed as it applies to OpenGL ES as well | +| `GLFW_FSAA_SAMPLES` | `GLFW_SAMPLES` | Renamed to match the OpenGL API | +| `GLFW_ACTIVE` | `GLFW_FOCUSED` | Renamed to match the window focus callback | +| `GLFW_WINDOW_NO_RESIZE` | `GLFW_RESIZABLE` | The default has been inverted | +| `GLFW_MOUSE_CURSOR` | `GLFW_CURSOR` | Used with @ref glfwSetInputMode | +| `GLFW_KEY_ESC` | `GLFW_KEY_ESCAPE` | | +| `GLFW_KEY_DEL` | `GLFW_KEY_DELETE` | | +| `GLFW_KEY_PAGEUP` | `GLFW_KEY_PAGE_UP` | | +| `GLFW_KEY_PAGEDOWN` | `GLFW_KEY_PAGE_DOWN` | | +| `GLFW_KEY_KP_NUM_LOCK` | `GLFW_KEY_NUM_LOCK` | | +| `GLFW_KEY_LCTRL` | `GLFW_KEY_LEFT_CONTROL` | | +| `GLFW_KEY_LSHIFT` | `GLFW_KEY_LEFT_SHIFT` | | +| `GLFW_KEY_LALT` | `GLFW_KEY_LEFT_ALT` | | +| `GLFW_KEY_LSUPER` | `GLFW_KEY_LEFT_SUPER` | | +| `GLFW_KEY_RCTRL` | `GLFW_KEY_RIGHT_CONTROL` | | +| `GLFW_KEY_RSHIFT` | `GLFW_KEY_RIGHT_SHIFT` | | +| `GLFW_KEY_RALT` | `GLFW_KEY_RIGHT_ALT` | | +| `GLFW_KEY_RSUPER` | `GLFW_KEY_RIGHT_SUPER` | | + +*/ diff --git a/deps/glfw-3.3.8/docs/news.dox b/deps/glfw-3.3.8/docs/news.dox new file mode 100644 index 0000000..1f016d3 --- /dev/null +++ b/deps/glfw-3.3.8/docs/news.dox @@ -0,0 +1,876 @@ +/*! + +@page news Release notes + +@tableofcontents + + +@section news_33 Release notes for version 3.3 + +These are the release notes for version 3.3. For a more detailed view including +all fixed bugs see the [version history](https://www.glfw.org/changelog.html). + +Please review the caveats, deprecations and removals if your project was written +against an earlier version of GLFW 3. + + +@subsection features_33 New features in version 3.3 + +@subsubsection gamepad_33 Gamepad input via SDL_GameControllerDB + +GLFW can now remap game controllers to a standard Xbox-like layout using +a built-in copy of SDL_GameControllerDB. Call @ref glfwJoystickIsGamepad to +check if a joystick has a mapping, @ref glfwGetGamepadState to retrieve its +input state, @ref glfwUpdateGamepadMappings to add newer mappings and @ref +glfwGetGamepadName and @ref glfwGetJoystickGUID for mapping related information. + +For more information see @ref gamepad. + + +@subsubsection moltenvk_33 Support for Vulkan on macOS via MoltenVK + +GLFW now supports [MoltenVK](https://moltengl.com/moltenvk/), a Vulkan +implementation on top of the Metal API, and its `VK_MVK_macos_surface` window +surface creation extension. MoltenVK is included in the [macOS Vulkan +SDK](https://vulkan.lunarg.com/). + +For more information see @ref vulkan_guide. + + +@subsubsection content_scale_33 Content scale queries for DPI-aware rendering + +GLFW now provides content scales for windows and monitors, i.e. the ratio +between their current DPI and the platform's default DPI, with @ref +glfwGetWindowContentScale and @ref glfwGetMonitorContentScale. + +Changes of the content scale of a window can be received with the window content +scale callback, set with @ref glfwSetWindowContentScaleCallback. + +The @ref GLFW_SCALE_TO_MONITOR window hint enables automatic resizing of a +window by the content scale of the monitor it is placed, on platforms like +Windows where this is necessary. This takes effect both on creation and when +the window is moved between monitors. It is related to but different from +[GLFW_COCOA_RETINA_FRAMEBUFFER](@ref GLFW_COCOA_RETINA_FRAMEBUFFER_hint). + +For more information see @ref window_scale. + + +@subsubsection setwindowattrib_33 Support for updating window attributes + +GLFW now supports changing the [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) attributes for existing +windows with @ref glfwSetWindowAttrib. + +For more information see @ref window_attribs. + + +@subsubsection raw_motion_33 Support for raw mouse motion + +GLFW now supports raw (unscaled and unaccelerated) mouse motion in disabled +cursor mode with the [GLFW_RAW_MOUSE_MOTION](@ref GLFW_RAW_MOUSE_MOTION) input +mode. Raw mouse motion input is not yet implemented on macOS. Call @ref +glfwRawMouseMotionSupported to check if GLFW can provide raw mouse motion on the +current system. + +For more information see @ref raw_mouse_motion. + + +@subsubsection joysticks_33 Joystick hats + +GLFW can now return the state of hats (i.e. POVs or D-pads) of a joystick with +@ref glfwGetJoystickHats. For compatibility, hats are also exposed as buttons. +This can be disabled with the @ref GLFW_JOYSTICK_HAT_BUTTONS initialization +hint. + +For more information see @ref joystick_hat. + + +@subsubsection geterror_33 Error query + +GLFW now supports querying the last error code for the calling thread and its +human-readable description with @ref glfwGetError. This can be used instead of +or together with the error callback. + +For more information see @ref error_handling. + + +@subsubsection init_hints_33 Support for initialization hints + +GLFW now supports setting library initialization hints with @ref glfwInitHint. +These must be set before initialization to take effect. Some of these hints are +platform specific but are safe to set on any platform. + +For more information see @ref init_hints. + + +@subsubsection attention_33 User attention request + +GLFW now supports requesting user attention with @ref +glfwRequestWindowAttention. Where possible this calls attention to the +specified window. On platforms like macOS it calls attention to the whole +application. + +For more information see @ref window_attention. + + +@subsubsection maximize_33 Window maximization callback + +GLFW now supports notifying the application that the window has been maximized +@ref glfwSetWindowMaximizeCallback. This is called both when the window was +maximized by the user and when it was done with @ref glfwMaximizeWindow. + +For more information see @ref window_maximize. + + +@subsubsection workarea_33 Query for the monitor work area + +GLFW now supports querying the work area of a monitor, i.e. the area not +occupied by task bars or global menu bars, with @ref glfwGetMonitorWorkarea. On +platforms that lack this concept, the whole area of the monitor is returned. + +For more information see @ref monitor_workarea. + + +@subsubsection transparency_33 Transparent windows and framebuffers + +GLFW now supports the creation of windows with transparent framebuffers on +systems with desktop compositing enabled with the @ref +GLFW_TRANSPARENT_FRAMEBUFFER window hint and attribute. This hint must be set +before window creation and leaves any window decorations opaque. + +GLFW now also supports whole window transparency with @ref glfwGetWindowOpacity +and @ref glfwSetWindowOpacity. This value controls the opacity of the whole +window including decorations and unlike framebuffer transparency can be changed +at any time after window creation. + +For more information see @ref window_transparency. + + +@subsubsection key_scancode_33 Query for the scancode of a key + +GLFW now supports querying the platform dependent scancode of any physical key +with @ref glfwGetKeyScancode. + +For more information see @ref input_key. + + +@subsubsection center_cursor_33 Cursor centering window hint + +GLFW now supports controlling whether the cursor is centered over newly created +full screen windows with the [GLFW_CENTER_CURSOR](@ref GLFW_CENTER_CURSOR_hint) +window hint. It is enabled by default. + + +@subsubsection cursor_hover_33 Mouse cursor hover window attribute + +GLFW now supports polling whether the cursor is hovering over the window content +area with the [GLFW_HOVERED](@ref GLFW_HOVERED_attrib) window attribute. This +attribute corresponds to the [cursor enter/leave](@ref cursor_enter) event. + + +@subsubsection focusonshow_33 Window hint and attribute for input focus on show + +GLFW now has the [GLFW_FOCUS_ON_SHOW](@ref GLFW_DECORATED_hint) window hint and +attribute for controlling whether a window gets input focus when shown. It is +enabled by default. It applies both when creating an visible window with @ref +glfwCreateWindow and when showing it with @ref glfwShowWindow. + +This is a workaround for GLFW 3.0 lacking @ref glfwFocusWindow and will be +corrected in the next major version. + +For more information see @ref window_hide. + + +@subsubsection device_userptr_33 Monitor and joystick user pointers + +GLFW now supports setting and querying user pointers for connected monitors and +joysticks with @ref glfwSetMonitorUserPointer, @ref glfwGetMonitorUserPointer, +@ref glfwSetJoystickUserPointer and @ref glfwGetJoystickUserPointer. + +For more information see @ref monitor_userptr and @ref joystick_userptr. + + +@subsubsection macos_nib_33 macOS menu bar from nib file + +GLFW will now load a `MainMenu.nib` file if found in the `Contents/Resources` +directory of the application bundle, as a way to replace the GLFW menu bar +without recompiling GLFW. This behavior can be disabled with the +[GLFW_COCOA_MENUBAR](@ref GLFW_COCOA_MENUBAR_hint) initialization hint. + + +@subsubsection glext_33 Support for more context creation extensions + +The context hint @ref GLFW_SRGB_CAPABLE now supports OpenGL ES via +`WGL_EXT_colorspace`, the context hint @ref GLFW_CONTEXT_NO_ERROR now supports +`WGL_ARB_create_context_no_error` and `GLX_ARB_create_context_no_error`, the +context hint @ref GLFW_CONTEXT_RELEASE_BEHAVIOR now supports +`EGL_KHR_context_flush_control` and @ref glfwGetProcAddress now supports +`EGL_KHR_get_all_proc_addresses`. + + +@subsubsection osmesa_33 OSMesa off-screen context creation support + +GLFW now supports creating off-screen OpenGL contexts using +[OSMesa](https://www.mesa3d.org/osmesa.html) by setting +[GLFW_CONTEXT_CREATION_API](@ref GLFW_CONTEXT_CREATION_API_hint) to +`GLFW_OSMESA_CONTEXT_API`. Native access function have been added to retrieve +the OSMesa color and depth buffers. + +There is also a new null backend that uses OSMesa as its native context +creation API, intended for automated testing. This backend does not provide +input. + + +@subsection caveats_33 Caveats for version 3.3 + +@subsubsection joystick_layout_33 Layout of joysticks have changed + +The way joystick elements are arranged have changed to match SDL2 in order to +support SDL_GameControllerDB mappings. The layout of joysticks may +change again if required for compatibility with SDL2. If you need a known and +stable layout for game controllers, see if you can switch to @ref gamepad. + +Existing code that depends on a specific joystick layout will likely have to be +updated. + + +@subsubsection wait_events_33 No window required to wait for events + +The @ref glfwWaitEvents and @ref glfwWaitEventsTimeout functions no longer need +a window to be created to wait for events. Before version 3.3 these functions +would return immediately if there were no user-created windows. On platforms +where only windows can receive events, an internal helper window is used. + +Existing code that depends on the earlier behavior will likely have to be +updated. + + +@subsubsection gamma_ramp_size_33 Gamma ramp size of 256 may be rejected + +The documentation for versions before 3.3 stated that a gamma ramp size of 256 +would always be accepted. This was never the case on X11 and could lead to +artifacts on macOS. The @ref glfwSetGamma function has been updated to always +generate a ramp of the correct size. + +Existing code that hardcodes a size of 256 should be updated to use the size of +the current ramp of a monitor when setting a new ramp for that monitor. + + +@subsubsection xinput_deadzone_33 Windows XInput deadzone removed + +GLFW no longer applies any deadzone to the input state received from the XInput +API. This was never done for any other platform joystick API so this change +makes the behavior more consistent but you will need to apply your own deadzone +if desired. + + +@subsubsection x11_clipboard_33 X11 clipboard transfer limits + +GLFW now supports reading clipboard text via the `INCR` method, which removes +the limit on how much text can be read with @ref glfwGetClipboardString. +However, writing via this method is not yet supported, so you may not be able to +write a very large string with @ref glfwSetClipboardString even if you read it +from the clipboard earlier. + +The exact size limit for writing to the clipboard is negotiated with each +receiving application but is at least several tens of kilobytes. Note that only +the read limit has changed. Any string that could be written before still can +be. + + +@subsubsection x11_linking_33 X11 extension libraries are loaded dynamically + +GLFW now loads all X11 extension libraries at initialization. The only X11 +library you need to link against is `libX11`. The header files for the +extension libraries are still required for compilation. + +Existing projects and makefiles that link GLFW directly against the extension +libraries should still build correctly but will add these libraries as load-time +dependencies. + + +@subsubsection cmake_version_33 CMake 3.0 or later is required + +The minimum CMake version has been raised from 2.8.12 to 3.0. This is only +a requirement of the GLFW CMake files. The GLFW source files do not depend on +CMake. + + +@subsubsection caveat_fbtransparency_33 Framebuffer transparency requires DWM transparency + +GLFW no longer supports framebuffer transparency enabled via @ref +GLFW_TRANSPARENT_FRAMEBUFFER on Windows 7 if DWM transparency is off +(the Transparency setting under Personalization > Window Color). + + +@subsubsection emptyevents_33 Empty events on X11 no longer roundtrip to server + +Starting with GLFW 3.3.7, events posted with @ref glfwPostEmptyEvent now use a separate +unnamed pipe instead of sending an X11 client event to the helper window. + + +@subsection deprecations_33 Deprecations in version 3.3 + +@subsubsection charmods_callback_33 Character with modifiers callback + +The character with modifiers callback set with @ref glfwSetCharModsCallback has +been deprecated and should if possible not be used. + +Existing code should still work but further bug fixes will likely not be made. +The callback will be removed in the next major version. + + +@subsubsection clipboard_window_33 Window parameter to clipboard functions + +The window parameter of the clipboard functions @ref glfwGetClipboardString and +@ref glfwSetClipboardString has been deprecated and is no longer used on any +platform. On platforms where the clipboard must be owned by a specific window, +an internal helper window is used. + +Existing code should still work unless it depends on a specific window owning +the clipboard. New code may pass `NULL` as the window argument. The parameter +will be removed in a future release. + + +@subsection removals_33 Removals in 3.3 + +@subsubsection macos_options_33 macOS specific CMake options and macros + +The `GLFW_USE_RETINA`, `GLFW_USE_CHDIR` and `GLFW_USE_MENUBAR` CMake options and +the `_GLFW_USE_RETINA`, `_GLFW_USE_CHDIR` and `_GLFW_USE_MENUBAR` compile-time +macros have been removed. + +These options and macros are replaced by the window hint +[GLFW_COCOA_RETINA_FRAMEBUFFER](@ref GLFW_COCOA_RETINA_FRAMEBUFFER_hint) +and the init hints +[GLFW_COCOA_CHDIR_RESOURCES](@ref GLFW_COCOA_CHDIR_RESOURCES_hint) and +[GLFW_COCOA_MENUBAR](@ref GLFW_COCOA_MENUBAR_hint). + +Existing projects and makefiles that set these options or define these macros +during compilation of GLFW will still build but it will have no effect and the +default behaviors will be used. + + +@subsubsection vulkan_sdk_33 LunarG Vulkan SDK dependency + +The GLFW test programs that previously depended on the LunarG Vulkan SDK now +instead uses a Vulkan loader generated by +[glad2](https://github.com/Dav1dde/glad). This means the GLFW CMake files no +longer look for the Vulkan SDK. + +Existing CMake projects that depended on the Vulkan SDK cache variables from +GLFW will need to call `find_package(Vulkan)` themselves. CMake 3.7 and later +already comes with a +[Vulkan find module](https://cmake.org/cmake/help/latest/module/FindVulkan.html) +similar to the one GLFW previously included. + + +@subsubsection lib_suffix_33 CMake option LIB_SUFFIX + +The `LIB_SUFFIX` CMake option has been removed. GLFW now uses the +GNUInstallDirs CMake package to handle platform specific details like the +library directory suffix and the `LIB_SUFFIX` CMake option has been removed. + +Existing projects and makefiles that set the `LIB_SUFFIX` option will use the +suffix chosen by the GNUInstallDirs package and the option will be ignored. + + +@subsubsection wl_shell_33 Support for the wl_shell protocol + +Support for the wl_shell protocol has been removed and GLFW now only supports +the XDG-Shell protocol. If your Wayland compositor does not support XDG-Shell +then GLFW will fail to initialize. + + +@subsubsection mir_removed_33 Mir support + +The experimental Mir support has been completely removed as the Mir project has +implemented support for the Wayland protocol and is recommending that +applications use that instead. + +Existing projects and makefiles that select Mir when compiling GLFW will fail. +Use Wayland or X11 instead. + + +@subsection symbols_33 New symbols in version 3.3 + +@subsubsection functions_33 New functions in version 3.3 + + - @ref glfwInitHint + - @ref glfwGetError + - @ref glfwGetMonitorWorkarea + - @ref glfwGetMonitorContentScale + - @ref glfwGetMonitorUserPointer + - @ref glfwSetMonitorUserPointer + - @ref glfwWindowHintString + - @ref glfwGetWindowContentScale + - @ref glfwGetWindowOpacity + - @ref glfwSetWindowOpacity + - @ref glfwRequestWindowAttention + - @ref glfwSetWindowAttrib + - @ref glfwSetWindowMaximizeCallback + - @ref glfwSetWindowContentScaleCallback + - @ref glfwRawMouseMotionSupported + - @ref glfwGetKeyScancode + - @ref glfwGetJoystickHats + - @ref glfwGetJoystickGUID + - @ref glfwGetJoystickUserPointer + - @ref glfwSetJoystickUserPointer + - @ref glfwJoystickIsGamepad + - @ref glfwUpdateGamepadMappings + - @ref glfwGetGamepadName + - @ref glfwGetGamepadState + + +@subsubsection types_33 New types in version 3.3 + + - @ref GLFWwindowmaximizefun + - @ref GLFWwindowcontentscalefun + - @ref GLFWgamepadstate + + +@subsubsection constants_33 New constants in version 3.3 + + - @ref GLFW_NO_ERROR + - @ref GLFW_JOYSTICK_HAT_BUTTONS + - @ref GLFW_COCOA_CHDIR_RESOURCES + - @ref GLFW_COCOA_MENUBAR + - @ref GLFW_CENTER_CURSOR + - @ref GLFW_TRANSPARENT_FRAMEBUFFER + - @ref GLFW_HOVERED + - @ref GLFW_FOCUS_ON_SHOW + - @ref GLFW_SCALE_TO_MONITOR + - @ref GLFW_COCOA_RETINA_FRAMEBUFFER + - @ref GLFW_COCOA_FRAME_NAME + - @ref GLFW_COCOA_GRAPHICS_SWITCHING + - @ref GLFW_X11_CLASS_NAME + - @ref GLFW_X11_INSTANCE_NAME + - @ref GLFW_OSMESA_CONTEXT_API + - @ref GLFW_HAT_CENTERED + - @ref GLFW_HAT_UP + - @ref GLFW_HAT_RIGHT + - @ref GLFW_HAT_DOWN + - @ref GLFW_HAT_LEFT + - @ref GLFW_HAT_RIGHT_UP + - @ref GLFW_HAT_RIGHT_DOWN + - @ref GLFW_HAT_LEFT_UP + - @ref GLFW_HAT_LEFT_DOWN + - @ref GLFW_MOD_CAPS_LOCK + - @ref GLFW_MOD_NUM_LOCK + - @ref GLFW_LOCK_KEY_MODS + - @ref GLFW_RAW_MOUSE_MOTION + - @ref GLFW_GAMEPAD_BUTTON_A + - @ref GLFW_GAMEPAD_BUTTON_B + - @ref GLFW_GAMEPAD_BUTTON_X + - @ref GLFW_GAMEPAD_BUTTON_Y + - @ref GLFW_GAMEPAD_BUTTON_LEFT_BUMPER + - @ref GLFW_GAMEPAD_BUTTON_RIGHT_BUMPER + - @ref GLFW_GAMEPAD_BUTTON_BACK + - @ref GLFW_GAMEPAD_BUTTON_START + - @ref GLFW_GAMEPAD_BUTTON_GUIDE + - @ref GLFW_GAMEPAD_BUTTON_LEFT_THUMB + - @ref GLFW_GAMEPAD_BUTTON_RIGHT_THUMB + - @ref GLFW_GAMEPAD_BUTTON_DPAD_UP + - @ref GLFW_GAMEPAD_BUTTON_DPAD_RIGHT + - @ref GLFW_GAMEPAD_BUTTON_DPAD_DOWN + - @ref GLFW_GAMEPAD_BUTTON_DPAD_LEFT + - @ref GLFW_GAMEPAD_BUTTON_LAST + - @ref GLFW_GAMEPAD_BUTTON_CROSS + - @ref GLFW_GAMEPAD_BUTTON_CIRCLE + - @ref GLFW_GAMEPAD_BUTTON_SQUARE + - @ref GLFW_GAMEPAD_BUTTON_TRIANGLE + - @ref GLFW_GAMEPAD_AXIS_LEFT_X + - @ref GLFW_GAMEPAD_AXIS_LEFT_Y + - @ref GLFW_GAMEPAD_AXIS_RIGHT_X + - @ref GLFW_GAMEPAD_AXIS_RIGHT_Y + - @ref GLFW_GAMEPAD_AXIS_LEFT_TRIGGER + - @ref GLFW_GAMEPAD_AXIS_RIGHT_TRIGGER + - @ref GLFW_GAMEPAD_AXIS_LAST + + +@section news_32 Release notes for 3.2 + +These are the release notes for version 3.2. For a more detailed view including +all fixed bugs see the [version history](https://www.glfw.org/changelog.html). + + +@subsection features_32 New features in version 3.2 + +@subsubsection news_32_vulkan Support for Vulkan + +GLFW now supports basic integration with Vulkan with @ref glfwVulkanSupported, +@ref glfwGetRequiredInstanceExtensions, @ref glfwGetInstanceProcAddress, @ref +glfwGetPhysicalDevicePresentationSupport and @ref glfwCreateWindowSurface. +Vulkan header inclusion can be selected with +@ref GLFW_INCLUDE_VULKAN. + + +@subsubsection news_32_setwindowmonitor Window mode switching + +GLFW now supports switching between windowed and full screen modes and updating +the monitor and desired resolution and refresh rate of full screen windows with +@ref glfwSetWindowMonitor. + + +@subsubsection news_32_maximize Window maxmimization support + +GLFW now supports window maximization with @ref glfwMaximizeWindow and the +@ref GLFW_MAXIMIZED window hint and attribute. + + +@subsubsection news_32_focus Window input focus control + +GLFW now supports giving windows input focus with @ref glfwFocusWindow. + + +@subsubsection news_32_sizelimits Window size limit support + +GLFW now supports setting both absolute and relative window size limits with +@ref glfwSetWindowSizeLimits and @ref glfwSetWindowAspectRatio. + + +@subsubsection news_32_keyname Localized key names + +GLFW now supports querying the localized name of printable keys with @ref +glfwGetKeyName, either by key token or by scancode. + + +@subsubsection news_32_waittimeout Wait for events with timeout + +GLFW now supports waiting for events for a set amount of time with @ref +glfwWaitEventsTimeout. + + +@subsubsection news_32_icon Window icon support + +GLFW now supports setting the icon of windows with @ref glfwSetWindowIcon. + + +@subsubsection news_32_timer Raw timer access + +GLFW now supports raw timer values with @ref glfwGetTimerValue and @ref +glfwGetTimerFrequency. + + +@subsubsection news_32_joystick Joystick connection callback + +GLFW now supports notifying when a joystick has been connected or disconnected +with @ref glfwSetJoystickCallback. + + +@subsubsection news_32_noapi Context-less windows + +GLFW now supports creating windows without a OpenGL or OpenGL ES context by +setting the [GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) hint to `GLFW_NO_API`. + + +@subsubsection news_32_contextapi Run-time context creation API selection + +GLFW now supports selecting and querying the context creation API at run-time +with the @ref GLFW_CONTEXT_CREATION_API hint and attribute. + + +@subsubsection news_32_noerror Error-free context creation + +GLFW now supports creating and querying OpenGL and OpenGL ES contexts that do +not emit errors with the @ref GLFW_CONTEXT_NO_ERROR hint, provided the machine +supports the `GL_KHR_no_error` extension. + + +@subsubsection news_32_cmake CMake config-file package support + +GLFW now supports being used as a +[config-file package](@ref build_link_cmake_package) from other projects for +easy linking with the library and its dependencies. + + +@section news_31 Release notes for 3.1 + +These are the release notes for version 3.1. For a more detailed view including +all fixed bugs see the [version history](https://www.glfw.org/changelog.html). + + +@subsection features_31 New features in version 3.1 + +@subsubsection news_31_cursor Custom mouse cursor images + +GLFW now supports creating and setting both custom cursor images and standard +cursor shapes. They are created with @ref glfwCreateCursor or @ref +glfwCreateStandardCursor, set with @ref glfwSetCursor and destroyed with @ref +glfwDestroyCursor. + +@see @ref cursor_object + + +@subsubsection news_31_drop Path drop event + +GLFW now provides a callback for receiving the paths of files and directories +dropped onto GLFW windows. The callback is set with @ref glfwSetDropCallback. + +@see @ref path_drop + + +@subsubsection news_31_emptyevent Main thread wake-up + +GLFW now provides the @ref glfwPostEmptyEvent function for posting an empty +event from another thread to the main thread event queue, causing @ref +glfwWaitEvents to return. + +@see @ref events + + +@subsubsection news_31_framesize Window frame size query + +GLFW now supports querying the size, on each side, of the frame around the +content area of a window, with @ref glfwGetWindowFrameSize. + +@see [Window size](@ref window_size) + + +@subsubsection news_31_autoiconify Simultaneous multi-monitor rendering + +GLFW now supports disabling auto-iconification of full screen windows with +the [GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_hint) window hint. This is +intended for people building multi-monitor installations, where you need windows +to stay in full screen despite losing input focus. + + +@subsubsection news_31_floating Floating windows + +GLFW now supports floating windows, also called topmost or always on top, for +easier debugging with the @ref GLFW_FLOATING window hint and attribute. + + +@subsubsection news_31_focused Initially unfocused windows + +GLFW now supports preventing a windowed mode window from gaining input focus on +creation, with the [GLFW_FOCUSED](@ref GLFW_FOCUSED_hint) window hint. + + +@subsubsection news_31_direct Direct access for window attributes and cursor position + +GLFW now queries the window input focus, visibility and iconification attributes +and the cursor position directly instead of returning cached data. + + +@subsubsection news_31_charmods Character with modifiers callback + +GLFW now provides a callback for character events with modifier key bits. The +callback is set with @ref glfwSetCharModsCallback. Unlike the regular character +callback, this will report character events that will not result in a character +being input, for example if the Control key is held down. + +@see @ref input_char + + +@subsubsection news_31_single Single buffered framebuffers + +GLFW now supports the creation of single buffered windows, with the @ref +GLFW_DOUBLEBUFFER hint. + + +@subsubsection news_31_glext Macro for including extension header + +GLFW now includes the extension header appropriate for the chosen OpenGL or +OpenGL ES header when @ref GLFW_INCLUDE_GLEXT is defined. GLFW does not provide +these headers. They must be provided by your development environment or your +OpenGL or OpenGL ES SDK. + + +@subsubsection news_31_release Context release behaviors + +GLFW now supports controlling and querying whether the pipeline is flushed when +a context is made non-current, with the @ref GLFW_CONTEXT_RELEASE_BEHAVIOR hint +and attribute, provided the machine supports the `GL_KHR_context_flush_control` +extension. + + +@subsubsection news_31_wayland (Experimental) Wayland support + +GLFW now has an _experimental_ Wayland display protocol backend that can be +selected on Linux with a CMake option. + + +@subsubsection news_31_mir (Experimental) Mir support + +GLFW now has an _experimental_ Mir display server backend that can be selected +on Linux with a CMake option. + + +@section news_30 Release notes for 3.0 + +These are the release notes for version 3.0. For a more detailed view including +all fixed bugs see the [version history](https://www.glfw.org/changelog.html). + + +@subsection features_30 New features in version 3.0 + +@subsubsection news_30_cmake CMake build system + +GLFW now uses the CMake build system instead of the various makefiles and +project files used by earlier versions. CMake is available for all platforms +supported by GLFW, is present in most package systems and can generate +makefiles and/or project files for most popular development environments. + +For more information on how to use CMake, see the +[CMake manual](https://cmake.org/cmake/help/documentation.html). + + +@subsubsection news_30_multiwnd Multi-window support + +GLFW now supports the creation of multiple windows, each with their own OpenGL +or OpenGL ES context, and all window functions now take a window handle. Event +callbacks are now per-window and are provided with the handle of the window that +received the event. The @ref glfwMakeContextCurrent function has been added to +select which context is current on a given thread. + + +@subsubsection news_30_multimon Multi-monitor support + +GLFW now explicitly supports multiple monitors. They can be enumerated with +@ref glfwGetMonitors, queried with @ref glfwGetVideoModes, @ref +glfwGetMonitorPos, @ref glfwGetMonitorName and @ref glfwGetMonitorPhysicalSize, +and specified at window creation to make the newly created window full screen on +that specific monitor. + + +@subsubsection news_30_unicode Unicode support + +All string arguments to GLFW functions and all strings returned by GLFW now use +the UTF-8 encoding. This includes the window title, error string, clipboard +text, monitor and joystick names as well as the extension function arguments (as +ASCII is a subset of UTF-8). + + +@subsubsection news_30_clipboard Clipboard text I/O + +GLFW now supports reading and writing plain text to and from the system +clipboard, with the @ref glfwGetClipboardString and @ref glfwSetClipboardString +functions. + + +@subsubsection news_30_gamma Gamma ramp support + +GLFW now supports setting and reading back the gamma ramp of monitors, with the +@ref glfwGetGammaRamp and @ref glfwSetGammaRamp functions. There is also @ref +glfwSetGamma, which generates a ramp from a gamma value and then sets it. + + +@subsubsection news_30_gles OpenGL ES support + +GLFW now supports the creation of OpenGL ES contexts, by setting the +[GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) hint to `GLFW_OPENGL_ES_API`, where +creation of such contexts are supported. Note that GLFW _does not implement_ +OpenGL ES, so your driver must provide support in a way usable by GLFW. Modern +Nvidia and Intel drivers support creation of OpenGL ES context using the GLX and +WGL APIs, while AMD provides an EGL implementation instead. + + +@subsubsection news_30_egl (Experimental) EGL support + +GLFW now has an experimental EGL context creation back end that can be selected +through CMake options. + + +@subsubsection news_30_hidpi High-DPI support + +GLFW now supports high-DPI monitors on both Windows and macOS, giving windows +full resolution framebuffers where other UI elements are scaled up. To achieve +this, @ref glfwGetFramebufferSize and @ref glfwSetFramebufferSizeCallback have +been added. These work with pixels, while the rest of the GLFW API works with +screen coordinates. This is important as OpenGL uses pixels, not screen +coordinates. + + +@subsubsection news_30_error Error callback + +GLFW now has an error callback, which can provide your application with much +more detailed diagnostics than was previously possible. The callback is passed +an error code and a description string. + + +@subsubsection news_30_wndptr Per-window user pointer + +Each window now has a user-defined pointer, retrieved with @ref +glfwGetWindowUserPointer and set with @ref glfwSetWindowUserPointer, to make it +easier to integrate GLFW into C++ code. + + +@subsubsection news_30_iconifyfun Window iconification callback + +Each window now has a callback for iconification and restoration events, +which is set with @ref glfwSetWindowIconifyCallback. + + +@subsubsection news_30_wndposfun Window position callback + +Each window now has a callback for position events, which is set with @ref +glfwSetWindowPosCallback. + + +@subsubsection news_30_wndpos Window position query + +The position of a window can now be retrieved using @ref glfwGetWindowPos. + + +@subsubsection news_30_focusfun Window focus callback + +Each windows now has a callback for focus events, which is set with @ref +glfwSetWindowFocusCallback. + + +@subsubsection news_30_enterleave Cursor enter/leave callback + +Each window now has a callback for when the mouse cursor enters or leaves its +content area, which is set with @ref glfwSetCursorEnterCallback. + + +@subsubsection news_30_wndtitle Initial window title + +The title of a window is now specified at creation time, as one of the arguments +to @ref glfwCreateWindow. + + +@subsubsection news_30_hidden Hidden windows + +Windows can now be hidden with @ref glfwHideWindow, shown using @ref +glfwShowWindow and created initially hidden with the @ref GLFW_VISIBLE window +hint and attribute. This allows for off-screen rendering in a way compatible +with most drivers, as well as moving a window to a specific position before +showing it. + + +@subsubsection news_30_undecorated Undecorated windows + +Windowed mode windows can now be created without decorations, e.g. things like +a frame, a title bar, with the @ref GLFW_DECORATED window hint and attribute. +This allows for the creation of things like splash screens. + + +@subsubsection news_30_keymods Modifier key bit masks + +[Modifier key bit mask](@ref mods) parameters have been added to the +[mouse button](@ref GLFWmousebuttonfun) and [key](@ref GLFWkeyfun) callbacks. + + +@subsubsection news_30_scancode Platform-specific scancodes + +A scancode parameter has been added to the [key callback](@ref GLFWkeyfun). Keys +that don't have a [key token](@ref keys) still get passed on with the key +parameter set to `GLFW_KEY_UNKNOWN`. These scancodes will vary between machines +and are intended to be used for key bindings. + + +@subsubsection news_30_jsname Joystick names + +The name of a joystick can now be retrieved using @ref glfwGetJoystickName. + + +@subsubsection news_30_doxygen Doxygen documentation + +You are reading it. + +*/ diff --git a/deps/glfw-3.3.8/docs/quick.dox b/deps/glfw-3.3.8/docs/quick.dox new file mode 100644 index 0000000..3645fc0 --- /dev/null +++ b/deps/glfw-3.3.8/docs/quick.dox @@ -0,0 +1,365 @@ +/*! + +@page quick_guide Getting started + +@tableofcontents + +This guide takes you through writing a simple application using GLFW 3. The +application will create a window and OpenGL context, render a rotating triangle +and exit when the user closes the window or presses _Escape_. This guide will +introduce a few of the most commonly used functions, but there are many more. + +This guide assumes no experience with earlier versions of GLFW. If you +have used GLFW 2 in the past, read @ref moving_guide, as some functions +behave differently in GLFW 3. + + +@section quick_steps Step by step + +@subsection quick_include Including the GLFW header + +In the source files of your application where you use GLFW, you need to include +its header file. + +@code +#include +@endcode + +This header provides all the constants, types and function prototypes of the +GLFW API. + +By default it also includes the OpenGL header from your development environment. +On some platforms this header only supports older versions of OpenGL. The most +extreme case is Windows, where it typically only supports OpenGL 1.2. + +Most programs will instead use an +[extension loader library](@ref context_glext_auto) and include its header. +This example uses files generated by [glad](https://gen.glad.sh/). The GLFW +header can detect most such headers if they are included first and will then not +include the one from your development environment. + +@code +#include +#include +@endcode + +To make sure there will be no header conflicts, you can define @ref +GLFW_INCLUDE_NONE before the GLFW header to explicitly disable inclusion of the +development environment header. This also allows the two headers to be included +in any order. + +@code +#define GLFW_INCLUDE_NONE +#include +#include +@endcode + + +@subsection quick_init_term Initializing and terminating GLFW + +Before you can use most GLFW functions, the library must be initialized. On +successful initialization, `GLFW_TRUE` is returned. If an error occurred, +`GLFW_FALSE` is returned. + +@code +if (!glfwInit()) +{ + // Initialization failed +} +@endcode + +Note that `GLFW_TRUE` and `GLFW_FALSE` are and will always be one and zero. + +When you are done using GLFW, typically just before the application exits, you +need to terminate GLFW. + +@code +glfwTerminate(); +@endcode + +This destroys any remaining windows and releases any other resources allocated by +GLFW. After this call, you must initialize GLFW again before using any GLFW +functions that require it. + + +@subsection quick_capture_error Setting an error callback + +Most events are reported through callbacks, whether it's a key being pressed, +a GLFW window being moved, or an error occurring. Callbacks are C functions (or +C++ static methods) that are called by GLFW with arguments describing the event. + +In case a GLFW function fails, an error is reported to the GLFW error callback. +You can receive these reports with an error callback. This function must have +the signature below but may do anything permitted in other callbacks. + +@code +void error_callback(int error, const char* description) +{ + fprintf(stderr, "Error: %s\n", description); +} +@endcode + +Callback functions must be set, so GLFW knows to call them. The function to set +the error callback is one of the few GLFW functions that may be called before +initialization, which lets you be notified of errors both during and after +initialization. + +@code +glfwSetErrorCallback(error_callback); +@endcode + + +@subsection quick_create_window Creating a window and context + +The window and its OpenGL context are created with a single call to @ref +glfwCreateWindow, which returns a handle to the created combined window and +context object + +@code +GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL); +if (!window) +{ + // Window or OpenGL context creation failed +} +@endcode + +This creates a 640 by 480 windowed mode window with an OpenGL context. If +window or OpenGL context creation fails, `NULL` will be returned. You should +always check the return value. While window creation rarely fails, context +creation depends on properly installed drivers and may fail even on machines +with the necessary hardware. + +By default, the OpenGL context GLFW creates may have any version. You can +require a minimum OpenGL version by setting the `GLFW_CONTEXT_VERSION_MAJOR` and +`GLFW_CONTEXT_VERSION_MINOR` hints _before_ creation. If the required minimum +version is not supported on the machine, context (and window) creation fails. + +@code +glfwWindowHint(GLFW_CONTEXT_VERSION_MAJOR, 2); +glfwWindowHint(GLFW_CONTEXT_VERSION_MINOR, 0); +GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL); +if (!window) +{ + // Window or context creation failed +} +@endcode + +The window handle is passed to all window related functions and is provided to +along to all window related callbacks, so they can tell which window received +the event. + +When a window and context is no longer needed, destroy it. + +@code +glfwDestroyWindow(window); +@endcode + +Once this function is called, no more events will be delivered for that window +and its handle becomes invalid. + + +@subsection quick_context_current Making the OpenGL context current + +Before you can use the OpenGL API, you must have a current OpenGL context. + +@code +glfwMakeContextCurrent(window); +@endcode + +The context will remain current until you make another context current or until +the window owning the current context is destroyed. + +If you are using an [extension loader library](@ref context_glext_auto) to +access modern OpenGL then this is when to initialize it, as the loader needs +a current context to load from. This example uses +[glad](https://github.com/Dav1dde/glad), but the same rule applies to all such +libraries. + +@code +gladLoadGL(glfwGetProcAddress); +@endcode + + +@subsection quick_window_close Checking the window close flag + +Each window has a flag indicating whether the window should be closed. + +When the user attempts to close the window, either by pressing the close widget +in the title bar or using a key combination like Alt+F4, this flag is set to 1. +Note that __the window isn't actually closed__, so you are expected to monitor +this flag and either destroy the window or give some kind of feedback to the +user. + +@code +while (!glfwWindowShouldClose(window)) +{ + // Keep running +} +@endcode + +You can be notified when the user is attempting to close the window by setting +a close callback with @ref glfwSetWindowCloseCallback. The callback will be +called immediately after the close flag has been set. + +You can also set it yourself with @ref glfwSetWindowShouldClose. This can be +useful if you want to interpret other kinds of input as closing the window, like +for example pressing the _Escape_ key. + + +@subsection quick_key_input Receiving input events + +Each window has a large number of callbacks that can be set to receive all the +various kinds of events. To receive key press and release events, create a key +callback function. + +@code +static void key_callback(GLFWwindow* window, int key, int scancode, int action, int mods) +{ + if (key == GLFW_KEY_ESCAPE && action == GLFW_PRESS) + glfwSetWindowShouldClose(window, GLFW_TRUE); +} +@endcode + +The key callback, like other window related callbacks, are set per-window. + +@code +glfwSetKeyCallback(window, key_callback); +@endcode + +In order for event callbacks to be called when events occur, you need to process +events as described below. + + +@subsection quick_render Rendering with OpenGL + +Once you have a current OpenGL context, you can use OpenGL normally. In this +tutorial, a multi-colored rotating triangle will be rendered. The framebuffer +size needs to be retrieved for `glViewport`. + +@code +int width, height; +glfwGetFramebufferSize(window, &width, &height); +glViewport(0, 0, width, height); +@endcode + +You can also set a framebuffer size callback using @ref +glfwSetFramebufferSizeCallback and be notified when the size changes. + +The details of how to render with OpenGL is outside the scope of this tutorial, +but there are many excellent resources for learning modern OpenGL. Here are +a few of them: + + - [Anton's OpenGL 4 Tutorials](https://antongerdelan.net/opengl/) + - [Learn OpenGL](https://learnopengl.com/) + - [Open.GL](https://open.gl/) + +These all happen to use GLFW, but OpenGL itself works the same whatever API you +use to create the window and context. + + +@subsection quick_timer Reading the timer + +To create smooth animation, a time source is needed. GLFW provides a timer that +returns the number of seconds since initialization. The time source used is the +most accurate on each platform and generally has micro- or nanosecond +resolution. + +@code +double time = glfwGetTime(); +@endcode + + +@subsection quick_swap_buffers Swapping buffers + +GLFW windows by default use double buffering. That means that each window has +two rendering buffers; a front buffer and a back buffer. The front buffer is +the one being displayed and the back buffer the one you render to. + +When the entire frame has been rendered, the buffers need to be swapped with one +another, so the back buffer becomes the front buffer and vice versa. + +@code +glfwSwapBuffers(window); +@endcode + +The swap interval indicates how many frames to wait until swapping the buffers, +commonly known as _vsync_. By default, the swap interval is zero, meaning +buffer swapping will occur immediately. On fast machines, many of those frames +will never be seen, as the screen is still only updated typically 60-75 times +per second, so this wastes a lot of CPU and GPU cycles. + +Also, because the buffers will be swapped in the middle the screen update, +leading to [screen tearing](https://en.wikipedia.org/wiki/Screen_tearing). + +For these reasons, applications will typically want to set the swap interval to +one. It can be set to higher values, but this is usually not recommended, +because of the input latency it leads to. + +@code +glfwSwapInterval(1); +@endcode + +This function acts on the current context and will fail unless a context is +current. + + +@subsection quick_process_events Processing events + +GLFW needs to communicate regularly with the window system both in order to +receive events and to show that the application hasn't locked up. Event +processing must be done regularly while you have visible windows and is normally +done each frame after buffer swapping. + +There are two methods for processing pending events; polling and waiting. This +example will use event polling, which processes only those events that have +already been received and then returns immediately. + +@code +glfwPollEvents(); +@endcode + +This is the best choice when rendering continually, like most games do. If +instead you only need to update your rendering once you have received new input, +@ref glfwWaitEvents is a better choice. It waits until at least one event has +been received, putting the thread to sleep in the meantime, and then processes +all received events. This saves a great deal of CPU cycles and is useful for, +for example, many kinds of editing tools. + + +@section quick_example Putting it together + +Now that you know how to initialize GLFW, create a window and poll for +keyboard input, it's possible to create a simple program. + +This program creates a 640 by 480 windowed mode window and starts a loop that +clears the screen, renders a triangle and processes events until the user either +presses _Escape_ or closes the window. + +@snippet simple.c code + +The program above can be found in the +[source package](https://www.glfw.org/download.html) as `examples/simple.c` +and is compiled along with all other examples when you build GLFW. If you +built GLFW from the source package then you already have this as `simple.exe` on +Windows, `simple` on Linux or `simple.app` on macOS. + +This tutorial used only a few of the many functions GLFW provides. There are +guides for each of the areas covered by GLFW. Each guide will introduce all the +functions for that category. + + - @ref intro_guide + - @ref window_guide + - @ref context_guide + - @ref monitor_guide + - @ref input_guide + +You can access reference documentation for any GLFW function by clicking it and +the reference for each function links to related functions and guide sections. + +The tutorial ends here. Once you have written a program that uses GLFW, you +will need to compile and link it. How to do that depends on the development +environment you are using and is best explained by the documentation for that +environment. To learn about the details that are specific to GLFW, see +@ref build_guide. + +*/ diff --git a/deps/glfw-3.3.8/docs/spaces.svg b/deps/glfw-3.3.8/docs/spaces.svg new file mode 100644 index 0000000..5b32646 --- /dev/null +++ b/deps/glfw-3.3.8/docs/spaces.svg @@ -0,0 +1,877 @@ + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +   + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/deps/glfw-3.3.8/docs/vulkan.dox b/deps/glfw-3.3.8/docs/vulkan.dox new file mode 100644 index 0000000..f34366f --- /dev/null +++ b/deps/glfw-3.3.8/docs/vulkan.dox @@ -0,0 +1,242 @@ +/*! + +@page vulkan_guide Vulkan guide + +@tableofcontents + +This guide is intended to fill the gaps between the official [Vulkan +resources](https://www.khronos.org/vulkan/) and the rest of the GLFW +documentation and is not a replacement for either. It assumes some familiarity +with Vulkan concepts like loaders, devices, queues and surfaces and leaves it to +the Vulkan documentation to explain the details of Vulkan functions. + +To develop for Vulkan you should download the [LunarG Vulkan +SDK](https://vulkan.lunarg.com/) for your platform. Apart from headers and link +libraries, they also provide the validation layers necessary for development. + +The [Vulkan Tutorial](https://vulkan-tutorial.com/) has more information on how +to use GLFW and Vulkan. The [Khronos Vulkan +Samples](https://github.com/KhronosGroup/Vulkan-Samples) also use GLFW, although +with a small framework in between. + +For details on a specific Vulkan support function, see the @ref vulkan. There +are also guides for the other areas of the GLFW API. + + - @ref intro_guide + - @ref window_guide + - @ref context_guide + - @ref monitor_guide + - @ref input_guide + + +@section vulkan_loader Linking against the Vulkan loader + +By default, GLFW will look for the Vulkan loader on demand at runtime via its +standard name (`vulkan-1.dll` on Windows, `libvulkan.so.1` on Linux and other +Unix-like systems and `libvulkan.1.dylib` on macOS). This means that GLFW does +not need to be linked against the loader. However, it also means that if you +are using the static library form of the Vulkan loader GLFW will either fail to +find it or (worse) use the wrong one. + +The @ref GLFW_VULKAN_STATIC CMake option makes GLFW call the Vulkan loader +directly instead of dynamically loading it at runtime. Not linking against the +Vulkan loader will then be a compile-time error. + +@macos To make your application be redistributable you will need to set up the +application bundle according to the LunarG SDK documentation. This is explained +in more detail in the +[SDK documentation for macOS](https://vulkan.lunarg.com/doc/sdk/latest/mac/getting_started.html). + + +@section vulkan_include Including the Vulkan and GLFW header files + +To include the Vulkan header, define @ref GLFW_INCLUDE_VULKAN before including +the GLFW header. + +@code +#define GLFW_INCLUDE_VULKAN +#include +@endcode + +If you instead want to include the Vulkan header from a custom location or use +your own custom Vulkan header then do this before the GLFW header. + +@code +#include +#include +@endcode + +Unless a Vulkan header is included, either by the GLFW header or above it, any +GLFW functions that take or return Vulkan types will not be declared. + +The `VK_USE_PLATFORM_*_KHR` macros do not need to be defined for the Vulkan part +of GLFW to work. Define them only if you are using these extensions directly. + + +@section vulkan_support Querying for Vulkan support + +If you are linking directly against the Vulkan loader then you can skip this +section. The canonical desktop loader library exports all Vulkan core and +Khronos extension functions, allowing them to be called directly. + +If you are loading the Vulkan loader dynamically instead of linking directly +against it, you can check for the availability of a loader and ICD with @ref +glfwVulkanSupported. + +@code +if (glfwVulkanSupported()) +{ + // Vulkan is available, at least for compute +} +@endcode + +This function returns `GLFW_TRUE` if the Vulkan loader and any minimally +functional ICD was found. + +If one or both were not found, calling any other Vulkan related GLFW function +will generate a @ref GLFW_API_UNAVAILABLE error. + + +@subsection vulkan_proc Querying Vulkan function pointers + +To load any Vulkan core or extension function from the found loader, call @ref +glfwGetInstanceProcAddress. To load functions needed for instance creation, +pass `NULL` as the instance. + +@code +PFN_vkCreateInstance pfnCreateInstance = (PFN_vkCreateInstance) + glfwGetInstanceProcAddress(NULL, "vkCreateInstance"); +@endcode + +Once you have created an instance, you can load from it all other Vulkan core +functions and functions from any instance extensions you enabled. + +@code +PFN_vkCreateDevice pfnCreateDevice = (PFN_vkCreateDevice) + glfwGetInstanceProcAddress(instance, "vkCreateDevice"); +@endcode + +This function in turn calls `vkGetInstanceProcAddr`. If that fails, the +function falls back to a platform-specific query of the Vulkan loader (i.e. +`dlsym` or `GetProcAddress`). If that also fails, the function returns `NULL`. +For more information about `vkGetInstanceProcAddr`, see the Vulkan +documentation. + +Vulkan also provides `vkGetDeviceProcAddr` for loading device-specific versions +of Vulkan function. This function can be retrieved from an instance with @ref +glfwGetInstanceProcAddress. + +@code +PFN_vkGetDeviceProcAddr pfnGetDeviceProcAddr = (PFN_vkGetDeviceProcAddr) + glfwGetInstanceProcAddress(instance, "vkGetDeviceProcAddr"); +@endcode + +Device-specific functions may execute a little bit faster, due to not having to +dispatch internally based on the device passed to them. For more information +about `vkGetDeviceProcAddr`, see the Vulkan documentation. + + +@section vulkan_ext Querying required Vulkan extensions + +To do anything useful with Vulkan you need to create an instance. If you want +to use Vulkan to render to a window, you must enable the instance extensions +GLFW requires to create Vulkan surfaces. + +To query the instance extensions required, call @ref +glfwGetRequiredInstanceExtensions. + +@code +uint32_t count; +const char** extensions = glfwGetRequiredInstanceExtensions(&count); +@endcode + +These extensions must all be enabled when creating instances that are going to +be passed to @ref glfwGetPhysicalDevicePresentationSupport and @ref +glfwCreateWindowSurface. The set of extensions will vary depending on platform +and may also vary depending on graphics drivers and other factors. + +If it fails it will return `NULL` and GLFW will not be able to create Vulkan +window surfaces. You can still use Vulkan for off-screen rendering and compute +work. + +If successful the returned array will always include `VK_KHR_surface`, so if +you don't require any additional extensions you can pass this list directly to +the `VkInstanceCreateInfo` struct. + +@code +VkInstanceCreateInfo ici; + +memset(&ici, 0, sizeof(ici)); +ici.enabledExtensionCount = count; +ici.ppEnabledExtensionNames = extensions; +... +@endcode + +Additional extensions may be required by future versions of GLFW. You should +check whether 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. + +@macos MoltenVK is (as of July 2022) not yet a fully conformant implementation +of Vulkan. As of Vulkan SDK 1.3.216.0, this means you must also enable the +`VK_KHR_portability_enumeration` instance extension and set the +`VK_INSTANCE_CREATE_ENUMERATE_PORTABILITY_BIT_KHR` bit in the instance creation +info flags for MoltenVK to show up in the list of physical devices. For more +information, see the Vulkan and MoltenVK documentation. + + +@section vulkan_present Querying for Vulkan presentation support + +Not every queue family of every Vulkan device can present images to surfaces. +To check whether a specific queue family of a physical device supports image +presentation without first having to create a window and surface, call @ref +glfwGetPhysicalDevicePresentationSupport. + +@code +if (glfwGetPhysicalDevicePresentationSupport(instance, physical_device, queue_family_index)) +{ + // Queue family supports image presentation +} +@endcode + +The `VK_KHR_surface` extension additionally provides the +`vkGetPhysicalDeviceSurfaceSupportKHR` function, which performs the same test on +an existing Vulkan surface. + + +@section vulkan_window Creating the window + +Unless you will be using OpenGL or OpenGL ES with the same window as Vulkan, +there is no need to create a context. You can disable context creation with the +[GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) hint. + +@code +glfwWindowHint(GLFW_CLIENT_API, GLFW_NO_API); +GLFWwindow* window = glfwCreateWindow(640, 480, "Window Title", NULL, NULL); +@endcode + +See @ref context_less for more information. + + +@section vulkan_surface Creating a Vulkan window surface + +You can create a Vulkan surface (as defined by the `VK_KHR_surface` extension) +for a GLFW window with @ref glfwCreateWindowSurface. + +@code +VkSurfaceKHR surface; +VkResult err = glfwCreateWindowSurface(instance, window, NULL, &surface); +if (err) +{ + // Window surface creation failed +} +@endcode + +If an OpenGL or OpenGL ES context was created on the window, the context has +ownership of the presentation on the window and a Vulkan surface cannot be +created. + +It is your responsibility to destroy the surface. GLFW does not destroy it for +you. Call `vkDestroySurfaceKHR` function from the same extension to destroy it. + +*/ diff --git a/deps/glfw-3.3.8/docs/window.dox b/deps/glfw-3.3.8/docs/window.dox new file mode 100644 index 0000000..2fcf11f --- /dev/null +++ b/deps/glfw-3.3.8/docs/window.dox @@ -0,0 +1,1412 @@ +/*! + +@page window_guide Window guide + +@tableofcontents + +This guide introduces the window related functions of GLFW. For details on +a specific function in this category, see the @ref window. There are also +guides for the other areas of GLFW. + + - @ref intro_guide + - @ref context_guide + - @ref vulkan_guide + - @ref monitor_guide + - @ref input_guide + + +@section window_object Window objects + +The @ref GLFWwindow object encapsulates both a window and a context. They are +created with @ref glfwCreateWindow and destroyed with @ref glfwDestroyWindow, or +@ref glfwTerminate, if any remain. As the window and context are inseparably +linked, the object pointer is used as both a context and window handle. + +To see the event stream provided to the various window related callbacks, run +the `events` test program. + + +@subsection window_creation Window creation + +A window and its OpenGL or OpenGL ES context are created with @ref +glfwCreateWindow, which returns a handle to the created window object. For +example, this creates a 640 by 480 windowed mode window: + +@code +GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", NULL, NULL); +@endcode + +If window creation fails, `NULL` will be returned, so it is necessary to check +the return value. + +The window handle is passed to all window related functions and is provided to +along with all input events, so event handlers can tell which window received +the event. + + +@subsubsection window_full_screen Full screen windows + +To create a full screen window, you need to specify which monitor the window +should use. In most cases, the user's primary monitor is a good choice. +For more information about retrieving monitors, see @ref monitor_monitors. + +@code +GLFWwindow* window = glfwCreateWindow(640, 480, "My Title", glfwGetPrimaryMonitor(), NULL); +@endcode + +Full screen windows cover the entire display area of a monitor, have no border +or decorations. + +Windowed mode windows can be made full screen by setting a monitor with @ref +glfwSetWindowMonitor, and full screen ones can be made windowed by unsetting it +with the same function. + +Each field of the @ref GLFWvidmode structure corresponds to a function parameter +or window hint and combine to form the _desired video mode_ for that window. +The supported video mode most closely matching the desired video mode will be +set for the chosen monitor as long as the window has input focus. For more +information about retrieving video modes, see @ref monitor_modes. + +Video mode field | Corresponds to +---------------- | -------------- +GLFWvidmode.width | `width` parameter of @ref glfwCreateWindow +GLFWvidmode.height | `height` parameter of @ref glfwCreateWindow +GLFWvidmode.redBits | @ref GLFW_RED_BITS hint +GLFWvidmode.greenBits | @ref GLFW_GREEN_BITS hint +GLFWvidmode.blueBits | @ref GLFW_BLUE_BITS hint +GLFWvidmode.refreshRate | @ref GLFW_REFRESH_RATE hint + +Once you have a full screen window, you can change its resolution, refresh rate +and monitor with @ref glfwSetWindowMonitor. If you only need change its +resolution you can also call @ref glfwSetWindowSize. In all cases, the new +video mode will be selected the same way as the video mode chosen by @ref +glfwCreateWindow. If the window has an OpenGL or OpenGL ES context, it will be +unaffected. + +By default, the original video mode of the monitor will be restored and the +window iconified if it loses input focus, to allow the user to switch back to +the desktop. This behavior can be disabled with the +[GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_hint) window hint, for example if you +wish to simultaneously cover multiple monitors with full screen windows. + +If a monitor is disconnected, all windows that are full screen on that monitor +will be switched to windowed mode. See @ref monitor_event for more information. + + +@subsubsection window_windowed_full_screen "Windowed full screen" windows + +If the closest match for the desired video mode is the current one, the video +mode will not be changed, making window creation faster and application +switching much smoother. This is sometimes called _windowed full screen_ or +_borderless full screen_ window and counts as a full screen window. To create +such a window, request the current video mode. + +@code +const GLFWvidmode* mode = glfwGetVideoMode(monitor); + +glfwWindowHint(GLFW_RED_BITS, mode->redBits); +glfwWindowHint(GLFW_GREEN_BITS, mode->greenBits); +glfwWindowHint(GLFW_BLUE_BITS, mode->blueBits); +glfwWindowHint(GLFW_REFRESH_RATE, mode->refreshRate); + +GLFWwindow* window = glfwCreateWindow(mode->width, mode->height, "My Title", monitor, NULL); +@endcode + +This also works for windowed mode windows that are made full screen. + +@code +const GLFWvidmode* mode = glfwGetVideoMode(monitor); + +glfwSetWindowMonitor(window, monitor, 0, 0, mode->width, mode->height, mode->refreshRate); +@endcode + +Note that @ref glfwGetVideoMode returns the _current_ video mode of a monitor, +so if you already have a full screen window on that monitor that you want to +make windowed full screen, you need to have saved the desktop resolution before. + + +@subsection window_destruction Window destruction + +When a window is no longer needed, destroy it with @ref glfwDestroyWindow. + +@code +glfwDestroyWindow(window); +@endcode + +Window destruction always succeeds. Before the actual destruction, all +callbacks are removed so no further events will be delivered for the window. +All windows remaining when @ref glfwTerminate is called are destroyed as well. + +When a full screen window is destroyed, the original video mode of its monitor +is restored, but the gamma ramp is left untouched. + + +@subsection window_hints Window creation hints + +There are a number of hints that can be set before the creation of a window and +context. Some affect the window itself, others affect the framebuffer or +context. These hints are set to their default values each time the library is +initialized with @ref glfwInit. Integer value hints can be set individually +with @ref glfwWindowHint and string value hints with @ref glfwWindowHintString. +You can reset all at once to their defaults with @ref glfwDefaultWindowHints. + +Some hints are platform specific. These are always valid to 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 +calls. + +@note Window hints need to be set before the creation of the window and context +you wish to have the specified attributes. They function as additional +arguments to @ref glfwCreateWindow. + + +@subsubsection window_hints_hard Hard and soft constraints + +Some window hints are hard constraints. These must match the available +capabilities _exactly_ for window and context creation to succeed. Hints +that are not hard constraints are matched as closely as possible, but the +resulting context and framebuffer may differ from what these hints requested. + +The following hints are always hard constraints: +- @ref GLFW_STEREO +- @ref GLFW_DOUBLEBUFFER +- [GLFW_CLIENT_API](@ref GLFW_CLIENT_API_hint) +- [GLFW_CONTEXT_CREATION_API](@ref GLFW_CONTEXT_CREATION_API_hint) + +The following additional hints are hard constraints when requesting an OpenGL +context, but are ignored when requesting an OpenGL ES context: +- [GLFW_OPENGL_FORWARD_COMPAT](@ref GLFW_OPENGL_FORWARD_COMPAT_hint) +- [GLFW_OPENGL_PROFILE](@ref GLFW_OPENGL_PROFILE_hint) + + +@subsubsection window_hints_wnd Window related hints + +@anchor GLFW_RESIZABLE_hint +__GLFW_RESIZABLE__ specifies whether the windowed mode window will be resizable +_by the user_. The window will still be resizable using the @ref +glfwSetWindowSize function. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. +This hint is ignored for full screen and undecorated windows. + +@anchor GLFW_VISIBLE_hint +__GLFW_VISIBLE__ specifies whether the windowed mode window will be initially +visible. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This hint is +ignored for full screen windows. + +@anchor GLFW_DECORATED_hint +__GLFW_DECORATED__ specifies whether the windowed mode window will have window +decorations such as a border, a close widget, etc. An undecorated window will +not be resizable by the user but will still allow the user to generate close +events on some platforms. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. +This hint is ignored for full screen windows. + +@anchor GLFW_FOCUSED_hint +__GLFW_FOCUSED__ specifies whether the windowed mode window will be given input +focus when created. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This +hint is ignored for full screen and initially hidden windows. + +@anchor GLFW_AUTO_ICONIFY_hint +__GLFW_AUTO_ICONIFY__ specifies whether the full screen window will +automatically iconify and restore the previous video mode on input focus loss. +Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This hint is ignored for +windowed mode windows. + +@anchor GLFW_FLOATING_hint +__GLFW_FLOATING__ specifies whether the windowed mode window will be floating +above other regular windows, also called topmost or always-on-top. This is +intended primarily for debugging purposes and cannot be used to implement proper +full screen windows. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This +hint is ignored for full screen windows. + +@anchor GLFW_MAXIMIZED_hint +__GLFW_MAXIMIZED__ specifies whether the windowed mode window will be maximized +when created. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This hint is +ignored for full screen windows. + +@anchor GLFW_CENTER_CURSOR_hint +__GLFW_CENTER_CURSOR__ specifies whether the cursor should be centered over +newly created full screen windows. Possible values are `GLFW_TRUE` and +`GLFW_FALSE`. This hint is ignored for windowed mode windows. + +@anchor GLFW_TRANSPARENT_FRAMEBUFFER_hint +__GLFW_TRANSPARENT_FRAMEBUFFER__ specifies whether the window framebuffer will +be transparent. If enabled and supported by the system, the window framebuffer +alpha channel will be used to combine the framebuffer with the background. This +does not affect window decorations. Possible values are `GLFW_TRUE` and +`GLFW_FALSE`. + +@anchor GLFW_FOCUS_ON_SHOW_hint +__GLFW_FOCUS_ON_SHOW__ specifies whether the window will be given input +focus when @ref glfwShowWindow is called. Possible values are `GLFW_TRUE` and +`GLFW_FALSE`. + +@anchor GLFW_SCALE_TO_MONITOR +__GLFW_SCALE_TO_MONITOR__ specified whether the window content area should be +resized based on the [monitor content scale](@ref monitor_scale) of any monitor +it is placed on. This includes the initial placement when the window is +created. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. + +This hint only has an effect on platforms where screen coordinates and pixels +always map 1:1 such as Windows and X11. On platforms like macOS the resolution +of the framebuffer is changed independently of the window size. + + +@subsubsection window_hints_fb Framebuffer related hints + +@anchor GLFW_RED_BITS +@anchor GLFW_GREEN_BITS +@anchor GLFW_BLUE_BITS +@anchor GLFW_ALPHA_BITS +@anchor GLFW_DEPTH_BITS +@anchor GLFW_STENCIL_BITS +__GLFW_RED_BITS__, __GLFW_GREEN_BITS__, __GLFW_BLUE_BITS__, __GLFW_ALPHA_BITS__, +__GLFW_DEPTH_BITS__ and __GLFW_STENCIL_BITS__ specify the desired bit depths of +the various components of the default framebuffer. A value of `GLFW_DONT_CARE` +means the application has no preference. + +@anchor GLFW_ACCUM_RED_BITS +@anchor GLFW_ACCUM_GREEN_BITS +@anchor GLFW_ACCUM_BLUE_BITS +@anchor GLFW_ACCUM_ALPHA_BITS +__GLFW_ACCUM_RED_BITS__, __GLFW_ACCUM_GREEN_BITS__, __GLFW_ACCUM_BLUE_BITS__ and +__GLFW_ACCUM_ALPHA_BITS__ specify the desired bit depths of the various +components of the accumulation buffer. A value of `GLFW_DONT_CARE` means the +application has no preference. + +Accumulation buffers are a legacy OpenGL feature and should not be used in new +code. + +@anchor GLFW_AUX_BUFFERS +__GLFW_AUX_BUFFERS__ specifies the desired number of auxiliary buffers. A value +of `GLFW_DONT_CARE` means the application has no preference. + +Auxiliary buffers are a legacy OpenGL feature and should not be used in new +code. + +@anchor GLFW_STEREO +__GLFW_STEREO__ specifies whether to use OpenGL stereoscopic rendering. +Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This is a hard constraint. + +@anchor GLFW_SAMPLES +__GLFW_SAMPLES__ specifies the desired number of samples to use for +multisampling. Zero disables multisampling. A value of `GLFW_DONT_CARE` means +the application has no preference. + +@anchor GLFW_SRGB_CAPABLE +__GLFW_SRGB_CAPABLE__ specifies whether the framebuffer should be sRGB capable. +Possible values are `GLFW_TRUE` and `GLFW_FALSE`. + +@note __OpenGL:__ If enabled and supported by the system, the +`GL_FRAMEBUFFER_SRGB` enable will control sRGB rendering. By default, sRGB +rendering will be disabled. + +@note __OpenGL ES:__ If enabled and supported by the system, the context will +always have sRGB rendering enabled. + +@anchor GLFW_DOUBLEBUFFER +__GLFW_DOUBLEBUFFER__ specifies whether the framebuffer should be double +buffered. You nearly always want to use double buffering. This is a hard +constraint. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. + + +@subsubsection window_hints_mtr Monitor related hints + +@anchor GLFW_REFRESH_RATE +__GLFW_REFRESH_RATE__ specifies the desired refresh rate for full screen +windows. A value of `GLFW_DONT_CARE` means the highest available refresh rate +will be used. This hint is ignored for windowed mode windows. + + +@subsubsection window_hints_ctx Context related hints + +@anchor GLFW_CLIENT_API_hint +__GLFW_CLIENT_API__ specifies which client API to create the context for. +Possible values are `GLFW_OPENGL_API`, `GLFW_OPENGL_ES_API` and `GLFW_NO_API`. +This is a hard constraint. + +@anchor GLFW_CONTEXT_CREATION_API_hint +__GLFW_CONTEXT_CREATION_API__ specifies which context creation API to use to +create the context. Possible values are `GLFW_NATIVE_CONTEXT_API`, +`GLFW_EGL_CONTEXT_API` and `GLFW_OSMESA_CONTEXT_API`. This is a hard +constraint. If no client API is requested, this hint is ignored. + +An [extension loader library](@ref context_glext_auto) that assumes it knows +which API was used to create the current context may fail if you change this +hint. This can be resolved by having it load functions via @ref +glfwGetProcAddress. + +@note @wayland The EGL API _is_ the native context creation API, so this hint +will have no effect. + +@note @x11 On some Linux systems, creating contexts via both the native and EGL +APIs in a single process will cause the application to segfault. Stick to one +API or the other on Linux for now. + +@note __OSMesa:__ As its name implies, an OpenGL context created with OSMesa +does not update the window contents when its buffers are swapped. Use OpenGL +functions or the OSMesa native access functions @ref glfwGetOSMesaColorBuffer +and @ref glfwGetOSMesaDepthBuffer to retrieve the framebuffer contents. + +@anchor GLFW_CONTEXT_VERSION_MAJOR_hint +@anchor GLFW_CONTEXT_VERSION_MINOR_hint +__GLFW_CONTEXT_VERSION_MAJOR__ and __GLFW_CONTEXT_VERSION_MINOR__ specify the +client API version that the created context must be compatible with. The exact +behavior of these hints depend on the requested client API. + +While there is no way to ask the driver for a context of the highest supported +version, GLFW will attempt to provide this when you ask for a version 1.0 +context, which is the default for these hints. + +Do not confuse these hints with @ref GLFW_VERSION_MAJOR and @ref +GLFW_VERSION_MINOR, which provide the API version of the GLFW header. + +@note __OpenGL:__ These hints are not hard constraints, but creation will fail +if the OpenGL version of the created context is less than the one requested. It +is therefore perfectly safe to use the default of version 1.0 for legacy code +and you will still get backwards-compatible contexts of version 3.0 and above +when available. + +@note __OpenGL ES:__ These hints are not hard constraints, but creation will +fail if the OpenGL ES version of the created context is less than the one +requested. Additionally, OpenGL ES 1.x cannot be returned if 2.0 or later was +requested, and vice versa. This is because OpenGL ES 3.x is backward compatible +with 2.0, but OpenGL ES 2.0 is not backward compatible with 1.x. + +@note @macos The OS only supports forward-compatible 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_FORWARD_COMPAT](@ref GLFW_OPENGL_FORWARD_COMPAT_hint) and +[GLFW_OPENGL_PROFILE](@ref GLFW_OPENGL_PROFILE_hint) hints accordingly. OpenGL +3.0 and 3.1 contexts are not supported at all on macOS. + +@anchor GLFW_OPENGL_FORWARD_COMPAT_hint +__GLFW_OPENGL_FORWARD_COMPAT__ specifies whether the OpenGL context should be +forward-compatible, i.e. one where all functionality deprecated in the requested +version of OpenGL is removed. This must only be used if the requested OpenGL +version is 3.0 or above. If OpenGL ES is requested, this hint is ignored. + +Forward-compatibility is described in detail in the +[OpenGL Reference Manual](https://www.opengl.org/registry/). + +@anchor GLFW_OPENGL_DEBUG_CONTEXT_hint +__GLFW_OPENGL_DEBUG_CONTEXT__ specifies whether the context should be created +in debug mode, which may provide additional error and diagnostic reporting +functionality. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. + +Debug contexts for OpenGL and OpenGL ES are described in detail by the +[GL_KHR_debug](https://www.khronos.org/registry/OpenGL/extensions/KHR/KHR_debug.txt) +extension. + +@anchor GLFW_OPENGL_PROFILE_hint +__GLFW_OPENGL_PROFILE__ specifies which OpenGL profile to create the context +for. Possible values are one of `GLFW_OPENGL_CORE_PROFILE` or +`GLFW_OPENGL_COMPAT_PROFILE`, or `GLFW_OPENGL_ANY_PROFILE` to not request +a specific profile. If requesting an OpenGL version below 3.2, +`GLFW_OPENGL_ANY_PROFILE` must be used. If OpenGL ES is requested, this hint +is ignored. + +OpenGL profiles are described in detail in the +[OpenGL Reference Manual](https://www.opengl.org/registry/). + +@anchor GLFW_CONTEXT_ROBUSTNESS_hint +__GLFW_CONTEXT_ROBUSTNESS__ specifies the robustness strategy to be used by the +context. This can be one of `GLFW_NO_RESET_NOTIFICATION` or +`GLFW_LOSE_CONTEXT_ON_RESET`, or `GLFW_NO_ROBUSTNESS` to not request +a robustness strategy. + +@anchor GLFW_CONTEXT_RELEASE_BEHAVIOR_hint +__GLFW_CONTEXT_RELEASE_BEHAVIOR__ specifies the release behavior to be +used by the context. Possible values are one of `GLFW_ANY_RELEASE_BEHAVIOR`, +`GLFW_RELEASE_BEHAVIOR_FLUSH` or `GLFW_RELEASE_BEHAVIOR_NONE`. If the +behavior is `GLFW_ANY_RELEASE_BEHAVIOR`, the default behavior of the context +creation API will be used. If the behavior is `GLFW_RELEASE_BEHAVIOR_FLUSH`, +the pipeline will be flushed whenever the context is released from being the +current one. If the behavior is `GLFW_RELEASE_BEHAVIOR_NONE`, the pipeline will +not be flushed on release. + +Context release behaviors are described in detail by the +[GL_KHR_context_flush_control](https://www.opengl.org/registry/specs/KHR/context_flush_control.txt) +extension. + +@anchor GLFW_CONTEXT_NO_ERROR_hint +__GLFW_CONTEXT_NO_ERROR__ specifies whether errors should be generated by the +context. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. If enabled, +situations that would have generated errors instead cause undefined behavior. + +The no error mode for OpenGL and OpenGL ES is described in detail by the +[GL_KHR_no_error](https://www.opengl.org/registry/specs/KHR/no_error.txt) +extension. + + +@subsubsection window_hints_osx macOS specific window hints + +@anchor GLFW_COCOA_RETINA_FRAMEBUFFER_hint +__GLFW_COCOA_RETINA_FRAMEBUFFER__ specifies whether to use full resolution +framebuffers on Retina displays. Possible values are `GLFW_TRUE` and +`GLFW_FALSE`. This is ignored on other platforms. + +@anchor GLFW_COCOA_FRAME_NAME_hint +__GLFW_COCOA_FRAME_NAME__ specifies the UTF-8 encoded name to use for autosaving +the window frame, or if empty disables frame autosaving for the window. This is +ignored on other platforms. This is set with @ref glfwWindowHintString. + +@anchor GLFW_COCOA_GRAPHICS_SWITCHING_hint +__GLFW_COCOA_GRAPHICS_SWITCHING__ specifies whether to in Automatic Graphics +Switching, i.e. to allow the system to choose the integrated GPU for the OpenGL +context and move it between GPUs if necessary or whether to force it to always +run on the discrete GPU. This only affects systems with both integrated and +discrete GPUs. Possible values are `GLFW_TRUE` and `GLFW_FALSE`. This is +ignored on other platforms. + +Simpler programs and tools may want to enable this to save power, while games +and other applications performing advanced rendering will want to leave it +disabled. + +A bundled application that wishes to participate in Automatic Graphics Switching +should also declare this in its `Info.plist` by setting the +`NSSupportsAutomaticGraphicsSwitching` key to `true`. + + +@subsubsection window_hints_x11 X11 specific window hints + +@anchor GLFW_X11_CLASS_NAME_hint +@anchor GLFW_X11_INSTANCE_NAME_hint +__GLFW_X11_CLASS_NAME__ and __GLFW_X11_INSTANCE_NAME__ specifies the desired +ASCII encoded class and instance parts of the ICCCM `WM_CLASS` window property. +These are set with @ref glfwWindowHintString. + + +@subsubsection window_hints_values Supported and default values + +Window hint | Default value | Supported values +----------------------------- | --------------------------- | ---------------- +GLFW_RESIZABLE | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_VISIBLE | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_DECORATED | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_FOCUSED | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_AUTO_ICONIFY | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_FLOATING | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_MAXIMIZED | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_CENTER_CURSOR | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_TRANSPARENT_FRAMEBUFFER | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_FOCUS_ON_SHOW | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_SCALE_TO_MONITOR | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_RED_BITS | 8 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_GREEN_BITS | 8 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_BLUE_BITS | 8 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_ALPHA_BITS | 8 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_DEPTH_BITS | 24 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_STENCIL_BITS | 8 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_ACCUM_RED_BITS | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_ACCUM_GREEN_BITS | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_ACCUM_BLUE_BITS | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_ACCUM_ALPHA_BITS | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_AUX_BUFFERS | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_SAMPLES | 0 | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_REFRESH_RATE | `GLFW_DONT_CARE` | 0 to `INT_MAX` or `GLFW_DONT_CARE` +GLFW_STEREO | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_SRGB_CAPABLE | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_DOUBLEBUFFER | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_CLIENT_API | `GLFW_OPENGL_API` | `GLFW_OPENGL_API`, `GLFW_OPENGL_ES_API` or `GLFW_NO_API` +GLFW_CONTEXT_CREATION_API | `GLFW_NATIVE_CONTEXT_API` | `GLFW_NATIVE_CONTEXT_API`, `GLFW_EGL_CONTEXT_API` or `GLFW_OSMESA_CONTEXT_API` +GLFW_CONTEXT_VERSION_MAJOR | 1 | Any valid major version number of the chosen client API +GLFW_CONTEXT_VERSION_MINOR | 0 | Any valid minor version number of the chosen client API +GLFW_CONTEXT_ROBUSTNESS | `GLFW_NO_ROBUSTNESS` | `GLFW_NO_ROBUSTNESS`, `GLFW_NO_RESET_NOTIFICATION` or `GLFW_LOSE_CONTEXT_ON_RESET` +GLFW_CONTEXT_RELEASE_BEHAVIOR | `GLFW_ANY_RELEASE_BEHAVIOR` | `GLFW_ANY_RELEASE_BEHAVIOR`, `GLFW_RELEASE_BEHAVIOR_FLUSH` or `GLFW_RELEASE_BEHAVIOR_NONE` +GLFW_OPENGL_FORWARD_COMPAT | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_OPENGL_DEBUG_CONTEXT | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_OPENGL_PROFILE | `GLFW_OPENGL_ANY_PROFILE` | `GLFW_OPENGL_ANY_PROFILE`, `GLFW_OPENGL_COMPAT_PROFILE` or `GLFW_OPENGL_CORE_PROFILE` +GLFW_COCOA_RETINA_FRAMEBUFFER | `GLFW_TRUE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_COCOA_FRAME_NAME | `""` | A UTF-8 encoded frame autosave name +GLFW_COCOA_GRAPHICS_SWITCHING | `GLFW_FALSE` | `GLFW_TRUE` or `GLFW_FALSE` +GLFW_X11_CLASS_NAME | `""` | An ASCII encoded `WM_CLASS` class name +GLFW_X11_INSTANCE_NAME | `""` | An ASCII encoded `WM_CLASS` instance name + + +@section window_events Window event processing + +See @ref events. + + +@section window_properties Window properties and events + +@subsection window_userptr User pointer + +Each window has a user pointer that can be set with @ref +glfwSetWindowUserPointer and queried with @ref glfwGetWindowUserPointer. This +can be used for any purpose you need and will not be modified by GLFW throughout +the life-time of the window. + +The initial value of the pointer is `NULL`. + + +@subsection window_close Window closing and close flag + +When the user attempts to close the window, for example by clicking the close +widget or using a key chord like Alt+F4, the _close flag_ of the window is set. +The window is however not actually destroyed and, unless you watch for this +state change, nothing further happens. + +The current state of the close flag is returned by @ref glfwWindowShouldClose +and can be set or cleared directly with @ref glfwSetWindowShouldClose. A common +pattern is to use the close flag as a main loop condition. + +@code +while (!glfwWindowShouldClose(window)) +{ + render(window); + + glfwSwapBuffers(window); + glfwPollEvents(); +} +@endcode + +If you wish to be notified when the user attempts to close a window, set a close +callback. + +@code +glfwSetWindowCloseCallback(window, window_close_callback); +@endcode + +The callback function is called directly _after_ the close flag has been set. +It can be used for example to filter close requests and clear the close flag +again unless certain conditions are met. + +@code +void window_close_callback(GLFWwindow* window) +{ + if (!time_to_close) + glfwSetWindowShouldClose(window, GLFW_FALSE); +} +@endcode + + +@subsection window_size Window size + +The size of a window can be changed with @ref glfwSetWindowSize. For windowed +mode windows, this sets the size, in +[screen coordinates](@ref coordinate_systems) of the _content area_ or _content +area_ of the window. The window system may impose limits on window size. + +@code +glfwSetWindowSize(window, 640, 480); +@endcode + +For full screen windows, the specified size becomes the new resolution of the +window's desired video mode. The video mode most closely matching the new +desired video mode is set immediately. The window is resized to fit the +resolution of the set video mode. + +If you wish to be notified when a window is resized, whether by the user, the +system or your own code, set a size callback. + +@code +glfwSetWindowSizeCallback(window, window_size_callback); +@endcode + +The callback function receives the new size, in screen coordinates, of the +content area of the window when the window is resized. + +@code +void window_size_callback(GLFWwindow* window, int width, int height) +{ +} +@endcode + +There is also @ref glfwGetWindowSize for directly retrieving the current size of +a window. + +@code +int width, height; +glfwGetWindowSize(window, &width, &height); +@endcode + +@note Do not pass the window size to `glViewport` or other pixel-based OpenGL +calls. The window size is in screen coordinates, not pixels. Use the +[framebuffer size](@ref window_fbsize), which is in pixels, for pixel-based +calls. + +The above functions work with the size of the content area, but decorated +windows typically have title bars and window frames around this rectangle. You +can retrieve the extents of these with @ref glfwGetWindowFrameSize. + +@code +int left, top, right, bottom; +glfwGetWindowFrameSize(window, &left, &top, &right, &bottom); +@endcode + +The returned values are the distances, in screen coordinates, from the edges of +the content area to the corresponding edges of the full window. As they are +distances and not coordinates, they are always zero or positive. + + +@subsection window_fbsize Framebuffer size + +While the size of a window is measured in screen coordinates, OpenGL works with +pixels. The size you pass into `glViewport`, for example, should be in pixels. +On some machines screen coordinates and pixels are the same, but on others they +will not be. There is a second set of functions to retrieve the size, in +pixels, of the framebuffer of a window. + +If you wish to be notified when the framebuffer of a window is resized, whether +by the user or the system, set a size callback. + +@code +glfwSetFramebufferSizeCallback(window, framebuffer_size_callback); +@endcode + +The callback function receives the new size of the framebuffer when it is +resized, which can for example be used to update the OpenGL viewport. + +@code +void framebuffer_size_callback(GLFWwindow* window, int width, int height) +{ + glViewport(0, 0, width, height); +} +@endcode + +There is also @ref glfwGetFramebufferSize for directly retrieving the current +size of the framebuffer of a window. + +@code +int width, height; +glfwGetFramebufferSize(window, &width, &height); +glViewport(0, 0, width, height); +@endcode + +The size of a framebuffer may change independently of the size of a window, for +example if the window is dragged between a regular monitor and a high-DPI one. + + +@subsection window_scale Window content scale + +The content scale for a window can be retrieved with @ref +glfwGetWindowContentScale. + +@code +float xscale, yscale; +glfwGetWindowContentScale(window, &xscale, &yscale); +@endcode + +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 systems 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. + +If you wish to be notified when the content scale of a window changes, whether +because of a system setting change or because it was moved to a monitor with +a different scale, set a content scale callback. + +@code +glfwSetWindowContentScaleCallback(window, window_content_scale_callback); +@endcode + +The callback function receives the new content scale of the window. + +@code +void window_content_scale_callback(GLFWwindow* window, float xscale, float yscale) +{ + set_interface_scale(xscale, yscale); +} +@endcode + +On platforms where pixels and screen coordinates always map 1:1, the window +will need to be resized to appear the same size when it is moved to a monitor +with a different content scale. To have this done automatically both when the +window is created and when its content scale later changes, set the @ref +GLFW_SCALE_TO_MONITOR window hint. + + +@subsection window_sizelimits Window size limits + +The minimum and maximum size of the content area of a windowed mode window can +be enforced with @ref glfwSetWindowSizeLimits. The user may resize the window +to any size and aspect ratio within the specified limits, unless the aspect +ratio is also set. + +@code +glfwSetWindowSizeLimits(window, 200, 200, 400, 400); +@endcode + +To specify only a minimum size or only a maximum one, set the other pair to +`GLFW_DONT_CARE`. + +@code +glfwSetWindowSizeLimits(window, 640, 480, GLFW_DONT_CARE, GLFW_DONT_CARE); +@endcode + +To disable size limits for a window, set them all to `GLFW_DONT_CARE`. + +The aspect ratio of the content area of a windowed mode window can be enforced +with @ref glfwSetWindowAspectRatio. The user may resize the window freely +unless size limits are also set, but the size will be constrained to maintain +the aspect ratio. + +@code +glfwSetWindowAspectRatio(window, 16, 9); +@endcode + +The aspect ratio is specified as a numerator and denominator, corresponding to +the width and height, respectively. If you want a window to maintain its +current aspect ratio, use its current size as the ratio. + +@code +int width, height; +glfwGetWindowSize(window, &width, &height); +glfwSetWindowAspectRatio(window, width, height); +@endcode + +To disable the aspect ratio limit for a window, set both terms to +`GLFW_DONT_CARE`. + +You can have both size limits and aspect ratio set for a window, but the results +are undefined if they conflict. + + +@subsection window_pos Window position + +The position of a windowed-mode window can be changed with @ref +glfwSetWindowPos. This moves the window so that the upper-left corner of its +content area has the specified [screen coordinates](@ref coordinate_systems). +The window system may put limitations on window placement. + +@code +glfwSetWindowPos(window, 100, 100); +@endcode + +If you wish to be notified when a window is moved, whether by the user, the +system or your own code, set a position callback. + +@code +glfwSetWindowPosCallback(window, window_pos_callback); +@endcode + +The callback function receives the new position, in screen coordinates, of the +upper-left corner of the content area when the window is moved. + +@code +void window_pos_callback(GLFWwindow* window, int xpos, int ypos) +{ +} +@endcode + +There is also @ref glfwGetWindowPos for directly retrieving the current position +of the content area of the window. + +@code +int xpos, ypos; +glfwGetWindowPos(window, &xpos, &ypos); +@endcode + + +@subsection window_title Window title + +All GLFW windows have a title, although undecorated or full screen windows may +not display it or only display it in a task bar or similar interface. You can +set a UTF-8 encoded window title with @ref glfwSetWindowTitle. + +@code +glfwSetWindowTitle(window, "My Window"); +@endcode + +The specified string is copied before the function returns, so there is no need +to keep it around. + +As long as your source file is encoded as UTF-8, you can use any Unicode +characters directly in the source. + +@code +glfwSetWindowTitle(window, "ラストエグザイル"); +@endcode + +If you are using C++11 or C11, you can use a UTF-8 string literal. + +@code +glfwSetWindowTitle(window, u8"This is always a UTF-8 string"); +@endcode + + +@subsection window_icon Window icon + +Decorated windows have icons on some platforms. You can set this icon by +specifying a list of candidate images with @ref glfwSetWindowIcon. + +@code +GLFWimage images[2]; +images[0] = load_icon("my_icon.png"); +images[1] = load_icon("my_icon_small.png"); + +glfwSetWindowIcon(window, 2, images); +@endcode + +The image data is 32-bit, little-endian, non-premultiplied RGBA, i.e. eight bits +per channel with the red channel first. The pixels are arranged canonically as +sequential rows, starting from the top-left corner. + +To revert to the default window icon, pass in an empty image array. + +@code +glfwSetWindowIcon(window, 0, NULL); +@endcode + + +@subsection window_monitor Window monitor + +Full screen windows are associated with a specific monitor. You can get the +handle for this monitor with @ref glfwGetWindowMonitor. + +@code +GLFWmonitor* monitor = glfwGetWindowMonitor(window); +@endcode + +This monitor handle is one of those returned by @ref glfwGetMonitors. + +For windowed mode windows, this function returns `NULL`. This is how to tell +full screen windows from windowed mode windows. + +You can move windows between monitors or between full screen and windowed mode +with @ref glfwSetWindowMonitor. When making a window full screen on the same or +on a different monitor, specify the desired monitor, resolution and refresh +rate. The position arguments are ignored. + +@code +const GLFWvidmode* mode = glfwGetVideoMode(monitor); + +glfwSetWindowMonitor(window, monitor, 0, 0, mode->width, mode->height, mode->refreshRate); +@endcode + +When making the window windowed, specify the desired position and size. The +refresh rate argument is ignored. + +@code +glfwSetWindowMonitor(window, NULL, xpos, ypos, width, height, 0); +@endcode + +This restores any previous window settings such as whether it is decorated, +floating, resizable, has size or aspect ratio limits, etc.. To restore a window +that was originally windowed to its original size and position, save these +before making it full screen and then pass them in as above. + + +@subsection window_iconify Window iconification + +Windows can be iconified (i.e. minimized) with @ref glfwIconifyWindow. + +@code +glfwIconifyWindow(window); +@endcode + +When a full screen window is iconified, the original video mode of its monitor +is restored until the user or application restores the window. + +Iconified windows can be restored with @ref glfwRestoreWindow. This function +also restores windows from maximization. + +@code +glfwRestoreWindow(window); +@endcode + +When a full screen window is restored, the desired video mode is restored to its +monitor as well. + +If you wish to be notified when a window is iconified or restored, whether by +the user, system or your own code, set an iconify callback. + +@code +glfwSetWindowIconifyCallback(window, window_iconify_callback); +@endcode + +The callback function receives changes in the iconification state of the window. + +@code +void window_iconify_callback(GLFWwindow* window, int iconified) +{ + if (iconified) + { + // The window was iconified + } + else + { + // The window was restored + } +} +@endcode + +You can also get the current iconification state with @ref glfwGetWindowAttrib. + +@code +int iconified = glfwGetWindowAttrib(window, GLFW_ICONIFIED); +@endcode + + +@subsection window_maximize Window maximization + +Windows can be maximized (i.e. zoomed) with @ref glfwMaximizeWindow. + +@code +glfwMaximizeWindow(window); +@endcode + +Full screen windows cannot be maximized and passing a full screen window to this +function does nothing. + +Maximized windows can be restored with @ref glfwRestoreWindow. This function +also restores windows from iconification. + +@code +glfwRestoreWindow(window); +@endcode + +If you wish to be notified when a window is maximized or restored, whether by +the user, system or your own code, set a maximize callback. + +@code +glfwSetWindowMaximizeCallback(window, window_maximize_callback); +@endcode + +The callback function receives changes in the maximization state of the window. + +@code +void window_maximize_callback(GLFWwindow* window, int maximized) +{ + if (maximized) + { + // The window was maximized + } + else + { + // The window was restored + } +} +@endcode + +You can also get the current maximization state with @ref glfwGetWindowAttrib. + +@code +int maximized = glfwGetWindowAttrib(window, GLFW_MAXIMIZED); +@endcode + +By default, newly created windows are not maximized. You can change this +behavior by setting the [GLFW_MAXIMIZED](@ref GLFW_MAXIMIZED_hint) window hint +before creating the window. + +@code +glfwWindowHint(GLFW_MAXIMIZED, GLFW_TRUE); +@endcode + + +@subsection window_hide Window visibility + +Windowed mode windows can be hidden with @ref glfwHideWindow. + +@code +glfwHideWindow(window); +@endcode + +This makes the window completely invisible to the user, including removing it +from the task bar, dock or window list. Full screen windows cannot be hidden +and calling @ref glfwHideWindow on a full screen window does nothing. + +Hidden windows can be shown with @ref glfwShowWindow. + +@code +glfwShowWindow(window); +@endcode + +By default, this function will also set the input focus to that window. 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. + +You can also get the current visibility state with @ref glfwGetWindowAttrib. + +@code +int visible = glfwGetWindowAttrib(window, GLFW_VISIBLE); +@endcode + +By default, newly created windows are visible. You can change this behavior by +setting the [GLFW_VISIBLE](@ref GLFW_VISIBLE_hint) window hint before creating +the window. + +@code +glfwWindowHint(GLFW_VISIBLE, GLFW_FALSE); +@endcode + +Windows created hidden are completely invisible to the user until shown. This +can be useful if you need to set up your window further before showing it, for +example moving it to a specific location. + + +@subsection window_focus Window input focus + +Windows can be given input focus and brought to the front with @ref +glfwFocusWindow. + +@code +glfwFocusWindow(window); +@endcode + +Keep in mind that it can be very disruptive to the user when a window is forced +to the top. For a less disruptive way of getting the user's attention, see +[attention requests](@ref window_attention). + +If you wish to be notified when a window gains or loses input focus, whether by +the user, system or your own code, set a focus callback. + +@code +glfwSetWindowFocusCallback(window, window_focus_callback); +@endcode + +The callback function receives changes in the input focus state of the window. + +@code +void window_focus_callback(GLFWwindow* window, int focused) +{ + if (focused) + { + // The window gained input focus + } + else + { + // The window lost input focus + } +} +@endcode + +You can also get the current input focus state with @ref glfwGetWindowAttrib. + +@code +int focused = glfwGetWindowAttrib(window, GLFW_FOCUSED); +@endcode + +By default, newly created windows are given input focus. You can change this +behavior by setting the [GLFW_FOCUSED](@ref GLFW_FOCUSED_hint) window hint +before creating the window. + +@code +glfwWindowHint(GLFW_FOCUSED, GLFW_FALSE); +@endcode + + +@subsection window_attention Window attention request + +If you wish to notify the user of an event without interrupting, you can request +attention with @ref glfwRequestWindowAttention. + +@code +glfwRequestWindowAttention(window); +@endcode + +The system will highlight the specified window, or on platforms where this is +not supported, the application as a whole. Once the user has given it +attention, the system will automatically end the request. + + +@subsection window_refresh Window damage and refresh + +If you wish to be notified when the contents of a window is damaged and needs +to be refreshed, set a window refresh callback. + +@code +glfwSetWindowRefreshCallback(m_handle, window_refresh_callback); +@endcode + +The callback function is called when the contents of the window needs to be +refreshed. + +@code +void window_refresh_callback(GLFWwindow* window) +{ + draw_editor_ui(window); + glfwSwapBuffers(window); +} +@endcode + +@note On compositing window systems such as Aero, Compiz or Aqua, where the +window contents are saved off-screen, this callback might only be called when +the window or framebuffer is resized. + + +@subsection window_transparency Window transparency + +GLFW supports two kinds of transparency for windows; framebuffer transparency +and whole window transparency. A single window may not use both methods. The +results of doing this are undefined. + +Both methods require the platform to support it and not every version of every +platform GLFW supports does this, so there are mechanisms to check whether the +window really is transparent. + +Window framebuffers can be made transparent on a per-pixel per-frame basis with +the [GLFW_TRANSPARENT_FRAMEBUFFER](@ref GLFW_TRANSPARENT_FRAMEBUFFER_hint) +window hint. + +@code +glfwWindowHint(GLFW_TRANSPARENT_FRAMEBUFFER, GLFW_TRUE); +@endcode + +If supported by the system, the window content area will be composited with the +background using the framebuffer per-pixel alpha channel. This requires desktop +compositing to be enabled on the system. It does not affect window decorations. + +You can check whether the window framebuffer was successfully made transparent +with the +[GLFW_TRANSPARENT_FRAMEBUFFER](@ref GLFW_TRANSPARENT_FRAMEBUFFER_attrib) +window attribute. + +@code +if (glfwGetWindowAttrib(window, GLFW_TRANSPARENT_FRAMEBUFFER)) +{ + // window framebuffer is currently transparent +} +@endcode + +GLFW comes with an example that enabled framebuffer transparency called `gears`. + +The opacity of the whole window, including any decorations, can be set with @ref +glfwSetWindowOpacity. + +@code +glfwSetWindowOpacity(window, 0.5f); +@endcode + +The opacity (or alpha) value is a positive finite number between zero and one, +where 0 (zero) is fully transparent and 1 (one) is fully opaque. The initial +opacity value for newly created windows is 1. + +The current opacity of a window can be queried with @ref glfwGetWindowOpacity. + +@code +float opacity = glfwGetWindowOpacity(window); +@endcode + +If the system does not support whole window transparency, this function always +returns one. + +GLFW comes with a test program that lets you control whole window transparency +at run-time called `opacity`. + + +@subsection window_attribs Window attributes + +Windows have a number of attributes that can be returned using @ref +glfwGetWindowAttrib. Some reflect state that may change as a result of user +interaction, (e.g. whether it has input focus), while others reflect inherent +properties of the window (e.g. what kind of border it has). Some are related to +the window and others to its OpenGL or OpenGL ES context. + +@code +if (glfwGetWindowAttrib(window, GLFW_FOCUSED)) +{ + // window has input focus +} +@endcode + +The [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) window attributes can be +changed with @ref glfwSetWindowAttrib. + +@code +glfwSetWindowAttrib(window, GLFW_RESIZABLE, GLFW_FALSE); +@endcode + + + +@subsubsection window_attribs_wnd Window related attributes + +@anchor GLFW_FOCUSED_attrib +__GLFW_FOCUSED__ indicates whether the specified window has input focus. See +@ref window_focus for details. + +@anchor GLFW_ICONIFIED_attrib +__GLFW_ICONIFIED__ indicates whether the specified window is iconified. +See @ref window_iconify for details. + +@anchor GLFW_MAXIMIZED_attrib +__GLFW_MAXIMIZED__ indicates whether the specified window is maximized. See +@ref window_maximize for details. + +@anchor GLFW_HOVERED_attrib +__GLFW_HOVERED__ indicates whether the cursor is currently directly over the +content area of the window, with no other windows between. See @ref +cursor_enter for details. + +@anchor GLFW_VISIBLE_attrib +__GLFW_VISIBLE__ indicates whether the specified window is visible. See @ref +window_hide for details. + +@anchor GLFW_RESIZABLE_attrib +__GLFW_RESIZABLE__ indicates whether the specified window is resizable _by the +user_. This can be set before creation with the +[GLFW_RESIZABLE](@ref GLFW_RESIZABLE_hint) window hint or after with @ref +glfwSetWindowAttrib. + +@anchor GLFW_DECORATED_attrib +__GLFW_DECORATED__ indicates whether the specified window has decorations such +as a border, a close widget, etc. This can be set before creation with the +[GLFW_DECORATED](@ref GLFW_DECORATED_hint) window hint or after with @ref +glfwSetWindowAttrib. + +@anchor GLFW_AUTO_ICONIFY_attrib +__GLFW_AUTO_ICONIFY__ indicates whether the specified full screen window is +iconified on focus loss, a close widget, etc. This can be set before creation +with the [GLFW_AUTO_ICONIFY](@ref GLFW_AUTO_ICONIFY_hint) window hint or after +with @ref glfwSetWindowAttrib. + +@anchor GLFW_FLOATING_attrib +__GLFW_FLOATING__ indicates whether the specified window is floating, also +called topmost or always-on-top. This can be set before creation with the +[GLFW_FLOATING](@ref GLFW_FLOATING_hint) window hint or after with @ref +glfwSetWindowAttrib. + +@anchor GLFW_TRANSPARENT_FRAMEBUFFER_attrib +__GLFW_TRANSPARENT_FRAMEBUFFER__ indicates whether the specified window has +a transparent framebuffer, i.e. the window contents is composited with the +background using the window framebuffer alpha channel. See @ref +window_transparency for details. + +@anchor GLFW_FOCUS_ON_SHOW_attrib +__GLFW_FOCUS_ON_SHOW__ specifies whether the window will be given input +focus when @ref glfwShowWindow is called. This can be set before creation +with the [GLFW_FOCUS_ON_SHOW](@ref GLFW_FOCUS_ON_SHOW_hint) window hint or +after with @ref glfwSetWindowAttrib. + +@subsubsection window_attribs_ctx Context related attributes + +@anchor GLFW_CLIENT_API_attrib +__GLFW_CLIENT_API__ indicates the client API provided by the window's context; +either `GLFW_OPENGL_API`, `GLFW_OPENGL_ES_API` or `GLFW_NO_API`. + +@anchor GLFW_CONTEXT_CREATION_API_attrib +__GLFW_CONTEXT_CREATION_API__ indicates the context creation API used to create +the window's context; either `GLFW_NATIVE_CONTEXT_API`, `GLFW_EGL_CONTEXT_API` +or `GLFW_OSMESA_CONTEXT_API`. + +@anchor GLFW_CONTEXT_VERSION_MAJOR_attrib +@anchor GLFW_CONTEXT_VERSION_MINOR_attrib +@anchor GLFW_CONTEXT_REVISION_attrib +__GLFW_CONTEXT_VERSION_MAJOR__, __GLFW_CONTEXT_VERSION_MINOR__ and +__GLFW_CONTEXT_REVISION__ indicate the client API version of the window's +context. + +@note Do not confuse these attributes with `GLFW_VERSION_MAJOR`, +`GLFW_VERSION_MINOR` and `GLFW_VERSION_REVISION` which provide the API version +of the GLFW header. + +@anchor GLFW_OPENGL_FORWARD_COMPAT_attrib +__GLFW_OPENGL_FORWARD_COMPAT__ is `GLFW_TRUE` if the window's context is an +OpenGL forward-compatible one, or `GLFW_FALSE` otherwise. + +@anchor GLFW_OPENGL_DEBUG_CONTEXT_attrib +__GLFW_OPENGL_DEBUG_CONTEXT__ is `GLFW_TRUE` if the window's context is in debug +mode, or `GLFW_FALSE` otherwise. + +@anchor GLFW_OPENGL_PROFILE_attrib +__GLFW_OPENGL_PROFILE__ indicates the OpenGL profile used by the context. This +is `GLFW_OPENGL_CORE_PROFILE` or `GLFW_OPENGL_COMPAT_PROFILE` if the context +uses a known profile, or `GLFW_OPENGL_ANY_PROFILE` if the OpenGL profile is +unknown or the context is an OpenGL ES context. Note that the returned profile +may not match the profile bits of the context flags, as GLFW will try other +means of detecting the profile when no bits are set. + +@anchor GLFW_CONTEXT_RELEASE_BEHAVIOR_attrib +__GLFW_CONTEXT_RELEASE_BEHAVIOR__ indicates the release used by the context. +Possible values are one of `GLFW_ANY_RELEASE_BEHAVIOR`, +`GLFW_RELEASE_BEHAVIOR_FLUSH` or `GLFW_RELEASE_BEHAVIOR_NONE`. If the +behavior is `GLFW_ANY_RELEASE_BEHAVIOR`, the default behavior of the context +creation API will be used. If the behavior is `GLFW_RELEASE_BEHAVIOR_FLUSH`, +the pipeline will be flushed whenever the context is released from being the +current one. If the behavior is `GLFW_RELEASE_BEHAVIOR_NONE`, the pipeline will +not be flushed on release. + +@anchor GLFW_CONTEXT_NO_ERROR_attrib +__GLFW_CONTEXT_NO_ERROR__ indicates whether errors are generated by the context. +Possible values are `GLFW_TRUE` and `GLFW_FALSE`. If enabled, situations that +would have generated errors instead cause undefined behavior. + +@anchor GLFW_CONTEXT_ROBUSTNESS_attrib +__GLFW_CONTEXT_ROBUSTNESS__ indicates the robustness strategy used by the +context. This is `GLFW_LOSE_CONTEXT_ON_RESET` or `GLFW_NO_RESET_NOTIFICATION` +if the window's context supports robustness, or `GLFW_NO_ROBUSTNESS` otherwise. + + +@subsubsection window_attribs_fb Framebuffer related attributes + +GLFW does not expose attributes of the default framebuffer (i.e. the framebuffer +attached to the window) as these can be queried directly with either OpenGL, +OpenGL ES or Vulkan. + +If you are using version 3.0 or later of OpenGL or OpenGL ES, the +`glGetFramebufferAttachmentParameteriv` function can be used to retrieve the +number of bits for the red, green, blue, alpha, depth and stencil buffer +channels. Otherwise, the `glGetIntegerv` function can be used. + +The number of MSAA samples are always retrieved with `glGetIntegerv`. For +contexts supporting framebuffer objects, the number of samples of the currently +bound framebuffer is returned. + +Attribute | glGetIntegerv | glGetFramebufferAttachmentParameteriv +------------ | ----------------- | ------------------------------------- +Red bits | `GL_RED_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_RED_SIZE` +Green bits | `GL_GREEN_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_GREEN_SIZE` +Blue bits | `GL_BLUE_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_BLUE_SIZE` +Alpha bits | `GL_ALPHA_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_ALPHA_SIZE` +Depth bits | `GL_DEPTH_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_DEPTH_SIZE` +Stencil bits | `GL_STENCIL_BITS` | `GL_FRAMEBUFFER_ATTACHMENT_STENCIL_SIZE` +MSAA samples | `GL_SAMPLES` | _Not provided by this function_ + +When calling `glGetFramebufferAttachmentParameteriv`, the red, green, blue and +alpha sizes are queried from the `GL_BACK_LEFT`, while the depth and stencil +sizes are queried from the `GL_DEPTH` and `GL_STENCIL` attachments, +respectively. + + +@section buffer_swap Buffer swapping + +GLFW windows are by default double buffered. That means that you have two +rendering buffers; a front buffer and a back buffer. The front buffer is +the one being displayed and the back buffer the one you render to. + +When the entire frame has been rendered, it is time to swap the back and the +front buffers in order to display what has been rendered and begin rendering +a new frame. This is done with @ref glfwSwapBuffers. + +@code +glfwSwapBuffers(window); +@endcode + +Sometimes it can be useful to select when the buffer swap will occur. With the +function @ref glfwSwapInterval it is possible to select the minimum number of +monitor refreshes the driver should wait from the time @ref glfwSwapBuffers was +called before swapping the buffers: + +@code +glfwSwapInterval(1); +@endcode + +If the interval is zero, the swap will take place immediately when @ref +glfwSwapBuffers is called without waiting for a refresh. Otherwise at least +interval retraces will pass between each buffer swap. Using a swap interval of +zero can be useful for benchmarking purposes, when it is not desirable to +measure the time it takes to wait for the vertical retrace. However, a swap +interval of one lets you avoid tearing. + +Note that this may not work on all machines, as some drivers have +user-controlled settings that override any swap interval the application +requests. + +A context that supports either the `WGL_EXT_swap_control_tear` or the +`GLX_EXT_swap_control_tear` extension also accepts _negative_ swap intervals, +which allows the driver to swap immediately even if a frame arrives a little bit +late. This trades the risk of visible tears for greater framerate stability. +You can check for these extensions with @ref glfwExtensionSupported. + +*/ -- cgit v1.2.3-70-g09d2