Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs.h
Go to the documentation of this file.
1
8#ifndef FLECS_H
9#define FLECS_H
10
33/* Flecs version macros */
34#define FLECS_VERSION_MAJOR 4
35#define FLECS_VERSION_MINOR 1
36#define FLECS_VERSION_PATCH 6
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
62
68// #define FLECS_ACCURATE_COUNTERS
69
75// #define FLECS_DISABLE_COUNTERS
76
77/* Make sure provided configuration is valid */
78#if defined(FLECS_DEBUG) && defined(FLECS_NDEBUG)
79#warning "invalid configuration: cannot both define FLECS_DEBUG and FLECS_NDEBUG"
80#endif
81#if defined(FLECS_DEBUG) && defined(NDEBUG)
82#warning "invalid configuration: cannot both define FLECS_DEBUG and NDEBUG"
83#endif
84
89#if !defined(FLECS_DEBUG) && !defined(FLECS_NDEBUG)
90#if defined(NDEBUG)
91#define FLECS_NDEBUG
92#else
93#define FLECS_DEBUG
94#endif
95#endif
96
101#ifdef FLECS_SANITIZE
102#ifndef FLECS_DEBUG
103#define FLECS_DEBUG /* If sanitized mode is enabled, so is debug mode */
104#endif
105#endif
106
111#ifdef FLECS_DEBUG
112#ifndef FLECS_DEBUG_INFO
113#define FLECS_DEBUG_INFO
114#endif
115#ifndef FLECS_EXCLUSIVE_ACCESS
116#define FLECS_EXCLUSIVE_ACCESS /* Enable exclusive access checks in debug mode */
117#endif
118#endif
119
120/* Tip: if you see weird behavior that you think might be a bug, make sure to
121 * test with the FLECS_DEBUG or FLECS_SANITIZE flags enabled. There's a good
122 * chance that this gives you more information about the issue! */
123
137// #define FLECS_SOFT_ASSERT
138
144// #define FLECS_KEEP_ASSERT
145
152// #define FLECS_DEFAULT_TO_UNCACHED_QUERIES
153
166// #define FLECS_CREATE_MEMBER_ENTITIES
167
176// #define FLECS_CPP_NO_AUTO_REGISTRATION
177
185// #define FLECS_CPP_NO_ENUM_REFLECTION
186
191// #define FLECS_NO_ALWAYS_INLINE
192
220// #define FLECS_CUSTOM_BUILD
221
222#ifndef FLECS_CUSTOM_BUILD
223#define FLECS_ALERTS
224#define FLECS_APP
225// #define FLECS_C /**< C API convenience macros, always enabled. */
226#define FLECS_CPP
227#define FLECS_DOC
228// #define FLECS_EXCLUSIVE_ACCESS /**< Enable exclusive world access checks. */
229// #define FLECS_JOURNAL /**< Journaling addon. */
230#define FLECS_JSON
231#define FLECS_HTTP
232#define FLECS_LOG
233#define FLECS_META
234#define FLECS_METRICS
235#define FLECS_MODULE
236#define FLECS_OS_API_IMPL
237// #define FLECS_PERF_TRACE /**< Enable performance tracing. */
238#define FLECS_PIPELINE
239#define FLECS_REST
240#define FLECS_PARSER
241#define FLECS_QUERY_DSL
242#define FLECS_SCRIPT
243// #define FLECS_SCRIPT_MATH /**< Math functions for Flecs script (may require linking with libm). */
244// #define FLECS_SCRIPT_PLATFORM /**< Platform constants for Flecs script. */
245#define FLECS_SYSTEM
246#define FLECS_STATS
247#define FLECS_TIMER
248#define FLECS_UNITS
249#endif // ifndef FLECS_CUSTOM_BUILD
250
254// #define FLECS_LOW_FOOTPRINT
255#ifdef FLECS_LOW_FOOTPRINT
256#define FLECS_HI_COMPONENT_ID 16
257#define FLECS_HI_ID_RECORD_ID 16
258#define FLECS_ENTITY_PAGE_BITS 6
259#define FLECS_USE_OS_ALLOC
260#define FLECS_DEFAULT_TO_UNCACHED_QUERIES
261#endif
262
277#ifndef FLECS_HI_COMPONENT_ID
278#define FLECS_HI_COMPONENT_ID 256
279#endif
280
287#ifndef FLECS_HI_ID_RECORD_ID
288#define FLECS_HI_ID_RECORD_ID 1024
289#endif
290
296#ifndef FLECS_SPARSE_PAGE_BITS
297#define FLECS_SPARSE_PAGE_BITS 6
298#endif
299
302#ifndef FLECS_ENTITY_PAGE_BITS
303#define FLECS_ENTITY_PAGE_BITS 10
304#endif
305
310// #define FLECS_USE_OS_ALLOC
311
314#ifndef FLECS_ID_DESC_MAX
315#define FLECS_ID_DESC_MAX 32
316#endif
317
320#ifndef FLECS_EVENT_DESC_MAX
321#define FLECS_EVENT_DESC_MAX 8
322#endif
323
326#define FLECS_VARIABLE_COUNT_MAX 64
327
330#ifndef FLECS_TERM_COUNT_MAX
331#define FLECS_TERM_COUNT_MAX 32
332#endif
333
336#ifndef FLECS_TERM_ARG_COUNT_MAX
337#define FLECS_TERM_ARG_COUNT_MAX 16
338#endif
339
342#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
343#define FLECS_QUERY_VARIABLE_COUNT_MAX 64
344#endif
345
348#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
349#define FLECS_QUERY_SCOPE_NESTING_MAX 8
350#endif
351
356#ifndef FLECS_DAG_DEPTH_MAX
357#define FLECS_DAG_DEPTH_MAX 128
358#endif
359
364#define FLECS_TREE_SPAWNER_DEPTH_CACHE_SIZE (6)
365
368#include "flecs/private/api_defines.h"
369
379typedef uint64_t ecs_id_t;
380
387
403typedef struct {
405 int32_t count;
406} ecs_type_t;
407
431
434
437
439typedef struct ecs_term_t ecs_term_t;
440
443
462
467
472typedef struct ecs_iter_t ecs_iter_t;
473
482typedef struct ecs_ref_t ecs_ref_t;
483
488
493
496
499
519typedef void ecs_poly_t;
520
523
530
533
536#include "flecs/datastructures/vec.h" /* Vector datatype */
537#include "flecs/datastructures/sparse.h" /* Sparse set */
538#include "flecs/datastructures/block_allocator.h" /* Block allocator */
539#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
540#include "flecs/datastructures/map.h" /* Map */
541#include "flecs/datastructures/allocator.h" /* Allocator */
542#include "flecs/datastructures/strbuf.h" /* String builder */
543#include "flecs/os_api.h" /* Abstraction for operating system functions */
544
545#ifdef __cplusplus
546extern "C" {
547#endif
548
573typedef void (*ecs_run_action_t)(
574 ecs_iter_t *it);
575
582typedef void (*ecs_iter_action_t)(
583 ecs_iter_t *it);
584
593 ecs_iter_t *it);
594
601 ecs_iter_t *it);
602
605 ecs_entity_t e1,
606 const void *ptr1,
607 ecs_entity_t e2,
608 const void *ptr2);
609
612 ecs_world_t* world,
613 ecs_table_t* table,
614 ecs_entity_t* entities,
615 void* ptr,
616 int32_t size,
617 int32_t lo,
618 int32_t hi,
619 ecs_order_by_action_t order_by);
620
622typedef uint64_t (*ecs_group_by_action_t)(
623 ecs_world_t *world,
624 ecs_table_t *table,
625 ecs_id_t group_id,
626 void *ctx);
627
629typedef void* (*ecs_group_create_action_t)(
630 ecs_world_t *world,
631 uint64_t group_id,
632 void *group_by_ctx); /* from ecs_query_desc_t */
633
636 ecs_world_t *world,
637 uint64_t group_id,
638 void *group_ctx, /* return value from ecs_group_create_action_t */
639 void *group_by_ctx); /* from ecs_query_desc_t */
640
642typedef void (*ecs_module_action_t)(
643 ecs_world_t *world);
644
646typedef void (*ecs_fini_action_t)(
647 ecs_world_t *world,
648 void *ctx);
649
651typedef void (*ecs_ctx_free_t)(
652 void *ctx);
653
655typedef int (*ecs_compare_action_t)(
656 const void *ptr1,
657 const void *ptr2);
658
660typedef uint64_t (*ecs_hash_value_action_t)(
661 const void *ptr);
662
664typedef void (*ecs_xtor_t)(
665 void *ptr,
666 int32_t count,
667 const ecs_type_info_t *type_info);
668
670typedef void (*ecs_copy_t)(
671 void *dst_ptr,
672 const void *src_ptr,
673 int32_t count,
674 const ecs_type_info_t *type_info);
675
677typedef void (*ecs_move_t)(
678 void *dst_ptr,
679 void *src_ptr,
680 int32_t count,
681 const ecs_type_info_t *type_info);
682
684typedef int (*ecs_cmp_t)(
685 const void *a_ptr,
686 const void *b_ptr,
687 const ecs_type_info_t *type_info);
688
690typedef bool (*ecs_equals_t)(
691 const void *a_ptr,
692 const void *b_ptr,
693 const ecs_type_info_t *type_info);
694
698typedef bool (*ecs_on_validate_t)(
699 ecs_world_t *world,
700 ecs_entity_t entity,
701 void *ptr);
702
704typedef void (*flecs_poly_dtor_t)(
705 ecs_poly_t *poly);
706
725
736
744
751#define EcsSelf (1llu << 63)
752
757#define EcsUp (1llu << 62)
758
763#define EcsTrav (1llu << 61)
764
769#define EcsCascade (1llu << 60)
770
775#define EcsDesc (1llu << 59)
776
781#define EcsIsVariable (1llu << 58)
782
787#define EcsIsEntity (1llu << 57)
788
793#define EcsIsName (1llu << 56)
794
799#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
800
805#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
806
821
843
884
913
921/* Flags that can be used to check which hooks a type has set */
922#define ECS_TYPE_HOOK_CTOR ECS_CAST(ecs_flags32_t, 1 << 0)
923#define ECS_TYPE_HOOK_DTOR ECS_CAST(ecs_flags32_t, 1 << 1)
924#define ECS_TYPE_HOOK_COPY ECS_CAST(ecs_flags32_t, 1 << 2)
925#define ECS_TYPE_HOOK_MOVE ECS_CAST(ecs_flags32_t, 1 << 3)
926#define ECS_TYPE_HOOK_COPY_CTOR ECS_CAST(ecs_flags32_t, 1 << 4)
927#define ECS_TYPE_HOOK_MOVE_CTOR ECS_CAST(ecs_flags32_t, 1 << 5)
928#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 6)
929#define ECS_TYPE_HOOK_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 7)
930#define ECS_TYPE_HOOK_CMP ECS_CAST(ecs_flags32_t, 1 << 8)
931#define ECS_TYPE_HOOK_EQUALS ECS_CAST(ecs_flags32_t, 1 << 9)
932
933
934/* Flags that can be used to set/check which hooks of a type are invalid */
935#define ECS_TYPE_HOOK_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 10)
936#define ECS_TYPE_HOOK_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 12)
937#define ECS_TYPE_HOOK_COPY_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 13)
938#define ECS_TYPE_HOOK_MOVE_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 14)
939#define ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 15)
940#define ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 16)
941#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 17)
942#define ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 18)
943#define ECS_TYPE_HOOK_CMP_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 19)
944#define ECS_TYPE_HOOK_EQUALS_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 20)
945
946/* Internal debug flag that indicates type hooks have been invoked */
947#define ECS_TYPE_HOOK_IN_USE ECS_CAST(ecs_flags32_t, 1 << 21)
948
949
950/* All valid hook flags */
951#define ECS_TYPE_HOOKS (ECS_TYPE_HOOK_CTOR|ECS_TYPE_HOOK_DTOR|\
952 ECS_TYPE_HOOK_COPY|ECS_TYPE_HOOK_MOVE|ECS_TYPE_HOOK_COPY_CTOR|\
953 ECS_TYPE_HOOK_MOVE_CTOR|ECS_TYPE_HOOK_CTOR_MOVE_DTOR|\
954 ECS_TYPE_HOOK_MOVE_DTOR|ECS_TYPE_HOOK_CMP|ECS_TYPE_HOOK_EQUALS)
955
956/* All invalid hook flags */
957#define ECS_TYPE_HOOKS_ILLEGAL (ECS_TYPE_HOOK_CTOR_ILLEGAL|\
958 ECS_TYPE_HOOK_DTOR_ILLEGAL|ECS_TYPE_HOOK_COPY_ILLEGAL|\
959 ECS_TYPE_HOOK_MOVE_ILLEGAL|ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL|\
960 ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL|ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL|\
961 ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL|ECS_TYPE_HOOK_CMP_ILLEGAL|\
962 ECS_TYPE_HOOK_EQUALS_ILLEGAL)
1032
1044
1045#include "flecs/private/api_types.h" /* Supporting API types */
1046#include "flecs/private/api_support.h" /* Supporting API functions */
1047#include "flecs/datastructures/hashmap.h" /* Hashmap */
1048#include "flecs/private/api_internals.h" /* Supporting API functions */
1049
1056
1061typedef struct ecs_entity_desc_t {
1062 int32_t _canary;
1068 const char *name;
1073 const char *sep;
1077 const char *root_sep;
1079 const char *symbol;
1095
1098
1100 const char *add_expr;
1102
1132
1146
1186 /* World */
1190 /* Matched data */
1191 int32_t offset;
1192 int32_t count;
1194 void **ptrs;
1196 const int16_t *columns;
1197 const ecs_size_t *sizes;
1202 ecs_flags64_t constrained_vars;
1203 ecs_termset_t set_fields;
1204 ecs_termset_t ref_fields;
1205 ecs_termset_t row_fields;
1206 ecs_termset_t up_fields;
1208 /* Input information */
1212 int32_t event_cur;
1214 /* Query information */
1216 int8_t term_index;
1221 /* Context */
1222 void *param;
1223 void *ctx;
1226 void *run_ctx;
1228 /* Time */
1232 /* Iterator counters */
1235 /* Misc */
1236 ecs_flags32_t flags;
1238 ecs_iter_private_t priv_;
1240 /* Chained iterators */
1245};
1246
1247
1252#define EcsQueryMatchPrefab (1u << 1u)
1253
1258#define EcsQueryMatchDisabled (1u << 2u)
1259
1264#define EcsQueryMatchEmptyTables (1u << 3u)
1265
1270#define EcsQueryAllowUnresolvedByName (1u << 6u)
1271
1276#define EcsQueryTableOnly (1u << 7u)
1277
1288#define EcsQueryDetectChanges (1u << 8u)
1289
1298#define EcsQueryGroupByOrdered (1u << 9u)
1299
1309#define EcsQueryGroupByDesc (1u << 10u)
1310
1311
1385
1446
1451typedef struct ecs_event_desc_t {
1454
1459
1462
1466
1468 int32_t offset;
1469
1473 int32_t count;
1474
1477
1482 void *param;
1483
1487 const void *const_param;
1488
1493 void *set_ptr;
1494
1497
1499 ecs_flags32_t flags;
1501
1502
1511typedef struct ecs_build_info_t {
1512 const char *compiler;
1513 const char **addons;
1514 const char **flags;
1515 const char *version;
1519 bool debug;
1523
1583
1591
1595typedef struct ecs_entity_range_t {
1596 uint32_t min;
1597 uint32_t max;
1598 uint32_t cur;
1599 ecs_vec_t recycled;
1601
1612typedef struct EcsIdentifier {
1613 char *value;
1614 ecs_size_t length;
1615 uint64_t hash;
1616 uint64_t index_hash;
1617 ecs_hashmap_t *index;
1619
1621typedef struct EcsComponent {
1622 ecs_size_t size;
1623 ecs_size_t alignment;
1625
1630
1639
1644
1646typedef struct {
1647 const char *child_name;
1649 uint32_t child;
1652
1654typedef struct {
1655 ecs_vec_t children;
1657
1668
1672/* Only include deprecated definitions if deprecated addon is required */
1673#ifdef FLECS_DEPRECATED
1675#endif
1676
1692FLECS_API extern const ecs_id_t ECS_PAIR;
1693
1695FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1696
1698FLECS_API extern const ecs_id_t ECS_TOGGLE;
1699
1701FLECS_API extern const ecs_id_t ECS_VALUE_PAIR;
1702
1710/* Built-in component IDs */
1711
1713FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1714
1716FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1717
1719FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1720
1722FLECS_API extern const ecs_entity_t ecs_id(EcsParent);
1723
1725FLECS_API extern const ecs_entity_t ecs_id(EcsTreeSpawner);
1726
1728FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1729
1731FLECS_API extern const ecs_entity_t EcsParentDepth;
1732
1734FLECS_API extern const ecs_entity_t EcsQuery;
1735
1737FLECS_API extern const ecs_entity_t EcsObserver;
1738
1740FLECS_API extern const ecs_entity_t EcsSystem;
1741
1743FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1744
1746FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1747
1749FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1750
1752FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1753
1755FLECS_API extern const ecs_entity_t EcsFlecs;
1756
1758FLECS_API extern const ecs_entity_t EcsFlecsCore;
1759
1761FLECS_API extern const ecs_entity_t EcsWorld;
1762
1764FLECS_API extern const ecs_entity_t EcsWildcard;
1765
1767FLECS_API extern const ecs_entity_t EcsAny;
1768
1770FLECS_API extern const ecs_entity_t EcsThis;
1771
1773FLECS_API extern const ecs_entity_t EcsVariable;
1774
1782FLECS_API extern const ecs_entity_t EcsTransitive;
1783
1791FLECS_API extern const ecs_entity_t EcsReflexive;
1792
1803FLECS_API extern const ecs_entity_t EcsFinal;
1804
1810FLECS_API extern const ecs_entity_t EcsInheritable;
1811
1813FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1814
1818FLECS_API extern const ecs_entity_t EcsOverride;
1819
1823FLECS_API extern const ecs_entity_t EcsInherit;
1824
1829FLECS_API extern const ecs_entity_t EcsDontInherit;
1830
1838FLECS_API extern const ecs_entity_t EcsSymmetric;
1839
1849FLECS_API extern const ecs_entity_t EcsExclusive;
1850
1852FLECS_API extern const ecs_entity_t EcsAcyclic;
1853
1856FLECS_API extern const ecs_entity_t EcsTraversable;
1857
1867FLECS_API extern const ecs_entity_t EcsWith;
1868
1878FLECS_API extern const ecs_entity_t EcsOneOf;
1879
1881FLECS_API extern const ecs_entity_t EcsCanToggle;
1882
1886FLECS_API extern const ecs_entity_t EcsTrait;
1887
1897FLECS_API extern const ecs_entity_t EcsRelationship;
1898
1908FLECS_API extern const ecs_entity_t EcsTarget;
1909
1912FLECS_API extern const ecs_entity_t EcsPairIsTag;
1913
1915FLECS_API extern const ecs_entity_t EcsName;
1916
1918FLECS_API extern const ecs_entity_t EcsSymbol;
1919
1921FLECS_API extern const ecs_entity_t EcsAlias;
1922
1924FLECS_API extern const ecs_entity_t EcsChildOf;
1925
1927FLECS_API extern const ecs_entity_t EcsIsA;
1928
1930FLECS_API extern const ecs_entity_t EcsDependsOn;
1931
1933FLECS_API extern const ecs_entity_t EcsSlotOf;
1934
1936FLECS_API extern const ecs_entity_t EcsOrderedChildren;
1937
1939FLECS_API extern const ecs_entity_t EcsModule;
1940
1943FLECS_API extern const ecs_entity_t EcsPrefab;
1944
1947FLECS_API extern const ecs_entity_t EcsDisabled;
1948
1952FLECS_API extern const ecs_entity_t EcsNotQueryable;
1953
1955FLECS_API extern const ecs_entity_t EcsOnAdd;
1956
1958FLECS_API extern const ecs_entity_t EcsOnRemove;
1959
1961FLECS_API extern const ecs_entity_t EcsOnSet;
1962
1964FLECS_API extern const ecs_entity_t EcsMonitor;
1965
1967FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1968
1970FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1971
1973FLECS_API extern const ecs_entity_t EcsOnDelete;
1974
1977FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1978
1981FLECS_API extern const ecs_entity_t EcsRemove;
1982
1985FLECS_API extern const ecs_entity_t EcsDelete;
1986
1989FLECS_API extern const ecs_entity_t EcsPanic;
1990
1993FLECS_API extern const ecs_entity_t EcsSingleton;
1994
1996FLECS_API extern const ecs_entity_t EcsSparse;
1997
1999FLECS_API extern const ecs_entity_t EcsDontFragment;
2000
2002FLECS_API extern const ecs_entity_t EcsPredEq;
2003
2005FLECS_API extern const ecs_entity_t EcsPredMatch;
2006
2008FLECS_API extern const ecs_entity_t EcsPredLookup;
2009
2011FLECS_API extern const ecs_entity_t EcsScopeOpen;
2012
2014FLECS_API extern const ecs_entity_t EcsScopeClose;
2015
2020FLECS_API extern const ecs_entity_t EcsEmpty;
2021
2022FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
2023FLECS_API extern const ecs_entity_t EcsOnStart;
2024FLECS_API extern const ecs_entity_t EcsPreFrame;
2025FLECS_API extern const ecs_entity_t EcsOnLoad;
2026FLECS_API extern const ecs_entity_t EcsPostLoad;
2027FLECS_API extern const ecs_entity_t EcsPreUpdate;
2028FLECS_API extern const ecs_entity_t EcsOnUpdate;
2029FLECS_API extern const ecs_entity_t EcsOnValidate;
2030FLECS_API extern const ecs_entity_t EcsPostUpdate;
2031FLECS_API extern const ecs_entity_t EcsPreStore;
2032FLECS_API extern const ecs_entity_t EcsOnStore;
2033FLECS_API extern const ecs_entity_t EcsPostFrame;
2034FLECS_API extern const ecs_entity_t EcsPhase;
2036FLECS_API extern const ecs_entity_t EcsConstant;
2040#define EcsLastInternalComponentId (ecs_id(EcsTreeSpawner))
2041
2044#define EcsFirstUserComponentId (8)
2045
2048#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
2049
2050/* When visualized, the reserved ID ranges look like this:
2051 * - [1..8]: Built-in components
2052 * - [9..FLECS_HI_COMPONENT_ID]: Low IDs reserved for application components
2053 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Built-in entities
2054 */
2055
2077FLECS_API
2079
2086FLECS_API
2088
2098FLECS_API
2100 int argc,
2101 char *argv[]);
2102
2109FLECS_API
2111 ecs_world_t *world);
2112
2120FLECS_API
2122 const ecs_world_t *world);
2123
2132FLECS_API
2134 ecs_world_t *world,
2135 ecs_fini_action_t action,
2136 void *ctx);
2137
2144
2171FLECS_API
2173 const ecs_world_t *world);
2174
2182FLECS_API
2184 const ecs_world_t *world);
2185
2211FLECS_API
2213 ecs_world_t *world,
2214 ecs_ftime_t delta_time);
2215
2222FLECS_API
2224 ecs_world_t *world);
2225
2234FLECS_API
2236 ecs_world_t *world,
2237 ecs_fini_action_t action,
2238 void *ctx);
2239
2246FLECS_API
2248 ecs_world_t *world);
2249
2256FLECS_API
2258 const ecs_world_t *world);
2259
2272 ecs_world_t *world,
2273 bool enable);
2274
2286 ecs_world_t *world,
2287 bool enable);
2288
2304FLECS_API
2306 ecs_world_t *world,
2307 ecs_ftime_t fps);
2308
2322FLECS_API
2324 ecs_world_t *world,
2325 ecs_flags32_t flags);
2326
2403FLECS_API
2405 ecs_world_t *world,
2406 bool multi_threaded);
2407
2415FLECS_API
2417 ecs_world_t *world);
2418
2424FLECS_API
2426 ecs_world_t *stage);
2427
2444FLECS_API
2446 ecs_world_t *world);
2447
2461FLECS_API
2463 ecs_world_t *world);
2464
2479FLECS_API
2481 ecs_world_t *world);
2482
2493FLECS_API
2495 ecs_world_t *world);
2496
2508FLECS_API
2510 const ecs_world_t *world);
2511
2523FLECS_API
2525 const ecs_world_t *world);
2526
2540FLECS_API
2542 ecs_world_t *world,
2543 int32_t stages);
2544
2551FLECS_API
2553 const ecs_world_t *world);
2554
2570FLECS_API
2572 const ecs_world_t *world,
2573 int32_t stage_id);
2574
2582FLECS_API
2584 const ecs_world_t *world);
2585
2593FLECS_API
2595 ecs_world_t *world);
2596
2601FLECS_API
2603 ecs_world_t *stage);
2604
2612FLECS_API
2614 const ecs_world_t *world);
2615
2631FLECS_API
2633 ecs_world_t *world,
2634 void *ctx,
2635 ecs_ctx_free_t ctx_free);
2636
2645FLECS_API
2647 ecs_world_t *world,
2648 void *ctx,
2649 ecs_ctx_free_t ctx_free);
2650
2658FLECS_API
2660 const ecs_world_t *world);
2661
2669FLECS_API
2671 const ecs_world_t *world);
2672
2678FLECS_API
2680
2686FLECS_API
2688 const ecs_world_t *world);
2689
2698FLECS_API
2700 ecs_world_t *world,
2701 int32_t entity_count);
2702
2717FLECS_API
2719 ecs_world_t *world);
2720
2735FLECS_API
2737 ecs_world_t *world,
2738 uint32_t min,
2739 uint32_t max);
2740
2755FLECS_API
2757 ecs_world_t *world,
2758 const ecs_entity_range_t *range);
2759
2767FLECS_API
2769 const ecs_world_t *world);
2770
2776FLECS_API
2778 const ecs_world_t *world);
2779
2793FLECS_API
2795 ecs_world_t *world,
2796 ecs_flags32_t flags);
2797
2813
2849FLECS_API
2851 ecs_world_t *world,
2852 const ecs_delete_empty_tables_desc_t *desc);
2853
2859FLECS_API
2861 const ecs_poly_t *poly);
2862
2868FLECS_API
2870 const ecs_poly_t *poly);
2871
2885FLECS_API
2887 const ecs_poly_t *object,
2888 int32_t type);
2889
2893#define flecs_poly_is(object, type)\
2894 flecs_poly_is_(object, type##_magic)
2895
2904FLECS_API
2906 ecs_entity_t first,
2907 ecs_entity_t second);
2908
2931FLECS_API
2933 ecs_world_t *world,
2934 const char *thread_name);
2935
2958FLECS_API
2960 ecs_world_t *world,
2961 bool lock_world);
2962
2989FLECS_API
2991 ecs_world_t *world);
2992
3010FLECS_API
3012 ecs_world_t *world);
3013
3021FLECS_API
3023 ecs_world_t *world,
3024 ecs_id_t component);
3025
3033FLECS_API
3035 ecs_world_t *world,
3036 ecs_table_t *table);
3037
3056FLECS_API
3058 ecs_world_t *world,
3059 const ecs_entity_desc_t *desc);
3060
3087FLECS_API
3089 ecs_world_t *world,
3090 const ecs_bulk_desc_t *desc);
3091
3101FLECS_API
3103 ecs_world_t *world,
3104 ecs_id_t component,
3105 int32_t count);
3106
3122FLECS_API
3124 ecs_world_t *world,
3125 ecs_entity_t dst,
3126 ecs_entity_t src,
3127 bool copy_value);
3128
3137FLECS_API
3139 ecs_world_t *world,
3140 ecs_entity_t entity);
3141
3149FLECS_API
3151 ecs_world_t *world,
3152 ecs_id_t component);
3153
3171FLECS_API
3173 ecs_world_t *world,
3174 ecs_entity_t parent,
3175 const ecs_entity_t *children,
3176 int32_t child_count);
3177
3187FLECS_API
3189 const ecs_world_t *world,
3190 ecs_entity_t parent);
3191
3209FLECS_API
3211 ecs_world_t *world,
3212 ecs_entity_t entity,
3213 ecs_id_t component);
3214
3223FLECS_API
3225 ecs_world_t *world,
3226 ecs_entity_t entity,
3227 ecs_id_t component);
3228
3280FLECS_API
3282 ecs_world_t *world,
3283 ecs_entity_t entity,
3284 ecs_id_t component);
3285
3292FLECS_API
3294 ecs_world_t *world,
3295 ecs_entity_t entity);
3296
3304FLECS_API
3306 ecs_world_t *world,
3307 ecs_id_t component);
3308
3324FLECS_API
3326 ecs_world_t *world,
3327 ecs_id_t component);
3328
3337FLECS_API
3339 const ecs_world_t *world);
3340
3359FLECS_API
3361 ecs_world_t *world,
3362 ecs_entity_t entity,
3363 bool enabled);
3364
3378FLECS_API
3380 ecs_world_t *world,
3381 ecs_entity_t entity,
3382 ecs_id_t component,
3383 bool enable);
3384
3395FLECS_API
3397 const ecs_world_t *world,
3398 ecs_entity_t entity,
3399 ecs_id_t component);
3400
3424FLECS_API
3425FLECS_ALWAYS_INLINE const void* ecs_get_id(
3426 const ecs_world_t *world,
3427 ecs_entity_t entity,
3428 ecs_id_t component);
3429
3444FLECS_API
3445FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
3446 const ecs_world_t *world,
3447 ecs_entity_t entity,
3448 ecs_id_t component);
3449
3464FLECS_API
3465FLECS_ALWAYS_INLINE void* ecs_get_sparse_id(
3466 const ecs_world_t *world,
3467 ecs_entity_t entity,
3468 ecs_id_t component,
3469 size_t size);
3470
3488FLECS_API
3490 ecs_world_t *world,
3491 ecs_entity_t entity,
3492 ecs_id_t component,
3493 size_t size);
3494
3505FLECS_ALWAYS_INLINE FLECS_API
3507 const ecs_world_t *world,
3508 ecs_entity_t entity,
3509 ecs_id_t component);
3510
3521FLECS_ALWAYS_INLINE FLECS_API
3523 const ecs_world_t *world,
3524 ecs_ref_t *ref,
3525 ecs_id_t component);
3526
3535FLECS_ALWAYS_INLINE FLECS_API
3537 const ecs_world_t *world,
3538 ecs_ref_t *ref,
3539 ecs_id_t component);
3540
3561FLECS_API
3563 ecs_world_t *world,
3564 ecs_entity_t entity,
3565 ecs_id_t component,
3566 size_t size,
3567 bool *is_new);
3568
3578FLECS_API
3580 ecs_world_t *world,
3581 ecs_entity_t entity,
3582 ecs_id_t component);
3583
3599FLECS_API
3601 ecs_world_t *world,
3602 ecs_entity_t entity,
3603 ecs_id_t component,
3604 size_t size,
3605 const void *ptr);
3606
3635FLECS_API
3637 const ecs_world_t *world,
3638 ecs_entity_t e);
3639
3669FLECS_API
3671 const ecs_world_t *world,
3672 ecs_entity_t e);
3673
3679FLECS_API
3681 ecs_entity_t e);
3682
3699FLECS_API
3701 const ecs_world_t *world,
3702 ecs_entity_t e);
3703
3726FLECS_API
3728 ecs_world_t *world,
3729 ecs_entity_t entity);
3730
3749FLECS_API
3751 ecs_world_t *world,
3752 ecs_id_t component);
3753
3761FLECS_API
3763 const ecs_world_t *world,
3764 ecs_entity_t entity);
3765
3780FLECS_API
3782 ecs_world_t *world,
3783 ecs_entity_t entity);
3784
3790FLECS_API
3792 ecs_entity_t entity);
3793
3809FLECS_API
3811 const ecs_world_t *world,
3812 ecs_entity_t entity);
3813
3820FLECS_API
3822 const ecs_world_t *world,
3823 ecs_entity_t entity);
3824
3832FLECS_API
3834 const ecs_world_t *world,
3835 const ecs_type_t* type);
3836
3848FLECS_API
3850 const ecs_world_t *world,
3851 const ecs_table_t *table);
3852
3867FLECS_API
3869 const ecs_world_t *world,
3870 ecs_entity_t entity);
3871
3882FLECS_API
3883FLECS_ALWAYS_INLINE bool ecs_has_id(
3884 const ecs_world_t *world,
3885 ecs_entity_t entity,
3886 ecs_id_t component);
3887
3898FLECS_API
3899FLECS_ALWAYS_INLINE bool ecs_owns_id(
3900 const ecs_world_t *world,
3901 ecs_entity_t entity,
3902 ecs_id_t component);
3903
3918FLECS_API
3920 const ecs_world_t *world,
3921 ecs_entity_t entity,
3922 ecs_entity_t rel,
3923 int32_t index);
3924
3938FLECS_API
3940 const ecs_world_t *world,
3941 ecs_entity_t entity);
3942
3956FLECS_API
3958 ecs_world_t *world,
3959 ecs_entity_t parent,
3960 const char *name);
3961
3982FLECS_API
3984 const ecs_world_t *world,
3985 ecs_entity_t entity,
3986 ecs_entity_t rel,
3987 ecs_id_t component);
3988
3999FLECS_API
4001 const ecs_world_t *world,
4002 ecs_entity_t entity,
4003 ecs_entity_t rel);
4004
4012FLECS_API
4014 const ecs_world_t *world,
4015 ecs_id_t entity);
4016
4036FLECS_API
4037const char* ecs_get_name(
4038 const ecs_world_t *world,
4039 ecs_entity_t entity);
4040
4050FLECS_API
4051const char* ecs_get_symbol(
4052 const ecs_world_t *world,
4053 ecs_entity_t entity);
4054
4068FLECS_API
4070 ecs_world_t *world,
4071 ecs_entity_t entity,
4072 const char *name);
4073
4087FLECS_API
4089 ecs_world_t *world,
4090 ecs_entity_t entity,
4091 const char *symbol);
4092
4104FLECS_API
4106 ecs_world_t *world,
4107 ecs_entity_t entity,
4108 const char *alias);
4109
4125FLECS_API
4127 const ecs_world_t *world,
4128 const char *path);
4129
4144FLECS_API
4146 const ecs_world_t *world,
4147 ecs_entity_t parent,
4148 const char *name);
4149
4172FLECS_API
4174 const ecs_world_t *world,
4175 ecs_entity_t parent,
4176 const char *path,
4177 const char *sep,
4178 const char *prefix,
4179 bool recursive);
4180
4198FLECS_API
4200 const ecs_world_t *world,
4201 const char *symbol,
4202 bool lookup_as_path,
4203 bool recursive);
4204
4226FLECS_API
4228 const ecs_world_t *world,
4229 ecs_entity_t parent,
4230 ecs_entity_t child,
4231 const char *sep,
4232 const char *prefix);
4233
4247FLECS_API
4249 const ecs_world_t *world,
4250 ecs_entity_t parent,
4251 ecs_entity_t child,
4252 const char *sep,
4253 const char *prefix,
4254 ecs_strbuf_t *buf,
4255 bool escape);
4256
4272FLECS_API
4274 ecs_world_t *world,
4275 ecs_entity_t parent,
4276 const char *path,
4277 const char *sep,
4278 const char *prefix);
4279
4294FLECS_API
4296 ecs_world_t *world,
4297 ecs_entity_t entity,
4298 ecs_entity_t parent,
4299 const char *path,
4300 const char *sep,
4301 const char *prefix);
4302
4316FLECS_API
4318 ecs_world_t *world,
4319 ecs_entity_t scope);
4320
4328FLECS_API
4330 const ecs_world_t *world);
4331
4341FLECS_API
4343 ecs_world_t *world,
4344 const char *prefix);
4345
4372FLECS_API
4374 ecs_world_t *world,
4375 const ecs_entity_t *lookup_path);
4376
4383FLECS_API
4385 const ecs_world_t *world);
4386
4411FLECS_API
4413 ecs_world_t *world,
4414 const ecs_component_desc_t *desc);
4415
4425FLECS_API
4427 const ecs_world_t *world,
4428 ecs_id_t component);
4429
4441FLECS_API
4443 ecs_world_t *world,
4444 ecs_entity_t component,
4445 const ecs_type_hooks_t *hooks);
4446
4453FLECS_API
4455 const ecs_world_t *world,
4456 ecs_entity_t component);
4457
4481FLECS_API
4483 const ecs_world_t *world,
4484 ecs_id_t component);
4485
4494FLECS_API
4496 const ecs_world_t *world,
4497 ecs_id_t component);
4498
4518FLECS_API
4520 const ecs_world_t *world,
4521 ecs_id_t component);
4522
4531FLECS_API
4533 ecs_id_t component,
4534 ecs_id_t pattern);
4535
4541FLECS_API
4543 ecs_id_t component);
4544
4550FLECS_API
4552 ecs_id_t component);
4553
4560 ecs_id_t component);
4561
4575FLECS_API
4577 const ecs_world_t *world,
4578 ecs_id_t component);
4579
4588FLECS_API
4589ecs_flags32_t ecs_id_get_flags(
4590 const ecs_world_t *world,
4591 ecs_id_t component);
4592
4603FLECS_API
4605 uint64_t component_flags);
4606
4622FLECS_API
4624 const ecs_world_t *world,
4625 ecs_id_t component);
4626
4634FLECS_API
4636 const ecs_world_t *world,
4637 ecs_id_t component,
4638 ecs_strbuf_t *buf);
4639
4648FLECS_API
4650 const ecs_world_t *world,
4651 const char *expr);
4652
4668FLECS_API
4670 const ecs_term_ref_t *ref);
4671
4683FLECS_API
4685 const ecs_term_t *term);
4686
4701FLECS_API
4703 const ecs_term_t *term);
4704
4717FLECS_API
4719 const ecs_term_t *term);
4720
4729FLECS_API
4731 const ecs_world_t *world,
4732 const ecs_term_t *term);
4733
4741FLECS_API
4743 const ecs_query_t *query);
4744
4785FLECS_API
4787 const ecs_world_t *world,
4788 ecs_id_t component);
4789
4795FLECS_API
4797 ecs_iter_t *it);
4798
4821FLECS_API
4822FLECS_ALWAYS_INLINE ecs_iter_t ecs_children(
4823 const ecs_world_t *world,
4824 ecs_entity_t parent);
4825
4833FLECS_API
4834FLECS_ALWAYS_INLINE ecs_iter_t ecs_children_w_rel(
4835 const ecs_world_t *world,
4836 ecs_entity_t relationship,
4837 ecs_entity_t parent);
4838
4844FLECS_API
4846 ecs_iter_t *it);
4847
4866FLECS_API
4868 ecs_world_t *world,
4869 const ecs_query_desc_t *desc);
4870
4881FLECS_API
4883 ecs_world_t *world,
4884 ecs_entity_t entity,
4885 const ecs_query_desc_t *desc);
4886
4891FLECS_API
4893 ecs_query_t *query);
4894
4903FLECS_API
4905 const ecs_query_t *query,
4906 const char *name);
4907
4915FLECS_API
4917 const ecs_query_t *query,
4918 int32_t var_id);
4919
4930FLECS_API
4932 const ecs_query_t *query,
4933 int32_t var_id);
4934
5003FLECS_API
5005 const ecs_world_t *world,
5006 const ecs_query_t *query);
5007
5015FLECS_API
5017 ecs_iter_t *it);
5018
5037FLECS_API
5039 const ecs_query_t *query,
5040 ecs_entity_t entity,
5041 ecs_iter_t *it);
5042
5061FLECS_API
5063 const ecs_query_t *query,
5064 ecs_table_t *table,
5065 ecs_iter_t *it);
5066
5093FLECS_API
5095 const ecs_query_t *query,
5096 ecs_table_range_t *range,
5097 ecs_iter_t *it);
5098
5106FLECS_API
5108 const ecs_query_t *query);
5109
5119FLECS_API
5121 const ecs_query_t *query);
5122
5137FLECS_API
5139 const ecs_query_t *query,
5140 const ecs_iter_t *it);
5141
5147FLECS_API
5149 const ecs_query_t *query);
5150
5168FLECS_API
5170 ecs_query_t *query,
5171 ecs_iter_t *it,
5172 const char *expr);
5173
5196FLECS_API
5198 ecs_query_t *query);
5199
5208FLECS_API
5210 const ecs_world_t *world,
5211 ecs_entity_t query);
5212
5223FLECS_API
5225 ecs_iter_t *it);
5226
5249FLECS_API
5251 ecs_iter_t *it,
5252 uint64_t group_id);
5253
5279FLECS_API
5280const ecs_map_t* ecs_query_get_groups(
5281 const ecs_query_t *query);
5282
5291FLECS_API
5293 const ecs_query_t *query,
5294 uint64_t group_id);
5295
5304FLECS_API
5306 const ecs_query_t *query,
5307 uint64_t group_id);
5308
5317
5324FLECS_API
5326 const ecs_query_t *query);
5327
5333FLECS_API
5335 const ecs_query_t *query);
5336
5345FLECS_API
5347 const ecs_query_t *query);
5348
5377FLECS_API
5379 ecs_world_t *world,
5380 ecs_event_desc_t *desc);
5381
5392FLECS_API
5394 ecs_world_t *world,
5395 ecs_event_desc_t *desc);
5396
5411FLECS_API
5413 ecs_world_t *world,
5414 const ecs_observer_desc_t *desc);
5415
5431FLECS_API
5433 ecs_world_t *world,
5434 ecs_entity_t observer,
5435 const ecs_observer_desc_t *desc);
5436
5445FLECS_API
5447 const ecs_world_t *world,
5448 ecs_entity_t observer);
5449
5472FLECS_API
5474 ecs_iter_t *it);
5475
5485FLECS_API
5487 ecs_iter_t *it);
5488
5500FLECS_API
5502 ecs_iter_t *it);
5503
5516FLECS_API
5518 ecs_iter_t *it);
5519
5527FLECS_API
5529 ecs_iter_t *it);
5530
5569FLECS_API
5571 ecs_iter_t *it,
5572 int32_t var_id,
5573 ecs_entity_t entity);
5574
5585FLECS_API
5587 ecs_iter_t *it,
5588 int32_t var_id,
5589 const ecs_table_t *table);
5590
5601FLECS_API
5603 ecs_iter_t *it,
5604 int32_t var_id,
5605 const ecs_table_range_t *range);
5606
5619FLECS_API
5621 ecs_iter_t *it,
5622 int32_t var_id);
5623
5630FLECS_API
5632 const ecs_iter_t *it,
5633 int32_t var_id);
5634
5640FLECS_API
5642 const ecs_iter_t *it);
5643
5649FLECS_API
5651 const ecs_iter_t *it);
5652
5666FLECS_API
5668 ecs_iter_t *it,
5669 int32_t var_id);
5670
5684FLECS_API
5686 ecs_iter_t *it,
5687 int32_t var_id);
5688
5700FLECS_API
5702 ecs_iter_t *it,
5703 int32_t var_id);
5704
5716FLECS_API
5718 const ecs_iter_t *it);
5719
5731FLECS_API
5733 ecs_iter_t *it);
5734
5746FLECS_API
5748 const ecs_iter_t *it);
5749
5765FLECS_API
5767 const ecs_iter_t *it,
5768 int32_t offset,
5769 int32_t limit);
5770
5777FLECS_API
5779 ecs_iter_t *it);
5780
5801FLECS_API
5803 const ecs_iter_t *it,
5804 int32_t index,
5805 int32_t count);
5806
5813FLECS_API
5815 ecs_iter_t *it);
5816
5858FLECS_API
5860 const ecs_iter_t *it,
5861 size_t size,
5862 int8_t index);
5863
5886FLECS_API
5888 const ecs_iter_t *it,
5889 size_t size,
5890 int8_t index,
5891 int32_t row);
5892
5901FLECS_API
5903 const ecs_iter_t *it,
5904 int8_t index);
5905
5916FLECS_API
5918 const ecs_iter_t *it,
5919 int8_t index);
5920
5927FLECS_API
5929 const ecs_iter_t *it,
5930 int8_t index);
5931
5938FLECS_API
5940 const ecs_iter_t *it,
5941 int8_t index);
5942
5951FLECS_API
5953 const ecs_iter_t *it,
5954 int8_t index);
5955
5963FLECS_API
5965 const ecs_iter_t *it,
5966 int8_t index);
5967
5975FLECS_API
5977 const ecs_iter_t *it,
5978 int8_t index);
5979
5993FLECS_API
5995 const ecs_iter_t *it,
5996 int8_t index);
5997
6013FLECS_API
6015 const ecs_table_t *table);
6016
6027FLECS_API
6029 const ecs_world_t *world,
6030 const ecs_table_t *table,
6031 ecs_id_t component);
6032
6042FLECS_API
6044 const ecs_world_t *world,
6045 const ecs_table_t *table,
6046 ecs_id_t component);
6047
6055FLECS_API
6057 const ecs_table_t *table);
6058
6072FLECS_API
6074 const ecs_table_t *table,
6075 int32_t index);
6076
6085FLECS_API
6087 const ecs_table_t *table,
6088 int32_t index);
6089
6098FLECS_API
6100 const ecs_table_t *table,
6101 int32_t index,
6102 int32_t offset);
6103
6113FLECS_API
6115 const ecs_world_t *world,
6116 const ecs_table_t *table,
6117 ecs_id_t component,
6118 int32_t offset);
6119
6127FLECS_API
6129 const ecs_table_t *table,
6130 int32_t index);
6131
6138FLECS_API
6140 const ecs_table_t *table);
6141
6149FLECS_API
6151 const ecs_table_t *table);
6152
6159FLECS_API
6161 const ecs_table_t *table);
6162
6173FLECS_API
6175 const ecs_world_t *world,
6176 const ecs_table_t *table,
6177 ecs_id_t component);
6178
6189FLECS_API
6191 const ecs_world_t *world,
6192 const ecs_table_t *table,
6193 ecs_entity_t relationship,
6194 int32_t index);
6195
6206FLECS_API
6208 const ecs_world_t *world,
6209 const ecs_table_t *table,
6210 ecs_entity_t rel);
6211
6221FLECS_API
6223 ecs_world_t *world,
6224 ecs_table_t *table,
6225 ecs_id_t component);
6226
6237FLECS_API
6239 ecs_world_t *world,
6240 const ecs_id_t *ids,
6241 int32_t id_count);
6242
6252FLECS_API
6254 ecs_world_t *world,
6255 ecs_table_t *table,
6256 ecs_id_t component);
6257
6273FLECS_API
6275 ecs_world_t *world,
6276 ecs_table_t *table);
6277
6284FLECS_API
6286 ecs_world_t *world,
6287 ecs_table_t *table);
6288
6298FLECS_API
6300 ecs_table_t *table,
6301 ecs_flags32_t flags);
6302
6310FLECS_API
6312 const ecs_table_t *table);
6313
6323FLECS_API
6325 ecs_world_t* world,
6326 ecs_table_t* table,
6327 int32_t row_1,
6328 int32_t row_2);
6329
6354FLECS_API
6356 ecs_world_t *world,
6357 ecs_entity_t entity,
6358 ecs_record_t *record,
6359 ecs_table_t *table,
6360 const ecs_type_t *added,
6361 const ecs_type_t *removed);
6362
6363
6383FLECS_API
6385 const ecs_world_t *world,
6386 const ecs_table_t *table,
6387 ecs_id_t component,
6388 ecs_id_t *component_out);
6389
6425FLECS_API
6427 const ecs_world_t *world,
6428 const ecs_table_t *table,
6429 int32_t offset,
6430 ecs_id_t component,
6431 ecs_id_t *component_out);
6432
6473FLECS_API
6475 const ecs_world_t *world,
6476 const ecs_table_t *table,
6477 int32_t offset,
6478 ecs_id_t component,
6479 ecs_entity_t rel,
6480 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
6481 ecs_entity_t *tgt_out,
6482 ecs_id_t *component_out,
6483 struct ecs_table_record_t **tr_out);
6484
6500FLECS_API
6502 const ecs_world_t *world,
6503 ecs_entity_t entity,
6504 ecs_id_t id,
6505 ecs_entity_t rel,
6506 bool self,
6508 ecs_entity_t *tgt_out,
6509 ecs_id_t *id_out,
6510 struct ecs_table_record_t **tr_out);
6511
6519FLECS_API
6521 ecs_world_t* world,
6522 ecs_table_t* table);
6523
6537#include "flecs/addons/flecs_c.h"
6538
6539#ifdef __cplusplus
6540}
6541#endif
6542
6543#include "flecs/private/addons.h"
6544
6545#endif
The deprecated addon contains deprecated operations.
Extends the core API with convenience macros for C applications.
void ecs_remove_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Remove a component from an entity.
void ecs_auto_override_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Add an auto override for a component.
void ecs_remove_all(ecs_world_t *world, ecs_id_t component)
Remove all instances of the specified component.
void ecs_clear(ecs_world_t *world, ecs_entity_t entity)
Clear all components.
ecs_id_t ecs_get_with(const ecs_world_t *world)
Get the component set with ecs_set_with().
void ecs_add_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Add a (component) ID to an entity.
ecs_entity_t ecs_set_with(ecs_world_t *world, ecs_id_t component)
Create new entities with a specified component.
struct ecs_value_t ecs_value_t
Value of a dynamic type.
struct EcsIdentifier EcsIdentifier
A (string) identifier.
struct EcsTreeSpawner EcsTreeSpawner
Tree instantiation cache component.
struct EcsPoly EcsPoly
Component for storing a poly object.
struct EcsDefaultChildComponent EcsDefaultChildComponent
When added to an entity, this informs serialization formats which component to use when a value is as...
struct EcsParent EcsParent
Non-fragmenting ChildOf relationship.
struct EcsComponent EcsComponent
Component information.
const ecs_entity_t EcsScopeClose
Marker used to indicate the end of a scope (}) in queries.
const ecs_entity_t EcsOnRemove
Event that triggers when an ID is removed from an entity.
const ecs_entity_t EcsThis
This entity.
const ecs_entity_t EcsWildcard
Wildcard entity ("*").
const ecs_entity_t EcsName
Tag to indicate name identifier.
const ecs_entity_t EcsAcyclic
Mark a relationship as acyclic.
const ecs_entity_t EcsSymmetric
Mark relationship as commutative.
const ecs_entity_t EcsAlias
Tag to indicate alias identifier.
const ecs_entity_t EcsOnSet
Event that triggers when a component is set for an entity.
const ecs_entity_t EcsReflexive
Mark a relationship as reflexive.
const ecs_entity_t EcsTrait
Can be added to components to indicate it is a trait.
const ecs_entity_t EcsEmpty
Tag used to indicate a query is empty.
const ecs_entity_t EcsOneOf
Ensure that a relationship target is a child of the specified entity.
const ecs_entity_t EcsOnTableDelete
Event that triggers when a table is deleted.
const ecs_entity_t EcsOnTableCreate
Event that triggers when a table is created.
const ecs_entity_t EcsObserver
Tag added to observers.
const ecs_entity_t EcsQuery
Tag added to queries.
const ecs_entity_t EcsRelationship
Ensure that an entity is always used in a pair as a relationship.
const ecs_entity_t EcsSingleton
Mark component as singleton.
const ecs_entity_t EcsOnStart
OnStart pipeline phase.
const ecs_entity_t EcsNotQueryable
Trait added to entities that should never be returned by queries.
const ecs_entity_t EcsOnStore
OnStore pipeline phase.
const ecs_entity_t EcsOrderedChildren
Tag that, when added to a parent, ensures stable order of ecs_children() results.
const ecs_entity_t EcsDontFragment
Mark component as non-fragmenting.
const ecs_entity_t EcsTraversable
Mark a relationship as traversable.
const ecs_entity_t EcsPredLookup
Marker used to indicate $var ~= "pattern" matching in queries.
const ecs_entity_t EcsPreStore
PreStore pipeline phase.
const ecs_entity_t EcsOnLoad
OnLoad pipeline phase.
const ecs_entity_t EcsIsA
Used to express inheritance relationships.
const ecs_entity_t EcsExclusive
Can be added to a relationship to indicate that the relationship can only occur once on an entity.
const ecs_entity_t EcsSymbol
Tag to indicate symbol identifier.
const ecs_entity_t EcsDependsOn
Used to express dependency relationships.
const ecs_entity_t EcsTransitive
Mark a relationship as transitive.
const ecs_entity_t EcsDelete
Delete cleanup policy.
const ecs_entity_t EcsChildOf
Used to express parent-child relationships.
const ecs_entity_t EcsFlecsCore
Core module scope.
const ecs_entity_t EcsMonitor
Event that triggers an observer when an entity starts or stops matching a query.
const ecs_entity_t EcsCanToggle
Mark a component as toggleable with ecs_enable_id().
const ecs_entity_t EcsPredEq
Marker used to indicate $var == ... matching in queries.
const ecs_entity_t EcsPhase
Phase pipeline phase.
const ecs_entity_t EcsWorld
Entity associated with world (used for "attaching" components to world).
const ecs_entity_t EcsScopeOpen
Marker used to indicate the start of a scope ({) in queries.
const ecs_entity_t EcsPostUpdate
PostUpdate pipeline phase.
const ecs_entity_t EcsOnValidate
OnValidate pipeline phase.
const ecs_entity_t EcsRemove
Remove cleanup policy.
const ecs_entity_t EcsOverride
Override component on instantiate.
const ecs_entity_t EcsPredMatch
Marker used to indicate $var == "name" matching in queries.
const ecs_entity_t EcsInherit
Inherit component on instantiate.
const ecs_entity_t EcsSlotOf
Used to express a slot (used with prefab inheritance).
const ecs_entity_t EcsModule
Tag added to module entities.
const ecs_entity_t EcsSparse
Mark component as sparse.
const ecs_entity_t EcsPreUpdate
PreUpdate pipeline phase.
const ecs_entity_t EcsOnAdd
Event that triggers when an ID is added to an entity.
const ecs_entity_t EcsPrefab
Tag added to prefab entities.
const ecs_entity_t EcsOnInstantiate
Relationship that specifies component inheritance behavior.
const ecs_entity_t EcsPostFrame
PostFrame pipeline phase.
const ecs_entity_t EcsInheritable
Mark component as inheritable.
const ecs_entity_t EcsAny
Any entity ("_").
const ecs_entity_t EcsTarget
Ensure that an entity is always used in a pair as a target.
const ecs_entity_t EcsParentDepth
Relationship storing the entity's depth in a non-fragmenting hierarchy.
const ecs_entity_t EcsWith
Ensure that a component is always added together with another component.
const ecs_entity_t EcsPostLoad
PostLoad pipeline phase.
const ecs_entity_t EcsOnDelete
Relationship used for specifying cleanup behavior.
const ecs_entity_t EcsOnDeleteTarget
Relationship used to define what should happen when a target entity (second element of a pair) is del...
const ecs_entity_t EcsPreFrame
PreFrame pipeline phase.
const ecs_entity_t EcsFlecs
Root scope for built-in Flecs entities.
const ecs_entity_t EcsSystem
Tag added to systems.
const ecs_entity_t EcsOnUpdate
OnUpdate pipeline phase.
const ecs_entity_t EcsDisabled
When this tag is added to an entity, it is skipped by queries, unless EcsDisabled is explicitly queri...
const ecs_entity_t EcsDontInherit
Never inherit component on instantiate.
const ecs_entity_t EcsPairIsTag
Can be added to a relationship to indicate that it should never hold data, even when it or the relati...
const ecs_entity_t EcsPanic
Panic cleanup policy.
const ecs_entity_t EcsFinal
Ensure that an entity or component cannot be used as a target in an IsA relationship.
const ecs_entity_t EcsVariable
Variable entity ("$").
const ecs_entity_t EcsConstant
Tag added to enum or bitmask constants.
FLECS_API const ecs_entity_t ecs_id(EcsDocDescription)
Component ID for EcsDocDescription.
ecs_world_t * ecs_stage_new(ecs_world_t *world)
Create an unmanaged stage.
bool ecs_defer_end(ecs_world_t *world)
End a block of operations to defer.
bool ecs_readonly_begin(ecs_world_t *world, bool multi_threaded)
Begin readonly mode.
void ecs_defer_resume(ecs_world_t *world)
Resume deferring.
bool ecs_defer_begin(ecs_world_t *world)
Defer operations until the end of the frame.
void ecs_defer_suspend(ecs_world_t *world)
Suspend deferring but do not flush queue.
bool ecs_is_deferred(const ecs_world_t *world)
Test if deferring is enabled for the current stage.
void ecs_stage_free(ecs_world_t *stage)
Free an unmanaged stage.
void ecs_merge(ecs_world_t *stage)
Merge a stage.
int32_t ecs_stage_get_id(const ecs_world_t *world)
Get the stage ID.
bool ecs_stage_is_readonly(const ecs_world_t *world)
Test whether the current world is readonly.
int32_t ecs_get_stage_count(const ecs_world_t *world)
Get the number of configured stages.
ecs_world_t * ecs_get_stage(const ecs_world_t *world, int32_t stage_id)
Get stage-specific world pointer.
void ecs_set_stage_count(ecs_world_t *world, int32_t stages)
Configure the world to have N stages.
void ecs_readonly_end(ecs_world_t *world)
End readonly mode.
bool ecs_is_defer_suspended(const ecs_world_t *world)
Test if deferring is suspended for the current stage.
const ecs_type_hooks_t * ecs_get_hooks_id(const ecs_world_t *world, ecs_entity_t component)
Get hooks for a component.
ecs_entity_t ecs_component_init(ecs_world_t *world, const ecs_component_desc_t *desc)
Find or create a component.
const ecs_type_info_t * ecs_get_type_info(const ecs_world_t *world, ecs_id_t component)
Get the type info for a component.
struct ecs_component_desc_t ecs_component_desc_t
Used with ecs_component_init().
void ecs_set_hooks_id(ecs_world_t *world, ecs_entity_t component, const ecs_type_hooks_t *hooks)
Register hooks for a component.
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:498
struct ecs_header_t ecs_header_t
Header for ecs_poly_t objects.
struct ecs_stage_t ecs_stage_t
A stage enables modification while iterating and from multiple threads.
Definition flecs.h:433
struct ecs_ref_t ecs_ref_t
A ref is a fast way to fetch a component for a specific entity.
Definition flecs.h:482
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:386
struct ecs_table_record_t ecs_table_record_t
Opaque type for table record.
Definition flecs.h:532
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:430
struct ecs_mixins_t ecs_mixins_t
Type that stores poly mixins.
Definition flecs.h:522
uint64_t ecs_id_t
IDs are the things that can be added to an entity.
Definition flecs.h:379
struct ecs_observable_t ecs_observable_t
An observable produces events that can be listened for by an observer.
Definition flecs.h:466
struct ecs_record_t ecs_record_t
Information about an entity, like its table and row.
Definition flecs.h:495
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:436
void ecs_poly_t
A poly object.
Definition flecs.h:519
ecs_entity_t ecs_new_low_id(ecs_world_t *world)
Create new low ID.
void ecs_set_child_order(ecs_world_t *world, ecs_entity_t parent, const ecs_entity_t *children, int32_t child_count)
Set child order for parent with OrderedChildren.
const ecs_entity_t * ecs_bulk_init(ecs_world_t *world, const ecs_bulk_desc_t *desc)
Bulk create or populate new entities.
ecs_entity_t ecs_clone(ecs_world_t *world, ecs_entity_t dst, ecs_entity_t src, bool copy_value)
Clone an entity.
ecs_entity_t ecs_new(ecs_world_t *world)
Create new entity ID.
ecs_entity_t ecs_entity_init(ecs_world_t *world, const ecs_entity_desc_t *desc)
Find or create an entity.
void ecs_delete(ecs_world_t *world, ecs_entity_t entity)
Delete an entity.
void ecs_delete_with(ecs_world_t *world, ecs_id_t component)
Delete all entities with the specified component.
ecs_entity_t ecs_new_w_id(ecs_world_t *world, ecs_id_t component)
Create new entity with (component) ID.
ecs_entity_t ecs_new_w_table(ecs_world_t *world, ecs_table_t *table)
Create new entity in table.
const ecs_entity_t * ecs_bulk_new_w_id(ecs_world_t *world, ecs_id_t component, int32_t count)
Create N new entities.
ecs_entities_t ecs_get_ordered_children(const ecs_world_t *world, ecs_entity_t parent)
Get ordered children.
bool ecs_children_next(ecs_iter_t *it)
Progress an iterator created with ecs_children().
ecs_iter_t ecs_each_id(const ecs_world_t *world, ecs_id_t component)
Iterate all entities with a specified (component ID).
bool ecs_each_next(ecs_iter_t *it)
Progress an iterator created with ecs_each_id().
ecs_iter_t ecs_children(const ecs_world_t *world, ecs_entity_t parent)
Iterate children of a parent.
ecs_iter_t ecs_children_w_rel(const ecs_world_t *world, ecs_entity_t relationship, ecs_entity_t parent)
Same as ecs_children(), but with a custom relationship argument.
void ecs_enable_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component, bool enable)
Enable or disable a component.
bool ecs_is_enabled_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Test if a component is enabled.
void ecs_enable(ecs_world_t *world, ecs_entity_t entity, bool enabled)
Enable or disable an entity.
struct ecs_bulk_desc_t ecs_bulk_desc_t
Used with ecs_bulk_init().
struct ecs_entity_desc_t ecs_entity_desc_t
Used with ecs_entity_init().
char * ecs_entity_str(const ecs_world_t *world, ecs_entity_t entity)
Convert an entity to a string.
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_entity_t ecs_get_parent(const ecs_world_t *world, ecs_entity_t entity)
Get the parent (target of the ChildOf relationship) for an entity.
ecs_entity_t ecs_get_target_for_id(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, ecs_id_t component)
Get the target of a relationship for a given component.
const ecs_type_t * ecs_get_type(const ecs_world_t *world, ecs_entity_t entity)
Get the type of an entity.
bool ecs_owns_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Test if an entity owns a component.
char * ecs_type_str(const ecs_world_t *world, const ecs_type_t *type)
Convert a type to a string.
char * ecs_table_str(const ecs_world_t *world, const ecs_table_t *table)
Convert a table to a string.
int32_t ecs_count_id(const ecs_world_t *world, ecs_id_t entity)
Count entities that have the specified ID.
int32_t ecs_get_depth(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel)
Return the depth for an entity in the tree for the specified relationship.
ecs_table_t * ecs_get_table(const ecs_world_t *world, ecs_entity_t entity)
Get the table of an entity.
ecs_entity_t ecs_new_w_parent(ecs_world_t *world, ecs_entity_t parent, const char *name)
Create child with Parent component.
bool ecs_has_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Test if an entity has a component.
void(* ecs_module_action_t)(ecs_world_t *world)
Initialization action for modules.
Definition flecs.h:642
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:622
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:684
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:660
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:635
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:600
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:629
bool(* ecs_on_validate_t)(ecs_world_t *world, ecs_entity_t entity, void *ptr)
On validate hook.
Definition flecs.h:698
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:611
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:592
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:582
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:670
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:690
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:655
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:646
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:677
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:704
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:573
void(* ecs_ctx_free_t)(void *ctx)
Function to clean up context data.
Definition flecs.h:651
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:604
void(* ecs_xtor_t)(void *ptr, int32_t count, const ecs_type_info_t *type_info)
Constructor/destructor callback.
Definition flecs.h:664
void * ecs_ref_get_id(const ecs_world_t *world, ecs_ref_t *ref, ecs_id_t component)
Get a component from a ref.
void * ecs_emplace_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component, size_t size, bool *is_new)
Emplace a component.
void ecs_ref_update(const ecs_world_t *world, ecs_ref_t *ref, ecs_id_t component)
Update a ref.
const void * ecs_get_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Get an immutable pointer to a component.
void ecs_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Signal that a component has been modified.
ecs_ref_t ecs_ref_init_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Create a component ref.
void * ecs_get_mut_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component)
Get a mutable pointer to a component.
void * ecs_ensure_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component, size_t size)
Ensure an entity has a component and return a pointer.
void ecs_set_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t component, size_t size, const void *ptr)
Set the value of a component.
void * ecs_get_sparse_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t component, size_t size)
Get a pointer to a sparse component.
const ecs_id_t ECS_PAIR
Indicate that the ID is a pair.
const ecs_id_t ECS_AUTO_OVERRIDE
Automatically override component when it is inherited.
const ecs_id_t ECS_TOGGLE
Add a bitset to storage, which allows a component to be enabled or disabled.
const ecs_id_t ECS_VALUE_PAIR
Indicate that the target of a pair is an integer value.
char * ecs_id_str(const ecs_world_t *world, ecs_id_t component)
Convert a component ID to a string.
bool ecs_id_is_tag(const ecs_world_t *world, ecs_id_t component)
Return whether a specified component is a tag.
ecs_flags32_t ecs_id_get_flags(const ecs_world_t *world, ecs_id_t component)
Get flags associated with an ID.
bool ecs_id_is_valid(const ecs_world_t *world, ecs_id_t component)
Utility to check if an ID is valid.
const char * ecs_id_flag_str(uint64_t component_flags)
Convert a component flag to a string.
bool ecs_id_in_use(const ecs_world_t *world, ecs_id_t component)
Return whether a specified component is in use.
bool ecs_id_match(ecs_id_t component, ecs_id_t pattern)
Utility to match a component with a pattern.
void ecs_id_str_buf(const ecs_world_t *world, ecs_id_t component, ecs_strbuf_t *buf)
Write a component string to a buffer.
bool ecs_id_is_pair(ecs_id_t component)
Utility to check if a component is a pair.
ecs_entity_t ecs_get_typeid(const ecs_world_t *world, ecs_id_t component)
Get the type for a component.
ecs_id_t ecs_id_from_str(const ecs_world_t *world, const char *expr)
Convert a string to a component.
bool ecs_id_is_wildcard(ecs_id_t component)
Utility to check if a component is a wildcard.
bool ecs_id_is_any(ecs_id_t component)
Utility to check if a component is an any wildcard.
ecs_entity_t ecs_field_src(const ecs_iter_t *it, int8_t index)
Return the field source.
bool ecs_iter_changed(ecs_iter_t *it)
Return whether the current iterator result has changed.
bool ecs_field_is_writeonly(const ecs_iter_t *it, int8_t index)
Test whether the field is write-only.
ecs_var_t * ecs_iter_get_vars(const ecs_iter_t *it)
Get the variable array.
bool ecs_field_is_readonly(const ecs_iter_t *it, int8_t index)
Test whether the field is read-only.
const char * ecs_iter_get_var_name(const ecs_iter_t *it, int32_t var_id)
Get the variable name.
ecs_iter_t ecs_worker_iter(const ecs_iter_t *it, int32_t index, int32_t count)
Create a worker iterator.
bool ecs_iter_is_true(ecs_iter_t *it)
Test if an iterator is true.
void ecs_iter_fini(ecs_iter_t *it)
Clean up iterator resources.
char * ecs_iter_str(const ecs_iter_t *it)
Convert an iterator to a string.
bool ecs_iter_var_is_constrained(ecs_iter_t *it, int32_t var_id)
Return whether a variable is constrained.
ecs_iter_t ecs_page_iter(const ecs_iter_t *it, int32_t offset, int32_t limit)
Create a paged iterator.
int32_t ecs_iter_get_var_count(const ecs_iter_t *it)
Get the number of variables.
void * ecs_field_at_w_size(const ecs_iter_t *it, size_t size, int8_t index, int32_t row)
Get data for a field at a specified row.
ecs_id_t ecs_field_id(const ecs_iter_t *it, int8_t index)
Return the ID matched for a field.
bool ecs_field_is_set(const ecs_iter_t *it, int8_t index)
Test whether a field is set.
void ecs_iter_set_var(ecs_iter_t *it, int32_t var_id, ecs_entity_t entity)
Set the value for an iterator variable.
bool ecs_field_is_self(const ecs_iter_t *it, int8_t index)
Test whether the field is matched on self.
bool ecs_iter_next(ecs_iter_t *it)
Progress any iterator.
ecs_entity_t ecs_iter_get_var(ecs_iter_t *it, int32_t var_id)
Get the value of an iterator variable as an entity.
bool ecs_worker_next(ecs_iter_t *it)
Progress a worker iterator.
ecs_entity_t ecs_iter_first(ecs_iter_t *it)
Get the first matching entity from an iterator.
int32_t ecs_field_column(const ecs_iter_t *it, int8_t index)
Return the index of a matched table column.
uint64_t ecs_iter_get_group(const ecs_iter_t *it)
Return the group ID for the currently iterated result.
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_table_t * ecs_iter_get_var_as_table(ecs_iter_t *it, int32_t var_id)
Get the value of an iterator variable as a table.
void * ecs_field_w_size(const ecs_iter_t *it, size_t size, int8_t index)
Get data for a field.
int32_t ecs_iter_count(ecs_iter_t *it)
Count the number of matched entities in a query.
bool ecs_page_next(ecs_iter_t *it)
Progress a paged iterator.
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.
size_t ecs_field_size(const ecs_iter_t *it, int8_t index)
Return the field type size.
ecs_table_range_t ecs_iter_get_var_as_range(ecs_iter_t *it, int32_t var_id)
Get the value of an iterator variable as a table range.
ecs_id_t ecs_strip_generation(ecs_entity_t e)
Remove the generation from an entity ID.
void ecs_make_alive_id(ecs_world_t *world, ecs_id_t component)
Same as ecs_make_alive(), but for components.
bool ecs_is_valid(const ecs_world_t *world, ecs_entity_t e)
Test whether an entity is valid.
void ecs_make_alive(ecs_world_t *world, ecs_entity_t entity)
Ensure an ID is alive.
ecs_entity_t ecs_get_alive(const ecs_world_t *world, ecs_entity_t e)
Get an alive identifier.
uint32_t ecs_get_version(ecs_entity_t entity)
Get the generation of an entity.
bool ecs_exists(const ecs_world_t *world, ecs_entity_t entity)
Test whether an entity exists.
bool ecs_is_alive(const ecs_world_t *world, ecs_entity_t e)
Test whether an entity is alive.
void ecs_set_version(ecs_world_t *world, ecs_entity_t entity)
Override the generation of an entity.
struct ecs_world_info_t ecs_world_info_t
Type that contains information about the world.
struct ecs_query_group_info_t ecs_query_group_info_t
Type that contains information about a query group.
struct ecs_entity_range_t ecs_entity_range_t
Type that stores an entity id range.
struct ecs_build_info_t ecs_build_info_t
Type with information about the current Flecs build.
ecs_entity_t ecs_observer_update(ecs_world_t *world, ecs_entity_t observer, const ecs_observer_desc_t *desc)
Update an existing observer.
void ecs_emit(ecs_world_t *world, ecs_event_desc_t *desc)
Send an event.
void ecs_enqueue(ecs_world_t *world, ecs_event_desc_t *desc)
Enqueue an event.
ecs_entity_t ecs_observer_init(ecs_world_t *world, const ecs_observer_desc_t *desc)
Create an observer.
const ecs_observer_t * ecs_observer_get(const ecs_world_t *world, ecs_entity_t observer)
Get the observer object.
struct ecs_event_desc_t ecs_event_desc_t
Used with ecs_emit().
struct ecs_observer_desc_t ecs_observer_desc_t
Used with ecs_observer_init().
#define FLECS_EVENT_DESC_MAX
Maximum number of events in ecs_observer_desc_t.
Definition flecs.h:321
#define ecs_ftime_t
Customizable precision for scalar time values.
Definition flecs.h:59
#define FLECS_ID_DESC_MAX
Maximum number of IDs to add in ecs_entity_desc_t / ecs_bulk_desc_t.
Definition flecs.h:315
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:331
#define FLECS_TREE_SPAWNER_DEPTH_CACHE_SIZE
Size of the depth cache in the tree spawner component.
Definition flecs.h:364
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_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 an entity from a path.
ecs_entity_t ecs_lookup_symbol(const ecs_world_t *world, const char *symbol, bool lookup_as_path, bool recursive)
Look up an entity by its symbol name.
void ecs_set_alias(ecs_world_t *world, ecs_entity_t entity, const char *alias)
Set an alias for an entity.
ecs_entity_t ecs_lookup(const ecs_world_t *world, const char *path)
Look up an entity by its path.
ecs_entity_t ecs_get_scope(const ecs_world_t *world)
Get the current scope.
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 a path identifier to a buffer.
ecs_entity_t * ecs_set_lookup_path(ecs_world_t *world, const ecs_entity_t *lookup_path)
Set the search path for lookup operations.
ecs_entity_t ecs_set_name(ecs_world_t *world, ecs_entity_t entity, const char *name)
Set the name of an entity.
const char * ecs_get_symbol(const ecs_world_t *world, ecs_entity_t entity)
Get the symbol of an entity.
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)
Look up an entity from a path.
ecs_entity_t ecs_set_symbol(ecs_world_t *world, ecs_entity_t entity, const char *symbol)
Set the symbol of an entity.
ecs_entity_t ecs_lookup_child(const ecs_world_t *world, ecs_entity_t parent, const char *name)
Look up a child entity by name.
const char * ecs_get_name(const ecs_world_t *world, ecs_entity_t entity)
Get the name of an entity.
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 a specified path to an entity.
ecs_entity_t * ecs_get_lookup_path(const ecs_world_t *world)
Get the current lookup path.
ecs_entity_t ecs_set_scope(ecs_world_t *world, ecs_entity_t scope)
Set the current scope.
const char * ecs_set_name_prefix(ecs_world_t *world, const char *prefix)
Set a name prefix for newly created entities.
void ecs_iter_skip(ecs_iter_t *it)
Skip a table while iterating.
bool ecs_query_has_table(const ecs_query_t *query, ecs_table_t *table, ecs_iter_t *it)
Match a table with a query.
void ecs_iter_set_group(ecs_iter_t *it, uint64_t group_id)
Set the group to iterate for a query iterator.
const ecs_query_t * ecs_query_get(const ecs_world_t *world, ecs_entity_t query)
Get the query object.
bool ecs_query_next(ecs_iter_t *it)
Progress a query iterator.
const ecs_query_group_info_t * ecs_query_get_group_info(const ecs_query_t *query, uint64_t group_id)
Get information about a query group.
ecs_query_t * ecs_query_update(ecs_world_t *world, ecs_entity_t entity, const ecs_query_desc_t *desc)
Replace the query on an existing entity.
bool ecs_query_is_true(const ecs_query_t *query)
Test whether a query returns one or more results.
char * ecs_term_str(const ecs_world_t *world, const ecs_term_t *term)
Convert a term to a string expression.
bool ecs_query_has_range(const ecs_query_t *query, ecs_table_range_t *range, ecs_iter_t *it)
Match a range with a query.
int32_t ecs_query_find_var(const ecs_query_t *query, const char *name)
Find a variable index.
void ecs_query_fini(ecs_query_t *query)
Delete a query.
bool ecs_query_has(const ecs_query_t *query, ecs_entity_t entity, ecs_iter_t *it)
Match an entity with a query.
char * ecs_query_plan_w_profile(const ecs_query_t *query, const ecs_iter_t *it)
Convert a query to a string with a profile.
struct ecs_query_desc_t ecs_query_desc_t
Used with ecs_query_init().
const char * ecs_query_args_parse(ecs_query_t *query, ecs_iter_t *it, const char *expr)
Populate variables from a key-value string.
int32_t ecs_query_match_count(const ecs_query_t *query)
Return how often a match event happened for a cached query.
char * ecs_query_plan(const ecs_query_t *query)
Convert a query to a string.
ecs_iter_t ecs_query_iter(const ecs_world_t *world, const ecs_query_t *query)
Create a query iterator.
char * ecs_query_str(const ecs_query_t *query)
Convert a query to a string expression.
bool ecs_query_var_is_entity(const ecs_query_t *query, int32_t var_id)
Test if a variable is an entity.
ecs_query_t * ecs_query_init(ecs_world_t *world, const ecs_query_desc_t *desc)
Create a query.
bool ecs_query_changed(ecs_query_t *query)
Return whether the query data changed since the last iteration.
const char * ecs_query_var_name(const ecs_query_t *query, int32_t var_id)
Get the variable name.
bool ecs_term_match_this(const ecs_term_t *term)
Is a term matched on the $this variable.
char * ecs_query_plans(const ecs_query_t *query)
Same as ecs_query_plan(), but includes the plan for populating the cache (if any).
void * ecs_query_get_group_ctx(const ecs_query_t *query, uint64_t group_id)
Get the context of a query group.
ecs_query_count_t ecs_query_count(const ecs_query_t *query)
Return the number of entities and results the query matches with.
const ecs_map_t * ecs_query_get_groups(const ecs_query_t *query)
Return the map with query groups.
bool ecs_term_is_initialized(const ecs_term_t *term)
Test whether a term is set.
bool ecs_term_ref_is_set(const ecs_term_ref_t *ref)
Test whether a term ref is set.
struct ecs_query_count_t ecs_query_count_t
Struct returned by ecs_query_count().
bool ecs_term_match_0(const ecs_term_t *term)
Is a term matched on a 0 source.
const ecs_query_t * ecs_query_get_cache_query(const ecs_query_t *query)
Get the query used to populate the cache.
struct ecs_term_ref_t ecs_term_ref_t
Type that describes a reference to an entity or variable in a term.
ecs_query_cache_kind_t
Specify cache policy for query.
Definition flecs.h:738
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:717
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:727
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:741
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:739
@ EcsQueryCacheNone
No caching.
Definition flecs.h:742
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:740
@ EcsOut
Term is only written.
Definition flecs.h:723
@ EcsInOut
Term is both read and written.
Definition flecs.h:721
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:720
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:718
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:719
@ EcsIn
Term is only read.
Definition flecs.h:722
@ EcsNot
The term must not match.
Definition flecs.h:730
@ EcsOptional
The term may match.
Definition flecs.h:731
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:729
@ EcsOrFrom
Term must match at least one component from term ID.
Definition flecs.h:733
@ EcsAnd
The term must match.
Definition flecs.h:728
@ EcsNotFrom
Term must match none of the components from term ID.
Definition flecs.h:734
@ EcsAndFrom
Term must match all components from term ID.
Definition flecs.h:732
ecs_table_t * ecs_table_add_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t component)
Get the table that has all components of the current table plus the specified ID.
int32_t ecs_search_offset(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t component, ecs_id_t *component_out)
Search for a component in a table type starting from an offset.
ecs_table_t * ecs_table_remove_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t component)
Get the table that has all components of the current table minus the specified component.
const ecs_type_t * ecs_table_get_type(const ecs_table_t *table)
Get the type for a table.
int32_t ecs_table_get_column_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t component)
Get the column index for a component.
int32_t ecs_search_relation_for_entity(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, ecs_entity_t rel, bool self, ecs_component_record_t *cr, ecs_entity_t *tgt_out, ecs_id_t *id_out, struct ecs_table_record_t **tr_out)
Search for a component ID by following a relationship, starting from an entity.
void * ecs_table_get_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t component, int32_t offset)
Get a column from a table by component.
int32_t ecs_table_size(const ecs_table_t *table)
Return the allocated size of the table.
bool ecs_table_has_flags(ecs_table_t *table, ecs_flags32_t flags)
Test a table for flags.
int32_t ecs_table_column_to_type_index(const ecs_table_t *table, int32_t index)
Convert a column index to a type index.
int32_t ecs_table_column_count(const ecs_table_t *table)
Return the number of columns in a table.
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) an entity to a table.
int32_t ecs_search_relation(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t component, ecs_entity_t rel, ecs_flags64_t flags, ecs_entity_t *tgt_out, ecs_id_t *component_out, struct ecs_table_record_t **tr_out)
Search for a component or relationship ID in a table type starting from an offset.
void * ecs_table_get_column(const ecs_table_t *table, int32_t index, int32_t offset)
Get a column from a table by column index.
int32_t ecs_search(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t component, ecs_id_t *component_out)
Search for a component in a table type.
ecs_entity_t ecs_table_get_target(const ecs_world_t *world, const ecs_table_t *table, ecs_entity_t relationship, int32_t index)
Get the relationship target for a table.
int32_t ecs_table_count(const ecs_table_t *table)
Return the number of entities in the table.
const ecs_entity_t * ecs_table_entities(const ecs_table_t *table)
Return the array with entity IDs for the table.
void ecs_table_unlock(ecs_world_t *world, ecs_table_t *table)
Unlock a table.
bool ecs_table_has_traversable(const ecs_table_t *table)
Check if a table has traversable entities.
int32_t ecs_table_get_depth(const ecs_world_t *world, const ecs_table_t *table, ecs_entity_t rel)
Return the depth for a table in the tree for the specified relationship.
bool ecs_table_has_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t component)
Test if a table has a component.
void ecs_table_swap_rows(ecs_world_t *world, ecs_table_t *table, int32_t row_1, int32_t row_2)
Swap two elements inside the table.
void ecs_table_lock(ecs_world_t *world, ecs_table_t *table)
Lock a table.
ecs_table_t * ecs_table_find(ecs_world_t *world, const ecs_id_t *ids, int32_t id_count)
Find a table from an ID array.
size_t ecs_table_get_column_size(const ecs_table_t *table, int32_t index)
Get the column size from a table.
int32_t ecs_table_get_type_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t component)
Get the type index for a component.
void ecs_table_clear_entities(ecs_world_t *world, ecs_table_t *table)
Remove all entities in a table.
int32_t ecs_table_type_to_column_index(const ecs_table_t *table, int32_t index)
Convert a type index to a column index.
struct ecs_entities_t ecs_entities_t
Type returned by ecs_get_entities().
void ecs_atfini(ecs_world_t *world, ecs_fini_action_t action, void *ctx)
Register an action to be executed when the world is destroyed.
bool ecs_is_fini(const ecs_world_t *world)
Return whether the world is being deleted.
int ecs_fini(ecs_world_t *world)
Delete a world.
ecs_flags32_t ecs_world_get_flags(const ecs_world_t *world)
Get flags set on the world.
ecs_world_t * ecs_mini(void)
Create a new world with just the core module.
ecs_world_t * ecs_init(void)
Create a new world.
ecs_world_t * ecs_init_w_args(int argc, char *argv[])
Create a new world with arguments.
ecs_entities_t ecs_get_entities(const ecs_world_t *world)
Return entity identifiers in the world.
void ecs_set_target_fps(ecs_world_t *world, float fps)
Set target frames per second (FPS) for an application.
void ecs_measure_system_time(ecs_world_t *world, bool enable)
Measure system time.
float ecs_frame_begin(ecs_world_t *world, float delta_time)
Begin frame.
void ecs_run_post_frame(ecs_world_t *world, ecs_fini_action_t action, void *ctx)
Register an action to be executed once after the frame.
bool ecs_should_quit(const ecs_world_t *world)
Return whether a quit has been requested.
void ecs_set_default_query_flags(ecs_world_t *world, ecs_flags32_t flags)
Set the default query flags.
void ecs_quit(ecs_world_t *world)
Signal exit.
void ecs_measure_frame_time(ecs_world_t *world, bool enable)
Measure frame time.
void ecs_frame_end(ecs_world_t *world)
End frame.
ecs_entity_t ecs_get_entity(const ecs_poly_t *poly)
Get the entity from a poly.
ecs_id_t ecs_make_pair(ecs_entity_t first, ecs_entity_t second)
Make a pair ID.
const ecs_build_info_t * ecs_get_build_info(void)
Get build info.
bool flecs_poly_is_(const ecs_poly_t *object, int32_t type)
Test if a pointer is of the specified type.
void ecs_entity_range_set(ecs_world_t *world, const ecs_entity_range_t *range)
Set the active entity range.
const ecs_entity_range_t * ecs_entity_range_new(ecs_world_t *world, uint32_t min, uint32_t max)
Create a new entity range.
ecs_entity_t ecs_get_max_id(const ecs_world_t *world)
Get the largest issued entity ID (not counting generation).
void ecs_run_aperiodic(ecs_world_t *world, ecs_flags32_t flags)
Force aperiodic actions.
void * ecs_get_binding_ctx(const ecs_world_t *world)
Get the world binding context.
void ecs_shrink(ecs_world_t *world)
Free unused memory.
void ecs_dim(ecs_world_t *world, int32_t entity_count)
Dimension the world for a specified number of entities.
const ecs_world_info_t * ecs_get_world_info(const ecs_world_t *world)
Get the world info.
const ecs_world_t * ecs_get_world(const ecs_poly_t *poly)
Get the world from a poly.
void ecs_set_ctx(ecs_world_t *world, void *ctx, ecs_ctx_free_t ctx_free)
Set a world context.
void ecs_exclusive_access_begin(ecs_world_t *world, const char *thread_name)
Begin exclusive thread access.
int32_t ecs_delete_empty_tables(ecs_world_t *world, const ecs_delete_empty_tables_desc_t *desc)
Clean up empty tables.
const ecs_entity_range_t * ecs_entity_range_get(const ecs_world_t *world)
Get the currently active entity id range.
void ecs_set_binding_ctx(ecs_world_t *world, void *ctx, ecs_ctx_free_t ctx_free)
Set a world binding context.
struct ecs_delete_empty_tables_desc_t ecs_delete_empty_tables_desc_t
Used with ecs_delete_empty_tables().
void ecs_exclusive_access_end(ecs_world_t *world, bool lock_world)
End exclusive thread access.
void * ecs_get_ctx(const ecs_world_t *world)
Get the world context.
Operating system abstraction API.
Component information.
Definition flecs.h:1621
ecs_size_t size
Component size.
Definition flecs.h:1622
ecs_size_t alignment
Component alignment.
Definition flecs.h:1623
When added to an entity, this informs serialization formats which component to use when a value is as...
Definition flecs.h:1636
ecs_id_t component
Default component ID.
Definition flecs.h:1637
A (string) identifier.
Definition flecs.h:1612
ecs_size_t length
Length of identifier.
Definition flecs.h:1614
char * value
Identifier string.
Definition flecs.h:1613
ecs_hashmap_t * index
Current index.
Definition flecs.h:1617
uint64_t hash
Hash of current value.
Definition flecs.h:1615
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1616
Non-fragmenting ChildOf relationship.
Definition flecs.h:1641
ecs_entity_t value
Parent entity.
Definition flecs.h:1642
Component for storing a poly object.
Definition flecs.h:1627
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1628
Apply a rate filter to a tick source.
Definition timer.h:45
Component used to provide a tick source to systems.
Definition system.h:32
Component used for one-shot and interval timer functionality.
Definition timer.h:35
Tree instantiation cache component.
Definition flecs.h:1665
ecs_tree_spawner_t data[(6)]
Cache data indexed by depth.
Definition flecs.h:1666
Type with information about the current Flecs build.
Definition flecs.h:1511
const char ** flags
Compile-time settings.
Definition flecs.h:1514
int16_t version_major
Major Flecs version.
Definition flecs.h:1516
const char ** addons
Addons included in the build.
Definition flecs.h:1513
const char * version
Stringified version.
Definition flecs.h:1515
const char * compiler
Compiler used to compile Flecs.
Definition flecs.h:1512
bool sanitize
Is this a sanitize build?
Definition flecs.h:1520
bool perf_trace
Is this a perf tracing build?
Definition flecs.h:1521
int16_t version_minor
Minor Flecs version.
Definition flecs.h:1517
bool debug
Is this a debug build?
Definition flecs.h:1519
int16_t version_patch
Patch Flecs version.
Definition flecs.h:1518
Used with ecs_bulk_init().
Definition flecs.h:1107
ecs_id_t ids[32]
IDs to create the entities with.
Definition flecs.h:1117
void ** data
Array with component data to insert.
Definition flecs.h:1119
int32_t count
Number of entities to create/populate.
Definition flecs.h:1115
int32_t _canary
Used for validity testing.
Definition flecs.h:1108
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:1110
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1126
Used with ecs_component_init().
Definition flecs.h:1137
int32_t _canary
Used for validity testing.
Definition flecs.h:1138
ecs_type_info_t type
Parameters for type (size, hooks, ...).
Definition flecs.h:1144
ecs_entity_t entity
Existing entity to associate with a component (optional).
Definition flecs.h:1141
Used with ecs_delete_empty_tables().
Definition flecs.h:2799
uint16_t delete_generation
Delete table when generation > delete_generation.
Definition flecs.h:2804
double time_budget_seconds
Amount of time operation is allowed to spend.
Definition flecs.h:2807
uint16_t clear_generation
Free table data when generation > clear_generation.
Definition flecs.h:2801
int32_t offset
Table index to start scanning at.
Definition flecs.h:2811
Type returned by ecs_get_entities().
Definition flecs.h:2139
int32_t alive_count
Number of alive entity IDs.
Definition flecs.h:2142
int32_t count
Total number of entity IDs.
Definition flecs.h:2141
const ecs_entity_t * ids
Array with all entity IDs in the world.
Definition flecs.h:2140
Used with ecs_entity_init().
Definition flecs.h:1061
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:1073
const char * root_sep
Optional, used for identifiers relative to the root.
Definition flecs.h:1077
const char * name
Name of the entity.
Definition flecs.h:1068
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:1089
const char * symbol
Optional entity symbol.
Definition flecs.h:1079
int32_t _canary
Used for validity testing.
Definition flecs.h:1062
const ecs_id_t * add
0-terminated array of IDs to add to the entity.
Definition flecs.h:1094
const char * add_expr
String expression with components to add.
Definition flecs.h:1100
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:1097
ecs_entity_t id
Set to modify existing entity (optional).
Definition flecs.h:1064
ecs_entity_t parent
Parent entity.
Definition flecs.h:1066
Type that stores an entity id range.
Definition flecs.h:1595
uint32_t max
Last id in range (inclusive, 0 = unlimited).
Definition flecs.h:1597
uint32_t cur
Last issued id in range.
Definition flecs.h:1598
ecs_vec_t recycled
Recycled entity ids (vec<entity_t>).
Definition flecs.h:1599
uint32_t min
First id in range (inclusive).
Definition flecs.h:1596
Used with ecs_emit().
Definition flecs.h:1451
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1476
const void * const_param
Same as param, but with the guarantee that the value won't be modified.
Definition flecs.h:1487
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1461
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1473
ecs_table_t * other_table
Optional second table to notify.
Definition flecs.h:1465
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1468
const ecs_type_t * ids
Component IDs.
Definition flecs.h:1458
void * set_ptr
Optional pointer to the value of the component for which the event is emitted.
Definition flecs.h:1493
ecs_poly_t * observable
Observable (usually the world).
Definition flecs.h:1496
ecs_entity_t event
The event ID.
Definition flecs.h:1453
ecs_flags32_t flags
Event flags.
Definition flecs.h:1499
void * param
Optional context.
Definition flecs.h:1482
Header for ecs_poly_t objects.
Definition flecs.h:525
int32_t type
Magic number indicating which type of Flecs object.
Definition flecs.h:526
int32_t refcount
Refcount, to enable RAII handles.
Definition flecs.h:527
ecs_mixins_t * mixins
Table with offsets to (optional) mixins.
Definition flecs.h:528
Iterator.
Definition flecs.h:1185
ecs_world_t * real_world
Actual world.
Definition flecs.h:1188
void * param
Param passed to ecs_run().
Definition flecs.h:1222
ecs_entity_t event
The event (if applicable).
Definition flecs.h:1210
int32_t frame_offset
Offset relative to the start of iteration.
Definition flecs.h:1233
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1204
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1237
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1236
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1244
void * ctx
System context.
Definition flecs.h:1223
void * run_ctx
Run language binding context.
Definition flecs.h:1226
ecs_table_t * table
Current table.
Definition flecs.h:1198
int32_t offset
Offset relative to the current table.
Definition flecs.h:1191
ecs_id_t event_id
The (component) ID for the event.
Definition flecs.h:1211
ecs_iter_fini_action_t fini
Function to clean up iterator resources.
Definition flecs.h:1243
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1238
ecs_world_t * world
The world.
Definition flecs.h:1187
void * callback_ctx
Callback language binding context.
Definition flecs.h:1225
ecs_entity_t * sources
Entity on which the ID was matched (0 if same as entities).
Definition flecs.h:1201
void * binding_ctx
System binding context.
Definition flecs.h:1224
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1205
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1230
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1219
int8_t term_index
Index of the term that emitted an event.
Definition flecs.h:1216
ecs_entity_t system
The system (if applicable).
Definition flecs.h:1209
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1203
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1197
float delta_time
Time elapsed since last frame.
Definition flecs.h:1229
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1206
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1242
int8_t field_count
Number of fields in the iterator.
Definition flecs.h:1215
ecs_table_t * other_table
Previous or next table when adding or removing.
Definition flecs.h:1199
int32_t event_cur
Unique event ID.
Definition flecs.h:1212
const ecs_table_record_t ** trs
Info on where to find the field in the table.
Definition flecs.h:1195
int32_t count
Number of entities to iterate.
Definition flecs.h:1192
void ** ptrs
Component pointers.
Definition flecs.h:1194
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1241
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1193
ecs_id_t * ids
(Component) IDs.
Definition flecs.h:1200
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1202
Used with ecs_observer_init().
Definition flecs.h:1390
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1439
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1427
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1436
ecs_entity_t entity
Existing entity to associate with an observer (optional).
Definition flecs.h:1395
int32_t * last_event_id
Used for internal purposes.
Definition flecs.h:1442
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1430
void * ctx
User context to pass to callback.
Definition flecs.h:1424
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1398
ecs_flags32_t flags_
Used for internal purposes.
Definition flecs.h:1444
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1433
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1443
bool global_observer
Global observers are tied to the lifespan of the world.
Definition flecs.h:1410
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1413
bool yield_existing
When an observer is created, generate events from existing data.
Definition flecs.h:1405
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1421
ecs_entity_t events[8]
Events to observe (OnAdd, OnRemove, OnSet).
Definition flecs.h:1401
int32_t _canary
Used for validity testing.
Definition flecs.h:1392
An observer reacts to events matching a query.
Definition flecs.h:888
int32_t event_count
Number of events.
Definition flecs.h:895
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:897
ecs_entity_t entity
Entity associated with the observer.
Definition flecs.h:911
ecs_observable_t * observable
Observable for the observer.
Definition flecs.h:908
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:898
ecs_header_t hdr
Object header.
Definition flecs.h:889
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:904
ecs_entity_t events[8]
Observer events.
Definition flecs.h:894
void * run_ctx
Run language binding context.
Definition flecs.h:902
ecs_world_t * world
The world.
Definition flecs.h:910
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:906
void * callback_ctx
Callback language binding context.
Definition flecs.h:901
void * ctx
Observer context.
Definition flecs.h:900
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:905
ecs_query_t * query
Observer query.
Definition flecs.h:891
Struct returned by ecs_query_count().
Definition flecs.h:5310
int32_t entities
Number of entities returned by the query.
Definition flecs.h:5312
int32_t results
Number of results returned by the query.
Definition flecs.h:5311
int32_t tables
Number of tables returned by the query.
Definition flecs.h:5313
Used with ecs_query_init().
Definition flecs.h:1316
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1377
ecs_id_t group_by
Component ID to be used for grouping.
Definition flecs.h:1347
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1321
int32_t _canary
Used for validity testing.
Definition flecs.h:1318
void * ctx
User context to pass to callback.
Definition flecs.h:1371
ecs_ctx_free_t group_by_ctx_free
Function to free group_by_ctx.
Definition flecs.h:1368
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1365
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1374
ecs_entity_t order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition flecs.h:1343
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1335
ecs_group_create_action_t on_group_create
Callback that is invoked when a new group is created.
Definition flecs.h:1358
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:1383
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1380
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1354
ecs_group_delete_action_t on_group_delete
Callback that is invoked when an existing group is deleted.
Definition flecs.h:1362
ecs_sort_table_action_t order_by_table_callback
Callback used for ordering query results.
Definition flecs.h:1339
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1330
ecs_query_cache_kind_t cache_kind
Caching policy of the query.
Definition flecs.h:1327
const char * expr
Query DSL expression (optional).
Definition flecs.h:1324
Type that contains information about a query group.
Definition flecs.h:1585
int32_t table_count
Number of tables in group.
Definition flecs.h:1588
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1589
uint64_t id
Group ID.
Definition flecs.h:1586
int32_t match_count
How often tables have been matched or unmatched.
Definition flecs.h:1587
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:847
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:867
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:864
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:866
ecs_header_t hdr
Object header.
Definition flecs.h:848
int8_t var_count
Number of query variables.
Definition flecs.h:856
ecs_flags32_t fixed_fields
Bitmasks for quick field information lookups.
Definition flecs.h:861
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:862
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:865
int32_t eval_count
Number of times the query is evaluated.
Definition flecs.h:882
ecs_world_t * world
World or stage the query was created with.
Definition flecs.h:880
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:863
uint64_t bloom_filter
Bitmask used to quickly discard tables.
Definition flecs.h:854
ecs_world_t * real_world
Actual world.
Definition flecs.h:879
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:869
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:878
void * ctx
User context to pass to callback.
Definition flecs.h:875
int32_t * sizes
Component sizes.
Definition flecs.h:851
ecs_id_t * ids
Component ids.
Definition flecs.h:852
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:868
ecs_term_t * terms
Query terms.
Definition flecs.h:850
ecs_query_cache_kind_t cache_kind
Caching policy of the query.
Definition flecs.h:871
int8_t term_count
Number of query terms.
Definition flecs.h:857
char ** vars
Array with variable names for the iterator.
Definition flecs.h:873
int8_t field_count
Number of fields returned by the query.
Definition flecs.h:858
ecs_flags32_t flags
Query flags.
Definition flecs.h:855
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:876
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:808
const char * name
Name.
Definition flecs.h:815
ecs_entity_t id
Entity ID.
Definition flecs.h:809
Type that describes a term (single element in a query).
Definition flecs.h:823
ecs_term_ref_t src
Source of term.
Definition flecs.h:829
int8_t field_index
Index of the field for the term in the iterator.
Definition flecs.h:840
ecs_id_t id
Component ID to be matched by term.
Definition flecs.h:824
int16_t oper
Operator of term.
Definition flecs.h:838
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:831
ecs_flags16_t flags_
Flags that help evaluation, set by ecs_query_init().
Definition flecs.h:841
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:833
int16_t inout
Access to contents matched by term.
Definition flecs.h:837
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:830
Component with data to instantiate a non-fragmenting tree.
Definition flecs.h:1646
uint32_t child
Prefab child entity (without generation).
Definition flecs.h:1649
int32_t parent_index
Index into the children vector.
Definition flecs.h:1650
const char * child_name
Name of the prefab child.
Definition flecs.h:1647
ecs_table_t * table
Table in which the child will be stored.
Definition flecs.h:1648
Tree spawner data for a single hierarchy depth.
Definition flecs.h:1654
ecs_vec_t children
vector<ecs_tree_spawner_child_t>.
Definition flecs.h:1655
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:970
void * lifecycle_ctx
Component lifecycle context (see meta addon).
Definition flecs.h:1026
void * ctx
User-defined context.
Definition flecs.h:1024
ecs_iter_action_t on_remove
Callback that is invoked when an instance of the component is removed.
Definition flecs.h:1011
void * binding_ctx
Language binding context.
Definition flecs.h:1025
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:985
ecs_flags32_t flags
Hook flags.
Definition flecs.h:997
ecs_cmp_t cmp
Compare hook.
Definition flecs.h:988
ecs_copy_t copy
copy assignment.
Definition flecs.h:966
ecs_ctx_free_t lifecycle_ctx_free
Callback to free lifecycle_ctx.
Definition flecs.h:1030
ecs_on_validate_t on_validate
Callback that is invoked before the on_set/OnSet hooks and observers are invoked.
Definition flecs.h:1022
ecs_iter_action_t on_set
Callback that is invoked when an instance of the component is set.
Definition flecs.h:1006
ecs_move_t move
move assignment.
Definition flecs.h:967
ecs_xtor_t ctor
ctor.
Definition flecs.h:964
ecs_iter_action_t on_replace
Callback that is invoked with the existing and new value before the value is assigned.
Definition flecs.h:1017
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1028
ecs_iter_action_t on_add
Callback that is invoked when an instance of a component is added.
Definition flecs.h:1001
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1029
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:973
ecs_equals_t equals
Equals hook.
Definition flecs.h:991
ecs_move_t ctor_move_dtor
Ctor + move + dtor (or move_ctor + dtor).
Definition flecs.h:979
ecs_xtor_t dtor
dtor.
Definition flecs.h:965
Type that contains component information (passed to ctors/dtors/...).
Definition flecs.h:1037
ecs_size_t alignment
Alignment of the type.
Definition flecs.h:1039
ecs_size_t size
Size of the type.
Definition flecs.h:1038
const char * name
Type name.
Definition flecs.h:1042
ecs_entity_t component
Handle to component (do not set).
Definition flecs.h:1041
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:1040
A type is a list of (component) IDs.
Definition flecs.h:403
ecs_id_t * array
Array with IDs.
Definition flecs.h:404
int32_t count
Number of elements in array.
Definition flecs.h:405
Value of a dynamic type.
Definition flecs.h:1052
void * ptr
Pointer to value.
Definition flecs.h:1054
ecs_entity_t type
Type of value.
Definition flecs.h:1053
Type that contains information about the world.
Definition flecs.h:1525
int64_t observers_ran_total
Total number of times an observer was invoked.
Definition flecs.h:1551
float delta_time
Time passed to or computed by ecs_progress().
Definition flecs.h:1529
int64_t systems_ran_total
Total number of systems run.
Definition flecs.h:1550
int64_t set_count
Set commands processed.
Definition flecs.h:1568
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1537
int32_t tag_id_count
Number of tag (no data) IDs in the world.
Definition flecs.h:1554
int32_t component_id_count
Number of component (data) IDs in the world.
Definition flecs.h:1555
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1549
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1542
int32_t table_count
Number of tables.
Definition flecs.h:1558
float delta_time_raw
Raw delta time (no time scaling).
Definition flecs.h:1528
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1532
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1547
float system_time_total
Total time spent in systems.
Definition flecs.h:1533
int64_t id_delete_total
Total number of times an ID was deleted.
Definition flecs.h:1546
float merge_time_total
Total time spent in merges.
Definition flecs.h:1535
struct ecs_world_info_t::@0 cmd
Command statistics.
int64_t discard_count
Commands discarded, happens when the entity is no longer alive when running the command.
Definition flecs.h:1571
int64_t clear_count
Clear commands processed.
Definition flecs.h:1567
ecs_entity_t last_component_id
Last issued component entity ID.
Definition flecs.h:1526
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1540
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1541
int64_t other_count
Other commands processed.
Definition flecs.h:1573
int64_t batched_command_count
Commands batched.
Definition flecs.h:1575
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1548
int64_t queries_ran_total
Total number of times a query was evaluated.
Definition flecs.h:1552
int64_t delete_count
Delete commands processed.
Definition flecs.h:1566
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1543
int64_t id_create_total
Total number of times a new ID was created.
Definition flecs.h:1545
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1574
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1530
int32_t pair_id_count
Number of pair IDs in the world.
Definition flecs.h:1556
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1536
int64_t ensure_count
Ensure or emplace commands processed.
Definition flecs.h:1569
float target_fps
Target FPS.
Definition flecs.h:1531
double world_time_total_raw
Time elapsed in simulation (no scaling).
Definition flecs.h:1538
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1534
uint32_t creation_time
Time when world was created.
Definition flecs.h:1560
int64_t modified_count
Modified commands processed.
Definition flecs.h:1570
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1578
int64_t event_count
Enqueued custom events.
Definition flecs.h:1572
int64_t add_count
Add commands processed.
Definition flecs.h:1564
int64_t remove_count
Remove commands processed.
Definition flecs.h:1565