Debian Codegraph @

subprojects/imgui-1.91.6/backends/imgui_impl_opengl2.cpp

raw
1 // dear imgui: Renderer Backend for OpenGL2 (legacy OpenGL, fixed pipeline)
2 // This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, custom..)
3
4 // Implemented features:
5 // [X] Renderer: User texture binding. Use 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID!
6 // Missing features or Issues:
7 // [ ] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
8
9 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
10 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
11 // Learn about Dear ImGui:
12 // - FAQ https://dearimgui.com/faq
13 // - Getting Started https://dearimgui.com/getting-started
14 // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
15 // - Introduction, links and more at the top of imgui.cpp
16
17 // **DO NOT USE THIS CODE IF YOUR CODE/ENGINE IS USING MODERN OPENGL (SHADERS, VBO, VAO, etc.)**
18 // **Prefer using the code in imgui_impl_opengl3.cpp**
19 // This code is mostly provided as a reference to learn how ImGui integration works, because it is shorter to read.
20 // If your code is using GL3+ context or any semi modern OpenGL calls, using this is likely to make everything more
21 // complicated, will require your code to reset every single OpenGL attributes to their initial state, and might
22 // confuse your GPU driver.
23 // The GL2 code is unable to reset attributes or even call e.g. "glUseProgram(0)" because they don't exist in that API.
24
25 // CHANGELOG
26 // (minor and older changes stripped away, please see git history for details)
27 // 2024-10-07: OpenGL: Changed default texture sampler to Clamp instead of Repeat/Wrap.
28 // 2024-06-28: OpenGL: ImGui_ImplOpenGL2_NewFrame() recreates font texture if it has been destroyed by ImGui_ImplOpenGL2_DestroyFontsTexture(). (#7748)
29 // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
30 // 2021-12-08: OpenGL: Fixed mishandling of the ImDrawCmd::IdxOffset field! This is an old bug but it never had an effect until some internal rendering changes in 1.86.
31 // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX).
32 // 2021-05-19: OpenGL: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
33 // 2021-01-03: OpenGL: Backup, setup and restore GL_SHADE_MODEL state, disable GL_STENCIL_TEST and disable GL_NORMAL_ARRAY client state to increase compatibility with legacy OpenGL applications.
34 // 2020-01-23: OpenGL: Backup, setup and restore GL_TEXTURE_ENV to increase compatibility with legacy OpenGL applications.
35 // 2019-04-30: OpenGL: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
36 // 2019-02-11: OpenGL: Projecting clipping rectangles correctly using draw_data->FramebufferScale to allow multi-viewports for retina display.
37 // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
38 // 2018-08-03: OpenGL: Disabling/restoring GL_LIGHTING and GL_COLOR_MATERIAL to increase compatibility with legacy OpenGL applications.
39 // 2018-06-08: Misc: Extracted imgui_impl_opengl2.cpp/.h away from the old combined GLFW/SDL+OpenGL2 examples.
40 // 2018-06-08: OpenGL: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
41 // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplOpenGL2_RenderDrawData() in the .h file so you can call it yourself.
42 // 2017-09-01: OpenGL: Save and restore current polygon mode.
43 // 2016-09-10: OpenGL: Uploading font texture as RGBA32 to increase compatibility with users shaders (not ideal).
44 // 2016-09-05: OpenGL: Fixed save and restore of current scissor rectangle.
45
46 #include "imgui.h"
47 #ifndef IMGUI_DISABLE
48 #include "imgui_impl_opengl2.h"
49 #include <stdint.h> // intptr_t
50
51 // Clang/GCC warnings with -Weverything
52 #if defined(__clang__)
53 #pragma clang diagnostic push
54 #pragma clang diagnostic ignored "-Wunused-macros" // warning: macro is not used
55 #pragma clang diagnostic ignored "-Wnonportable-system-include-path"
56 #endif
57
58 // Include OpenGL header (without an OpenGL loader) requires a bit of fiddling
59 #if defined(_WIN32) && !defined(APIENTRY)
60 #define APIENTRY __stdcall // It is customary to use APIENTRY for OpenGL function pointer declarations on all platforms. Additionally, the Windows OpenGL header needs APIENTRY.
61 #endif
62 #if defined(_WIN32) && !defined(WINGDIAPI)
63 #define WINGDIAPI __declspec(dllimport) // Some Windows OpenGL headers need this
64 #endif
65 #if defined(__APPLE__)
66 #define GL_SILENCE_DEPRECATION
67 #include <OpenGL/gl.h>
68 #else
69 #include <GL/gl.h>
70 #endif
71
72 struct ImGui_ImplOpenGL2_Data
73 {
74 GLuint FontTexture;
75
76 ImGui_ImplOpenGL2_Data() { memset((void*)this, 0, sizeof(*this)); }
77 };
78
79 // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
80 // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
81 static ImGui_ImplOpenGL2_Data* ImGui_ImplOpenGL2_GetBackendData()
82 {
83 return ImGui::GetCurrentContext() ? (ImGui_ImplOpenGL2_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
84 }
85
86 // Functions
87 bool ImGui_ImplOpenGL2_Init()
88 {
89 ImGuiIO& io = ImGui::GetIO();
90 IMGUI_CHECKVERSION();
91 IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
92
93 // Setup backend capabilities flags
94 ImGui_ImplOpenGL2_Data* bd = IM_NEW(ImGui_ImplOpenGL2_Data)();
95 io.BackendRendererUserData = (void*)bd;
96 io.BackendRendererName = "imgui_impl_opengl2";
97
98 return true;
99 }
100
101 void ImGui_ImplOpenGL2_Shutdown()
102 {
103 ImGui_ImplOpenGL2_Data* bd = ImGui_ImplOpenGL2_GetBackendData();
104 IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
105 ImGuiIO& io = ImGui::GetIO();
106
107 ImGui_ImplOpenGL2_DestroyDeviceObjects();
108 io.BackendRendererName = nullptr;
109 io.BackendRendererUserData = nullptr;
110 IM_DELETE(bd);
111 }
112
113 void ImGui_ImplOpenGL2_NewFrame()
114 {
115 ImGui_ImplOpenGL2_Data* bd = ImGui_ImplOpenGL2_GetBackendData();
116 IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplOpenGL2_Init()?");
117
118 if (!bd->FontTexture)
119 ImGui_ImplOpenGL2_CreateDeviceObjects();
120 if (!bd->FontTexture)
121 ImGui_ImplOpenGL2_CreateFontsTexture();
122 }
123
124 static void ImGui_ImplOpenGL2_SetupRenderState(ImDrawData* draw_data, int fb_width, int fb_height)
125 {
126 // Setup render state: alpha-blending enabled, no face culling, no depth testing, scissor enabled, vertex/texcoord/color pointers, polygon fill.
127 glEnable(GL_BLEND);
128 glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
129 //glBlendFuncSeparate(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA, GL_ONE, GL_ONE_MINUS_SRC_ALPHA); // In order to composite our output buffer we need to preserve alpha
130 glDisable(GL_CULL_FACE);
131 glDisable(GL_DEPTH_TEST);
132 glDisable(GL_STENCIL_TEST);
133 glDisable(GL_LIGHTING);
134 glDisable(GL_COLOR_MATERIAL);
135 glEnable(GL_SCISSOR_TEST);
136 glEnableClientState(GL_VERTEX_ARRAY);
137 glEnableClientState(GL_TEXTURE_COORD_ARRAY);
138 glEnableClientState(GL_COLOR_ARRAY);
139 glDisableClientState(GL_NORMAL_ARRAY);
140 glEnable(GL_TEXTURE_2D);
141 glPolygonMode(GL_FRONT_AND_BACK, GL_FILL);
142 glShadeModel(GL_SMOOTH);
143 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
144
145 // If you are using this code with non-legacy OpenGL header/contexts (which you should not, prefer using imgui_impl_opengl3.cpp!!),
146 // you may need to backup/reset/restore other state, e.g. for current shader using the commented lines below.
147 // (DO NOT MODIFY THIS FILE! Add the code in your calling function)
148 // GLint last_program;
149 // glGetIntegerv(GL_CURRENT_PROGRAM, &last_program);
150 // glUseProgram(0);
151 // ImGui_ImplOpenGL2_RenderDrawData(...);
152 // glUseProgram(last_program)
153 // There are potentially many more states you could need to clear/setup that we can't access from default headers.
154 // e.g. glBindBuffer(GL_ARRAY_BUFFER, 0), glDisable(GL_TEXTURE_CUBE_MAP).
155
156 // Setup viewport, orthographic projection matrix
157 // 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.
158 glViewport(0, 0, (GLsizei)fb_width, (GLsizei)fb_height);
159 glMatrixMode(GL_PROJECTION);
160 glPushMatrix();
161 glLoadIdentity();
162 glOrtho(draw_data->DisplayPos.x, draw_data->DisplayPos.x + draw_data->DisplaySize.x, draw_data->DisplayPos.y + draw_data->DisplaySize.y, draw_data->DisplayPos.y, -1.0f, +1.0f);
163 glMatrixMode(GL_MODELVIEW);
164 glPushMatrix();
165 glLoadIdentity();
166 }
167
168 // OpenGL2 Render function.
169 // Note that this implementation is little overcomplicated because we are saving/setting up/restoring every OpenGL state explicitly.
170 // This is in order to be able to run within an OpenGL engine that doesn't do so.
171 void ImGui_ImplOpenGL2_RenderDrawData(ImDrawData* draw_data)
172 {
173 // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
174 int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
175 int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
176 if (fb_width == 0 || fb_height == 0)
177 return;
178
179 // Backup GL state
180 GLint last_texture; glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
181 GLint last_polygon_mode[2]; glGetIntegerv(GL_POLYGON_MODE, last_polygon_mode);
182 GLint last_viewport[4]; glGetIntegerv(GL_VIEWPORT, last_viewport);
183 GLint last_scissor_box[4]; glGetIntegerv(GL_SCISSOR_BOX, last_scissor_box);
184 GLint last_shade_model; glGetIntegerv(GL_SHADE_MODEL, &last_shade_model);
185 GLint last_tex_env_mode; glGetTexEnviv(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, &last_tex_env_mode);
186 glPushAttrib(GL_ENABLE_BIT | GL_COLOR_BUFFER_BIT | GL_TRANSFORM_BIT);
187
188 // Setup desired GL state
189 ImGui_ImplOpenGL2_SetupRenderState(draw_data, fb_width, fb_height);
190
191 // Will project scissor/clipping rectangles into framebuffer space
192 ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
193 ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
194
195 // Render command lists
196 for (int n = 0; n < draw_data->CmdListsCount; n++)
197 {
198 const ImDrawList* draw_list = draw_data->CmdLists[n];
199 const ImDrawVert* vtx_buffer = draw_list->VtxBuffer.Data;
200 const ImDrawIdx* idx_buffer = draw_list->IdxBuffer.Data;
201 glVertexPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + offsetof(ImDrawVert, pos)));
202 glTexCoordPointer(2, GL_FLOAT, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + offsetof(ImDrawVert, uv)));
203 glColorPointer(4, GL_UNSIGNED_BYTE, sizeof(ImDrawVert), (const GLvoid*)((const char*)vtx_buffer + offsetof(ImDrawVert, col)));
204
205 for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
206 {
207 const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
208 if (pcmd->UserCallback)
209 {
210 // User callback, registered via ImDrawList::AddCallback()
211 // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
212 if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
213 ImGui_ImplOpenGL2_SetupRenderState(draw_data, fb_width, fb_height);
214 else
215 pcmd->UserCallback(draw_list, pcmd);
216 }
217 else
218 {
219 // Project scissor/clipping rectangles into framebuffer space
220 ImVec2 clip_min((pcmd->ClipRect.x - clip_off.x) * clip_scale.x, (pcmd->ClipRect.y - clip_off.y) * clip_scale.y);
221 ImVec2 clip_max((pcmd->ClipRect.z - clip_off.x) * clip_scale.x, (pcmd->ClipRect.w - clip_off.y) * clip_scale.y);
222 if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
223 continue;
224
225 // Apply scissor/clipping rectangle (Y is inverted in OpenGL)
226 glScissor((int)clip_min.x, (int)((float)fb_height - clip_max.y), (int)(clip_max.x - clip_min.x), (int)(clip_max.y - clip_min.y));
227
228 // Bind texture, Draw
229 glBindTexture(GL_TEXTURE_2D, (GLuint)(intptr_t)pcmd->GetTexID());
230 glDrawElements(GL_TRIANGLES, (GLsizei)pcmd->ElemCount, sizeof(ImDrawIdx) == 2 ? GL_UNSIGNED_SHORT : GL_UNSIGNED_INT, idx_buffer + pcmd->IdxOffset);
231 }
232 }
233 }
234
235 // Restore modified GL state
236 glDisableClientState(GL_COLOR_ARRAY);
237 glDisableClientState(GL_TEXTURE_COORD_ARRAY);
238 glDisableClientState(GL_VERTEX_ARRAY);
239 glBindTexture(GL_TEXTURE_2D, (GLuint)last_texture);
240 glMatrixMode(GL_MODELVIEW);
241 glPopMatrix();
242 glMatrixMode(GL_PROJECTION);
243 glPopMatrix();
244 glPopAttrib();
245 glPolygonMode(GL_FRONT, (GLenum)last_polygon_mode[0]); glPolygonMode(GL_BACK, (GLenum)last_polygon_mode[1]);
246 glViewport(last_viewport[0], last_viewport[1], (GLsizei)last_viewport[2], (GLsizei)last_viewport[3]);
247 glScissor(last_scissor_box[0], last_scissor_box[1], (GLsizei)last_scissor_box[2], (GLsizei)last_scissor_box[3]);
248 glShadeModel(last_shade_model);
249 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, last_tex_env_mode);
250 }
251
252 bool ImGui_ImplOpenGL2_CreateFontsTexture()
253 {
254 // Build texture atlas
255 ImGuiIO& io = ImGui::GetIO();
256 ImGui_ImplOpenGL2_Data* bd = ImGui_ImplOpenGL2_GetBackendData();
257 unsigned char* pixels;
258 int width, height;
259 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.
260
261 // Upload texture to graphics system
262 // (Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling)
263 GLint last_texture;
264 glGetIntegerv(GL_TEXTURE_BINDING_2D, &last_texture);
265 glGenTextures(1, &bd->FontTexture);
266 glBindTexture(GL_TEXTURE_2D, bd->FontTexture);
267 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
268 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
269 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP);
270 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP);
271 glPixelStorei(GL_UNPACK_ROW_LENGTH, 0);
272 glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, pixels);
273
274 // Store our identifier
275 io.Fonts->SetTexID((ImTextureID)(intptr_t)bd->FontTexture);
276
277 // Restore state
278 glBindTexture(GL_TEXTURE_2D, last_texture);
279
280 return true;
281 }
282
283 void ImGui_ImplOpenGL2_DestroyFontsTexture()
284 {
285 ImGuiIO& io = ImGui::GetIO();
286 ImGui_ImplOpenGL2_Data* bd = ImGui_ImplOpenGL2_GetBackendData();
287 if (bd->FontTexture)
288 {
289 glDeleteTextures(1, &bd->FontTexture);
290 io.Fonts->SetTexID(0);
291 bd->FontTexture = 0;
292 }
293 }
294
295 bool ImGui_ImplOpenGL2_CreateDeviceObjects()
296 {
297 return ImGui_ImplOpenGL2_CreateFontsTexture();
298 }
299
300 void ImGui_ImplOpenGL2_DestroyDeviceObjects()
301 {
302 ImGui_ImplOpenGL2_DestroyFontsTexture();
303 }
304
305 //-----------------------------------------------------------------------------
306
307 #if defined(__clang__)
308 #pragma clang diagnostic pop
309 #endif
310
311 #endif // #ifndef IMGUI_DISABLE