Debian Codegraph @

subprojects/imgui-1.91.6/backends/imgui_impl_opengl3.h

raw
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
6 // Implemented features:
7 // [X] Renderer: User texture binding. Use 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID!
8 // [x] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset) [Desktop OpenGL only!]
9
10 // About WebGL/ES:
11 // - You need to '#define IMGUI_IMPL_OPENGL_ES2' or '#define IMGUI_IMPL_OPENGL_ES3' to use WebGL or OpenGL ES.
12 // - This is done automatically on iOS, Android and Emscripten targets.
13 // - For other targets, the define needs to be visible from the imgui_impl_opengl3.cpp compilation unit. If unsure, define globally or in imconfig.h.
14
15 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
16 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
17 // Learn about Dear ImGui:
18 // - FAQ https://dearimgui.com/faq
19 // - Getting Started https://dearimgui.com/getting-started
20 // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
21 // - Introduction, links and more at the top of imgui.cpp
22
23 // About GLSL version:
24 // The 'glsl_version' initialization parameter should be nullptr (default) or a "#version XXX" string.
25 // On computer platform the GLSL version default to "#version 130". On OpenGL ES 3 platform it defaults to "#version 300 es"
26 // Only override if your GL version doesn't handle this GLSL version. See GLSL version table at the top of imgui_impl_opengl3.cpp.
27
28 #pragma once
29 #include "imgui.h" // IMGUI_IMPL_API
30 #ifndef IMGUI_DISABLE
31
32 // Follow "Getting Started" link and check examples/ folder to learn about using backends!
33 IMGUI_IMPL_API bool ImGui_ImplOpenGL3_Init(const char* glsl_version = nullptr);
34 IMGUI_IMPL_API void ImGui_ImplOpenGL3_Shutdown();
35 IMGUI_IMPL_API void ImGui_ImplOpenGL3_NewFrame();
36 IMGUI_IMPL_API void ImGui_ImplOpenGL3_RenderDrawData(ImDrawData* draw_data);
37
38 // (Optional) Called by Init/NewFrame/Shutdown
39 IMGUI_IMPL_API bool ImGui_ImplOpenGL3_CreateFontsTexture();
40 IMGUI_IMPL_API void ImGui_ImplOpenGL3_DestroyFontsTexture();
41 IMGUI_IMPL_API bool ImGui_ImplOpenGL3_CreateDeviceObjects();
42 IMGUI_IMPL_API void ImGui_ImplOpenGL3_DestroyDeviceObjects();
43
44 // Configuration flags to add in your imconfig file:
45 //#define IMGUI_IMPL_OPENGL_ES2 // Enable ES 2 (Auto-detected on Emscripten)
46 //#define IMGUI_IMPL_OPENGL_ES3 // Enable ES 3 (Auto-detected on iOS/Android)
47
48 // You can explicitly select GLES2 or GLES3 API by using one of the '#define IMGUI_IMPL_OPENGL_LOADER_XXX' in imconfig.h or compiler command-line.
49 #if !defined(IMGUI_IMPL_OPENGL_ES2) \
50 && !defined(IMGUI_IMPL_OPENGL_ES3)
51
52 // Try to detect GLES on matching platforms
53 #if defined(__APPLE__)
54 #include <TargetConditionals.h>
55 #endif
56 #if (defined(__APPLE__) && (TARGET_OS_IOS || TARGET_OS_TV)) || (defined(__ANDROID__))
57 #define IMGUI_IMPL_OPENGL_ES3 // iOS, Android -> GL ES 3, "#version 300 es"
58 #elif defined(__EMSCRIPTEN__) || defined(__amigaos4__)
59 #define IMGUI_IMPL_OPENGL_ES2 // Emscripten -> GL ES 2, "#version 100"
60 #else
61 // Otherwise imgui_impl_opengl3_loader.h will be used.
62 #endif
63
64 #endif
65
66 #endif // #ifndef IMGUI_DISABLE