source: opengl-game/IMGUI/imgui_impl_sdl.h

feature/imgui-sdl
Last change on this file was 3b7d497, checked in by Dmitry Portnoy <dportnoy@…>, 4 years ago

Start implementing an ImGUI ui on top of SDL and Vulkan using some example code

  • Property mode set to 100644
File size: 1.7 KB
Line 
1// dear imgui: Platform Binding 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 copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
14// If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
15// https://github.com/ocornut/imgui
16
17#pragma once
18#include "imgui.h" // IMGUI_IMPL_API
19
20struct SDL_Window;
21typedef union SDL_Event SDL_Event;
22
23IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForOpenGL(SDL_Window* window, void* sdl_gl_context);
24IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForVulkan(SDL_Window* window);
25IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForD3D(SDL_Window* window);
26IMGUI_IMPL_API bool ImGui_ImplSDL2_InitForMetal(SDL_Window* window);
27IMGUI_IMPL_API void ImGui_ImplSDL2_Shutdown();
28IMGUI_IMPL_API void ImGui_ImplSDL2_NewFrame(SDL_Window* window);
29IMGUI_IMPL_API bool ImGui_ImplSDL2_ProcessEvent(const SDL_Event* event);
Note: See TracBrowser for help on using the repository browser.