imgui_impl_opengl3.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  1. // dear imgui: Renderer for modern OpenGL with shaders / programmatic pipeline
  2. // - Desktop GL: 2.x 3.x 4.x
  3. // - Embedded GL: ES 2.0 (WebGL 1.0), ES 3.0 (WebGL 2.0)
  4. // This needs to be used along with a Platform Binding (e.g. GLFW, SDL, Win32, custom..)
  5. // Implemented features:
  6. // [X] Renderer: User texture binding. Use 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID!
  7. // [x] Renderer: Desktop GL only: Support for large meshes (64k+ vertices) with 16-bit indices.
  8. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  9. // If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
  10. // https://github.com/ocornut/imgui
  11. // CHANGELOG
  12. // (minor and older changes stripped away, please see git history for details)
  13. // 2020-01-07: OpenGL: Added support for glbindings OpenGL loader.
  14. // 2019-10-25: OpenGL: Using a combination of GL define and runtime GL version to decide whether to use glDrawElementsBaseVertex(). Fix building with pre-3.2 GL loaders.
  15. // 2019-09-22: OpenGL: Detect default GL loader using __has_include compiler facility.
  16. // 2019-09-16: OpenGL: Tweak initialization code to allow application calling ImGui_ImplOpenGL3_CreateFontsTexture() before the first NewFrame() call.
  17. // 2019-05-29: OpenGL: Desktop GL only: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  18. // 2019-04-30: OpenGL: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  19. // 2019-03-29: OpenGL: Not calling glBindBuffer more than necessary in the render loop.
  20. // 2019-03-15: OpenGL: Added a dummy GL call + comments in ImGui_ImplOpenGL3_Init() to detect uninitialized GL function loaders early.
  21. // 2019-03-03: OpenGL: Fix support for ES 2.0 (WebGL 1.0).
  22. // 2019-02-20: OpenGL: Fix for OSX not supporting OpenGL 4.5, we don't try to read GL_CLIP_ORIGIN even if defined by the headers/loader.
  23. // 2019-02-11: OpenGL: Projecting clipping rectangles correctly using draw_data->FramebufferScale to allow multi-viewports for retina display.
  24. // 2019-02-01: OpenGL: Using GLSL 410 shaders for any version over 410 (e.g. 430, 450).
  25. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  26. // 2018-11-13: OpenGL: Support for GL 4.5's glClipControl(GL_UPPER_LEFT) / GL_CLIP_ORIGIN.
  27. // 2018-08-29: OpenGL: Added support for more OpenGL loaders: glew and glad, with comments indicative that any loader can be used.
  28. // 2018-08-09: OpenGL: Default to OpenGL ES 3 on iOS and Android. GLSL version default to "#version 300 ES".
  29. // 2018-07-30: OpenGL: Support for GLSL 300 ES and 410 core. Fixes for Emscripten compilation.
  30. // 2018-07-10: OpenGL: Support for more GLSL versions (based on the GLSL version string). Added error output when shaders fail to compile/link.
  31. // 2018-06-08: Misc: Extracted imgui_impl_opengl3.cpp/.h away from the old combined GLFW/SDL+OpenGL3 examples.
  32. // 2018-06-08: OpenGL: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  33. // 2018-05-25: OpenGL: Removed unnecessary backup/restore of GL_ELEMENT_ARRAY_BUFFER_BINDING since this is part of the VAO state.
  34. // 2018-05-14: OpenGL: Making the call to glBindSampler() optional so 3.2 context won't fail if the function is a NULL pointer.
  35. // 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".
  36. // 2018-02-23: OpenGL: Create the VAO in the render function so the setup can more easily be used with multiple shared GL context.
  37. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplSdlGL3_RenderDrawData() in the .h file so you can call it yourself.
  38. // 2018-01-07: OpenGL: Changed GLSL shader version from 330 to 150.
  39. // 2017-09-01: OpenGL: Save and restore current bound sampler. Save and restore current polygon mode.
  40. // 2017-05-01: OpenGL: Fixed save and restore of current blend func state.
  41. // 2017-05-01: OpenGL: Fixed save and restore of current GL_ACTIVE_TEXTURE.
  42. // 2016-09-05: OpenGL: Fixed save and restore of current scissor rectangle.
  43. // 2016-07-29: OpenGL: Explicitly setting GL_UNPACK_ROW_LENGTH to reduce issues because SDL changes it. (#752)
  44. //----------------------------------------
  45. // OpenGL GLSL GLSL
  46. // version version string
  47. //----------------------------------------
  48. // 2.0 110 "#version 110"
  49. // 2.1 120 "#version 120"
  50. // 3.0 130 "#version 130"
  51. // 3.1 140 "#version 140"
  52. // 3.2 150 "#version 150"
  53. // 3.3 330 "#version 330 core"
  54. // 4.0 400 "#version 400 core"
  55. // 4.1 410 "#version 410 core"
  56. // 4.2 420 "#version 410 core"
  57. // 4.3 430 "#version 430 core"
  58. // ES 2.0 100 "#version 100" = WebGL 1.0
  59. // ES 3.0 300 "#version 300 es" = WebGL 2.0
  60. //----------------------------------------
  61. #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_WARNINGS)
  62. #define _CRT_SECURE_NO_WARNINGS
  63. #endif
  64. #include "imgui.h"
  65. #include "imgui_impl_opengl3.h"
  66. #include <stdio.h>
  67. #if defined(_MSC_VER) && _MSC_VER <= 1500 // MSVC 2008 or earlier
  68. #include <stddef.h> // intptr_t
  69. #else
  70. #include <stdint.h> // intptr_t
  71. #endif
  72. #if defined(__APPLE__)
  73. #include "TargetConditionals.h"
  74. #endif
  75. // Auto-enable GLES on matching platforms
  76. #if !defined(IMGUI_IMPL_OPENGL_ES2) && !defined(IMGUI_IMPL_OPENGL_ES3)
  77. #if (defined(__APPLE__) && (TARGET_OS_IOS || TARGET_OS_TV)) || (defined(__ANDROID__))
  78. #define IMGUI_IMPL_OPENGL_ES3 // iOS, Android -> GL ES 3, "#version 300 es"
  79. #undef IMGUI_IMPL_OPENGL_LOADER_GL3W
  80. #undef IMGUI_IMPL_OPENGL_LOADER_GLEW
  81. #undef IMGUI_IMPL_OPENGL_LOADER_GLAD
  82. #undef IMGUI_IMPL_OPENGL_LOADER_GLBINDING2
  83. #undef IMGUI_IMPL_OPENGL_LOADER_GLBINDING3
  84. #undef IMGUI_IMPL_OPENGL_LOADER_CUSTOM
  85. #elif defined(__EMSCRIPTEN__)
  86. #define IMGUI_IMPL_OPENGL_ES2 // Emscripten -> GL ES 2, "#version 100"
  87. #undef IMGUI_IMPL_OPENGL_LOADER_GL3W
  88. #undef IMGUI_IMPL_OPENGL_LOADER_GLEW
  89. #undef IMGUI_IMPL_OPENGL_LOADER_GLAD
  90. #undef IMGUI_IMPL_OPENGL_LOADER_GLBINDING2
  91. #undef IMGUI_IMPL_OPENGL_LOADER_GLBINDING3
  92. #undef IMGUI_IMPL_OPENGL_LOADER_CUSTOM
  93. #endif
  94. #endif
  95. // GL includes
  96. #if defined(IMGUI_IMPL_OPENGL_ES2)
  97. #include <GLES2/gl2.h>
  98. #elif defined(IMGUI_IMPL_OPENGL_ES3)
  99. #if (defined(__APPLE__) && (TARGET_OS_IOS || TARGET_OS_TV))
  100. #include <OpenGLES/ES3/gl.h> // Use GL ES 3
  101. #else
  102. #include <GLES3/gl3.h> // Use GL ES 3
  103. #endif
  104. #else
  105. // About Desktop OpenGL function loaders:
  106. // Modern desktop OpenGL doesn't have a standard portable header file to load OpenGL function pointers.
  107. // Helper libraries are often used for this purpose! Here we are supporting a few common ones (gl3w, glew, glad).
  108. // You may use another loader/header of your choice (glext, glLoadGen, etc.), or chose to manually implement your own.
  109. #if defined(IMGUI_IMPL_OPENGL_LOADER_GL3W)
  110. #include <GL/gl3w.h> // Needs to be initialized with gl3wInit() in user's code
  111. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLEW)
  112. #include <GL/glew.h> // Needs to be initialized with glewInit() in user's code
  113. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLAD)
  114. #include <glad/glad.h> // Needs to be initialized with gladLoadGL() in user's code
  115. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLBINDING2) || defined(IMGUI_IMPL_OPENGL_LOADER_GLBINDING3)
  116. #include <glbinding/gl/gl.h> // Initialize with glbinding::initialize()
  117. #if defined(IMGUI_IMPL_OPENGL_LOADER_GLBINDING2)
  118. #include <glbinding/Binding.h>
  119. #else
  120. #include <glbinding/glbinding.h>
  121. #endif
  122. using namespace gl;
  123. #else
  124. #include IMGUI_IMPL_OPENGL_LOADER_CUSTOM
  125. #endif
  126. #endif
  127. // Desktop GL 3.2+ has glDrawElementsBaseVertex() which GL ES and WebGL don't have.
  128. #if defined(IMGUI_IMPL_OPENGL_ES2) || defined(IMGUI_IMPL_OPENGL_ES3) || !defined(GL_VERSION_3_2)
  129. #define IMGUI_IMPL_OPENGL_MAY_HAVE_VTX_OFFSET 0
  130. #else
  131. #define IMGUI_IMPL_OPENGL_MAY_HAVE_VTX_OFFSET 1
  132. #endif
  133. // OpenGL Data
  134. static GLuint g_GlVersion = 0; // Extracted at runtime using GL_MAJOR_VERSION, GL_MINOR_VERSION queries.
  135. static char g_GlslVersionString[32] = ""; // Specified by user or detected based on compile time GL settings.
  136. static GLuint g_FontTexture = 0;
  137. static GLuint g_ShaderHandle = 0, g_VertHandle = 0, g_FragHandle = 0;
  138. static int g_AttribLocationTex = 0, g_AttribLocationProjMtx = 0; // Uniforms location
  139. static int g_AttribLocationVtxPos = 0, g_AttribLocationVtxUV = 0, g_AttribLocationVtxColor = 0; // Vertex attributes location
  140. static unsigned int g_VboHandle = 0, g_ElementsHandle = 0;
  141. // Functions
  142. bool ImGui_ImplOpenGL3_Init(const char* glsl_version)
  143. {
  144. // Query for GL version
  145. #if !defined(IMGUI_IMPL_OPENGL_ES2)
  146. GLint major, minor;
  147. glGetIntegerv(GL_MAJOR_VERSION, &major);
  148. glGetIntegerv(GL_MINOR_VERSION, &minor);
  149. g_GlVersion = major * 1000 + minor;
  150. #else
  151. g_GlVersion = 2000; // GLES 2
  152. #endif
  153. // Setup back-end capabilities flags
  154. ImGuiIO& io = ImGui::GetIO();
  155. io.BackendRendererName = "imgui_impl_opengl3";
  156. #if IMGUI_IMPL_OPENGL_MAY_HAVE_VTX_OFFSET
  157. if (g_GlVersion >= 3200)
  158. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  159. #endif
  160. // Store GLSL version string so we can refer to it later in case we recreate shaders.
  161. // Note: GLSL version is NOT the same as GL version. Leave this to NULL if unsure.
  162. #if defined(IMGUI_IMPL_OPENGL_ES2)
  163. if (glsl_version == NULL)
  164. glsl_version = "#version 100";
  165. #elif defined(IMGUI_IMPL_OPENGL_ES3)
  166. if (glsl_version == NULL)
  167. glsl_version = "#version 300 es";
  168. #else
  169. if (glsl_version == NULL)
  170. glsl_version = "#version 130";
  171. #endif
  172. IM_ASSERT((int)strlen(glsl_version) + 2 < IM_ARRAYSIZE(g_GlslVersionString));
  173. strcpy(g_GlslVersionString, glsl_version);
  174. strcat(g_GlslVersionString, "\n");
  175. // Dummy construct to make it easily visible in the IDE and debugger which GL loader has been selected.
  176. // The code actually never uses the 'gl_loader' variable! It is only here so you can read it!
  177. // If auto-detection fails or doesn't select the same GL loader file as used by your application,
  178. // you are likely to get a crash below.
  179. // You can explicitly select a loader by using '#define IMGUI_IMPL_OPENGL_LOADER_XXX' in imconfig.h or compiler command-line.
  180. const char* gl_loader = "Unknown";
  181. IM_UNUSED(gl_loader);
  182. #if defined(IMGUI_IMPL_OPENGL_LOADER_GL3W)
  183. gl_loader = "GL3W";
  184. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLEW)
  185. gl_loader = "GLEW";
  186. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLAD)
  187. gl_loader = "GLAD";
  188. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLBINDING2)
  189. gl_loader = "glbinding2";
  190. #elif defined(IMGUI_IMPL_OPENGL_LOADER_GLBINDING3)
  191. gl_loader = "glbinding3";
  192. #else // IMGUI_IMPL_OPENGL_LOADER_CUSTOM
  193. gl_loader = "Custom";
  194. #endif
  195. // Make a dummy GL call (we don't actually need the result)
  196. // IF YOU GET A CRASH HERE: it probably means that you haven't initialized the OpenGL function loader used by this code.
  197. // Desktop OpenGL 3/4 need a function loader. See the IMGUI_IMPL_OPENGL_LOADER_xxx explanation above.
  198. GLint current_texture;
  199. glGetIntegerv(GL_TEXTURE_BINDING_2D, &current_texture);
  200. return true;
  201. }
  202. void ImGui_ImplOpenGL3_Shutdown()
  203. {
  204. ImGui_ImplOpenGL3_DestroyDeviceObjects();
  205. }
  206. void ImGui_ImplOpenGL3_NewFrame()
  207. {
  208. if (!g_ShaderHandle)
  209. ImGui_ImplOpenGL3_CreateDeviceObjects();
  210. }
  211. static void ImGui_ImplOpenGL3_SetupRenderState(ImDrawData* draw_data, int fb_width, int fb_height, GLuint vertex_array_object)
  212. {
  213. // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, polygon fill
  214. glEnable(GL_BLEND);
  215. glBlendEquation(GL_FUNC_ADD);
  216. glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
  217. glDisable(GL_CULL_FACE);
  218. glDisable(GL_DEPTH_TEST);
  219. glEnable(GL_SCISSOR_TEST);
  220. #ifdef GL_POLYGON_MODE
  221. glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
  222. #endif
  223. // Setup viewport, orthographic projection matrix
  224. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayPos is (0,0) for single viewport apps.
  225. glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
  226. float L = draw_data->DisplayPos.x;
  227. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  228. float T = draw_data->DisplayPos.y;
  229. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  230. const float ortho_projection[4][4] =
  231. {
  232. { 2.0f/(R-L), 0.0f, 0.0f, 0.0f },
  233. { 0.0f, 2.0f/(T-B), 0.0f, 0.0f },
  234. { 0.0f, 0.0f, -1.0f, 0.0f },
  235. { (R+L)/(L-R), (T+B)/(B-T), 0.0f, 1.0f },
  236. };
  237. glUseProgram(g_ShaderHandle);
  238. glUniform1i(g_AttribLocationTex, 0);
  239. glUniformMatrix4fv(g_AttribLocationProjMtx, 1, GL_FALSE, &ortho_projection[0][0]);
  240. #ifdef GL_SAMPLER_BINDING
  241. glBindSampler(0, 0); // We use combined texture/sampler state. Applications using GL 3.3 may set that otherwise.
  242. #endif
  243. (void)vertex_array_object;
  244. #ifndef IMGUI_IMPL_OPENGL_ES2
  245. glBindVertexArray(vertex_array_object);
  246. #endif
  247. // Bind vertex/index buffers and setup attributes for ImDrawVert
  248. glBindBuffer(GL_ARRAY_BUFFER, g_VboHandle);
  249. glBindBuffer(GL_ELEMENT_ARRAY_BUFFER, g_ElementsHandle);
  250. glEnableVertexAttribArray(g_AttribLocationVtxPos);
  251. glEnableVertexAttribArray(g_AttribLocationVtxUV);
  252. glEnableVertexAttribArray(g_AttribLocationVtxColor);
  253. glVertexAttribPointer(g_AttribLocationVtxPos, 2, GL_FLOAT, GL_FALSE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, pos));
  254. glVertexAttribPointer(g_AttribLocationVtxUV, 2, GL_FLOAT, GL_FALSE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, uv));
  255. glVertexAttribPointer(g_AttribLocationVtxColor, 4, GL_UNSIGNED_BYTE, GL_TRUE, sizeof(ImDrawVert), (GLvoid*)IM_OFFSETOF(ImDrawVert, col));
  256. }
  257. // OpenGL3 Render function.
  258. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  259. // 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.
  260. void ImGui_ImplOpenGL3_RenderDrawData(ImDrawData* draw_data)
  261. {
  262. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  263. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  264. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  265. if (fb_width <= 0 || fb_height <= 0)
  266. return;
  267. // Backup GL state
  268. GLenum last_active_texture; glGetIntegerv(GL_ACTIVE_TEXTURE, (GLint*)&last_active_texture);
  269. glActiveTexture(GL_TEXTURE0);
  270. GLint last_program; glGetIntegerv(GL_CURRENT_PROGRAM, &last_program);
  271. GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  272. #ifdef GL_SAMPLER_BINDING
  273. GLint last_sampler; glGetIntegerv(GL_SAMPLER_BINDING, &last_sampler);
  274. #endif
  275. GLint last_array_buffer; glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &last_array_buffer);
  276. #ifndef IMGUI_IMPL_OPENGL_ES2
  277. GLint last_vertex_array_object; glGetIntegerv(GL_VERTEX_ARRAY_BINDING, &last_vertex_array_object);
  278. #endif
  279. #ifdef GL_POLYGON_MODE
  280. GLint last_polygon_mode[2]; glGetIntegerv(GL_POLYGON_MODE, last_polygon_mode);
  281. #endif
  282. GLint last_viewport[4]; glGetIntegerv(GL_VIEWPORT, last_viewport);
  283. GLint last_scissor_box[4]; glGetIntegerv(GL_SCISSOR_BOX, last_scissor_box);
  284. GLenum last_blend_src_rgb; glGetIntegerv(GL_BLEND_SRC_RGB, (GLint*)&last_blend_src_rgb);
  285. GLenum last_blend_dst_rgb; glGetIntegerv(GL_BLEND_DST_RGB, (GLint*)&last_blend_dst_rgb);
  286. GLenum last_blend_src_alpha; glGetIntegerv(GL_BLEND_SRC_ALPHA, (GLint*)&last_blend_src_alpha);
  287. GLenum last_blend_dst_alpha; glGetIntegerv(GL_BLEND_DST_ALPHA, (GLint*)&last_blend_dst_alpha);
  288. GLenum last_blend_equation_rgb; glGetIntegerv(GL_BLEND_EQUATION_RGB, (GLint*)&last_blend_equation_rgb);
  289. GLenum last_blend_equation_alpha; glGetIntegerv(GL_BLEND_EQUATION_ALPHA, (GLint*)&last_blend_equation_alpha);
  290. GLboolean last_enable_blend = glIsEnabled(GL_BLEND);
  291. GLboolean last_enable_cull_face = glIsEnabled(GL_CULL_FACE);
  292. GLboolean last_enable_depth_test = glIsEnabled(GL_DEPTH_TEST);
  293. GLboolean last_enable_scissor_test = glIsEnabled(GL_SCISSOR_TEST);
  294. bool clip_origin_lower_left = true;
  295. #if defined(GL_CLIP_ORIGIN) && !defined(__APPLE__)
  296. GLenum last_clip_origin = 0; glGetIntegerv(GL_CLIP_ORIGIN, (GLint*)&last_clip_origin); // Support for GL 4.5's glClipControl(GL_UPPER_LEFT)
  297. if (last_clip_origin == GL_UPPER_LEFT)
  298. clip_origin_lower_left = false;
  299. #endif
  300. // Setup desired GL state
  301. // Recreate the VAO every time (this is to easily allow multiple GL contexts to be rendered to. VAO are not shared among GL contexts)
  302. // The renderer would actually work without any VAO bound, but then our VertexAttrib calls would overwrite the default one currently bound.
  303. GLuint vertex_array_object = 0;
  304. #ifndef IMGUI_IMPL_OPENGL_ES2
  305. glGenVertexArrays(1, &vertex_array_object);
  306. #endif
  307. ImGui_ImplOpenGL3_SetupRenderState(draw_data, fb_width, fb_height, vertex_array_object);
  308. // Will project scissor/clipping rectangles into framebuffer space
  309. ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
  310. ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
  311. // Render command lists
  312. for (int n = 0; n < draw_data->CmdListsCount; n++)
  313. {
  314. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  315. // Upload vertex/index buffers
  316. glBufferData(GL_ARRAY_BUFFER, (GLsizeiptr)cmd_list->VtxBuffer.Size * sizeof(ImDrawVert), (const GLvoid*)cmd_list->VtxBuffer.Data, GL_STREAM_DRAW);
  317. glBufferData(GL_ELEMENT_ARRAY_BUFFER, (GLsizeiptr)cmd_list->IdxBuffer.Size * sizeof(ImDrawIdx), (const GLvoid*)cmd_list->IdxBuffer.Data, GL_STREAM_DRAW);
  318. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  319. {
  320. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  321. if (pcmd->UserCallback != NULL)
  322. {
  323. // User callback, registered via ImDrawList::AddCallback()
  324. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  325. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  326. ImGui_ImplOpenGL3_SetupRenderState(draw_data, fb_width, fb_height, vertex_array_object);
  327. else
  328. pcmd->UserCallback(cmd_list, pcmd);
  329. }
  330. else
  331. {
  332. // Project scissor/clipping rectangles into framebuffer space
  333. ImVec4 clip_rect;
  334. clip_rect.x = (pcmd->ClipRect.x - clip_off.x) * clip_scale.x;
  335. clip_rect.y = (pcmd->ClipRect.y - clip_off.y) * clip_scale.y;
  336. clip_rect.z = (pcmd->ClipRect.z - clip_off.x) * clip_scale.x;
  337. clip_rect.w = (pcmd->ClipRect.w - clip_off.y) * clip_scale.y;
  338. if (clip_rect.x < fb_width && clip_rect.y < fb_height && clip_rect.z >= 0.0f && clip_rect.w >= 0.0f)
  339. {
  340. // Apply scissor/clipping rectangle
  341. if (clip_origin_lower_left)
  342. 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));
  343. else
  344. glScissor((int)clip_rect.x, (int)clip_rect.y, (int)clip_rect.z, (int)clip_rect.w); // Support for GL 4.5 rarely used glClipControl(GL_UPPER_LEFT)
  345. // Bind texture, Draw
  346. glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->TextureId);
  347. #if IMGUI_IMPL_OPENGL_MAY_HAVE_VTX_OFFSET
  348. if (g_GlVersion >= 3200)
  349. glDrawElementsBaseVertex(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, (void*)(intptr_t)(pcmd->IdxOffset * sizeof(ImDrawIdx)), (GLint)pcmd->VtxOffset);
  350. else
  351. #endif
  352. glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, (void*)(intptr_t)(pcmd->IdxOffset * sizeof(ImDrawIdx)));
  353. }
  354. }
  355. }
  356. }
  357. // Destroy the temporary VAO
  358. #ifndef IMGUI_IMPL_OPENGL_ES2
  359. glDeleteVertexArrays(1, &vertex_array_object);
  360. #endif
  361. // Restore modified GL state
  362. glUseProgram(last_program);
  363. glBindTexture(GL_TEXTURE_2D, last_texture);
  364. #ifdef GL_SAMPLER_BINDING
  365. glBindSampler(0, last_sampler);
  366. #endif
  367. glActiveTexture(last_active_texture);
  368. #ifndef IMGUI_IMPL_OPENGL_ES2
  369. glBindVertexArray(last_vertex_array_object);
  370. #endif
  371. glBindBuffer(GL_ARRAY_BUFFER, last_array_buffer);
  372. glBlendEquationSeparate(last_blend_equation_rgb, last_blend_equation_alpha);
  373. glBlendFuncSeparate(last_blend_src_rgb, last_blend_dst_rgb, last_blend_src_alpha, last_blend_dst_alpha);
  374. if (last_enable_blend) glEnable(GL_BLEND); else glDisable(GL_BLEND);
  375. if (last_enable_cull_face) glEnable(GL_CULL_FACE); else glDisable(GL_CULL_FACE);
  376. if (last_enable_depth_test) glEnable(GL_DEPTH_TEST); else glDisable(GL_DEPTH_TEST);
  377. if (last_enable_scissor_test) glEnable(GL_SCISSOR_TEST); else glDisable(GL_SCISSOR_TEST);
  378. #ifdef GL_POLYGON_MODE
  379. glPolygonMode(GL_FRONT_AND_BACK, (GLenum)last_polygon_mode[0]);
  380. #endif
  381. glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
  382. glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
  383. }
  384. bool ImGui_ImplOpenGL3_CreateFontsTexture()
  385. {
  386. // Build texture atlas
  387. ImGuiIO& io = ImGui::GetIO();
  388. unsigned char* pixels;
  389. int width, height;
  390. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height); // Load as RGBA 32-bit (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.
  391. // Upload texture to graphics system
  392. GLint last_texture;
  393. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  394. glGenTextures(1, &g_FontTexture);
  395. glBindTexture(GL_TEXTURE_2D, g_FontTexture);
  396. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
  397. glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
  398. #ifdef GL_UNPACK_ROW_LENGTH
  399. glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
  400. #endif
  401. glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
  402. // Store our identifier
  403. io.Fonts->TexID = (ImTextureID)(intptr_t)g_FontTexture;
  404. // Restore state
  405. glBindTexture(GL_TEXTURE_2D, last_texture);
  406. return true;
  407. }
  408. void ImGui_ImplOpenGL3_DestroyFontsTexture()
  409. {
  410. if (g_FontTexture)
  411. {
  412. ImGuiIO& io = ImGui::GetIO();
  413. glDeleteTextures(1, &g_FontTexture);
  414. io.Fonts->TexID = 0;
  415. g_FontTexture = 0;
  416. }
  417. }
  418. // If you get an error please report on github. You may try different GL context version or GLSL version. See GL<>GLSL version table at the top of this file.
  419. static bool CheckShader(GLuint handle, const char* desc)
  420. {
  421. GLint status = 0, log_length = 0;
  422. glGetShaderiv(handle, GL_COMPILE_STATUS, &status);
  423. glGetShaderiv(handle, GL_INFO_LOG_LENGTH, &log_length);
  424. if ((GLboolean)status == GL_FALSE)
  425. fprintf(stderr, "ERROR: ImGui_ImplOpenGL3_CreateDeviceObjects: failed to compile %s!\n", desc);
  426. if (log_length > 1)
  427. {
  428. ImVector<char> buf;
  429. buf.resize((int)(log_length + 1));
  430. glGetShaderInfoLog(handle, log_length, NULL, (GLchar*)buf.begin());
  431. fprintf(stderr, "%s\n", buf.begin());
  432. }
  433. return (GLboolean)status == GL_TRUE;
  434. }
  435. // If you get an error please report on GitHub. You may try different GL context version or GLSL version.
  436. static bool CheckProgram(GLuint handle, const char* desc)
  437. {
  438. GLint status = 0, log_length = 0;
  439. glGetProgramiv(handle, GL_LINK_STATUS, &status);
  440. glGetProgramiv(handle, GL_INFO_LOG_LENGTH, &log_length);
  441. if ((GLboolean)status == GL_FALSE)
  442. fprintf(stderr, "ERROR: ImGui_ImplOpenGL3_CreateDeviceObjects: failed to link %s! (with GLSL '%s')\n", desc, g_GlslVersionString);
  443. if (log_length > 1)
  444. {
  445. ImVector<char> buf;
  446. buf.resize((int)(log_length + 1));
  447. glGetProgramInfoLog(handle, log_length, NULL, (GLchar*)buf.begin());
  448. fprintf(stderr, "%s\n", buf.begin());
  449. }
  450. return (GLboolean)status == GL_TRUE;
  451. }
  452. bool ImGui_ImplOpenGL3_CreateDeviceObjects()
  453. {
  454. // Backup GL state
  455. GLint last_texture, last_array_buffer;
  456. glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
  457. glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &last_array_buffer);
  458. #ifndef IMGUI_IMPL_OPENGL_ES2
  459. GLint last_vertex_array;
  460. glGetIntegerv(GL_VERTEX_ARRAY_BINDING, &last_vertex_array);
  461. #endif
  462. // Parse GLSL version string
  463. int glsl_version = 130;
  464. sscanf(g_GlslVersionString, "#version %d", &glsl_version);
  465. const GLchar* vertex_shader_glsl_120 =
  466. "uniform mat4 ProjMtx;\n"
  467. "attribute vec2 Position;\n"
  468. "attribute vec2 UV;\n"
  469. "attribute vec4 Color;\n"
  470. "varying vec2 Frag_UV;\n"
  471. "varying vec4 Frag_Color;\n"
  472. "void main()\n"
  473. "{\n"
  474. " Frag_UV = UV;\n"
  475. " Frag_Color = Color;\n"
  476. " gl_Position = ProjMtx * vec4(Position.xy,0,1);\n"
  477. "}\n";
  478. const GLchar* vertex_shader_glsl_130 =
  479. "uniform mat4 ProjMtx;\n"
  480. "in vec2 Position;\n"
  481. "in vec2 UV;\n"
  482. "in vec4 Color;\n"
  483. "out vec2 Frag_UV;\n"
  484. "out vec4 Frag_Color;\n"
  485. "void main()\n"
  486. "{\n"
  487. " Frag_UV = UV;\n"
  488. " Frag_Color = Color;\n"
  489. " gl_Position = ProjMtx * vec4(Position.xy,0,1);\n"
  490. "}\n";
  491. const GLchar* vertex_shader_glsl_300_es =
  492. "precision mediump float;\n"
  493. "layout (location = 0) in vec2 Position;\n"
  494. "layout (location = 1) in vec2 UV;\n"
  495. "layout (location = 2) in vec4 Color;\n"
  496. "uniform mat4 ProjMtx;\n"
  497. "out vec2 Frag_UV;\n"
  498. "out vec4 Frag_Color;\n"
  499. "void main()\n"
  500. "{\n"
  501. " Frag_UV = UV;\n"
  502. " Frag_Color = Color;\n"
  503. " gl_Position = ProjMtx * vec4(Position.xy,0,1);\n"
  504. "}\n";
  505. const GLchar* vertex_shader_glsl_410_core =
  506. "layout (location = 0) in vec2 Position;\n"
  507. "layout (location = 1) in vec2 UV;\n"
  508. "layout (location = 2) in vec4 Color;\n"
  509. "uniform mat4 ProjMtx;\n"
  510. "out vec2 Frag_UV;\n"
  511. "out vec4 Frag_Color;\n"
  512. "void main()\n"
  513. "{\n"
  514. " Frag_UV = UV;\n"
  515. " Frag_Color = Color;\n"
  516. " gl_Position = ProjMtx * vec4(Position.xy,0,1);\n"
  517. "}\n";
  518. const GLchar* fragment_shader_glsl_120 =
  519. "#ifdef GL_ES\n"
  520. " precision mediump float;\n"
  521. "#endif\n"
  522. "uniform sampler2D Texture;\n"
  523. "varying vec2 Frag_UV;\n"
  524. "varying vec4 Frag_Color;\n"
  525. "void main()\n"
  526. "{\n"
  527. " gl_FragColor = Frag_Color * texture2D(Texture, Frag_UV.st);\n"
  528. "}\n";
  529. const GLchar* fragment_shader_glsl_130 =
  530. "uniform sampler2D Texture;\n"
  531. "in vec2 Frag_UV;\n"
  532. "in vec4 Frag_Color;\n"
  533. "out vec4 Out_Color;\n"
  534. "void main()\n"
  535. "{\n"
  536. " Out_Color = Frag_Color * texture(Texture, Frag_UV.st);\n"
  537. "}\n";
  538. const GLchar* fragment_shader_glsl_300_es =
  539. "precision mediump float;\n"
  540. "uniform sampler2D Texture;\n"
  541. "in vec2 Frag_UV;\n"
  542. "in vec4 Frag_Color;\n"
  543. "layout (location = 0) out vec4 Out_Color;\n"
  544. "void main()\n"
  545. "{\n"
  546. " Out_Color = Frag_Color * texture(Texture, Frag_UV.st);\n"
  547. "}\n";
  548. const GLchar* fragment_shader_glsl_410_core =
  549. "in vec2 Frag_UV;\n"
  550. "in vec4 Frag_Color;\n"
  551. "uniform sampler2D Texture;\n"
  552. "layout (location = 0) out vec4 Out_Color;\n"
  553. "void main()\n"
  554. "{\n"
  555. " Out_Color = Frag_Color * texture(Texture, Frag_UV.st);\n"
  556. "}\n";
  557. // Select shaders matching our GLSL versions
  558. const GLchar* vertex_shader = NULL;
  559. const GLchar* fragment_shader = NULL;
  560. if (glsl_version < 130)
  561. {
  562. vertex_shader = vertex_shader_glsl_120;
  563. fragment_shader = fragment_shader_glsl_120;
  564. }
  565. else if (glsl_version >= 410)
  566. {
  567. vertex_shader = vertex_shader_glsl_410_core;
  568. fragment_shader = fragment_shader_glsl_410_core;
  569. }
  570. else if (glsl_version == 300)
  571. {
  572. vertex_shader = vertex_shader_glsl_300_es;
  573. fragment_shader = fragment_shader_glsl_300_es;
  574. }
  575. else
  576. {
  577. vertex_shader = vertex_shader_glsl_130;
  578. fragment_shader = fragment_shader_glsl_130;
  579. }
  580. // Create shaders
  581. const GLchar* vertex_shader_with_version[2] = { g_GlslVersionString, vertex_shader };
  582. g_VertHandle = glCreateShader(GL_VERTEX_SHADER);
  583. glShaderSource(g_VertHandle, 2, vertex_shader_with_version, NULL);
  584. glCompileShader(g_VertHandle);
  585. CheckShader(g_VertHandle, "vertex shader");
  586. const GLchar* fragment_shader_with_version[2] = { g_GlslVersionString, fragment_shader };
  587. g_FragHandle = glCreateShader(GL_FRAGMENT_SHADER);
  588. glShaderSource(g_FragHandle, 2, fragment_shader_with_version, NULL);
  589. glCompileShader(g_FragHandle);
  590. CheckShader(g_FragHandle, "fragment shader");
  591. g_ShaderHandle = glCreateProgram();
  592. glAttachShader(g_ShaderHandle, g_VertHandle);
  593. glAttachShader(g_ShaderHandle, g_FragHandle);
  594. glLinkProgram(g_ShaderHandle);
  595. CheckProgram(g_ShaderHandle, "shader program");
  596. g_AttribLocationTex = glGetUniformLocation(g_ShaderHandle, "Texture");
  597. g_AttribLocationProjMtx = glGetUniformLocation(g_ShaderHandle, "ProjMtx");
  598. g_AttribLocationVtxPos = glGetAttribLocation(g_ShaderHandle, "Position");
  599. g_AttribLocationVtxUV = glGetAttribLocation(g_ShaderHandle, "UV");
  600. g_AttribLocationVtxColor = glGetAttribLocation(g_ShaderHandle, "Color");
  601. // Create buffers
  602. glGenBuffers(1, &g_VboHandle);
  603. glGenBuffers(1, &g_ElementsHandle);
  604. ImGui_ImplOpenGL3_CreateFontsTexture();
  605. // Restore modified GL state
  606. glBindTexture(GL_TEXTURE_2D, last_texture);
  607. glBindBuffer(GL_ARRAY_BUFFER, last_array_buffer);
  608. #ifndef IMGUI_IMPL_OPENGL_ES2
  609. glBindVertexArray(last_vertex_array);
  610. #endif
  611. return true;
  612. }
  613. void ImGui_ImplOpenGL3_DestroyDeviceObjects()
  614. {
  615. if (g_VboHandle) { glDeleteBuffers(1, &g_VboHandle); g_VboHandle = 0; }
  616. if (g_ElementsHandle) { glDeleteBuffers(1, &g_ElementsHandle); g_ElementsHandle = 0; }
  617. if (g_ShaderHandle && g_VertHandle) { glDetachShader(g_ShaderHandle, g_VertHandle); }
  618. if (g_ShaderHandle && g_FragHandle) { glDetachShader(g_ShaderHandle, g_FragHandle); }
  619. if (g_VertHandle) { glDeleteShader(g_VertHandle); g_VertHandle = 0; }
  620. if (g_FragHandle) { glDeleteShader(g_FragHandle); g_FragHandle = 0; }
  621. if (g_ShaderHandle) { glDeleteProgram(g_ShaderHandle); g_ShaderHandle = 0; }
  622. ImGui_ImplOpenGL3_DestroyFontsTexture();
  623. }