imgui_impl_win32.h (2704B)
1 // dear imgui: Platform Backend for Windows (standard windows API for 32 and 64 bits applications) 2 // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..) 3 4 // Implemented features: 5 // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui) 6 // [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. 7 // [X] Platform: Keyboard arrays indexed using VK_* Virtual Key Codes, e.g. ImGui::IsKeyPressed(VK_SPACE). 8 // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'. 9 10 // You can copy and use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this. 11 // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp. 12 // Read online: https://github.com/ocornut/imgui/tree/master/docs 13 14 #pragma once 15 #include "imgui.h" // IMGUI_IMPL_API 16 17 IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd); 18 IMGUI_IMPL_API void ImGui_ImplWin32_Shutdown(); 19 IMGUI_IMPL_API void ImGui_ImplWin32_NewFrame(); 20 21 // Win32 message handler your application need to call. 22 // - Intentionally commented out in a '#if 0' block to avoid dragging dependencies on <windows.h> from this helper. 23 // - You should COPY the line below into your .cpp code to forward declare the function and then you can call it. 24 #if 0 25 extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam); 26 #endif 27 28 // DPI-related helpers (optional) 29 // - Use to enable DPI awareness without having to create an application manifest. 30 // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps. 31 // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc. 32 // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime, 33 // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies. 34 IMGUI_IMPL_API void ImGui_ImplWin32_EnableDpiAwareness(); 35 IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd); // HWND hwnd 36 IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor); // HMONITOR monitor 37 38 // Transparency related helpers (optional) [experimental] 39 // - Use to enable alpha compositing transparency with the desktop. 40 // - Use together with e.g. clearing your framebuffer with zero-alpha. 41 IMGUI_IMPL_API void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd); // HWND hwnd