Flecs v4.0
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
metrics.h File Reference

Metrics module. More...

Go to the source code of this file.

Classes

struct  EcsMetricValue
 Component that stores metric value. More...
 
struct  EcsMetricSource
 Component that stores metric source. More...
 
struct  ecs_metric_desc_t
 Used with ecs_metric_init to create metric. More...
 

Macros

#define ecs_metric(world, ...)    ecs_metric_init(world, &(ecs_metric_desc_t) __VA_ARGS__ )
 Shorthand for creating a metric with ecs_metric_init().
 

Typedefs

typedef struct EcsMetricValue EcsMetricValue
 Component that stores metric value.
 
typedef struct EcsMetricSource EcsMetricSource
 Component that stores metric source.
 
typedef struct ecs_metric_desc_t ecs_metric_desc_t
 Used with ecs_metric_init to create metric.
 

Functions

FLECS_API ECS_COMPONENT_DECLARE (FlecsMetrics)
 Flecs metrics module.
 
FLECS_API ECS_TAG_DECLARE (EcsMetric)
 Tag added to metrics, and used as first element of metric kind pair.
 
FLECS_API ECS_TAG_DECLARE (EcsCounter)
 Metric that has monotonically increasing value.
 
FLECS_API ECS_TAG_DECLARE (EcsCounterIncrement)
 Counter metric that is auto-incremented by source value.
 
FLECS_API ECS_TAG_DECLARE (EcsCounterId)
 Counter metric that counts the number of entities with an id.
 
FLECS_API ECS_TAG_DECLARE (EcsGauge)
 Metric that represents current value.
 
FLECS_API ECS_TAG_DECLARE (EcsMetricInstance)
 Tag added to metric instances.
 
FLECS_API ECS_COMPONENT_DECLARE (EcsMetricValue)
 Component with metric instance value.
 
FLECS_API ECS_COMPONENT_DECLARE (EcsMetricSource)
 Component with entity source of metric instance.
 
FLECS_API ecs_entity_t ecs_metric_init (ecs_world_t *world, const ecs_metric_desc_t *desc)
 Create a new metric.
 
FLECS_API void FlecsMetricsImport (ecs_world_t *world)
 Metrics module import function.
 

Detailed Description

Metrics module.

The metrics module extracts metrics from components and makes them available through a unified component interface.

Definition in file metrics.h.