2020-10-12 17:34:22 +02:00
// dear imgui: Platform Backend for GLFW
2021-01-28 12:11:26 +01:00
// This needs to be used along with a Renderer (e.g. OpenGL3, Vulkan, WebGPU..)
2018-02-21 23:05:17 +01:00
// (Info: GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
2022-01-10 15:24:21 +01:00
// (Requires: GLFW 3.1+. Prefer GLFW 3.3+ for full feature support.)
2016-03-24 11:00:47 +01:00
2018-02-05 20:34:11 +01:00
// Implemented features:
2018-06-11 12:33:51 +02:00
// [X] Platform: Clipboard support.
2023-04-04 19:43:51 +02:00
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen (Windows only).
2021-12-12 12:00:31 +01: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 10:37:55 +02:00
// [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
2022-01-10 15:24:21 +01:00
// [x] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange' (note: the resizing cursors requires GLFW 3.4+).
2018-06-12 16:24:24 +02:00
// [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
2018-02-05 20:34:11 +01:00
2020-07-17 15:57:50 +02:00
// Issues:
// [ ] Platform: Multi-viewport support: ParentViewportID not honored, and so io.ConfigViewportsNoDefaultParent has no effect (minor).
2021-07-29 18:59:45 +02:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2021-05-27 13:59:35 +02: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.
2020-10-14 12:22:53 +02:00
// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
// Read online: https://github.com/ocornut/imgui/tree/master/docs
2015-03-09 12:59:23 +01:00
2018-11-01 20:56:36 +01:00
# pragma once
2020-04-07 11:02:29 +02:00
# include "imgui.h" // IMGUI_IMPL_API
2023-07-13 11:27:52 +02:00
# ifndef IMGUI_DISABLE
2018-11-01 20:56:36 +01:00
2015-03-09 12:59:23 +01:00
struct GLFWwindow ;
2020-02-09 17:31:18 +01:00
struct GLFWmonitor ;
2015-03-09 12:59:23 +01:00
2018-06-21 12:04:00 +02: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 17:27:33 +01:00
IMGUI_IMPL_API bool ImGui_ImplGlfw_InitForOther ( GLFWwindow * window , bool install_callbacks ) ;
2018-06-21 12:04:00 +02:00
IMGUI_IMPL_API void ImGui_ImplGlfw_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplGlfw_NewFrame ( ) ;
2015-03-09 16:02:22 +01:00
2023-02-03 17:53:53 +01:00
// GLFW callbacks install
2022-02-07 16:00:13 +01: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 17:53:53 +01: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 17:08:37 +01: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 12:04:00 +02: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 ) ;
2020-02-09 17:31:18 +01:00
IMGUI_IMPL_API void ImGui_ImplGlfw_MonitorCallback ( GLFWmonitor * monitor , int event ) ;
2023-07-13 11:27:52 +02:00
# endif // #ifndef IMGUI_DISABLE