2023-06-08 01:29:16 -04:00
// dear imgui: Renderer Backend for SDL_Renderer for SDL3
2025-08-11 17:28:38 -04:00
// (Requires: SDL 3.1.8+)
2023-06-08 01:29:16 -04:00
2025-08-11 17:28:38 -04:00
// Note that SDL_Renderer is an _optional_ component of SDL3, which IMHO is now largely obsolete.
// For a multi-platform app consider using other technologies:
// - SDL3+SDL_GPU: SDL_GPU is SDL3 new graphics abstraction API.
// - SDL3+DirectX, SDL3+OpenGL, SDL3+Vulkan: combine SDL with dedicated renderers.
// If your application wants to render any non trivial amount of graphics other than UI,
// please be aware that SDL_Renderer currently offers a limited graphic API to the end-user
// and it might be difficult to step out of those boundaries.
2023-06-08 01:29:16 -04:00
// Implemented features:
2025-08-11 21:40:50 -04:00
// [X] Renderer: User texture binding. Use 'SDL_Texture*' as texture identifier. Read the FAQ about ImTextureID/ImTextureRef!
2025-08-11 16:50:18 -04:00
// [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
2025-08-11 21:40:50 -04:00
// [X] Renderer: Texture updates support for dynamic font atlas (ImGuiBackendFlags_RendererHasTextures).
2025-08-11 15:52:57 -04:00
// [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
2023-06-08 01:29:16 -04:00
// Missing features:
// [ ] Renderer: Multi-viewport support (multiple windows).
2025-08-09 22:26:36 -04:00
// You can copy and use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2023-06-08 01:29:16 -04:00
# pragma once
# include "imgui.h" // IMGUI_IMPL_API
2023-08-30 01:42:51 -04:00
# ifndef IMGUI_DISABLE
2023-06-08 01:29:16 -04:00
struct SDL_Renderer ;
2025-08-10 06:07:58 -04:00
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
2023-06-08 01:29:16 -04:00
IMGUI_IMPL_API bool ImGui_ImplSDLRenderer3_Init ( SDL_Renderer * renderer ) ;
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_NewFrame ( ) ;
2025-08-10 05:23:51 -04:00
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_RenderDrawData ( ImDrawData * draw_data , SDL_Renderer * renderer ) ;
2023-06-08 01:29:16 -04:00
// Called by Init/NewFrame/Shutdown
2025-08-11 21:40:50 -04:00
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_CreateDeviceObjects ( ) ;
2023-06-08 01:29:16 -04:00
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_DestroyDeviceObjects ( ) ;
2023-08-30 01:42:51 -04:00
2025-08-11 21:40:50 -04:00
// (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.
IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_UpdateTexture ( ImTextureData * tex ) ;
2025-08-11 15:52:57 -04:00
// [BETA] Selected render state data shared with callbacks.
// This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplSDLRenderer3_RenderDrawData() call.
// (Please open an issue if you feel you need access to more data)
struct ImGui_ImplSDLRenderer3_RenderState
{
SDL_Renderer * Renderer ;
} ;
2023-08-30 01:42:51 -04:00
# endif // #ifndef IMGUI_DISABLE