imgui_impl_opengl2.cpp 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  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. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  6. // If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
  7. // https://github.com/ocornut/imgui
  8. // **DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
  9. // **Prefer using the code in imgui_impl_opengl3.cpp**
  10. // This code is mostly provided as a reference to learn how ImGui integration works, because it is shorter to read.
  11. // If your code is using GL3+ context or any semi modern OpenGL calls, using this is likely to make everything more
  12. // complicated, will require your code to reset every single OpenGL attributes to their initial state, and might
  13. // confuse your GPU driver.
  14. // The GL2 code is unable to reset attributes or even call e.g. "glUseProgram(0)" because they don't exist in that API.
  15. // CHANGELOG
  16. // (minor and older changes stripped away, please see git history for details)
  17. // 2019-02-11: OpenGL: Projecting clipping rectangles correctly using draw_data->FramebufferScale to allow multi-viewports for retina display.
  18. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  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. // Functions
  48. bool ImGui_ImplOpenGL2_Init()
  49. {
  50. ImGuiIO& io = ImGui::GetIO();
  51. io.BackendRendererName = "imgui_impl_opengl2";
  52. return true;
  53. }
  54. void ImGui_ImplOpenGL2_Shutdown()
  55. {
  56. ImGui_ImplOpenGL2_DestroyDeviceObjects();
  57. }
  58. void ImGui_ImplOpenGL2_NewFrame()
  59. {
  60. if (!g_FontTexture)
  61. ImGui_ImplOpenGL2_CreateDeviceObjects();
  62. }
  63. // OpenGL2 Render function.
  64. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  65. // 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.
  66. void ImGui_ImplOpenGL2_RenderDrawData(ImDrawData* draw_data)
  67. {
  68. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  69. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  70. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  71. if (fb_width == 0 || fb_height == 0)
  72. return;
  73. // We are using the OpenGL fixed pipeline to make the example code simpler to read!
  74. // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, vertex/texcoord/color pointers, polygon fill.
  75. GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  76. GLint last_polygon_mode[2]; glGetIntegerv(GL_POLYGON_MODE, last_polygon_mode);
  77. GLint last_viewport[4]; glGetIntegerv(GL_VIEWPORT, last_viewport);
  78. GLint last_scissor_box[4]; glGetIntegerv(GL_SCISSOR_BOX, last_scissor_box);
  79. glPushAttrib(GL_ENABLE_BIT | GL_COLOR_BUFFER_BIT | GL_TRANSFORM_BIT);
  80. glEnable(GL_BLEND);
  81. glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
  82. glDisable(GL_CULL_FACE);
  83. glDisable(GL_DEPTH_TEST);
  84. glDisable(GL_LIGHTING);
  85. glDisable(GL_COLOR_MATERIAL);
  86. glEnable(GL_SCISSOR_TEST);
  87. glEnableClientState(GL_VERTEX_ARRAY);
  88. glEnableClientState(GL_TEXTURE_COORD_ARRAY);
  89. glEnableClientState(GL_COLOR_ARRAY);
  90. glEnable(GL_TEXTURE_2D);
  91. glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
  92. // If you are using this code with non-legacy OpenGL header/contexts (which you should not, prefer using imgui_impl_opengl3.cpp!!),
  93. // you may need to backup/reset/restore current shader using the lines below. DO NOT MODIFY THIS FILE! Add the code in your calling function:
  94. // GLint last_program;
  95. // glGetIntegerv(GL_CURRENT_PROGRAM, &last_program);
  96. // glUseProgram(0);
  97. // ImGui_ImplOpenGL2_RenderDrawData(...);
  98. // glUseProgram(last_program)
  99. // Setup viewport, orthographic projection matrix
  100. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin is typically (0,0) for single viewport apps.
  101. glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
  102. glMatrixMode(GL_PROJECTION);
  103. glPushMatrix();
  104. glLoadIdentity();
  105. 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);
  106. glMatrixMode(GL_MODELVIEW);
  107. glPushMatrix();
  108. glLoadIdentity();
  109. // Will project scissor/clipping rectangles into framebuffer space
  110. ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
  111. ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
  112. // Render command lists
  113. for (int n = 0; n < draw_data->CmdListsCount; n++)
  114. {
  115. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  116. const ImDrawVert* vtx_buffer = cmd_list->VtxBuffer.Data;
  117. const ImDrawIdx* idx_buffer = cmd_list->IdxBuffer.Data;
  118. glVertexPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, pos)));
  119. glTexCoordPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, uv)));
  120. glColorPointer(4, GL_UNSIGNED_BYTE, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + IM_OFFSETOF(ImDrawVert, col)));
  121. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  122. {
  123. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  124. if (pcmd->UserCallback)
  125. {
  126. // User callback (registered via ImDrawList::AddCallback)
  127. pcmd->UserCallback(cmd_list, pcmd);
  128. }
  129. else
  130. {
  131. // Project scissor/clipping rectangles into framebuffer space
  132. ImVec4 clip_rect;
  133. clip_rect.x = (pcmd->ClipRect.x - clip_off.x) * clip_scale.x;
  134. clip_rect.y = (pcmd->ClipRect.y - clip_off.y) * clip_scale.y;
  135. clip_rect.z = (pcmd->ClipRect.z - clip_off.x) * clip_scale.x;
  136. clip_rect.w = (pcmd->ClipRect.w - clip_off.y) * clip_scale.y;
  137. if (clip_rect.x < fb_width && clip_rect.y < fb_height && clip_rect.z >= 0.0f && clip_rect.w >= 0.0f)
  138. {
  139. // Apply scissor/clipping rectangle
  140. 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));
  141. // Bind texture, Draw
  142. glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->TextureId);
  143. glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer);
  144. }
  145. }
  146. idx_buffer += pcmd->ElemCount;
  147. }
  148. }
  149. // Restore modified state
  150. glDisableClientState(GL_COLOR_ARRAY);
  151. glDisableClientState(GL_TEXTURE_COORD_ARRAY);
  152. glDisableClientState(GL_VERTEX_ARRAY);
  153. glBindTexture(GL_TEXTURE_2D, (GLuint)last_texture);
  154. glMatrixMode(GL_MODELVIEW);
  155. glPopMatrix();
  156. glMatrixMode(GL_PROJECTION);
  157. glPopMatrix();
  158. glPopAttrib();
  159. glPolygonMode(GL_FRONT, (GLenum)last_polygon_mode[0]); glPolygonMode(GL_BACK, (GLenum)last_polygon_mode[1]);
  160. glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
  161. glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
  162. }
  163. bool ImGui_ImplOpenGL2_CreateFontsTexture()
  164. {
  165. // Build texture atlas
  166. ImGuiIO& io = ImGui::GetIO();
  167. unsigned char* pixels;
  168. int width, height;
  169. 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.
  170. // Upload texture to graphics system
  171. GLint last_texture;
  172. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  173. glGenTextures(1, &g_FontTexture);
  174. glBindTexture(GL_TEXTURE_2D, g_FontTexture);
  175. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  176. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  177. glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
  178. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
  179. // Store our identifier
  180. io.Fonts->TexID = (ImTextureID)(intptr_t)g_FontTexture;
  181. // Restore state
  182. glBindTexture(GL_TEXTURE_2D, last_texture);
  183. return true;
  184. }
  185. void ImGui_ImplOpenGL2_DestroyFontsTexture()
  186. {
  187. if (g_FontTexture)
  188. {
  189. ImGuiIO& io = ImGui::GetIO();
  190. glDeleteTextures(1, &g_FontTexture);
  191. io.Fonts->TexID = 0;
  192. g_FontTexture = 0;
  193. }
  194. }
  195. bool ImGui_ImplOpenGL2_CreateDeviceObjects()
  196. {
  197. return ImGui_ImplOpenGL2_CreateFontsTexture();
  198. }
  199. void ImGui_ImplOpenGL2_DestroyDeviceObjects()
  200. {
  201. ImGui_ImplOpenGL2_DestroyFontsTexture();
  202. }