imgui_impl_opengl3.cpp 16 KB

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