Flecs: include/flecs.h Source File
Description: A fast entity component system (ECS) for C & C++

| Flecs v4.0 A fast entity component system (ECS) for C & C++

Loading...
Searching...
No Matches
flecs.h
Go to the documentation of this file.
1
8#ifndef FLECS_H
9#define FLECS_H
10
33/* Flecs version macros */
34#define FLECS_VERSION_MAJOR 4
35#define FLECS_VERSION_MINOR 0
36#define FLECS_VERSION_PATCH 3
39#define FLECS_VERSION FLECS_VERSION_IMPL(\
40 FLECS_VERSION_MAJOR, FLECS_VERSION_MINOR, FLECS_VERSION_PATCH)
41
45#ifdef FLECS_CONFIG_HEADER
46#include "flecs_config.h"
47#endif
48
51#ifndef ecs_float_t
52#define ecs_float_t float
53#endif
54
58#ifndef ecs_ftime_t
59#define ecs_ftime_t ecs_float_t
60#endif
61
65// #define FLECS_LEGACY
66
72// #define FLECS_ACCURATE_COUNTERS
73
79// #define FLECS_DISABLE_COUNTERS
80
81/* Make sure provided configuration is valid */
82#if defined(FLECS_DEBUG) && defined(FLECS_NDEBUG)
83#error "invalid configuration: cannot both define FLECS_DEBUG and FLECS_NDEBUG"
84#endif
85#if defined(FLECS_DEBUG) && defined(NDEBUG)
86#error "invalid configuration: cannot both define FLECS_DEBUG and NDEBUG"
87#endif
88
93#if !defined(FLECS_DEBUG) && !defined(FLECS_NDEBUG)
94#if defined(NDEBUG)
95#define FLECS_NDEBUG
96#else
97#define FLECS_DEBUG
98#endif
99#endif
100
105#ifdef FLECS_SANITIZE
106#ifndef FLECS_DEBUG
107#define FLECS_DEBUG /* If sanitized mode is enabled, so is debug mode */
108#endif
109#endif
110
111/* Tip: if you see weird behavior that you think might be a bug, make sure to
112 * test with the FLECS_DEBUG or FLECS_SANITIZE flags enabled. There's a good
113 * chance that this gives you more information about the issue! */
114
128// #define FLECS_SOFT_ASSERT
129
135// #define FLECS_KEEP_ASSERT
136
145// #define FLECS_CPP_NO_AUTO_REGISTRATION
146
174// #define FLECS_CUSTOM_BUILD
175
184// #define FLECS_CPP_NO_AUTO_REGISTRATION
185
186#ifndef FLECS_CUSTOM_BUILD
187// #define FLECS_C /**< C API convenience macros, always enabled */
188#define FLECS_CPP
189#define FLECS_MODULE
190#define FLECS_SCRIPT
191#define FLECS_STATS
192#define FLECS_METRICS
193#define FLECS_ALERTS
194#define FLECS_SYSTEM
195#define FLECS_PIPELINE
196#define FLECS_TIMER
197#define FLECS_META
198#define FLECS_UNITS
199#define FLECS_JSON
200#define FLECS_DOC
201#define FLECS_LOG
202#define FLECS_APP
203#define FLECS_OS_API_IMPL
204#define FLECS_HTTP
205#define FLECS_REST
206// #define FLECS_JOURNAL /**< Journaling addon (disabled by default) */
207// #define FLECS_PERF_TRACE /**< Enable performance tracing (disabled by default) */
208#endif // ifndef FLECS_CUSTOM_BUILD
209
213// #define FLECS_LOW_FOOTPRINT
214#ifdef FLECS_LOW_FOOTPRINT
215#define FLECS_HI_COMPONENT_ID (16)
216#define FLECS_HI_ID_RECORD_ID (16)
217#define FLECS_SPARSE_PAGE_BITS (6)
218#define FLECS_ENTITY_PAGE_BITS (6)
219#define FLECS_USE_OS_ALLOC
220#endif
221
232#ifndef FLECS_HI_COMPONENT_ID
233#define FLECS_HI_COMPONENT_ID (256)
234#endif
235
242#ifndef FLECS_HI_ID_RECORD_ID
243#define FLECS_HI_ID_RECORD_ID (1024)
244#endif
245
251#ifndef FLECS_SPARSE_PAGE_BITS
252#define FLECS_SPARSE_PAGE_BITS (12)
253#endif
254
257#ifndef FLECS_ENTITY_PAGE_BITS
258#define FLECS_ENTITY_PAGE_BITS (12)
259#endif
260
265// #define FLECS_USE_OS_ALLOC
266
269#ifndef FLECS_ID_DESC_MAX
270#define FLECS_ID_DESC_MAX (32)
271#endif
272
275#ifndef FLECS_EVENT_DESC_MAX
276#define FLECS_EVENT_DESC_MAX (8)
277#endif
278
281#define FLECS_VARIABLE_COUNT_MAX (64)
282
285#ifndef FLECS_TERM_COUNT_MAX
286#define FLECS_TERM_COUNT_MAX 32
287#endif
288
291#ifndef FLECS_TERM_ARG_COUNT_MAX
292#define FLECS_TERM_ARG_COUNT_MAX (16)
293#endif
294
297#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
298#define FLECS_QUERY_VARIABLE_COUNT_MAX (64)
299#endif
300
303#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
304#define FLECS_QUERY_SCOPE_NESTING_MAX (8)
305#endif
306
309#include "flecs/private/api_defines.h"
310#include "flecs/datastructures/vec.h" /* Vector datatype */
311#include "flecs/datastructures/sparse.h" /* Sparse set */
312#include "flecs/datastructures/block_allocator.h" /* Block allocator */
313#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
314#include "flecs/datastructures/map.h" /* Map */
315#include "flecs/datastructures/switch_list.h" /* Switch list */
316#include "flecs/datastructures/allocator.h" /* Allocator */
317#include "flecs/datastructures/strbuf.h" /* String builder */
318#include "flecs/os_api.h" /* Abstraction for operating system functions */
319
320#ifdef __cplusplus
321extern "C" {
322#endif
323
340 typedef uint64_t ecs_id_t;
341
347 typedef ecs_id_t ecs_entity_t;
348
364 typedef struct {
365 ecs_id_t *array;
366 int32_t count;
367} ecs_type_t;
368
391 typedef struct ecs_world_t ecs_world_t;
392
394 typedef struct ecs_stage_t ecs_stage_t;
395
397 typedef struct ecs_table_t ecs_table_t;
398
400 typedef struct ecs_term_t ecs_term_t;
401
403 typedef struct ecs_query_t ecs_query_t;
404
422 typedef struct ecs_observer_t ecs_observer_t;
423
427 typedef struct ecs_observable_t ecs_observable_t;
428
433 typedef struct ecs_iter_t ecs_iter_t;
434
443 typedef struct ecs_ref_t ecs_ref_t;
444
448 typedef struct ecs_type_hooks_t ecs_type_hooks_t;
449
453 typedef struct ecs_type_info_t ecs_type_info_t;
454
456 typedef struct ecs_record_t ecs_record_t;
457
459 typedef struct ecs_id_record_t ecs_id_record_t;
460
480 typedef void ecs_poly_t;
481
483 typedef struct ecs_mixins_t ecs_mixins_t;
484
486 typedef struct ecs_header_t {
487 int32_t magic;
488 int32_t type;
489 int32_t refcount;
490 ecs_mixins_t *mixins;
491} ecs_header_t;
492
494 struct ecs_record_t {
495 ecs_id_record_t *idr;
496 ecs_table_t *table;
497 uint32_t row;
498 int32_t dense;
499};
500
502 typedef struct ecs_table_cache_hdr_t {
503 struct ecs_table_cache_t *cache;
504 ecs_table_t *table;
505 struct ecs_table_cache_hdr_t *prev, *next;
506 bool empty;
507} ecs_table_cache_hdr_t;
508
513 typedef struct ecs_table_record_t {
514 ecs_table_cache_hdr_t hdr;
515 int16_t index;
516 int16_t count;
517 int16_t column;
518} ecs_table_record_t;
519
538 typedef void (*ecs_run_action_t)(
539 ecs_iter_t *it);
540
547 typedef void (*ecs_iter_action_t)(
548 ecs_iter_t *it);
549
557 typedef bool (*ecs_iter_next_action_t)(
558 ecs_iter_t *it);
559
565 typedef void (*ecs_iter_fini_action_t)(
566 ecs_iter_t *it);
567
569 typedef int (*ecs_order_by_action_t)(
570 ecs_entity_t e1,
571 const void *ptr1,
572 ecs_entity_t e2,
573 const void *ptr2);
574
576 typedef void (*ecs_sort_table_action_t)(
577 ecs_world_t* world,
578 ecs_table_t* table,
579 ecs_entity_t* entities,
580 void* ptr,
581 int32_t size,
582 int32_t lo,
583 int32_t hi,
584 ecs_order_by_action_t order_by);
585
587 typedef uint64_t (*ecs_group_by_action_t)(
588 ecs_world_t *world,
589 ecs_table_t *table,
590 ecs_id_t group_id,
591 void *ctx);
592
594 typedef void* (*ecs_group_create_action_t)(
595 ecs_world_t *world,
596 uint64_t group_id,
597 void *group_by_ctx); /* from ecs_query_desc_t */
598
600 typedef void (*ecs_group_delete_action_t)(
601 ecs_world_t *world,
602 uint64_t group_id,
603 void *group_ctx, /* return value from ecs_group_create_action_t */
604 void *group_by_ctx); /* from ecs_query_desc_t */
605
607 typedef void (*ecs_module_action_t)(
608 ecs_world_t *world);
609
611 typedef void (*ecs_fini_action_t)(
612 ecs_world_t *world,
613 void *ctx);
614
616 typedef void (*ecs_ctx_free_t)(
617 void *ctx);
618
620 typedef int (*ecs_compare_action_t)(
621 const void *ptr1,
622 const void *ptr2);
623
625 typedef uint64_t (*ecs_hash_value_action_t)(
626 const void *ptr);
627
629 typedef void (*ecs_xtor_t)(
630 void *ptr,
631 int32_t count,
632 const ecs_type_info_t *type_info);
633
635 typedef void (*ecs_copy_t)(
636 void *dst_ptr,
637 const void *src_ptr,
638 int32_t count,
639 const ecs_type_info_t *type_info);
640
642 typedef void (*ecs_move_t)(
643 void *dst_ptr,
644 void *src_ptr,
645 int32_t count,
646 const ecs_type_info_t *type_info);
647
649 typedef void (*flecs_poly_dtor_t)(
650 ecs_poly_t *poly);
651
662 typedef enum ecs_inout_kind_t {
663 EcsInOutDefault,
664 EcsInOutNone,
665 EcsInOutFilter,
666 EcsInOut,
667 EcsIn,
668 EcsOut,
669} ecs_inout_kind_t;
670
672 typedef enum ecs_oper_kind_t {
673 EcsAnd,
674 EcsOr,
675 EcsNot,
676 EcsOptional,
677 EcsAndFrom,
678 EcsOrFrom,
679 EcsNotFrom,
680} ecs_oper_kind_t;
681
683 typedef enum ecs_query_cache_kind_t {
684 EcsQueryCacheDefault,
685 EcsQueryCacheAuto,
686 EcsQueryCacheAll,
687 EcsQueryCacheNone,
688} ecs_query_cache_kind_t;
689
690/* Term id flags */
691
696#define EcsSelf (1llu << 63)
697
702#define EcsUp (1llu << 62)
703
708#define EcsTrav (1llu << 61)
709
714#define EcsCascade (1llu << 60)
715
720#define EcsDesc (1llu << 59)
721
726#define EcsIsVariable (1llu << 58)
727
732#define EcsIsEntity (1llu << 57)
733
738#define EcsIsName (1llu << 56)
739
744#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
745
750#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
751
753 typedef struct ecs_term_ref_t {
754 ecs_entity_t id;
760 const char *name;
765} ecs_term_ref_t;
766
768 struct ecs_term_t {
769 ecs_id_t id;
774 ecs_term_ref_t src;
775 ecs_term_ref_t first;
776 ecs_term_ref_t second;
778 ecs_entity_t trav;
782 int16_t inout;
783 int16_t oper;
785 int8_t field_index;
786 ecs_flags16_t flags_;
787};
788
792 struct ecs_query_t {
793 ecs_header_t hdr;
795 ecs_term_t terms[FLECS_TERM_COUNT_MAX];
796 int32_t sizes[FLECS_TERM_COUNT_MAX];
797 ecs_id_t ids[FLECS_TERM_COUNT_MAX];
799 ecs_flags32_t flags;
800 int8_t var_count;
801 int8_t term_count;
802 int8_t field_count;
804 /* Bitmasks for quick field information lookups */
805 ecs_termset_t fixed_fields;
806 ecs_termset_t var_fields;
807 ecs_termset_t static_id_fields;
808 ecs_termset_t data_fields;
809 ecs_termset_t write_fields;
810 ecs_termset_t read_fields;
811 ecs_termset_t row_fields;
812 ecs_termset_t shared_readonly_fields;
813 ecs_termset_t set_fields;
815 ecs_query_cache_kind_t cache_kind;
817 char **vars;
819 void *ctx;
820 void *binding_ctx;
822 ecs_entity_t entity;
823 ecs_world_t *real_world;
824 ecs_world_t *world;
826 int32_t eval_count;
827};
828
832 struct ecs_observer_t {
833 ecs_header_t hdr;
835 ecs_query_t *query;
838 ecs_entity_t events[FLECS_EVENT_DESC_MAX];
839 int32_t event_count;
841 ecs_iter_action_t callback;
842 ecs_run_action_t run;
844 void *ctx;
845 void *callback_ctx;
846 void *run_ctx;
848 ecs_ctx_free_t ctx_free;
849 ecs_ctx_free_t callback_ctx_free;
850 ecs_ctx_free_t run_ctx_free;
852 ecs_observable_t *observable;
854 ecs_world_t *world;
855 ecs_entity_t entity;
856};
857
864 struct ecs_type_hooks_t {
865 ecs_xtor_t ctor;
866 ecs_xtor_t dtor;
867 ecs_copy_t copy;
868 ecs_move_t move;
871 ecs_copy_t copy_ctor;
872
874 ecs_move_t move_ctor;
875
880 ecs_move_t ctor_move_dtor;
881
886 ecs_move_t move_dtor;
887
890 ecs_iter_action_t on_add;
891
895 ecs_iter_action_t on_set;
896
900 ecs_iter_action_t on_remove;
901
902 void *ctx;
903 void *binding_ctx;
904 void *lifecycle_ctx;
906 ecs_ctx_free_t ctx_free;
907 ecs_ctx_free_t binding_ctx_free;
908 ecs_ctx_free_t lifecycle_ctx_free;
910};
911
916 struct ecs_type_info_t {
917 ecs_size_t size;
918 ecs_size_t alignment;
919 ecs_type_hooks_t hooks;
920 ecs_entity_t component;
921 const char *name;
922};
923
924#include "flecs/private/api_types.h" /* Supporting API types */
925#include "flecs/private/api_support.h" /* Supporting API functions */
926#include "flecs/datastructures/hashmap.h" /* Hashmap */
927
929 typedef struct ecs_value_t {
930 ecs_entity_t type;
931 void *ptr;
932} ecs_value_t;
933
938 typedef struct ecs_entity_desc_t {
939 int32_t _canary;
941 ecs_entity_t id;
943 ecs_entity_t parent;
945 const char *name;
950 const char *sep;
954 const char *root_sep;
956 const char *symbol;
966 bool use_low_id;
971 const ecs_id_t *add;
972
974 const ecs_value_t *set;
975
977 const char *add_expr;
978} ecs_entity_desc_t;
979
984 typedef struct ecs_bulk_desc_t {
985 int32_t _canary;
987 ecs_entity_t *entities;
992 int32_t count;
994 ecs_id_t ids[FLECS_ID_DESC_MAX];
996 void **data;
1003 ecs_table_t *table;
1008} ecs_bulk_desc_t;
1009
1014 typedef struct ecs_component_desc_t {
1015 int32_t _canary;
1018 ecs_entity_t entity;
1019
1021 ecs_type_info_t type;
1022} ecs_component_desc_t;
1023
1062 struct ecs_iter_t {
1063 /* World */
1064 ecs_world_t *world;
1065 ecs_world_t *real_world;
1067 /* Matched data */
1068 const ecs_entity_t *entities;
1069 const ecs_size_t *sizes;
1070 ecs_table_t *table;
1071 ecs_table_t *other_table;
1072 ecs_id_t *ids;
1073 ecs_var_t *variables;
1074 const ecs_table_record_t **trs;
1075 ecs_entity_t *sources;
1076 ecs_flags64_t constrained_vars;
1077 uint64_t group_id;
1078 ecs_termset_t set_fields;
1079 ecs_termset_t ref_fields;
1080 ecs_termset_t row_fields;
1081 ecs_termset_t up_fields;
1083 /* Input information */
1084 ecs_entity_t system;
1085 ecs_entity_t event;
1086 ecs_id_t event_id;
1087 int32_t event_cur;
1089 /* Query information */
1090 int8_t field_count;
1091 int8_t term_index;
1094 int8_t variable_count;
1095 const ecs_query_t *query;
1096 char **variable_names;
1098 /* Context */
1099 void *param;
1100 void *ctx;
1101 void *binding_ctx;
1102 void *callback_ctx;
1103 void *run_ctx;
1105 /* Time */
1106 ecs_ftime_t delta_time;
1107 ecs_ftime_t delta_system_time;
1109 /* Iterator counters */
1110 int32_t frame_offset;
1111 int32_t offset;
1112 int32_t count;
1114 /* Misc */
1115 ecs_flags32_t flags;
1116 ecs_entity_t interrupted_by;
1117 ecs_iter_private_t priv_;
1119 /* Chained iterators */
1120 ecs_iter_next_action_t next;
1121 ecs_iter_action_t callback;
1122 ecs_iter_fini_action_t fini;
1123 ecs_iter_t *chain_it;
1124};
1125
1126
1131#define EcsQueryMatchPrefab (1u << 1u)
1132
1137#define EcsQueryMatchDisabled (1u << 2u)
1138
1143#define EcsQueryMatchEmptyTables (1u << 3u)
1144
1149#define EcsQueryAllowUnresolvedByName (1u << 6u)
1150
1155#define EcsQueryTableOnly (1u << 7u)
1156
1157
1162 typedef struct ecs_query_desc_t {
1164 int32_t _canary;
1165
1167 ecs_term_t terms[FLECS_TERM_COUNT_MAX];
1168
1170 const char *expr;
1171
1173 ecs_query_cache_kind_t cache_kind;
1174
1176 ecs_flags32_t flags;
1177
1181 ecs_order_by_action_t order_by_callback;
1182
1185 ecs_sort_table_action_t order_by_table_callback;
1186
1189 ecs_entity_t order_by;
1190
1193 ecs_id_t group_by;
1194
1200 ecs_group_by_action_t group_by_callback;
1201
1204 ecs_group_create_action_t on_group_create;
1205
1208 ecs_group_delete_action_t on_group_delete;
1209
1211 void *group_by_ctx;
1212
1214 ecs_ctx_free_t group_by_ctx_free;
1215
1217 void *ctx;
1218
1220 void *binding_ctx;
1221
1223 ecs_ctx_free_t ctx_free;
1224
1226 ecs_ctx_free_t binding_ctx_free;
1227
1229 ecs_entity_t entity;
1230} ecs_query_desc_t;
1231
1236 typedef struct ecs_observer_desc_t {
1238 int32_t _canary;
1239
1241 ecs_entity_t entity;
1242
1244 ecs_query_desc_t query;
1245
1247 ecs_entity_t events[FLECS_EVENT_DESC_MAX];
1248
1251 bool yield_existing;
1252
1254 ecs_iter_action_t callback;
1255
1262 ecs_run_action_t run;
1263
1265 void *ctx;
1266
1268 ecs_ctx_free_t ctx_free;
1269
1271 void *callback_ctx;
1272
1274 ecs_ctx_free_t callback_ctx_free;
1275
1277 void *run_ctx;
1278
1280 ecs_ctx_free_t run_ctx_free;
1281
1283 ecs_poly_t *observable;
1284
1287 int32_t *last_event_id;
1288
1290 int8_t term_index_;
1291 ecs_flags32_t flags_;
1292} ecs_observer_desc_t;
1293
1298 typedef struct ecs_event_desc_t {
1300 ecs_entity_t event;
1301
1305 const ecs_type_t *ids;
1306
1308 ecs_table_t *table;
1309
1312 ecs_table_t *other_table;
1313
1315 int32_t offset;
1316
1320 int32_t count;
1321
1323 ecs_entity_t entity;
1324
1329 void *param;
1330
1334 const void *const_param;
1335
1337 ecs_poly_t *observable;
1338
1340 ecs_flags32_t flags;
1341} ecs_event_desc_t;
1342
1343
1352 typedef struct ecs_build_info_t {
1353 const char *compiler;
1354 const char **addons;
1355 const char *version;
1356 int16_t version_major;
1357 int16_t version_minor;
1358 int16_t version_patch;
1359 bool debug;
1360 bool sanitize;
1361 bool perf_trace;
1362} ecs_build_info_t;
1363
1365 typedef struct ecs_world_info_t {
1366 ecs_entity_t last_component_id;
1367 ecs_entity_t min_id;
1368 ecs_entity_t max_id;
1370 ecs_ftime_t delta_time_raw;
1371 ecs_ftime_t delta_time;
1372 ecs_ftime_t time_scale;
1373 ecs_ftime_t target_fps;
1374 ecs_ftime_t frame_time_total;
1375 ecs_ftime_t system_time_total;
1376 ecs_ftime_t emit_time_total;
1377 ecs_ftime_t merge_time_total;
1378 ecs_ftime_t rematch_time_total;
1379 double world_time_total;
1380 double world_time_total_raw;
1382 int64_t frame_count_total;
1383 int64_t merge_count_total;
1384 int64_t eval_comp_monitors_total;
1385 int64_t rematch_count_total;
1387 int64_t id_create_total;
1388 int64_t id_delete_total;
1389 int64_t table_create_total;
1390 int64_t table_delete_total;
1391 int64_t pipeline_build_count_total;
1392 int64_t systems_ran_frame;
1393 int64_t observers_ran_frame;
1395 int32_t tag_id_count;
1396 int32_t component_id_count;
1397 int32_t pair_id_count;
1399 int32_t table_count;
1400 int32_t empty_table_count;
1402 /* -- Command counts -- */
1403 struct {
1404 int64_t add_count;
1405 int64_t remove_count;
1406 int64_t delete_count;
1407 int64_t clear_count;
1408 int64_t set_count;
1409 int64_t ensure_count;
1410 int64_t modified_count;
1411 int64_t discard_count;
1412 int64_t event_count;
1413 int64_t other_count;
1414 int64_t batched_entity_count;
1415 int64_t batched_command_count;
1416 } cmd;
1418 const char *name_prefix;
1422} ecs_world_info_t;
1423
1425 typedef struct ecs_query_group_info_t {
1426 int32_t match_count;
1427 int32_t table_count;
1428 void *ctx;
1429} ecs_query_group_info_t;
1430
1441 typedef struct EcsIdentifier {
1442 char *value;
1443 ecs_size_t length;
1444 uint64_t hash;
1445 uint64_t index_hash;
1446 ecs_hashmap_t *index;
1447} EcsIdentifier;
1448
1450 typedef struct EcsComponent {
1451 ecs_size_t size;
1452 ecs_size_t alignment;
1453} EcsComponent;
1454
1456 typedef struct EcsPoly {
1457 ecs_poly_t *poly;
1458} EcsPoly;
1459
1465 typedef struct EcsDefaultChildComponent {
1466 ecs_id_t component;
1467} EcsDefaultChildComponent;
1468
1472/* Only include deprecated definitions if deprecated addon is required */
1473#ifdef FLECS_DEPRECATED
1474#include "flecs/addons/deprecated.h"
1475#endif
1476
1492FLECS_API extern const ecs_id_t ECS_PAIR;
1493
1495FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1496
1498FLECS_API extern const ecs_id_t ECS_TOGGLE;
1499
1507/* Builtin component ids */
1508
1510FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1511
1513FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1514
1516FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1517
1519FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1520
1522FLECS_API extern const ecs_entity_t EcsQuery;
1523
1525FLECS_API extern const ecs_entity_t EcsObserver;
1526
1528FLECS_API extern const ecs_entity_t EcsSystem;
1529
1531FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1532
1534FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1535
1537FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1538
1540FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1541
1543FLECS_API extern const ecs_entity_t EcsFlecs;
1544
1546FLECS_API extern const ecs_entity_t EcsFlecsCore;
1547
1549FLECS_API extern const ecs_entity_t EcsWorld;
1550
1552FLECS_API extern const ecs_entity_t EcsWildcard;
1553
1555FLECS_API extern const ecs_entity_t EcsAny;
1556
1558FLECS_API extern const ecs_entity_t EcsThis;
1559
1561FLECS_API extern const ecs_entity_t EcsVariable;
1562
1564#define EcsSingleton EcsVariable
1565
1573FLECS_API extern const ecs_entity_t EcsTransitive;
1574
1582FLECS_API extern const ecs_entity_t EcsReflexive;
1583
1594FLECS_API extern const ecs_entity_t EcsFinal;
1595
1597FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1598
1602FLECS_API extern const ecs_entity_t EcsOverride;
1603
1607FLECS_API extern const ecs_entity_t EcsInherit;
1608
1613FLECS_API extern const ecs_entity_t EcsDontInherit;
1614
1622FLECS_API extern const ecs_entity_t EcsSymmetric;
1623
1633FLECS_API extern const ecs_entity_t EcsExclusive;
1634
1636FLECS_API extern const ecs_entity_t EcsAcyclic;
1637
1640FLECS_API extern const ecs_entity_t EcsTraversable;
1641
1651FLECS_API extern const ecs_entity_t EcsWith;
1652
1662FLECS_API extern const ecs_entity_t EcsOneOf;
1663
1665FLECS_API extern const ecs_entity_t EcsCanToggle;
1666
1670FLECS_API extern const ecs_entity_t EcsTrait;
1671
1681FLECS_API extern const ecs_entity_t EcsRelationship;
1682
1692FLECS_API extern const ecs_entity_t EcsTarget;
1693
1696FLECS_API extern const ecs_entity_t EcsPairIsTag;
1697
1699FLECS_API extern const ecs_entity_t EcsName;
1700
1702FLECS_API extern const ecs_entity_t EcsSymbol;
1703
1705FLECS_API extern const ecs_entity_t EcsAlias;
1706
1708FLECS_API extern const ecs_entity_t EcsChildOf;
1709
1711FLECS_API extern const ecs_entity_t EcsIsA;
1712
1714FLECS_API extern const ecs_entity_t EcsDependsOn;
1715
1717FLECS_API extern const ecs_entity_t EcsSlotOf;
1718
1720FLECS_API extern const ecs_entity_t EcsModule;
1721
1723FLECS_API extern const ecs_entity_t EcsPrivate;
1724
1727FLECS_API extern const ecs_entity_t EcsPrefab;
1728
1731FLECS_API extern const ecs_entity_t EcsDisabled;
1732
1736FLECS_API extern const ecs_entity_t EcsNotQueryable;
1737
1739FLECS_API extern const ecs_entity_t EcsOnAdd;
1740
1742FLECS_API extern const ecs_entity_t EcsOnRemove;
1743
1745FLECS_API extern const ecs_entity_t EcsOnSet;
1746
1748FLECS_API extern const ecs_entity_t EcsMonitor;
1749
1751FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1752
1754FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1755
1757FLECS_API extern const ecs_entity_t EcsOnTableEmpty;
1758
1760FLECS_API extern const ecs_entity_t EcsOnTableFill;
1761
1763FLECS_API extern const ecs_entity_t EcsOnDelete;
1764
1767FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1768
1771FLECS_API extern const ecs_entity_t EcsRemove;
1772
1775FLECS_API extern const ecs_entity_t EcsDelete;
1776
1779FLECS_API extern const ecs_entity_t EcsPanic;
1780
1782FLECS_API extern const ecs_entity_t EcsSparse;
1783
1785FLECS_API extern const ecs_entity_t EcsUnion;
1786
1788FLECS_API extern const ecs_entity_t EcsPredEq;
1789
1791FLECS_API extern const ecs_entity_t EcsPredMatch;
1792
1794FLECS_API extern const ecs_entity_t EcsPredLookup;
1795
1797FLECS_API extern const ecs_entity_t EcsScopeOpen;
1798
1800FLECS_API extern const ecs_entity_t EcsScopeClose;
1801
1806FLECS_API extern const ecs_entity_t EcsEmpty;
1807
1808FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
1809FLECS_API extern const ecs_entity_t EcsOnStart;
1810FLECS_API extern const ecs_entity_t EcsPreFrame;
1811FLECS_API extern const ecs_entity_t EcsOnLoad;
1812FLECS_API extern const ecs_entity_t EcsPostLoad;
1813FLECS_API extern const ecs_entity_t EcsPreUpdate;
1814FLECS_API extern const ecs_entity_t EcsOnUpdate;
1815FLECS_API extern const ecs_entity_t EcsOnValidate;
1816FLECS_API extern const ecs_entity_t EcsPostUpdate;
1817FLECS_API extern const ecs_entity_t EcsPreStore;
1818FLECS_API extern const ecs_entity_t EcsOnStore;
1819FLECS_API extern const ecs_entity_t EcsPostFrame;
1820FLECS_API extern const ecs_entity_t EcsPhase;
1824#define EcsLastInternalComponentId (ecs_id(EcsPoly))
1825
1828#define EcsFirstUserComponentId (8)
1829
1832#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
1833
1834/* When visualized the reserved id ranges look like this:
1835 * - [1..8]: Builtin components
1836 * - [9..FLECS_HI_COMPONENT_ID]: Low ids reserved for application components
1837 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Builtin entities
1838 */
1839
1861FLECS_API
1862 ecs_world_t* ecs_init(void);
1863
1870FLECS_API
1871 ecs_world_t* ecs_mini(void);
1872
1880FLECS_API
1881 ecs_world_t* ecs_init_w_args(
1882 int argc,
1883 char *argv[]);
1884
1891FLECS_API
1892 int ecs_fini(
1893 ecs_world_t *world);
1894
1902FLECS_API
1903 bool ecs_is_fini(
1904 const ecs_world_t *world);
1905
1913FLECS_API
1914 void ecs_atfini(
1915 ecs_world_t *world,
1916 ecs_fini_action_t action,
1917 void *ctx);
1918
1920 typedef struct ecs_entities_t {
1921 const ecs_entity_t *ids;
1922 int32_t count;
1923 int32_t alive_count;
1924} ecs_entities_t;
1925
1952FLECS_API
1953 ecs_entities_t ecs_get_entities(
1954 const ecs_world_t *world);
1955
1963FLECS_API
1964ecs_flags32_t ecs_world_get_flags(
1965 const ecs_world_t *world);
1966
1992FLECS_API
1993 ecs_ftime_t ecs_frame_begin(
1994 ecs_world_t *world,
1995 ecs_ftime_t delta_time);
1996
2003FLECS_API
2004 void ecs_frame_end(
2005 ecs_world_t *world);
2006
2014FLECS_API
2015 void ecs_run_post_frame(
2016 ecs_world_t *world,
2017 ecs_fini_action_t action,
2018 void *ctx);
2019
2026FLECS_API
2027 void ecs_quit(
2028 ecs_world_t *world);
2029
2036FLECS_API
2037 bool ecs_should_quit(
2038 const ecs_world_t *world);
2039
2051FLECS_API void ecs_measure_frame_time(
2052 ecs_world_t *world,
2053 bool enable);
2054
2065FLECS_API void ecs_measure_system_time(
2066 ecs_world_t *world,
2067 bool enable);
2068
2084FLECS_API
2085 void ecs_set_target_fps(
2086 ecs_world_t *world,
2087 ecs_ftime_t fps);
2088
2102FLECS_API
2103 void ecs_set_default_query_flags(
2104 ecs_world_t *world,
2105 ecs_flags32_t flags);
2106
2183FLECS_API
2184 bool ecs_readonly_begin(
2185 ecs_world_t *world,
2186 bool multi_threaded);
2187
2195FLECS_API
2196 void ecs_readonly_end(
2197 ecs_world_t *world);
2198
2209FLECS_API
2210 void ecs_merge(
2211 ecs_world_t *world);
2212
2228FLECS_API
2229 bool ecs_defer_begin(
2230 ecs_world_t *world);
2231
2242FLECS_API
2243 bool ecs_is_deferred(
2244 const ecs_world_t *world);
2245
2259FLECS_API
2260 bool ecs_defer_end(
2261 ecs_world_t *world);
2262
2277FLECS_API
2278 void ecs_defer_suspend(
2279 ecs_world_t *world);
2280
2291FLECS_API
2292 void ecs_defer_resume(
2293 ecs_world_t *world);
2294
2308FLECS_API
2309 void ecs_set_stage_count(
2310 ecs_world_t *world,
2311 int32_t stages);
2312
2319FLECS_API
2320int32_t ecs_get_stage_count(
2321 const ecs_world_t *world);
2322
2338FLECS_API
2339 ecs_world_t* ecs_get_stage(
2340 const ecs_world_t *world,
2341 int32_t stage_id);
2342
2350FLECS_API
2351 bool ecs_stage_is_readonly(
2352 const ecs_world_t *world);
2353
2361FLECS_API
2362 ecs_world_t* ecs_stage_new(
2363 ecs_world_t *world);
2364
2369FLECS_API
2370 void ecs_stage_free(
2371 ecs_world_t *stage);
2372
2380FLECS_API
2381int32_t ecs_stage_get_id(
2382 const ecs_world_t *world);
2383
2399FLECS_API
2400 void ecs_set_ctx(
2401 ecs_world_t *world,
2402 void *ctx,
2403 ecs_ctx_free_t ctx_free);
2404
2413FLECS_API
2414 void ecs_set_binding_ctx(
2415 ecs_world_t *world,
2416 void *ctx,
2417 ecs_ctx_free_t ctx_free);
2418
2426FLECS_API
2427 void* ecs_get_ctx(
2428 const ecs_world_t *world);
2429
2437FLECS_API
2438 void* ecs_get_binding_ctx(
2439 const ecs_world_t *world);
2440
2446FLECS_API
2447 const ecs_build_info_t* ecs_get_build_info(void);
2448
2454FLECS_API
2455 const ecs_world_info_t* ecs_get_world_info(
2456 const ecs_world_t *world);
2457
2466FLECS_API
2467 void ecs_dim(
2468 ecs_world_t *world,
2469 int32_t entity_count);
2470
2486FLECS_API
2487 void ecs_set_entity_range(
2488 ecs_world_t *world,
2489 ecs_entity_t id_start,
2490 ecs_entity_t id_end);
2491
2502FLECS_API
2503 bool ecs_enable_range_check(
2504 ecs_world_t *world,
2505 bool enable);
2506
2512FLECS_API
2513 ecs_entity_t ecs_get_max_id(
2514 const ecs_world_t *world);
2515
2529FLECS_API
2530 void ecs_run_aperiodic(
2531 ecs_world_t *world,
2532 ecs_flags32_t flags);
2533
2567FLECS_API
2568int32_t ecs_delete_empty_tables(
2569 ecs_world_t *world,
2570 ecs_id_t id,
2571 uint16_t clear_generation,
2572 uint16_t delete_generation,
2573 int32_t min_id_count,
2574 double time_budget_seconds);
2575
2581FLECS_API
2582 const ecs_world_t* ecs_get_world(
2583 const ecs_poly_t *poly);
2584
2590FLECS_API
2591 ecs_entity_t ecs_get_entity(
2592 const ecs_poly_t *poly);
2593
2607FLECS_API
2608 bool flecs_poly_is_(
2609 const ecs_poly_t *object,
2610 int32_t type);
2611
2615#define flecs_poly_is(object, type)\
2616 flecs_poly_is_(object, type##_magic)
2617
2626FLECS_API
2627 ecs_id_t ecs_make_pair(
2628 ecs_entity_t first,
2629 ecs_entity_t second);
2630
2657FLECS_API
2658 ecs_entity_t ecs_new(
2659 ecs_world_t *world);
2660
2678FLECS_API
2679 ecs_entity_t ecs_new_low_id(
2680 ecs_world_t *world);
2681
2690FLECS_API
2691 ecs_entity_t ecs_new_w_id(
2692 ecs_world_t *world,
2693 ecs_id_t id);
2694
2702FLECS_API
2703 ecs_entity_t ecs_new_w_table(
2704 ecs_world_t *world,
2705 ecs_table_t *table);
2706
2725FLECS_API
2726 ecs_entity_t ecs_entity_init(
2727 ecs_world_t *world,
2728 const ecs_entity_desc_t *desc);
2729
2756FLECS_API
2757 const ecs_entity_t* ecs_bulk_init(
2758 ecs_world_t *world,
2759 const ecs_bulk_desc_t *desc);
2760
2770FLECS_API
2771 const ecs_entity_t* ecs_bulk_new_w_id(
2772 ecs_world_t *world,
2773 ecs_id_t id,
2774 int32_t count);
2775
2791FLECS_API
2792 ecs_entity_t ecs_clone(
2793 ecs_world_t *world,
2794 ecs_entity_t dst,
2795 ecs_entity_t src,
2796 bool copy_value);
2797
2806FLECS_API
2807 void ecs_delete(
2808 ecs_world_t *world,
2809 ecs_entity_t entity);
2810
2818FLECS_API
2819 void ecs_delete_with(
2820 ecs_world_t *world,
2821 ecs_id_t id);
2822
2840FLECS_API
2841 void ecs_add_id(
2842 ecs_world_t *world,
2843 ecs_entity_t entity,
2844 ecs_id_t id);
2845
2854FLECS_API
2855 void ecs_remove_id(
2856 ecs_world_t *world,
2857 ecs_entity_t entity,
2858 ecs_id_t id);
2859
2911FLECS_API
2912 void ecs_auto_override_id(
2913 ecs_world_t *world,
2914 ecs_entity_t entity,
2915 ecs_id_t id);
2916
2923FLECS_API
2924 void ecs_clear(
2925 ecs_world_t *world,
2926 ecs_entity_t entity);
2927
2935FLECS_API
2936 void ecs_remove_all(
2937 ecs_world_t *world,
2938 ecs_id_t id);
2939
2947FLECS_API
2948 ecs_entity_t ecs_set_with(
2949 ecs_world_t *world,
2950 ecs_id_t id);
2951
2958FLECS_API
2959 ecs_id_t ecs_get_with(
2960 const ecs_world_t *world);
2961
2980FLECS_API
2981 void ecs_enable(
2982 ecs_world_t *world,
2983 ecs_entity_t entity,
2984 bool enabled);
2985
2999FLECS_API
3000 void ecs_enable_id(
3001 ecs_world_t *world,
3002 ecs_entity_t entity,
3003 ecs_id_t id,
3004 bool enable);
3005
3016FLECS_API
3017 bool ecs_is_enabled_id(
3018 const ecs_world_t *world,
3019 ecs_entity_t entity,
3020 ecs_id_t id);
3021
3045FLECS_API
3046 const void* ecs_get_id(
3047 const ecs_world_t *world,
3048 ecs_entity_t entity,
3049 ecs_id_t id);
3050
3062FLECS_API
3063 void* ecs_get_mut_id(
3064 const ecs_world_t *world,
3065 ecs_entity_t entity,
3066 ecs_id_t id);
3067
3085FLECS_API
3086 void* ecs_ensure_id(
3087 ecs_world_t *world,
3088 ecs_entity_t entity,
3089 ecs_id_t id);
3090
3102FLECS_API
3103 void* ecs_ensure_modified_id(
3104 ecs_world_t *world,
3105 ecs_entity_t entity,
3106 ecs_id_t id);
3107
3118FLECS_API
3119 ecs_ref_t ecs_ref_init_id(
3120 const ecs_world_t *world,
3121 ecs_entity_t entity,
3122 ecs_id_t id);
3123
3132FLECS_API
3133 void* ecs_ref_get_id(
3134 const ecs_world_t *world,
3135 ecs_ref_t *ref,
3136 ecs_id_t id);
3137
3145FLECS_API
3146 void ecs_ref_update(
3147 const ecs_world_t *world,
3148 ecs_ref_t *ref);
3149
3157FLECS_API
3158 ecs_record_t* ecs_record_find(
3159 const ecs_world_t *world,
3160 ecs_entity_t entity);
3161
3180FLECS_API
3181 ecs_record_t* ecs_write_begin(
3182 ecs_world_t *world,
3183 ecs_entity_t entity);
3184
3191FLECS_API
3192 void ecs_write_end(
3193 ecs_record_t *record);
3194
3214FLECS_API
3215 const ecs_record_t* ecs_read_begin(
3216 ecs_world_t *world,
3217 ecs_entity_t entity);
3218
3224FLECS_API
3225 void ecs_read_end(
3226 const ecs_record_t *record);
3227
3234FLECS_API
3235 ecs_entity_t ecs_record_get_entity(
3236 const ecs_record_t *record);
3237
3253FLECS_API
3254 const void* ecs_record_get_id(
3255 const ecs_world_t *world,
3256 const ecs_record_t *record,
3257 ecs_id_t id);
3258
3267FLECS_API
3268 void* ecs_record_ensure_id(
3269 ecs_world_t *world,
3270 ecs_record_t *record,
3271 ecs_id_t id);
3272
3280FLECS_API
3281 bool ecs_record_has_id(
3282 ecs_world_t *world,
3283 const ecs_record_t *record,
3284 ecs_id_t id);
3285
3302FLECS_API
3303 void* ecs_record_get_by_column(
3304 const ecs_record_t *record,
3305 int32_t column,
3306 size_t size);
3307
3327FLECS_API
3328 void* ecs_emplace_id(
3329 ecs_world_t *world,
3330 ecs_entity_t entity,
3331 ecs_id_t id,
3332 bool *is_new);
3333
3343FLECS_API
3344 void ecs_modified_id(
3345 ecs_world_t *world,
3346 ecs_entity_t entity,
3347 ecs_id_t id);
3348
3364FLECS_API
3365 void ecs_set_id(
3366 ecs_world_t *world,
3367 ecs_entity_t entity,
3368 ecs_id_t id,
3369 size_t size,
3370 const void *ptr);
3371
3399FLECS_API
3400 bool ecs_is_valid(
3401 const ecs_world_t *world,
3402 ecs_entity_t e);
3403
3429FLECS_API
3430 bool ecs_is_alive(
3431 const ecs_world_t *world,
3432 ecs_entity_t e);
3433
3439FLECS_API
3440 ecs_id_t ecs_strip_generation(
3441 ecs_entity_t e);
3442
3459FLECS_API
3460 ecs_entity_t ecs_get_alive(
3461 const ecs_world_t *world,
3462 ecs_entity_t e);
3463
3486FLECS_API
3487 void ecs_make_alive(
3488 ecs_world_t *world,
3489 ecs_entity_t entity);
3490
3509FLECS_API
3510 void ecs_make_alive_id(
3511 ecs_world_t *world,
3512 ecs_id_t id);
3513
3521FLECS_API
3522 bool ecs_exists(
3523 const ecs_world_t *world,
3524 ecs_entity_t entity);
3525
3540FLECS_API
3541 void ecs_set_version(
3542 ecs_world_t *world,
3543 ecs_entity_t entity);
3544
3560FLECS_API
3561 const ecs_type_t* ecs_get_type(
3562 const ecs_world_t *world,
3563 ecs_entity_t entity);
3564
3571FLECS_API
3572 ecs_table_t* ecs_get_table(
3573 const ecs_world_t *world,
3574 ecs_entity_t entity);
3575
3583FLECS_API
3584 char* ecs_type_str(
3585 const ecs_world_t *world,
3586 const ecs_type_t* type);
3587
3599FLECS_API
3600 char* ecs_table_str(
3601 const ecs_world_t *world,
3602 const ecs_table_t *table);
3603
3618FLECS_API
3619 char* ecs_entity_str(
3620 const ecs_world_t *world,
3621 ecs_entity_t entity);
3622
3633FLECS_API
3634 bool ecs_has_id(
3635 const ecs_world_t *world,
3636 ecs_entity_t entity,
3637 ecs_id_t id);
3638
3649FLECS_API
3650 bool ecs_owns_id(
3651 const ecs_world_t *world,
3652 ecs_entity_t entity,
3653 ecs_id_t id);
3654
3669FLECS_API
3670 ecs_entity_t ecs_get_target(
3671 const ecs_world_t *world,
3672 ecs_entity_t entity,
3673 ecs_entity_t rel,
3674 int32_t index);
3675
3689FLECS_API
3690 ecs_entity_t ecs_get_parent(
3691 const ecs_world_t *world,
3692 ecs_entity_t entity);
3693
3714FLECS_API
3715 ecs_entity_t ecs_get_target_for_id(
3716 const ecs_world_t *world,
3717 ecs_entity_t entity,
3718 ecs_entity_t rel,
3719 ecs_id_t id);
3720
3731FLECS_API
3732int32_t ecs_get_depth(
3733 const ecs_world_t *world,
3734 ecs_entity_t entity,
3735 ecs_entity_t rel);
3736
3744FLECS_API
3745int32_t ecs_count_id(
3746 const ecs_world_t *world,
3747 ecs_id_t entity);
3748
3768FLECS_API
3769 const char* ecs_get_name(
3770 const ecs_world_t *world,
3771 ecs_entity_t entity);
3772
3782FLECS_API
3783 const char* ecs_get_symbol(
3784 const ecs_world_t *world,
3785 ecs_entity_t entity);
3786
3800FLECS_API
3801 ecs_entity_t ecs_set_name(
3802 ecs_world_t *world,
3803 ecs_entity_t entity,
3804 const char *name);
3805
3819FLECS_API
3820 ecs_entity_t ecs_set_symbol(
3821 ecs_world_t *world,
3822 ecs_entity_t entity,
3823 const char *symbol);
3824
3836FLECS_API
3837 void ecs_set_alias(
3838 ecs_world_t *world,
3839 ecs_entity_t entity,
3840 const char *alias);
3841
3857FLECS_API
3858 ecs_entity_t ecs_lookup(
3859 const ecs_world_t *world,
3860 const char *path);
3861
3876FLECS_API
3877 ecs_entity_t ecs_lookup_child(
3878 const ecs_world_t *world,
3879 ecs_entity_t parent,
3880 const char *name);
3881
3904FLECS_API
3905 ecs_entity_t ecs_lookup_path_w_sep(
3906 const ecs_world_t *world,
3907 ecs_entity_t parent,
3908 const char *path,
3909 const char *sep,
3910 const char *prefix,
3911 bool recursive);
3912
3930FLECS_API
3931 ecs_entity_t ecs_lookup_symbol(
3932 const ecs_world_t *world,
3933 const char *symbol,
3934 bool lookup_as_path,
3935 bool recursive);
3936
3958FLECS_API
3959 char* ecs_get_path_w_sep(
3960 const ecs_world_t *world,
3961 ecs_entity_t parent,
3962 ecs_entity_t child,
3963 const char *sep,
3964 const char *prefix);
3965
3978 void ecs_get_path_w_sep_buf(
3979 const ecs_world_t *world,
3980 ecs_entity_t parent,
3981 ecs_entity_t child,
3982 const char *sep,
3983 const char *prefix,
3984 ecs_strbuf_t *buf,
3985 bool escape);
3986
4002FLECS_API
4003 ecs_entity_t ecs_new_from_path_w_sep(
4004 ecs_world_t *world,
4005 ecs_entity_t parent,
4006 const char *path,
4007 const char *sep,
4008 const char *prefix);
4009
4024FLECS_API
4025 ecs_entity_t ecs_add_path_w_sep(
4026 ecs_world_t *world,
4027 ecs_entity_t entity,
4028 ecs_entity_t parent,
4029 const char *path,
4030 const char *sep,
4031 const char *prefix);
4032
4046FLECS_API
4047 ecs_entity_t ecs_set_scope(
4048 ecs_world_t *world,
4049 ecs_entity_t scope);
4050
4058FLECS_API
4059 ecs_entity_t ecs_get_scope(
4060 const ecs_world_t *world);
4061
4071FLECS_API
4072 const char* ecs_set_name_prefix(
4073 ecs_world_t *world,
4074 const char *prefix);
4075
4102FLECS_API
4103 ecs_entity_t* ecs_set_lookup_path(
4104 ecs_world_t *world,
4105 const ecs_entity_t *lookup_path);
4106
4113FLECS_API
4114 ecs_entity_t* ecs_get_lookup_path(
4115 const ecs_world_t *world);
4116
4141FLECS_API
4142 ecs_entity_t ecs_component_init(
4143 ecs_world_t *world,
4144 const ecs_component_desc_t *desc);
4145
4155FLECS_API
4156 const ecs_type_info_t* ecs_get_type_info(
4157 const ecs_world_t *world,
4158 ecs_id_t id);
4159
4171FLECS_API
4172 void ecs_set_hooks_id(
4173 ecs_world_t *world,
4174 ecs_entity_t id,
4175 const ecs_type_hooks_t *hooks);
4176
4183FLECS_API
4184 const ecs_type_hooks_t* ecs_get_hooks_id(
4185 const ecs_world_t *world,
4186 ecs_entity_t id);
4187
4211FLECS_API
4212 bool ecs_id_is_tag(
4213 const ecs_world_t *world,
4214 ecs_id_t id);
4215
4224FLECS_API
4225 bool ecs_id_in_use(
4226 const ecs_world_t *world,
4227 ecs_id_t id);
4228
4248FLECS_API
4249 ecs_entity_t ecs_get_typeid(
4250 const ecs_world_t *world,
4251 ecs_id_t id);
4252
4261FLECS_API
4262 bool ecs_id_match(
4263 ecs_id_t id,
4264 ecs_id_t pattern);
4265
4271FLECS_API
4272 bool ecs_id_is_pair(
4273 ecs_id_t id);
4274
4280FLECS_API
4281 bool ecs_id_is_wildcard(
4282 ecs_id_t id);
4283
4297FLECS_API
4298 bool ecs_id_is_valid(
4299 const ecs_world_t *world,
4300 ecs_id_t id);
4301
4310FLECS_API
4311ecs_flags32_t ecs_id_get_flags(
4312 const ecs_world_t *world,
4313 ecs_id_t id);
4314
4321FLECS_API
4322 const char* ecs_id_flag_str(
4323 ecs_id_t id_flags);
4324
4332FLECS_API
4333 char* ecs_id_str(
4334 const ecs_world_t *world,
4335 ecs_id_t id);
4336
4344FLECS_API
4345 void ecs_id_str_buf(
4346 const ecs_world_t *world,
4347 ecs_id_t id,
4348 ecs_strbuf_t *buf);
4349
4357FLECS_API
4358 ecs_id_t ecs_id_from_str(
4359 const ecs_world_t *world,
4360 const char *expr);
4361
4375FLECS_API
4376 bool ecs_term_ref_is_set(
4377 const ecs_term_ref_t *id);
4378
4390FLECS_API
4391 bool ecs_term_is_initialized(
4392 const ecs_term_t *term);
4393
4408FLECS_API
4409 bool ecs_term_match_this(
4410 const ecs_term_t *term);
4411
4424FLECS_API
4425 bool ecs_term_match_0(
4426 const ecs_term_t *term);
4427
4436FLECS_API
4437 char* ecs_term_str(
4438 const ecs_world_t *world,
4439 const ecs_term_t *term);
4440
4448FLECS_API
4449 char* ecs_query_str(
4450 const ecs_query_t *query);
4451
4492FLECS_API
4493 ecs_iter_t ecs_each_id(
4494 const ecs_world_t *world,
4495 ecs_id_t id);
4496
4502FLECS_API
4503 bool ecs_each_next(
4504 ecs_iter_t *it);
4505
4518FLECS_API
4519 ecs_iter_t ecs_children(
4520 const ecs_world_t *world,
4521 ecs_entity_t parent);
4522
4528FLECS_API
4529 bool ecs_children_next(
4530 ecs_iter_t *it);
4531
4547FLECS_API
4548 ecs_query_t* ecs_query_init(
4549 ecs_world_t *world,
4550 const ecs_query_desc_t *desc);
4551
4556FLECS_API
4557 void ecs_query_fini(
4558 ecs_query_t *query);
4559
4568FLECS_API
4569int32_t ecs_query_find_var(
4570 const ecs_query_t *query,
4571 const char *name);
4572
4580FLECS_API
4581 const char* ecs_query_var_name(
4582 const ecs_query_t *query,
4583 int32_t var_id);
4584
4595FLECS_API
4596 bool ecs_query_var_is_entity(
4597 const ecs_query_t *query,
4598 int32_t var_id);
4599
4668FLECS_API
4669 ecs_iter_t ecs_query_iter(
4670 const ecs_world_t *world,
4671 const ecs_query_t *query);
4672
4680FLECS_API
4681 bool ecs_query_next(
4682 ecs_iter_t *it);
4683
4702FLECS_API
4703 bool ecs_query_has(
4704 ecs_query_t *query,
4705 ecs_entity_t entity,
4706 ecs_iter_t *it);
4707
4726FLECS_API
4727 bool ecs_query_has_table(
4728 ecs_query_t *query,
4729 ecs_table_t *table,
4730 ecs_iter_t *it);
4731
4758FLECS_API
4759 bool ecs_query_has_range(
4760 ecs_query_t *query,
4761 ecs_table_range_t *range,
4762 ecs_iter_t *it);
4763
4771FLECS_API
4772int32_t ecs_query_match_count(
4773 const ecs_query_t *query);
4774
4784FLECS_API
4785 char* ecs_query_plan(
4786 const ecs_query_t *query);
4787
4802FLECS_API
4803 char* ecs_query_plan_w_profile(
4804 const ecs_query_t *query,
4805 const ecs_iter_t *it);
4806
4824FLECS_API
4825 const char* ecs_query_args_parse(
4826 ecs_query_t *query,
4827 ecs_iter_t *it,
4828 const char *expr);
4829
4857FLECS_API
4858 bool ecs_query_changed(
4859 ecs_query_t *query);
4860
4871FLECS_API
4872 void ecs_iter_skip(
4873 ecs_iter_t *it);
4874
4897FLECS_API
4898 void ecs_iter_set_group(
4899 ecs_iter_t *it,
4900 uint64_t group_id);
4901
4910FLECS_API
4911 void* ecs_query_get_group_ctx(
4912 const ecs_query_t *query,
4913 uint64_t group_id);
4914
4923FLECS_API
4924 const ecs_query_group_info_t* ecs_query_get_group_info(
4925 const ecs_query_t *query,
4926 uint64_t group_id);
4927
4929 typedef struct ecs_query_count_t {
4930 int32_t results;
4931 int32_t entities;
4932 int32_t tables;
4933 int32_t empty_tables;
4934} ecs_query_count_t;
4935
4942FLECS_API
4943 ecs_query_count_t ecs_query_count(
4944 const ecs_query_t *query);
4945
4951FLECS_API
4952 bool ecs_query_is_true(
4953 const ecs_query_t *query);
4954
4963FLECS_API
4964 const ecs_query_t* ecs_query_get_cache_query(
4965 const ecs_query_t *query);
4966
4995FLECS_API
4996 void ecs_emit(
4997 ecs_world_t *world,
4998 ecs_event_desc_t *desc);
4999
5010FLECS_API
5011 void ecs_enqueue(
5012 ecs_world_t *world,
5013 ecs_event_desc_t *desc);
5014
5025FLECS_API
5026 ecs_entity_t ecs_observer_init(
5027 ecs_world_t *world,
5028 const ecs_observer_desc_t *desc);
5029
5038FLECS_API
5039 const ecs_observer_t* ecs_observer_get(
5040 const ecs_world_t *world,
5041 ecs_entity_t observer);
5042
5065FLECS_API
5066 bool ecs_iter_next(
5067 ecs_iter_t *it);
5068
5078FLECS_API
5079 void ecs_iter_fini(
5080 ecs_iter_t *it);
5081
5093FLECS_API
5094int32_t ecs_iter_count(
5095 ecs_iter_t *it);
5096
5109FLECS_API
5110 bool ecs_iter_is_true(
5111 ecs_iter_t *it);
5112
5120FLECS_API
5121 ecs_entity_t ecs_iter_first(
5122 ecs_iter_t *it);
5123
5162FLECS_API
5163 void ecs_iter_set_var(
5164 ecs_iter_t *it,
5165 int32_t var_id,
5166 ecs_entity_t entity);
5167
5178FLECS_API
5179 void ecs_iter_set_var_as_table(
5180 ecs_iter_t *it,
5181 int32_t var_id,
5182 const ecs_table_t *table);
5183
5194FLECS_API
5195 void ecs_iter_set_var_as_range(
5196 ecs_iter_t *it,
5197 int32_t var_id,
5198 const ecs_table_range_t *range);
5199
5212FLECS_API
5213 ecs_entity_t ecs_iter_get_var(
5214 ecs_iter_t *it,
5215 int32_t var_id);
5216
5230FLECS_API
5231 ecs_table_t* ecs_iter_get_var_as_table(
5232 ecs_iter_t *it,
5233 int32_t var_id);
5234
5248FLECS_API
5249ecs_table_range_t ecs_iter_get_var_as_range(
5250 ecs_iter_t *it,
5251 int32_t var_id);
5252
5264FLECS_API
5265 bool ecs_iter_var_is_constrained(
5266 ecs_iter_t *it,
5267 int32_t var_id);
5268
5280FLECS_API
5281 bool ecs_iter_changed(
5282 ecs_iter_t *it);
5283
5295FLECS_API
5296 char* ecs_iter_str(
5297 const ecs_iter_t *it);
5298
5314FLECS_API
5315 ecs_iter_t ecs_page_iter(
5316 const ecs_iter_t *it,
5317 int32_t offset,
5318 int32_t limit);
5319
5326FLECS_API
5327 bool ecs_page_next(
5328 ecs_iter_t *it);
5329
5350FLECS_API
5351 ecs_iter_t ecs_worker_iter(
5352 const ecs_iter_t *it,
5353 int32_t index,
5354 int32_t count);
5355
5362FLECS_API
5363 bool ecs_worker_next(
5364 ecs_iter_t *it);
5365
5407FLECS_API
5408 void* ecs_field_w_size(
5409 const ecs_iter_t *it,
5410 size_t size,
5411 int8_t index);
5412
5434FLECS_API
5435 void* ecs_field_at_w_size(
5436 const ecs_iter_t *it,
5437 size_t size,
5438 int8_t index,
5439 int32_t row);
5440
5449FLECS_API
5450 bool ecs_field_is_readonly(
5451 const ecs_iter_t *it,
5452 int8_t index);
5453
5464FLECS_API
5465 bool ecs_field_is_writeonly(
5466 const ecs_iter_t *it,
5467 int8_t index);
5468
5475FLECS_API
5476 bool ecs_field_is_set(
5477 const ecs_iter_t *it,
5478 int8_t index);
5479
5486FLECS_API
5487 ecs_id_t ecs_field_id(
5488 const ecs_iter_t *it,
5489 int8_t index);
5490
5499FLECS_API
5500int32_t ecs_field_column(
5501 const ecs_iter_t *it,
5502 int8_t index);
5503
5511FLECS_API
5512 ecs_entity_t ecs_field_src(
5513 const ecs_iter_t *it,
5514 int8_t index);
5515
5523FLECS_API
5524 size_t ecs_field_size(
5525 const ecs_iter_t *it,
5526 int8_t index);
5527
5541FLECS_API
5542 bool ecs_field_is_self(
5543 const ecs_iter_t *it,
5544 int8_t index);
5545
5561FLECS_API
5562 const ecs_type_t* ecs_table_get_type(
5563 const ecs_table_t *table);
5564
5575FLECS_API
5576int32_t ecs_table_get_type_index(
5577 const ecs_world_t *world,
5578 const ecs_table_t *table,
5579 ecs_id_t id);
5580
5590FLECS_API
5591int32_t ecs_table_get_column_index(
5592 const ecs_world_t *world,
5593 const ecs_table_t *table,
5594 ecs_id_t id);
5595
5603FLECS_API
5604int32_t ecs_table_column_count(
5605 const ecs_table_t *table);
5606
5620FLECS_API
5621int32_t ecs_table_type_to_column_index(
5622 const ecs_table_t *table,
5623 int32_t index);
5624
5633FLECS_API
5634int32_t ecs_table_column_to_type_index(
5635 const ecs_table_t *table,
5636 int32_t index);
5637
5646FLECS_API
5647 void* ecs_table_get_column(
5648 const ecs_table_t *table,
5649 int32_t index,
5650 int32_t offset);
5651
5661FLECS_API
5662 void* ecs_table_get_id(
5663 const ecs_world_t *world,
5664 const ecs_table_t *table,
5665 ecs_id_t id,
5666 int32_t offset);
5667
5675FLECS_API
5676 size_t ecs_table_get_column_size(
5677 const ecs_table_t *table,
5678 int32_t index);
5679
5686FLECS_API
5687int32_t ecs_table_count(
5688 const ecs_table_t *table);
5689
5697FLECS_API
5698int32_t ecs_table_size(
5699 const ecs_table_t *table);
5700
5707FLECS_API
5708 const ecs_entity_t* ecs_table_entities(
5709 const ecs_table_t *table);
5710
5721FLECS_API
5722 bool ecs_table_has_id(
5723 const ecs_world_t *world,
5724 const ecs_table_t *table,
5725 ecs_id_t id);
5726
5737FLECS_API
5738int32_t ecs_table_get_depth(
5739 const ecs_world_t *world,
5740 const ecs_table_t *table,
5741 ecs_entity_t rel);
5742
5752FLECS_API
5753 ecs_table_t* ecs_table_add_id(
5754 ecs_world_t *world,
5755 ecs_table_t *table,
5756 ecs_id_t id);
5757
5768FLECS_API
5769 ecs_table_t* ecs_table_find(
5770 ecs_world_t *world,
5771 const ecs_id_t *ids,
5772 int32_t id_count);
5773
5783FLECS_API
5784 ecs_table_t* ecs_table_remove_id(
5785 ecs_world_t *world,
5786 ecs_table_t *table,
5787 ecs_id_t id);
5788
5804FLECS_API
5805 void ecs_table_lock(
5806 ecs_world_t *world,
5807 ecs_table_t *table);
5808
5815FLECS_API
5816 void ecs_table_unlock(
5817 ecs_world_t *world,
5818 ecs_table_t *table);
5819
5829FLECS_API
5830 bool ecs_table_has_flags(
5831 ecs_table_t *table,
5832 ecs_flags32_t flags);
5833
5841FLECS_API
5842 void ecs_table_swap_rows(
5843 ecs_world_t* world,
5844 ecs_table_t* table,
5845 int32_t row_1,
5846 int32_t row_2);
5847
5870FLECS_API
5871 bool ecs_commit(
5872 ecs_world_t *world,
5873 ecs_entity_t entity,
5874 ecs_record_t *record,
5875 ecs_table_t *table,
5876 const ecs_type_t *added,
5877 const ecs_type_t *removed);
5878
5879
5898FLECS_API
5899int32_t ecs_search(
5900 const ecs_world_t *world,
5901 const ecs_table_t *table,
5902 ecs_id_t id,
5903 ecs_id_t *id_out);
5904
5940FLECS_API
5941int32_t ecs_search_offset(
5942 const ecs_world_t *world,
5943 const ecs_table_t *table,
5944 int32_t offset,
5945 ecs_id_t id,
5946 ecs_id_t *id_out);
5947
5989FLECS_API
5990int32_t ecs_search_relation(
5991 const ecs_world_t *world,
5992 const ecs_table_t *table,
5993 int32_t offset,
5994 ecs_id_t id,
5995 ecs_entity_t rel,
5996 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
5997 ecs_entity_t *subject_out,
5998 ecs_id_t *id_out,
5999 struct ecs_table_record_t **tr_out);
6000
6008FLECS_API
6009 void ecs_table_clear_entities(
6010 ecs_world_t* world,
6011 ecs_table_t* table);
6012
6029FLECS_API
6030 int ecs_value_init(
6031 const ecs_world_t *world,
6032 ecs_entity_t type,
6033 void *ptr);
6034
6042FLECS_API
6043 int ecs_value_init_w_type_info(
6044 const ecs_world_t *world,
6045 const ecs_type_info_t *ti,
6046 void *ptr);
6047
6054FLECS_API
6055 void* ecs_value_new(
6056 ecs_world_t *world,
6057 ecs_entity_t type);
6058
6065 void* ecs_value_new_w_type_info(
6066 ecs_world_t *world,
6067 const ecs_type_info_t *ti);
6068
6076 int ecs_value_fini_w_type_info(
6077 const ecs_world_t *world,
6078 const ecs_type_info_t *ti,
6079 void *ptr);
6080
6088FLECS_API
6089 int ecs_value_fini(
6090 const ecs_world_t *world,
6091 ecs_entity_t type,
6092 void* ptr);
6093
6101FLECS_API
6102 int ecs_value_free(
6103 ecs_world_t *world,
6104 ecs_entity_t type,
6105 void* ptr);
6106
6115FLECS_API
6116 int ecs_value_copy_w_type_info(
6117 const ecs_world_t *world,
6118 const ecs_type_info_t *ti,
6119 void* dst,
6120 const void *src);
6121
6130FLECS_API
6131 int ecs_value_copy(
6132 const ecs_world_t *world,
6133 ecs_entity_t type,
6134 void* dst,
6135 const void *src);
6136
6145 int ecs_value_move_w_type_info(
6146 const ecs_world_t *world,
6147 const ecs_type_info_t *ti,
6148 void* dst,
6149 void *src);
6150
6159 int ecs_value_move(
6160 const ecs_world_t *world,
6161 ecs_entity_t type,
6162 void* dst,
6163 void *src);
6164
6173 int ecs_value_move_ctor_w_type_info(
6174 const ecs_world_t *world,
6175 const ecs_type_info_t *ti,
6176 void* dst,
6177 void *src);
6178
6187 int ecs_value_move_ctor(
6188 const ecs_world_t *world,
6189 ecs_entity_t type,
6190 void* dst,
6191 void *src);
6192
6206#include "flecs/addons/flecs_c.h"
6207
6208#ifdef __cplusplus
6209}
6210#endif
6211
6212#include "flecs/private/addons.h"
6213
6214#endif
deprecated.h
The deprecated addon contains deprecated operations.
flecs_c.h
Extends the core API with convenience macros for C applications.
ecs_set_with
ecs_entity_t ecs_set_with(ecs_world_t *world, ecs_id_t id)
Set current with id.
ecs_add_id
void ecs_add_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Add a (component) id to an entity.
ecs_remove_id
void ecs_remove_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Remove a (component) id from an entity.
ecs_clear
void ecs_clear(ecs_world_t *world, ecs_entity_t entity)
Clear all components.
ecs_get_with
ecs_id_t ecs_get_with(const ecs_world_t *world)
Get current with id.
ecs_remove_all
void ecs_remove_all(ecs_world_t *world, ecs_id_t id)
Remove all instances of the specified (component) id.
ecs_auto_override_id
void ecs_auto_override_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Add auto override for (component) id.
ecs_value_t
struct ecs_value_t ecs_value_t
Utility to hold a value of a dynamic type.
EcsIdentifier
struct EcsIdentifier EcsIdentifier
A (string) identifier.
EcsPoly
struct EcsPoly EcsPoly
Component for storing a poly object.
EcsDefaultChildComponent
struct EcsDefaultChildComponent EcsDefaultChildComponent
When added to an entity this informs serialization formats which component to use when a value is ass...
EcsComponent
struct EcsComponent EcsComponent
Component information.
EcsScopeClose
const ecs_entity_t EcsScopeClose
Marker used to indicate the end of a scope (}) in queries.
EcsOnRemove
const ecs_entity_t EcsOnRemove
Event that triggers when an id is removed from an entity.
EcsThis
const ecs_entity_t EcsThis
This entity.
EcsWildcard
const ecs_entity_t EcsWildcard
Wildcard entity ("*").
EcsName
const ecs_entity_t EcsName
Tag to indicate name identifier.
EcsAcyclic
const ecs_entity_t EcsAcyclic
Marks a relationship as acyclic.
EcsSymmetric
const ecs_entity_t EcsSymmetric
Marks relationship as commutative.
EcsAlias
const ecs_entity_t EcsAlias
Tag to indicate alias identifier.
EcsOnSet
const ecs_entity_t EcsOnSet
Event that triggers when a component is set for an entity.
EcsReflexive
const ecs_entity_t EcsReflexive
Marks a relationship as reflexive.
EcsTrait
const ecs_entity_t EcsTrait
Can be added to components to indicate it is a trait.
EcsEmpty
const ecs_entity_t EcsEmpty
Tag used to indicate query is empty.
EcsOneOf
const ecs_entity_t EcsOneOf
Ensure that relationship target is child of specified entity.
EcsOnTableDelete
const ecs_entity_t EcsOnTableDelete
Event that triggers when a table is deleted.
EcsOnTableCreate
const ecs_entity_t EcsOnTableCreate
Event that triggers when a table is created.
EcsObserver
const ecs_entity_t EcsObserver
Tag added to observers.
EcsQuery
const ecs_entity_t EcsQuery
Tag added to queries.
EcsRelationship
const ecs_entity_t EcsRelationship
Ensure that an entity is always used in pair as relationship.
EcsOnStart
const ecs_entity_t EcsOnStart
OnStart pipeline phase.
EcsNotQueryable
const ecs_entity_t EcsNotQueryable
Trait added to entities that should never be returned by queries.
EcsOnStore
const ecs_entity_t EcsOnStore
OnStore pipeline phase.
EcsTraversable
const ecs_entity_t EcsTraversable
Marks a relationship as traversable.
EcsPredLookup
const ecs_entity_t EcsPredLookup
Marker used to indicate $var ~= "pattern" matching in queries.
EcsPreStore
const ecs_entity_t EcsPreStore
PreStore pipeline phase.
EcsOnLoad
const ecs_entity_t EcsOnLoad
OnLoad pipeline phase.
EcsIsA
const ecs_entity_t EcsIsA
Used to express inheritance relationships.
EcsExclusive
const ecs_entity_t EcsExclusive
Can be added to relationship to indicate that the relationship can only occur once on an entity.
EcsSymbol
const ecs_entity_t EcsSymbol
Tag to indicate symbol identifier.
EcsDependsOn
const ecs_entity_t EcsDependsOn
Used to express dependency relationships.
EcsTransitive
const ecs_entity_t EcsTransitive
Marks a relationship as transitive.
EcsDelete
const ecs_entity_t EcsDelete
Delete cleanup policy.
EcsOnTableFill
const ecs_entity_t EcsOnTableFill
Event that triggers when a table becomes non-empty.
EcsChildOf
const ecs_entity_t EcsChildOf
Used to express parent-child relationships.
EcsFlecsCore
const ecs_entity_t EcsFlecsCore
Core module scope.
EcsMonitor
const ecs_entity_t EcsMonitor
Event that triggers observer when an entity starts/stops matching a query.
EcsCanToggle
const ecs_entity_t EcsCanToggle
Mark a component as toggleable with ecs_enable_id().
EcsPredEq
const ecs_entity_t EcsPredEq
Marker used to indicate $var == ... matching in queries.
EcsPhase
const ecs_entity_t EcsPhase
Phase pipeline phase.
EcsOnTableEmpty
const ecs_entity_t EcsOnTableEmpty
Event that triggers when a table becomes empty (doesn't emit on creation).
EcsWorld
const ecs_entity_t EcsWorld
Entity associated with world (used for "attaching" components to world)
EcsPrivate
const ecs_entity_t EcsPrivate
Tag to indicate an entity/component/system is private to a module.
EcsScopeOpen
const ecs_entity_t EcsScopeOpen
Marker used to indicate the start of a scope ({) in queries.
EcsPostUpdate
const ecs_entity_t EcsPostUpdate
PostUpdate pipeline phase.
EcsOnValidate
const ecs_entity_t EcsOnValidate
OnValidate pipeline phase.
EcsRemove
const ecs_entity_t EcsRemove
Remove cleanup policy.
EcsOverride
const ecs_entity_t EcsOverride
Override component on instantiate.
EcsPredMatch
const ecs_entity_t EcsPredMatch
Marker used to indicate $var == "name" matching in queries.
EcsInherit
const ecs_entity_t EcsInherit
Inherit component on instantiate.
EcsSlotOf
const ecs_entity_t EcsSlotOf
Used to express a slot (used with prefab inheritance)
EcsModule
const ecs_entity_t EcsModule
Tag added to module entities.
EcsSparse
const ecs_entity_t EcsSparse
Mark component as sparse.
EcsPreUpdate
const ecs_entity_t EcsPreUpdate
PreUpdate pipeline phase.
EcsOnAdd
const ecs_entity_t EcsOnAdd
Event that triggers when an id is added to an entity.
EcsPrefab
const ecs_entity_t EcsPrefab
Tag added to prefab entities.
EcsOnInstantiate
const ecs_entity_t EcsOnInstantiate
Relationship that specifies component inheritance behavior.
EcsUnion
const ecs_entity_t EcsUnion
Mark relationship as union.
EcsPostFrame
const ecs_entity_t EcsPostFrame
PostFrame pipeline phase.
EcsAny
const ecs_entity_t EcsAny
Any entity ("_").
EcsTarget
const ecs_entity_t EcsTarget
Ensure that an entity is always used in pair as target.
EcsWith
const ecs_entity_t EcsWith
Ensure that a component always is added together with another component.
EcsPostLoad
const ecs_entity_t EcsPostLoad
PostLoad pipeline phase.
EcsOnDelete
const ecs_entity_t EcsOnDelete
Relationship used for specifying cleanup behavior.
EcsOnDeleteTarget
const ecs_entity_t EcsOnDeleteTarget
Relationship used to define what should happen when a target entity (second element of a pair) is del...
EcsPreFrame
const ecs_entity_t EcsPreFrame
PreFrame pipeline phase.
EcsFlecs
const ecs_entity_t EcsFlecs
Root scope for builtin flecs entities.
EcsSystem
const ecs_entity_t EcsSystem
Tag added to systems.
EcsOnUpdate
const ecs_entity_t EcsOnUpdate
OnUpdate pipeline phase.
EcsDisabled
const ecs_entity_t EcsDisabled
When this tag is added to an entity it is skipped by queries, unless EcsDisabled is explicitly querie...
EcsDontInherit
const ecs_entity_t EcsDontInherit
Never inherit component on instantiate.
EcsPairIsTag
const ecs_entity_t EcsPairIsTag
Can be added to relationship to indicate that it should never hold data, even when it or the relation...
EcsPanic
const ecs_entity_t EcsPanic
Panic cleanup policy.
EcsFinal
const ecs_entity_t EcsFinal
Ensures that entity/component cannot be used as target in IsA relationship.
EcsVariable
const ecs_entity_t EcsVariable
Variable entity ("$").
ecs_id
FLECS_API const ecs_entity_t ecs_id(EcsDocDescription)
Component id for EcsDocDescription.
ecs_stage_new
ecs_world_t * ecs_stage_new(ecs_world_t *world)
Create unmanaged stage.
ecs_defer_end
bool ecs_defer_end(ecs_world_t *world)
End block of operations to defer.
ecs_readonly_begin
bool ecs_readonly_begin(ecs_world_t *world, bool multi_threaded)
Begin readonly mode.
ecs_defer_resume
void ecs_defer_resume(ecs_world_t *world)
Resume deferring.
ecs_defer_begin
bool ecs_defer_begin(ecs_world_t *world)
Defer operations until end of frame.
ecs_defer_suspend
void ecs_defer_suspend(ecs_world_t *world)
Suspend deferring but do not flush queue.
ecs_is_deferred
bool ecs_is_deferred(const ecs_world_t *world)
Test if deferring is enabled for current stage.
ecs_stage_free
void ecs_stage_free(ecs_world_t *stage)
Free unmanaged stage.
ecs_merge
void ecs_merge(ecs_world_t *world)
Merge world or stage.
ecs_stage_get_id
int32_t ecs_stage_get_id(const ecs_world_t *world)
Get stage id.
ecs_stage_is_readonly
bool ecs_stage_is_readonly(const ecs_world_t *world)
Test whether the current world is readonly.
ecs_get_stage_count
int32_t ecs_get_stage_count(const ecs_world_t *world)
Get number of configured stages.
ecs_get_stage
ecs_world_t * ecs_get_stage(const ecs_world_t *world, int32_t stage_id)
Get stage-specific world pointer.
ecs_set_stage_count
void ecs_set_stage_count(ecs_world_t *world, int32_t stages)
Configure world to have N stages.
ecs_readonly_end
void ecs_readonly_end(ecs_world_t *world)
End readonly mode.
ecs_component_init
ecs_entity_t ecs_component_init(ecs_world_t *world, const ecs_component_desc_t *desc)
Find or create a component.
ecs_set_hooks_id
void ecs_set_hooks_id(ecs_world_t *world, ecs_entity_t id, const ecs_type_hooks_t *hooks)
Register hooks for component.
ecs_component_desc_t
struct ecs_component_desc_t ecs_component_desc_t
Used with ecs_component_init().
ecs_get_type_info
const ecs_type_info_t * ecs_get_type_info(const ecs_world_t *world, ecs_id_t id)
Get the type for an id.
ecs_get_hooks_id
const ecs_type_hooks_t * ecs_get_hooks_id(const ecs_world_t *world, ecs_entity_t id)
Get hooks for component.
ecs_header_t
struct ecs_header_t ecs_header_t
Header for ecs_poly_t objects.
ecs_stage_t
struct ecs_stage_t ecs_stage_t
A stage enables modification while iterating and from multiple threads.
Definition flecs.h:394
ecs_ref_t
struct ecs_ref_t ecs_ref_t
A ref is a fast way to fetch a component for a specific entity.
Definition flecs.h:443
ecs_entity_t
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:347
ecs_table_record_t
struct ecs_table_record_t ecs_table_record_t
Metadata describing where a component id is stored in a table.
ecs_id_record_t
struct ecs_id_record_t ecs_id_record_t
Information about a (component) id, such as type info and tables with the id.
Definition flecs.h:459
ecs_world_t
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:391
ecs_mixins_t
struct ecs_mixins_t ecs_mixins_t
Type that stores poly mixins.
Definition flecs.h:483
ecs_id_t
uint64_t ecs_id_t
Ids are the things that can be added to an entity.
Definition flecs.h:340
ecs_observable_t
struct ecs_observable_t ecs_observable_t
An observable produces events that can be listened for by an observer.
Definition flecs.h:427
ecs_table_t
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:397
ecs_poly_t
void ecs_poly_t
A poly object.
Definition flecs.h:480
ecs_table_cache_hdr_t
struct ecs_table_cache_hdr_t ecs_table_cache_hdr_t
Header for table cache elements.
ecs_new_low_id
ecs_entity_t ecs_new_low_id(ecs_world_t *world)
Create new low id.
ecs_new_w_id
ecs_entity_t ecs_new_w_id(ecs_world_t *world, ecs_id_t id)
Create new entity with (component) id.
ecs_bulk_init
const ecs_entity_t * ecs_bulk_init(ecs_world_t *world, const ecs_bulk_desc_t *desc)
Bulk create/populate new entities.
ecs_clone
ecs_entity_t ecs_clone(ecs_world_t *world, ecs_entity_t dst, ecs_entity_t src, bool copy_value)
Clone an entity This operation clones the components of one entity into another entity.
ecs_bulk_new_w_id
const ecs_entity_t * ecs_bulk_new_w_id(ecs_world_t *world, ecs_id_t id, int32_t count)
Create N new entities.
ecs_new
ecs_entity_t ecs_new(ecs_world_t *world)
Create new entity id.
ecs_entity_init
ecs_entity_t ecs_entity_init(ecs_world_t *world, const ecs_entity_desc_t *desc)
Find or create an entity.
ecs_delete_with
void ecs_delete_with(ecs_world_t *world, ecs_id_t id)
Delete all entities with the specified id.
ecs_delete
void ecs_delete(ecs_world_t *world, ecs_entity_t entity)
Delete an entity.
ecs_new_w_table
ecs_entity_t ecs_new_w_table(ecs_world_t *world, ecs_table_t *table)
Create new entity in table.
ecs_children_next
bool ecs_children_next(ecs_iter_t *it)
Progress an iterator created with ecs_children().
ecs_each_next
bool ecs_each_next(ecs_iter_t *it)
Progress an iterator created with ecs_each_id().
ecs_children
ecs_iter_t ecs_children(const ecs_world_t *world, ecs_entity_t parent)
Iterate children of parent.
ecs_each_id
ecs_iter_t ecs_each_id(const ecs_world_t *world, ecs_id_t id)
Iterate all entities with specified (component id).
ecs_is_enabled_id
bool ecs_is_enabled_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if component is enabled.
ecs_enable_id
void ecs_enable_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, bool enable)
Enable or disable component.
ecs_enable
void ecs_enable(ecs_world_t *world, ecs_entity_t entity, bool enabled)
Enable or disable entity.
ecs_bulk_desc_t
struct ecs_bulk_desc_t ecs_bulk_desc_t
Used with ecs_bulk_init().
ecs_entity_desc_t
struct ecs_entity_desc_t ecs_entity_desc_t
Used with ecs_entity_init().
ecs_entity_str
char * ecs_entity_str(const ecs_world_t *world, ecs_entity_t entity)
Convert entity to string.
ecs_get_target
ecs_entity_t ecs_get_target(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, int32_t index)
Get the target of a relationship.
ecs_get_parent
ecs_entity_t ecs_get_parent(const ecs_world_t *world, ecs_entity_t entity)
Get parent (target of ChildOf relationship) for entity.
ecs_get_type
const ecs_type_t * ecs_get_type(const ecs_world_t *world, ecs_entity_t entity)
Get the type of an entity.
ecs_has_id
bool ecs_has_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if an entity has an id.
ecs_type_str
char * ecs_type_str(const ecs_world_t *world, const ecs_type_t *type)
Convert type to string.
ecs_table_str
char * ecs_table_str(const ecs_world_t *world, const ecs_table_t *table)
Convert table to string.
ecs_count_id
int32_t ecs_count_id(const ecs_world_t *world, ecs_id_t entity)
Count entities that have the specified id.
ecs_owns_id
bool ecs_owns_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if an entity owns an id.
ecs_get_depth
int32_t ecs_get_depth(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel)
Return depth for entity in tree for the specified relationship.
ecs_get_target_for_id
ecs_entity_t ecs_get_target_for_id(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, ecs_id_t id)
Get the target of a relationship for a given id.
ecs_get_table
ecs_table_t * ecs_get_table(const ecs_world_t *world, ecs_entity_t entity)
Get the table of an entity.
ecs_module_action_t
void(* ecs_module_action_t)(ecs_world_t *world)
Initialization action for modules.
Definition flecs.h:607
ecs_group_by_action_t
uint64_t(* ecs_group_by_action_t)(ecs_world_t *world, ecs_table_t *table, ecs_id_t group_id, void *ctx)
Callback used for grouping tables in a query.
Definition flecs.h:587
ecs_hash_value_action_t
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:625
ecs_group_delete_action_t
void(* ecs_group_delete_action_t)(ecs_world_t *world, uint64_t group_id, void *group_ctx, void *group_by_ctx)
Callback invoked when a query deletes an existing group.
Definition flecs.h:600
ecs_iter_fini_action_t
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:565
ecs_group_create_action_t
void *(* ecs_group_create_action_t)(ecs_world_t *world, uint64_t group_id, void *group_by_ctx)
Callback invoked when a query creates a new group.
Definition flecs.h:594
ecs_sort_table_action_t
void(* ecs_sort_table_action_t)(ecs_world_t *world, ecs_table_t *table, ecs_entity_t *entities, void *ptr, int32_t size, int32_t lo, int32_t hi, ecs_order_by_action_t order_by)
Callback used for sorting the entire table of components.
Definition flecs.h:576
ecs_iter_next_action_t
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:557
ecs_iter_action_t
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:547
ecs_copy_t
void(* ecs_copy_t)(void *dst_ptr, const void *src_ptr, int32_t count, const ecs_type_info_t *type_info)
Copy is invoked when a component is copied into another component.
Definition flecs.h:635
ecs_compare_action_t
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:620
ecs_fini_action_t
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:611
ecs_move_t
void(* ecs_move_t)(void *dst_ptr, void *src_ptr, int32_t count, const ecs_type_info_t *type_info)
Move is invoked when a component is moved to another component.
Definition flecs.h:642
flecs_poly_dtor_t
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:649
ecs_run_action_t
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:538
ecs_ctx_free_t
void(* ecs_ctx_free_t)(void *ctx)
Function to cleanup context data.
Definition flecs.h:616
ecs_order_by_action_t
int(* ecs_order_by_action_t)(ecs_entity_t e1, const void *ptr1, ecs_entity_t e2, const void *ptr2)
Callback used for comparing components.
Definition flecs.h:569
ecs_xtor_t
void(* ecs_xtor_t)(void *ptr, int32_t count, const ecs_type_info_t *type_info)
Constructor/destructor callback.
Definition flecs.h:629
ecs_get_mut_id
void * ecs_get_mut_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get a mutable pointer to a component.
ecs_ref_init_id
ecs_ref_t ecs_ref_init_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Create a component ref.
ecs_record_get_entity
ecs_entity_t ecs_record_get_entity(const ecs_record_t *record)
Get entity corresponding with record.
ecs_ref_update
void ecs_ref_update(const ecs_world_t *world, ecs_ref_t *ref)
Update ref.
ecs_record_get_id
const void * ecs_record_get_id(const ecs_world_t *world, const ecs_record_t *record, ecs_id_t id)
Get component from entity record.
ecs_record_get_by_column
void * ecs_record_get_by_column(const ecs_record_t *record, int32_t column, size_t size)
Get component pointer from column/record.
ecs_read_end
void ecs_read_end(const ecs_record_t *record)
End read access to entity.
ecs_emplace_id
void * ecs_emplace_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, bool *is_new)
Emplace a component.
ecs_ensure_id
void * ecs_ensure_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get a mutable pointer to a component.
ecs_write_end
void ecs_write_end(ecs_record_t *record)
End exclusive write access to entity.
ecs_set_id
void ecs_set_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, size_t size, const void *ptr)
Set the value of a component.
ecs_ensure_modified_id
void * ecs_ensure_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Combines ensure + modified in single operation.
ecs_ref_get_id
void * ecs_ref_get_id(const ecs_world_t *world, ecs_ref_t *ref, ecs_id_t id)
Get component from ref.
ecs_record_has_id
bool ecs_record_has_id(ecs_world_t *world, const ecs_record_t *record, ecs_id_t id)
Test if entity for record has a (component) id.
ecs_record_ensure_id
void * ecs_record_ensure_id(ecs_world_t *world, ecs_record_t *record, ecs_id_t id)
Same as ecs_record_get_id(), but returns a mutable pointer.
ecs_get_id
const void * ecs_get_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get an immutable pointer to a component.
ecs_write_begin
ecs_record_t * ecs_write_begin(ecs_world_t *world, ecs_entity_t entity)
Begin exclusive write access to entity.
ecs_modified_id
void ecs_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Signal that a component has been modified.
ecs_record_find
ecs_record_t * ecs_record_find(const ecs_world_t *world, ecs_entity_t entity)
Find record for entity.
ecs_read_begin
const ecs_record_t * ecs_read_begin(ecs_world_t *world, ecs_entity_t entity)
Begin read access to entity.
ECS_PAIR
const ecs_id_t ECS_PAIR
Indicates that the id is a pair.
ECS_AUTO_OVERRIDE
const ecs_id_t ECS_AUTO_OVERRIDE
Automatically override component when it is inherited.
ECS_TOGGLE
const ecs_id_t ECS_TOGGLE
Adds bitset to storage which allows component to be enabled/disabled.
ecs_id_is_valid
bool ecs_id_is_valid(const ecs_world_t *world, ecs_id_t id)
Utility to check if id is valid.
ecs_id_is_pair
bool ecs_id_is_pair(ecs_id_t id)
Utility to check if id is a pair.
ecs_get_typeid
ecs_entity_t ecs_get_typeid(const ecs_world_t *world, ecs_id_t id)
Get the type for an id.
ecs_id_match
bool ecs_id_match(ecs_id_t id, ecs_id_t pattern)
Utility to match an id with a pattern.
ecs_id_flag_str
const char * ecs_id_flag_str(ecs_id_t id_flags)
Convert id flag to string.
ecs_id_in_use
bool ecs_id_in_use(const ecs_world_t *world, ecs_id_t id)
Returns whether specified id is in use.
ecs_id_is_tag
bool ecs_id_is_tag(const ecs_world_t *world, ecs_id_t id)
Returns whether specified id a tag.
ecs_id_str_buf
void ecs_id_str_buf(const ecs_world_t *world, ecs_id_t id, ecs_strbuf_t *buf)
Write (component) id string to buffer.
ecs_id_str
char * ecs_id_str(const ecs_world_t *world, ecs_id_t id)
Convert (component) id to string.
ecs_id_is_wildcard
bool ecs_id_is_wildcard(ecs_id_t id)
Utility to check if id is a wildcard.
ecs_id_from_str
ecs_id_t ecs_id_from_str(const ecs_world_t *world, const char *expr)
Convert string to a (component) id.
ecs_id_get_flags
ecs_flags32_t ecs_id_get_flags(const ecs_world_t *world, ecs_id_t id)
Get flags associated with id.
ecs_field_src
ecs_entity_t ecs_field_src(const ecs_iter_t *it, int8_t index)
Return field source.
ecs_iter_changed
bool ecs_iter_changed(ecs_iter_t *it)
Returns whether current iterator result has changed.
ecs_field_is_writeonly
bool ecs_field_is_writeonly(const ecs_iter_t *it, int8_t index)
Test whether the field is writeonly.
ecs_field_is_readonly
bool ecs_field_is_readonly(const ecs_iter_t *it, int8_t index)
Test whether the field is readonly.
ecs_worker_iter
ecs_iter_t ecs_worker_iter(const ecs_iter_t *it, int32_t index, int32_t count)
Create a worker iterator.
ecs_iter_is_true
bool ecs_iter_is_true(ecs_iter_t *it)
Test if iterator is true.
ecs_iter_fini
void ecs_iter_fini(ecs_iter_t *it)
Cleanup iterator resources.
ecs_iter_str
char * ecs_iter_str(const ecs_iter_t *it)
Convert iterator to string.
ecs_iter_var_is_constrained
bool ecs_iter_var_is_constrained(ecs_iter_t *it, int32_t var_id)
Returns whether variable is constrained.
ecs_page_iter
ecs_iter_t ecs_page_iter(const ecs_iter_t *it, int32_t offset, int32_t limit)
Create a paged iterator.
ecs_field_at_w_size
void * ecs_field_at_w_size(const ecs_iter_t *it, size_t size, int8_t index, int32_t row)
Get data for field at specified row.
ecs_field_id
ecs_id_t ecs_field_id(const ecs_iter_t *it, int8_t index)
Return id matched for field.
ecs_field_is_set
bool ecs_field_is_set(const ecs_iter_t *it, int8_t index)
Test whether field is set.
ecs_iter_set_var
void ecs_iter_set_var(ecs_iter_t *it, int32_t var_id, ecs_entity_t entity)
Set value for iterator variable.
ecs_field_is_self
bool ecs_field_is_self(const ecs_iter_t *it, int8_t index)
Test whether the field is matched on self.
ecs_iter_next
bool ecs_iter_next(ecs_iter_t *it)
Progress any iterator.
ecs_iter_get_var
ecs_entity_t ecs_iter_get_var(ecs_iter_t *it, int32_t var_id)
Get value of iterator variable as entity.
ecs_worker_next
bool ecs_worker_next(ecs_iter_t *it)
Progress a worker iterator.
ecs_iter_first
ecs_entity_t ecs_iter_first(ecs_iter_t *it)
Get first matching entity from iterator.
ecs_field_column
int32_t ecs_field_column(const ecs_iter_t *it, int8_t index)
Return index of matched table column.
ecs_iter_set_var_as_table
void ecs_iter_set_var_as_table(ecs_iter_t *it, int32_t var_id, const ecs_table_t *table)
Same as ecs_iter_set_var(), but for a table.
ecs_iter_get_var_as_table
ecs_table_t * ecs_iter_get_var_as_table(ecs_iter_t *it, int32_t var_id)
Get value of iterator variable as table.
ecs_field_w_size
void * ecs_field_w_size(const ecs_iter_t *it, size_t size, int8_t index)
Get data for field.
ecs_iter_count
int32_t ecs_iter_count(ecs_iter_t *it)
Count number of matched entities in query.
ecs_page_next
bool ecs_page_next(ecs_iter_t *it)
Progress a paged iterator.
ecs_iter_set_var_as_range
void ecs_iter_set_var_as_range(ecs_iter_t *it, int32_t var_id, const ecs_table_range_t *range)
Same as ecs_iter_set_var(), but for a range of entities This constrains the variable to a range of en...
ecs_field_size
size_t ecs_field_size(const ecs_iter_t *it, int8_t index)
Return field type size.
ecs_iter_get_var_as_range
ecs_table_range_t ecs_iter_get_var_as_range(ecs_iter_t *it, int32_t var_id)
Get value of iterator variable as table range.
ecs_strip_generation
ecs_id_t ecs_strip_generation(ecs_entity_t e)
Remove generation from entity id.
ecs_is_valid
bool ecs_is_valid(const ecs_world_t *world, ecs_entity_t e)
Test whether an entity is valid.
ecs_make_alive
void ecs_make_alive(ecs_world_t *world, ecs_entity_t entity)
Ensure id is alive.
ecs_make_alive_id
void ecs_make_alive_id(ecs_world_t *world, ecs_id_t id)
Same as ecs_make_alive(), but for (component) ids.
ecs_get_alive
ecs_entity_t ecs_get_alive(const ecs_world_t *world, ecs_entity_t e)
Get alive identifier.
ecs_exists
bool ecs_exists(const ecs_world_t *world, ecs_entity_t entity)
Test whether an entity exists.
ecs_is_alive
bool ecs_is_alive(const ecs_world_t *world, ecs_entity_t e)
Test whether an entity is alive.
ecs_set_version
void ecs_set_version(ecs_world_t *world, ecs_entity_t entity)
Override the generation of an entity.
ecs_world_info_t
struct ecs_world_info_t ecs_world_info_t
Type that contains information about the world.
ecs_query_group_info_t
struct ecs_query_group_info_t ecs_query_group_info_t
Type that contains information about a query group.
ecs_build_info_t
struct ecs_build_info_t ecs_build_info_t
Type with information about the current Flecs build.
ecs_emit
void ecs_emit(ecs_world_t *world, ecs_event_desc_t *desc)
Send event.
ecs_enqueue
void ecs_enqueue(ecs_world_t *world, ecs_event_desc_t *desc)
Enqueue event.
ecs_observer_init
ecs_entity_t ecs_observer_init(ecs_world_t *world, const ecs_observer_desc_t *desc)
Create observer.
ecs_observer_get
const ecs_observer_t * ecs_observer_get(const ecs_world_t *world, ecs_entity_t observer)
Get observer object.
ecs_event_desc_t
struct ecs_event_desc_t ecs_event_desc_t
Used with ecs_emit().
ecs_observer_desc_t
struct ecs_observer_desc_t ecs_observer_desc_t
Used with ecs_observer_init().
FLECS_EVENT_DESC_MAX
#define FLECS_EVENT_DESC_MAX
Maximum number of events in ecs_observer_desc_t.
Definition flecs.h:276
ecs_ftime_t
#define ecs_ftime_t
Customizable precision for scalar time values.
Definition flecs.h:59
FLECS_ID_DESC_MAX
#define FLECS_ID_DESC_MAX
Maximum number of ids to add ecs_entity_desc_t / ecs_bulk_desc_t.
Definition flecs.h:270
FLECS_TERM_COUNT_MAX
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:286
ecs_get_path_w_sep
char * ecs_get_path_w_sep(const ecs_world_t *world, ecs_entity_t parent, ecs_entity_t child, const char *sep, const char *prefix)
Get a path identifier for an entity.
ecs_new_from_path_w_sep
ecs_entity_t ecs_new_from_path_w_sep(ecs_world_t *world, ecs_entity_t parent, const char *path, const char *sep, const char *prefix)
Find or create entity from path.
ecs_lookup_symbol
ecs_entity_t ecs_lookup_symbol(const ecs_world_t *world, const char *symbol, bool lookup_as_path, bool recursive)
Lookup an entity by its symbol name.
ecs_set_alias
void ecs_set_alias(ecs_world_t *world, ecs_entity_t entity, const char *alias)
Set alias for entity.
ecs_lookup
ecs_entity_t ecs_lookup(const ecs_world_t *world, const char *path)
Lookup an entity by it's path.
ecs_get_scope
ecs_entity_t ecs_get_scope(const ecs_world_t *world)
Get the current scope.
ecs_get_path_w_sep_buf
void ecs_get_path_w_sep_buf(const ecs_world_t *world, ecs_entity_t parent, ecs_entity_t child, const char *sep, const char *prefix, ecs_strbuf_t *buf, bool escape)
Write path identifier to buffer.
ecs_set_lookup_path
ecs_entity_t * ecs_set_lookup_path(ecs_world_t *world, const ecs_entity_t *lookup_path)
Set search path for lookup operations.
ecs_set_name
ecs_entity_t ecs_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Set the name of an entity.
ecs_get_symbol
const char * ecs_get_symbol(const ecs_world_t *world, ecs_entity_t entity)
Get the symbol of an entity.
ecs_lookup_path_w_sep
ecs_entity_t ecs_lookup_path_w_sep(const ecs_world_t *world, ecs_entity_t parent, const char *path, const char *sep, const char *prefix, bool recursive)
Lookup an entity from a path.
ecs_set_symbol
ecs_entity_t ecs_set_symbol(ecs_world_t *world, ecs_entity_t entity, const char *symbol)
Set the symbol of an entity.
ecs_lookup_child
ecs_entity_t ecs_lookup_child(const ecs_world_t *world, ecs_entity_t parent, const char *name)
Lookup a child entity by name.
ecs_get_name
const char * ecs_get_name(const ecs_world_t *world, ecs_entity_t entity)
Get the name of an entity.
ecs_add_path_w_sep
ecs_entity_t ecs_add_path_w_sep(ecs_world_t *world, ecs_entity_t entity, ecs_entity_t parent, const char *path, const char *sep, const char *prefix)
Add specified path to entity.
ecs_get_lookup_path
ecs_entity_t * ecs_get_lookup_path(const ecs_world_t *world)
Get current lookup path.
ecs_set_scope
ecs_entity_t ecs_set_scope(ecs_world_t *world, ecs_entity_t scope)
Set the current scope.
ecs_set_name_prefix
const char * ecs_set_name_prefix(ecs_world_t *world, const char *prefix)
Set a name prefix for newly created entities.
ecs_iter_skip
void ecs_iter_skip(ecs_iter_t *it)
Skip a table while iterating.
ecs_iter_set_group
void ecs_iter_set_group(ecs_iter_t *it, uint64_t group_id)
Set group to iterate for query iterator.
ecs_query_next
bool ecs_query_next(ecs_iter_t *it)
Progress query iterator.
ecs_query_get_group_info
const ecs_query_group_info_t * ecs_query_get_group_info(const ecs_query_t *query, uint64_t group_id)
Get information about query group.
ecs_query_has
bool ecs_query_has(ecs_query_t *query, ecs_entity_t entity, ecs_iter_t *it)
Match entity with query.
ecs_query_is_true
bool ecs_query_is_true(const ecs_query_t *query)
Does query return one or more results.
ecs_term_str
char * ecs_term_str(const ecs_world_t *world, const ecs_term_t *term)
Convert term to string expression.
ecs_query_find_var
int32_t ecs_query_find_var(const ecs_query_t *query, const char *name)
Find variable index.
ecs_query_fini
void ecs_query_fini(ecs_query_t *query)
Delete a query.
ecs_query_plan_w_profile
char * ecs_query_plan_w_profile(const ecs_query_t *query, const ecs_iter_t *it)
Convert query to string with profile.
ecs_query_desc_t
struct ecs_query_desc_t ecs_query_desc_t
Used with ecs_query_init().
ecs_query_args_parse
const char * ecs_query_args_parse(ecs_query_t *query, ecs_iter_t *it, const char *expr)
Populate variables from key-value string.
ecs_query_match_count
int32_t ecs_query_match_count(const ecs_query_t *query)
Returns how often a match event happened for a cached query.
ecs_query_plan
char * ecs_query_plan(const ecs_query_t *query)
Convert query to a string.
ecs_query_iter
ecs_iter_t ecs_query_iter(const ecs_world_t *world, const ecs_query_t *query)
Create a query iterator.
ecs_query_str
char * ecs_query_str(const ecs_query_t *query)
Convert query to string expression.
ecs_query_var_is_entity
bool ecs_query_var_is_entity(const ecs_query_t *query, int32_t var_id)
Test if variable is an entity.
ecs_query_init
ecs_query_t * ecs_query_init(ecs_world_t *world, const ecs_query_desc_t *desc)
Create a query.
ecs_query_changed
bool ecs_query_changed(ecs_query_t *query)
Returns whether the query data changed since the last iteration.
ecs_query_has_range
bool ecs_query_has_range(ecs_query_t *query, ecs_table_range_t *range, ecs_iter_t *it)
Match range with query.
ecs_query_var_name
const char * ecs_query_var_name(const ecs_query_t *query, int32_t var_id)
Get variable name.
ecs_term_match_this
bool ecs_term_match_this(const ecs_term_t *term)
Is term matched on $this variable.
ecs_query_has_table
bool ecs_query_has_table(ecs_query_t *query, ecs_table_t *table, ecs_iter_t *it)
Match table with query.
ecs_query_get_group_ctx
void * ecs_query_get_group_ctx(const ecs_query_t *query, uint64_t group_id)
Get context of query group.
ecs_query_count
ecs_query_count_t ecs_query_count(const ecs_query_t *query)
Returns number of entities and results the query matches with.
ecs_term_ref_is_set
bool ecs_term_ref_is_set(const ecs_term_ref_t *id)
Test whether term id is set.
ecs_term_is_initialized
bool ecs_term_is_initialized(const ecs_term_t *term)
Test whether a term is set.
ecs_query_count_t
struct ecs_query_count_t ecs_query_count_t
Struct returned by ecs_query_count().
ecs_term_match_0
bool ecs_term_match_0(const ecs_term_t *term)
Is term matched on 0 source.
ecs_query_get_cache_query
const ecs_query_t * ecs_query_get_cache_query(const ecs_query_t *query)
Get query used to populate cache.
ecs_term_ref_t
struct ecs_term_ref_t ecs_term_ref_t
Type that describes a reference to an entity or variable in a term.
ecs_query_cache_kind_t
ecs_query_cache_kind_t
Specify cache policy for query.
Definition flecs.h:683
ecs_inout_kind_t
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:662
ecs_oper_kind_t
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:672
EcsQueryCacheAll
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:686
EcsQueryCacheDefault
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:684
EcsQueryCacheNone
@ EcsQueryCacheNone
No caching.
Definition flecs.h:687
EcsQueryCacheAuto
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:685
EcsOut
@ EcsOut
Term is only written.
Definition flecs.h:668
EcsInOut
@ EcsInOut
Term is both read and written.
Definition flecs.h:666
EcsInOutFilter
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:665
EcsInOutDefault
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:663
EcsInOutNone
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:664
EcsIn
@ EcsIn
Term is only read.
Definition flecs.h:667
EcsNot
@ EcsNot
The term must not match.
Definition flecs.h:675
EcsOptional
@ EcsOptional
The term may match.
Definition flecs.h:676
EcsOr
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:674
EcsOrFrom
@ EcsOrFrom
Term must match at least one component from term id.
Definition flecs.h:678
EcsAnd
@ EcsAnd
The term must match.
Definition flecs.h:673
EcsNotFrom
@ EcsNotFrom
Term must match none of the components from term id.
Definition flecs.h:679
EcsAndFrom
@ EcsAndFrom
Term must match all components from term id.
Definition flecs.h:677
ecs_table_add_id
ecs_table_t * ecs_table_add_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t id)
Get table that has all components of current table plus the specified id.
ecs_search
int32_t ecs_search(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id, ecs_id_t *id_out)
Search for component id in table type.
ecs_table_get_type
const ecs_type_t * ecs_table_get_type(const ecs_table_t *table)
Get type for table.
ecs_search_offset
int32_t ecs_search_offset(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t id, ecs_id_t *id_out)
Search for component id in table type starting from an offset.
ecs_table_size
int32_t ecs_table_size(const ecs_table_t *table)
Returns allocated size of table.
ecs_table_has_flags
bool ecs_table_has_flags(ecs_table_t *table, ecs_flags32_t flags)
Test table for flags.
ecs_table_column_to_type_index
int32_t ecs_table_column_to_type_index(const ecs_table_t *table, int32_t index)
Convert column index to type index.
ecs_table_column_count
int32_t ecs_table_column_count(const ecs_table_t *table)
Return number of columns in table.
ecs_commit
bool ecs_commit(ecs_world_t *world, ecs_entity_t entity, ecs_record_t *record, ecs_table_t *table, const ecs_type_t *added, const ecs_type_t *removed)
Commit (move) entity to a table.
ecs_table_get_column
void * ecs_table_get_column(const ecs_table_t *table, int32_t index, int32_t offset)
Get column from table by column index.
ecs_table_has_id
bool ecs_table_has_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Test if table has id.
ecs_table_remove_id
ecs_table_t * ecs_table_remove_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t id)
Get table that has all components of current table minus the specified id.
ecs_table_count
int32_t ecs_table_count(const ecs_table_t *table)
Returns the number of entities in the table.
ecs_table_entities
const ecs_entity_t * ecs_table_entities(const ecs_table_t *table)
Returns array with entity ids for table.
ecs_table_unlock
void ecs_table_unlock(ecs_world_t *world, ecs_table_t *table)
Unlock a table.
ecs_table_get_depth
int32_t ecs_table_get_depth(const ecs_world_t *world, const ecs_table_t *table, ecs_entity_t rel)
Return depth for table in tree for relationship rel.
ecs_table_get_id
void * ecs_table_get_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id, int32_t offset)
Get column from table by component id.
ecs_table_swap_rows
void ecs_table_swap_rows(ecs_world_t *world, ecs_table_t *table, int32_t row_1, int32_t row_2)
Swaps two elements inside the table.
ecs_table_get_column_index
int32_t ecs_table_get_column_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Get column index for id.
ecs_table_lock
void ecs_table_lock(ecs_world_t *world, ecs_table_t *table)
Lock a table.
ecs_table_find
ecs_table_t * ecs_table_find(ecs_world_t *world, const ecs_id_t *ids, int32_t id_count)
Find table from id array.
ecs_table_get_type_index
int32_t ecs_table_get_type_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Get type index for id.
ecs_table_get_column_size
size_t ecs_table_get_column_size(const ecs_table_t *table, int32_t index)
Get column size from table.
ecs_table_clear_entities
void ecs_table_clear_entities(ecs_world_t *world, ecs_table_t *table)
Remove all entities in a table.
ecs_search_relation
int32_t ecs_search_relation(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t id, ecs_entity_t rel, ecs_flags64_t flags, ecs_entity_t *subject_out, ecs_id_t *id_out, struct ecs_table_record_t **tr_out)
Search for component/relationship id in table type starting from an offset.
ecs_table_type_to_column_index
int32_t ecs_table_type_to_column_index(const ecs_table_t *table, int32_t index)
Convert type index to column index.
ecs_value_fini_w_type_info
int ecs_value_fini_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *ptr)
Destruct a value.
ecs_value_fini
int ecs_value_fini(const ecs_world_t *world, ecs_entity_t type, void *ptr)
Destruct a value.
ecs_value_copy
int ecs_value_copy(const ecs_world_t *world, ecs_entity_t type, void *dst, const void *src)
Copy value.
ecs_value_move
int ecs_value_move(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move value.
ecs_value_move_w_type_info
int ecs_value_move_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, void *src)
Move value.
ecs_value_new_w_type_info
void * ecs_value_new_w_type_info(ecs_world_t *world, const ecs_type_info_t *ti)
Construct a value in new storage.
ecs_value_move_ctor_w_type_info
int ecs_value_move_ctor_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, void *src)
Move construct value.
ecs_value_copy_w_type_info
int ecs_value_copy_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, const void *src)
Copy value.
ecs_value_init_w_type_info
int ecs_value_init_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *ptr)
Construct a value in existing storage.
ecs_value_new
void * ecs_value_new(ecs_world_t *world, ecs_entity_t type)
Construct a value in new storage.
ecs_value_free
int ecs_value_free(ecs_world_t *world, ecs_entity_t type, void *ptr)
Destruct a value, free storage.
ecs_value_move_ctor
int ecs_value_move_ctor(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move construct value.
ecs_value_init
int ecs_value_init(const ecs_world_t *world, ecs_entity_t type, void *ptr)
Construct a value in existing storage.
ecs_entities_t
struct ecs_entities_t ecs_entities_t
Type returned by ecs_get_entities().
ecs_atfini
void ecs_atfini(ecs_world_t *world, ecs_fini_action_t action, void *ctx)
Register action to be executed when world is destroyed.
ecs_is_fini
bool ecs_is_fini(const ecs_world_t *world)
Returns whether the world is being deleted.
ecs_fini
int ecs_fini(ecs_world_t *world)
Delete a world.
ecs_world_get_flags
ecs_flags32_t ecs_world_get_flags(const ecs_world_t *world)
Get flags set on the world.
ecs_mini
ecs_world_t * ecs_mini(void)
Create a new world with just the core module.
ecs_init
ecs_world_t * ecs_init(void)
Create a new world.
ecs_init_w_args
ecs_world_t * ecs_init_w_args(int argc, char *argv[])
Create a new world with arguments.
ecs_get_entities
ecs_entities_t ecs_get_entities(const ecs_world_t *world)
Return entity identifiers in world.
ecs_set_target_fps
void ecs_set_target_fps(ecs_world_t *world, float fps)
Set target frames per second (FPS) for application.
ecs_measure_system_time
void ecs_measure_system_time(ecs_world_t *world, bool enable)
Measure system time.
ecs_frame_begin
float ecs_frame_begin(ecs_world_t *world, float delta_time)
Begin frame.
ecs_run_post_frame
void ecs_run_post_frame(ecs_world_t *world, ecs_fini_action_t action, void *ctx)
Register action to be executed once after frame.
ecs_should_quit
bool ecs_should_quit(const ecs_world_t *world)
Return whether a quit has been requested.
ecs_set_default_query_flags
void ecs_set_default_query_flags(ecs_world_t *world, ecs_flags32_t flags)
Set default query flags.
ecs_quit
void ecs_quit(ecs_world_t *world)
Signal exit This operation signals that the application should quit.
ecs_measure_frame_time
void ecs_measure_frame_time(ecs_world_t *world, bool enable)
Measure frame time.
ecs_frame_end
void ecs_frame_end(ecs_world_t *world)
End frame.
ecs_get_entity
ecs_entity_t ecs_get_entity(const ecs_poly_t *poly)
Get entity from poly.
ecs_make_pair
ecs_id_t ecs_make_pair(ecs_entity_t first, ecs_entity_t second)
Make a pair id.
ecs_get_build_info
const ecs_build_info_t * ecs_get_build_info(void)
Get build info.
flecs_poly_is_
bool flecs_poly_is_(const ecs_poly_t *object, int32_t type)
Test if pointer is of specified type.
ecs_get_max_id
ecs_entity_t ecs_get_max_id(const ecs_world_t *world)
Get the largest issued entity id (not counting generation).
ecs_run_aperiodic
void ecs_run_aperiodic(ecs_world_t *world, ecs_flags32_t flags)
Force aperiodic actions.
ecs_get_binding_ctx
void * ecs_get_binding_ctx(const ecs_world_t *world)
Get the world binding context.
ecs_dim
void ecs_dim(ecs_world_t *world, int32_t entity_count)
Dimension the world for a specified number of entities.
ecs_set_entity_range
void ecs_set_entity_range(ecs_world_t *world, ecs_entity_t id_start, ecs_entity_t id_end)
Set a range for issuing new entity ids.
ecs_get_world_info
const ecs_world_info_t * ecs_get_world_info(const ecs_world_t *world)
Get world info.
ecs_get_world
const ecs_world_t * ecs_get_world(const ecs_poly_t *poly)
Get world from poly.
ecs_set_ctx
void ecs_set_ctx(ecs_world_t *world, void *ctx, ecs_ctx_free_t ctx_free)
Set a world context.
ecs_delete_empty_tables
int32_t ecs_delete_empty_tables(ecs_world_t *world, ecs_id_t id, uint16_t clear_generation, uint16_t delete_generation, int32_t min_id_count, double time_budget_seconds)
Cleanup empty tables.
ecs_set_binding_ctx
void ecs_set_binding_ctx(ecs_world_t *world, void *ctx, ecs_ctx_free_t ctx_free)
Set a world binding context.
ecs_enable_range_check
bool ecs_enable_range_check(ecs_world_t *world, bool enable)
Enable/disable range limits.
ecs_get_ctx
void * ecs_get_ctx(const ecs_world_t *world)
Get the world context.
os_api.h
Operating system abstraction API.
EcsComponent
Component information.
Definition flecs.h:1450
EcsComponent::size
ecs_size_t size
Component size.
Definition flecs.h:1451
EcsComponent::alignment
ecs_size_t alignment
Component alignment.
Definition flecs.h:1452
EcsDefaultChildComponent
When added to an entity this informs serialization formats which component to use when a value is ass...
Definition flecs.h:1465
EcsDefaultChildComponent::component
ecs_id_t component
Default component id.
Definition flecs.h:1466
EcsIdentifier
A (string) identifier.
Definition flecs.h:1441
EcsIdentifier::length
ecs_size_t length
Length of identifier.
Definition flecs.h:1443
EcsIdentifier::value
char * value
Identifier string.
Definition flecs.h:1442
EcsIdentifier::index
ecs_hashmap_t * index
Current index.
Definition flecs.h:1446
EcsIdentifier::hash
uint64_t hash
Hash of current value.
Definition flecs.h:1444
EcsIdentifier::index_hash
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1445
EcsPoly
Component for storing a poly object.
Definition flecs.h:1456
EcsPoly::poly
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1457
EcsRateFilter
Apply a rate filter to a tick source.
Definition timer.h:45
EcsTickSource
Component used to provide a tick source to systems.
Definition system.h:32
EcsTimer
Component used for one shot/interval timer functionality.
Definition timer.h:35
ecs_build_info_t
Type with information about the current Flecs build.
Definition flecs.h:1352
ecs_build_info_t::version_major
int16_t version_major
Major flecs version.
Definition flecs.h:1356
ecs_build_info_t::addons
const char ** addons
Addons included in build.
Definition flecs.h:1354
ecs_build_info_t::version
const char * version
Stringified version.
Definition flecs.h:1355
ecs_build_info_t::compiler
const char * compiler
Compiler used to compile flecs.
Definition flecs.h:1353
ecs_build_info_t::sanitize
bool sanitize
Is this a sanitize build.
Definition flecs.h:1360
ecs_build_info_t::perf_trace
bool perf_trace
Is this a perf tracing build.
Definition flecs.h:1361
ecs_build_info_t::version_minor
int16_t version_minor
Minor flecs version.
Definition flecs.h:1357
ecs_build_info_t::debug
bool debug
Is this a debug build.
Definition flecs.h:1359
ecs_build_info_t::version_patch
int16_t version_patch
Patch flecs version.
Definition flecs.h:1358
ecs_bulk_desc_t
Used with ecs_bulk_init().
Definition flecs.h:984
ecs_bulk_desc_t::data
void ** data
Array with component data to insert.
Definition flecs.h:996
ecs_bulk_desc_t::ids
ecs_id_t ids[(32)]
Ids to create the entities with.
Definition flecs.h:994
ecs_bulk_desc_t::count
int32_t count
Number of entities to create/populate.
Definition flecs.h:992
ecs_bulk_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:985
ecs_bulk_desc_t::entities
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:987
ecs_bulk_desc_t::table
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1003
ecs_component_desc_t
Used with ecs_component_init().
Definition flecs.h:1014
ecs_component_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1015
ecs_component_desc_t::type
ecs_type_info_t type
Parameters for type (size, hooks, ...)
Definition flecs.h:1021
ecs_component_desc_t::entity
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1018
ecs_entities_t
Type returned by ecs_get_entities().
Definition flecs.h:1920
ecs_entities_t::alive_count
int32_t alive_count
Number of alive entity ids.
Definition flecs.h:1923
ecs_entities_t::count
int32_t count
Total number of entity ids.
Definition flecs.h:1922
ecs_entities_t::ids
const ecs_entity_t * ids
Array with all entity ids in the world.
Definition flecs.h:1921
ecs_entity_desc_t
Used with ecs_entity_init().
Definition flecs.h:938
ecs_entity_desc_t::sep
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:950
ecs_entity_desc_t::root_sep
const char * root_sep
Optional, used for identifiers relative to root.
Definition flecs.h:954
ecs_entity_desc_t::name
const char * name
Name of the entity.
Definition flecs.h:945
ecs_entity_desc_t::use_low_id
bool use_low_id
When set to true, a low id (typically reserved for components) will be used to create the entity,...
Definition flecs.h:966
ecs_entity_desc_t::symbol
const char * symbol
Optional entity symbol.
Definition flecs.h:956
ecs_entity_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:939
ecs_entity_desc_t::add
const ecs_id_t * add
0-terminated array of ids to add to the entity.
Definition flecs.h:971
ecs_entity_desc_t::add_expr
const char * add_expr
String expression with components to add.
Definition flecs.h:977
ecs_entity_desc_t::set
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:974
ecs_entity_desc_t::id
ecs_entity_t id
Set to modify existing entity (optional)
Definition flecs.h:941
ecs_entity_desc_t::parent
ecs_entity_t parent
Parent entity.
Definition flecs.h:943
ecs_event_desc_t
Used with ecs_emit().
Definition flecs.h:1298
ecs_event_desc_t::entity
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1323
ecs_event_desc_t::const_param
const void * const_param
Same as param, but with the guarantee that the value won't be modified.
Definition flecs.h:1334
ecs_event_desc_t::table
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1308
ecs_event_desc_t::count
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1320
ecs_event_desc_t::other_table
ecs_table_t * other_table
Optional 2nd table to notify.
Definition flecs.h:1312
ecs_event_desc_t::offset
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1315
ecs_event_desc_t::ids
const ecs_type_t * ids
Component ids.
Definition flecs.h:1305
ecs_event_desc_t::observable
ecs_poly_t * observable
Observable (usually the world)
Definition flecs.h:1337
ecs_event_desc_t::event
ecs_entity_t event
The event id.
Definition flecs.h:1300
ecs_event_desc_t::flags
ecs_flags32_t flags
Event flags.
Definition flecs.h:1340
ecs_event_desc_t::param
void * param
Optional context.
Definition flecs.h:1329
ecs_header_t
Header for ecs_poly_t objects.
Definition flecs.h:486
ecs_header_t::magic
int32_t magic
Magic number verifying it's a flecs object.
Definition flecs.h:487
ecs_header_t::type
int32_t type
Magic number indicating which type of flecs object.
Definition flecs.h:488
ecs_header_t::refcount
int32_t refcount
Refcount, to enable RAII handles.
Definition flecs.h:489
ecs_header_t::mixins
ecs_mixins_t * mixins
Table with offsets to (optional) mixins.
Definition flecs.h:490
ecs_iter_t
Iterator.
Definition flecs.h:1062
ecs_iter_t::real_world
ecs_world_t * real_world
Actual world.
Definition flecs.h:1065
ecs_iter_t::param
void * param
Param passed to ecs_run.
Definition flecs.h:1099
ecs_iter_t::event
ecs_entity_t event
The event (if applicable)
Definition flecs.h:1085
ecs_iter_t::frame_offset
int32_t frame_offset
Offset relative to start of iteration.
Definition flecs.h:1110
ecs_iter_t::variable_names
char ** variable_names
Names of variables (if any)
Definition flecs.h:1096
ecs_iter_t::ref_fields
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1079
ecs_iter_t::variable_count
int8_t variable_count
Number of variables for query.
Definition flecs.h:1094
ecs_iter_t::interrupted_by
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1116
ecs_iter_t::flags
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1115
ecs_iter_t::chain_it
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1123
ecs_iter_t::ctx
void * ctx
System context.
Definition flecs.h:1100
ecs_iter_t::run_ctx
void * run_ctx
Run language binding context.
Definition flecs.h:1103
ecs_iter_t::table
ecs_table_t * table
Current table.
Definition flecs.h:1070
ecs_iter_t::offset
int32_t offset
Offset relative to current table.
Definition flecs.h:1111
ecs_iter_t::event_id
ecs_id_t event_id
The (component) id for the event.
Definition flecs.h:1086
ecs_iter_t::fini
ecs_iter_fini_action_t fini
Function to cleanup iterator resources.
Definition flecs.h:1122
ecs_iter_t::variables
ecs_var_t * variables
Values of variables (if any)
Definition flecs.h:1073
ecs_iter_t::priv_
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1117
ecs_iter_t::world
ecs_world_t * world
The world.
Definition flecs.h:1064
ecs_iter_t::callback_ctx
void * callback_ctx
Callback language binding context.
Definition flecs.h:1102
ecs_iter_t::sources
ecs_entity_t * sources
Entity on which the id was matched (0 if same as entities)
Definition flecs.h:1075
ecs_iter_t::binding_ctx
void * binding_ctx
System binding context.
Definition flecs.h:1101
ecs_iter_t::row_fields
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1080
ecs_iter_t::delta_system_time
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1107
ecs_iter_t::query
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1095
ecs_iter_t::term_index
int8_t term_index
Index of term that emitted an event.
Definition flecs.h:1091
ecs_iter_t::system
ecs_entity_t system
The system (if applicable)
Definition flecs.h:1084
ecs_iter_t::set_fields
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1078
ecs_iter_t::sizes
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1069
ecs_iter_t::delta_time
float delta_time
Time elapsed since last frame.
Definition flecs.h:1106
ecs_iter_t::up_fields
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1081
ecs_iter_t::callback
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1121
ecs_iter_t::field_count
int8_t field_count
Number of fields in iterator.
Definition flecs.h:1090
ecs_iter_t::other_table
ecs_table_t * other_table
Prev or next table when adding/removing.
Definition flecs.h:1071
ecs_iter_t::event_cur
int32_t event_cur
Unique event id.
Definition flecs.h:1087
ecs_iter_t::trs
const ecs_table_record_t ** trs
Info on where to find field in table.
Definition flecs.h:1074
ecs_iter_t::count
int32_t count
Number of entities to iterate.
Definition flecs.h:1112
ecs_iter_t::group_id
uint64_t group_id
Group id for table, if group_by is used.
Definition flecs.h:1077
ecs_iter_t::next
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1120
ecs_iter_t::entities
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1068
ecs_iter_t::ids
ecs_id_t * ids
(Component) ids
Definition flecs.h:1072
ecs_iter_t::constrained_vars
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1076
ecs_observer_desc_t
Used with ecs_observer_init().
Definition flecs.h:1236
ecs_observer_desc_t::run_ctx_free
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1280
ecs_observer_desc_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1268
ecs_observer_desc_t::run_ctx
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1277
ecs_observer_desc_t::entity
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1241
ecs_observer_desc_t::events
ecs_entity_t events[(8)]
Events to observe (OnAdd, OnRemove, OnSet)
Definition flecs.h:1247
ecs_observer_desc_t::last_event_id
int32_t * last_event_id
Optional shared last event id for multiple observers.
Definition flecs.h:1287
ecs_observer_desc_t::callback_ctx
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1271
ecs_observer_desc_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:1265
ecs_observer_desc_t::query
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1244
ecs_observer_desc_t::observable
ecs_poly_t * observable
Observable with which to register the observer.
Definition flecs.h:1283
ecs_observer_desc_t::callback_ctx_free
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1274
ecs_observer_desc_t::term_index_
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1290
ecs_observer_desc_t::callback
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1254
ecs_observer_desc_t::yield_existing
bool yield_existing
When observer is created, generate events from existing data.
Definition flecs.h:1251
ecs_observer_desc_t::run
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1262
ecs_observer_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1238
ecs_observer_t
An observer reacts to events matching a query.
Definition flecs.h:832
ecs_observer_t::event_count
int32_t event_count
Number of events.
Definition flecs.h:839
ecs_observer_t::callback
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:841
ecs_observer_t::entity
ecs_entity_t entity
Entity associated with observer.
Definition flecs.h:855
ecs_observer_t::observable
ecs_observable_t * observable
Observable for observer.
Definition flecs.h:852
ecs_observer_t::run
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:842
ecs_observer_t::hdr
ecs_header_t hdr
Object header.
Definition flecs.h:833
ecs_observer_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:848
ecs_observer_t::run_ctx
void * run_ctx
Run language binding context.
Definition flecs.h:846
ecs_observer_t::world
ecs_world_t * world
The world.
Definition flecs.h:854
ecs_observer_t::run_ctx_free
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:850
ecs_observer_t::callback_ctx
void * callback_ctx
Callback language binding context.
Definition flecs.h:845
ecs_observer_t::ctx
void * ctx
Observer context.
Definition flecs.h:844
ecs_observer_t::events
ecs_entity_t events[(8)]
Observer events.
Definition flecs.h:838
ecs_observer_t::callback_ctx_free
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:849
ecs_observer_t::query
ecs_query_t * query
Observer query.
Definition flecs.h:835
ecs_query_count_t
Struct returned by ecs_query_count().
Definition flecs.h:4929
ecs_query_count_t::empty_tables
int32_t empty_tables
Number of empty tables returned by query.
Definition flecs.h:4933
ecs_query_count_t::entities
int32_t entities
Number of entities returned by query.
Definition flecs.h:4931
ecs_query_count_t::results
int32_t results
Number of results returned by query.
Definition flecs.h:4930
ecs_query_count_t::tables
int32_t tables
Number of tables returned by query.
Definition flecs.h:4932
ecs_query_desc_t
Used with ecs_query_init().
Definition flecs.h:1162
ecs_query_desc_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1223
ecs_query_desc_t::group_by
ecs_id_t group_by
Component id to be used for grouping.
Definition flecs.h:1193
ecs_query_desc_t::terms
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1167
ecs_query_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1164
ecs_query_desc_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:1217
ecs_query_desc_t::group_by_ctx_free
ecs_ctx_free_t group_by_ctx_free
Function to free group_by_ctx.
Definition flecs.h:1214
ecs_query_desc_t::group_by_ctx
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1211
ecs_query_desc_t::binding_ctx
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1220
ecs_query_desc_t::order_by
ecs_entity_t order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition flecs.h:1189
ecs_query_desc_t::order_by_callback
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1181
ecs_query_desc_t::on_group_create
ecs_group_create_action_t on_group_create
Callback that is invoked when a new group is created.
Definition flecs.h:1204
ecs_query_desc_t::entity
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:1229
ecs_query_desc_t::binding_ctx_free
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1226
ecs_query_desc_t::group_by_callback
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1200
ecs_query_desc_t::on_group_delete
ecs_group_delete_action_t on_group_delete
Callback that is invoked when an existing group is deleted.
Definition flecs.h:1208
ecs_query_desc_t::order_by_table_callback
ecs_sort_table_action_t order_by_table_callback
Callback used for ordering query results.
Definition flecs.h:1185
ecs_query_desc_t::flags
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1176
ecs_query_desc_t::cache_kind
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:1173
ecs_query_desc_t::expr
const char * expr
Query DSL expression (optional)
Definition flecs.h:1170
ecs_query_group_info_t
Type that contains information about a query group.
Definition flecs.h:1425
ecs_query_group_info_t::table_count
int32_t table_count
Number of tables in group.
Definition flecs.h:1427
ecs_query_group_info_t::ctx
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1428
ecs_query_group_info_t::match_count
int32_t match_count
How often tables have been matched/unmatched.
Definition flecs.h:1426
ecs_query_t
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:792
ecs_query_t::row_fields
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:811
ecs_query_t::data_fields
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:808
ecs_query_t::read_fields
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:810
ecs_query_t::hdr
ecs_header_t hdr
Object header.
Definition flecs.h:793
ecs_query_t::terms
ecs_term_t terms[32]
Query terms.
Definition flecs.h:795
ecs_query_t::var_count
int8_t var_count
Number of query variables.
Definition flecs.h:800
ecs_query_t::fixed_fields
ecs_flags32_t fixed_fields
Fields with a fixed source.
Definition flecs.h:805
ecs_query_t::var_fields
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:806
ecs_query_t::write_fields
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:809
ecs_query_t::sizes
int32_t sizes[32]
Component sizes.
Definition flecs.h:796
ecs_query_t::eval_count
int32_t eval_count
Number of times query is evaluated.
Definition flecs.h:826
ecs_query_t::world
ecs_world_t * world
World or stage query was created with.
Definition flecs.h:824
ecs_query_t::static_id_fields
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:807
ecs_query_t::real_world
ecs_world_t * real_world
Actual world.
Definition flecs.h:823
ecs_query_t::set_fields
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:813
ecs_query_t::entity
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:822
ecs_query_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:819
ecs_query_t::shared_readonly_fields
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:812
ecs_query_t::ids
ecs_id_t ids[32]
Component ids.
Definition flecs.h:797
ecs_query_t::cache_kind
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:815
ecs_query_t::term_count
int8_t term_count
Number of query terms.
Definition flecs.h:801
ecs_query_t::vars
char ** vars
Array with variable names for iterator.
Definition flecs.h:817
ecs_query_t::field_count
int8_t field_count
Number of fields returned by query.
Definition flecs.h:802
ecs_query_t::flags
ecs_flags32_t flags
Query flags.
Definition flecs.h:799
ecs_query_t::binding_ctx
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:820
ecs_record_t
Record for entity index.
Definition flecs.h:494
ecs_record_t::table
ecs_table_t * table
Identifies a type (and table) in world.
Definition flecs.h:496
ecs_record_t::row
uint32_t row
Table row of the entity.
Definition flecs.h:497
ecs_record_t::idr
ecs_id_record_t * idr
Id record to (*, entity) for target entities.
Definition flecs.h:495
ecs_record_t::dense
int32_t dense
Index in dense array of entity index.
Definition flecs.h:498
ecs_table_cache_hdr_t
Header for table cache elements.
Definition flecs.h:502
ecs_table_cache_hdr_t::empty
bool empty
Whether element is in empty list.
Definition flecs.h:506
ecs_table_cache_hdr_t::next
struct ecs_table_cache_hdr_t * next
Next/previous elements for id in table cache.
Definition flecs.h:505
ecs_table_cache_hdr_t::cache
struct ecs_table_cache_t * cache
Table cache of element.
Definition flecs.h:503
ecs_table_cache_hdr_t::table
ecs_table_t * table
Table associated with element.
Definition flecs.h:504
ecs_table_record_t
Metadata describing where a component id is stored in a table.
Definition flecs.h:513
ecs_table_record_t::hdr
ecs_table_cache_hdr_t hdr
Table cache header.
Definition flecs.h:514
ecs_table_record_t::index
int16_t index
First type index where id occurs in table.
Definition flecs.h:515
ecs_table_record_t::column
int16_t column
First column index where id occurs.
Definition flecs.h:517
ecs_table_record_t::count
int16_t count
Number of times id occurs in table.
Definition flecs.h:516
ecs_term_ref_t
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:753
ecs_term_ref_t::name
const char * name
Name.
Definition flecs.h:760
ecs_term_ref_t::id
ecs_entity_t id
Entity id.
Definition flecs.h:754
ecs_term_t
Type that describes a term (single element in a query).
Definition flecs.h:768
ecs_term_t::src
ecs_term_ref_t src
Source of term.
Definition flecs.h:774
ecs_term_t::field_index
int8_t field_index
Index of field for term in iterator.
Definition flecs.h:785
ecs_term_t::id
ecs_id_t id
Component id to be matched by term.
Definition flecs.h:769
ecs_term_t::oper
int16_t oper
Operator of term.
Definition flecs.h:783
ecs_term_t::second
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:776
ecs_term_t::flags_
ecs_flags16_t flags_
Flags that help eval, set by ecs_query_init()
Definition flecs.h:786
ecs_term_t::trav
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:778
ecs_term_t::inout
int16_t inout
Access to contents matched by term.
Definition flecs.h:782
ecs_term_t::first
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:775
ecs_type_hooks_t
Type that contains component lifecycle callbacks.
Definition flecs.h:864
ecs_type_hooks_t::copy_ctor
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:871
ecs_type_hooks_t::lifecycle_ctx
void * lifecycle_ctx
Component lifecycle context (see meta add-on)
Definition flecs.h:904
ecs_type_hooks_t::ctx
void * ctx
User defined context.
Definition flecs.h:902
ecs_type_hooks_t::on_remove
ecs_iter_action_t on_remove
Callback that is invoked when an instance of the component is removed.
Definition flecs.h:900
ecs_type_hooks_t::binding_ctx
void * binding_ctx
Language binding context.
Definition flecs.h:903
ecs_type_hooks_t::move_dtor
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:886
ecs_type_hooks_t::copy
ecs_copy_t copy
copy assignment
Definition flecs.h:867
ecs_type_hooks_t::lifecycle_ctx_free
ecs_ctx_free_t lifecycle_ctx_free
Callback to free lifecycle_ctx.
Definition flecs.h:908
ecs_type_hooks_t::on_set
ecs_iter_action_t on_set
Callback that is invoked when an instance of the component is set.
Definition flecs.h:895
ecs_type_hooks_t::move
ecs_move_t move
move assignment
Definition flecs.h:868
ecs_type_hooks_t::ctor
ecs_xtor_t ctor
ctor
Definition flecs.h:865
ecs_type_hooks_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:906
ecs_type_hooks_t::on_add
ecs_iter_action_t on_add
Callback that is invoked when an instance of a component is added.
Definition flecs.h:890
ecs_type_hooks_t::binding_ctx_free
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:907
ecs_type_hooks_t::move_ctor
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:874
ecs_type_hooks_t::ctor_move_dtor
ecs_move_t ctor_move_dtor
Ctor + move + dtor (or move_ctor + dtor).
Definition flecs.h:880
ecs_type_hooks_t::dtor
ecs_xtor_t dtor
dtor
Definition flecs.h:866
ecs_type_info_t
Type that contains component information (passed to ctors/dtors/...)
Definition flecs.h:916
ecs_type_info_t::alignment
ecs_size_t alignment
Alignment of type.
Definition flecs.h:918
ecs_type_info_t::size
ecs_size_t size
Size of type.
Definition flecs.h:917
ecs_type_info_t::name
const char * name
Type name.
Definition flecs.h:921
ecs_type_info_t::component
ecs_entity_t component
Handle to component (do not set)
Definition flecs.h:920
ecs_type_info_t::hooks
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:919
ecs_type_t
A type is a list of (component) ids.
Definition flecs.h:364
ecs_type_t::array
ecs_id_t * array
Array with ids.
Definition flecs.h:365
ecs_type_t::count
int32_t count
Number of elements in array.
Definition flecs.h:366
ecs_value_t
Utility to hold a value of a dynamic type.
Definition flecs.h:929
ecs_value_t::ptr
void * ptr
Pointer to value.
Definition flecs.h:931
ecs_value_t::type
ecs_entity_t type
Type of value.
Definition flecs.h:930
ecs_world_info_t
Type that contains information about the world.
Definition flecs.h:1365
ecs_world_info_t::delta_time
float delta_time
Time passed to or computed by ecs_progress()
Definition flecs.h:1371
ecs_world_info_t::min_id
ecs_entity_t min_id
First allowed entity id.
Definition flecs.h:1367
ecs_world_info_t::set_count
int64_t set_count
Set commands processed.
Definition flecs.h:1408
ecs_world_info_t::world_time_total
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1379
ecs_world_info_t::tag_id_count
int32_t tag_id_count
Number of tag (no data) ids in the world.
Definition flecs.h:1395
ecs_world_info_t::component_id_count
int32_t component_id_count
Number of component (data) ids in the world.
Definition flecs.h:1396
ecs_world_info_t::pipeline_build_count_total
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1391
ecs_world_info_t::eval_comp_monitors_total
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1384
ecs_world_info_t::table_count
int32_t table_count
Number of tables.
Definition flecs.h:1399
ecs_world_info_t::delta_time_raw
float delta_time_raw
Raw delta time (no time scaling)
Definition flecs.h:1370
ecs_world_info_t::frame_time_total
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1374
ecs_world_info_t::table_create_total
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1389
ecs_world_info_t::observers_ran_frame
int64_t observers_ran_frame
Total number of times observer was invoked.
Definition flecs.h:1393
ecs_world_info_t::system_time_total
float system_time_total
Total time spent in systems.
Definition flecs.h:1375
ecs_world_info_t::id_delete_total
int64_t id_delete_total
Total number of times an id was deleted.
Definition flecs.h:1388
ecs_world_info_t::systems_ran_frame
int64_t systems_ran_frame
Total number of systems ran in last frame.
Definition flecs.h:1392
ecs_world_info_t::merge_time_total
float merge_time_total
Total time spent in merges.
Definition flecs.h:1377
ecs_world_info_t::cmd
struct ecs_world_info_t::@0 cmd
Command statistics.
ecs_world_info_t::discard_count
int64_t discard_count
Commands discarded, happens when entity is no longer alive when running the command.
Definition flecs.h:1411
ecs_world_info_t::clear_count
int64_t clear_count
Clear commands processed.
Definition flecs.h:1407
ecs_world_info_t::last_component_id
ecs_entity_t last_component_id
Last issued component entity id.
Definition flecs.h:1366
ecs_world_info_t::empty_table_count
int32_t empty_table_count
Number of tables without entities.
Definition flecs.h:1400
ecs_world_info_t::frame_count_total
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1382
ecs_world_info_t::max_id
ecs_entity_t max_id
Last allowed entity id.
Definition flecs.h:1368
ecs_world_info_t::merge_count_total
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1383
ecs_world_info_t::other_count
int64_t other_count
Other commands processed.
Definition flecs.h:1413
ecs_world_info_t::batched_command_count
int64_t batched_command_count
Commands batched.
Definition flecs.h:1415
ecs_world_info_t::table_delete_total
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1390
ecs_world_info_t::delete_count
int64_t delete_count
Selete commands processed.
Definition flecs.h:1406
ecs_world_info_t::rematch_count_total
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1385
ecs_world_info_t::id_create_total
int64_t id_create_total
Total number of times a new id was created.
Definition flecs.h:1387
ecs_world_info_t::batched_entity_count
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1414
ecs_world_info_t::time_scale
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1372
ecs_world_info_t::pair_id_count
int32_t pair_id_count
Number of pair ids in the world.
Definition flecs.h:1397
ecs_world_info_t::rematch_time_total
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1378
ecs_world_info_t::ensure_count
int64_t ensure_count
Ensure/emplace commands processed.
Definition flecs.h:1409
ecs_world_info_t::target_fps
float target_fps
Target fps.
Definition flecs.h:1373
ecs_world_info_t::world_time_total_raw
double world_time_total_raw
Time elapsed in simulation (no scaling)
Definition flecs.h:1380
ecs_world_info_t::emit_time_total
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1376
ecs_world_info_t::modified_count
int64_t modified_count
Modified commands processed.
Definition flecs.h:1410
ecs_world_info_t::name_prefix
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1418
ecs_world_info_t::event_count
int64_t event_count
Enqueued custom events.
Definition flecs.h:1412
ecs_world_info_t::add_count
int64_t add_count
Add commands processed.
Definition flecs.h:1404
ecs_world_info_t::remove_count
int64_t remove_count
Remove commands processed.
Definition flecs.h:1405