ImGuiOverlayRenderSystem Class

Adapts an ImGuiOverlay to the engine runtime system update step. More...

Declaration

class helios::imgui::systems::ImGuiOverlayRenderSystem { ... }

Public Member Typedefs Index

using	EngineRoleTag = SystemRole
	Runtime role tag used by the engine system registry. More...

Public Constructors Index

	ImGuiOverlayRenderSystem (ImGuiOverlay &overlay)
	Creates a render system bound to a specific ImGui overlay. More...

Public Member Functions Index

void	update (UpdateContext &updateContext) noexcept
	Executes one system update and renders the bound overlay. More...

Private Member Attributes Index

ImGuiOverlay &	overlay_
	Referenced overlay rendered by this system. More...

Description

Adapts an ImGuiOverlay to the engine runtime system update step.

The system keeps a reference to an overlay instance and invokes ImGuiOverlay::render() on each update.

Definition at line 28 of file ImGuiOverlayRenderSystem.ixx.

Public Member Typedefs

EngineRoleTag

using helios::imgui::systems::ImGuiOverlayRenderSystem::EngineRoleTag = SystemRole

Runtime role tag used by the engine system registry.

Definition at line 40 of file ImGuiOverlayRenderSystem.ixx.

40 using EngineRoleTag = SystemRole;

Public Constructors

ImGuiOverlayRenderSystem()

helios::imgui::systems::ImGuiOverlayRenderSystem::ImGuiOverlayRenderSystem (ImGuiOverlay & overlay)

inline explicit

Creates a render system bound to a specific ImGui overlay.

Parameters

overlay

Overlay instance to render on update.

Definition at line 47 of file ImGuiOverlayRenderSystem.ixx.

47 explicit ImGuiOverlayRenderSystem(ImGuiOverlay& overlay) : overlay_(overlay) {}

Public Member Functions

update()

void helios::imgui::systems::ImGuiOverlayRenderSystem::update (UpdateContext & updateContext)

inline noexcept

Executes one system update and renders the bound overlay.

Parameters

updateContext

Per-frame update context provided by the runtime.

Definition at line 53 of file ImGuiOverlayRenderSystem.ixx.

53 void update(UpdateContext& updateContext) noexcept {

54 overlay_.render();

55 };

Reference helios::imgui::ImGuiOverlay::render.

Private Member Attributes

overlay_

ImGuiOverlay& helios::imgui::systems::ImGuiOverlayRenderSystem::overlay_

Referenced overlay rendered by this system.

Definition at line 33 of file ImGuiOverlayRenderSystem.ixx.

33 ImGuiOverlay& overlay_;

---

The documentation for this class was generated from the following file:

• ImGuiOverlayRenderSystem.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.