2022-05-18 16:23:10 -04:00
// dear imgui: Platform Backend for OSX / Cocoa
// This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan, Metal..)
2023-06-08 01:29:16 -04:00
// - Not well tested. If you want a portable application, prefer using the GLFW or SDL platform Backends on Mac.
// - Requires linking with the GameController framework ("-framework GameController").
2022-05-18 16:23:10 -04:00
// Implemented features:
// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
2023-06-08 01:29:16 -04:00
// [X] Platform: Mouse support. Can discriminate Mouse/Pen.
2025-08-11 16:09:28 -04:00
// [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]
2022-05-18 16:23:10 -04:00
// [X] Platform: OSX clipboard is supported within core Dear ImGui (no specific code in this backend).
// [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
// [X] Platform: IME support.
2025-08-10 04:12:45 -04:00
// [x] Platform: Multi-viewport / platform windows.
2025-08-10 05:01:31 -04:00
// Issues:
// [ ] Platform: Multi-viewport: Window size not correctly reported when enabling io.ConfigViewportsNoDecoration
// [ ] Platform: Multi-viewport: ParentViewportID not honored, and so io.ConfigViewportsNoDefaultParent has no effect (minor).
2022-05-18 16:23:10 -04:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
2025-08-09 22:26:36 -04:00
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2022-05-18 16:23:10 -04:00
# include "imgui.h" // IMGUI_IMPL_API
2023-08-30 01:42:51 -04:00
# ifndef IMGUI_DISABLE
2022-05-18 16:23:10 -04:00
2023-06-08 01:29:16 -04:00
# ifdef __OBJC__
2022-05-18 16:23:10 -04:00
@ class NSEvent ;
@ class NSView ;
2025-08-10 06:07:58 -04:00
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
2022-05-18 16:23:10 -04:00
IMGUI_IMPL_API bool ImGui_ImplOSX_Init ( NSView * _Nonnull view ) ;
IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame ( NSView * _Nullable view ) ;
2023-06-08 01:29:16 -04:00
# endif
//-----------------------------------------------------------------------------
// C++ API
//-----------------------------------------------------------------------------
# ifdef IMGUI_IMPL_METAL_CPP_EXTENSIONS
// #include <AppKit/AppKit.hpp>
# ifndef __OBJC__
2025-08-10 06:07:58 -04:00
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
2023-06-08 01:29:16 -04:00
IMGUI_IMPL_API bool ImGui_ImplOSX_Init ( void * _Nonnull view ) ;
IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame ( void * _Nullable view ) ;
# endif
# endif
2023-08-30 01:42:51 -04:00
# endif // #ifndef IMGUI_DISABLE