metrics.h

Go to the documentation of this file.

 
#ifdef FLECS_METRICS
 
#ifndef FLECS_METRICS_H
#define FLECS_METRICS_H
 
#ifndef FLECS_META
#define FLECS_META
#endif
 
#ifndef FLECS_UNITS
#define FLECS_UNITS
#endif
 
#ifndef FLECS_PIPELINE
#define FLECS_PIPELINE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
FLECS_API extern ECS_COMPONENT_DECLARE(FlecsMetrics);
 
FLECS_API extern ECS_TAG_DECLARE(EcsMetric);
 
FLECS_API extern ECS_TAG_DECLARE(EcsCounter);
 
FLECS_API extern ECS_TAG_DECLARE(EcsCounterIncrement);
 
FLECS_API extern ECS_TAG_DECLARE(EcsCounterId);
 
FLECS_API extern ECS_TAG_DECLARE(EcsGauge);
 
FLECS_API extern ECS_TAG_DECLARE(EcsMetricInstance);
 
FLECS_API extern ECS_COMPONENT_DECLARE(EcsMetricValue);
 
FLECS_API extern ECS_COMPONENT_DECLARE(EcsMetricSource);
 
typedef struct EcsMetricValue {
    double value;
} EcsMetricValue;
 
typedef struct EcsMetricSource {
    ecs_entity_t entity;
} EcsMetricSource;
 
typedef struct ecs_metric_desc_t {
    int32_t _canary;
 
    ecs_entity_t entity;
 
    ecs_entity_t member;
 
    /* Member dot expression. Can be used instead of member and supports nested
     * members. Must be set together with id and should not be set at the same
     * time as member. */
    const char *dotmember;
 
    ecs_id_t id;
 
    bool targets;
 
    ecs_entity_t kind;
 
    const char *brief;
} ecs_metric_desc_t;
 
FLECS_API
ecs_entity_t ecs_metric_init(
    ecs_world_t *world,
    const ecs_metric_desc_t *desc);
 
#define ecs_metric(world, ...)\
    ecs_metric_init(world, &(ecs_metric_desc_t) __VA_ARGS__ )
 
FLECS_API
void FlecsMetricsImport(
    ecs_world_t *world);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif