carb::stats::StatDesc

Defined in examples/example.stats/include/carb/stats/IStats.h

struct StatDesc

A descriptor for a new statistic to be added or enumerated.

Public Members

const char *name

The name of this statistic value.

This should be a short identifier name suitable for printing to the user. This may not be nullptr.

const char *description = nullptr

A detailed description of this statistic value.

This should be something suitable for display to the user in something such as a tooltip. This may be nullptr if a detailed description is not needed.

AggregationType aggregationType = AggregationType::eReplace : An identifier indicating how new values for this statistic should be aggregated into the new value.

Value value

When creating a new statistic, this specifies the initial value.

When enumerating it, this specifies the current aggregated value for the statistic.