GameLoop.ixx File

Central orchestrator for the game update cycle. More...

Included Headers

#include <cassert> #include <memory> #include <vector> #include <span> #include <helios.engine.runtime.world.Manager> #include <helios.engine.runtime.gameloop:Phase> #include <helios.engine.runtime.enginestate.types> #include <helios.engine.runtime.messaging.event.GameLoopEventBus> #include <helios.engine.runtime.world.GameWorld> #include <helios.ecs> #include <helios.engine.util.log.LogManager> #include <helios.engine.input.InputSnapshot> #include <helios.engine.util.log.Logger> #include <helios.engine.runtime.world.UpdateContext>

Namespaces Index

namespace	helios
namespace	engine
namespace	runtime
namespace	gameloop

Classes Index

class	GameLoop
	Central orchestrator for the game update cycle. More...

Macro Definitions Index

#define	HELIOS_LOG_SCOPE   "helios::engine::runtime::gameloop::GameLoop"

Description

Central orchestrator for the game update cycle.

Macro Definitions

HELIOS_LOG_SCOPE

#define HELIOS_LOG_SCOPE   "helios::engine::runtime::gameloop::GameLoop"

Definition at line 38 of file GameLoop.ixx.

38#define HELIOS_LOG_SCOPE "helios::engine::runtime::gameloop::GameLoop"

File Listing

The file content with the documentation metadata removed is:

1

5module;

6

7#include <cassert>

8#include <memory>

9#include <vector>

10#include <span>

11

12export module helios.engine.runtime.gameloop:GameLoop;

13

14import helios.engine.runtime.world.GameWorld;

15

16import helios.engine.runtime.world.UpdateContext;

17import helios.engine.util.log.Logger;

18import helios.engine.util.log.LogManager;

19

20import helios.ecs;

21

22import helios.engine.runtime.messaging.event.GameLoopEventBus;

23

24import helios.engine.runtime.enginestate.types;

25

26import :CommitPoint;

27import :Phase;

28import :PassCommitListener;

29

30import helios.engine.runtime.world.Manager;

31

32import helios.engine.input.InputSnapshot;

33

34import helios.engine.runtime.world.GameWorld;

35

36using namespace helios::engine::runtime::world;

37

38#define HELIOS_LOG_SCOPE "helios::engine::runtime::gameloop::GameLoop"

39export namespace helios::engine::runtime::gameloop {

40

88 class GameLoop : public helios::engine::runtime::gameloop::PassCommitListener {

89

90

97 bool initialized_ = false;

98 protected:

99

100

101

105 inline static const helios::engine::util::log::Logger& logger_ = helios::engine::util::log::LogManager::loggerForScope(

106 HELIOS_LOG_SCOPE);

107 GameWorld& gameWorld_;

108

109

113 helios::engine::runtime::gameloop::Phase prePhase_;

114

118 helios::engine::runtime::gameloop::Phase mainPhase_;

119

123 helios::engine::runtime::gameloop::Phase postPhase_;

124

125

136 helios::engine::runtime::messaging::event::GameLoopEventBus phaseEventBus_{};

137

149 helios::engine::runtime::messaging::event::GameLoopEventBus passEventBus_{};

150

165 helios::engine::runtime::messaging::event::GameLoopEventBus frameEventBus_{};

166

170 float totalTime_ = 0.0f;

171

172

173

198 void onPassCommit(

199 const CommitPoint commitPoint,

200 GameWorld& gameWorld,

201 UpdateContext& updateContext) noexcept {

202

203 // commands must be executed before Managers

204 if ((commitPoint & CommitPoint::FlushCommands) == CommitPoint::FlushCommands) {

205 gameWorld.flushCommandBuffers(updateContext);

206 }

207

208 if ((commitPoint & CommitPoint::FlushManagers) == CommitPoint::FlushManagers) {

209 gameWorld.flushManagers(updateContext);

210 }

211

212 // managers might create pass events

213 if ((commitPoint & CommitPoint::PassEvents) == CommitPoint::PassEvents) {

214 passEventBus_.swapBuffers();

215 }

216

217 }

218

235 void phaseCommit(

236 GameWorld& gameWorld,

237 UpdateContext& updateContext) {

238

239 passEventBus_.clearAll();

240

241 // command buffers generate requests for managers, so this comes first

242 gameWorld.flushCommandBuffers(updateContext);

243

244 // managers process requests

245 gameWorld.flushManagers(updateContext);

246

247 // make sure flushed managers make their events available to the phase event bus

248 phaseEventBus_.swapBuffers();

249 }

250

251

252 public:

253

254

264 GameLoop(GameWorld& gameWorld) : gameWorld_(gameWorld), prePhase_(*this, gameWorld_), mainPhase_(*this, gameWorld_), postPhase_(*this, gameWorld_) {};

265

266

274 [[nodiscard]] helios::engine::runtime::gameloop::Phase& phase(const helios::engine::runtime::gameloop::PhaseType phaseType) noexcept {

275

276 switch (phaseType) {

277 case helios::engine::runtime::gameloop::PhaseType::Pre:

278 return prePhase_;

279 break;

280 case helios::engine::runtime::gameloop::PhaseType::Main:

281 return mainPhase_;

282 break;

283 case helios::engine::runtime::gameloop::PhaseType::Post:

284 return postPhase_;

285 break;

286 }

287

288 std::unreachable();

289

290 }

291

292

311 void init(GameWorld& gameWorld) {

312

313 assert(!initialized_ && "init() already called");

314

315 prePhase_.init(gameWorld);

316 prePhase_.addPassCommitListener(this);

317

318 mainPhase_.init(gameWorld);

319 mainPhase_.addPassCommitListener(this);

320

321 postPhase_.init(gameWorld);

322 postPhase_.addPassCommitListener(this);

323

324 initialized_ = true;

325 }

326

327 GameWorld& gameWorld() noexcept {

328 return gameWorld_;

329 }

330

361 void update(

362 GameWorld& gameWorld,

363 float deltaTime,

364 const helios::engine::input::InputSnapshot& inputSnapshot

365 ) noexcept {

366

367 assert(initialized_ && "GameLoop not initialized");

368

369 totalTime_ += deltaTime;

370

371 auto updateContext = UpdateContext(

372 gameWorld.session(),

373 gameWorld.runtimeEnvironment(),

374 deltaTime,

375 totalTime_,

376 phaseEventBus_,

377 passEventBus_,

378 frameEventBus_,

379 inputSnapshot,

380 gameWorld.level(),

381 gameWorld.engineWorld()

382 );

383

384 auto& session = gameWorld.session();

385

386 // gameloop phases

387 prePhase_.update(gameWorld, updateContext);

388 phaseCommit(gameWorld, updateContext);

389

390 mainPhase_.update(gameWorld, updateContext);

391 phaseCommit(gameWorld, updateContext);

392

393 postPhase_.update(gameWorld, updateContext);

394 phaseCommit(gameWorld, updateContext);

395 frameEventBus_.swapBuffers();

396 }

397

398 [[nodiscard]] bool isRunning( GameWorld& gameWorld) const noexcept {

399 return initialized_ && !gameWorld.session().isDestroyed();

400 }

401

402

403

404 };

405

406}

407

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.