1 // dear imgui: Platform Backend for SDL2 2 // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..) 3 // (Info: SDL2 is a cross-platform general purpose library for handling windows, inputs, graphics context creation, etc.) 4 5 // Implemented features: 6 // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. 7 // [X] Platform: Clipboard support. 8 // [X] Platform: Keyboard arrays indexed using SDL_SCANCODE_* codes, e.g. ImGui::IsKeyPressed(SDL_SCANCODE_SPACE). 9 // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. 10 // Missing features: 11 // [ ] Platform: SDL2 handling of IME under Windows appears to be broken and it explicitly disable the regular Windows IME. You can restore Windows IME by compiling SDL with SDL_DISABLE_WINDOWS_IME. 12 13 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. 14 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. 15 // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp. 16 // Read online: https://github.com/ocornut/imgui/tree/master/docs 17 18 #pragma once 19 #include "imgui.h" // IMGUI_IMPL_API 20 21 struct SDL_Window; 22 typedef union SDL_Event SDL_Event; 23 24 IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOpenGL(SDL_Window* window, void* sdl_gl_context); 25 IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForVulkan(SDL_Window* window); 26 IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForD3D(SDL_Window* window); 27 IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForMetal(SDL_Window* window); 28 IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForSDLRenderer(SDL_Window* window); 29 IMGUI_IMPL_API void ImGui_ImplSDL2_Shutdown(); 30 IMGUI_IMPL_API void ImGui_ImplSDL2_NewFrame(); 31 IMGUI_IMPL_API bool ImGui_ImplSDL2_ProcessEvent(const SDL_Event* event); 32 33 #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS ImGui_ImplSDL2_NewFrame(SDL_Window *)34static inline void ImGui_ImplSDL2_NewFrame(SDL_Window*) { ImGui_ImplSDL2_NewFrame(); } // 1.84: removed unnecessary parameter 35 #endif 36