The documentation is not complete, so I cannot build anything

[Pietro228]

Hello,

I wanted to add imgui to my OpenGL project running on Metal (M1 MacBook Air). I have added the code, but I don't know what some placeholders mean. This documentation states that I only have to add some lines of code, but does not even explain what this line ImGui_ImplMetal_Init(YOUR_METAL_DEVICE); with "YOUR_METAL_DEVICE" means. What should I put here? A small comment would be really great. Like this I will now have to search for clues like a Sherlock..

[PathogenDavid]

OpenGL project running on Metal

OpenGL and Metal are different graphics APIs. (And Metal is just one of many frameworks that makes up macOS.) You should be using the imgui_impl_opengl3 render backend, not imgui_impl_metal.

"OpenGL on Metal" is technically possible through things like ANGLE, but it's very unlikely that's what you're actually doing. (Even so, you would ignore the Metal aspect in that scenario.)

---

Generally it's best to reference an example that most closely matches your app.

Recommending a specific example would require knowing the platform backend that's relevant to your situation, the three most likely candidates for an OpenGL macOS app would be:

• SDL via imgui_impl_sdl3 (Example code)
• GLFW via imgui_impl_glfw (Example code)
• Cocoa/AppKit via imgui_impl_osx (Unfortunately there's not a modern OpenGL example for this. This community doesn't have many macOS-focused folks--probably why there's no example--so probably best to avoid either way.)

If you aren't married to a platform backend already, I'd recommend GLFW for simplicity or SDL if you think you'll eventually want the other stuff it provides.