imgui_impl_sdlrenderer2.h 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. // dear imgui: Renderer Backend for SDL_Renderer for SDL2
  2. // (Requires: SDL 2.0.17+)
  3. // Note that SDL_Renderer is an _optional_ component of SDL2, which IMHO is now largely obsolete.
  4. // For a multi-platform app consider using other technologies:
  5. // - SDL3+SDL_GPU: SDL_GPU is SDL3 new graphics abstraction API. You will need to update to SDL3.
  6. // - SDL2+DirectX, SDL2+OpenGL, SDL2+Vulkan: combine SDL with dedicated renderers.
  7. // If your application wants to render any non trivial amount of graphics other than UI,
  8. // please be aware that SDL_Renderer currently offers a limited graphic API to the end-user
  9. // and it might be difficult to step out of those boundaries.
  10. // Implemented features:
  11. // [X] Renderer: User texture binding. Use 'SDL_Texture*' as ImTextureID. Read the FAQ about ImTextureID!
  12. // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
  13. // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
  14. // Missing features:
  15. // [ ] Renderer: Multi-viewport support (multiple windows).
  16. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  17. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  18. // Learn about Dear ImGui:
  19. // - FAQ https://dearimgui.com/faq
  20. // - Getting Started https://dearimgui.com/getting-started
  21. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  22. // - Introduction, links and more at the top of imgui.cpp
  23. #pragma once
  24. #ifndef IMGUI_DISABLE
  25. #include "imgui.h" // IMGUI_IMPL_API
  26. struct SDL_Renderer;
  27. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  28. IMGUI_IMPL_API bool ImGui_ImplSDLRenderer2_Init(SDL_Renderer* renderer);
  29. IMGUI_IMPL_API void ImGui_ImplSDLRenderer2_Shutdown();
  30. IMGUI_IMPL_API void ImGui_ImplSDLRenderer2_NewFrame();
  31. IMGUI_IMPL_API void ImGui_ImplSDLRenderer2_RenderDrawData(ImDrawData* draw_data, SDL_Renderer* renderer);
  32. // Called by Init/NewFrame/Shutdown
  33. IMGUI_IMPL_API bool ImGui_ImplSDLRenderer2_CreateFontsTexture();
  34. IMGUI_IMPL_API void ImGui_ImplSDLRenderer2_DestroyFontsTexture();
  35. IMGUI_IMPL_API bool ImGui_ImplSDLRenderer2_CreateDeviceObjects();
  36. IMGUI_IMPL_API void ImGui_ImplSDLRenderer2_DestroyDeviceObjects();
  37. // [BETA] Selected render state data shared with callbacks.
  38. // This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplSDLRenderer2_RenderDrawData() call.
  39. // (Please open an issue if you feel you need access to more data)
  40. struct ImGui_ImplSDLRenderer2_RenderState
  41. {
  42. SDL_Renderer* Renderer;
  43. };
  44. #endif // #ifndef IMGUI_DISABLE