• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // dear imgui: Platform Backend for GLFW
2 // This needs to be used along with a Renderer (e.g. OpenGL3, Vulkan, WebGPU..)
3 // (Info: GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
4 
5 // Implemented features:
6 //  [X] Platform: Clipboard support.
7 //  [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
8 //  [x] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. FIXME: 3 cursors types are missing from GLFW.
9 //  [X] Platform: Keyboard arrays indexed using GLFW_KEY_* codes, e.g. ImGui::IsKeyPressed(GLFW_KEY_SPACE).
10 
11 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
12 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
13 // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
14 // Read online: https://github.com/ocornut/imgui/tree/master/docs
15 
16 // About GLSL version:
17 // The 'glsl_version' initialization parameter defaults to "#version 150" if NULL.
18 // Only override if your GL version doesn't handle this GLSL version. Keep NULL if unsure!
19 
20 #pragma once
21 #include "imgui.h"      // IMGUI_IMPL_API
22 
23 struct GLFWwindow;
24 struct GLFWmonitor;
25 
26 IMGUI_IMPL_API bool     ImGui_ImplGlfw_InitForOpenGL(GLFWwindow* window, bool install_callbacks);
27 IMGUI_IMPL_API bool     ImGui_ImplGlfw_InitForVulkan(GLFWwindow* window, bool install_callbacks);
28 IMGUI_IMPL_API bool     ImGui_ImplGlfw_InitForOther(GLFWwindow* window, bool install_callbacks);
29 IMGUI_IMPL_API void     ImGui_ImplGlfw_Shutdown();
30 IMGUI_IMPL_API void     ImGui_ImplGlfw_NewFrame();
31 
32 // GLFW callbacks
33 // - When calling Init with 'install_callbacks=true': GLFW callbacks will be installed for you. They will call user's previously installed callbacks, if any.
34 // - When calling Init with 'install_callbacks=false': GLFW callbacks won't be installed. You will need to call those function yourself from your own GLFW callbacks.
35 IMGUI_IMPL_API void     ImGui_ImplGlfw_WindowFocusCallback(GLFWwindow* window, int focused);
36 IMGUI_IMPL_API void     ImGui_ImplGlfw_CursorEnterCallback(GLFWwindow* window, int entered);
37 IMGUI_IMPL_API void     ImGui_ImplGlfw_MouseButtonCallback(GLFWwindow* window, int button, int action, int mods);
38 IMGUI_IMPL_API void     ImGui_ImplGlfw_ScrollCallback(GLFWwindow* window, double xoffset, double yoffset);
39 IMGUI_IMPL_API void     ImGui_ImplGlfw_KeyCallback(GLFWwindow* window, int key, int scancode, int action, int mods);
40 IMGUI_IMPL_API void     ImGui_ImplGlfw_CharCallback(GLFWwindow* window, unsigned int c);
41 IMGUI_IMPL_API void     ImGui_ImplGlfw_MonitorCallback(GLFWmonitor* monitor, int event);
42