imgui-mirror/backends/imgui_impl_null.h
Sharadh Rajaraman 08fbbd9624 backends: prepare for inclusion in a C++20 module purview
Each backend becomes its own module that imports 'imgui' and includes
its header and source in the purview. Do the same preparation as for
the core:
- Skip system, platform and graphics API includes under
  IMGUI_CXX_MODULE, because the module includes them in its global
  module fragment.
- Skip the forward declarations of platform types (GLFWwindow,
  SDL_Window, ID3D11Device...). Declared in the purview, they would be
  new types attached to the backend module instead of the real ones.
  For the same reason, sdl2 drops the elaborated
  'struct _SDL_GameController'.
- Wrap each header's API in IMGUI_EXPORT_BEGIN/END.
- win32: export ImGui_ImplWin32_WndProcHandler() under IMGUI_CXX_MODULE.
  The header keeps it commented out to avoid pulling in <windows.h>,
  but a module user can't forward-declare it themselves.
- glfw: skip the local GetIO(ImGuiContext*) declaration, because
  'imgui' exports it.
2026-09-28 16:11:53 +00:00

37 lines
1.6 KiB
C

// dear imgui: Null Platform+Renderer Backends
// This is designed if you need to use a blind Dear Imgui context with no input and no output.
// 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.
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
#pragma once
#include "imgui.h" // IMGUI_IMPL_API
#ifndef IMGUI_DISABLE
IMGUI_EXPORT_BEGIN
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
// Null = NullPlatform + NullRender
IMGUI_IMPL_API bool ImGui_ImplNull_Init();
IMGUI_IMPL_API void ImGui_ImplNull_Shutdown();
IMGUI_IMPL_API void ImGui_ImplNull_NewFrame();
// Null platform only (single screen, fixed timestep, no inputs)
IMGUI_IMPL_API bool ImGui_ImplNullPlatform_Init();
IMGUI_IMPL_API void ImGui_ImplNullPlatform_Shutdown();
IMGUI_IMPL_API void ImGui_ImplNullPlatform_NewFrame();
// Null renderer only (no output)
IMGUI_IMPL_API bool ImGui_ImplNullRender_Init();
IMGUI_IMPL_API void ImGui_ImplNullRender_Shutdown();
IMGUI_IMPL_API void ImGui_ImplNullRender_NewFrame();
IMGUI_IMPL_API void ImGui_ImplNullRender_RenderDrawData(ImDrawData* draw_data);
IMGUI_EXPORT_END
#endif // #ifndef IMGUI_DISABLE