2020-10-12 10:34:22 -05:00
// dear imgui: Platform Backend for GLFW
2021-01-28 05:11:26 -06:00
// This needs to be used along with a Renderer (e.g. OpenGL3, Vulkan, WebGPU..)
2018-06-08 12:37:33 -05:00
// (Info: GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
2016-03-24 05:00:47 -05:00
2018-02-05 13:34:11 -06:00
// Implemented features:
2018-06-11 05:33:51 -05:00
// [X] Platform: Clipboard support.
2023-04-04 12:43:51 -05:00
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen (Windows only).
2021-12-12 05:00:31 -06: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 03:37:55 -05:00
// [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
2021-12-12 05:00:31 -06:00
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange' (note: the resizing cursors requires GLFW 3.4+).
2018-02-05 13:34:11 -06:00
2021-07-29 11:59:45 -05:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2021-05-27 06:59:35 -05: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 06:47:08 -05: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 06:59:23 -05:00
2018-11-01 14:56:36 -05:00
# pragma once
2020-04-07 04:02:29 -05:00
# include "imgui.h" // IMGUI_IMPL_API
2023-07-13 04:27:52 -05:00
# ifndef IMGUI_DISABLE
2020-04-06 13:23:57 -05:00
2015-03-09 06:59:23 -05:00
struct GLFWwindow ;
2021-07-07 07:12:48 -05:00
struct GLFWmonitor ;
2015-03-09 06:59:23 -05:00
2018-06-21 05:04:00 -05: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-10 10:27:33 -06:00
IMGUI_IMPL_API bool ImGui_ImplGlfw_InitForOther ( GLFWwindow * window , bool install_callbacks ) ;
2018-06-21 05:04:00 -05:00
IMGUI_IMPL_API void ImGui_ImplGlfw_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_NewFrame ( ) ;
2015-03-09 10:02:22 -05:00
2023-12-19 08:52:44 -06:00
// Emscripten related initialization phase methods
# ifdef __EMSCRIPTEN__
2023-12-19 08:57:00 -06:00
IMGUI_IMPL_API void ImGui_ImplGlfw_InstallEmscriptenCanvasResizeCallback ( const char * canvas_selector ) ;
2023-12-19 08:52:44 -06:00
# endif
2023-02-03 10:53:53 -06:00
// GLFW callbacks install
2022-02-07 09:00:13 -06: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-03 10:53:53 -06: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-12 10:08:37 -06: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 05:04:00 -05: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 07:12:48 -05:00
IMGUI_IMPL_API void ImGui_ImplGlfw_MonitorCallback ( GLFWmonitor * monitor , int event ) ;
2023-07-13 04:27:52 -05:00
# endif // #ifndef IMGUI_DISABLE