imgui_impl_opengl3.cpp 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. // ImGui Renderer for: OpenGL3 (modern OpenGL with shaders / programmatic pipeline)
  2. // This needs to be used along with a Platform Binding (e.g. GLFW, SDL, Win32, custom..)
  3. // (Note: We are using GL3W as a helper library to access OpenGL functions since there is no standard header to access modern OpenGL functions easily. Alternatives are GLEW, Glad, etc..)
  4. // Implemented features:
  5. // [X] User texture binding. Use 'GLUint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID in imgui.cpp.
  6. // [X] Multi-viewport rendering (when ImGuiConfigFlags_ViewportsEnable is enabled).
  7. // CHANGELOG
  8. // (minor and older changes stripped away, please see git history for details)
  9. // 2018-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  10. // 2018-06-08: Misc: Extracted imgui_impl_opengl3.cpp/.h away from the old combined GLFW/SDL+OpenGL3 examples.
  11. // 2018-06-08: OpenGL: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  12. // 2018-05-25: OpenGL: Removed unnecessary backup/restore of GL_ELEMENT_ARRAY_BUFFER_BINDING since this is part of the VAO state.
  13. // 2018-05-14: OpenGL: Making the call to glBindSampler() optional so 3.2 context won't fail if the function is a NULL pointer.
  14. // 2018-03-06: OpenGL: Added const char* glsl_version parameter to ImGui_ImplOpenGL3_Init() so user can override the GLSL version e.g. "#version 150".
  15. // 2018-02-23: OpenGL: Create the VAO in the render function so the setup can more easily be used with multiple shared GL context.
  16. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplSdlGL3_RenderDrawData() in the .h file so you can call it yourself.
  17. // 2018-01-07: OpenGL: Changed GLSL shader version from 330 to 150.
  18. // 2017-09-01: OpenGL: Save and restore current bound sampler. Save and restore current polygon mode.
  19. // 2017-05-01: OpenGL: Fixed save and restore of current blend func state.
  20. // 2017-05-01: OpenGL: Fixed save and restore of current GL_ACTIVE_TEXTURE.
  21. // 2016-09-05: OpenGL: Fixed save and restore of current scissor rectangle.
  22. // 2016-07-29: OpenGL: Explicitly setting GL_UNPACK_ROW_LENGTH to reduce issues because SDL changes it. (#752)
  23. #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
  24. #define _CRT_SECURE_NO_WARNINGS
  25. #endif
  26. #include "imgui.h"
  27. #include "imgui_impl_opengl3.h"
  28. #include <GL/gl3w.h> // This example is using gl3w to access OpenGL functions (because it is small). You may use glew/glad/glLoadGen/etc. whatever already works for you.
  29. // OpenGL Data
  30. static char g_GlslVersion[32] = "#version 150";
  31. static GLuint g_FontTexture = 0;
  32. static int g_ShaderHandle = 0, g_VertHandle = 0, g_FragHandle = 0;
  33. static int g_AttribLocationTex = 0, g_AttribLocationProjMtx = 0;
  34. static int g_AttribLocationPosition = 0, g_AttribLocationUV = 0, g_AttribLocationColor = 0;
  35. static unsigned int g_VboHandle = 0, g_ElementsHandle = 0;
  36. // Forward Declarations
  37. static void ImGui_ImplOpenGL3_InitPlatformInterface();
  38. static void ImGui_ImplOpenGL3_ShutdownPlatformInterface();
  39. // Functions
  40. bool ImGui_ImplOpenGL3_Init(const char* glsl_version)
  41. {
  42. // Store GLSL version string so we can refer to it later in case we recreate shaders. Note: GLSL version is NOT the same as GL version. Leave this to NULL if unsure.
  43. if (glsl_version == NULL)
  44. glsl_version = "#version 150";
  45. IM_ASSERT((int)strlen(glsl_version) + 2 < IM_ARRAYSIZE(g_GlslVersion));
  46. strcpy(g_GlslVersion, glsl_version);
  47. strcat(g_GlslVersion, "\n");
  48. // Setup back-end capabilities flags
  49. ImGuiIO& io = ImGui::GetIO();
  50. io.BackendFlags |= ImGuiBackendFlags_RendererHasViewports; // We can create multi-viewports on the Renderer side (optional)
  51. if (io.ConfigFlags & ImGuiConfigFlags_ViewportsEnable)
  52. ImGui_ImplOpenGL3_InitPlatformInterface();
  53. return true;
  54. }
  55. void ImGui_ImplOpenGL3_Shutdown()
  56. {
  57. ImGui_ImplOpenGL3_ShutdownPlatformInterface();
  58. ImGui_ImplOpenGL3_DestroyDeviceObjects();
  59. }
  60. void ImGui_ImplOpenGL3_NewFrame()
  61. {
  62. if (!g_FontTexture)
  63. ImGui_ImplOpenGL3_CreateDeviceObjects();
  64. }
  65. // OpenGL3 Render function.
  66. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  67. // 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.
  68. void ImGui_ImplOpenGL3_RenderDrawData(ImDrawData* draw_data)
  69. {
  70. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  71. ImGuiIO& io = ImGui::GetIO();
  72. int fb_width = (int)(draw_data->DisplaySize.x * io.DisplayFramebufferScale.x);
  73. int fb_height = (int)(draw_data->DisplaySize.y * io.DisplayFramebufferScale.y);
  74. if (fb_width <= 0 || fb_height <= 0)
  75. return;
  76. draw_data->ScaleClipRects(io.DisplayFramebufferScale);
  77. // Backup GL state
  78. GLenum last_active_texture; glGetIntegerv(GL_ACTIVE_TEXTURE, (GLint*)&last_active_texture);
  79. glActiveTexture(GL_TEXTURE0);
  80. GLint last_program; glGetIntegerv(GL_CURRENT_PROGRAM, &last_program);
  81. GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  82. GLint last_sampler; glGetIntegerv(GL_SAMPLER_BINDING, &last_sampler);
  83. GLint last_array_buffer; glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &last_array_buffer);
  84. GLint last_vertex_array; glGetIntegerv(GL_VERTEX_ARRAY_BINDING, &last_vertex_array);
  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. GLenum last_blend_src_rgb; glGetIntegerv(GL_BLEND_SRC_RGB, (GLint*)&last_blend_src_rgb);
  89. GLenum last_blend_dst_rgb; glGetIntegerv(GL_BLEND_DST_RGB, (GLint*)&last_blend_dst_rgb);
  90. GLenum last_blend_src_alpha; glGetIntegerv(GL_BLEND_SRC_ALPHA, (GLint*)&last_blend_src_alpha);
  91. GLenum last_blend_dst_alpha; glGetIntegerv(GL_BLEND_DST_ALPHA, (GLint*)&last_blend_dst_alpha);
  92. GLenum last_blend_equation_rgb; glGetIntegerv(GL_BLEND_EQUATION_RGB, (GLint*)&last_blend_equation_rgb);
  93. GLenum last_blend_equation_alpha; glGetIntegerv(GL_BLEND_EQUATION_ALPHA, (GLint*)&last_blend_equation_alpha);
  94. GLboolean last_enable_blend = glIsEnabled(GL_BLEND);
  95. GLboolean last_enable_cull_face = glIsEnabled(GL_CULL_FACE);
  96. GLboolean last_enable_depth_test = glIsEnabled(GL_DEPTH_TEST);
  97. GLboolean last_enable_scissor_test = glIsEnabled(GL_SCISSOR_TEST);
  98. // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, polygon fill
  99. glEnable(GL_BLEND);
  100. glBlendEquation(GL_FUNC_ADD);
  101. glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
  102. glDisable(GL_CULL_FACE);
  103. glDisable(GL_DEPTH_TEST);
  104. glEnable(GL_SCISSOR_TEST);
  105. glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
  106. // Setup viewport, orthographic projection matrix
  107. // 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.
  108. glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
  109. float L = draw_data->DisplayPos.x;
  110. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  111. float T = draw_data->DisplayPos.y;
  112. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  113. const float ortho_projection[4][4] =
  114. {
  115. { 2.0f/(R-L), 0.0f, 0.0f, 0.0f },
  116. { 0.0f, 2.0f/(T-B), 0.0f, 0.0f },
  117. { 0.0f, 0.0f, -1.0f, 0.0f },
  118. { (R+L)/(L-R), (T+B)/(B-T), 0.0f, 1.0f },
  119. };
  120. glUseProgram(g_ShaderHandle);
  121. glUniform1i(g_AttribLocationTex, 0);
  122. glUniformMatrix4fv(g_AttribLocationProjMtx, 1, GL_FALSE, &ortho_projection[0][0]);
  123. if (glBindSampler) glBindSampler(0, 0); // We use combined texture/sampler state. Applications using GL 3.3 may set that otherwise.
  124. // Recreate the VAO every time
  125. // (This is to easily allow multiple GL contexts. VAO are not shared among GL contexts, and we don't track creation/deletion of windows so we don't have an obvious key to use to cache them.)
  126. GLuint vao_handle = 0;
  127. glGenVertexArrays(1, &vao_handle);
  128. glBindVertexArray(vao_handle);
  129. glBindBuffer(GL_ARRAY_BUFFER, g_VboHandle);
  130. glEnableVertexAttribArray(g_AttribLocationPosition);
  131. glEnableVertexAttribArray(g_AttribLocationUV);
  132. glEnableVertexAttribArray(g_AttribLocationColor);
  133. glVertexAttribPointer(g_AttribLocationPosition, 2, GL_FLOAT, GL_FALSE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, pos));
  134. glVertexAttribPointer(g_AttribLocationUV, 2, GL_FLOAT, GL_FALSE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, uv));
  135. glVertexAttribPointer(g_AttribLocationColor, 4, GL_UNSIGNED_BYTE, GL_TRUE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, col));
  136. // Draw
  137. ImVec2 pos = draw_data->DisplayPos;
  138. for (int n = 0; n < draw_data->CmdListsCount; n++)
  139. {
  140. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  141. const ImDrawIdx* idx_buffer_offset = 0;
  142. glBindBuffer(GL_ARRAY_BUFFER, g_VboHandle);
  143. glBufferData(GL_ARRAY_BUFFER, (GLsizeiptr)cmd_list->VtxBuffer.Size * sizeof(ImDrawVert), (const GLvoid*)cmd_list->VtxBuffer.Data, GL_STREAM_DRAW);
  144. glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, g_ElementsHandle);
  145. glBufferData(GL_ELEMENT_ARRAY_BUFFER, (GLsizeiptr)cmd_list->IdxBuffer.Size * sizeof(ImDrawIdx), (const GLvoid*)cmd_list->IdxBuffer.Data, GL_STREAM_DRAW);
  146. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  147. {
  148. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  149. if (pcmd->UserCallback)
  150. {
  151. // User callback (registered via ImDrawList::AddCallback)
  152. pcmd->UserCallback(cmd_list, pcmd);
  153. }
  154. else
  155. {
  156. ImVec4 clip_rect = ImVec4(pcmd->ClipRect.x - pos.x, pcmd->ClipRect.y - pos.y, pcmd->ClipRect.z - pos.x, pcmd->ClipRect.w - pos.y);
  157. if (clip_rect.x < fb_width && clip_rect.y < fb_height && clip_rect.z >= 0.0f && clip_rect.w >= 0.0f)
  158. {
  159. // Apply scissor/clipping rectangle
  160. 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));
  161. // Bind texture, Draw
  162. glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->TextureId);
  163. glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer_offset);
  164. }
  165. }
  166. idx_buffer_offset += pcmd->ElemCount;
  167. }
  168. }
  169. glDeleteVertexArrays(1, &vao_handle);
  170. // Restore modified GL state
  171. glUseProgram(last_program);
  172. glBindTexture(GL_TEXTURE_2D, last_texture);
  173. if (glBindSampler) glBindSampler(0, last_sampler);
  174. glActiveTexture(last_active_texture);
  175. glBindVertexArray(last_vertex_array);
  176. glBindBuffer(GL_ARRAY_BUFFER, last_array_buffer);
  177. glBlendEquationSeparate(last_blend_equation_rgb, last_blend_equation_alpha);
  178. glBlendFuncSeparate(last_blend_src_rgb, last_blend_dst_rgb, last_blend_src_alpha, last_blend_dst_alpha);
  179. if (last_enable_blend) glEnable(GL_BLEND); else glDisable(GL_BLEND);
  180. if (last_enable_cull_face) glEnable(GL_CULL_FACE); else glDisable(GL_CULL_FACE);
  181. if (last_enable_depth_test) glEnable(GL_DEPTH_TEST); else glDisable(GL_DEPTH_TEST);
  182. if (last_enable_scissor_test) glEnable(GL_SCISSOR_TEST); else glDisable(GL_SCISSOR_TEST);
  183. glPolygonMode(GL_FRONT_AND_BACK, (GLenum)last_polygon_mode[0]);
  184. glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
  185. glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
  186. }
  187. bool ImGui_ImplOpenGL3_CreateFontsTexture()
  188. {
  189. // Build texture atlas
  190. ImGuiIO& io = ImGui::GetIO();
  191. unsigned char* pixels;
  192. int width, height;
  193. 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.
  194. // Upload texture to graphics system
  195. GLint last_texture;
  196. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  197. glGenTextures(1, &g_FontTexture);
  198. glBindTexture(GL_TEXTURE_2D, g_FontTexture);
  199. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  200. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  201. glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
  202. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
  203. // Store our identifier
  204. io.Fonts->TexID = (void *)(intptr_t)g_FontTexture;
  205. // Restore state
  206. glBindTexture(GL_TEXTURE_2D, last_texture);
  207. return true;
  208. }
  209. void ImGui_ImplOpenGL3_DestroyFontsTexture()
  210. {
  211. if (g_FontTexture)
  212. {
  213. ImGuiIO& io = ImGui::GetIO();
  214. glDeleteTextures(1, &g_FontTexture);
  215. io.Fonts->TexID = 0;
  216. g_FontTexture = 0;
  217. }
  218. }
  219. bool ImGui_ImplOpenGL3_CreateDeviceObjects()
  220. {
  221. // Backup GL state
  222. GLint last_texture, last_array_buffer, last_vertex_array;
  223. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  224. glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &last_array_buffer);
  225. glGetIntegerv(GL_VERTEX_ARRAY_BINDING, &last_vertex_array);
  226. // Create shaders
  227. const GLchar *vertex_shader =
  228. "uniform mat4 ProjMtx;\n"
  229. "in vec2 Position;\n"
  230. "in vec2 UV;\n"
  231. "in vec4 Color;\n"
  232. "out vec2 Frag_UV;\n"
  233. "out vec4 Frag_Color;\n"
  234. "void main()\n"
  235. "{\n"
  236. " Frag_UV = UV;\n"
  237. " Frag_Color = Color;\n"
  238. " gl_Position = ProjMtx * vec4(Position.xy,0,1);\n"
  239. "}\n";
  240. const GLchar* fragment_shader =
  241. "uniform sampler2D Texture;\n"
  242. "in vec2 Frag_UV;\n"
  243. "in vec4 Frag_Color;\n"
  244. "out vec4 Out_Color;\n"
  245. "void main()\n"
  246. "{\n"
  247. " Out_Color = Frag_Color * texture( Texture, Frag_UV.st);\n"
  248. "}\n";
  249. const GLchar* vertex_shader_with_version[2] = { g_GlslVersion, vertex_shader };
  250. const GLchar* fragment_shader_with_version[2] = { g_GlslVersion, fragment_shader };
  251. g_ShaderHandle = glCreateProgram();
  252. g_VertHandle = glCreateShader(GL_VERTEX_SHADER);
  253. g_FragHandle = glCreateShader(GL_FRAGMENT_SHADER);
  254. glShaderSource(g_VertHandle, 2, vertex_shader_with_version, NULL);
  255. glShaderSource(g_FragHandle, 2, fragment_shader_with_version, NULL);
  256. glCompileShader(g_VertHandle);
  257. glCompileShader(g_FragHandle);
  258. glAttachShader(g_ShaderHandle, g_VertHandle);
  259. glAttachShader(g_ShaderHandle, g_FragHandle);
  260. glLinkProgram(g_ShaderHandle);
  261. g_AttribLocationTex = glGetUniformLocation(g_ShaderHandle, "Texture");
  262. g_AttribLocationProjMtx = glGetUniformLocation(g_ShaderHandle, "ProjMtx");
  263. g_AttribLocationPosition = glGetAttribLocation(g_ShaderHandle, "Position");
  264. g_AttribLocationUV = glGetAttribLocation(g_ShaderHandle, "UV");
  265. g_AttribLocationColor = glGetAttribLocation(g_ShaderHandle, "Color");
  266. glGenBuffers(1, &g_VboHandle);
  267. glGenBuffers(1, &g_ElementsHandle);
  268. ImGui_ImplOpenGL3_CreateFontsTexture();
  269. // Restore modified GL state
  270. glBindTexture(GL_TEXTURE_2D, last_texture);
  271. glBindBuffer(GL_ARRAY_BUFFER, last_array_buffer);
  272. glBindVertexArray(last_vertex_array);
  273. return true;
  274. }
  275. void ImGui_ImplOpenGL3_DestroyDeviceObjects()
  276. {
  277. if (g_VboHandle) glDeleteBuffers(1, &g_VboHandle);
  278. if (g_ElementsHandle) glDeleteBuffers(1, &g_ElementsHandle);
  279. g_VboHandle = g_ElementsHandle = 0;
  280. if (g_ShaderHandle && g_VertHandle) glDetachShader(g_ShaderHandle, g_VertHandle);
  281. if (g_VertHandle) glDeleteShader(g_VertHandle);
  282. g_VertHandle = 0;
  283. if (g_ShaderHandle && g_FragHandle) glDetachShader(g_ShaderHandle, g_FragHandle);
  284. if (g_FragHandle) glDeleteShader(g_FragHandle);
  285. g_FragHandle = 0;
  286. if (g_ShaderHandle) glDeleteProgram(g_ShaderHandle);
  287. g_ShaderHandle = 0;
  288. ImGui_ImplOpenGL3_DestroyFontsTexture();
  289. }
  290. //--------------------------------------------------------------------------------------------------------
  291. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  292. // This is an _advanced_ and _optional_ feature, allowing the back-end to create and handle multiple viewports simultaneously.
  293. // 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..
  294. //--------------------------------------------------------------------------------------------------------
  295. static void ImGui_ImplOpenGL3_RenderWindow(ImGuiViewport* viewport, void*)
  296. {
  297. if (!(viewport->Flags & ImGuiViewportFlags_NoRendererClear))
  298. {
  299. ImVec4 clear_color = ImVec4(0.0f, 0.0f, 0.0f, 1.0f);
  300. glClearColor(clear_color.x, clear_color.y, clear_color.z, clear_color.w);
  301. glClear(GL_COLOR_BUFFER_BIT);
  302. }
  303. ImGui_ImplOpenGL3_RenderDrawData(viewport->DrawData);
  304. }
  305. static void ImGui_ImplOpenGL3_InitPlatformInterface()
  306. {
  307. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  308. platform_io.Renderer_RenderWindow = ImGui_ImplOpenGL3_RenderWindow;
  309. }
  310. static void ImGui_ImplOpenGL3_ShutdownPlatformInterface()
  311. {
  312. ImGui::DestroyPlatformWindows();
  313. }