imgui_impl_osx.h 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. // Implemented features:
  6. // [X] Platform: Clipboard support is part of core Dear ImGui (no specific code in this backend).
  7. // [X] Platform: Mouse support. Can discriminate Mouse/Pen.
  8. // [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]
  9. // [X] Platform: Gamepad support. Enabled with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  10. // [X] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'.
  11. // [X] Platform: IME support.
  12. // Missing features or Issues:
  13. // [ ] Missing ImGuiMouseCursor_Wait and ImGuiMouseCursor_Progress cursors.
  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. #pragma once
  22. #include "imgui.h" // IMGUI_IMPL_API
  23. #ifndef IMGUI_DISABLE
  24. #ifdef __OBJC__
  25. @class NSEvent;
  26. @class NSView;
  27. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  28. IMGUI_IMPL_API bool ImGui_ImplOSX_Init(NSView* _Nonnull view);
  29. IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown();
  30. IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame(NSView* _Nullable view);
  31. #endif
  32. //-----------------------------------------------------------------------------
  33. // C++ API
  34. //-----------------------------------------------------------------------------
  35. #ifdef IMGUI_IMPL_METAL_CPP_EXTENSIONS
  36. // #include <AppKit/AppKit.hpp>
  37. #ifndef __OBJC__
  38. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  39. IMGUI_IMPL_API bool ImGui_ImplOSX_Init(void* _Nonnull view);
  40. IMGUI_IMPL_API void ImGui_ImplOSX_Shutdown();
  41. IMGUI_IMPL_API void ImGui_ImplOSX_NewFrame(void* _Nullable view);
  42. #endif
  43. #endif
  44. #endif // #ifndef IMGUI_DISABLE