Debian Codegraph @

subprojects/imgui-1.91.6/backends/imgui_impl_win32.h

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