imgui_impl_android.h 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. // dear imgui: Platform Binding for Android native app
  2. // This needs to be used along with the OpenGL 3 Renderer (imgui_impl_opengl3)
  3. // Implemented features:
  4. // [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 AKEYCODE_* values are obsolete since 1.87 and not supported since 1.91.5]
  5. // [X] Platform: Mouse support. Can discriminate Mouse/TouchScreen/Pen.
  6. // Missing features or Issues:
  7. // [ ] Platform: Clipboard support.
  8. // [ ] Platform: Gamepad support. Enable with 'io.ConfigFlags |= ImGuiConfigFlags_NavEnableGamepad'.
  9. // [ ] Platform: Mouse cursor shape and visibility (ImGuiBackendFlags_HasMouseCursors). Disable with 'io.ConfigFlags |= ImGuiConfigFlags_NoMouseCursorChange'. FIXME: Check if this is even possible with Android.
  10. // Important:
  11. // - Consider using SDL or GLFW backend on Android, which will be more full-featured than this.
  12. // - FIXME: On-screen keyboard currently needs to be enabled by the application (see examples/ and issue #3446)
  13. // - FIXME: Unicode character inputs needs to be passed by Dear ImGui by the application (see examples/ and issue #3446)
  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. struct ANativeWindow;
  25. struct AInputEvent;
  26. // Follow "Getting Started" link and check examples/ folder to learn about using backends!
  27. IMGUI_IMPL_API bool ImGui_ImplAndroid_Init(ANativeWindow* window);
  28. IMGUI_IMPL_API int32_t ImGui_ImplAndroid_HandleInputEvent(const AInputEvent* input_event);
  29. IMGUI_IMPL_API void ImGui_ImplAndroid_Shutdown();
  30. IMGUI_IMPL_API void ImGui_ImplAndroid_NewFrame();
  31. #endif // #ifndef IMGUI_DISABLE