imgui_impl_win32.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. // dear imgui: Platform Backend for Windows (standard windows API for 32-bits AND 64-bits applications)
  2. // This needs to be used along with a Renderer (e.g. DirectX11, OpenGL3, Vulkan..)
  3. // Implemented features:
  4. // [X] Platform: Clipboard support (for Win32 this is actually part of core dear imgui)
  5. // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen.
  6. // [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 VK_* values are obsolete since 1.87 and not supported since 1.91.5]
  7. // [X] Platform: Gamepad support.
  8. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  9. // [X] Platform: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  10. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  11. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  12. // Learn about Dear ImGui:
  13. // - FAQ https://dearimgui.com/faq
  14. // - Getting Started https://dearimgui.com/getting-started
  15. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  16. // - Introduction, links and more at the top of imgui.cpp
  17. #pragma once
  18. #include "imgui.h" // IMGUI_IMPL_API
  19. #ifndef IMGUI_DISABLE
  20. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  21. IMGUI_IMPL_API bool ImGui_ImplWin32_Init(void* hwnd);
  22. IMGUI_IMPL_API bool ImGui_ImplWin32_InitForOpenGL(void* hwnd);
  23. IMGUI_IMPL_API void ImGui_ImplWin32_Shutdown();
  24. IMGUI_IMPL_API void ImGui_ImplWin32_NewFrame();
  25. // Win32 message handler your application need to call.
  26. // - Intentionally commented out in a '#if 0' block to avoid dragging dependencies on <windows.h> from this helper.
  27. // - You should COPY the line below into your .cpp code to forward declare the function and then you can call it.
  28. // - Call from your application's message handler. Keep calling your message handler unless this function returns TRUE.
  29. #if 0
  30. extern IMGUI_IMPL_API LRESULT ImGui_ImplWin32_WndProcHandler(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam);
  31. #endif
  32. // DPI-related helpers (optional)
  33. // - Use to enable DPI awareness without having to create an application manifest.
  34. // - Your own app may already do this via a manifest or explicit calls. This is mostly useful for our examples/ apps.
  35. // - In theory we could call simple functions from Windows SDK such as SetProcessDPIAware(), SetProcessDpiAwareness(), etc.
  36. // but most of the functions provided by Microsoft require Windows 8.1/10+ SDK at compile time and Windows 8/10+ at runtime,
  37. // neither we want to require the user to have. So we dynamically select and load those functions to avoid dependencies.
  38. IMGUI_IMPL_API void ImGui_ImplWin32_EnableDpiAwareness();
  39. IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForHwnd(void* hwnd); // HWND hwnd
  40. IMGUI_IMPL_API float ImGui_ImplWin32_GetDpiScaleForMonitor(void* monitor); // HMONITOR monitor
  41. // Transparency related helpers (optional) [experimental]
  42. // - Use to enable alpha compositing transparency with the desktop.
  43. // - Use together with e.g. clearing your framebuffer with zero-alpha.
  44. IMGUI_IMPL_API void ImGui_ImplWin32_EnableAlphaCompositing(void* hwnd); // HWND hwnd
  45. #endif // #ifndef IMGUI_DISABLE