| 1 |
// dear imgui: Platform Backend for SDL3 (*EXPERIMENTAL*) |
| 2 |
// This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..) |
| 3 |
// (Info: SDL3 is a cross-platform general purpose library for handling windows, inputs, graphics context creation, etc.) |
| 4 |
|
| 5 |
// (**IMPORTANT: SDL 3.0.0 is NOT YET RELEASED AND CURRENTLY HAS A FAST CHANGING API. THIS CODE BREAKS OFTEN AS SDL3 CHANGES.**) |
| 6 |
|
| 7 |
// Implemented features: |
| 8 |
// [X] Platform: Clipboard support. |
| 9 |
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen. |
| 10 |
// [X] Platform: Keyboard support. Since 1.87 we are using the io.AddKeyEvent() function. Pass ImGuiKey values to all key functions e.g. ImGui::IsKeyPressed(ImGuiKey_Space). [Legacy SDL_SCANCODE_* values are obsolete since 1.87 and not supported since 1.91.5] |
| 11 |
// [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. |
| 12 |
// [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. |
| 13 |
// [X] Platform: IME support. |
| 14 |
|
| 15 |
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. |
| 16 |
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. |
| 17 |
// Learn about Dear ImGui: |
| 18 |
// - FAQ https://dearimgui.com/faq |
| 19 |
// - Getting Started https://dearimgui.com/getting-started |
| 20 |
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder). |
| 21 |
// - Introduction, links and more at the top of imgui.cpp |
| 22 |
|
| 23 |
#pragma once |
| 24 |
#include "imgui.h" // IMGUI_IMPL_API |
| 25 |
#ifndef IMGUI_DISABLE |
| 26 |
|
| 27 |
struct SDL_Window; |
| 28 |
struct SDL_Renderer; |
| 29 |
struct SDL_Gamepad; |
| 30 |
typedef union SDL_Event SDL_Event; |
| 31 |
|
| 32 |
// Follow "Getting Started" link and check examples/ folder to learn about using backends! |
| 33 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForOpenGL(SDL_Window* window, void* sdl_gl_context); |
| 34 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForVulkan(SDL_Window* window); |
| 35 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForD3D(SDL_Window* window); |
| 36 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForMetal(SDL_Window* window); |
| 37 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForSDLRenderer(SDL_Window* window, SDL_Renderer* renderer); |
| 38 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_InitForOther(SDL_Window* window); |
| 39 |
IMGUI_IMPL_API void ImGui_ImplSDL3_Shutdown(); |
| 40 |
IMGUI_IMPL_API void ImGui_ImplSDL3_NewFrame(); |
| 41 |
IMGUI_IMPL_API bool ImGui_ImplSDL3_ProcessEvent(const SDL_Event* event); |
| 42 |
|
| 43 |
// Gamepad selection automatically starts in AutoFirst mode, picking first available SDL_Gamepad. You may override this. |
| 44 |
// When using manual mode, caller is responsible for opening/closing gamepad. |
| 45 |
enum ImGui_ImplSDL3_GamepadMode { ImGui_ImplSDL3_GamepadMode_AutoFirst, ImGui_ImplSDL3_GamepadMode_AutoAll, ImGui_ImplSDL3_GamepadMode_Manual }; |
| 46 |
IMGUI_IMPL_API void ImGui_ImplSDL3_SetGamepadMode(ImGui_ImplSDL3_GamepadMode mode, SDL_Gamepad** manual_gamepads_array = nullptr, int manual_gamepads_count = -1); |
| 47 |
|
| 48 |
#endif // #ifndef IMGUI_DISABLE |