UFtsBatchBenchmarkSubsystem Class Reference

Benchmark system on an engine level that handles running multiple benchmarks in a shipped title based on command line. More...

#include <FtsBatchBenchmarkSubsystem.h>

Inheritance diagram for UFtsBatchBenchmarkSubsystem:

Public Member Functions
void	NotifyWorldBenchmarkBegunPlay (UFtsBenchmarkSubsystem *BenchmarkSubsystem)
	Called by world subsystem when it is up and running.
void	NotifyBenchmarkFinished (UFtsBenchmarkSubsystem *BenchmarkSubsystem)
	Called by world subsystem when a benchmark finishes to start the next one.
void	StartBatch (const UObject *WorldContextObject, const FFtsBatchBenchmarkParameters &InBatchParameters)
void	StopBatch (const UObject *WorldContextObject)
bool	IsBatchInProgress () const
void	GetResults (FFtsBenchmarkResultList &OutResults) const

Public Attributes
FFtsBatchBenchmarkEventSignature	OnBatchStarted
FFtsBatchBenchmarkEventSignature	OnBatchFinished

Detailed Description

Benchmark system on an engine level that handles running multiple benchmarks in a shipped title based on command line.

Initialized on engine startup this subsystem waits for a world subsystem to initialize and notify it's ready. Then the system will load a benchmark specification and process it. After all benchmarks are processed it will optionally save the results and quit the application.

Member Function Documentation

NotifyBenchmarkFinished()

void UFtsBatchBenchmarkSubsystem::NotifyBenchmarkFinished

(

UFtsBenchmarkSubsystem *

BenchmarkSubsystem

)

Called by world subsystem when a benchmark finishes to start the next one.

Parameters

BenchmarkSubsystem

Calling subsystem

NotifyWorldBenchmarkBegunPlay()

void UFtsBatchBenchmarkSubsystem::NotifyWorldBenchmarkBegunPlay

(

UFtsBenchmarkSubsystem *

BenchmarkSubsystem

)

Called by world subsystem when it is up and running.

Parameters

BenchmarkSubsystem

Initialized subsystem

---

The documentation for this class was generated from the following files:

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