git repos / blockattack-game

blame: source/code/Libs/imgui/backends/imgui_impl_sdlrenderer2.h

normal view · raw

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