File size: 19,018 Bytes
7fd553e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 | // Copyright Epic Games, Inc. All Rights Reserved.
#include "CustomSettings/LyraSettingValueDiscrete_PerfStat.h"
#include "EditCondition/WhenPlayingAsPrimaryPlayer.h"
#include "GameSettingCollection.h"
#include "GameSettingValueDiscreteDynamic.h"
#include "HAL/IConsoleManager.h"
#include "LyraGameSettingRegistry.h"
#include "LyraSettingsLocal.h"
#include "Performance/LyraPerformanceStatTypes.h"
#include "Player/LyraLocalPlayer.h"
#include "RHI.h"
class ULyraLocalPlayer;
#define LOCTEXT_NAMESPACE "Lyra"
static TAutoConsoleVariable<bool> CVarLatencyMarkersRequireNVIDIA(TEXT("Lyra.Settings.LatencyMarkersRequireNVIDIA"),
true,
TEXT("If true, then only allow latency markers to be enabled on NVIDIA hardware"),
ECVF_Default);
// Checks if the current platform can even support latency stats (game, render, total, etc latency stats)
class FGameSettingEditCondition_LatencyStatsSupported final : public FGameSettingEditCondition
{
public:
FGameSettingEditCondition_LatencyStatsSupported() = default;
virtual void GatherEditState(const ULocalPlayer * InLocalPlayer, FGameSettingEditableState & InOutEditState) const override
{
if (!ULyraSettingsLocal::DoesPlatformSupportLatencyTrackingStats())
{
InOutEditState.Disable(LOCTEXT("PlatformDoesNotSupportLatencyStates", "Latency performance stats are not supported on this device"));
}
}
};
// Checks if latency stats are currently enabled and listens for when that changes to correclt update the edit condition state
class FGameSettingEditCondition_LatencyStatsCurrentlyEnabled final : public FGameSettingEditCondition
{
public:
FGameSettingEditCondition_LatencyStatsCurrentlyEnabled() = default;
virtual ~FGameSettingEditCondition_LatencyStatsCurrentlyEnabled() override
{
if (!SettingChangedDelegate.IsValid())
{
return;
}
ULyraSettingsLocal* Settings = ULyraSettingsLocal::Get();
if (!Settings)
{
return;
}
Settings->OnLatencyStatIndicatorSettingsChangedEvent().Remove(SettingChangedDelegate);
}
private:
virtual void Initialize(const ULocalPlayer* InLocalPlayer) override
{
// Bind to an event for when the settings are updated so that we can broadcast that we need
// to be re-evaluated
ULyraSettingsLocal* Settings = ULyraSettingsLocal::Get();
if (!Settings)
{
return;
}
SettingChangedDelegate = Settings->OnLatencyStatIndicatorSettingsChangedEvent().AddSP(this->AsShared(), &FGameSettingEditCondition_LatencyStatsCurrentlyEnabled::BroadcastEditConditionChanged);
}
virtual void GatherEditState(const ULocalPlayer * InLocalPlayer, FGameSettingEditableState & InOutEditState) const override
{
const ULyraSettingsLocal* Settings = ULyraSettingsLocal::Get();
if (!Settings)
{
return;
}
if (!Settings->GetEnableLatencyTrackingStats())
{
InOutEditState.Disable(LOCTEXT("LatencyMarkerRequireStatsEnabled", "Latency Tracking Stats must be enabled to use this."));
}
}
FDelegateHandle SettingChangedDelegate;
};
// Checks if latency markers are supported on the current platform
class FGameSettingEditCondition_LatencyMarkersSupported final : public FGameSettingEditCondition
{
public:
FGameSettingEditCondition_LatencyMarkersSupported() = default;
virtual void GatherEditState(const ULocalPlayer * InLocalPlayer, FGameSettingEditableState & InOutEditState) const override
{
if (!ULyraSettingsLocal::DoesPlatformSupportLatencyMarkers())
{
InOutEditState.Disable(LOCTEXT("PlatformDoesNotSupportLatencyMarkers", "Latency markers are not supported on this device"));
}
// Lyra is only going to use the "Reflex" plugin to track these latency stats, so restrict these settings to NVIDIA devices.
if (CVarLatencyMarkersRequireNVIDIA.GetValueOnAnyThread() && !IsRHIDeviceNVIDIA())
{
InOutEditState.Disable(LOCTEXT("InputLatencyMarkersRequiresNVIDIA", "Latency markers only work on NVIDIA devices."));
}
}
};
//////////////////////////////////////////////////////////////////////
void ULyraGameSettingRegistry::AddPerformanceStatPage(UGameSettingCollection* PerfStatsOuterCategory, ULyraLocalPlayer* InLocalPlayer)
{
//----------------------------------------------------------------------------------
{
static_assert((int32)ELyraDisplayablePerformanceStat::Count == 18, "Consider updating this function to deal with new performance stats");
UGameSettingCollectionPage* StatsPage = NewObject<UGameSettingCollectionPage>();
StatsPage->SetDevName(TEXT("PerfStatsPage"));
StatsPage->SetDisplayName(LOCTEXT("PerfStatsPage_Name", "Performance Stats"));
StatsPage->SetDescriptionRichText(LOCTEXT("PerfStatsPage_Description", "Configure the display of performance statistics."));
StatsPage->SetNavigationText(LOCTEXT("PerfStatsPage_Navigation", "Edit"));
StatsPage->AddEditCondition(FWhenPlayingAsPrimaryPlayer::Get());
PerfStatsOuterCategory->AddSetting(StatsPage);
// Performance stats
////////////////////////////////////////////////////////////////////////////////////
{
UGameSettingCollection* StatCategory_Performance = NewObject<UGameSettingCollection>();
StatCategory_Performance->SetDevName(TEXT("StatCategory_Performance"));
StatCategory_Performance->SetDisplayName(LOCTEXT("StatCategory_Performance_Name", "Performance"));
StatsPage->AddSetting(StatCategory_Performance);
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::ClientFPS);
Setting->SetDisplayName(LOCTEXT("PerfStat_ClientFPS", "Client FPS"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_ClientFPS", "Client frame rate (higher is better)"));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::ServerFPS);
Setting->SetDisplayName(LOCTEXT("PerfStat_ServerFPS", "Server FPS"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_ServerFPS", "Server frame rate"));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::FrameTime);
Setting->SetDisplayName(LOCTEXT("PerfStat_FrameTime", "Frame Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_FrameTime", "The total frame time."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::IdleTime);
Setting->SetDisplayName(LOCTEXT("PerfStat_IdleTime", "Idle Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_IdleTime", "The amount of time spent waiting idle for frame pacing."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::FrameTime_GameThread);
Setting->SetDisplayName(LOCTEXT("PerfStat_FrameTime_GameThread", "CPU Game Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_FrameTime_GameThread", "The amount of time spent on the main game thread."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::FrameTime_RenderThread);
Setting->SetDisplayName(LOCTEXT("PerfStat_FrameTime_RenderThread", "CPU Render Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_FrameTime_RenderThread", "The amount of time spent on the rendering thread."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::FrameTime_RHIThread);
Setting->SetDisplayName(LOCTEXT("PerfStat_FrameTime_RHIThread", "CPU RHI Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_FrameTime_RHIThread", "The amount of time spent on the Render Hardware Interface thread."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::FrameTime_GPU);
Setting->SetDisplayName(LOCTEXT("PerfStat_FrameTime_GPU", "GPU Render Time"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_FrameTime_GPU", "The amount of time spent on the GPU."));
StatCategory_Performance->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
}
// Network stats
////////////////////////////////////////////////////////////////////////////////////
{
UGameSettingCollection* StatCategory_Network = NewObject<UGameSettingCollection>();
StatCategory_Network->SetDevName(TEXT("StatCategory_Network"));
StatCategory_Network->SetDisplayName(LOCTEXT("StatCategory_Network_Name", "Network"));
StatsPage->AddSetting(StatCategory_Network);
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::Ping);
Setting->SetDisplayName(LOCTEXT("PerfStat_Ping", "Ping"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_Ping", "The roundtrip latency of your connection to the server."));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketLoss_Incoming);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketLoss_Incoming", "Incoming Packet Loss"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketLoss_Incoming", "The percentage of incoming packets lost."));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketLoss_Outgoing);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketLoss_Outgoing", "Outgoing Packet Loss"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketLoss_Outgoing", "The percentage of outgoing packets lost."));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketRate_Incoming);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketRate_Incoming", "Incoming Packet Rate"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketRate_Incoming", "Rate of incoming packets (per second)"));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketRate_Outgoing);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketRate_Outgoing", "Outgoing Packet Rate"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketRate_Outgoing", "Rate of outgoing packets (per second)"));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketSize_Incoming);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketSize_Incoming", "Incoming Packet Size"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketSize_Incoming", "The average size (in bytes) of packets recieved in the last second."));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::PacketSize_Outgoing);
Setting->SetDisplayName(LOCTEXT("PerfStat_PacketSize_Outgoing", "Outgoing Packet Size"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_PacketSize_Outgoing", "The average size (in bytes) of packets sent in the last second."));
StatCategory_Network->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
}
// Latency stats
////////////////////////////////////////////////////////////////////////////////////
{
UGameSettingCollection* StatCategory_Latency = NewObject<UGameSettingCollection>();
StatCategory_Latency->SetDevName(TEXT("StatCategory_Latency"));
StatCategory_Latency->SetDisplayName(LOCTEXT("StatCategory_Latency_Name", "Latency"));
StatsPage->AddSetting(StatCategory_Latency);
//----------------------------------------------------------------------------------
{
UGameSettingValueDiscreteDynamic_Bool* Setting = NewObject<UGameSettingValueDiscreteDynamic_Bool>();
Setting->SetDevName(TEXT("InputLatencyTrackingStats"));
Setting->SetDisplayName(LOCTEXT("InputLatencyTrackingStats_Name", "Enable Latency Tracking Stats"));
Setting->SetDescriptionRichText(LOCTEXT("InputLatencyTrackingStats_Description", "Enabling Input Latency stat tracking"));
Setting->SetDynamicGetter(GET_LOCAL_SETTINGS_FUNCTION_PATH(GetEnableLatencyTrackingStats));
Setting->SetDynamicSetter(GET_LOCAL_SETTINGS_FUNCTION_PATH(SetEnableLatencyTrackingStats));
// Set the default value to true if the platform supports latency tracking stats
Setting->SetDefaultValue(ULyraSettingsLocal::DoesPlatformSupportLatencyTrackingStats());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsSupported>());
StatCategory_Latency->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
UGameSettingValueDiscreteDynamic_Bool* Setting = NewObject<UGameSettingValueDiscreteDynamic_Bool>();
Setting->SetDevName(TEXT("InputLatencyMarkers"));
Setting->SetDisplayName(LOCTEXT("InputLatencyMarkers_Name", "Enable Latency Markers"));
Setting->SetDescriptionRichText(LOCTEXT("InputLatencyMarkers_Description", "Enabling Input Latency Markers to flash the screen"));
Setting->SetDynamicGetter(GET_LOCAL_SETTINGS_FUNCTION_PATH(GetEnableLatencyFlashIndicators));
Setting->SetDynamicSetter(GET_LOCAL_SETTINGS_FUNCTION_PATH(SetEnableLatencyFlashIndicators));
Setting->SetDefaultValue(false);
// Latency markers require the stats to be supported and enabled
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsSupported>());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsCurrentlyEnabled>());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyMarkersSupported>());
StatCategory_Latency->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::Latency_Total);
Setting->SetDisplayName(LOCTEXT("PerfStat_Latency_Total", "Total Game Latency"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_Latency_Total", "The total amount of latency"));
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsSupported>());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsCurrentlyEnabled>());
StatCategory_Latency->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::Latency_Game);
Setting->SetDisplayName(LOCTEXT("PerfStat_Latency_Game", "Game Latency"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_Latency_Game", "Game simulation start to driver submission end"));
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsSupported>());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsCurrentlyEnabled>());
StatCategory_Latency->AddSetting(Setting);
}
//----------------------------------------------------------------------------------
{
ULyraSettingValueDiscrete_PerfStat* Setting = NewObject<ULyraSettingValueDiscrete_PerfStat>();
Setting->SetStat(ELyraDisplayablePerformanceStat::Latency_Render);
Setting->SetDisplayName(LOCTEXT("PerfStat_Latency_Render", "Render Latency"));
Setting->SetDescriptionRichText(LOCTEXT("PerfStatDescription_Latency_Render", "OS render queue start to GPU render end"));
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsSupported>());
Setting->AddEditCondition(MakeShared<FGameSettingEditCondition_LatencyStatsCurrentlyEnabled>());
StatCategory_Latency->AddSetting(Setting);
}
}
}
}
#undef LOCTEXT_NAMESPACE
|