ScummVM API documentation
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
imgui_impl_sdlrenderer3.h
1 // dear imgui: Renderer Backend for SDL_Renderer for SDL3
2 // (Requires: SDL 3.0.0+)
3 
4 // (**IMPORTANT: SDL 3.0.0 is NOT YET RELEASED AND CURRENTLY HAS A FAST CHANGING API. THIS CODE BREAKS OFTEN AS SDL3 CHANGES.**)
5 
6 // Note how SDL_Renderer is an _optional_ component of SDL3.
7 // For a multi-platform app consider using e.g. SDL+DirectX on Windows and SDL+OpenGL on Linux/OSX.
8 // If your application will want to render any non trivial amount of graphics other than UI,
9 // please be aware that SDL_Renderer currently offers a limited graphic API to the end-user and
10 // it might be difficult to step out of those boundaries.
11 
12 // Implemented features:
13 // [X] Renderer: User texture binding. Use 'SDL_Texture*' as ImTextureID. Read the FAQ about ImTextureID!
14 // [X] Renderer: Large meshes support (64k+ vertices) with 16-bit indices.
15 
16 // You can copy and 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 
24 #pragma once
25 #include "backends/imgui/imgui.h" // IMGUI_IMPL_API
26 #ifndef IMGUI_DISABLE
27 
28 struct SDL_Renderer;
29 
30 // Follow "Getting Started" link and check examples/ folder to learn about using backends!
31 IMGUI_IMPL_API bool ImGui_ImplSDLRenderer3_Init(SDL_Renderer* renderer);
32 IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_Shutdown();
33 IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_NewFrame();
34 IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_RenderDrawData(ImDrawData* draw_data, SDL_Renderer* renderer);
35 
36 // Called by Init/NewFrame/Shutdown
37 IMGUI_IMPL_API bool ImGui_ImplSDLRenderer3_CreateFontsTexture();
38 IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_DestroyFontsTexture();
39 IMGUI_IMPL_API bool ImGui_ImplSDLRenderer3_CreateDeviceObjects();
40 IMGUI_IMPL_API void ImGui_ImplSDLRenderer3_DestroyDeviceObjects();
41 
42 #endif // #ifndef IMGUI_DISABLE
Definition: imgui.h:3309