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
7
8#ifndef FLECS_H
9#define FLECS_H
10
17
25
32
33/* Flecs version macros */
34#define FLECS_VERSION_MAJOR 4
35#define FLECS_VERSION_MINOR 0
36#define FLECS_VERSION_PATCH 4
37
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
115#ifdef FLECS_DEBUG
116#ifndef FLECS_DEBUG_INFO
117#define FLECS_DEBUG_INFO
118#endif
119#endif
120
121/* Tip: if you see weird behavior that you think might be a bug, make sure to
122 * test with the FLECS_DEBUG or FLECS_SANITIZE flags enabled. There's a good
123 * chance that this gives you more information about the issue! */
124
138// #define FLECS_SOFT_ASSERT
139
145// #define FLECS_KEEP_ASSERT
146
153// #define FLECS_DEFAULT_TO_UNCACHED_QUERIES
154
163// #define FLECS_CPP_NO_AUTO_REGISTRATION
164
172// #define FLECS_CPP_NO_ENUM_REFLECTION
173
178// #define FLECS_NO_ALWAYS_INLINE
179
207// #define FLECS_CUSTOM_BUILD
208
209#ifndef FLECS_CUSTOM_BUILD
210#define FLECS_ALERTS
211#define FLECS_APP
212// #define FLECS_C /**< C API convenience macros, always enabled */
213#define FLECS_CPP
214#define FLECS_DOC
215// #define FLECS_JOURNAL /**< Journaling addon */
216#define FLECS_JSON
217#define FLECS_HTTP
218#define FLECS_LOG
219#define FLECS_META
220#define FLECS_METRICS
221#define FLECS_MODULE
222#define FLECS_OS_API_IMPL
223// #define FLECS_PERF_TRACE /**< Enable performance tracing */
224#define FLECS_PIPELINE
225#define FLECS_REST
226#define FLECS_PARSER
227#define FLECS_QUERY_DSL
228#define FLECS_SCRIPT
229// #define FLECS_SCRIPT_MATH /**< Math functions for flecs script (may require linking with libm) */
230#define FLECS_SYSTEM
231#define FLECS_STATS
232#define FLECS_TIMER
233#define FLECS_UNITS
234#endif // ifndef FLECS_CUSTOM_BUILD
235
239// #define FLECS_LOW_FOOTPRINT
240#ifdef FLECS_LOW_FOOTPRINT
241#define FLECS_HI_COMPONENT_ID (16)
242#define FLECS_HI_ID_RECORD_ID (16)
243#define FLECS_SPARSE_PAGE_BITS (4)
244#define FLECS_ENTITY_PAGE_BITS (6)
245#define FLECS_USE_OS_ALLOC
246#endif
247
258#ifndef FLECS_HI_COMPONENT_ID
259#define FLECS_HI_COMPONENT_ID (256)
260#endif
261
268#ifndef FLECS_HI_ID_RECORD_ID
269#define FLECS_HI_ID_RECORD_ID (1024)
270#endif
271
277#ifndef FLECS_SPARSE_PAGE_BITS
278#define FLECS_SPARSE_PAGE_BITS (6)
279#endif
280
283#ifndef FLECS_ENTITY_PAGE_BITS
284#define FLECS_ENTITY_PAGE_BITS (12)
285#endif
286
291// #define FLECS_USE_OS_ALLOC
292
295#ifndef FLECS_ID_DESC_MAX
296#define FLECS_ID_DESC_MAX (32)
297#endif
298
301#ifndef FLECS_EVENT_DESC_MAX
302#define FLECS_EVENT_DESC_MAX (8)
303#endif
304
307#define FLECS_VARIABLE_COUNT_MAX (64)
308
311#ifndef FLECS_TERM_COUNT_MAX
312#define FLECS_TERM_COUNT_MAX 32
313#endif
314
317#ifndef FLECS_TERM_ARG_COUNT_MAX
318#define FLECS_TERM_ARG_COUNT_MAX (16)
319#endif
320
323#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
324#define FLECS_QUERY_VARIABLE_COUNT_MAX (64)
325#endif
326
329#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
330#define FLECS_QUERY_SCOPE_NESTING_MAX (8)
331#endif
332
337#ifndef FLECS_DAG_DEPTH_MAX
338#define FLECS_DAG_DEPTH_MAX (128)
339#endif
340
342
343#include "flecs/private/api_defines.h"
344#include "flecs/datastructures/vec.h" /* Vector datatype */
345#include "flecs/datastructures/sparse.h" /* Sparse set */
346#include "flecs/datastructures/block_allocator.h" /* Block allocator */
347#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
348#include "flecs/datastructures/map.h" /* Map */
349#include "flecs/datastructures/switch_list.h" /* Switch list */
350#include "flecs/datastructures/allocator.h" /* Allocator */
351#include "flecs/datastructures/strbuf.h" /* String builder */
352#include "flecs/os_api.h" /* Abstraction for operating system functions */
353
354#ifdef __cplusplus
355extern "C" {
356#endif
357
364
371
374 typedef uint64_t ecs_id_t;
375
381 typedef ecs_id_t ecs_entity_t;
382
398 typedef struct {
399 ecs_id_t *array;
400 int32_t count;
401} ecs_type_t;
402
425 typedef struct ecs_world_t ecs_world_t;
426
428 typedef struct ecs_stage_t ecs_stage_t;
429
431 typedef struct ecs_table_t ecs_table_t;
432
434 typedef struct ecs_term_t ecs_term_t;
435
437 typedef struct ecs_query_t ecs_query_t;
438
456 typedef struct ecs_observer_t ecs_observer_t;
457
461 typedef struct ecs_observable_t ecs_observable_t;
462
467 typedef struct ecs_iter_t ecs_iter_t;
468
477 typedef struct ecs_ref_t ecs_ref_t;
478
482 typedef struct ecs_type_hooks_t ecs_type_hooks_t;
483
487 typedef struct ecs_type_info_t ecs_type_info_t;
488
490 typedef struct ecs_record_t ecs_record_t;
491
493 typedef struct ecs_component_record_t ecs_component_record_t;
494
514 typedef void ecs_poly_t;
515
517 typedef struct ecs_mixins_t ecs_mixins_t;
518
520 typedef struct ecs_header_t {
521 int32_t magic;
522 int32_t type;
523 int32_t refcount;
524 ecs_mixins_t *mixins;
525} ecs_header_t;
526
527typedef struct ecs_table_record_t ecs_table_record_t;
528
530
537
547 typedef void (*ecs_run_action_t)(
548 ecs_iter_t *it);
549
556 typedef void (*ecs_iter_action_t)(
557 ecs_iter_t *it);
558
566 typedef bool (*ecs_iter_next_action_t)(
567 ecs_iter_t *it);
568
574 typedef void (*ecs_iter_fini_action_t)(
575 ecs_iter_t *it);
576
578 typedef int (*ecs_order_by_action_t)(
579 ecs_entity_t e1,
580 const void *ptr1,
581 ecs_entity_t e2,
582 const void *ptr2);
583
585 typedef void (*ecs_sort_table_action_t)(
586 ecs_world_t* world,
587 ecs_table_t* table,
588 ecs_entity_t* entities,
589 void* ptr,
590 int32_t size,
591 int32_t lo,
592 int32_t hi,
593 ecs_order_by_action_t order_by);
594
596 typedef uint64_t (*ecs_group_by_action_t)(
597 ecs_world_t *world,
598 ecs_table_t *table,
599 ecs_id_t group_id,
600 void *ctx);
601
603 typedef void* (*ecs_group_create_action_t)(
604 ecs_world_t *world,
605 uint64_t group_id,
606 void *group_by_ctx); /* from ecs_query_desc_t */
607
609 typedef void (*ecs_group_delete_action_t)(
610 ecs_world_t *world,
611 uint64_t group_id,
612 void *group_ctx, /* return value from ecs_group_create_action_t */
613 void *group_by_ctx); /* from ecs_query_desc_t */
614
616 typedef void (*ecs_module_action_t)(
617 ecs_world_t *world);
618
620 typedef void (*ecs_fini_action_t)(
621 ecs_world_t *world,
622 void *ctx);
623
625 typedef void (*ecs_ctx_free_t)(
626 void *ctx);
627
629 typedef int (*ecs_compare_action_t)(
630 const void *ptr1,
631 const void *ptr2);
632
634 typedef uint64_t (*ecs_hash_value_action_t)(
635 const void *ptr);
636
638 typedef void (*ecs_xtor_t)(
639 void *ptr,
640 int32_t count,
641 const ecs_type_info_t *type_info);
642
644 typedef void (*ecs_copy_t)(
645 void *dst_ptr,
646 const void *src_ptr,
647 int32_t count,
648 const ecs_type_info_t *type_info);
649
651 typedef void (*ecs_move_t)(
652 void *dst_ptr,
653 void *src_ptr,
654 int32_t count,
655 const ecs_type_info_t *type_info);
656
658 typedef int (*ecs_cmp_t)(
659 const void *a_ptr,
660 const void *b_ptr,
661 const ecs_type_info_t *type_info);
662
664 typedef bool (*ecs_equals_t)(
665 const void *a_ptr,
666 const void *b_ptr,
667 const ecs_type_info_t *type_info);
668
670 typedef void (*flecs_poly_dtor_t)(
671 ecs_poly_t *poly);
672
674
681
683 typedef enum ecs_inout_kind_t {
684 EcsInOutDefault,
685 EcsInOutNone,
686 EcsInOutFilter,
687 EcsInOut,
688 EcsIn,
689 EcsOut,
690} ecs_inout_kind_t;
691
693 typedef enum ecs_oper_kind_t {
694 EcsAnd,
695 EcsOr,
696 EcsNot,
697 EcsOptional,
698 EcsAndFrom,
699 EcsOrFrom,
700 EcsNotFrom,
701} ecs_oper_kind_t;
702
704 typedef enum ecs_query_cache_kind_t {
705 EcsQueryCacheDefault,
706 EcsQueryCacheAuto,
707 EcsQueryCacheAll,
708 EcsQueryCacheNone,
709} ecs_query_cache_kind_t;
710
711/* Term id flags */
712
717#define EcsSelf (1llu << 63)
718
723#define EcsUp (1llu << 62)
724
729#define EcsTrav (1llu << 61)
730
735#define EcsCascade (1llu << 60)
736
741#define EcsDesc (1llu << 59)
742
747#define EcsIsVariable (1llu << 58)
748
753#define EcsIsEntity (1llu << 57)
754
759#define EcsIsName (1llu << 56)
760
765#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
766
771#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
772
774 typedef struct ecs_term_ref_t {
775 ecs_entity_t id;
780
781 const char *name;
786} ecs_term_ref_t;
787
789 struct ecs_term_t {
790 ecs_id_t id;
794
795 ecs_term_ref_t src;
796 ecs_term_ref_t first;
797 ecs_term_ref_t second;
798
799 ecs_entity_t trav;
802
803 int16_t inout;
804 int16_t oper;
805
806 int8_t field_index;
807 ecs_flags16_t flags_;
808};
809
813 struct ecs_query_t {
814 ecs_header_t hdr;
815
816 ecs_term_t terms[FLECS_TERM_COUNT_MAX];
817 int32_t sizes[FLECS_TERM_COUNT_MAX];
818 ecs_id_t ids[FLECS_TERM_COUNT_MAX];
819
820 ecs_flags32_t flags;
821 int8_t var_count;
822 int8_t term_count;
823 int8_t field_count;
824
825 /* Bitmasks for quick field information lookups */
826 ecs_termset_t fixed_fields;
827 ecs_termset_t var_fields;
828 ecs_termset_t static_id_fields;
829 ecs_termset_t data_fields;
830 ecs_termset_t write_fields;
831 ecs_termset_t read_fields;
832 ecs_termset_t row_fields;
833 ecs_termset_t shared_readonly_fields;
834 ecs_termset_t set_fields;
835
836 ecs_query_cache_kind_t cache_kind;
837
838 char **vars;
839
840 void *ctx;
841 void *binding_ctx;
842
843 ecs_entity_t entity;
844 ecs_world_t *real_world;
845 ecs_world_t *world;
846
847 int32_t eval_count;
848};
849
853 struct ecs_observer_t {
854 ecs_header_t hdr;
855
856 ecs_query_t *query;
857
859 ecs_entity_t events[FLECS_EVENT_DESC_MAX];
860 int32_t event_count;
861
862 ecs_iter_action_t callback;
863 ecs_run_action_t run;
864
865 void *ctx;
866 void *callback_ctx;
867 void *run_ctx;
868
869 ecs_ctx_free_t ctx_free;
870 ecs_ctx_free_t callback_ctx_free;
871 ecs_ctx_free_t run_ctx_free;
872
873 ecs_observable_t *observable;
874
875 ecs_world_t *world;
876 ecs_entity_t entity;
877};
878
880
885
886/* Flags that can be used to check which hooks a type has set */
887#define ECS_TYPE_HOOK_CTOR ECS_CAST(ecs_flags32_t, 1 << 0)
888#define ECS_TYPE_HOOK_DTOR ECS_CAST(ecs_flags32_t, 1 << 1)
889#define ECS_TYPE_HOOK_COPY ECS_CAST(ecs_flags32_t, 1 << 2)
890#define ECS_TYPE_HOOK_MOVE ECS_CAST(ecs_flags32_t, 1 << 3)
891#define ECS_TYPE_HOOK_COPY_CTOR ECS_CAST(ecs_flags32_t, 1 << 4)
892#define ECS_TYPE_HOOK_MOVE_CTOR ECS_CAST(ecs_flags32_t, 1 << 5)
893#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 6)
894#define ECS_TYPE_HOOK_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 7)
895#define ECS_TYPE_HOOK_CMP ECS_CAST(ecs_flags32_t, 1 << 8)
896#define ECS_TYPE_HOOK_EQUALS ECS_CAST(ecs_flags32_t, 1 << 9)
897
898
899/* Flags that can be used to set/check which hooks of a type are invalid */
900#define ECS_TYPE_HOOK_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 10)
901#define ECS_TYPE_HOOK_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 12)
902#define ECS_TYPE_HOOK_COPY_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 13)
903#define ECS_TYPE_HOOK_MOVE_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 14)
904#define ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 15)
905#define ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 16)
906#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 17)
907#define ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 18)
908#define ECS_TYPE_HOOK_CMP_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 19)
909#define ECS_TYPE_HOOK_EQUALS_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 20)
910
911
912/* All valid hook flags */
913#define ECS_TYPE_HOOKS (ECS_TYPE_HOOK_CTOR|ECS_TYPE_HOOK_DTOR|\
914 ECS_TYPE_HOOK_COPY|ECS_TYPE_HOOK_MOVE|ECS_TYPE_HOOK_COPY_CTOR|\
915 ECS_TYPE_HOOK_MOVE_CTOR|ECS_TYPE_HOOK_CTOR_MOVE_DTOR|\
916 ECS_TYPE_HOOK_MOVE_DTOR|ECS_TYPE_HOOK_CMP|ECS_TYPE_HOOK_EQUALS)
917
918/* All invalid hook flags */
919#define ECS_TYPE_HOOKS_ILLEGAL (ECS_TYPE_HOOK_CTOR_ILLEGAL|\
920 ECS_TYPE_HOOK_DTOR_ILLEGAL|ECS_TYPE_HOOK_COPY_ILLEGAL|\
921 ECS_TYPE_HOOK_MOVE_ILLEGAL|ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL|\
922 ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL|ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL|\
923 ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL|ECS_TYPE_HOOK_CMP_ILLEGAL|\
924 ECS_TYPE_HOOK_EQUALS_ILLEGAL)
925 struct ecs_type_hooks_t {
926 ecs_xtor_t ctor;
927 ecs_xtor_t dtor;
928 ecs_copy_t copy;
929 ecs_move_t move;
930
932 ecs_copy_t copy_ctor;
933
935 ecs_move_t move_ctor;
936
941 ecs_move_t ctor_move_dtor;
942
947 ecs_move_t move_dtor;
948
950 ecs_cmp_t cmp;
951
953 ecs_equals_t equals;
954
959 ecs_flags32_t flags;
960
961
964 ecs_iter_action_t on_add;
965
969 ecs_iter_action_t on_set;
970
974 ecs_iter_action_t on_remove;
975
976 void *ctx;
977 void *binding_ctx;
978 void *lifecycle_ctx;
979
980 ecs_ctx_free_t ctx_free;
981 ecs_ctx_free_t binding_ctx_free;
982 ecs_ctx_free_t lifecycle_ctx_free;
983};
984
989 struct ecs_type_info_t {
990 ecs_size_t size;
991 ecs_size_t alignment;
992 ecs_type_hooks_t hooks;
993 ecs_entity_t component;
994 const char *name;
995};
996
997#include "flecs/private/api_types.h" /* Supporting API types */
998#include "flecs/private/api_support.h" /* Supporting API functions */
999#include "flecs/datastructures/hashmap.h" /* Hashmap */
1000#include "flecs/private/api_internals.h" /* Supporting API functions */
1001
1003 typedef struct ecs_value_t {
1004 ecs_entity_t type;
1005 void *ptr;
1006} ecs_value_t;
1007
1012 typedef struct ecs_entity_desc_t {
1013 int32_t _canary;
1014
1015 ecs_entity_t id;
1016
1017 ecs_entity_t parent;
1018
1019 const char *name;
1023
1024 const char *sep;
1027
1028 const char *root_sep;
1029
1030 const char *symbol;
1039
1040 bool use_low_id;
1043
1045 const ecs_id_t *add;
1046
1048 const ecs_value_t *set;
1049
1051 const char *add_expr;
1052} ecs_entity_desc_t;
1053
1058 typedef struct ecs_bulk_desc_t {
1059 int32_t _canary;
1060
1061 ecs_entity_t *entities;
1065
1066 int32_t count;
1067
1068 ecs_id_t ids[FLECS_ID_DESC_MAX];
1069
1070 void **data;
1076
1077 ecs_table_t *table;
1081
1082} ecs_bulk_desc_t;
1083
1088 typedef struct ecs_component_desc_t {
1089 int32_t _canary;
1090
1092 ecs_entity_t entity;
1093
1095 ecs_type_info_t type;
1096} ecs_component_desc_t;
1097
1136 struct ecs_iter_t {
1137 /* World */
1138 ecs_world_t *world;
1139 ecs_world_t *real_world;
1140
1141 /* Matched data */
1142 const ecs_entity_t *entities;
1143 const ecs_size_t *sizes;
1144 ecs_table_t *table;
1145 ecs_table_t *other_table;
1146 ecs_id_t *ids;
1147 ecs_var_t *variables;
1148 const ecs_table_record_t **trs;
1149 ecs_entity_t *sources;
1150 ecs_flags64_t constrained_vars;
1151 uint64_t group_id;
1152 ecs_termset_t set_fields;
1153 ecs_termset_t ref_fields;
1154 ecs_termset_t row_fields;
1155 ecs_termset_t up_fields;
1156
1157 /* Input information */
1158 ecs_entity_t system;
1159 ecs_entity_t event;
1160 ecs_id_t event_id;
1161 int32_t event_cur;
1162
1163 /* Query information */
1164 int8_t field_count;
1165 int8_t term_index;
1168 int8_t variable_count;
1169 const ecs_query_t *query;
1170 char **variable_names;
1171
1172 /* Context */
1173 void *param;
1174 void *ctx;
1175 void *binding_ctx;
1176 void *callback_ctx;
1177 void *run_ctx;
1178
1179 /* Time */
1180 ecs_ftime_t delta_time;
1181 ecs_ftime_t delta_system_time;
1182
1183 /* Iterator counters */
1184 int32_t frame_offset;
1185 int32_t offset;
1186 int32_t count;
1187
1188 /* Misc */
1189 ecs_flags32_t flags;
1190 ecs_entity_t interrupted_by;
1191 ecs_iter_private_t priv_;
1192
1193 /* Chained iterators */
1194 ecs_iter_next_action_t next;
1195 ecs_iter_action_t callback;
1196 ecs_iter_fini_action_t fini;
1197 ecs_iter_t *chain_it;
1198};
1199
1200
1205#define EcsQueryMatchPrefab (1u << 1u)
1206
1211#define EcsQueryMatchDisabled (1u << 2u)
1212
1217#define EcsQueryMatchEmptyTables (1u << 3u)
1218
1223#define EcsQueryAllowUnresolvedByName (1u << 6u)
1224
1229#define EcsQueryTableOnly (1u << 7u)
1230
1231
1236 typedef struct ecs_query_desc_t {
1238 int32_t _canary;
1239
1241 ecs_term_t terms[FLECS_TERM_COUNT_MAX];
1242
1244 const char *expr;
1245
1247 ecs_query_cache_kind_t cache_kind;
1248
1250 ecs_flags32_t flags;
1251
1255 ecs_order_by_action_t order_by_callback;
1256
1259 ecs_sort_table_action_t order_by_table_callback;
1260
1263 ecs_entity_t order_by;
1264
1267 ecs_id_t group_by;
1268
1274 ecs_group_by_action_t group_by_callback;
1275
1278 ecs_group_create_action_t on_group_create;
1279
1282 ecs_group_delete_action_t on_group_delete;
1283
1285 void *group_by_ctx;
1286
1288 ecs_ctx_free_t group_by_ctx_free;
1289
1291 void *ctx;
1292
1294 void *binding_ctx;
1295
1297 ecs_ctx_free_t ctx_free;
1298
1300 ecs_ctx_free_t binding_ctx_free;
1301
1303 ecs_entity_t entity;
1304} ecs_query_desc_t;
1305
1310 typedef struct ecs_observer_desc_t {
1312 int32_t _canary;
1313
1315 ecs_entity_t entity;
1316
1318 ecs_query_desc_t query;
1319
1321 ecs_entity_t events[FLECS_EVENT_DESC_MAX];
1322
1325 bool yield_existing;
1326
1328 ecs_iter_action_t callback;
1329
1336 ecs_run_action_t run;
1337
1339 void *ctx;
1340
1342 ecs_ctx_free_t ctx_free;
1343
1345 void *callback_ctx;
1346
1348 ecs_ctx_free_t callback_ctx_free;
1349
1351 void *run_ctx;
1352
1354 ecs_ctx_free_t run_ctx_free;
1355
1357 ecs_poly_t *observable;
1358
1361 int32_t *last_event_id;
1362
1364 int8_t term_index_;
1365 ecs_flags32_t flags_;
1366} ecs_observer_desc_t;
1367
1372 typedef struct ecs_event_desc_t {
1374 ecs_entity_t event;
1375
1379 const ecs_type_t *ids;
1380
1382 ecs_table_t *table;
1383
1386 ecs_table_t *other_table;
1387
1389 int32_t offset;
1390
1394 int32_t count;
1395
1397 ecs_entity_t entity;
1398
1403 void *param;
1404
1408 const void *const_param;
1409
1411 ecs_poly_t *observable;
1412
1414 ecs_flags32_t flags;
1415} ecs_event_desc_t;
1416
1417
1424
1426 typedef struct ecs_build_info_t {
1427 const char *compiler;
1428 const char **addons;
1429 const char *version;
1430 int16_t version_major;
1431 int16_t version_minor;
1432 int16_t version_patch;
1433 bool debug;
1434 bool sanitize;
1435 bool perf_trace;
1436} ecs_build_info_t;
1437
1439 typedef struct ecs_world_info_t {
1440 ecs_entity_t last_component_id;
1441 ecs_entity_t min_id;
1442 ecs_entity_t max_id;
1443
1444 ecs_ftime_t delta_time_raw;
1445 ecs_ftime_t delta_time;
1446 ecs_ftime_t time_scale;
1447 ecs_ftime_t target_fps;
1448 ecs_ftime_t frame_time_total;
1449 ecs_ftime_t system_time_total;
1450 ecs_ftime_t emit_time_total;
1451 ecs_ftime_t merge_time_total;
1452 ecs_ftime_t rematch_time_total;
1453 double world_time_total;
1454 double world_time_total_raw;
1455
1456 int64_t frame_count_total;
1457 int64_t merge_count_total;
1458 int64_t eval_comp_monitors_total;
1459 int64_t rematch_count_total;
1460
1461 int64_t id_create_total;
1462 int64_t id_delete_total;
1463 int64_t table_create_total;
1464 int64_t table_delete_total;
1465 int64_t pipeline_build_count_total;
1466 int64_t systems_ran_frame;
1467 int64_t observers_ran_frame;
1468
1469 int32_t tag_id_count;
1470 int32_t component_id_count;
1471 int32_t pair_id_count;
1472
1473 int32_t table_count;
1474
1475 /* -- Command counts -- */
1476 struct {
1477 int64_t add_count;
1478 int64_t remove_count;
1479 int64_t delete_count;
1480 int64_t clear_count;
1481 int64_t set_count;
1482 int64_t ensure_count;
1483 int64_t modified_count;
1484 int64_t discard_count;
1485 int64_t event_count;
1486 int64_t other_count;
1487 int64_t batched_entity_count;
1488 int64_t batched_command_count;
1489 } cmd;
1490
1491 const char *name_prefix;
1495} ecs_world_info_t;
1496
1498 typedef struct ecs_query_group_info_t {
1499 int32_t match_count;
1500 int32_t table_count;
1501 void *ctx;
1502} ecs_query_group_info_t;
1503
1505
1512
1514 typedef struct EcsIdentifier {
1515 char *value;
1516 ecs_size_t length;
1517 uint64_t hash;
1518 uint64_t index_hash;
1519 ecs_hashmap_t *index;
1520} EcsIdentifier;
1521
1523 typedef struct EcsComponent {
1524 ecs_size_t size;
1525 ecs_size_t alignment;
1526} EcsComponent;
1527
1529 typedef struct EcsPoly {
1530 ecs_poly_t *poly;
1531} EcsPoly;
1532
1538 typedef struct EcsDefaultChildComponent {
1539 ecs_id_t component;
1540} EcsDefaultChildComponent;
1541
1544
1545/* Only include deprecated definitions if deprecated addon is required */
1546#ifdef FLECS_DEPRECATED
1547#include "flecs/addons/deprecated.h"
1548#endif
1549
1556
1563
1565FLECS_API extern const ecs_id_t ECS_PAIR;
1566
1568FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1569
1571FLECS_API extern const ecs_id_t ECS_TOGGLE;
1572
1574
1579
1580/* Builtin component ids */
1581
1583FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1584
1586FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1587
1589FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1590
1592FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1593
1595FLECS_API extern const ecs_entity_t EcsQuery;
1596
1598FLECS_API extern const ecs_entity_t EcsObserver;
1599
1601FLECS_API extern const ecs_entity_t EcsSystem;
1602
1604FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1605
1607FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1608
1610FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1611
1613FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1614
1616FLECS_API extern const ecs_entity_t EcsFlecs;
1617
1619FLECS_API extern const ecs_entity_t EcsFlecsCore;
1620
1622FLECS_API extern const ecs_entity_t EcsWorld;
1623
1625FLECS_API extern const ecs_entity_t EcsWildcard;
1626
1628FLECS_API extern const ecs_entity_t EcsAny;
1629
1631FLECS_API extern const ecs_entity_t EcsThis;
1632
1634FLECS_API extern const ecs_entity_t EcsVariable;
1635
1637#define EcsSingleton EcsVariable
1638
1646FLECS_API extern const ecs_entity_t EcsTransitive;
1647
1655FLECS_API extern const ecs_entity_t EcsReflexive;
1656
1667FLECS_API extern const ecs_entity_t EcsFinal;
1668
1674FLECS_API extern const ecs_entity_t EcsInheritable;
1675
1677FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1678
1682FLECS_API extern const ecs_entity_t EcsOverride;
1683
1687FLECS_API extern const ecs_entity_t EcsInherit;
1688
1693FLECS_API extern const ecs_entity_t EcsDontInherit;
1694
1702FLECS_API extern const ecs_entity_t EcsSymmetric;
1703
1713FLECS_API extern const ecs_entity_t EcsExclusive;
1714
1716FLECS_API extern const ecs_entity_t EcsAcyclic;
1717
1720FLECS_API extern const ecs_entity_t EcsTraversable;
1721
1731FLECS_API extern const ecs_entity_t EcsWith;
1732
1742FLECS_API extern const ecs_entity_t EcsOneOf;
1743
1745FLECS_API extern const ecs_entity_t EcsCanToggle;
1746
1750FLECS_API extern const ecs_entity_t EcsTrait;
1751
1761FLECS_API extern const ecs_entity_t EcsRelationship;
1762
1772FLECS_API extern const ecs_entity_t EcsTarget;
1773
1776FLECS_API extern const ecs_entity_t EcsPairIsTag;
1777
1779FLECS_API extern const ecs_entity_t EcsName;
1780
1782FLECS_API extern const ecs_entity_t EcsSymbol;
1783
1785FLECS_API extern const ecs_entity_t EcsAlias;
1786
1788FLECS_API extern const ecs_entity_t EcsChildOf;
1789
1791FLECS_API extern const ecs_entity_t EcsIsA;
1792
1794FLECS_API extern const ecs_entity_t EcsDependsOn;
1795
1797FLECS_API extern const ecs_entity_t EcsSlotOf;
1798
1800FLECS_API extern const ecs_entity_t EcsModule;
1801
1803FLECS_API extern const ecs_entity_t EcsPrivate;
1804
1807FLECS_API extern const ecs_entity_t EcsPrefab;
1808
1811FLECS_API extern const ecs_entity_t EcsDisabled;
1812
1816FLECS_API extern const ecs_entity_t EcsNotQueryable;
1817
1819FLECS_API extern const ecs_entity_t EcsOnAdd;
1820
1822FLECS_API extern const ecs_entity_t EcsOnRemove;
1823
1825FLECS_API extern const ecs_entity_t EcsOnSet;
1826
1828FLECS_API extern const ecs_entity_t EcsMonitor;
1829
1831FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1832
1834FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1835
1837FLECS_API extern const ecs_entity_t EcsOnDelete;
1838
1841FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1842
1845FLECS_API extern const ecs_entity_t EcsRemove;
1846
1849FLECS_API extern const ecs_entity_t EcsDelete;
1850
1853FLECS_API extern const ecs_entity_t EcsPanic;
1854
1856FLECS_API extern const ecs_entity_t EcsSparse;
1857
1859FLECS_API extern const ecs_entity_t EcsUnion;
1860
1862FLECS_API extern const ecs_entity_t EcsPredEq;
1863
1865FLECS_API extern const ecs_entity_t EcsPredMatch;
1866
1868FLECS_API extern const ecs_entity_t EcsPredLookup;
1869
1871FLECS_API extern const ecs_entity_t EcsScopeOpen;
1872
1874FLECS_API extern const ecs_entity_t EcsScopeClose;
1875
1880FLECS_API extern const ecs_entity_t EcsEmpty;
1881
1882FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
1883FLECS_API extern const ecs_entity_t EcsOnStart;
1884FLECS_API extern const ecs_entity_t EcsPreFrame;
1885FLECS_API extern const ecs_entity_t EcsOnLoad;
1886FLECS_API extern const ecs_entity_t EcsPostLoad;
1887FLECS_API extern const ecs_entity_t EcsPreUpdate;
1888FLECS_API extern const ecs_entity_t EcsOnUpdate;
1889FLECS_API extern const ecs_entity_t EcsOnValidate;
1890FLECS_API extern const ecs_entity_t EcsPostUpdate;
1891FLECS_API extern const ecs_entity_t EcsPreStore;
1892FLECS_API extern const ecs_entity_t EcsOnStore;
1893FLECS_API extern const ecs_entity_t EcsPostFrame;
1894FLECS_API extern const ecs_entity_t EcsPhase;
1895
1896FLECS_API extern const ecs_entity_t EcsConstant;
1897
1900#define EcsLastInternalComponentId (ecs_id(EcsPoly))
1901
1904#define EcsFirstUserComponentId (8)
1905
1908#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
1909
1910/* When visualized the reserved id ranges look like this:
1911 * - [1..8]: Builtin components
1912 * - [9..FLECS_HI_COMPONENT_ID]: Low ids reserved for application components
1913 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Builtin entities
1914 */
1915
1918
1925
1930
1937FLECS_API
1938 ecs_world_t* ecs_init(void);
1939
1946FLECS_API
1947 ecs_world_t* ecs_mini(void);
1948
1956FLECS_API
1957 ecs_world_t* ecs_init_w_args(
1958 int argc,
1959 char *argv[]);
1960
1967FLECS_API
1968 int ecs_fini(
1969 ecs_world_t *world);
1970
1978FLECS_API
1979 bool ecs_is_fini(
1980 const ecs_world_t *world);
1981
1989FLECS_API
1990 void ecs_atfini(
1991 ecs_world_t *world,
1992 ecs_fini_action_t action,
1993 void *ctx);
1994
1996 typedef struct ecs_entities_t {
1997 const ecs_entity_t *ids;
1998 int32_t count;
1999 int32_t alive_count;
2000} ecs_entities_t;
2001
2028FLECS_API
2029 ecs_entities_t ecs_get_entities(
2030 const ecs_world_t *world);
2031
2039FLECS_API
2040ecs_flags32_t ecs_world_get_flags(
2041 const ecs_world_t *world);
2042
2044
2049
2068FLECS_API
2069 ecs_ftime_t ecs_frame_begin(
2070 ecs_world_t *world,
2071 ecs_ftime_t delta_time);
2072
2079FLECS_API
2080 void ecs_frame_end(
2081 ecs_world_t *world);
2082
2090FLECS_API
2091 void ecs_run_post_frame(
2092 ecs_world_t *world,
2093 ecs_fini_action_t action,
2094 void *ctx);
2095
2102FLECS_API
2103 void ecs_quit(
2104 ecs_world_t *world);
2105
2112FLECS_API
2113 bool ecs_should_quit(
2114 const ecs_world_t *world);
2115
2127FLECS_API void ecs_measure_frame_time(
2128 ecs_world_t *world,
2129 bool enable);
2130
2141FLECS_API void ecs_measure_system_time(
2142 ecs_world_t *world,
2143 bool enable);
2144
2160FLECS_API
2161 void ecs_set_target_fps(
2162 ecs_world_t *world,
2163 ecs_ftime_t fps);
2164
2178FLECS_API
2179 void ecs_set_default_query_flags(
2180 ecs_world_t *world,
2181 ecs_flags32_t flags);
2182
2184
2189
2259FLECS_API
2260 bool ecs_readonly_begin(
2261 ecs_world_t *world,
2262 bool multi_threaded);
2263
2271FLECS_API
2272 void ecs_readonly_end(
2273 ecs_world_t *world);
2274
2285FLECS_API
2286 void ecs_merge(
2287 ecs_world_t *world);
2288
2304FLECS_API
2305 bool ecs_defer_begin(
2306 ecs_world_t *world);
2307
2318FLECS_API
2319 bool ecs_is_deferred(
2320 const ecs_world_t *world);
2321
2335FLECS_API
2336 bool ecs_defer_end(
2337 ecs_world_t *world);
2338
2353FLECS_API
2354 void ecs_defer_suspend(
2355 ecs_world_t *world);
2356
2367FLECS_API
2368 void ecs_defer_resume(
2369 ecs_world_t *world);
2370
2384FLECS_API
2385 void ecs_set_stage_count(
2386 ecs_world_t *world,
2387 int32_t stages);
2388
2395FLECS_API
2396int32_t ecs_get_stage_count(
2397 const ecs_world_t *world);
2398
2414FLECS_API
2415 ecs_world_t* ecs_get_stage(
2416 const ecs_world_t *world,
2417 int32_t stage_id);
2418
2426FLECS_API
2427 bool ecs_stage_is_readonly(
2428 const ecs_world_t *world);
2429
2437FLECS_API
2438 ecs_world_t* ecs_stage_new(
2439 ecs_world_t *world);
2440
2445FLECS_API
2446 void ecs_stage_free(
2447 ecs_world_t *stage);
2448
2456FLECS_API
2457int32_t ecs_stage_get_id(
2458 const ecs_world_t *world);
2459
2461
2466
2475FLECS_API
2476 void ecs_set_ctx(
2477 ecs_world_t *world,
2478 void *ctx,
2479 ecs_ctx_free_t ctx_free);
2480
2489FLECS_API
2490 void ecs_set_binding_ctx(
2491 ecs_world_t *world,
2492 void *ctx,
2493 ecs_ctx_free_t ctx_free);
2494
2502FLECS_API
2503 void* ecs_get_ctx(
2504 const ecs_world_t *world);
2505
2513FLECS_API
2514 void* ecs_get_binding_ctx(
2515 const ecs_world_t *world);
2516
2522FLECS_API
2523 const ecs_build_info_t* ecs_get_build_info(void);
2524
2530FLECS_API
2531 const ecs_world_info_t* ecs_get_world_info(
2532 const ecs_world_t *world);
2533
2542FLECS_API
2543 void ecs_dim(
2544 ecs_world_t *world,
2545 int32_t entity_count);
2546
2561FLECS_API
2562 void ecs_shrink(
2563 ecs_world_t *world);
2564
2580FLECS_API
2581 void ecs_set_entity_range(
2582 ecs_world_t *world,
2583 ecs_entity_t id_start,
2584 ecs_entity_t id_end);
2585
2596FLECS_API
2597 bool ecs_enable_range_check(
2598 ecs_world_t *world,
2599 bool enable);
2600
2606FLECS_API
2607 ecs_entity_t ecs_get_max_id(
2608 const ecs_world_t *world);
2609
2623FLECS_API
2624 void ecs_run_aperiodic(
2625 ecs_world_t *world,
2626 ecs_flags32_t flags);
2627
2629 typedef struct ecs_delete_empty_tables_desc_t {
2631 uint16_t clear_generation;
2632
2634 uint16_t delete_generation;
2635
2637 double time_budget_seconds;
2638} ecs_delete_empty_tables_desc_t;
2639
2669FLECS_API
2670int32_t ecs_delete_empty_tables(
2671 ecs_world_t *world,
2672 const ecs_delete_empty_tables_desc_t *desc);
2673
2679FLECS_API
2680 const ecs_world_t* ecs_get_world(
2681 const ecs_poly_t *poly);
2682
2688FLECS_API
2689 ecs_entity_t ecs_get_entity(
2690 const ecs_poly_t *poly);
2691
2705FLECS_API
2706 bool flecs_poly_is_(
2707 const ecs_poly_t *object,
2708 int32_t type);
2709
2713#define flecs_poly_is(object, type)\
2714 flecs_poly_is_(object, type##_magic)
2715
2724FLECS_API
2725 ecs_id_t ecs_make_pair(
2726 ecs_entity_t first,
2727 ecs_entity_t second);
2728
2730
2732
2739
2746
2755FLECS_API
2756 ecs_entity_t ecs_new(
2757 ecs_world_t *world);
2758
2776FLECS_API
2777 ecs_entity_t ecs_new_low_id(
2778 ecs_world_t *world);
2779
2788FLECS_API
2789 ecs_entity_t ecs_new_w_id(
2790 ecs_world_t *world,
2791 ecs_id_t id);
2792
2800FLECS_API
2801 ecs_entity_t ecs_new_w_table(
2802 ecs_world_t *world,
2803 ecs_table_t *table);
2804
2823FLECS_API
2824 ecs_entity_t ecs_entity_init(
2825 ecs_world_t *world,
2826 const ecs_entity_desc_t *desc);
2827
2854FLECS_API
2855 const ecs_entity_t* ecs_bulk_init(
2856 ecs_world_t *world,
2857 const ecs_bulk_desc_t *desc);
2858
2868FLECS_API
2869 const ecs_entity_t* ecs_bulk_new_w_id(
2870 ecs_world_t *world,
2871 ecs_id_t id,
2872 int32_t count);
2873
2889FLECS_API
2890 ecs_entity_t ecs_clone(
2891 ecs_world_t *world,
2892 ecs_entity_t dst,
2893 ecs_entity_t src,
2894 bool copy_value);
2895
2904FLECS_API
2905 void ecs_delete(
2906 ecs_world_t *world,
2907 ecs_entity_t entity);
2908
2916FLECS_API
2917 void ecs_delete_with(
2918 ecs_world_t *world,
2919 ecs_id_t id);
2920
2922
2929
2938FLECS_API
2939 void ecs_add_id(
2940 ecs_world_t *world,
2941 ecs_entity_t entity,
2942 ecs_id_t id);
2943
2952FLECS_API
2953 void ecs_remove_id(
2954 ecs_world_t *world,
2955 ecs_entity_t entity,
2956 ecs_id_t id);
2957
3009FLECS_API
3010 void ecs_auto_override_id(
3011 ecs_world_t *world,
3012 ecs_entity_t entity,
3013 ecs_id_t id);
3014
3021FLECS_API
3022 void ecs_clear(
3023 ecs_world_t *world,
3024 ecs_entity_t entity);
3025
3033FLECS_API
3034 void ecs_remove_all(
3035 ecs_world_t *world,
3036 ecs_id_t id);
3037
3045FLECS_API
3046 ecs_entity_t ecs_set_with(
3047 ecs_world_t *world,
3048 ecs_id_t id);
3049
3056FLECS_API
3057 ecs_id_t ecs_get_with(
3058 const ecs_world_t *world);
3059
3061
3068
3078FLECS_API
3079 void ecs_enable(
3080 ecs_world_t *world,
3081 ecs_entity_t entity,
3082 bool enabled);
3083
3097FLECS_API
3098 void ecs_enable_id(
3099 ecs_world_t *world,
3100 ecs_entity_t entity,
3101 ecs_id_t id,
3102 bool enable);
3103
3114FLECS_API
3115 bool ecs_is_enabled_id(
3116 const ecs_world_t *world,
3117 ecs_entity_t entity,
3118 ecs_id_t id);
3119
3121
3128
3143FLECS_API
3144FLECS_ALWAYS_INLINE const void* ecs_get_id(
3145 const ecs_world_t *world,
3146 ecs_entity_t entity,
3147 ecs_id_t id);
3148
3160FLECS_API
3161FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
3162 const ecs_world_t *world,
3163 ecs_entity_t entity,
3164 ecs_id_t id);
3165
3183FLECS_API
3184 void* ecs_ensure_id(
3185 ecs_world_t *world,
3186 ecs_entity_t entity,
3187 ecs_id_t id);
3188
3200FLECS_API
3201 void* ecs_ensure_modified_id(
3202 ecs_world_t *world,
3203 ecs_entity_t entity,
3204 ecs_id_t id);
3205
3216FLECS_API
3217 ecs_ref_t ecs_ref_init_id(
3218 const ecs_world_t *world,
3219 ecs_entity_t entity,
3220 ecs_id_t id);
3221
3230FLECS_API
3231 void* ecs_ref_get_id(
3232 const ecs_world_t *world,
3233 ecs_ref_t *ref,
3234 ecs_id_t id);
3235
3243FLECS_API
3244 void ecs_ref_update(
3245 const ecs_world_t *world,
3246 ecs_ref_t *ref);
3247
3267FLECS_API
3268 void* ecs_emplace_id(
3269 ecs_world_t *world,
3270 ecs_entity_t entity,
3271 ecs_id_t id,
3272 bool *is_new);
3273
3283FLECS_API
3284 void ecs_modified_id(
3285 ecs_world_t *world,
3286 ecs_entity_t entity,
3287 ecs_id_t id);
3288
3304FLECS_API
3305 void ecs_set_id(
3306 ecs_world_t *world,
3307 ecs_entity_t entity,
3308 ecs_id_t id,
3309 size_t size,
3310 const void *ptr);
3311
3313
3320
3339FLECS_API
3340 bool ecs_is_valid(
3341 const ecs_world_t *world,
3342 ecs_entity_t e);
3343
3369FLECS_API
3370 bool ecs_is_alive(
3371 const ecs_world_t *world,
3372 ecs_entity_t e);
3373
3379FLECS_API
3380 ecs_id_t ecs_strip_generation(
3381 ecs_entity_t e);
3382
3399FLECS_API
3400 ecs_entity_t ecs_get_alive(
3401 const ecs_world_t *world,
3402 ecs_entity_t e);
3403
3426FLECS_API
3427 void ecs_make_alive(
3428 ecs_world_t *world,
3429 ecs_entity_t entity);
3430
3449FLECS_API
3450 void ecs_make_alive_id(
3451 ecs_world_t *world,
3452 ecs_id_t id);
3453
3461FLECS_API
3462 bool ecs_exists(
3463 const ecs_world_t *world,
3464 ecs_entity_t entity);
3465
3480FLECS_API
3481 void ecs_set_version(
3482 ecs_world_t *world,
3483 ecs_entity_t entity);
3484
3486
3493
3500FLECS_API
3501 const ecs_type_t* ecs_get_type(
3502 const ecs_world_t *world,
3503 ecs_entity_t entity);
3504
3511FLECS_API
3512 ecs_table_t* ecs_get_table(
3513 const ecs_world_t *world,
3514 ecs_entity_t entity);
3515
3523FLECS_API
3524 char* ecs_type_str(
3525 const ecs_world_t *world,
3526 const ecs_type_t* type);
3527
3539FLECS_API
3540 char* ecs_table_str(
3541 const ecs_world_t *world,
3542 const ecs_table_t *table);
3543
3558FLECS_API
3559 char* ecs_entity_str(
3560 const ecs_world_t *world,
3561 ecs_entity_t entity);
3562
3573FLECS_API
3574FLECS_ALWAYS_INLINE bool ecs_has_id(
3575 const ecs_world_t *world,
3576 ecs_entity_t entity,
3577 ecs_id_t id);
3578
3589FLECS_API
3590FLECS_ALWAYS_INLINE bool ecs_owns_id(
3591 const ecs_world_t *world,
3592 ecs_entity_t entity,
3593 ecs_id_t id);
3594
3609FLECS_API
3610 ecs_entity_t ecs_get_target(
3611 const ecs_world_t *world,
3612 ecs_entity_t entity,
3613 ecs_entity_t rel,
3614 int32_t index);
3615
3629FLECS_API
3630 ecs_entity_t ecs_get_parent(
3631 const ecs_world_t *world,
3632 ecs_entity_t entity);
3633
3654FLECS_API
3655 ecs_entity_t ecs_get_target_for_id(
3656 const ecs_world_t *world,
3657 ecs_entity_t entity,
3658 ecs_entity_t rel,
3659 ecs_id_t id);
3660
3671FLECS_API
3672int32_t ecs_get_depth(
3673 const ecs_world_t *world,
3674 ecs_entity_t entity,
3675 ecs_entity_t rel);
3676
3684FLECS_API
3685int32_t ecs_count_id(
3686 const ecs_world_t *world,
3687 ecs_id_t entity);
3688
3690
3691
3698
3708FLECS_API
3709 const char* ecs_get_name(
3710 const ecs_world_t *world,
3711 ecs_entity_t entity);
3712
3722FLECS_API
3723 const char* ecs_get_symbol(
3724 const ecs_world_t *world,
3725 ecs_entity_t entity);
3726
3740FLECS_API
3741 ecs_entity_t ecs_set_name(
3742 ecs_world_t *world,
3743 ecs_entity_t entity,
3744 const char *name);
3745
3759FLECS_API
3760 ecs_entity_t ecs_set_symbol(
3761 ecs_world_t *world,
3762 ecs_entity_t entity,
3763 const char *symbol);
3764
3776FLECS_API
3777 void ecs_set_alias(
3778 ecs_world_t *world,
3779 ecs_entity_t entity,
3780 const char *alias);
3781
3797FLECS_API
3798 ecs_entity_t ecs_lookup(
3799 const ecs_world_t *world,
3800 const char *path);
3801
3816FLECS_API
3817 ecs_entity_t ecs_lookup_child(
3818 const ecs_world_t *world,
3819 ecs_entity_t parent,
3820 const char *name);
3821
3844FLECS_API
3845 ecs_entity_t ecs_lookup_path_w_sep(
3846 const ecs_world_t *world,
3847 ecs_entity_t parent,
3848 const char *path,
3849 const char *sep,
3850 const char *prefix,
3851 bool recursive);
3852
3870FLECS_API
3871 ecs_entity_t ecs_lookup_symbol(
3872 const ecs_world_t *world,
3873 const char *symbol,
3874 bool lookup_as_path,
3875 bool recursive);
3876
3898FLECS_API
3899 char* ecs_get_path_w_sep(
3900 const ecs_world_t *world,
3901 ecs_entity_t parent,
3902 ecs_entity_t child,
3903 const char *sep,
3904 const char *prefix);
3905
3918 void ecs_get_path_w_sep_buf(
3919 const ecs_world_t *world,
3920 ecs_entity_t parent,
3921 ecs_entity_t child,
3922 const char *sep,
3923 const char *prefix,
3924 ecs_strbuf_t *buf,
3925 bool escape);
3926
3942FLECS_API
3943 ecs_entity_t ecs_new_from_path_w_sep(
3944 ecs_world_t *world,
3945 ecs_entity_t parent,
3946 const char *path,
3947 const char *sep,
3948 const char *prefix);
3949
3964FLECS_API
3965 ecs_entity_t ecs_add_path_w_sep(
3966 ecs_world_t *world,
3967 ecs_entity_t entity,
3968 ecs_entity_t parent,
3969 const char *path,
3970 const char *sep,
3971 const char *prefix);
3972
3986FLECS_API
3987 ecs_entity_t ecs_set_scope(
3988 ecs_world_t *world,
3989 ecs_entity_t scope);
3990
3998FLECS_API
3999 ecs_entity_t ecs_get_scope(
4000 const ecs_world_t *world);
4001
4011FLECS_API
4012 const char* ecs_set_name_prefix(
4013 ecs_world_t *world,
4014 const char *prefix);
4015
4042FLECS_API
4043 ecs_entity_t* ecs_set_lookup_path(
4044 ecs_world_t *world,
4045 const ecs_entity_t *lookup_path);
4046
4053FLECS_API
4054 ecs_entity_t* ecs_get_lookup_path(
4055 const ecs_world_t *world);
4056
4058
4060
4067
4081FLECS_API
4082 ecs_entity_t ecs_component_init(
4083 ecs_world_t *world,
4084 const ecs_component_desc_t *desc);
4085
4095FLECS_API
4096 const ecs_type_info_t* ecs_get_type_info(
4097 const ecs_world_t *world,
4098 ecs_id_t id);
4099
4111FLECS_API
4112 void ecs_set_hooks_id(
4113 ecs_world_t *world,
4114 ecs_entity_t id,
4115 const ecs_type_hooks_t *hooks);
4116
4123FLECS_API
4124 const ecs_type_hooks_t* ecs_get_hooks_id(
4125 const ecs_world_t *world,
4126 ecs_entity_t id);
4127
4129
4136
4151FLECS_API
4152 bool ecs_id_is_tag(
4153 const ecs_world_t *world,
4154 ecs_id_t id);
4155
4164FLECS_API
4165 bool ecs_id_in_use(
4166 const ecs_world_t *world,
4167 ecs_id_t id);
4168
4188FLECS_API
4189 ecs_entity_t ecs_get_typeid(
4190 const ecs_world_t *world,
4191 ecs_id_t id);
4192
4201FLECS_API
4202 bool ecs_id_match(
4203 ecs_id_t id,
4204 ecs_id_t pattern);
4205
4211FLECS_API
4212 bool ecs_id_is_pair(
4213 ecs_id_t id);
4214
4220FLECS_API
4221 bool ecs_id_is_wildcard(
4222 ecs_id_t id);
4223
4237FLECS_API
4238 bool ecs_id_is_valid(
4239 const ecs_world_t *world,
4240 ecs_id_t id);
4241
4250FLECS_API
4251ecs_flags32_t ecs_id_get_flags(
4252 const ecs_world_t *world,
4253 ecs_id_t id);
4254
4261FLECS_API
4262 const char* ecs_id_flag_str(
4263 ecs_id_t id_flags);
4264
4272FLECS_API
4273 char* ecs_id_str(
4274 const ecs_world_t *world,
4275 ecs_id_t id);
4276
4284FLECS_API
4285 void ecs_id_str_buf(
4286 const ecs_world_t *world,
4287 ecs_id_t id,
4288 ecs_strbuf_t *buf);
4289
4297FLECS_API
4298 ecs_id_t ecs_id_from_str(
4299 const ecs_world_t *world,
4300 const char *expr);
4301
4303
4309
4315FLECS_API
4316 bool ecs_term_ref_is_set(
4317 const ecs_term_ref_t *id);
4318
4330FLECS_API
4331 bool ecs_term_is_initialized(
4332 const ecs_term_t *term);
4333
4348FLECS_API
4349 bool ecs_term_match_this(
4350 const ecs_term_t *term);
4351
4364FLECS_API
4365 bool ecs_term_match_0(
4366 const ecs_term_t *term);
4367
4376FLECS_API
4377 char* ecs_term_str(
4378 const ecs_world_t *world,
4379 const ecs_term_t *term);
4380
4388FLECS_API
4389 char* ecs_query_str(
4390 const ecs_query_t *query);
4391
4393
4399
4432FLECS_API
4433 ecs_iter_t ecs_each_id(
4434 const ecs_world_t *world,
4435 ecs_id_t id);
4436
4442FLECS_API
4443 bool ecs_each_next(
4444 ecs_iter_t *it);
4445
4458FLECS_API
4459 ecs_iter_t ecs_children(
4460 const ecs_world_t *world,
4461 ecs_entity_t parent);
4462
4468FLECS_API
4469 bool ecs_children_next(
4470 ecs_iter_t *it);
4471
4473
4480
4487FLECS_API
4488 ecs_query_t* ecs_query_init(
4489 ecs_world_t *world,
4490 const ecs_query_desc_t *desc);
4491
4496FLECS_API
4497 void ecs_query_fini(
4498 ecs_query_t *query);
4499
4508FLECS_API
4509int32_t ecs_query_find_var(
4510 const ecs_query_t *query,
4511 const char *name);
4512
4520FLECS_API
4521 const char* ecs_query_var_name(
4522 const ecs_query_t *query,
4523 int32_t var_id);
4524
4535FLECS_API
4536 bool ecs_query_var_is_entity(
4537 const ecs_query_t *query,
4538 int32_t var_id);
4539
4608FLECS_API
4609 ecs_iter_t ecs_query_iter(
4610 const ecs_world_t *world,
4611 const ecs_query_t *query);
4612
4620FLECS_API
4621 bool ecs_query_next(
4622 ecs_iter_t *it);
4623
4642FLECS_API
4643 bool ecs_query_has(
4644 ecs_query_t *query,
4645 ecs_entity_t entity,
4646 ecs_iter_t *it);
4647
4666FLECS_API
4667 bool ecs_query_has_table(
4668 ecs_query_t *query,
4669 ecs_table_t *table,
4670 ecs_iter_t *it);
4671
4698FLECS_API
4699 bool ecs_query_has_range(
4700 ecs_query_t *query,
4701 ecs_table_range_t *range,
4702 ecs_iter_t *it);
4703
4711FLECS_API
4712int32_t ecs_query_match_count(
4713 const ecs_query_t *query);
4714
4724FLECS_API
4725 char* ecs_query_plan(
4726 const ecs_query_t *query);
4727
4742FLECS_API
4743 char* ecs_query_plan_w_profile(
4744 const ecs_query_t *query,
4745 const ecs_iter_t *it);
4746
4764FLECS_API
4765 const char* ecs_query_args_parse(
4766 ecs_query_t *query,
4767 ecs_iter_t *it,
4768 const char *expr);
4769
4797FLECS_API
4798 bool ecs_query_changed(
4799 ecs_query_t *query);
4800
4809FLECS_API
4810 const ecs_query_t* ecs_query_get(
4811 const ecs_world_t *world,
4812 ecs_entity_t query);
4813
4824FLECS_API
4825 void ecs_iter_skip(
4826 ecs_iter_t *it);
4827
4850FLECS_API
4851 void ecs_iter_set_group(
4852 ecs_iter_t *it,
4853 uint64_t group_id);
4854
4863FLECS_API
4864 void* ecs_query_get_group_ctx(
4865 const ecs_query_t *query,
4866 uint64_t group_id);
4867
4876FLECS_API
4877 const ecs_query_group_info_t* ecs_query_get_group_info(
4878 const ecs_query_t *query,
4879 uint64_t group_id);
4880
4882 typedef struct ecs_query_count_t {
4883 int32_t results;
4884 int32_t entities;
4885 int32_t tables;
4886 int32_t empty_tables;
4887} ecs_query_count_t;
4888
4895FLECS_API
4896 ecs_query_count_t ecs_query_count(
4897 const ecs_query_t *query);
4898
4904FLECS_API
4905 bool ecs_query_is_true(
4906 const ecs_query_t *query);
4907
4916FLECS_API
4917 const ecs_query_t* ecs_query_get_cache_query(
4918 const ecs_query_t *query);
4919
4921
4928
4948FLECS_API
4949 void ecs_emit(
4950 ecs_world_t *world,
4951 ecs_event_desc_t *desc);
4952
4963FLECS_API
4964 void ecs_enqueue(
4965 ecs_world_t *world,
4966 ecs_event_desc_t *desc);
4967
4978FLECS_API
4979 ecs_entity_t ecs_observer_init(
4980 ecs_world_t *world,
4981 const ecs_observer_desc_t *desc);
4982
4991FLECS_API
4992 const ecs_observer_t* ecs_observer_get(
4993 const ecs_world_t *world,
4994 ecs_entity_t observer);
4995
4997
5004
5018FLECS_API
5019 bool ecs_iter_next(
5020 ecs_iter_t *it);
5021
5031FLECS_API
5032 void ecs_iter_fini(
5033 ecs_iter_t *it);
5034
5046FLECS_API
5047int32_t ecs_iter_count(
5048 ecs_iter_t *it);
5049
5062FLECS_API
5063 bool ecs_iter_is_true(
5064 ecs_iter_t *it);
5065
5073FLECS_API
5074 ecs_entity_t ecs_iter_first(
5075 ecs_iter_t *it);
5076
5115FLECS_API
5116 void ecs_iter_set_var(
5117 ecs_iter_t *it,
5118 int32_t var_id,
5119 ecs_entity_t entity);
5120
5131FLECS_API
5132 void ecs_iter_set_var_as_table(
5133 ecs_iter_t *it,
5134 int32_t var_id,
5135 const ecs_table_t *table);
5136
5147FLECS_API
5148 void ecs_iter_set_var_as_range(
5149 ecs_iter_t *it,
5150 int32_t var_id,
5151 const ecs_table_range_t *range);
5152
5165FLECS_API
5166 ecs_entity_t ecs_iter_get_var(
5167 ecs_iter_t *it,
5168 int32_t var_id);
5169
5183FLECS_API
5184 ecs_table_t* ecs_iter_get_var_as_table(
5185 ecs_iter_t *it,
5186 int32_t var_id);
5187
5201FLECS_API
5202ecs_table_range_t ecs_iter_get_var_as_range(
5203 ecs_iter_t *it,
5204 int32_t var_id);
5205
5217FLECS_API
5218 bool ecs_iter_var_is_constrained(
5219 ecs_iter_t *it,
5220 int32_t var_id);
5221
5233FLECS_API
5234 bool ecs_iter_changed(
5235 ecs_iter_t *it);
5236
5248FLECS_API
5249 char* ecs_iter_str(
5250 const ecs_iter_t *it);
5251
5267FLECS_API
5268 ecs_iter_t ecs_page_iter(
5269 const ecs_iter_t *it,
5270 int32_t offset,
5271 int32_t limit);
5272
5279FLECS_API
5280 bool ecs_page_next(
5281 ecs_iter_t *it);
5282
5303FLECS_API
5304 ecs_iter_t ecs_worker_iter(
5305 const ecs_iter_t *it,
5306 int32_t index,
5307 int32_t count);
5308
5315FLECS_API
5316 bool ecs_worker_next(
5317 ecs_iter_t *it);
5318
5360FLECS_API
5361 void* ecs_field_w_size(
5362 const ecs_iter_t *it,
5363 size_t size,
5364 int8_t index);
5365
5387FLECS_API
5388 void* ecs_field_at_w_size(
5389 const ecs_iter_t *it,
5390 size_t size,
5391 int8_t index,
5392 int32_t row);
5393
5402FLECS_API
5403 bool ecs_field_is_readonly(
5404 const ecs_iter_t *it,
5405 int8_t index);
5406
5417FLECS_API
5418 bool ecs_field_is_writeonly(
5419 const ecs_iter_t *it,
5420 int8_t index);
5421
5428FLECS_API
5429 bool ecs_field_is_set(
5430 const ecs_iter_t *it,
5431 int8_t index);
5432
5439FLECS_API
5440 ecs_id_t ecs_field_id(
5441 const ecs_iter_t *it,
5442 int8_t index);
5443
5452FLECS_API
5453int32_t ecs_field_column(
5454 const ecs_iter_t *it,
5455 int8_t index);
5456
5464FLECS_API
5465 ecs_entity_t ecs_field_src(
5466 const ecs_iter_t *it,
5467 int8_t index);
5468
5476FLECS_API
5477 size_t ecs_field_size(
5478 const ecs_iter_t *it,
5479 int8_t index);
5480
5494FLECS_API
5495 bool ecs_field_is_self(
5496 const ecs_iter_t *it,
5497 int8_t index);
5498
5500
5507
5514FLECS_API
5515 const ecs_type_t* ecs_table_get_type(
5516 const ecs_table_t *table);
5517
5528FLECS_API
5529int32_t ecs_table_get_type_index(
5530 const ecs_world_t *world,
5531 const ecs_table_t *table,
5532 ecs_id_t id);
5533
5543FLECS_API
5544int32_t ecs_table_get_column_index(
5545 const ecs_world_t *world,
5546 const ecs_table_t *table,
5547 ecs_id_t id);
5548
5556FLECS_API
5557int32_t ecs_table_column_count(
5558 const ecs_table_t *table);
5559
5573FLECS_API
5574int32_t ecs_table_type_to_column_index(
5575 const ecs_table_t *table,
5576 int32_t index);
5577
5586FLECS_API
5587int32_t ecs_table_column_to_type_index(
5588 const ecs_table_t *table,
5589 int32_t index);
5590
5599FLECS_API
5600 void* ecs_table_get_column(
5601 const ecs_table_t *table,
5602 int32_t index,
5603 int32_t offset);
5604
5614FLECS_API
5615 void* ecs_table_get_id(
5616 const ecs_world_t *world,
5617 const ecs_table_t *table,
5618 ecs_id_t id,
5619 int32_t offset);
5620
5628FLECS_API
5629 size_t ecs_table_get_column_size(
5630 const ecs_table_t *table,
5631 int32_t index);
5632
5639FLECS_API
5640int32_t ecs_table_count(
5641 const ecs_table_t *table);
5642
5650FLECS_API
5651int32_t ecs_table_size(
5652 const ecs_table_t *table);
5653
5660FLECS_API
5661 const ecs_entity_t* ecs_table_entities(
5662 const ecs_table_t *table);
5663
5674FLECS_API
5675 bool ecs_table_has_id(
5676 const ecs_world_t *world,
5677 const ecs_table_t *table,
5678 ecs_id_t id);
5679
5690FLECS_API
5691int32_t ecs_table_get_depth(
5692 const ecs_world_t *world,
5693 const ecs_table_t *table,
5694 ecs_entity_t rel);
5695
5705FLECS_API
5706 ecs_table_t* ecs_table_add_id(
5707 ecs_world_t *world,
5708 ecs_table_t *table,
5709 ecs_id_t id);
5710
5721FLECS_API
5722 ecs_table_t* ecs_table_find(
5723 ecs_world_t *world,
5724 const ecs_id_t *ids,
5725 int32_t id_count);
5726
5736FLECS_API
5737 ecs_table_t* ecs_table_remove_id(
5738 ecs_world_t *world,
5739 ecs_table_t *table,
5740 ecs_id_t id);
5741
5757FLECS_API
5758 void ecs_table_lock(
5759 ecs_world_t *world,
5760 ecs_table_t *table);
5761
5768FLECS_API
5769 void ecs_table_unlock(
5770 ecs_world_t *world,
5771 ecs_table_t *table);
5772
5782FLECS_API
5783 bool ecs_table_has_flags(
5784 ecs_table_t *table,
5785 ecs_flags32_t flags);
5786
5794FLECS_API
5795 void ecs_table_swap_rows(
5796 ecs_world_t* world,
5797 ecs_table_t* table,
5798 int32_t row_1,
5799 int32_t row_2);
5800
5823FLECS_API
5824 bool ecs_commit(
5825 ecs_world_t *world,
5826 ecs_entity_t entity,
5827 ecs_record_t *record,
5828 ecs_table_t *table,
5829 const ecs_type_t *added,
5830 const ecs_type_t *removed);
5831
5832
5851FLECS_API
5852int32_t ecs_search(
5853 const ecs_world_t *world,
5854 const ecs_table_t *table,
5855 ecs_id_t id,
5856 ecs_id_t *id_out);
5857
5893FLECS_API
5894int32_t ecs_search_offset(
5895 const ecs_world_t *world,
5896 const ecs_table_t *table,
5897 int32_t offset,
5898 ecs_id_t id,
5899 ecs_id_t *id_out);
5900
5942FLECS_API
5943int32_t ecs_search_relation(
5944 const ecs_world_t *world,
5945 const ecs_table_t *table,
5946 int32_t offset,
5947 ecs_id_t id,
5948 ecs_entity_t rel,
5949 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
5950 ecs_entity_t *subject_out,
5951 ecs_id_t *id_out,
5952 struct ecs_table_record_t **tr_out);
5953
5961FLECS_API
5962 void ecs_table_clear_entities(
5963 ecs_world_t* world,
5964 ecs_table_t* table);
5965
5967
5974
5982FLECS_API
5983 int ecs_value_init(
5984 const ecs_world_t *world,
5985 ecs_entity_t type,
5986 void *ptr);
5987
5995FLECS_API
5996 int ecs_value_init_w_type_info(
5997 const ecs_world_t *world,
5998 const ecs_type_info_t *ti,
5999 void *ptr);
6000
6007FLECS_API
6008 void* ecs_value_new(
6009 ecs_world_t *world,
6010 ecs_entity_t type);
6011
6018 void* ecs_value_new_w_type_info(
6019 ecs_world_t *world,
6020 const ecs_type_info_t *ti);
6021
6029 int ecs_value_fini_w_type_info(
6030 const ecs_world_t *world,
6031 const ecs_type_info_t *ti,
6032 void *ptr);
6033
6041FLECS_API
6042 int ecs_value_fini(
6043 const ecs_world_t *world,
6044 ecs_entity_t type,
6045 void* ptr);
6046
6054FLECS_API
6055 int ecs_value_free(
6056 ecs_world_t *world,
6057 ecs_entity_t type,
6058 void* ptr);
6059
6068FLECS_API
6069 int ecs_value_copy_w_type_info(
6070 const ecs_world_t *world,
6071 const ecs_type_info_t *ti,
6072 void* dst,
6073 const void *src);
6074
6083FLECS_API
6084 int ecs_value_copy(
6085 const ecs_world_t *world,
6086 ecs_entity_t type,
6087 void* dst,
6088 const void *src);
6089
6098 int ecs_value_move_w_type_info(
6099 const ecs_world_t *world,
6100 const ecs_type_info_t *ti,
6101 void* dst,
6102 void *src);
6103
6112 int ecs_value_move(
6113 const ecs_world_t *world,
6114 ecs_entity_t type,
6115 void* dst,
6116 void *src);
6117
6126 int ecs_value_move_ctor_w_type_info(
6127 const ecs_world_t *world,
6128 const ecs_type_info_t *ti,
6129 void* dst,
6130 void *src);
6131
6140 int ecs_value_move_ctor(
6141 const ecs_world_t *world,
6142 ecs_entity_t type,
6143 void* dst,
6144 void *src);
6145
6147
6149
6158
6159#include "flecs/addons/flecs_c.h"
6160
6161#ifdef __cplusplus
6162}
6163#endif
6164
6165#include "flecs/private/addons.h"
6166
6167#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.
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.
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.
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.
EcsInheritable
const ecs_entity_t EcsInheritable
Mark component as inheritable.
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 ("$").
EcsConstant
const ecs_entity_t EcsConstant
Tag added to enum/bitmask constants.
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_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_component_record_t
struct ecs_component_record_t ecs_component_record_t
Information about a (component) id, such as type info and tables with the id.
Definition flecs.h:493
ecs_stage_t
struct ecs_stage_t ecs_stage_t
A stage enables modification while iterating and from multiple threads.
Definition flecs.h:428
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:477
ecs_entity_t
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:381
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:425
ecs_mixins_t
struct ecs_mixins_t ecs_mixins_t
Type that stores poly mixins.
Definition flecs.h:517
ecs_id_t
uint64_t ecs_id_t
Ids are the things that can be added to an entity.
Definition flecs.h:374
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:461
ecs_record_t
struct ecs_record_t ecs_record_t
Information about an entity, like its table and row.
Definition flecs.h:490
ecs_table_t
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:431
ecs_poly_t
void ecs_poly_t
A poly object.
Definition flecs.h:514
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_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:616
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:596
ecs_cmp_t
int(* ecs_cmp_t)(const void *a_ptr, const void *b_ptr, const ecs_type_info_t *type_info)
Compare hook to compare component instances.
Definition flecs.h:658
ecs_hash_value_action_t
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:634
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:609
ecs_iter_fini_action_t
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:574
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:603
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:585
ecs_iter_next_action_t
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:566
ecs_iter_action_t
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:556
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:644
ecs_equals_t
bool(* ecs_equals_t)(const void *a_ptr, const void *b_ptr, const ecs_type_info_t *type_info)
Equals operator hook.
Definition flecs.h:664
ecs_compare_action_t
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:629
ecs_fini_action_t
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:620
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:651
flecs_poly_dtor_t
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:670
ecs_run_action_t
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:547
ecs_ctx_free_t
void(* ecs_ctx_free_t)(void *ctx)
Function to cleanup context data.
Definition flecs.h:625
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:578
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:638
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_ref_update
void ecs_ref_update(const ecs_world_t *world, ecs_ref_t *ref)
Update ref.
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_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_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_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_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_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.
FLECS_EVENT_DESC_MAX
#define FLECS_EVENT_DESC_MAX
Maximum number of events in ecs_observer_desc_t.
Definition flecs.h:302
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:296
FLECS_TERM_COUNT_MAX
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:312
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_get
const ecs_query_t * ecs_query_get(const ecs_world_t *world, ecs_entity_t query)
Get query object.
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_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_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_query_cache_kind_t
ecs_query_cache_kind_t
Specify cache policy for query.
Definition flecs.h:704
ecs_inout_kind_t
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:683
ecs_oper_kind_t
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:693
EcsQueryCacheAll
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:707
EcsQueryCacheDefault
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:705
EcsQueryCacheNone
@ EcsQueryCacheNone
No caching.
Definition flecs.h:708
EcsQueryCacheAuto
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:706
EcsOut
@ EcsOut
Term is only written.
Definition flecs.h:689
EcsInOut
@ EcsInOut
Term is both read and written.
Definition flecs.h:687
EcsInOutFilter
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:686
EcsInOutDefault
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:684
EcsInOutNone
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:685
EcsIn
@ EcsIn
Term is only read.
Definition flecs.h:688
EcsNot
@ EcsNot
The term must not match.
Definition flecs.h:696
EcsOptional
@ EcsOptional
The term may match.
Definition flecs.h:697
EcsOr
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:695
EcsOrFrom
@ EcsOrFrom
Term must match at least one component from term id.
Definition flecs.h:699
EcsAnd
@ EcsAnd
The term must match.
Definition flecs.h:694
EcsNotFrom
@ EcsNotFrom
Term must match none of the components from term id.
Definition flecs.h:700
EcsAndFrom
@ EcsAndFrom
Term must match all components from term id.
Definition flecs.h:698
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_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_shrink
void ecs_shrink(ecs_world_t *world)
Free unused memory.
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, const ecs_delete_empty_tables_desc_t *desc)
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:1523
EcsComponent::size
ecs_size_t size
Component size.
Definition flecs.h:1524
EcsComponent::alignment
ecs_size_t alignment
Component alignment.
Definition flecs.h:1525
EcsDefaultChildComponent
When added to an entity this informs serialization formats which component to use when a value is ass...
Definition flecs.h:1538
EcsDefaultChildComponent::component
ecs_id_t component
Default component id.
Definition flecs.h:1539
EcsIdentifier
A (string) identifier.
Definition flecs.h:1514
EcsIdentifier::length
ecs_size_t length
Length of identifier.
Definition flecs.h:1516
EcsIdentifier::value
char * value
Identifier string.
Definition flecs.h:1515
EcsIdentifier::index
ecs_hashmap_t * index
Current index.
Definition flecs.h:1519
EcsIdentifier::hash
uint64_t hash
Hash of current value.
Definition flecs.h:1517
EcsIdentifier::index_hash
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1518
EcsPoly
Component for storing a poly object.
Definition flecs.h:1529
EcsPoly::poly
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1530
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:1426
ecs_build_info_t::version_major
int16_t version_major
Major flecs version.
Definition flecs.h:1430
ecs_build_info_t::addons
const char ** addons
Addons included in build.
Definition flecs.h:1428
ecs_build_info_t::version
const char * version
Stringified version.
Definition flecs.h:1429
ecs_build_info_t::compiler
const char * compiler
Compiler used to compile flecs.
Definition flecs.h:1427
ecs_build_info_t::sanitize
bool sanitize
Is this a sanitize build.
Definition flecs.h:1434
ecs_build_info_t::perf_trace
bool perf_trace
Is this a perf tracing build.
Definition flecs.h:1435
ecs_build_info_t::version_minor
int16_t version_minor
Minor flecs version.
Definition flecs.h:1431
ecs_build_info_t::debug
bool debug
Is this a debug build.
Definition flecs.h:1433
ecs_build_info_t::version_patch
int16_t version_patch
Patch flecs version.
Definition flecs.h:1432
ecs_bulk_desc_t
Used with ecs_bulk_init().
Definition flecs.h:1058
ecs_bulk_desc_t::data
void ** data
Array with component data to insert.
Definition flecs.h:1070
ecs_bulk_desc_t::ids
ecs_id_t ids[(32)]
Ids to create the entities with.
Definition flecs.h:1068
ecs_bulk_desc_t::count
int32_t count
Number of entities to create/populate.
Definition flecs.h:1066
ecs_bulk_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1059
ecs_bulk_desc_t::entities
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:1061
ecs_bulk_desc_t::table
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1077
ecs_component_desc_t
Used with ecs_component_init().
Definition flecs.h:1088
ecs_component_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1089
ecs_component_desc_t::type
ecs_type_info_t type
Parameters for type (size, hooks, ...)
Definition flecs.h:1095
ecs_component_desc_t::entity
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1092
ecs_delete_empty_tables_desc_t
Used with ecs_delete_empty_tables().
Definition flecs.h:2629
ecs_delete_empty_tables_desc_t::delete_generation
uint16_t delete_generation
Delete table when generation > delete_generation.
Definition flecs.h:2634
ecs_delete_empty_tables_desc_t::time_budget_seconds
double time_budget_seconds
Amount of time operation is allowed to spend.
Definition flecs.h:2637
ecs_delete_empty_tables_desc_t::clear_generation
uint16_t clear_generation
Free table data when generation > clear_generation.
Definition flecs.h:2631
ecs_entities_t
Type returned by ecs_get_entities().
Definition flecs.h:1996
ecs_entities_t::alive_count
int32_t alive_count
Number of alive entity ids.
Definition flecs.h:1999
ecs_entities_t::count
int32_t count
Total number of entity ids.
Definition flecs.h:1998
ecs_entities_t::ids
const ecs_entity_t * ids
Array with all entity ids in the world.
Definition flecs.h:1997
ecs_entity_desc_t
Used with ecs_entity_init().
Definition flecs.h:1012
ecs_entity_desc_t::sep
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:1024
ecs_entity_desc_t::root_sep
const char * root_sep
Optional, used for identifiers relative to root.
Definition flecs.h:1028
ecs_entity_desc_t::name
const char * name
Name of the entity.
Definition flecs.h:1019
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:1040
ecs_entity_desc_t::symbol
const char * symbol
Optional entity symbol.
Definition flecs.h:1030
ecs_entity_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1013
ecs_entity_desc_t::add
const ecs_id_t * add
0-terminated array of ids to add to the entity.
Definition flecs.h:1045
ecs_entity_desc_t::add_expr
const char * add_expr
String expression with components to add.
Definition flecs.h:1051
ecs_entity_desc_t::set
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:1048
ecs_entity_desc_t::id
ecs_entity_t id
Set to modify existing entity (optional)
Definition flecs.h:1015
ecs_entity_desc_t::parent
ecs_entity_t parent
Parent entity.
Definition flecs.h:1017
ecs_event_desc_t
Used with ecs_emit().
Definition flecs.h:1372
ecs_event_desc_t::entity
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1397
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:1408
ecs_event_desc_t::table
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1382
ecs_event_desc_t::count
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1394
ecs_event_desc_t::other_table
ecs_table_t * other_table
Optional 2nd table to notify.
Definition flecs.h:1386
ecs_event_desc_t::offset
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1389
ecs_event_desc_t::ids
const ecs_type_t * ids
Component ids.
Definition flecs.h:1379
ecs_event_desc_t::observable
ecs_poly_t * observable
Observable (usually the world)
Definition flecs.h:1411
ecs_event_desc_t::event
ecs_entity_t event
The event id.
Definition flecs.h:1374
ecs_event_desc_t::flags
ecs_flags32_t flags
Event flags.
Definition flecs.h:1414
ecs_event_desc_t::param
void * param
Optional context.
Definition flecs.h:1403
ecs_header_t
Header for ecs_poly_t objects.
Definition flecs.h:520
ecs_header_t::magic
int32_t magic
Magic number verifying it's a flecs object.
Definition flecs.h:521
ecs_header_t::type
int32_t type
Magic number indicating which type of flecs object.
Definition flecs.h:522
ecs_header_t::refcount
int32_t refcount
Refcount, to enable RAII handles.
Definition flecs.h:523
ecs_header_t::mixins
ecs_mixins_t * mixins
Table with offsets to (optional) mixins.
Definition flecs.h:524
ecs_iter_t
Iterator.
Definition flecs.h:1136
ecs_iter_t::real_world
ecs_world_t * real_world
Actual world.
Definition flecs.h:1139
ecs_iter_t::param
void * param
Param passed to ecs_run.
Definition flecs.h:1173
ecs_iter_t::event
ecs_entity_t event
The event (if applicable)
Definition flecs.h:1159
ecs_iter_t::frame_offset
int32_t frame_offset
Offset relative to start of iteration.
Definition flecs.h:1184
ecs_iter_t::variable_names
char ** variable_names
Names of variables (if any)
Definition flecs.h:1170
ecs_iter_t::ref_fields
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1153
ecs_iter_t::variable_count
int8_t variable_count
Number of variables for query.
Definition flecs.h:1168
ecs_iter_t::interrupted_by
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1190
ecs_iter_t::flags
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1189
ecs_iter_t::chain_it
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1197
ecs_iter_t::ctx
void * ctx
System context.
Definition flecs.h:1174
ecs_iter_t::run_ctx
void * run_ctx
Run language binding context.
Definition flecs.h:1177
ecs_iter_t::table
ecs_table_t * table
Current table.
Definition flecs.h:1144
ecs_iter_t::offset
int32_t offset
Offset relative to current table.
Definition flecs.h:1185
ecs_iter_t::event_id
ecs_id_t event_id
The (component) id for the event.
Definition flecs.h:1160
ecs_iter_t::fini
ecs_iter_fini_action_t fini
Function to cleanup iterator resources.
Definition flecs.h:1196
ecs_iter_t::variables
ecs_var_t * variables
Values of variables (if any)
Definition flecs.h:1147
ecs_iter_t::priv_
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1191
ecs_iter_t::world
ecs_world_t * world
The world.
Definition flecs.h:1138
ecs_iter_t::callback_ctx
void * callback_ctx
Callback language binding context.
Definition flecs.h:1176
ecs_iter_t::sources
ecs_entity_t * sources
Entity on which the id was matched (0 if same as entities)
Definition flecs.h:1149
ecs_iter_t::binding_ctx
void * binding_ctx
System binding context.
Definition flecs.h:1175
ecs_iter_t::row_fields
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1154
ecs_iter_t::delta_system_time
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1181
ecs_iter_t::query
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1169
ecs_iter_t::term_index
int8_t term_index
Index of term that emitted an event.
Definition flecs.h:1165
ecs_iter_t::system
ecs_entity_t system
The system (if applicable)
Definition flecs.h:1158
ecs_iter_t::set_fields
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1152
ecs_iter_t::sizes
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1143
ecs_iter_t::delta_time
float delta_time
Time elapsed since last frame.
Definition flecs.h:1180
ecs_iter_t::up_fields
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1155
ecs_iter_t::callback
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1195
ecs_iter_t::field_count
int8_t field_count
Number of fields in iterator.
Definition flecs.h:1164
ecs_iter_t::other_table
ecs_table_t * other_table
Prev or next table when adding/removing.
Definition flecs.h:1145
ecs_iter_t::event_cur
int32_t event_cur
Unique event id.
Definition flecs.h:1161
ecs_iter_t::trs
const ecs_table_record_t ** trs
Info on where to find field in table.
Definition flecs.h:1148
ecs_iter_t::count
int32_t count
Number of entities to iterate.
Definition flecs.h:1186
ecs_iter_t::group_id
uint64_t group_id
Group id for table, if group_by is used.
Definition flecs.h:1151
ecs_iter_t::next
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1194
ecs_iter_t::entities
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1142
ecs_iter_t::ids
ecs_id_t * ids
(Component) ids
Definition flecs.h:1146
ecs_iter_t::constrained_vars
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1150
ecs_observer_desc_t
Used with ecs_observer_init().
Definition flecs.h:1310
ecs_observer_desc_t::run_ctx_free
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1354
ecs_observer_desc_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1342
ecs_observer_desc_t::run_ctx
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1351
ecs_observer_desc_t::entity
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1315
ecs_observer_desc_t::events
ecs_entity_t events[(8)]
Events to observe (OnAdd, OnRemove, OnSet)
Definition flecs.h:1321
ecs_observer_desc_t::last_event_id
int32_t * last_event_id
Optional shared last event id for multiple observers.
Definition flecs.h:1361
ecs_observer_desc_t::callback_ctx
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1345
ecs_observer_desc_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:1339
ecs_observer_desc_t::query
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1318
ecs_observer_desc_t::observable
ecs_poly_t * observable
Observable with which to register the observer.
Definition flecs.h:1357
ecs_observer_desc_t::callback_ctx_free
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1348
ecs_observer_desc_t::term_index_
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1364
ecs_observer_desc_t::callback
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1328
ecs_observer_desc_t::yield_existing
bool yield_existing
When observer is created, generate events from existing data.
Definition flecs.h:1325
ecs_observer_desc_t::run
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1336
ecs_observer_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1312
ecs_observer_t
An observer reacts to events matching a query.
Definition flecs.h:853
ecs_observer_t::event_count
int32_t event_count
Number of events.
Definition flecs.h:860
ecs_observer_t::callback
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:862
ecs_observer_t::entity
ecs_entity_t entity
Entity associated with observer.
Definition flecs.h:876
ecs_observer_t::observable
ecs_observable_t * observable
Observable for observer.
Definition flecs.h:873
ecs_observer_t::run
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:863
ecs_observer_t::hdr
ecs_header_t hdr
Object header.
Definition flecs.h:854
ecs_observer_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:869
ecs_observer_t::run_ctx
void * run_ctx
Run language binding context.
Definition flecs.h:867
ecs_observer_t::world
ecs_world_t * world
The world.
Definition flecs.h:875
ecs_observer_t::run_ctx_free
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:871
ecs_observer_t::callback_ctx
void * callback_ctx
Callback language binding context.
Definition flecs.h:866
ecs_observer_t::ctx
void * ctx
Observer context.
Definition flecs.h:865
ecs_observer_t::events
ecs_entity_t events[(8)]
Observer events.
Definition flecs.h:859
ecs_observer_t::callback_ctx_free
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:870
ecs_observer_t::query
ecs_query_t * query
Observer query.
Definition flecs.h:856
ecs_query_count_t
Struct returned by ecs_query_count().
Definition flecs.h:4882
ecs_query_count_t::empty_tables
int32_t empty_tables
Number of empty tables returned by query.
Definition flecs.h:4886
ecs_query_count_t::entities
int32_t entities
Number of entities returned by query.
Definition flecs.h:4884
ecs_query_count_t::results
int32_t results
Number of results returned by query.
Definition flecs.h:4883
ecs_query_count_t::tables
int32_t tables
Number of tables returned by query.
Definition flecs.h:4885
ecs_query_desc_t
Used with ecs_query_init().
Definition flecs.h:1236
ecs_query_desc_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1297
ecs_query_desc_t::group_by
ecs_id_t group_by
Component id to be used for grouping.
Definition flecs.h:1267
ecs_query_desc_t::terms
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1241
ecs_query_desc_t::_canary
int32_t _canary
Used for validity testing.
Definition flecs.h:1238
ecs_query_desc_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:1291
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:1288
ecs_query_desc_t::group_by_ctx
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1285
ecs_query_desc_t::binding_ctx
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1294
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:1263
ecs_query_desc_t::order_by_callback
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1255
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:1278
ecs_query_desc_t::entity
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:1303
ecs_query_desc_t::binding_ctx_free
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1300
ecs_query_desc_t::group_by_callback
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1274
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:1282
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:1259
ecs_query_desc_t::flags
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1250
ecs_query_desc_t::cache_kind
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:1247
ecs_query_desc_t::expr
const char * expr
Query DSL expression (optional)
Definition flecs.h:1244
ecs_query_group_info_t
Type that contains information about a query group.
Definition flecs.h:1498
ecs_query_group_info_t::table_count
int32_t table_count
Number of tables in group.
Definition flecs.h:1500
ecs_query_group_info_t::ctx
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1501
ecs_query_group_info_t::match_count
int32_t match_count
How often tables have been matched/unmatched.
Definition flecs.h:1499
ecs_query_t
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:813
ecs_query_t::row_fields
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:832
ecs_query_t::data_fields
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:829
ecs_query_t::read_fields
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:831
ecs_query_t::hdr
ecs_header_t hdr
Object header.
Definition flecs.h:814
ecs_query_t::terms
ecs_term_t terms[32]
Query terms.
Definition flecs.h:816
ecs_query_t::var_count
int8_t var_count
Number of query variables.
Definition flecs.h:821
ecs_query_t::fixed_fields
ecs_flags32_t fixed_fields
Fields with a fixed source.
Definition flecs.h:826
ecs_query_t::var_fields
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:827
ecs_query_t::write_fields
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:830
ecs_query_t::sizes
int32_t sizes[32]
Component sizes.
Definition flecs.h:817
ecs_query_t::eval_count
int32_t eval_count
Number of times query is evaluated.
Definition flecs.h:847
ecs_query_t::world
ecs_world_t * world
World or stage query was created with.
Definition flecs.h:845
ecs_query_t::static_id_fields
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:828
ecs_query_t::real_world
ecs_world_t * real_world
Actual world.
Definition flecs.h:844
ecs_query_t::set_fields
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:834
ecs_query_t::entity
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:843
ecs_query_t::ctx
void * ctx
User context to pass to callback.
Definition flecs.h:840
ecs_query_t::shared_readonly_fields
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:833
ecs_query_t::ids
ecs_id_t ids[32]
Component ids.
Definition flecs.h:818
ecs_query_t::cache_kind
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:836
ecs_query_t::term_count
int8_t term_count
Number of query terms.
Definition flecs.h:822
ecs_query_t::vars
char ** vars
Array with variable names for iterator.
Definition flecs.h:838
ecs_query_t::field_count
int8_t field_count
Number of fields returned by query.
Definition flecs.h:823
ecs_query_t::flags
ecs_flags32_t flags
Query flags.
Definition flecs.h:820
ecs_query_t::binding_ctx
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:841
ecs_term_ref_t
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:774
ecs_term_ref_t::name
const char * name
Name.
Definition flecs.h:781
ecs_term_ref_t::id
ecs_entity_t id
Entity id.
Definition flecs.h:775
ecs_term_t
Type that describes a term (single element in a query).
Definition flecs.h:789
ecs_term_t::src
ecs_term_ref_t src
Source of term.
Definition flecs.h:795
ecs_term_t::field_index
int8_t field_index
Index of field for term in iterator.
Definition flecs.h:806
ecs_term_t::id
ecs_id_t id
Component id to be matched by term.
Definition flecs.h:790
ecs_term_t::oper
int16_t oper
Operator of term.
Definition flecs.h:804
ecs_term_t::second
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:797
ecs_term_t::flags_
ecs_flags16_t flags_
Flags that help eval, set by ecs_query_init()
Definition flecs.h:807
ecs_term_t::trav
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:799
ecs_term_t::inout
int16_t inout
Access to contents matched by term.
Definition flecs.h:803
ecs_term_t::first
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:796
ecs_type_hooks_t
Definition flecs.h:925
ecs_type_hooks_t::copy_ctor
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:932
ecs_type_hooks_t::lifecycle_ctx
void * lifecycle_ctx
Component lifecycle context (see meta add-on)
Definition flecs.h:978
ecs_type_hooks_t::ctx
void * ctx
User defined context.
Definition flecs.h:976
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:974
ecs_type_hooks_t::binding_ctx
void * binding_ctx
Language binding context.
Definition flecs.h:977
ecs_type_hooks_t::move_dtor
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:947
ecs_type_hooks_t::flags
ecs_flags32_t flags
Hook flags.
Definition flecs.h:959
ecs_type_hooks_t::cmp
ecs_cmp_t cmp
Compare hook.
Definition flecs.h:950
ecs_type_hooks_t::copy
ecs_copy_t copy
copy assignment
Definition flecs.h:928
ecs_type_hooks_t::lifecycle_ctx_free
ecs_ctx_free_t lifecycle_ctx_free
Callback to free lifecycle_ctx.
Definition flecs.h:982
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:969
ecs_type_hooks_t::move
ecs_move_t move
move assignment
Definition flecs.h:929
ecs_type_hooks_t::ctor
ecs_xtor_t ctor
ctor
Definition flecs.h:926
ecs_type_hooks_t::ctx_free
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:980
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:964
ecs_type_hooks_t::binding_ctx_free
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:981
ecs_type_hooks_t::move_ctor
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:935
ecs_type_hooks_t::equals
ecs_equals_t equals
Equals hook.
Definition flecs.h:953
ecs_type_hooks_t::ctor_move_dtor
ecs_move_t ctor_move_dtor
Ctor + move + dtor (or move_ctor + dtor).
Definition flecs.h:941
ecs_type_hooks_t::dtor
ecs_xtor_t dtor
dtor
Definition flecs.h:927
ecs_type_info_t
Type that contains component information (passed to ctors/dtors/...)
Definition flecs.h:989
ecs_type_info_t::alignment
ecs_size_t alignment
Alignment of type.
Definition flecs.h:991
ecs_type_info_t::size
ecs_size_t size
Size of type.
Definition flecs.h:990
ecs_type_info_t::name
const char * name
Type name.
Definition flecs.h:994
ecs_type_info_t::component
ecs_entity_t component
Handle to component (do not set)
Definition flecs.h:993
ecs_type_info_t::hooks
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:992
ecs_type_t
A type is a list of (component) ids.
Definition flecs.h:398
ecs_type_t::array
ecs_id_t * array
Array with ids.
Definition flecs.h:399
ecs_type_t::count
int32_t count
Number of elements in array.
Definition flecs.h:400
ecs_value_t
Utility to hold a value of a dynamic type.
Definition flecs.h:1003
ecs_value_t::ptr
void * ptr
Pointer to value.
Definition flecs.h:1005
ecs_value_t::type
ecs_entity_t type
Type of value.
Definition flecs.h:1004
ecs_world_info_t
Type that contains information about the world.
Definition flecs.h:1439
ecs_world_info_t::delta_time
float delta_time
Time passed to or computed by ecs_progress()
Definition flecs.h:1445
ecs_world_info_t::min_id
ecs_entity_t min_id
First allowed entity id.
Definition flecs.h:1441
ecs_world_info_t::set_count
int64_t set_count
Set commands processed.
Definition flecs.h:1481
ecs_world_info_t::world_time_total
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1453
ecs_world_info_t::tag_id_count
int32_t tag_id_count
Number of tag (no data) ids in the world.
Definition flecs.h:1469
ecs_world_info_t::component_id_count
int32_t component_id_count
Number of component (data) ids in the world.
Definition flecs.h:1470
ecs_world_info_t::pipeline_build_count_total
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1465
ecs_world_info_t::eval_comp_monitors_total
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1458
ecs_world_info_t::table_count
int32_t table_count
Number of tables.
Definition flecs.h:1473
ecs_world_info_t::delta_time_raw
float delta_time_raw
Raw delta time (no time scaling)
Definition flecs.h:1444
ecs_world_info_t::frame_time_total
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1448
ecs_world_info_t::table_create_total
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1463
ecs_world_info_t::observers_ran_frame
int64_t observers_ran_frame
Total number of times observer was invoked.
Definition flecs.h:1467
ecs_world_info_t::system_time_total
float system_time_total
Total time spent in systems.
Definition flecs.h:1449
ecs_world_info_t::id_delete_total
int64_t id_delete_total
Total number of times an id was deleted.
Definition flecs.h:1462
ecs_world_info_t::systems_ran_frame
int64_t systems_ran_frame
Total number of systems ran in last frame.
Definition flecs.h:1466
ecs_world_info_t::cmd
struct ecs_world_info_t::@354013130002221015352342176135321160002353227336 cmd
Command statistics.
ecs_world_info_t::merge_time_total
float merge_time_total
Total time spent in merges.
Definition flecs.h:1451
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:1484
ecs_world_info_t::clear_count
int64_t clear_count
Clear commands processed.
Definition flecs.h:1480
ecs_world_info_t::last_component_id
ecs_entity_t last_component_id
Last issued component entity id.
Definition flecs.h:1440
ecs_world_info_t::frame_count_total
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1456
ecs_world_info_t::max_id
ecs_entity_t max_id
Last allowed entity id.
Definition flecs.h:1442
ecs_world_info_t::merge_count_total
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1457
ecs_world_info_t::other_count
int64_t other_count
Other commands processed.
Definition flecs.h:1486
ecs_world_info_t::batched_command_count
int64_t batched_command_count
Commands batched.
Definition flecs.h:1488
ecs_world_info_t::table_delete_total
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1464
ecs_world_info_t::delete_count
int64_t delete_count
Selete commands processed.
Definition flecs.h:1479
ecs_world_info_t::rematch_count_total
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1459
ecs_world_info_t::id_create_total
int64_t id_create_total
Total number of times a new id was created.
Definition flecs.h:1461
ecs_world_info_t::batched_entity_count
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1487
ecs_world_info_t::time_scale
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1446
ecs_world_info_t::pair_id_count
int32_t pair_id_count
Number of pair ids in the world.
Definition flecs.h:1471
ecs_world_info_t::rematch_time_total
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1452
ecs_world_info_t::ensure_count
int64_t ensure_count
Ensure/emplace commands processed.
Definition flecs.h:1482
ecs_world_info_t::target_fps
float target_fps
Target fps.
Definition flecs.h:1447
ecs_world_info_t::world_time_total_raw
double world_time_total_raw
Time elapsed in simulation (no scaling)
Definition flecs.h:1454
ecs_world_info_t::emit_time_total
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1450
ecs_world_info_t::modified_count
int64_t modified_count
Modified commands processed.
Definition flecs.h:1483
ecs_world_info_t::name_prefix
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1491
ecs_world_info_t::event_count
int64_t event_count
Enqueued custom events.
Definition flecs.h:1485
ecs_world_info_t::add_count
int64_t add_count
Add commands processed.
Definition flecs.h:1477
ecs_world_info_t::remove_count
int64_t remove_count
Remove commands processed.
Definition flecs.h:1478