#include "../../tracktion_graph/utilities/tracktion_PerformanceMeasurement.h"

Classes
struct	tracktion::engine::BenchmarkDescription
	Describes a benchmark. More...

struct	tracktion::engine::BenchmarkResult
	Holds the duration a benchmark took to run. More...

class	tracktion::engine::Benchmark
	An indiviual Benchmark. More...

class	tracktion::engine::BenchmarkList
	Contans a list of BenchmarkResult[s]. More...

struct	tracktion::engine::ScopedBenchmark
	Helper class for measuring a benchmark and adding it to the singleton BenchmarkList list. More...

struct	tracktion::engine::ScopedMeasurement
	Helper class for starting/stopping a benchmark measurement. More...

Namespaces
namespace	tracktion

namespace	tracktion::engine
	Declarations from this namespaces are inlined into tracktion.

Functions
BenchmarkDescription	tracktion::engine::createBenchmarkDescription (std::string category, std::string name, std::string description)
	Creates a description by hashing the name and description fields.

BenchmarkResult	tracktion::engine::createBenchmarkResult (BenchmarkDescription description, const tracktion::graph::PerformanceMeasurement::Statistics &stats)
	Creates a BenchmarkResult from a set of Statistics.

Class Documentation

◆ tracktion::engine::BenchmarkDescription

struct tracktion::engine::BenchmarkDescription

Describes a benchmark.

These fields will be used to sort and group your benchmarks for comparison over time.

Definition at line 23 of file tracktion_Benchmark.h.

Class Members
string	category	A category for grouping.
string	description	An optional description that might include configs etc.
size_t	hash	A hash uniquely identifying this benchmark.
string	name	A human-readable name for the benchmark.
string	platform	A platform string.

struct tracktion::engine::BenchmarkResult

Holds the duration a benchmark took to run.

Definition at line 41 of file tracktion_Benchmark.h.