OSX examples/bindings: help/maintainers wanted

[ocornut]

Hello,

As part of the work mentioned in #1870 I have pushed a first pass of refactored examples to Master. While the changes are fairly consequent it shouldn't really affect users directly as your existing bindings/code will still work.

The core idea behind this refactor that we are separating the example "Platform code" (inputs, windowing, time) from the example "Renderer code" (directx, opengl, vulkan..). This separation has various advantage, but in particular become more important and valuable as we move toward the Viewport feature, which puts more responsibility on the Platform code. Another benefit is that framework like GLFW today don't support all the features we need for multi-viewport, and although the suggestions are being pushed to GLFW, having a fallback native path would be useful, as one of the top priority in the upcoming few months will be to get multi-viewport good enough to be in master.

I have now added an OSX branch https://github.com/ocornut/imgui/tree/osx, based on old work by @Pagghiu (#281) which we reworked with @itamago.

It consist mostly in:

examples/imgui_impl_osx.mm
examples/imgui_impl_osx.h
examples/example_osx_opengl2/main.cpp

The main.cpp app basically combines imgui_impl_osx.mm + imgui_impl_opengl2.cpp into a demo app. Pretty simple stuff, no surprise. But since it is difficult for to make sensible progress on the Mac side, I would rather open a thread here.

Todo / Notes / If you want to help

• [ ] Does the design looks alright to you?
• [x] Missing: Clipboard is not supported.
• [x] Missing: Mouse cursors shapes are not supported.
• [x] We need to test a combination with imgui_impl_opengl3.cpp. We used the simpler imgui_impl_opengl2.cpp because of an issue related to the OpenGL loader. Could imgui_impl_opengl3 be fixed to work in the OSX ecosystem? (perhaps it doesn't need any loader there?) and a example_osx_opengl3/ demo app created accordingly.
• [ ] Improve hi dpi support.
• [x] The elephant in the room is obviously that OpenGL is now considered obsolete on OSX. So ideally we'd aim at adding a imgui_impl_metal piece of code that provided the rendering aspect of it.
• [x] Keyboard is completely broken. The keyboard mapping code is a little odd, which comes from the fact (and this is smart) that the keyboard events are covering both characters and keys (https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/EventOverview/HandlingKeyEvents/HandlingKeyEvents.html#//apple_ref/doc/uid/10000060i-CH7) by taking advantage of 0xF700 Unicode ranges for key. This doesn't fit super well with imgui's simplified approach. Any suggestion on how to improve that? Does it means that OSX doesn't have a concept of Keys? The current code maps 'a' to ImGuiKey_A but would a 'A' input work? Any suggestion/improvement?
• [x] Missing: Support for multi-viewport (current branch is based on Master, not on the Viewport branch).

EDIT In addition, I think we could later rework or dismantle the current example_apple/ folder which contains a bunch of odd cruft. I don't mind providing an example that include Synergy but the support code could probably be moved in libs/. Any suggestion on what to do with example_apple/ would be useful too.

Thanks!

[ocornut]

Work in progress Metal example/renderer there: https://github.com/warrenm/imgui/tree/metal

[ocornut]

• Merged Metal renderer courtesy of @warrenm, also merged his OSX & iOS + Metal example code! (#1929)
• Removed the old example_apple/ folder.
• Merged all those new stuff into master and removing the osx branch now.

Still missing from imgui_impl_osx.mm: support for mouse cursor shape and visibility.

[ocornut]

The example_apple_metal/ and example_apple_opengl2/ are:

• Missing cleanup code (context destruction)
• Inconsistent with each others in term of structure. I would suggest transitioning toward more like example_apple_opengl2/ is doing aka less off-topic code. Ideally they'll mirror each other as much as possible.

Could somebody familiar with OSX/iOS help with those?

[ocornut]

88f4c1321a4030120d364023f58c0d76815bb3cf tries to make both Metal and OpenGL2 example more similar but there are still a bunch of larger difference that we aren't familiar with. Would be nice is someone OSX/iOS friendly could decide how/if we should bridge the differences.

[ocornut]

Closing this as being an old general catchall issue. The big remaining issues is more general better hidpi support across all platform, which has its own OSX specifities but there are more than enough dedicated issues already :)