An indiviual Benchmark. More...

#include "tracktion_Benchmark.h"

Public Member Functions
	Benchmark (BenchmarkDescription desc)
	Creates a Benchmark for a given BenchmarkDescription.

void	start ()
	Starts timing the benchmark.

void	stop ()
	Stops timing the benchmark.

BenchmarkResult	getResult () const
	Returns the timing results.

Detailed Description

An indiviual Benchmark.

To masure a benchmark, simply create one of these with a valid description then before the code you are measuring call start and stop afterwards. Once you've done that, call getResult() to return the duration the benchmark took to run.

To collect a set of BenchmarkResults see @BenchmarkList

Definition at line 68 of file tracktion_Benchmark.h.

Constructor & Destructor Documentation

◆ Benchmark()

tracktion::engine::Benchmark::Benchmark ( BenchmarkDescription desc )

Creates a Benchmark for a given BenchmarkDescription.

Definition at line 72 of file tracktion_Benchmark.h.

Member Function Documentation

◆ getResult()

BenchmarkResult tracktion::engine::Benchmark::getResult ( ) const

Returns the timing results.

Definition at line 90 of file tracktion_Benchmark.h.

◆ start()

void tracktion::engine::Benchmark::start ( )

Starts timing the benchmark.

Definition at line 78 of file tracktion_Benchmark.h.

◆ stop()

void tracktion::engine::Benchmark::stop ( )

Stops timing the benchmark.

Definition at line 84 of file tracktion_Benchmark.h.

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

tracktion_core/utilities/tracktion_Benchmark.h