imgui_impl_opengl3.cpp 33 KB

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