Debian Codegraph @

subprojects/imgui-1.91.6/backends/imgui_impl_osx.h

raw
1 // dear imgui: Platform Backend for OSX / Cocoa
2 // This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan, Metal..)
3 // - Not well tested. If you want a portable application, prefer using the GLFW or SDL platform Backends on Mac.
4 // - Requires linking with the GameController framework ("-framework GameController").
5
6 // Implemented features:
7 // [X] Platform: Clipboard support is part of core Dear ImGui (no specific code in this backend).
8 // [X] Platform: Mouse support. Can discriminate Mouse/Pen.
9 // [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 kVK_* values are obsolete since 1.87 and not supported since 1.91.5]
10 // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
11 // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
12 // [X] Platform: IME support.
13
14 // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
15 // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
16 // Learn about Dear ImGui:
17 // - FAQ https://dearimgui.com/faq
18 // - Getting Started https://dearimgui.com/getting-started
19 // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
20 // - Introduction, links and more at the top of imgui.cpp
21
22 #include "imgui.h" // IMGUI_IMPL_API
23 #ifndef IMGUI_DISABLE
24
25 #ifdef __OBJC__
26
27 @class NSEvent;
28 @class NSView;
29
30 // Follow "Getting Started" link and check examples/ folder to learn about using backends!
31 IMGUI_IMPL_API bool ImGui_ImplOSX_Init(NSView* _Nonnull view);
32 IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown();
33 IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame(NSView* _Nullable view);
34
35 #endif
36
37 //-----------------------------------------------------------------------------
38 // C++ API
39 //-----------------------------------------------------------------------------
40
41 #ifdef IMGUI_IMPL_METAL_CPP_EXTENSIONS
42 // #include <AppKit/AppKit.hpp>
43 #ifndef __OBJC__
44
45 // Follow "Getting Started" link and check examples/ folder to learn about using backends!
46 IMGUI_IMPL_API bool ImGui_ImplOSX_Init(void* _Nonnull view);
47 IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown();
48 IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame(void* _Nullable view);
49
50 #endif
51 #endif
52
53 #endif // #ifndef IMGUI_DISABLE