system.h

Go to the documentation of this file.

 
#ifdef FLECS_SYSTEM
 
#ifndef FLECS_MODULE
#define FLECS_MODULE
#endif
 
#ifndef FLECS_SYSTEM_H
#define FLECS_SYSTEM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct EcsTickSource {
    bool tick;                 
    ecs_ftime_t time_elapsed;  
} EcsTickSource;
 
typedef struct ecs_system_desc_t {
    int32_t _canary;
 
    ecs_entity_t entity;
 
    ecs_query_desc_t query;
 
    ecs_iter_action_t callback;
 
    ecs_run_action_t run;
 
    void *ctx;
 
    ecs_ctx_free_t ctx_free;
 
    void *callback_ctx;
 
    ecs_ctx_free_t callback_ctx_free;
 
    void *run_ctx;
 
    ecs_ctx_free_t run_ctx_free;
    
    ecs_ftime_t interval;
 
    int32_t rate;
 
    ecs_entity_t tick_source;
 
    bool multi_threaded;
 
    bool immediate;
} ecs_system_desc_t;
 
FLECS_API
ecs_entity_t ecs_system_init(
    ecs_world_t *world,
    const ecs_system_desc_t *desc);
 
typedef struct ecs_system_t {
    ecs_header_t hdr;
 
    ecs_run_action_t run;
 
    ecs_iter_action_t action;
 
    ecs_query_t *query;
 
    ecs_entity_t query_entity;
 
    ecs_entity_t tick_source;
 
    bool multi_threaded;
 
    bool immediate;
 
    const char *name;
 
    void *ctx;
 
    void *callback_ctx;
 
    void *run_ctx;
 
    ecs_ctx_free_t ctx_free;
 
    ecs_ctx_free_t callback_ctx_free;
 
    ecs_ctx_free_t run_ctx_free;
 
    ecs_ftime_t time_spent;
 
    ecs_ftime_t time_passed;
 
    int64_t last_frame;
 
    /* Mixins */
    ecs_world_t *world;
    ecs_entity_t entity;
    flecs_poly_dtor_t dtor;      
} ecs_system_t;
 
FLECS_API
const ecs_system_t* ecs_system_get(
    const ecs_world_t *world,
    ecs_entity_t system);
 
#ifndef FLECS_LEGACY
 
#define ECS_SYSTEM_DECLARE(id) ecs_entity_t ecs_id(id)
 
#define ECS_SYSTEM_DEFINE(world, id_, phase, ...) \
    { \
        ecs_system_desc_t desc = {0}; \
        ecs_entity_desc_t edesc = {0}; \
        ecs_id_t add_ids[3] = {\
            ((phase) ? ecs_pair(EcsDependsOn, (phase)) : 0), \
            (phase), \
            0 \
        };\
        edesc.id = ecs_id(id_);\
        edesc.name = #id_;\
        edesc.add = add_ids;\
        desc.entity = ecs_entity_init(world, &edesc);\
        desc.query.expr = #__VA_ARGS__; \
        desc.callback = id_; \
        ecs_id(id_) = ecs_system_init(world, &desc); \
    } \
    ecs_assert(ecs_id(id_) != 0, ECS_INVALID_PARAMETER, "failed to create system %s", #id_)
 
#define ECS_SYSTEM(world, id, phase, ...) \
    ecs_entity_t ecs_id(id) = 0; ECS_SYSTEM_DEFINE(world, id, phase, __VA_ARGS__);\
    ecs_entity_t id = ecs_id(id);\
    (void)ecs_id(id);\
    (void)id
 
#define ecs_system(world, ...)\
    ecs_system_init(world, &(ecs_system_desc_t) __VA_ARGS__ )
 
#endif
 
FLECS_API
ecs_entity_t ecs_run(
    ecs_world_t *world,
    ecs_entity_t system,
    ecs_ftime_t delta_time,
    void *param);
 
FLECS_API
ecs_entity_t ecs_run_worker(
    ecs_world_t *world,
    ecs_entity_t system,
    int32_t stage_current,
    int32_t stage_count,
    ecs_ftime_t delta_time,
    void *param);
 
FLECS_API
void FlecsSystemImport(
    ecs_world_t *world);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif