2018-02-22 06:05:17 +08:00
// ImGui Platform Binding for: SDL2
// 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.)
2016-03-24 18:00:47 +08:00
2018-02-06 03:34:11 +08:00
// Implemented features:
// [X] User texture binding. Cast 'GLuint' OpenGL texture identifier as void*/ImTextureID. Read the FAQ about ImTextureID in imgui.cpp.
2015-11-29 19:19:30 +08:00
// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
2015-10-13 23:53:43 +08:00
// If you use this binding you'll need to call 4 functions: ImGui_ImplXXXX_Init(), ImGui_ImplXXXX_NewFrame(), ImGui::Render() and ImGui_ImplXXXX_Shutdown().
2015-11-29 19:19:30 +08:00
// If you are new to ImGui, see examples/README.txt and documentation at the top of imgui.cpp.
2015-07-09 00:27:25 +08:00
// https://github.com/ocornut/imgui
2018-02-15 18:11:21 +08:00
// CHANGELOG
2018-02-17 00:20:18 +08:00
// (minor and older changes stripped away, please see git history for details)
2018-02-17 02:55:16 +08:00
// 2018-02-16: Inputs: Added support for mouse cursors, honoring ImGui::GetMouseCursor() value.
2018-02-17 00:20:18 +08:00
// 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
// 2018-02-06: Inputs: Added mapping for ImGuiKey_Space.
// 2018-02-05: Misc: Using SDL_GetPerformanceCounter() instead of SDL_GetTicks() to be able to handle very high framerate (1000+ FPS).
// 2018-02-05: Inputs: Keyboard mapping is using scancodes everywhere instead of a confusing mixture of keycodes and scancodes.
// 2018-01-20: Inputs: Added Horizontal Mouse Wheel support.
// 2018-01-19: Inputs: When available (SDL 2.0.4+) using SDL_CaptureMouse() to retrieve coordinates outside of client area when dragging. Otherwise (SDL 2.0.3 and before) testing for SDL_WINDOW_INPUT_FOCUS instead of SDL_WINDOW_MOUSE_FOCUS.
// 2018-01-18: Inputs: Added mapping for ImGuiKey_Insert.
// 2017-08-25: Inputs: MousePos set to -FLT_MAX,-FLT_MAX when mouse is unavailable/missing (instead of -1,-1).
// 2016-10-15: Misc: Added a void* user_data parameter to Clipboard function handlers.
2018-02-15 18:11:21 +08:00
2018-02-17 05:22:47 +08:00
# include "imgui.h"
# include "imgui_impl_sdl2.h"
2018-02-27 17:29:37 +08:00
// SDL
2015-05-25 15:40:58 +08:00
# include <SDL.h>
# include <SDL_syswm.h>
// Data
2018-02-06 06:09:14 +08:00
static Uint64 g_Time = 0 ;
2015-05-25 15:40:58 +08:00
static bool g_MousePressed [ 3 ] = { false , false , false } ;
2018-02-17 05:22:47 +08:00
static SDL_Cursor * g_MouseCursors [ ImGuiMouseCursor_Count_ ] = { 0 } ;
2015-05-25 15:40:58 +08:00
2018-02-17 05:22:47 +08:00
static const char * ImGui_ImplSDL2_GetClipboardText ( void * )
2015-05-25 15:40:58 +08:00
{
2016-02-15 17:56:37 +08:00
return SDL_GetClipboardText ( ) ;
2015-05-25 15:40:58 +08:00
}
2018-02-17 05:22:47 +08:00
static void ImGui_ImplSDL2_SetClipboardText ( void * , const char * text )
2015-05-25 15:40:58 +08:00
{
SDL_SetClipboardText ( text ) ;
}
Examples: Added a bunch of comments/referencs related to io.WantCaptureMouse, io.WantCaptureKeyboard (#1262, #1237, #1219, #635, #1058, #1051, #912, #533, #703, #446, #459, #364, #213, #52, and more)
2017-11-01 21:24:09 +08:00
// You can read the io.WantCaptureMouse, io.WantCaptureKeyboard flags to tell if dear imgui wants to use your inputs.
// - When io.WantCaptureMouse is true, do not dispatch mouse input data to your main application.
// - When io.WantCaptureKeyboard is true, do not dispatch keyboard input data to your main application.
// Generally you may always pass all inputs to dear imgui, and hide them from your application based on those two flags.
2018-02-17 05:22:47 +08:00
bool ImGui_ImplSDL2_ProcessEvent ( SDL_Event * event )
2015-05-25 15:40:58 +08:00
{
ImGuiIO & io = ImGui : : GetIO ( ) ;
2015-07-09 01:42:43 +08:00
switch ( event - > type )
2015-07-09 00:10:54 +08:00
{
case SDL_MOUSEWHEEL :
{
2018-01-20 19:45:31 +08:00
if ( event - > wheel . x > 0 ) io . MouseWheelH + = 1 ;
if ( event - > wheel . x < 0 ) io . MouseWheelH - = 1 ;
if ( event - > wheel . y > 0 ) io . MouseWheel + = 1 ;
if ( event - > wheel . y < 0 ) io . MouseWheel - = 1 ;
2015-07-09 00:10:54 +08:00
return true ;
}
case SDL_MOUSEBUTTONDOWN :
{
2015-07-09 01:42:43 +08:00
if ( event - > button . button = = SDL_BUTTON_LEFT ) g_MousePressed [ 0 ] = true ;
if ( event - > button . button = = SDL_BUTTON_RIGHT ) g_MousePressed [ 1 ] = true ;
if ( event - > button . button = = SDL_BUTTON_MIDDLE ) g_MousePressed [ 2 ] = true ;
2015-07-09 00:10:54 +08:00
return true ;
}
case SDL_TEXTINPUT :
{
2015-07-16 11:16:22 +08:00
io . AddInputCharactersUTF8 ( event - > text . text ) ;
2015-07-09 00:10:54 +08:00
return true ;
}
case SDL_KEYDOWN :
case SDL_KEYUP :
{
2018-02-06 05:35:29 +08:00
int key = event - > key . keysym . scancode ;
IM_ASSERT ( key > = 0 & & key < IM_ARRAYSIZE ( io . KeysDown ) ) ;
2015-07-09 01:42:43 +08:00
io . KeysDown [ key ] = ( event - > type = = SDL_KEYDOWN ) ;
2015-07-09 00:10:54 +08:00
io . KeyShift = ( ( SDL_GetModState ( ) & KMOD_SHIFT ) ! = 0 ) ;
io . KeyCtrl = ( ( SDL_GetModState ( ) & KMOD_CTRL ) ! = 0 ) ;
io . KeyAlt = ( ( SDL_GetModState ( ) & KMOD_ALT ) ! = 0 ) ;
2016-04-03 00:22:40 +08:00
io . KeySuper = ( ( SDL_GetModState ( ) & KMOD_GUI ) ! = 0 ) ;
2015-07-09 00:10:54 +08:00
return true ;
}
}
return false ;
2015-05-25 15:40:58 +08:00
}
2018-02-17 05:22:47 +08:00
bool ImGui_ImplSDL2_Init ( SDL_Window * window )
2015-05-25 15:40:58 +08:00
{
2018-02-06 05:35:29 +08:00
// Keyboard mapping. ImGui will use those indices to peek into the io.KeyDown[] array.
2015-05-25 15:40:58 +08:00
ImGuiIO & io = ImGui : : GetIO ( ) ;
2018-02-06 05:35:29 +08:00
io . KeyMap [ ImGuiKey_Tab ] = SDL_SCANCODE_TAB ;
2015-05-25 15:40:58 +08:00
io . KeyMap [ ImGuiKey_LeftArrow ] = SDL_SCANCODE_LEFT ;
io . KeyMap [ ImGuiKey_RightArrow ] = SDL_SCANCODE_RIGHT ;
io . KeyMap [ ImGuiKey_UpArrow ] = SDL_SCANCODE_UP ;
io . KeyMap [ ImGuiKey_DownArrow ] = SDL_SCANCODE_DOWN ;
2015-07-09 00:10:54 +08:00
io . KeyMap [ ImGuiKey_PageUp ] = SDL_SCANCODE_PAGEUP ;
io . KeyMap [ ImGuiKey_PageDown ] = SDL_SCANCODE_PAGEDOWN ;
2015-05-25 15:40:58 +08:00
io . KeyMap [ ImGuiKey_Home ] = SDL_SCANCODE_HOME ;
io . KeyMap [ ImGuiKey_End ] = SDL_SCANCODE_END ;
2018-01-18 17:01:36 +08:00
io . KeyMap [ ImGuiKey_Insert ] = SDL_SCANCODE_INSERT ;
2018-02-06 05:35:29 +08:00
io . KeyMap [ ImGuiKey_Delete ] = SDL_SCANCODE_DELETE ;
io . KeyMap [ ImGuiKey_Backspace ] = SDL_SCANCODE_BACKSPACE ;
2018-02-07 02:29:31 +08:00
io . KeyMap [ ImGuiKey_Space ] = SDL_SCANCODE_SPACE ;
2018-02-06 05:35:29 +08:00
io . KeyMap [ ImGuiKey_Enter ] = SDL_SCANCODE_RETURN ;
io . KeyMap [ ImGuiKey_Escape ] = SDL_SCANCODE_ESCAPE ;
io . KeyMap [ ImGuiKey_A ] = SDL_SCANCODE_A ;
io . KeyMap [ ImGuiKey_C ] = SDL_SCANCODE_C ;
io . KeyMap [ ImGuiKey_V ] = SDL_SCANCODE_V ;
io . KeyMap [ ImGuiKey_X ] = SDL_SCANCODE_X ;
io . KeyMap [ ImGuiKey_Y ] = SDL_SCANCODE_Y ;
io . KeyMap [ ImGuiKey_Z ] = SDL_SCANCODE_Z ;
2016-03-26 22:43:45 +08:00
2018-02-17 05:22:47 +08:00
io . SetClipboardTextFn = ImGui_ImplSDL2_SetClipboardText ;
io . GetClipboardTextFn = ImGui_ImplSDL2_GetClipboardText ;
2016-10-15 17:36:43 +08:00
io . ClipboardUserData = NULL ;
2016-03-26 22:43:45 +08:00
2018-02-17 05:22:47 +08:00
g_MouseCursors [ ImGuiMouseCursor_Arrow ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_ARROW ) ;
g_MouseCursors [ ImGuiMouseCursor_TextInput ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_IBEAM ) ;
g_MouseCursors [ ImGuiMouseCursor_ResizeAll ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_SIZEALL ) ;
g_MouseCursors [ ImGuiMouseCursor_ResizeNS ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_SIZENS ) ;
g_MouseCursors [ ImGuiMouseCursor_ResizeEW ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_SIZEWE ) ;
g_MouseCursors [ ImGuiMouseCursor_ResizeNESW ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_SIZENESW ) ;
g_MouseCursors [ ImGuiMouseCursor_ResizeNWSE ] = SDL_CreateSystemCursor ( SDL_SYSTEM_CURSOR_SIZENWSE ) ;
2018-02-17 01:45:31 +08:00
2015-08-09 23:24:10 +08:00
# ifdef _WIN32
2016-02-15 17:56:37 +08:00
SDL_SysWMinfo wmInfo ;
SDL_VERSION ( & wmInfo . version ) ;
SDL_GetWindowWMInfo ( window , & wmInfo ) ;
2015-05-25 15:40:58 +08:00
io . ImeWindowHandle = wmInfo . info . win . window ;
2016-05-05 05:20:41 +08:00
# else
( void ) window ;
2015-05-25 15:40:58 +08:00
# endif
return true ;
}
2018-02-17 05:22:47 +08:00
void ImGui_ImplSDL2_Shutdown ( )
2015-05-25 15:40:58 +08:00
{
2018-02-20 21:23:22 +08:00
// Destroy SDL mouse cursors
2018-02-17 01:45:31 +08:00
for ( ImGuiMouseCursor cursor_n = 0 ; cursor_n < ImGuiMouseCursor_Count_ ; cursor_n + + )
2018-02-17 05:22:47 +08:00
SDL_FreeCursor ( g_MouseCursors [ cursor_n ] ) ;
2018-02-20 21:23:22 +08:00
memset ( g_MouseCursors , 0 , sizeof ( g_MouseCursors ) ) ;
2015-05-25 15:40:58 +08:00
}
2018-02-17 05:22:47 +08:00
void ImGui_ImplSDL2_NewFrame ( SDL_Window * window )
2015-05-25 15:40:58 +08:00
{
ImGuiIO & io = ImGui : : GetIO ( ) ;
2018-02-17 05:22:47 +08:00
IM_ASSERT ( io . Fonts - > IsBuilt ( ) ) ; // Font atlas needs to be built, call renderer _NewFrame() function e.g. ImGui_ImplOpenGL3_NewFrame()
2015-05-25 15:40:58 +08:00
// Setup display size (every frame to accommodate for window resizing)
int w , h ;
2016-03-26 05:25:20 +08:00
int display_w , display_h ;
2016-02-15 17:56:37 +08:00
SDL_GetWindowSize ( window , & w , & h ) ;
2016-03-26 05:25:20 +08:00
SDL_GL_GetDrawableSize ( window , & display_w , & display_h ) ;
2015-05-25 15:40:58 +08:00
io . DisplaySize = ImVec2 ( ( float ) w , ( float ) h ) ;
2016-03-26 05:25:20 +08:00
io . DisplayFramebufferScale = ImVec2 ( w > 0 ? ( ( float ) display_w / w ) : 0 , h > 0 ? ( ( float ) display_h / h ) : 0 ) ;
2016-01-20 22:06:31 +08:00
2018-02-06 06:09:14 +08:00
// Setup time step (we don't use SDL_GetTicks() because it is using millisecond resolution)
static Uint64 frequency = SDL_GetPerformanceFrequency ( ) ;
Uint64 current_time = SDL_GetPerformanceCounter ( ) ;
io . DeltaTime = g_Time > 0 ? ( float ) ( ( double ) ( current_time - g_Time ) / frequency ) : ( float ) ( 1.0f / 60.0f ) ;
2015-05-25 15:40:58 +08:00
g_Time = current_time ;
2018-01-19 17:46:54 +08:00
// Setup mouse inputs (we already got mouse wheel, keyboard keys & characters from our event handler)
2015-07-09 00:27:25 +08:00
int mx , my ;
2018-01-19 16:43:28 +08:00
Uint32 mouse_buttons = SDL_GetMouseState ( & mx , & my ) ;
2018-01-19 17:46:54 +08:00
io . MousePos = ImVec2 ( - FLT_MAX , - FLT_MAX ) ;
2018-01-19 16:43:28 +08:00
io . MouseDown [ 0 ] = g_MousePressed [ 0 ] | | ( mouse_buttons & SDL_BUTTON ( SDL_BUTTON_LEFT ) ) ! = 0 ; // If a mouse press event came, always pass it as "mouse held this frame", so we don't miss click-release events that are shorter than 1 frame.
io . MouseDown [ 1 ] = g_MousePressed [ 1 ] | | ( mouse_buttons & SDL_BUTTON ( SDL_BUTTON_RIGHT ) ) ! = 0 ;
io . MouseDown [ 2 ] = g_MousePressed [ 2 ] | | ( mouse_buttons & SDL_BUTTON ( SDL_BUTTON_MIDDLE ) ) ! = 0 ;
2015-07-08 23:46:55 +08:00
g_MousePressed [ 0 ] = g_MousePressed [ 1 ] = g_MousePressed [ 2 ] = false ;
2015-05-25 15:40:58 +08:00
2018-01-19 17:46:54 +08:00
// We need to use SDL_CaptureMouse() to easily retrieve mouse coordinates outside of the client area. This is only supported from SDL 2.0.4 (released Jan 2016)
# if (SDL_MAJOR_VERSION >= 2) && (SDL_MINOR_VERSION >= 0) && (SDL_PATCHLEVEL >= 4)
if ( ( SDL_GetWindowFlags ( window ) & ( SDL_WINDOW_MOUSE_FOCUS | SDL_WINDOW_MOUSE_CAPTURE ) ) ! = 0 )
io . MousePos = ImVec2 ( ( float ) mx , ( float ) my ) ;
bool any_mouse_button_down = false ;
for ( int n = 0 ; n < IM_ARRAYSIZE ( io . MouseDown ) ; n + + )
any_mouse_button_down | = io . MouseDown [ n ] ;
if ( any_mouse_button_down & & ( SDL_GetWindowFlags ( window ) & SDL_WINDOW_MOUSE_CAPTURE ) = = 0 )
SDL_CaptureMouse ( SDL_TRUE ) ;
if ( ! any_mouse_button_down & & ( SDL_GetWindowFlags ( window ) & SDL_WINDOW_MOUSE_CAPTURE ) ! = 0 )
SDL_CaptureMouse ( SDL_FALSE ) ;
# else
if ( ( SDL_GetWindowFlags ( window ) & SDL_WINDOW_INPUT_FOCUS ) ! = 0 )
io . MousePos = ImVec2 ( ( float ) mx , ( float ) my ) ;
# endif
2018-02-20 21:23:22 +08:00
// Update OS/hardware mouse cursor if imgui isn't drawing a software cursor
2018-02-17 02:55:16 +08:00
ImGuiMouseCursor cursor = ImGui : : GetMouseCursor ( ) ;
if ( io . MouseDrawCursor | | cursor = = ImGuiMouseCursor_None )
{
2018-02-17 01:45:31 +08:00
SDL_ShowCursor ( 0 ) ;
2018-02-17 02:55:16 +08:00
}
2018-02-17 01:45:31 +08:00
else
{
2018-02-20 21:23:22 +08:00
SDL_SetCursor ( g_MouseCursors [ cursor ] ? g_MouseCursors [ cursor ] : g_MouseCursors [ ImGuiMouseCursor_Arrow ] ) ;
2018-02-17 01:45:31 +08:00
SDL_ShowCursor ( 1 ) ;
}
2015-05-25 15:40:58 +08:00
Examples: Added a bunch of comments/referencs related to io.WantCaptureMouse, io.WantCaptureKeyboard (#1262, #1237, #1219, #635, #1058, #1051, #912, #533, #703, #446, #459, #364, #213, #52, and more)
2017-11-01 21:24:09 +08:00
// Start the frame. This call will update the io.WantCaptureMouse, io.WantCaptureKeyboard flag that you can use to dispatch inputs (or not) to your application.
2015-05-25 15:40:58 +08:00
ImGui : : NewFrame ( ) ;
}