imgui_impl_glfw_gl2.cpp 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. // ImGui GLFW binding with OpenGL (legacy, fixed pipeline)
  2. // (GLFW is a cross-platform general purpose library for handling windows, inputs, OpenGL/Vulkan graphics context creation, etc.)
  3. // Implemented features:
  4. // [X] User texture binding. Cast 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID in imgui.cpp.
  5. // **DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
  6. // **Prefer using the code in the opengl3_example/ folder**
  7. // This code is mostly provided as a reference to learn how ImGui integration works, because it is shorter to read.
  8. // If your code is using GL3+ context or any semi modern OpenGL calls, using this is likely to make everything more
  9. // complicated, will require your code to reset every single OpenGL attributes to their initial state, and might
  10. // confuse your GPU driver.
  11. // The GL2 code is unable to reset attributes or even call e.g. "glUseProgram(0)" because they don't exist in that API.
  12. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  13. // If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
  14. // If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
  15. // https://github.com/ocornut/imgui
  16. // CHANGELOG
  17. // (minor and older changes stripped away, please see git history for details)
  18. // 2018-02-20: Inputs: Added support for mouse cursors (ImGui::GetMouseCursor() value and WM_SETCURSOR message handling).
  19. // 2018-02-20: Inputs: Renamed GLFW callbacks exposed in .h to not include GL2 in their name.
  20. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplGlfwGL2_RenderDrawData() in the .h file so you can call it yourself.
  21. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  22. // 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
  23. // 2018-01-25: Inputs: Honoring the io.WantMoveMouse by repositioning the mouse by using navigation and ImGuiNavFlags_MoveMouse is set.
  24. // 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
  25. // 2018-01-18: Inputs: Added mapping for ImGuiKey_Insert.
  26. // 2018-01-09: Misc: Renamed imgui_impl_glfw.* to imgui_impl_glfw_gl2.*.
  27. // 2017-09-01: OpenGL: Save and restore current polygon mode.
  28. // 2017-08-25: Inputs: MousePos set to -FLT_MAX,-FLT_MAX when mouse is unavailable/missing (instead of -1,-1).
  29. // 2016-10-15: Misc: Added a void* user_data parameter to Clipboard function handlers.
  30. // 2016-09-10: OpenGL: Uploading font texture as RGBA32 to increase compatibility with users shaders (not ideal).
  31. // 2016-09-05: OpenGL: Fixed save and restore of current scissor rectangle.
  32. #include "imgui.h"
  33. #include "imgui_impl_glfw_gl2.h"
  34. // GLFW
  35. #include <GLFW/glfw3.h>
  36. #ifdef _WIN32
  37. #undef APIENTRY
  38. #define GLFW_EXPOSE_NATIVE_WIN32
  39. #define GLFW_EXPOSE_NATIVE_WGL
  40. #include <GLFW/glfw3native.h>
  41. #endif
  42. // GLFW data
  43. static GLFWwindow* g_Window = NULL;
  44. static double g_Time = 0.0f;
  45. static bool g_MouseJustPressed[3] = { false, false, false };
  46. static GLFWcursor* g_MouseCursors[ImGuiMouseCursor_Count_] = { 0 };
  47. // OpenGL data
  48. static GLuint g_FontTexture = 0;
  49. // OpenGL2 Render function.
  50. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  51. // Note that this implementation is little overcomplicated because we are saving/setting up/restoring every OpenGL state explicitly, in order to be able to run within any OpenGL engine that doesn't do so.
  52. void ImGui_ImplGlfwGL2_RenderDrawData(ImDrawData* draw_data)
  53. {
  54. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  55. ImGuiIO& io = ImGui::GetIO();
  56. int fb_width = (int)(io.DisplaySize.x * io.DisplayFramebufferScale.x);
  57. int fb_height = (int)(io.DisplaySize.y * io.DisplayFramebufferScale.y);
  58. if (fb_width == 0 || fb_height == 0)
  59. return;
  60. draw_data->ScaleClipRects(io.DisplayFramebufferScale);
  61. // We are using the OpenGL fixed pipeline to make the example code simpler to read!
  62. // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, vertex/texcoord/color pointers, polygon fill.
  63. GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  64. GLint last_polygon_mode[2]; glGetIntegerv(GL_POLYGON_MODE, last_polygon_mode);
  65. GLint last_viewport[4]; glGetIntegerv(GL_VIEWPORT, last_viewport);
  66. GLint last_scissor_box[4]; glGetIntegerv(GL_SCISSOR_BOX, last_scissor_box);
  67. glPushAttrib(GL_ENABLE_BIT | GL_COLOR_BUFFER_BIT | GL_TRANSFORM_BIT);
  68. glEnable(GL_BLEND);
  69. glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
  70. glDisable(GL_CULL_FACE);
  71. glDisable(GL_DEPTH_TEST);
  72. glEnable(GL_SCISSOR_TEST);
  73. glEnableClientState(GL_VERTEX_ARRAY);
  74. glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  75. glEnableClientState(GL_COLOR_ARRAY);
  76. glEnable(GL_TEXTURE_2D);
  77. glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
  78. //glUseProgram(0); // You may want this if using this code in an OpenGL 3+ context where shaders may be bound
  79. // Setup viewport, orthographic projection matrix
  80. glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
  81. glMatrixMode(GL_PROJECTION);
  82. glPushMatrix();
  83. glLoadIdentity();
  84. glOrtho(0.0f, io.DisplaySize.x, io.DisplaySize.y, 0.0f, -1.0f, +1.0f);
  85. glMatrixMode(GL_MODELVIEW);
  86. glPushMatrix();
  87. glLoadIdentity();
  88. // Render command lists
  89. for (int n = 0; n < draw_data->CmdListsCount; n++)
  90. {
  91. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  92. const ImDrawVert* vtx_buffer = cmd_list->VtxBuffer.Data;
  93. const ImDrawIdx* idx_buffer = cmd_list->IdxBuffer.Data;
  94. glVertexPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, pos)));
  95. glTexCoordPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, uv)));
  96. glColorPointer(4, GL_UNSIGNED_BYTE, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, col)));
  97. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  98. {
  99. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  100. if (pcmd->UserCallback)
  101. {
  102. pcmd->UserCallback(cmd_list, pcmd);
  103. }
  104. else
  105. {
  106. glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->TextureId);
  107. glScissor((int)pcmd->ClipRect.x, (int)(fb_height - pcmd->ClipRect.w), (int)(pcmd->ClipRect.z - pcmd->ClipRect.x), (int)(pcmd->ClipRect.w - pcmd->ClipRect.y));
  108. glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer);
  109. }
  110. idx_buffer += pcmd->ElemCount;
  111. }
  112. }
  113. // Restore modified state
  114. glDisableClientState(GL_COLOR_ARRAY);
  115. glDisableClientState(GL_TEXTURE_COORD_ARRAY);
  116. glDisableClientState(GL_VERTEX_ARRAY);
  117. glBindTexture(GL_TEXTURE_2D, (GLuint)last_texture);
  118. glMatrixMode(GL_MODELVIEW);
  119. glPopMatrix();
  120. glMatrixMode(GL_PROJECTION);
  121. glPopMatrix();
  122. glPopAttrib();
  123. glPolygonMode(GL_FRONT, (GLenum)last_polygon_mode[0]); glPolygonMode(GL_BACK, (GLenum)last_polygon_mode[1]);
  124. glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
  125. glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
  126. }
  127. static const char* ImGui_ImplGlfwGL2_GetClipboardText(void* user_data)
  128. {
  129. return glfwGetClipboardString((GLFWwindow*)user_data);
  130. }
  131. static void ImGui_ImplGlfwGL2_SetClipboardText(void* user_data, const char* text)
  132. {
  133. glfwSetClipboardString((GLFWwindow*)user_data, text);
  134. }
  135. void ImGui_ImplGlfw_MouseButtonCallback(GLFWwindow*, int button, int action, int /*mods*/)
  136. {
  137. if (action == GLFW_PRESS && button >= 0 && button < 3)
  138. g_MouseJustPressed[button] = true;
  139. }
  140. void ImGui_ImplGlfw_ScrollCallback(GLFWwindow*, double xoffset, double yoffset)
  141. {
  142. ImGuiIO& io = ImGui::GetIO();
  143. io.MouseWheelH += (float)xoffset;
  144. io.MouseWheel += (float)yoffset;
  145. }
  146. void ImGui_ImplGlfw_KeyCallback(GLFWwindow*, int key, int, int action, int mods)
  147. {
  148. ImGuiIO& io = ImGui::GetIO();
  149. if (action == GLFW_PRESS)
  150. io.KeysDown[key] = true;
  151. if (action == GLFW_RELEASE)
  152. io.KeysDown[key] = false;
  153. (void)mods; // Modifiers are not reliable across systems
  154. io.KeyCtrl = io.KeysDown[GLFW_KEY_LEFT_CONTROL] || io.KeysDown[GLFW_KEY_RIGHT_CONTROL];
  155. io.KeyShift = io.KeysDown[GLFW_KEY_LEFT_SHIFT] || io.KeysDown[GLFW_KEY_RIGHT_SHIFT];
  156. io.KeyAlt = io.KeysDown[GLFW_KEY_LEFT_ALT] || io.KeysDown[GLFW_KEY_RIGHT_ALT];
  157. io.KeySuper = io.KeysDown[GLFW_KEY_LEFT_SUPER] || io.KeysDown[GLFW_KEY_RIGHT_SUPER];
  158. }
  159. void ImGui_ImplGlfw_CharCallback(GLFWwindow*, unsigned int c)
  160. {
  161. ImGuiIO& io = ImGui::GetIO();
  162. if (c > 0 && c < 0x10000)
  163. io.AddInputCharacter((unsigned short)c);
  164. }
  165. bool ImGui_ImplGlfwGL2_CreateDeviceObjects()
  166. {
  167. // Build texture atlas
  168. ImGuiIO& io = ImGui::GetIO();
  169. unsigned char* pixels;
  170. int width, height;
  171. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); // Load as RGBA 32-bits (75% of the memory is wasted, but default font is so small) because it is more likely to be compatible with user's existing shaders. If your ImTextureId represent a higher-level concept than just a GL texture id, consider calling GetTexDataAsAlpha8() instead to save on GPU memory.
  172. // Upload texture to graphics system
  173. GLint last_texture;
  174. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  175. glGenTextures(1, &g_FontTexture);
  176. glBindTexture(GL_TEXTURE_2D, g_FontTexture);
  177. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  178. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  179. glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
  180. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
  181. // Store our identifier
  182. io.Fonts->TexID = (void *)(intptr_t)g_FontTexture;
  183. // Restore state
  184. glBindTexture(GL_TEXTURE_2D, last_texture);
  185. return true;
  186. }
  187. void ImGui_ImplGlfwGL2_InvalidateDeviceObjects()
  188. {
  189. if (g_FontTexture)
  190. {
  191. glDeleteTextures(1, &g_FontTexture);
  192. ImGui::GetIO().Fonts->TexID = 0;
  193. g_FontTexture = 0;
  194. }
  195. }
  196. static void ImGui_ImplGlfw_InstallCallbacks(GLFWwindow* window)
  197. {
  198. glfwSetMouseButtonCallback(window, ImGui_ImplGlfw_MouseButtonCallback);
  199. glfwSetScrollCallback(window, ImGui_ImplGlfw_ScrollCallback);
  200. glfwSetKeyCallback(window, ImGui_ImplGlfw_KeyCallback);
  201. glfwSetCharCallback(window, ImGui_ImplGlfw_CharCallback);
  202. }
  203. bool ImGui_ImplGlfwGL2_Init(GLFWwindow* window, bool install_callbacks)
  204. {
  205. g_Window = window;
  206. ImGuiIO& io = ImGui::GetIO();
  207. io.KeyMap[ImGuiKey_Tab] = GLFW_KEY_TAB; // Keyboard mapping. ImGui will use those indices to peek into the io.KeyDown[] array.
  208. io.KeyMap[ImGuiKey_LeftArrow] = GLFW_KEY_LEFT;
  209. io.KeyMap[ImGuiKey_RightArrow] = GLFW_KEY_RIGHT;
  210. io.KeyMap[ImGuiKey_UpArrow] = GLFW_KEY_UP;
  211. io.KeyMap[ImGuiKey_DownArrow] = GLFW_KEY_DOWN;
  212. io.KeyMap[ImGuiKey_PageUp] = GLFW_KEY_PAGE_UP;
  213. io.KeyMap[ImGuiKey_PageDown] = GLFW_KEY_PAGE_DOWN;
  214. io.KeyMap[ImGuiKey_Home] = GLFW_KEY_HOME;
  215. io.KeyMap[ImGuiKey_End] = GLFW_KEY_END;
  216. io.KeyMap[ImGuiKey_Insert] = GLFW_KEY_INSERT;
  217. io.KeyMap[ImGuiKey_Delete] = GLFW_KEY_DELETE;
  218. io.KeyMap[ImGuiKey_Backspace] = GLFW_KEY_BACKSPACE;
  219. io.KeyMap[ImGuiKey_Space] = GLFW_KEY_SPACE;
  220. io.KeyMap[ImGuiKey_Enter] = GLFW_KEY_ENTER;
  221. io.KeyMap[ImGuiKey_Escape] = GLFW_KEY_ESCAPE;
  222. io.KeyMap[ImGuiKey_A] = GLFW_KEY_A;
  223. io.KeyMap[ImGuiKey_C] = GLFW_KEY_C;
  224. io.KeyMap[ImGuiKey_V] = GLFW_KEY_V;
  225. io.KeyMap[ImGuiKey_X] = GLFW_KEY_X;
  226. io.KeyMap[ImGuiKey_Y] = GLFW_KEY_Y;
  227. io.KeyMap[ImGuiKey_Z] = GLFW_KEY_Z;
  228. io.SetClipboardTextFn = ImGui_ImplGlfwGL2_SetClipboardText;
  229. io.GetClipboardTextFn = ImGui_ImplGlfwGL2_GetClipboardText;
  230. io.ClipboardUserData = g_Window;
  231. #ifdef _WIN32
  232. io.ImeWindowHandle = glfwGetWin32Window(g_Window);
  233. #endif
  234. // Load cursors
  235. // FIXME: GLFW doesn't expose suitable cursors for ResizeAll, ResizeNESW, ResizeNWSE. We revert to arrow cursor for those.
  236. g_MouseCursors[ImGuiMouseCursor_Arrow] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  237. g_MouseCursors[ImGuiMouseCursor_TextInput] = glfwCreateStandardCursor(GLFW_IBEAM_CURSOR);
  238. g_MouseCursors[ImGuiMouseCursor_ResizeAll] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  239. g_MouseCursors[ImGuiMouseCursor_ResizeNS] = glfwCreateStandardCursor(GLFW_VRESIZE_CURSOR);
  240. g_MouseCursors[ImGuiMouseCursor_ResizeEW] = glfwCreateStandardCursor(GLFW_HRESIZE_CURSOR);
  241. g_MouseCursors[ImGuiMouseCursor_ResizeNESW] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  242. g_MouseCursors[ImGuiMouseCursor_ResizeNWSE] = glfwCreateStandardCursor(GLFW_ARROW_CURSOR);
  243. if (install_callbacks)
  244. ImGui_ImplGlfw_InstallCallbacks(window);
  245. return true;
  246. }
  247. void ImGui_ImplGlfwGL2_Shutdown()
  248. {
  249. // Destroy GLFW mouse cursors
  250. for (ImGuiMouseCursor cursor_n = 0; cursor_n < ImGuiMouseCursor_Count_; cursor_n++)
  251. glfwDestroyCursor(g_MouseCursors[cursor_n]);
  252. memset(g_MouseCursors, 0, sizeof(g_MouseCursors));
  253. // Destroy OpenGL objects
  254. ImGui_ImplGlfwGL2_InvalidateDeviceObjects();
  255. }
  256. void ImGui_ImplGlfwGL2_NewFrame()
  257. {
  258. if (!g_FontTexture)
  259. ImGui_ImplGlfwGL2_CreateDeviceObjects();
  260. ImGuiIO& io = ImGui::GetIO();
  261. // Setup display size (every frame to accommodate for window resizing)
  262. int w, h;
  263. int display_w, display_h;
  264. glfwGetWindowSize(g_Window, &w, &h);
  265. glfwGetFramebufferSize(g_Window, &display_w, &display_h);
  266. io.DisplaySize = ImVec2((float)w, (float)h);
  267. io.DisplayFramebufferScale = ImVec2(w > 0 ? ((float)display_w / w) : 0, h > 0 ? ((float)display_h / h) : 0);
  268. // Setup time step
  269. double current_time = glfwGetTime();
  270. io.DeltaTime = g_Time > 0.0 ? (float)(current_time - g_Time) : (float)(1.0f/60.0f);
  271. g_Time = current_time;
  272. // Setup inputs
  273. // (we already got mouse wheel, keyboard keys & characters from glfw callbacks polled in glfwPollEvents())
  274. if (glfwGetWindowAttrib(g_Window, GLFW_FOCUSED))
  275. {
  276. if (io.WantMoveMouse)
  277. {
  278. glfwSetCursorPos(g_Window, (double)io.MousePos.x, (double)io.MousePos.y); // Set mouse position if requested by io.WantMoveMouse flag (used when io.NavMovesTrue is enabled by user and using directional navigation)
  279. }
  280. else
  281. {
  282. double mouse_x, mouse_y;
  283. glfwGetCursorPos(g_Window, &mouse_x, &mouse_y);
  284. io.MousePos = ImVec2((float)mouse_x, (float)mouse_y);
  285. }
  286. }
  287. else
  288. {
  289. io.MousePos = ImVec2(-FLT_MAX,-FLT_MAX);
  290. }
  291. for (int i = 0; i < 3; i++)
  292. {
  293. // If a mouse press event came, always pass it as "mouse held this frame", so we don't miss click-release events that are shorter than 1 frame.
  294. io.MouseDown[i] = g_MouseJustPressed[i] || glfwGetMouseButton(g_Window, i) != 0;
  295. g_MouseJustPressed[i] = false;
  296. }
  297. // Update OS/hardware mouse cursor if imgui isn't drawing a software cursor
  298. ImGuiMouseCursor cursor = ImGui::GetMouseCursor();
  299. if (io.MouseDrawCursor || cursor == ImGuiMouseCursor_None)
  300. {
  301. glfwSetInputMode(g_Window, GLFW_CURSOR, GLFW_CURSOR_HIDDEN);
  302. }
  303. else
  304. {
  305. glfwSetCursor(g_Window, g_MouseCursors[cursor] ? g_MouseCursors[cursor] : g_MouseCursors[ImGuiMouseCursor_Arrow]);
  306. glfwSetInputMode(g_Window, GLFW_CURSOR, GLFW_CURSOR_NORMAL);
  307. }
  308. // Start the frame. This call will update the io.WantCaptureMouse, io.WantCaptureKeyboard flag that you can use to dispatch inputs (or not) to your application.
  309. ImGui::NewFrame();
  310. }