2020-10-12 17:34:22 +02:00
// dear imgui: Platform Backend for SDL2
2018-02-21 23:05:17 +01:00
// This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
// (Info: SDL2 is a cross-platform general purpose library for handling windows, inputs, graphics context creation, etc.)
2018-02-05 20:34:11 +01:00
2018-03-19 15:20:47 +01:00
// Implemented features:
2018-06-11 12:33:51 +02:00
// [X] Platform: Clipboard support.
2023-04-04 19:43:51 +02:00
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen.
2021-12-12 11:57:37 +01:00
// [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 will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
2019-04-23 12:26:14 +02:00
// [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
2021-12-12 11:57:37 +01:00
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
2018-06-12 16:24:24 +02:00
// [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
2018-06-08 19:37:33 +02:00
// Missing features:
2019-04-25 17:53:11 +02:00
// [ ] Platform: Multi-viewport + Minimized windows seems to break mouse wheel events (at least under Windows).
2023-02-10 17:05:06 +01:00
// [x] Platform: Basic IME support. App needs to call 'SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1");' before SDL_CreateWindow()!.
2018-03-19 15:20:47 +01:00
2021-06-29 19:54:25 +02:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2021-05-27 13:59:35 +02:00
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
2020-10-14 12:22:53 +02:00
// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
// Read online: https://github.com/ocornut/imgui/tree/master/docs
2015-11-16 22:05:22 +01:00
2018-11-01 20:56:36 +01:00
# pragma once
2020-04-07 11:02:29 +02:00
# include "imgui.h" // IMGUI_IMPL_API
2023-07-13 11:27:52 +02:00
# ifndef IMGUI_DISABLE
2018-11-01 20:56:36 +01:00
2015-11-16 22:05:22 +01:00
struct SDL_Window ;
2022-01-22 14:55:03 +01:00
struct SDL_Renderer ;
2015-11-16 22:05:22 +01:00
typedef union SDL_Event SDL_Event ;
2018-06-21 12:04:00 +02:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOpenGL ( SDL_Window * window , void * sdl_gl_context ) ;
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForVulkan ( SDL_Window * window ) ;
2019-06-17 01:11:32 +02:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForD3D ( SDL_Window * window ) ;
2020-02-10 15:13:29 +01:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForMetal ( SDL_Window * window ) ;
2022-01-22 14:55:03 +01:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForSDLRenderer ( SDL_Window * window , SDL_Renderer * renderer ) ;
2023-08-15 12:48:46 +02:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOther ( SDL_Window * window ) ;
2018-06-21 12:04:00 +02:00
IMGUI_IMPL_API void ImGui_ImplSDL2_Shutdown ( ) ;
2021-06-29 19:54:25 +02:00
IMGUI_IMPL_API void ImGui_ImplSDL2_NewFrame ( ) ;
2018-11-23 18:12:37 +01:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_ProcessEvent ( const SDL_Event * event ) ;
2021-06-29 19:54:25 +02:00
# ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
static inline void ImGui_ImplSDL2_NewFrame ( SDL_Window * ) { ImGui_ImplSDL2_NewFrame ( ) ; } // 1.84: removed unnecessary parameter
# endif
2023-07-13 11:27:52 +02:00
# endif // #ifndef IMGUI_DISABLE