Add Frame Time Display module

Author: Plextora

LatiteRewrite.vcxproj

@@ -432,6 +432,7 @@
     <ClInclude Include="src\client\feature\module\impl\hud\Chat.h" />
     <ClInclude Include="src\client\feature\module\impl\hud\ComboCounter.h" />
     <ClInclude Include="src\client\feature\module\impl\hud\CustomCoordinates.h" />
+    <ClInclude Include="src\client\feature\module\impl\hud\FrameTimeDisplay.h" />
     <ClInclude Include="src\client\feature\module\impl\hud\ItemCounter.h" />
     <ClInclude Include="src\client\feature\module\impl\hud\MovableBossbar.h" />
     <ClInclude Include="src\client\feature\module\impl\hud\MovableCoordinates.h" />
@@ -737,6 +738,7 @@
     <ClCompile Include="deps\mnem\scan\scanner.cpp" />
     <ClCompile Include="deps\mnem\scan\scanner_avx2.cpp" />
     <ClCompile Include="src\client\feature\module\impl\game\AutoGG.cpp" />
+    <ClCompile Include="src\client\feature\module\impl\hud\FrameTimeDisplay.cpp" />
     <ClCompile Include="src\client\feature\module\impl\visual\NoHurtCam.cpp" />
     <ClCompile Include="src\client\feature\module\impl\game\EnvironmentChanger.cpp" />
     <ClCompile Include="src\client\feature\module\impl\game\Freelook.cpp" />

LatiteRewrite.vcxproj.filters

@@ -162,6 +162,7 @@
     <ClCompile Include="src\client\feature\module\impl\hud\TabList.cpp" />
     <ClCompile Include="src\client\script\objects\OSScriptingObject.cpp" />
     <ClCompile Include="src\client\feature\module\impl\game\AutoGG.cpp" />
+    <ClCompile Include="src\client\feature\module\impl\hud\FrameTimeDisplay.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="assets\lang\en_US.json" />
@@ -481,6 +482,7 @@
     <ClInclude Include="assets\lang\zh_CN.json" />
     <ClInclude Include="assets\lang\zh_TW.json" />
     <ClInclude Include="src\client\script\objects\OSScriptingObject.h" />
+    <ClInclude Include="src\client\feature\module\impl\hud\FrameTimeDisplay.h" />
   </ItemGroup>
   <ItemGroup>
     <ResourceCompile Include="LatiteRewrite.rc" />

src/client/feature/module/ModuleManager.cpp

@@ -49,6 +49,7 @@
 #include "impl/hud/ComboCounter.h"
 #include "impl/hud/CustomCoordinates.h"
 #include "impl/hud/MovableCoordinates.h"
+#include "impl/hud/FrameTimeDisplay.h"
 
 #include "client/event/impl/KeyUpdateEvent.h"
 
@@ -97,6 +98,7 @@ ModuleManager::ModuleManager() {
 	this->items.push_back(std::make_shared<MovableCoordinates>());
 	this->items.push_back(std::make_shared<NoHurtCam>());
 	this->items.push_back(std::make_shared<AutoGG>());
+	this->items.push_back(std::make_shared<FrameTimeDisplay>());
 
 	for (auto& mod : items) {
 		mod->onInit();

src/client/feature/module/impl/hud/FrameTimeDisplay.cpp

@@ -0,0 +1,41 @@
+#include "pch.h"
+#include "FrameTimeDisplay.h"
+#include "client/Latite.h"
+
+// TODO: Make this module translatable
+FrameTimeDisplay::FrameTimeDisplay() : TextModule("FrameTimeDisplay", L"Frame Time Display",
+                                                  L"Displays the time it takes to render and display a frame (in milliseconds)",
+                                                  HUD, 400.f, 0, true) {
+
+    addSliderSetting("interval", L"Interval",
+        L"The amount of time it takes to update the display (in milliseconds)", interval, FloatValue(0.f),
+        FloatValue(1000.f), FloatValue(100.f));
+	this->prefix = TextValue(L"Frame time: ");
+	this->suffix = TextValue(L"ms");
+}
+
+std::wstringstream FrameTimeDisplay::text(bool isDefault, bool inEditor) {
+	// normal caching in the TextModule constructor didnt work so im doing this
+    static std::wstring cachedText;
+    static std::chrono::steady_clock::time_point lastUpdate;
+    static float displayedValue = -1.0f;
+
+    const float currentValue = Latite::get().getTimings().getFrameTime();
+    const std::chrono::time_point<std::chrono::steady_clock> now = std::chrono::steady_clock::now();
+    const long long elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(now - lastUpdate).count();
+
+    if (elapsed >= std::get<FloatValue>(interval)) {
+        std::wstringstream ss;
+        ss << std::fixed << std::setprecision(1) << currentValue;
+        cachedText = ss.str();
+        displayedValue = currentValue;
+        lastUpdate = now;
+    }
+
+    std::wstringstream output;
+    if (!cachedText.empty()) {
+        output.str(cachedText);
+        output.clear();
+    }
+    return output;
+}

src/client/feature/module/impl/hud/FrameTimeDisplay.h

@@ -0,0 +1,11 @@
+#pragma once
+#include "../../TextModule.h"
+
+class FrameTimeDisplay : public TextModule {
+public:
+	FrameTimeDisplay();
+
+	std::wstringstream text(bool isDefault, bool inEditor) override;
+private:
+	ValueType interval = FloatValue(100.f);
+};

src/client/misc/Timings.cpp

@@ -17,6 +17,12 @@ int Timings::getPerSecond(std::vector<std::chrono::steady_clock::time_point>& li
 
 void Timings::update()
 {
+	std::chrono::time_point<std::chrono::steady_clock> now = std::chrono::high_resolution_clock::now();
+
+	auto currentFrameDuration = now - lastFrameTime;
+	frameTime = std::chrono::duration<float, std::milli>(currentFrameDuration).count();
+	lastFrameTime = now;
+
 	auto dur = std::chrono::high_resolution_clock::now() - lastFPSTime;
 	float dir = std::chrono::duration<float, std::milli>(dur).count();
 	if (dir > 1000) {

src/client/misc/Timings.h

@@ -18,9 +18,11 @@ class Timings final
 	[[nodiscard]] int getFPS() { return fps; }
 	[[nodiscard]] int getCPSL() { return cpsL; }
 	[[nodiscard]] int getCPSR() { return cpsR; }
+	[[nodiscard]] float getFrameTime() { return frameTime; }
 private:
 
 	std::chrono::steady_clock::time_point beginTime{};
+	std::chrono::high_resolution_clock::time_point lastFrameTimeUpdate;
 	float injectTime = 0.f;
 
 	int cpsL = 0;
@@ -29,6 +31,9 @@ class Timings final
 	int fps = 0;
 	float tps = 0;
 
+	std::chrono::high_resolution_clock::time_point lastFrameTime;
+	float frameTime = 0.0f;
+
 	std::vector<std::chrono::steady_clock::time_point> cpsLV;
 	std::vector<std::chrono::steady_clock::time_point> cpsRV;
 	std::vector<std::chrono::steady_clock::time_point> tpsV;