imgui_impl_opengl2.cpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  1. // dear imgui: Renderer for OpenGL2 (legacy OpenGL, fixed pipeline)
  2. // This needs to be used along with a Platform Binding (e.g. GLFW, SDL, Win32, custom..)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID in imgui.cpp.
  5. // [X] Renderer: Multi-viewport support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  6. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  7. // If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
  8. // https://github.com/ocornut/imgui
  9. // **DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
  10. // **Prefer using the code in imgui_impl_opengl3.cpp**
  11. // This code is mostly provided as a reference to learn how ImGui integration works, because it is shorter to read.
  12. // If your code is using GL3+ context or any semi modern OpenGL calls, using this is likely to make everything more
  13. // complicated, will require your code to reset every single OpenGL attributes to their initial state, and might
  14. // confuse your GPU driver.
  15. // The GL2 code is unable to reset attributes or even call e.g. "glUseProgram(0)" because they don't exist in that API.
  16. // CHANGELOG
  17. // (minor and older changes stripped away, please see git history for details)
  18. // 2018-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  19. // 2018-08-03: OpenGL: Disabling/restoring GL_LIGHTING and GL_COLOR_MATERIAL to increase compatibility with legacy OpenGL applications.
  20. // 2018-06-08: Misc: Extracted imgui_impl_opengl2.cpp/.h away from the old combined GLFW/SDL+OpenGL2 examples.
  21. // 2018-06-08: OpenGL: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  22. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplGlfwGL2_RenderDrawData() in the .h file so you can call it yourself.
  23. // 2017-09-01: OpenGL: Save and restore current polygon mode.
  24. // 2016-09-10: OpenGL: Uploading font texture as RGBA32 to increase compatibility with users shaders (not ideal).
  25. // 2016-09-05: OpenGL: Fixed save and restore of current scissor rectangle.
  26. #include "imgui.h"
  27. #include "imgui_impl_opengl2.h"
  28. #if defined(_MSC_VER) && _MSC_VER <= 1500 // MSVC 2008 or earlier
  29. #include <stddef.h> // intptr_t
  30. #else
  31. #include <stdint.h> // intptr_t
  32. #endif
  33. // Include OpenGL header (without an OpenGL loader) requires a bit of fiddling
  34. #if defined(_WIN32) && !defined(APIENTRY)
  35. #define APIENTRY __stdcall // It is customary to use APIENTRY for OpenGL function pointer declarations on all platforms. Additionally, the Windows OpenGL header needs APIENTRY.
  36. #endif
  37. #if defined(_WIN32) && !defined(WINGDIAPI)
  38. #define WINGDIAPI __declspec(dllimport) // Some Windows OpenGL headers need this
  39. #endif
  40. #if defined(__APPLE__)
  41. #include <OpenGL/gl.h>
  42. #else
  43. #include <GL/gl.h>
  44. #endif
  45. // OpenGL Data
  46. static GLuint g_FontTexture = 0;
  47. // Forward Declarations
  48. static void ImGui_ImplOpenGL2_InitPlatformInterface();
  49. static void ImGui_ImplOpenGL2_ShutdownPlatformInterface();
  50. // Functions
  51. bool ImGui_ImplOpenGL2_Init()
  52. {
  53. // Setup back-end capabilities flags
  54. ImGuiIO& io = ImGui::GetIO();
  55. io.BackendFlags |= ImGuiBackendFlags_RendererHasViewports; // We can create multi-viewports on the Renderer side (optional)
  56. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  57. ImGui_ImplOpenGL2_InitPlatformInterface();
  58. return true;
  59. }
  60. void ImGui_ImplOpenGL2_Shutdown()
  61. {
  62. ImGui_ImplOpenGL2_ShutdownPlatformInterface();
  63. ImGui_ImplOpenGL2_DestroyDeviceObjects();
  64. }
  65. void ImGui_ImplOpenGL2_NewFrame()
  66. {
  67. if (!g_FontTexture)
  68. ImGui_ImplOpenGL2_CreateDeviceObjects();
  69. }
  70. // OpenGL2 Render function.
  71. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  72. // 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.
  73. void ImGui_ImplOpenGL2_RenderDrawData(ImDrawData* draw_data)
  74. {
  75. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  76. ImGuiIO& io = ImGui::GetIO();
  77. int fb_width = (int)(draw_data->DisplaySize.x * io.DisplayFramebufferScale.x);
  78. int fb_height = (int)(draw_data->DisplaySize.y * io.DisplayFramebufferScale.y);
  79. if (fb_width == 0 || fb_height == 0)
  80. return;
  81. draw_data->ScaleClipRects(io.DisplayFramebufferScale);
  82. // We are using the OpenGL fixed pipeline to make the example code simpler to read!
  83. // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, vertex/texcoord/color pointers, polygon fill.
  84. GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  85. GLint last_polygon_mode[2]; glGetIntegerv(GL_POLYGON_MODE, last_polygon_mode);
  86. GLint last_viewport[4]; glGetIntegerv(GL_VIEWPORT, last_viewport);
  87. GLint last_scissor_box[4]; glGetIntegerv(GL_SCISSOR_BOX, last_scissor_box);
  88. glPushAttrib(GL_ENABLE_BIT | GL_COLOR_BUFFER_BIT | GL_TRANSFORM_BIT);
  89. glEnable(GL_BLEND);
  90. glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
  91. glDisable(GL_CULL_FACE);
  92. glDisable(GL_DEPTH_TEST);
  93. glDisable(GL_LIGHTING);
  94. glDisable(GL_COLOR_MATERIAL);
  95. glEnable(GL_SCISSOR_TEST);
  96. glEnableClientState(GL_VERTEX_ARRAY);
  97. glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  98. glEnableClientState(GL_COLOR_ARRAY);
  99. glEnable(GL_TEXTURE_2D);
  100. glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
  101. //glUseProgram(0); // You may want this if using this code in an OpenGL 3+ context where shaders may be bound
  102. // Setup viewport, orthographic projection matrix
  103. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin is (0,0) for single viewport apps.
  104. glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
  105. glMatrixMode(GL_PROJECTION);
  106. glPushMatrix();
  107. glLoadIdentity();
  108. glOrtho(draw_data->DisplayPos.x, draw_data->DisplayPos.x + draw_data->DisplaySize.x, draw_data->DisplayPos.y + draw_data->DisplaySize.y, draw_data->DisplayPos.y, -1.0f, +1.0f);
  109. glMatrixMode(GL_MODELVIEW);
  110. glPushMatrix();
  111. glLoadIdentity();
  112. // Render command lists
  113. ImVec2 pos = draw_data->DisplayPos;
  114. for (int n = 0; n < draw_data->CmdListsCount; n++)
  115. {
  116. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  117. const ImDrawVert* vtx_buffer = cmd_list->VtxBuffer.Data;
  118. const ImDrawIdx* idx_buffer = cmd_list->IdxBuffer.Data;
  119. glVertexPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, pos)));
  120. glTexCoordPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, uv)));
  121. glColorPointer(4, GL_UNSIGNED_BYTE, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, col)));
  122. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  123. {
  124. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  125. if (pcmd->UserCallback)
  126. {
  127. // User callback (registered via ImDrawList::AddCallback)
  128. pcmd->UserCallback(cmd_list, pcmd);
  129. }
  130. else
  131. {
  132. ImVec4 clip_rect = ImVec4(pcmd->ClipRect.x - pos.x, pcmd->ClipRect.y - pos.y, pcmd->ClipRect.z - pos.x, pcmd->ClipRect.w - pos.y);
  133. if (clip_rect.x < fb_width && clip_rect.y < fb_height && clip_rect.z >= 0.0f && clip_rect.w >= 0.0f)
  134. {
  135. // Apply scissor/clipping rectangle
  136. glScissor((int)clip_rect.x, (int)(fb_height - clip_rect.w), (int)(clip_rect.z - clip_rect.x), (int)(clip_rect.w - clip_rect.y));
  137. // Bind texture, Draw
  138. glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->TextureId);
  139. glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer);
  140. }
  141. }
  142. idx_buffer += pcmd->ElemCount;
  143. }
  144. }
  145. // Restore modified state
  146. glDisableClientState(GL_COLOR_ARRAY);
  147. glDisableClientState(GL_TEXTURE_COORD_ARRAY);
  148. glDisableClientState(GL_VERTEX_ARRAY);
  149. glBindTexture(GL_TEXTURE_2D, (GLuint)last_texture);
  150. glMatrixMode(GL_MODELVIEW);
  151. glPopMatrix();
  152. glMatrixMode(GL_PROJECTION);
  153. glPopMatrix();
  154. glPopAttrib();
  155. glPolygonMode(GL_FRONT, (GLenum)last_polygon_mode[0]); glPolygonMode(GL_BACK, (GLenum)last_polygon_mode[1]);
  156. glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
  157. glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
  158. }
  159. bool ImGui_ImplOpenGL2_CreateFontsTexture()
  160. {
  161. // Build texture atlas
  162. ImGuiIO& io = ImGui::GetIO();
  163. unsigned char* pixels;
  164. int width, height;
  165. 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.
  166. // Upload texture to graphics system
  167. GLint last_texture;
  168. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  169. glGenTextures(1, &g_FontTexture);
  170. glBindTexture(GL_TEXTURE_2D, g_FontTexture);
  171. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  172. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  173. glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
  174. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
  175. // Store our identifier
  176. io.Fonts->TexID = (ImTextureID)(intptr_t)g_FontTexture;
  177. // Restore state
  178. glBindTexture(GL_TEXTURE_2D, last_texture);
  179. return true;
  180. }
  181. void ImGui_ImplOpenGL2_DestroyFontsTexture()
  182. {
  183. if (g_FontTexture)
  184. {
  185. ImGuiIO& io = ImGui::GetIO();
  186. glDeleteTextures(1, &g_FontTexture);
  187. io.Fonts->TexID = 0;
  188. g_FontTexture = 0;
  189. }
  190. }
  191. bool ImGui_ImplOpenGL2_CreateDeviceObjects()
  192. {
  193. return ImGui_ImplOpenGL2_CreateFontsTexture();
  194. }
  195. void ImGui_ImplOpenGL2_DestroyDeviceObjects()
  196. {
  197. ImGui_ImplOpenGL2_DestroyFontsTexture();
  198. }
  199. //--------------------------------------------------------------------------------------------------------
  200. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  201. // This is an _advanced_ and _optional_ feature, allowing the back-end to create and handle multiple viewports simultaneously.
  202. // If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you completely ignore this section first..
  203. //--------------------------------------------------------------------------------------------------------
  204. static void ImGui_ImplOpenGL2_RenderWindow(ImGuiViewport* viewport, void*)
  205. {
  206. if (!(viewport->Flags & ImGuiViewportFlags_NoRendererClear))
  207. {
  208. ImVec4 clear_color = ImVec4(0.0f, 0.0f, 0.0f, 1.0f);
  209. glClearColor(clear_color.x, clear_color.y, clear_color.z, clear_color.w);
  210. glClear(GL_COLOR_BUFFER_BIT);
  211. }
  212. ImGui_ImplOpenGL2_RenderDrawData(viewport->DrawData);
  213. }
  214. static void ImGui_ImplOpenGL2_InitPlatformInterface()
  215. {
  216. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  217. platform_io.Renderer_RenderWindow = ImGui_ImplOpenGL2_RenderWindow;
  218. }
  219. static void ImGui_ImplOpenGL2_ShutdownPlatformInterface()
  220. {
  221. ImGui::DestroyPlatformWindows();
  222. }