imgui/backends/imgui_impl_osx.h

// dear imgui: Platform Backend for OSX / Cocoa
// This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan, Metal..)
// [ALPHA] Early backend, not well tested. If you want a portable application, prefer using the GLFW or SDL platform Backends on Mac.

// Implemented features:
//  [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
//  [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 will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]
//  [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.
//
// 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.
// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.
// Read online: https://github.com/ocornut/imgui/tree/master/docs

#include "imgui.h"      // IMGUI_IMPL_API

#ifdef __OBJC__

@class NSEvent;
@class NSView;

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);

#endif

//-----------------------------------------------------------------------------
// C++ API
//-----------------------------------------------------------------------------

#ifdef IMGUI_IMPL_METAL_CPP_EXTENSIONS
// #include <AppKit/AppKit.hpp>
#ifndef __OBJC__

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
Docs: Renamed all occurences of "binding" and "back-end" to "backend" in comments and documentations, for consistency. 2020-10-12 23:34:22 +08:00			`// dear imgui: Platform Backend for OSX / Cocoa`
OSX: Various tweaks to imgui_impl_osx courtesy of @warrenm + fix NewFrame position which has been moved recently master. (#1873) 2018-07-04 19:24:16 +08:00			`// This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan, Metal..)`
Docs: Renamed all occurences of "binding" and "back-end" to "backend" in comments and documentations, for consistency. 2020-10-12 23:34:22 +08:00			`// [ALPHA] Early backend, not well tested. If you want a portable application, prefer using the GLFW or SDL platform Backends on Mac.`
Apple: Fixed example_osx_opengl2, renamed to example_apple_opengl2 + misc comments 2018-07-08 16:47:31 +08:00
Changelog, minor tweaks. (#2585) 2019-05-28 17:22:17 +08:00			`// Implemented features:`
			`// [X] Platform: Mouse cursor shape and visibility. Disable with 'io.ConfigFlags \|= ImGuiConfigFlags_NoMouseCursorChange'.`
Backends: OSX: Update to use io.AddEventKey() will full key map (#2625, #1873, #4858) 2021-12-12 19:04:13 +08: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 will also be supported unless IMGUI_DISABLE_OBSOLETE_KEYIO is set]`
Docs: Renamed all occurences of "binding" and "back-end" to "backend" in comments and documentations, for consistency. 2020-10-12 23:34:22 +08:00			`// [X] Platform: OSX clipboard is supported within core Dear ImGui (no specific code in this backend).`
Backends: OSX: Add Game Controller support. (#4759) 2021-12-11 05:10:21 +08:00			`// [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags \|= ImGuiConfigFlags_NavEnableGamepad'.`
Backends: OSX: Adedd basic IME support for macOS. (#3108, #2598) 2022-01-12 21:30:04 +08:00			`// [X] Platform: IME support.`
			`//`
Backends: OSX: Fix keyboard support. Handle scroll cancel. Don't set mouse cursor shape unconditionally. (#4759, #4253, #1873) Note the original FIXME: refered to GLFWs Cocoa implementation, which is largely what this commit provides. 2021-12-11 06:20:17 +08:00			`// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.`
Backends: Comments. 2021-05-27 19:59:35 +08:00			`// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.`
Moving backends code from examples/ to backends/ (step 6: update markdown documentation) 2020-10-14 18:22:53 +08:00			`// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp.`
			`// Read online: https://github.com/ocornut/imgui/tree/master/docs`

Backends: Comments next to include, misc minor comments/tweaks, fix imgui_impl_osx.h using IMGUI_API instead of IMGUI_IMPL_API. (#3105) 2020-04-07 17:02:29 +08:00			`#include "imgui.h" // IMGUI_IMPL_API`
Backends: Include imgui.h in implementation headers. (#3105) Currently, the implementation headers don't include the imgui.h header. Which means that the compilation will fail if the implementation header was included before the imgui.h header in the compilation unit. For instance, a compilation unit with the following will work: #include "imgui.h" #include "imgui_impl_glfw.h" #include "imgui_impl_opengl3.h" But a compilation unit with the following will fail because IMGUI_IMPL_API and possibly other symbols will not be defined: #include "imgui_impl_glfw.h" #include "imgui_impl_opengl3.h" #include "imgui.h" This patch includes imgui.h in the implementation headers to make inclusions order-invariant, which is a recommended practice. 2020-04-07 02:23:57 +08:00
Backends: Metal, OSX: Various fixes (ARC / Autorelease fixes with metal-cpp and extensions). (#5403) 2022-07-01 02:09:18 +08:00			`#ifdef __OBJC__`

Examples: Added imgui_impl_osx.mm bindings (#1870, #281) 2018-06-11 16:19:17 +08:00			`@class NSEvent;`
Introduced a new Metal renderer implementation and a new example illustrating usage of Metal on macOS and iOS (partially addresses #1873) 2018-07-05 17:41:21 +08:00			`@class NSView;`
Examples: Added imgui_impl_osx.mm bindings (#1870, #281) 2018-06-11 16:19:17 +08:00
Backends: OSX: Fix keyboard support. Handle scroll cancel. Don't set mouse cursor shape unconditionally. (#4759, #4253, #1873) Note the original FIXME: refered to GLFWs Cocoa implementation, which is largely what this commit provides. 2021-12-11 06:20:17 +08:00			`IMGUI_IMPL_API bool ImGui_ImplOSX_Init(NSView* _Nonnull view);`
Backends: Comments next to include, misc minor comments/tweaks, fix imgui_impl_osx.h using IMGUI_API instead of IMGUI_IMPL_API. (#3105) 2020-04-07 17:02:29 +08:00			`IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown();`
Misc: Bunch of code formatting changes suggested by a pass running 'astyle' 2020-06-30 21:31:54 +08:00			`IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame(NSView* _Nullable view);`
Backends: Metal, OSX: Various fixes (ARC / Autorelease fixes with metal-cpp and extensions). (#5403) 2022-07-01 02:09:18 +08:00
			`#endif`

			`//-----------------------------------------------------------------------------`
			`// C++ API`
			`//-----------------------------------------------------------------------------`

			`#ifdef IMGUI_IMPL_METAL_CPP_EXTENSIONS`
			`// #include <AppKit/AppKit.hpp>`
			`#ifndef __OBJC__`

			`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`