FFtsBatchBenchmarkParameters Struct Reference

Parameters for a batch run, read from the commandline. More...

#include <FtsBatchBenchmarkSubsystem.h>

Public Attributes
TArray< FPrimaryAssetId >	BenchmarksToRun
	List of benchmarks to run.
bool	bSaveResults = false
	Flag to save benchmark results to a file.
FString	ResultFilePath = ""
	File path to save results to if bSaveResults is set.
bool	bQuitAfterBatchComplete = true
	Whether to quit the game automatically after all benchmarks have run.

Detailed Description

Parameters for a batch run, read from the commandline.

Member Data Documentation

BenchmarksToRun

TArray<FPrimaryAssetId> FFtsBatchBenchmarkParameters::BenchmarksToRun

List of benchmarks to run.

By default it will run all benchmarks that are registered with the Asset Manager. To define specific benchmarks add the command line argument: -Benchmarks="BenchmarkId1,BenchmarkId2"

bQuitAfterBatchComplete

bool FFtsBatchBenchmarkParameters::bQuitAfterBatchComplete = true

Whether to quit the game automatically after all benchmarks have run.

Enabled by default, can be disabled with the -NoBenchmarkQuit flag

bSaveResults

bool FFtsBatchBenchmarkParameters::bSaveResults = false

Flag to save benchmark results to a file.

To set add the command line argument: -SaveBenchmarkResults

ResultFilePath

FString FFtsBatchBenchmarkParameters::ResultFilePath = ""

File path to save results to if bSaveResults is set.

Saves to project's Saved/Benchmarks/Report.json by default. To change use the command line argument: -ResultSavePath="/Path/To/File.json"

---

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

• Plugins/FtsBenchmark/Source/FtsBenchmark/Public/FtsBatchBenchmarkSubsystem.h