2020-10-12 23:34:22 +08:00
// dear imgui: Platform Backend for GLFW
2021-01-28 19:11:26 +08:00
// This needs to be used along with a Renderer (e.g. OpenGL3, Vulkan, WebGPU..)
2018-06-09 01:37:33 +08:00
// (Info: GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
2016-03-24 18:00:47 +08:00
2018-02-06 03:34:11 +08:00
// Implemented features:
2018-06-11 18:33:51 +08:00
// [X] Platform: Clipboard support.
2023-04-05 01:43:51 +08:00
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen (Windows only).
2021-12-12 19:00:31 +08:00
// [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy GLFW_KEY_* values will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
2018-09-20 16:37:55 +08:00
// [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
2021-12-12 19:00:31 +08:00
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange' (note: the resizing cursors requires GLFW 3.4+).
2018-02-06 03:34:11 +08:00
2021-07-30 00:59:45 +08:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2021-05-27 19:59:35 +08:00
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
2023-09-11 19:47:08 +08:00
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2015-03-09 19:59:23 +08:00
2018-11-02 03:56:36 +08:00
# pragma once
2020-04-07 17:02:29 +08:00
# include "imgui.h" // IMGUI_IMPL_API
2023-07-13 17:27:52 +08:00
# ifndef IMGUI_DISABLE
2020-04-07 02:23:57 +08:00
2015-03-09 19:59:23 +08:00
struct GLFWwindow ;
2021-07-07 20:12:48 +08:00
struct GLFWmonitor ;
2015-03-09 19:59:23 +08:00
2024-07-25 22:59:34 +08:00
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
2018-06-21 18:04:00 +08:00
IMGUI_IMPL_API bool ImGui_ImplGlfw_InitForOpenGL ( GLFWwindow * window , bool install_callbacks ) ;
IMGUI_IMPL_API bool ImGui_ImplGlfw_InitForVulkan ( GLFWwindow * window , bool install_callbacks ) ;
2021-02-11 00:27:33 +08:00
IMGUI_IMPL_API bool ImGui_ImplGlfw_InitForOther ( GLFWwindow * window , bool install_callbacks ) ;
2018-06-21 18:04:00 +08:00
IMGUI_IMPL_API void ImGui_ImplGlfw_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_NewFrame ( ) ;
2015-03-09 23:02:22 +08:00
2024-07-08 21:53:23 +08:00
// Emscripten related initialization phase methods (call after ImGui_ImplGlfw_InitForOpenGL)
2023-12-19 22:52:44 +08:00
# ifdef __EMSCRIPTEN__
2024-07-08 21:53:23 +08:00
IMGUI_IMPL_API void ImGui_ImplGlfw_InstallEmscriptenCallbacks ( GLFWwindow * window , const char * canvas_selector ) ;
//static inline void ImGui_ImplGlfw_InstallEmscriptenCanvasResizeCallback(const char* canvas_selector) { ImGui_ImplGlfw_InstallEmscriptenCallbacks(nullptr, canvas_selector); } } // Renamed in 1.91.0
2023-12-19 22:52:44 +08:00
# endif
2023-02-04 00:53:53 +08:00
// GLFW callbacks install
2022-02-07 23:00:13 +08:00
// - When calling Init with 'install_callbacks=true': ImGui_ImplGlfw_InstallCallbacks() is called. GLFW callbacks will be installed for you. They will chain-call user's previously installed callbacks, if any.
// - When calling Init with 'install_callbacks=false': GLFW callbacks won't be installed. You will need to call individual function yourself from your own GLFW callbacks.
IMGUI_IMPL_API void ImGui_ImplGlfw_InstallCallbacks ( GLFWwindow * window ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_RestoreCallbacks ( GLFWwindow * window ) ;
2023-02-04 00:53:53 +08:00
// GFLW callbacks options:
// - Set 'chain_for_all_windows=true' to enable chaining callbacks for all windows (including secondary viewports created by backends or by user)
IMGUI_IMPL_API void ImGui_ImplGlfw_SetCallbacksChainForAllWindows ( bool chain_for_all_windows ) ;
// GLFW callbacks (individual callbacks to call yourself if you didn't install callbacks)
2022-01-13 00:08:37 +08:00
IMGUI_IMPL_API void ImGui_ImplGlfw_WindowFocusCallback ( GLFWwindow * window , int focused ) ; // Since 1.84
IMGUI_IMPL_API void ImGui_ImplGlfw_CursorEnterCallback ( GLFWwindow * window , int entered ) ; // Since 1.84
IMGUI_IMPL_API void ImGui_ImplGlfw_CursorPosCallback ( GLFWwindow * window , double x , double y ) ; // Since 1.87
2018-06-21 18:04:00 +08:00
IMGUI_IMPL_API void ImGui_ImplGlfw_MouseButtonCallback ( GLFWwindow * window , int button , int action , int mods ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_ScrollCallback ( GLFWwindow * window , double xoffset , double yoffset ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_KeyCallback ( GLFWwindow * window , int key , int scancode , int action , int mods ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_CharCallback ( GLFWwindow * window , unsigned int c ) ;
2021-07-07 20:12:48 +08:00
IMGUI_IMPL_API void ImGui_ImplGlfw_MonitorCallback ( GLFWmonitor * monitor , int event ) ;
2023-07-13 17:27:52 +08:00
2024-07-31 23:33:24 +08:00
// GLFW helpers
IMGUI_IMPL_API void ImGui_ImplGlfw_Sleep ( int milliseconds ) ;
2023-07-13 17:27:52 +08:00
# endif // #ifndef IMGUI_DISABLE