＜2021SC@SDUSC＞ 开源游戏引擎 Overload 代码模块分析 之 OvGame（六）—— Core（三）Game

2021SC@SDUSC
开源游戏引擎 Overload 代码模块分析 之 OvGame（六）—— Core（三）Game

前言

经过之前的几篇探究，咱们终于为本篇的探究部分做好了铺垫。本篇是 OvGame 的 Core 的第三篇，将探究其 Game 部分。

之前的几篇作为铺垫，是因为 Game 包含了 Core 的 Context 与 GameRenderer，并用到了同属 OvGame 模块的 Utils 文件以及 Debug 文件，所以如果读者已经有些遗忘、或是尚未了解过，请先前往 Core（一） 、Core（二） 、Utils 与 Debug（上） 、Debug（下） 阅读。

另外，若想先大致了解该引擎各个大模块，可前往笔者这篇相关文章查看。
若想了解 OvGame 大纲，可前往笔者这篇文章。

分析

1、Game

1.1 Game.h

1.1.1 头文件

#include 
#include 

#include "OvGame/Core/Context.h"
#include "OvGame/Core/GameRenderer.h"

#include "OvGame/Utils/FPSCounter.h"

#ifdef _DEBUG
#include "OvGame/Debug/DriverInfo.h"
#include "OvGame/Debug/GameProfiler.h"
#include "OvGame/Debug/FrameInfo.h"
#endif

显然，Game 部分包含了 Overload 其它模块的文件，以及前言中提及的 Core、Utils、Debug 的文件。

1.1.2 主要代码

主要代码是 Game 类，负责处理游戏逻辑。先看它的公有函数，定义如下：

class Game
	{
	public:
		/**
		* Create the game
		* @param p_context
		*/
		Game(Context& p_context);

		/**
		* Destroy the game
		*/
		~Game();

		/**
		* Pre-update of the game logic
		*/
		void PreUpdate();

		/**
		* Update the game logic
		* @param p_deltaTime
		*/
		void Update(float p_deltaTime);

		/**
		* Post-update of the game logic
		*/
		void PostUpdate();

函数功能都有英文注释了，不多赘述，主要是注意三个函数的发生顺序：更新前、开始更新、更新后。接下来看私有变量：

	private:
		float m_elapsed = 0.0f;

		OvGame::Core::Context& m_context;
		OvUI::Modules::Canvas m_canvas;

		OvGame::Core::GameRenderer m_gameRenderer;

		/* Debug elements */
		OvGame::Utils::FPSCounter	m_fpsCounter;

		#ifdef _DEBUG
		OvGame::Debug::DriverInfo	m_driverInfo;
		OvGame::Debug::GameProfiler m_gameProfiler;
		OvGame::Debug::FrameInfo	m_frameInfo;
		#endif

		#ifdef _DEBUG
		bool m_showDebugInformation = true;
		#else
		bool m_showDebugInformation = false;
		#endif
	};

除了一些含义如其英文释义的变量，该类还定义了多个来自 OvGame 的类对象（请读者查阅笔者在 “ 前言 ” 中的过往文章，在此不再复述）；此外，该类还定义了 Canvas 类的对象，该类是一个绘制 UI 框架的画布。

此处定义用到了之前讲过的 #ifdef 条件编译命令，此处不同的是还有用到 #else，含义是：如果没有定义 _DEBUG，则编译定义 #else 下包含代码段中的变量。所以该语段的作用是设置是否进入了调试功能，默认未调试时为 false。

1.2 Game.cpp

1.2.1 头文件

#include "OvGame/Core/Game.h"

#include 
#include 

#include 

引入的都是 Overload 多个模块的内容，在此依然暂不多说。

1.2.2 主要代码

Game() 函数

OvGame::Core::Game::Game(Context & p_context) :
	m_context(p_context),
	m_gameRenderer(p_context),
	m_fpsCounter(*p_context.window)
	#ifdef _DEBUG
	,
	m_driverInfo(*m_context.renderer, *m_context.window),
	m_gameProfiler(*p_context.window, 0.25f),
	m_frameInfo(*m_context.renderer, *m_context.window)
	#endif
{
	m_context.uiManager->SetCanvas(m_canvas);
	m_canvas.AddPanel(m_fpsCounter);
	#ifdef _DEBUG
	m_canvas.AddPanel(m_driverInfo);
	m_canvas.AddPanel(m_gameProfiler);
	m_canvas.AddPanel(m_frameInfo);
	#endif

	m_context.sceneManager.LoadScene(m_context.projectSettings.Get<std::string>("start_scene"));
	m_context.sceneManager.GetCurrentScene()->Play();
}

这是该类的构造函数，首先传入了 Context 类对象参数，并用参数初始化表初始化多个变量，其中也用到了条件编译命令；接着函数内，m_context 的变量 UI 管理者调用 SetCanvas() 设置可用的画布；然后，m_canvas 调用 AddPanel() 添加多个面板到画布，面板内容（包括条件编译命令里的）都是各种信息；最后，m_context 的 场景管理者调用 LoadScene()、传入 项目设置的开始界面的值来加载场景，并调用 GetCurrentScene() 的 Play() 来激活对当前场景的使用。

~Game() 函数

OvGame::Core::Game::~Game()
{
	m_context.sceneManager.UnloadCurrentScene();
}

这是该类的析构函数，调用 UnloadCurrentScene() 来清除当前场景的所有存储。

PreUpdate() 函数

void OvGame::Core::Game::PreUpdate()
{
	#ifdef _DEBUG
	PROFILER_SPY("Pre-Update");
	#endif
	m_context.device->PollEvents();
}

该函数负责预先处理：先是条件编译命令，其意义是如果进行 debug，则使用 PROFILER_SPY() 加入 Pre-Update 预更新的分析器；接着，调用 PollEvents() 使用已创建的窗口启用输入和事件管理。

