Karma Engine
Loading...
Searching...
No Matches
imgui_impl_glfw.h
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// (Requires: GLFW 3.1+. Prefer GLFW 3.3+ for full feature support.)
5
6// Implemented features:
7// [X] Platform: Clipboard support.
8// [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass KarmaGuiKey values to all key functions e.g. KarmaGui::IsKeyPressed(KarmaGuiKey_Space). [Legacy GLFW_KEY_* values will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
9// [X] Platform: Gamepad support. Enable with 'io.ConfigFlags |= KarmaGuiConfigFlags_NavEnableGamepad'.
10// [x] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= KarmaGuiConfigFlags_NoMouseCursorChange' (note: the resizing cursors requires GLFW 3.4+).
11// [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= KarmaGuiConfigFlags_ViewportsEnable'.
12
13// Issues:
14// [ ] Platform: Multi-viewport support: ParentViewportID not honored, and so io.ConfigViewportsNoDefaultParent has no effect (minor).
15
16// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
17// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
18// If you are new to Dear KarmaGui, read documentation from the docs/ folder + read the top of imgui.cpp.
19// Read online: https://github.com/ocornut/imgui/tree/master/docs
20
21#pragma once
22#include "KarmaGui.h"
23
24struct GLFWwindow;
25struct GLFWmonitor;
26
27namespace Karma
28{
29 bool KarmaGui_ImplGlfw_InitForOpenGL(GLFWwindow* window, bool install_callbacks);
30 bool KarmaGui_ImplGlfw_InitForVulkan(GLFWwindow* window, bool install_callbacks);
31 bool KarmaGui_ImplGlfw_InitForOther(GLFWwindow* window, bool install_callbacks);
32 void KarmaGui_ImplGlfw_Shutdown();
33 void KarmaGui_ImplGlfw_NewFrame();
34
35 // GLFW callbacks (installer)
36 // - When calling Init with 'install_callbacks=true': KarmaGui_ImplGlfw_InstallCallbacks() is called. GLFW callbacks will be installed for you. They will chain-call user's previously installed callbacks, if any.
37 // - 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.
38 void KarmaGui_ImplGlfw_InstallCallbacks(GLFWwindow* window);
39 void KarmaGui_ImplGlfw_RestoreCallbacks(GLFWwindow* window);
40
41 // GLFW callbacks (individual callbacks to call if you didn't install callbacks)
42 void KarmaGui_ImplGlfw_WindowFocusCallback(GLFWwindow* window, int focused); // Since 1.84
43 void KarmaGui_ImplGlfw_CursorEnterCallback(GLFWwindow* window, int entered); // Since 1.84
44 void KarmaGui_ImplGlfw_CursorPosCallback(GLFWwindow* window, double x, double y); // Since 1.87
45 void KarmaGui_ImplGlfw_MouseButtonCallback(GLFWwindow* window, int button, int action, int mods);
46 void KarmaGui_ImplGlfw_ScrollCallback(GLFWwindow* window, double xoffset, double yoffset);
47 void KarmaGui_ImplGlfw_KeyCallback(GLFWwindow* window, int key, int scancode, int action, int mods);
48 void KarmaGui_ImplGlfw_CharCallback(GLFWwindow* window, unsigned int c);
49 void KarmaGui_ImplGlfw_MonitorCallback(GLFWmonitor* monitor, int event);
50}