imgui_impl_opengl3.h 3.7 KB

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