Update() 函数

该函数是该类的主要函数，负责更新逻辑。代码很长，我们分段看：

void OvGame::Core::Game::Update(float p_deltaTime)
{
	m_elapsed += p_deltaTime;

	m_context.engineUBO->SetSubData(m_elapsed, 3 * sizeof(OvMaths::FMatrix4) + sizeof(OvMaths::FVector3));

	m_context.renderer->ClearFrameInfo();

首先，用传入的单位时间参数更新经过了的时间 m_elapsed；再调用 SetSubData() 设置 UBO 中的数据，该函数在之前的文章已经讲解过；然后调用 ClearFrameInfo() 清空渲染器框架信息。

接下来进行一个 if 判断，如果 GetCurrentScene() 获得当前场景，则进入语段（反之，返回的是 nullptr 无法通过判断）：

	if (auto currentScene = m_context.sceneManager.GetCurrentScene())
	{
		{
			#ifdef _DEBUG
			PROFILER_SPY("Physics Update");
			#endif

			if (m_context.physicsEngine->Update(p_deltaTime))
				currentScene->FixedUpdate(p_deltaTime);
		}

首先，与 PreUpdate() 函数异曲同工的条件编译命令，不多说了；然后判断如果成功更新了物理系统，则调用 FixedUpdate() 以每秒 60 帧更新每一个 actor（游戏引擎里的专业术语，指各种物件对象）；接下来，同样的方法，依次更新了当前场景、音频系统，呼叫渲染器进行渲染：

		{
			#ifdef _DEBUG
			PROFILER_SPY("Scene Update");
			#endif
			currentScene->Update(p_deltaTime);
			currentScene->LateUpdate(p_deltaTime);
		}

		{
			#ifdef _DEBUG
			PROFILER_SPY("Audio Update");
			#endif
			m_context.audioEngine->Update();
		}

		{
			#ifdef _DEBUG
			PROFILER_SPY("Render Scene");
			#endif
			m_gameRenderer.RenderScene();
		}
	}

	m_context.sceneManager.Update();

最后，退出 if 语段后，场景管理者再整体更新一次（此处的多个更新函数来自 Overload 的其它模块，非笔者研究范畴，请读者自行了解）。

接下来进行其它的 if 判断：

	if  (m_context.inputManager->IsKeyPressed(OvWindowing::Inputs::EKey::KEY_F12))
		m_showDebugInformation = !m_showDebugInformation;

首先，IsKeyPressed() 的参数来自一个枚举类 OvWindowing::Inputs::EKey，它为键盘所有按键赋予了一个整数值（此处为 F12 按键，即调试键）；IsKeyPressed() 获得该值后，进入哈希表，调用 find() 查找 key 并设置 key 对应的 value 为枚举类 EKeyState 中的 “ 按下 ”（实际代码中赋值为 1）。

上述的操作是用逻辑运算符 “ && ” 连接的，所以若成功则返回 true，若失败（即查表未找到）则返回 false；若通过 if 判断，则将 bool 型的变量 m_showDebugInformation 取反。

下一段条件编译命令中的 if 判断也是一个道理：

	#ifdef _DEBUG
	if (m_context.inputManager->IsKeyPressed(OvWindowing::Inputs::EKey::KEY_R))
		OvRendering::Resources::Loaders::ShaderLoader::Recompile(*m_context.shaderManager[":Shaders\\Standard.glsl"], "Data\\Engine\\Shaders\\Standard.glsl");
	#endif

此处，按键为 “ R ”，即刷新键；所以 if 语段内调用 Recompile() 函数，重新编译参数给出的 glsl shader 文件。

而最后一个 if 判断，就基于上面提及的 m_showDebugInformation 的值：

	if (m_showDebugInformation)
	{
		m_fpsCounter.Update(p_deltaTime);
		#ifdef _DEBUG
		m_gameProfiler.Update(p_deltaTime);
		m_frameInfo.Update(p_deltaTime);
		#endif
		m_context.uiManager->Render();
	}
}

如果为 true，即进入了 Debug 调试功能，则通过 if：首先，第一个 Update() 更新单位时间的 FPS 值；其次，条件编译命令内更新游戏配置文件以及框架信息；最后，UI 管理器 Render() 渲染出以上所有的内容。

所以整体来看 Update()，可以发现它在未调试的时候仅更新记录流逝的时间、UBO、渲染器，而其它大部分的内容都是在调试阶段才更新信息并显示的。

PostUpdate() 函数

void OvGame::Core::Game::PostUpdate()
{
	#ifdef _DEBUG
	PROFILER_SPY("Post-Update");
	#endif
	m_context.window->SwapBuffers();
	m_context.inputManager->ClearEvents();
}

最后这个函数是在更新后操作的：首先，与上文一样，Debug 时候才编译设置分析器；接着，调用 SwapBuffers() 处理缓冲与当前窗口的交替；最后，调用 ClearEvents() 清除所有的键盘或鼠标的输入信息。

总结

总体来看，Game 类代码并不困难，其重要的操作就是：从 PreUpdate() 启用输入和事件、经过 Update() 更新、到 PostUpdate() 结束输入输出缓存的一套逻辑更新。

另一方面，从代码中可以明显地看到几乎每一处函数都用到了条件为 Debug 的条件编译命令。利用它，就可以实现不同的展示界面，犹如进入了一个新模式，Debug 模式。这是值得我们参考学习的一个简化代码提高效率的方法。

现在，Game 部分也全部探究完了，对于 Core 文件的最后一个部分的所有铺垫也完成了。那么下一篇，咱们将探究 OvGame 模块的 Core 文件的最后一部分：Application 以及 OvGame 的最终功能整合文件 Main.cpp。