2020-10-12 10:34:22 -05:00
// dear imgui: Platform Backend for SDL2
2018-06-08 12:37:33 -05: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-06-11 05:33:51 -05:00
// Implemented features:
// [X] Platform: Clipboard support.
2023-04-04 12:43:51 -05:00
// [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen.
2021-12-12 04:57:37 -06: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 05:26:14 -05:00
// [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
2021-12-12 04:57:37 -06:00
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
2023-02-07 11:55:10 -06:00
// [X] Platform: Basic IME support. App needs to call 'SDL_SetHint(SDL_HINT_IME_SHOW_UI, "1");' before SDL_CreateWindow()!.
2018-06-08 12:37:33 -05:00
2021-06-29 12:54:25 -05:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2021-05-27 06:59:35 -05: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.
2023-09-11 06:47:08 -05:00
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2018-06-08 12:37:33 -05:00
2018-11-01 14:56:36 -05:00
# pragma once
2020-04-07 04:02:29 -05:00
# include "imgui.h" // IMGUI_IMPL_API
2023-07-13 04:27:52 -05:00
# ifndef IMGUI_DISABLE
2020-04-06 13:23:57 -05:00
2018-06-08 12:37:33 -05:00
struct SDL_Window ;
2022-01-22 07:55:03 -06:00
struct SDL_Renderer ;
2024-02-13 09:24:44 -06:00
struct _SDL_GameController ;
2018-06-08 12:37:33 -05:00
typedef union SDL_Event SDL_Event ;
2018-06-21 05:04:00 -05: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-16 18:11:32 -05:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForD3D ( SDL_Window * window ) ;
2020-02-10 08:13:29 -06:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForMetal ( SDL_Window * window ) ;
2022-01-22 07:55:03 -06:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForSDLRenderer ( SDL_Window * window , SDL_Renderer * renderer ) ;
2023-08-15 05:48:46 -05:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOther ( SDL_Window * window ) ;
2018-06-21 05:04:00 -05:00
IMGUI_IMPL_API void ImGui_ImplSDL2_Shutdown ( ) ;
2021-06-29 12:54:25 -05:00
IMGUI_IMPL_API void ImGui_ImplSDL2_NewFrame ( ) ;
2018-11-23 11:12:37 -06:00
IMGUI_IMPL_API bool ImGui_ImplSDL2_ProcessEvent ( const SDL_Event * event ) ;
2021-06-29 12:54:25 -05:00
2024-02-14 04:30:43 -06:00
// Gamepad selection automatically starts in AutoFirst mode, picking first available SDL_Gamepad. You may override this.
2024-02-13 11:50:21 -06:00
// When using manual mode, caller is responsible for opening/closing gamepad.
2024-02-14 04:30:43 -06:00
enum ImGui_ImplSDL2_GamepadMode { ImGui_ImplSDL2_GamepadMode_AutoFirst , ImGui_ImplSDL2_GamepadMode_AutoAll , ImGui_ImplSDL2_GamepadMode_Manual } ;
IMGUI_IMPL_API void ImGui_ImplSDL2_SetGamepadMode ( ImGui_ImplSDL2_GamepadMode mode , struct _SDL_GameController * * manual_gamepads_array = NULL , int manual_gamepads_count = - 1 ) ;
2024-02-13 09:24:44 -06:00
2021-06-29 12:54:25 -05:00
# ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
2024-02-13 09:24:44 -06:00
static inline void ImGui_ImplSDL2_NewFrame ( SDL_Window * ) { ImGui_ImplSDL2_NewFrame ( ) ; } // 1.84: removed unnecessary parameter
2021-06-29 12:54:25 -05:00
# endif
2023-07-13 04:27:52 -05:00
# endif // #ifndef IMGUI_DISABLE