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 5
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#endif
116
117/* Tip: if you see weird behavior that you think might be a bug, make sure to
118 * test with the FLECS_DEBUG or FLECS_SANITIZE flags enabled. There's a good
119 * chance that this gives you more information about the issue! */
120
134// #define FLECS_SOFT_ASSERT
135
141// #define FLECS_KEEP_ASSERT
142
149// #define FLECS_DEFAULT_TO_UNCACHED_QUERIES
150
163// #define FLECS_CREATE_MEMBER_ENTITIES
164
173// #define FLECS_CPP_NO_AUTO_REGISTRATION
174
182// #define FLECS_CPP_NO_ENUM_REFLECTION
183
188// #define FLECS_NO_ALWAYS_INLINE
189
217// #define FLECS_CUSTOM_BUILD
218
219#ifndef FLECS_CUSTOM_BUILD
220#define FLECS_ALERTS
221#define FLECS_APP
222// #define FLECS_C /**< C API convenience macros, always enabled. */
223#define FLECS_CPP
224#define FLECS_DOC
225// #define FLECS_JOURNAL /**< Journaling addon. */
226#define FLECS_JSON
227#define FLECS_HTTP
228#define FLECS_LOG
229#define FLECS_META
230#define FLECS_METRICS
231#define FLECS_MODULE
232#define FLECS_OS_API_IMPL
233// #define FLECS_PERF_TRACE /**< Enable performance tracing. */
234#define FLECS_PIPELINE
235#define FLECS_REST
236#define FLECS_PARSER
237#define FLECS_QUERY_DSL
238#define FLECS_SCRIPT
239// #define FLECS_SCRIPT_MATH /**< Math functions for Flecs script (may require linking with libm). */
240#define FLECS_SYSTEM
241#define FLECS_STATS
242#define FLECS_TIMER
243#define FLECS_UNITS
244#endif // ifndef FLECS_CUSTOM_BUILD
245
249// #define FLECS_LOW_FOOTPRINT
250#ifdef FLECS_LOW_FOOTPRINT
251#define FLECS_HI_COMPONENT_ID 16
252#define FLECS_HI_ID_RECORD_ID 16
253#define FLECS_ENTITY_PAGE_BITS 6
254#define FLECS_USE_OS_ALLOC
255#define FLECS_DEFAULT_TO_UNCACHED_QUERIES
256#endif
257
272#ifndef FLECS_HI_COMPONENT_ID
273#define FLECS_HI_COMPONENT_ID 256
274#endif
275
282#ifndef FLECS_HI_ID_RECORD_ID
283#define FLECS_HI_ID_RECORD_ID 1024
284#endif
285
291#ifndef FLECS_SPARSE_PAGE_BITS
292#define FLECS_SPARSE_PAGE_BITS 6
293#endif
294
297#ifndef FLECS_ENTITY_PAGE_BITS
298#define FLECS_ENTITY_PAGE_BITS 10
299#endif
300
305// #define FLECS_USE_OS_ALLOC
306
309#ifndef FLECS_ID_DESC_MAX
310#define FLECS_ID_DESC_MAX 32
311#endif
312
315#ifndef FLECS_EVENT_DESC_MAX
316#define FLECS_EVENT_DESC_MAX 8
317#endif
318
321#define FLECS_VARIABLE_COUNT_MAX 64
322
325#ifndef FLECS_TERM_COUNT_MAX
326#define FLECS_TERM_COUNT_MAX 32
327#endif
328
331#ifndef FLECS_TERM_ARG_COUNT_MAX
332#define FLECS_TERM_ARG_COUNT_MAX 16
333#endif
334
337#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
338#define FLECS_QUERY_VARIABLE_COUNT_MAX 64
339#endif
340
343#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
344#define FLECS_QUERY_SCOPE_NESTING_MAX 8
345#endif
346
351#ifndef FLECS_DAG_DEPTH_MAX
352#define FLECS_DAG_DEPTH_MAX 128
353#endif
354
359#define FLECS_TREE_SPAWNER_DEPTH_CACHE_SIZE (6)
360
363#include "flecs/private/api_defines.h"
364
374typedef uint64_t ecs_id_t;
375
382
398typedef struct {
400 int32_t count;
401} ecs_type_t;
402
426
429
432
434typedef struct ecs_term_t ecs_term_t;
435
438
457
462
467typedef struct ecs_iter_t ecs_iter_t;
468
477typedef struct ecs_ref_t ecs_ref_t;
478
483
488
491
494
514typedef void ecs_poly_t;
515
518
525
528
531#include "flecs/datastructures/vec.h" /* Vector datatype */
532#include "flecs/datastructures/sparse.h" /* Sparse set */
533#include "flecs/datastructures/block_allocator.h" /* Block allocator */
534#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
535#include "flecs/datastructures/map.h" /* Map */
536#include "flecs/datastructures/allocator.h" /* Allocator */
537#include "flecs/datastructures/strbuf.h" /* String builder */
538#include "flecs/os_api.h" /* Abstraction for operating system functions */
539
540#ifdef __cplusplus
541extern "C" {
542#endif
543
568typedef void (*ecs_run_action_t)(
569 ecs_iter_t *it);
570
577typedef void (*ecs_iter_action_t)(
578 ecs_iter_t *it);
579
588 ecs_iter_t *it);
589
596 ecs_iter_t *it);
597
600 ecs_entity_t e1,
601 const void *ptr1,
602 ecs_entity_t e2,
603 const void *ptr2);
604
607 ecs_world_t* world,
608 ecs_table_t* table,
609 ecs_entity_t* entities,
610 void* ptr,
611 int32_t size,
612 int32_t lo,
613 int32_t hi,
614 ecs_order_by_action_t order_by);
615
617typedef uint64_t (*ecs_group_by_action_t)(
618 ecs_world_t *world,
619 ecs_table_t *table,
620 ecs_id_t group_id,
621 void *ctx);
622
624typedef void* (*ecs_group_create_action_t)(
625 ecs_world_t *world,
626 uint64_t group_id,
627 void *group_by_ctx); /* from ecs_query_desc_t */
628
631 ecs_world_t *world,
632 uint64_t group_id,
633 void *group_ctx, /* return value from ecs_group_create_action_t */
634 void *group_by_ctx); /* from ecs_query_desc_t */
635
637typedef void (*ecs_module_action_t)(
638 ecs_world_t *world);
639
641typedef void (*ecs_fini_action_t)(
642 ecs_world_t *world,
643 void *ctx);
644
646typedef void (*ecs_ctx_free_t)(
647 void *ctx);
648
650typedef int (*ecs_compare_action_t)(
651 const void *ptr1,
652 const void *ptr2);
653
655typedef uint64_t (*ecs_hash_value_action_t)(
656 const void *ptr);
657
659typedef void (*ecs_xtor_t)(
660 void *ptr,
661 int32_t count,
662 const ecs_type_info_t *type_info);
663
665typedef void (*ecs_copy_t)(
666 void *dst_ptr,
667 const void *src_ptr,
668 int32_t count,
669 const ecs_type_info_t *type_info);
670
672typedef void (*ecs_move_t)(
673 void *dst_ptr,
674 void *src_ptr,
675 int32_t count,
676 const ecs_type_info_t *type_info);
677
679typedef int (*ecs_cmp_t)(
680 const void *a_ptr,
681 const void *b_ptr,
682 const ecs_type_info_t *type_info);
683
685typedef bool (*ecs_equals_t)(
686 const void *a_ptr,
687 const void *b_ptr,
688 const ecs_type_info_t *type_info);
689
691typedef void (*flecs_poly_dtor_t)(
692 ecs_poly_t *poly);
693
712
723
731
738#define EcsSelf (1llu << 63)
739
744#define EcsUp (1llu << 62)
745
750#define EcsTrav (1llu << 61)
751
756#define EcsCascade (1llu << 60)
757
762#define EcsDesc (1llu << 59)
763
768#define EcsIsVariable (1llu << 58)
769
774#define EcsIsEntity (1llu << 57)
775
780#define EcsIsName (1llu << 56)
781
786#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
787
792#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
793
808
830
871
900
908/* Flags that can be used to check which hooks a type has set */
909#define ECS_TYPE_HOOK_CTOR ECS_CAST(ecs_flags32_t, 1 << 0)
910#define ECS_TYPE_HOOK_DTOR ECS_CAST(ecs_flags32_t, 1 << 1)
911#define ECS_TYPE_HOOK_COPY ECS_CAST(ecs_flags32_t, 1 << 2)
912#define ECS_TYPE_HOOK_MOVE ECS_CAST(ecs_flags32_t, 1 << 3)
913#define ECS_TYPE_HOOK_COPY_CTOR ECS_CAST(ecs_flags32_t, 1 << 4)
914#define ECS_TYPE_HOOK_MOVE_CTOR ECS_CAST(ecs_flags32_t, 1 << 5)
915#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 6)
916#define ECS_TYPE_HOOK_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 7)
917#define ECS_TYPE_HOOK_CMP ECS_CAST(ecs_flags32_t, 1 << 8)
918#define ECS_TYPE_HOOK_EQUALS ECS_CAST(ecs_flags32_t, 1 << 9)
919
920
921/* Flags that can be used to set/check which hooks of a type are invalid */
922#define ECS_TYPE_HOOK_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 10)
923#define ECS_TYPE_HOOK_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 12)
924#define ECS_TYPE_HOOK_COPY_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 13)
925#define ECS_TYPE_HOOK_MOVE_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 14)
926#define ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 15)
927#define ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 16)
928#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 17)
929#define ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 18)
930#define ECS_TYPE_HOOK_CMP_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 19)
931#define ECS_TYPE_HOOK_EQUALS_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 20)
932
933/* Internal debug flag that indicates type hooks have been invoked */
934#define ECS_TYPE_HOOK_IN_USE ECS_CAST(ecs_flags32_t, 1 << 21)
935
936
937/* All valid hook flags */
938#define ECS_TYPE_HOOKS (ECS_TYPE_HOOK_CTOR|ECS_TYPE_HOOK_DTOR|\
939 ECS_TYPE_HOOK_COPY|ECS_TYPE_HOOK_MOVE|ECS_TYPE_HOOK_COPY_CTOR|\
940 ECS_TYPE_HOOK_MOVE_CTOR|ECS_TYPE_HOOK_CTOR_MOVE_DTOR|\
941 ECS_TYPE_HOOK_MOVE_DTOR|ECS_TYPE_HOOK_CMP|ECS_TYPE_HOOK_EQUALS)
942
943/* All invalid hook flags */
944#define ECS_TYPE_HOOKS_ILLEGAL (ECS_TYPE_HOOK_CTOR_ILLEGAL|\
945 ECS_TYPE_HOOK_DTOR_ILLEGAL|ECS_TYPE_HOOK_COPY_ILLEGAL|\
946 ECS_TYPE_HOOK_MOVE_ILLEGAL|ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL|\
947 ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL|ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL|\
948 ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL|ECS_TYPE_HOOK_CMP_ILLEGAL|\
949 ECS_TYPE_HOOK_EQUALS_ILLEGAL)
1014
1026
1027#include "flecs/private/api_types.h" /* Supporting API types */
1028#include "flecs/private/api_support.h" /* Supporting API functions */
1029#include "flecs/datastructures/hashmap.h" /* Hashmap */
1030#include "flecs/private/api_internals.h" /* Supporting API functions */
1031
1037
1042typedef struct ecs_entity_desc_t {
1043 int32_t _canary;
1049 const char *name;
1054 const char *sep;
1058 const char *root_sep;
1060 const char *symbol;
1076
1079
1081 const char *add_expr;
1083
1113
1127
1167 /* World */
1171 /* Matched data */
1172 int32_t offset;
1173 int32_t count;
1175 void **ptrs;
1177 const ecs_size_t *sizes;
1182 ecs_flags64_t constrained_vars;
1183 ecs_termset_t set_fields;
1184 ecs_termset_t ref_fields;
1185 ecs_termset_t row_fields;
1186 ecs_termset_t up_fields;
1188 /* Input information */
1192 int32_t event_cur;
1194 /* Query information */
1196 int8_t term_index;
1201 /* Context */
1202 void *param;
1203 void *ctx;
1206 void *run_ctx;
1208 /* Time */
1212 /* Iterator counters */
1215 /* Misc */
1216 ecs_flags32_t flags;
1218 ecs_iter_private_t priv_;
1220 /* Chained iterators */
1225};
1226
1227
1232#define EcsQueryMatchPrefab (1u << 1u)
1233
1238#define EcsQueryMatchDisabled (1u << 2u)
1239
1244#define EcsQueryMatchEmptyTables (1u << 3u)
1245
1250#define EcsQueryAllowUnresolvedByName (1u << 6u)
1251
1256#define EcsQueryTableOnly (1u << 7u)
1257
1268#define EcsQueryDetectChanges (1u << 8u)
1269
1270
1344
1405
1410typedef struct ecs_event_desc_t {
1413
1418
1421
1425
1427 int32_t offset;
1428
1432 int32_t count;
1433
1436
1441 void *param;
1442
1446 const void *const_param;
1447
1450
1452 ecs_flags32_t flags;
1454
1455
1464typedef struct ecs_build_info_t {
1465 const char *compiler;
1466 const char **addons;
1467 const char **flags;
1468 const char *version;
1472 bool debug;
1476
1536
1544
1548typedef struct ecs_entity_range_t {
1549 uint32_t min;
1550 uint32_t max;
1551 uint32_t cur;
1552 ecs_vec_t recycled;
1554
1565typedef struct EcsIdentifier {
1566 char *value;
1567 ecs_size_t length;
1568 uint64_t hash;
1569 uint64_t index_hash;
1570 ecs_hashmap_t *index;
1572
1574typedef struct EcsComponent {
1575 ecs_size_t size;
1576 ecs_size_t alignment;
1578
1583
1592
1597
1599typedef struct {
1600 const char *child_name;
1602 uint32_t child;
1605
1607typedef struct {
1608 ecs_vec_t children;
1610
1621
1625/* Only include deprecated definitions if deprecated addon is required */
1626#ifdef FLECS_DEPRECATED
1628#endif
1629
1645FLECS_API extern const ecs_id_t ECS_PAIR;
1646
1648FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1649
1651FLECS_API extern const ecs_id_t ECS_TOGGLE;
1652
1654FLECS_API extern const ecs_id_t ECS_VALUE_PAIR;
1655
1663/* Built-in component IDs */
1664
1666FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1667
1669FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1670
1672FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1673
1675FLECS_API extern const ecs_entity_t ecs_id(EcsParent);
1676
1678FLECS_API extern const ecs_entity_t ecs_id(EcsTreeSpawner);
1679
1681FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1682
1684FLECS_API extern const ecs_entity_t EcsParentDepth;
1685
1687FLECS_API extern const ecs_entity_t EcsQuery;
1688
1690FLECS_API extern const ecs_entity_t EcsObserver;
1691
1693FLECS_API extern const ecs_entity_t EcsSystem;
1694
1696FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1697
1699FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1700
1702FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1703
1705FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1706
1708FLECS_API extern const ecs_entity_t EcsFlecs;
1709
1711FLECS_API extern const ecs_entity_t EcsFlecsCore;
1712
1714FLECS_API extern const ecs_entity_t EcsWorld;
1715
1717FLECS_API extern const ecs_entity_t EcsWildcard;
1718
1720FLECS_API extern const ecs_entity_t EcsAny;
1721
1723FLECS_API extern const ecs_entity_t EcsThis;
1724
1726FLECS_API extern const ecs_entity_t EcsVariable;
1727
1735FLECS_API extern const ecs_entity_t EcsTransitive;
1736
1744FLECS_API extern const ecs_entity_t EcsReflexive;
1745
1756FLECS_API extern const ecs_entity_t EcsFinal;
1757
1763FLECS_API extern const ecs_entity_t EcsInheritable;
1764
1766FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1767
1771FLECS_API extern const ecs_entity_t EcsOverride;
1772
1776FLECS_API extern const ecs_entity_t EcsInherit;
1777
1782FLECS_API extern const ecs_entity_t EcsDontInherit;
1783
1791FLECS_API extern const ecs_entity_t EcsSymmetric;
1792
1802FLECS_API extern const ecs_entity_t EcsExclusive;
1803
1805FLECS_API extern const ecs_entity_t EcsAcyclic;
1806
1809FLECS_API extern const ecs_entity_t EcsTraversable;
1810
1820FLECS_API extern const ecs_entity_t EcsWith;
1821
1831FLECS_API extern const ecs_entity_t EcsOneOf;
1832
1834FLECS_API extern const ecs_entity_t EcsCanToggle;
1835
1839FLECS_API extern const ecs_entity_t EcsTrait;
1840
1850FLECS_API extern const ecs_entity_t EcsRelationship;
1851
1861FLECS_API extern const ecs_entity_t EcsTarget;
1862
1865FLECS_API extern const ecs_entity_t EcsPairIsTag;
1866
1868FLECS_API extern const ecs_entity_t EcsName;
1869
1871FLECS_API extern const ecs_entity_t EcsSymbol;
1872
1874FLECS_API extern const ecs_entity_t EcsAlias;
1875
1877FLECS_API extern const ecs_entity_t EcsChildOf;
1878
1880FLECS_API extern const ecs_entity_t EcsIsA;
1881
1883FLECS_API extern const ecs_entity_t EcsDependsOn;
1884
1886FLECS_API extern const ecs_entity_t EcsSlotOf;
1887
1889FLECS_API extern const ecs_entity_t EcsOrderedChildren;
1890
1892FLECS_API extern const ecs_entity_t EcsModule;
1893
1896FLECS_API extern const ecs_entity_t EcsPrefab;
1897
1900FLECS_API extern const ecs_entity_t EcsDisabled;
1901
1905FLECS_API extern const ecs_entity_t EcsNotQueryable;
1906
1908FLECS_API extern const ecs_entity_t EcsOnAdd;
1909
1911FLECS_API extern const ecs_entity_t EcsOnRemove;
1912
1914FLECS_API extern const ecs_entity_t EcsOnSet;
1915
1917FLECS_API extern const ecs_entity_t EcsMonitor;
1918
1920FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1921
1923FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1924
1926FLECS_API extern const ecs_entity_t EcsOnDelete;
1927
1930FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1931
1934FLECS_API extern const ecs_entity_t EcsRemove;
1935
1938FLECS_API extern const ecs_entity_t EcsDelete;
1939
1942FLECS_API extern const ecs_entity_t EcsPanic;
1943
1946FLECS_API extern const ecs_entity_t EcsSingleton;
1947
1949FLECS_API extern const ecs_entity_t EcsSparse;
1950
1952FLECS_API extern const ecs_entity_t EcsDontFragment;
1953
1955FLECS_API extern const ecs_entity_t EcsPredEq;
1956
1958FLECS_API extern const ecs_entity_t EcsPredMatch;
1959
1961FLECS_API extern const ecs_entity_t EcsPredLookup;
1962
1964FLECS_API extern const ecs_entity_t EcsScopeOpen;
1965
1967FLECS_API extern const ecs_entity_t EcsScopeClose;
1968
1973FLECS_API extern const ecs_entity_t EcsEmpty;
1974
1975FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
1976FLECS_API extern const ecs_entity_t EcsOnStart;
1977FLECS_API extern const ecs_entity_t EcsPreFrame;
1978FLECS_API extern const ecs_entity_t EcsOnLoad;
1979FLECS_API extern const ecs_entity_t EcsPostLoad;
1980FLECS_API extern const ecs_entity_t EcsPreUpdate;
1981FLECS_API extern const ecs_entity_t EcsOnUpdate;
1982FLECS_API extern const ecs_entity_t EcsOnValidate;
1983FLECS_API extern const ecs_entity_t EcsPostUpdate;
1984FLECS_API extern const ecs_entity_t EcsPreStore;
1985FLECS_API extern const ecs_entity_t EcsOnStore;
1986FLECS_API extern const ecs_entity_t EcsPostFrame;
1987FLECS_API extern const ecs_entity_t EcsPhase;
1989FLECS_API extern const ecs_entity_t EcsConstant;
1993#define EcsLastInternalComponentId (ecs_id(EcsTreeSpawner))
1994
1997#define EcsFirstUserComponentId (8)
1998
2001#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
2002
2003/* When visualized, the reserved ID ranges look like this:
2004 * - [1..8]: Built-in components
2005 * - [9..FLECS_HI_COMPONENT_ID]: Low IDs reserved for application components
2006 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Built-in entities
2007 */
2008
2030FLECS_API
2032
2039FLECS_API
2041
2051FLECS_API
2053 int argc,
2054 char *argv[]);
2055
2062FLECS_API
2064 ecs_world_t *world);
2065
2073FLECS_API
2075 const ecs_world_t *world);
2076
2085FLECS_API
2087 ecs_world_t *world,
2088 ecs_fini_action_t action,
2089 void *ctx);
2090
2097
2124FLECS_API
2126 const ecs_world_t *world);
2127
2135FLECS_API
2137 const ecs_world_t *world);
2138
2164FLECS_API
2166 ecs_world_t *world,
2167 ecs_ftime_t delta_time);
2168
2175FLECS_API
2177 ecs_world_t *world);
2178
2187FLECS_API
2189 ecs_world_t *world,
2190 ecs_fini_action_t action,
2191 void *ctx);
2192
2199FLECS_API
2201 ecs_world_t *world);
2202
2209FLECS_API
2211 const ecs_world_t *world);
2212
2225 ecs_world_t *world,
2226 bool enable);
2227
2239 ecs_world_t *world,
2240 bool enable);
2241
2257FLECS_API
2259 ecs_world_t *world,
2260 ecs_ftime_t fps);
2261
2275FLECS_API
2277 ecs_world_t *world,
2278 ecs_flags32_t flags);
2279
2356FLECS_API
2358 ecs_world_t *world,
2359 bool multi_threaded);
2360
2368FLECS_API
2370 ecs_world_t *world);
2371
2377FLECS_API
2379 ecs_world_t *stage);
2380
2397FLECS_API
2399 ecs_world_t *world);
2400
2414FLECS_API
2416 ecs_world_t *world);
2417
2432FLECS_API
2434 ecs_world_t *world);
2435
2446FLECS_API
2448 ecs_world_t *world);
2449
2461FLECS_API
2463 const ecs_world_t *world);
2464
2476FLECS_API
2478 const ecs_world_t *world);
2479
2493FLECS_API
2495 ecs_world_t *world,
2496 int32_t stages);
2497
2504FLECS_API
2506 const ecs_world_t *world);
2507
2523FLECS_API
2525 const ecs_world_t *world,
2526 int32_t stage_id);
2527
2535FLECS_API
2537 const ecs_world_t *world);
2538
2546FLECS_API
2548 ecs_world_t *world);
2549
2554FLECS_API
2556 ecs_world_t *stage);
2557
2565FLECS_API
2567 const ecs_world_t *world);
2568
2584FLECS_API
2586 ecs_world_t *world,
2587 void *ctx,
2588 ecs_ctx_free_t ctx_free);
2589
2598FLECS_API
2600 ecs_world_t *world,
2601 void *ctx,
2602 ecs_ctx_free_t ctx_free);
2603
2611FLECS_API
2613 const ecs_world_t *world);
2614
2622FLECS_API
2624 const ecs_world_t *world);
2625
2631FLECS_API
2633
2639FLECS_API
2641 const ecs_world_t *world);
2642
2651FLECS_API
2653 ecs_world_t *world,
2654 int32_t entity_count);
2655
2670FLECS_API
2672 ecs_world_t *world);
2673
2688FLECS_API
2690 ecs_world_t *world,
2691 uint32_t min,
2692 uint32_t max);
2693
2708FLECS_API
2710 ecs_world_t *world,
2711 const ecs_entity_range_t *range);
2712
2720FLECS_API
2722 const ecs_world_t *world);
2723
2729FLECS_API
2731 const ecs_world_t *world);
2732
2746FLECS_API
2748 ecs_world_t *world,
2749 ecs_flags32_t flags);
2750
2766
2802FLECS_API
2804 ecs_world_t *world,
2805 const ecs_delete_empty_tables_desc_t *desc);
2806
2812FLECS_API
2814 const ecs_poly_t *poly);
2815
2821FLECS_API
2823 const ecs_poly_t *poly);
2824
2838FLECS_API
2840 const ecs_poly_t *object,
2841 int32_t type);
2842
2846#define flecs_poly_is(object, type)\
2847 flecs_poly_is_(object, type##_magic)
2848
2857FLECS_API
2859 ecs_entity_t first,
2860 ecs_entity_t second);
2861
2884FLECS_API
2886 ecs_world_t *world,
2887 const char *thread_name);
2888
2911FLECS_API
2913 ecs_world_t *world,
2914 bool lock_world);
2915
2942FLECS_API
2944 ecs_world_t *world);
2945
2963FLECS_API
2965 ecs_world_t *world);
2966
2975FLECS_API
2977 ecs_world_t *world,
2978 ecs_id_t component);
2979
2987FLECS_API
2989 ecs_world_t *world,
2990 ecs_table_t *table);
2991
3010FLECS_API
3012 ecs_world_t *world,
3013 const ecs_entity_desc_t *desc);
3014
3041FLECS_API
3043 ecs_world_t *world,
3044 const ecs_bulk_desc_t *desc);
3045
3055FLECS_API
3057 ecs_world_t *world,
3058 ecs_id_t component,
3059 int32_t count);
3060
3076FLECS_API
3078 ecs_world_t *world,
3079 ecs_entity_t dst,
3080 ecs_entity_t src,
3081 bool copy_value);
3082
3091FLECS_API
3093 ecs_world_t *world,
3094 ecs_entity_t entity);
3095
3103FLECS_API
3105 ecs_world_t *world,
3106 ecs_id_t component);
3107
3125FLECS_API
3127 ecs_world_t *world,
3128 ecs_entity_t parent,
3129 const ecs_entity_t *children,
3130 int32_t child_count);
3131
3141FLECS_API
3143 const ecs_world_t *world,
3144 ecs_entity_t parent);
3145
3163FLECS_API
3165 ecs_world_t *world,
3166 ecs_entity_t entity,
3167 ecs_id_t component);
3168
3177FLECS_API
3179 ecs_world_t *world,
3180 ecs_entity_t entity,
3181 ecs_id_t component);
3182
3234FLECS_API
3236 ecs_world_t *world,
3237 ecs_entity_t entity,
3238 ecs_id_t component);
3239
3246FLECS_API
3248 ecs_world_t *world,
3249 ecs_entity_t entity);
3250
3258FLECS_API
3260 ecs_world_t *world,
3261 ecs_id_t component);
3262
3278FLECS_API
3280 ecs_world_t *world,
3281 ecs_id_t component);
3282
3291FLECS_API
3293 const ecs_world_t *world);
3294
3313FLECS_API
3315 ecs_world_t *world,
3316 ecs_entity_t entity,
3317 bool enabled);
3318
3332FLECS_API
3334 ecs_world_t *world,
3335 ecs_entity_t entity,
3336 ecs_id_t component,
3337 bool enable);
3338
3349FLECS_API
3351 const ecs_world_t *world,
3352 ecs_entity_t entity,
3353 ecs_id_t component);
3354
3378FLECS_API
3379FLECS_ALWAYS_INLINE const void* ecs_get_id(
3380 const ecs_world_t *world,
3381 ecs_entity_t entity,
3382 ecs_id_t component);
3383
3398FLECS_API
3399FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
3400 const ecs_world_t *world,
3401 ecs_entity_t entity,
3402 ecs_id_t component);
3403
3421FLECS_API
3423 ecs_world_t *world,
3424 ecs_entity_t entity,
3425 ecs_id_t component,
3426 size_t size);
3427
3438FLECS_ALWAYS_INLINE FLECS_API
3440 const ecs_world_t *world,
3441 ecs_entity_t entity,
3442 ecs_id_t component);
3443
3454FLECS_ALWAYS_INLINE FLECS_API
3456 const ecs_world_t *world,
3457 ecs_ref_t *ref,
3458 ecs_id_t component);
3459
3467FLECS_ALWAYS_INLINE FLECS_API
3469 const ecs_world_t *world,
3470 ecs_ref_t *ref);
3471
3492FLECS_API
3494 ecs_world_t *world,
3495 ecs_entity_t entity,
3496 ecs_id_t component,
3497 size_t size,
3498 bool *is_new);
3499
3509FLECS_API
3511 ecs_world_t *world,
3512 ecs_entity_t entity,
3513 ecs_id_t component);
3514
3530FLECS_API
3532 ecs_world_t *world,
3533 ecs_entity_t entity,
3534 ecs_id_t component,
3535 size_t size,
3536 const void *ptr);
3537
3566FLECS_API
3568 const ecs_world_t *world,
3569 ecs_entity_t e);
3570
3600FLECS_API
3602 const ecs_world_t *world,
3603 ecs_entity_t e);
3604
3610FLECS_API
3612 ecs_entity_t e);
3613
3630FLECS_API
3632 const ecs_world_t *world,
3633 ecs_entity_t e);
3634
3657FLECS_API
3659 ecs_world_t *world,
3660 ecs_entity_t entity);
3661
3680FLECS_API
3682 ecs_world_t *world,
3683 ecs_id_t component);
3684
3692FLECS_API
3694 const ecs_world_t *world,
3695 ecs_entity_t entity);
3696
3711FLECS_API
3713 ecs_world_t *world,
3714 ecs_entity_t entity);
3715
3721FLECS_API
3723 ecs_entity_t entity);
3724
3740FLECS_API
3742 const ecs_world_t *world,
3743 ecs_entity_t entity);
3744
3751FLECS_API
3753 const ecs_world_t *world,
3754 ecs_entity_t entity);
3755
3763FLECS_API
3765 const ecs_world_t *world,
3766 const ecs_type_t* type);
3767
3779FLECS_API
3781 const ecs_world_t *world,
3782 const ecs_table_t *table);
3783
3798FLECS_API
3800 const ecs_world_t *world,
3801 ecs_entity_t entity);
3802
3813FLECS_API
3814FLECS_ALWAYS_INLINE bool ecs_has_id(
3815 const ecs_world_t *world,
3816 ecs_entity_t entity,
3817 ecs_id_t component);
3818
3829FLECS_API
3830FLECS_ALWAYS_INLINE bool ecs_owns_id(
3831 const ecs_world_t *world,
3832 ecs_entity_t entity,
3833 ecs_id_t component);
3834
3849FLECS_API
3851 const ecs_world_t *world,
3852 ecs_entity_t entity,
3853 ecs_entity_t rel,
3854 int32_t index);
3855
3869FLECS_API
3871 const ecs_world_t *world,
3872 ecs_entity_t entity);
3873
3887FLECS_API
3889 ecs_world_t *world,
3890 ecs_entity_t parent,
3891 const char *name);
3892
3913FLECS_API
3915 const ecs_world_t *world,
3916 ecs_entity_t entity,
3917 ecs_entity_t rel,
3918 ecs_id_t component);
3919
3930FLECS_API
3932 const ecs_world_t *world,
3933 ecs_entity_t entity,
3934 ecs_entity_t rel);
3935
3943FLECS_API
3945 const ecs_world_t *world,
3946 ecs_id_t entity);
3947
3967FLECS_API
3968const char* ecs_get_name(
3969 const ecs_world_t *world,
3970 ecs_entity_t entity);
3971
3981FLECS_API
3982const char* ecs_get_symbol(
3983 const ecs_world_t *world,
3984 ecs_entity_t entity);
3985
3999FLECS_API
4001 ecs_world_t *world,
4002 ecs_entity_t entity,
4003 const char *name);
4004
4018FLECS_API
4020 ecs_world_t *world,
4021 ecs_entity_t entity,
4022 const char *symbol);
4023
4035FLECS_API
4037 ecs_world_t *world,
4038 ecs_entity_t entity,
4039 const char *alias);
4040
4056FLECS_API
4058 const ecs_world_t *world,
4059 const char *path);
4060
4075FLECS_API
4077 const ecs_world_t *world,
4078 ecs_entity_t parent,
4079 const char *name);
4080
4103FLECS_API
4105 const ecs_world_t *world,
4106 ecs_entity_t parent,
4107 const char *path,
4108 const char *sep,
4109 const char *prefix,
4110 bool recursive);
4111
4129FLECS_API
4131 const ecs_world_t *world,
4132 const char *symbol,
4133 bool lookup_as_path,
4134 bool recursive);
4135
4157FLECS_API
4159 const ecs_world_t *world,
4160 ecs_entity_t parent,
4161 ecs_entity_t child,
4162 const char *sep,
4163 const char *prefix);
4164
4178FLECS_API
4180 const ecs_world_t *world,
4181 ecs_entity_t parent,
4182 ecs_entity_t child,
4183 const char *sep,
4184 const char *prefix,
4185 ecs_strbuf_t *buf,
4186 bool escape);
4187
4203FLECS_API
4205 ecs_world_t *world,
4206 ecs_entity_t parent,
4207 const char *path,
4208 const char *sep,
4209 const char *prefix);
4210
4225FLECS_API
4227 ecs_world_t *world,
4228 ecs_entity_t entity,
4229 ecs_entity_t parent,
4230 const char *path,
4231 const char *sep,
4232 const char *prefix);
4233
4247FLECS_API
4249 ecs_world_t *world,
4250 ecs_entity_t scope);
4251
4259FLECS_API
4261 const ecs_world_t *world);
4262
4272FLECS_API
4274 ecs_world_t *world,
4275 const char *prefix);
4276
4303FLECS_API
4305 ecs_world_t *world,
4306 const ecs_entity_t *lookup_path);
4307
4314FLECS_API
4316 const ecs_world_t *world);
4317
4342FLECS_API
4344 ecs_world_t *world,
4345 const ecs_component_desc_t *desc);
4346
4356FLECS_API
4358 const ecs_world_t *world,
4359 ecs_id_t component);
4360
4372FLECS_API
4374 ecs_world_t *world,
4375 ecs_entity_t component,
4376 const ecs_type_hooks_t *hooks);
4377
4384FLECS_API
4386 const ecs_world_t *world,
4387 ecs_entity_t component);
4388
4412FLECS_API
4414 const ecs_world_t *world,
4415 ecs_id_t component);
4416
4425FLECS_API
4427 const ecs_world_t *world,
4428 ecs_id_t component);
4429
4449FLECS_API
4451 const ecs_world_t *world,
4452 ecs_id_t component);
4453
4462FLECS_API
4464 ecs_id_t component,
4465 ecs_id_t pattern);
4466
4472FLECS_API
4474 ecs_id_t component);
4475
4481FLECS_API
4483 ecs_id_t component);
4484
4491 ecs_id_t component);
4492
4506FLECS_API
4508 const ecs_world_t *world,
4509 ecs_id_t component);
4510
4519FLECS_API
4520ecs_flags32_t ecs_id_get_flags(
4521 const ecs_world_t *world,
4522 ecs_id_t component);
4523
4534FLECS_API
4536 uint64_t component_flags);
4537
4553FLECS_API
4555 const ecs_world_t *world,
4556 ecs_id_t component);
4557
4565FLECS_API
4567 const ecs_world_t *world,
4568 ecs_id_t component,
4569 ecs_strbuf_t *buf);
4570
4579FLECS_API
4581 const ecs_world_t *world,
4582 const char *expr);
4583
4599FLECS_API
4601 const ecs_term_ref_t *ref);
4602
4614FLECS_API
4616 const ecs_term_t *term);
4617
4632FLECS_API
4634 const ecs_term_t *term);
4635
4648FLECS_API
4650 const ecs_term_t *term);
4651
4660FLECS_API
4662 const ecs_world_t *world,
4663 const ecs_term_t *term);
4664
4672FLECS_API
4674 const ecs_query_t *query);
4675
4716FLECS_API
4718 const ecs_world_t *world,
4719 ecs_id_t component);
4720
4726FLECS_API
4728 ecs_iter_t *it);
4729
4752FLECS_API
4753FLECS_ALWAYS_INLINE ecs_iter_t ecs_children(
4754 const ecs_world_t *world,
4755 ecs_entity_t parent);
4756
4764FLECS_API
4765FLECS_ALWAYS_INLINE ecs_iter_t ecs_children_w_rel(
4766 const ecs_world_t *world,
4767 ecs_entity_t relationship,
4768 ecs_entity_t parent);
4769
4775FLECS_API
4777 ecs_iter_t *it);
4778
4794FLECS_API
4796 ecs_world_t *world,
4797 const ecs_query_desc_t *desc);
4798
4803FLECS_API
4805 ecs_query_t *query);
4806
4815FLECS_API
4817 const ecs_query_t *query,
4818 const char *name);
4819
4827FLECS_API
4829 const ecs_query_t *query,
4830 int32_t var_id);
4831
4842FLECS_API
4844 const ecs_query_t *query,
4845 int32_t var_id);
4846
4915FLECS_API
4917 const ecs_world_t *world,
4918 const ecs_query_t *query);
4919
4927FLECS_API
4929 ecs_iter_t *it);
4930
4949FLECS_API
4951 const ecs_query_t *query,
4952 ecs_entity_t entity,
4953 ecs_iter_t *it);
4954
4973FLECS_API
4975 const ecs_query_t *query,
4976 ecs_table_t *table,
4977 ecs_iter_t *it);
4978
5005FLECS_API
5007 const ecs_query_t *query,
5008 ecs_table_range_t *range,
5009 ecs_iter_t *it);
5010
5018FLECS_API
5020 const ecs_query_t *query);
5021
5031FLECS_API
5033 const ecs_query_t *query);
5034
5049FLECS_API
5051 const ecs_query_t *query,
5052 const ecs_iter_t *it);
5053
5059FLECS_API
5061 const ecs_query_t *query);
5062
5080FLECS_API
5082 ecs_query_t *query,
5083 ecs_iter_t *it,
5084 const char *expr);
5085
5108FLECS_API
5110 ecs_query_t *query);
5111
5120FLECS_API
5122 const ecs_world_t *world,
5123 ecs_entity_t query);
5124
5135FLECS_API
5137 ecs_iter_t *it);
5138
5161FLECS_API
5163 ecs_iter_t *it,
5164 uint64_t group_id);
5165
5191FLECS_API
5192const ecs_map_t* ecs_query_get_groups(
5193 const ecs_query_t *query);
5194
5203FLECS_API
5205 const ecs_query_t *query,
5206 uint64_t group_id);
5207
5216FLECS_API
5218 const ecs_query_t *query,
5219 uint64_t group_id);
5220
5229
5236FLECS_API
5238 const ecs_query_t *query);
5239
5245FLECS_API
5247 const ecs_query_t *query);
5248
5257FLECS_API
5259 const ecs_query_t *query);
5260
5289FLECS_API
5291 ecs_world_t *world,
5292 ecs_event_desc_t *desc);
5293
5304FLECS_API
5306 ecs_world_t *world,
5307 ecs_event_desc_t *desc);
5308
5319FLECS_API
5321 ecs_world_t *world,
5322 const ecs_observer_desc_t *desc);
5323
5332FLECS_API
5334 const ecs_world_t *world,
5335 ecs_entity_t observer);
5336
5359FLECS_API
5361 ecs_iter_t *it);
5362
5372FLECS_API
5374 ecs_iter_t *it);
5375
5387FLECS_API
5389 ecs_iter_t *it);
5390
5403FLECS_API
5405 ecs_iter_t *it);
5406
5414FLECS_API
5416 ecs_iter_t *it);
5417
5456FLECS_API
5458 ecs_iter_t *it,
5459 int32_t var_id,
5460 ecs_entity_t entity);
5461
5472FLECS_API
5474 ecs_iter_t *it,
5475 int32_t var_id,
5476 const ecs_table_t *table);
5477
5488FLECS_API
5490 ecs_iter_t *it,
5491 int32_t var_id,
5492 const ecs_table_range_t *range);
5493
5506FLECS_API
5508 ecs_iter_t *it,
5509 int32_t var_id);
5510
5517FLECS_API
5519 const ecs_iter_t *it,
5520 int32_t var_id);
5521
5527FLECS_API
5529 const ecs_iter_t *it);
5530
5536FLECS_API
5538 const ecs_iter_t *it);
5539
5553FLECS_API
5555 ecs_iter_t *it,
5556 int32_t var_id);
5557
5571FLECS_API
5573 ecs_iter_t *it,
5574 int32_t var_id);
5575
5587FLECS_API
5589 ecs_iter_t *it,
5590 int32_t var_id);
5591
5603FLECS_API
5605 const ecs_iter_t *it);
5606
5618FLECS_API
5620 ecs_iter_t *it);
5621
5633FLECS_API
5635 const ecs_iter_t *it);
5636
5652FLECS_API
5654 const ecs_iter_t *it,
5655 int32_t offset,
5656 int32_t limit);
5657
5664FLECS_API
5666 ecs_iter_t *it);
5667
5688FLECS_API
5690 const ecs_iter_t *it,
5691 int32_t index,
5692 int32_t count);
5693
5700FLECS_API
5702 ecs_iter_t *it);
5703
5745FLECS_API
5747 const ecs_iter_t *it,
5748 size_t size,
5749 int8_t index);
5750
5773FLECS_API
5775 const ecs_iter_t *it,
5776 size_t size,
5777 int8_t index,
5778 int32_t row);
5779
5788FLECS_API
5790 const ecs_iter_t *it,
5791 int8_t index);
5792
5803FLECS_API
5805 const ecs_iter_t *it,
5806 int8_t index);
5807
5814FLECS_API
5816 const ecs_iter_t *it,
5817 int8_t index);
5818
5825FLECS_API
5827 const ecs_iter_t *it,
5828 int8_t index);
5829
5838FLECS_API
5840 const ecs_iter_t *it,
5841 int8_t index);
5842
5850FLECS_API
5852 const ecs_iter_t *it,
5853 int8_t index);
5854
5862FLECS_API
5864 const ecs_iter_t *it,
5865 int8_t index);
5866
5880FLECS_API
5882 const ecs_iter_t *it,
5883 int8_t index);
5884
5900FLECS_API
5902 const ecs_table_t *table);
5903
5914FLECS_API
5916 const ecs_world_t *world,
5917 const ecs_table_t *table,
5918 ecs_id_t component);
5919
5929FLECS_API
5931 const ecs_world_t *world,
5932 const ecs_table_t *table,
5933 ecs_id_t component);
5934
5942FLECS_API
5944 const ecs_table_t *table);
5945
5959FLECS_API
5961 const ecs_table_t *table,
5962 int32_t index);
5963
5972FLECS_API
5974 const ecs_table_t *table,
5975 int32_t index);
5976
5985FLECS_API
5987 const ecs_table_t *table,
5988 int32_t index,
5989 int32_t offset);
5990
6000FLECS_API
6002 const ecs_world_t *world,
6003 const ecs_table_t *table,
6004 ecs_id_t component,
6005 int32_t offset);
6006
6014FLECS_API
6016 const ecs_table_t *table,
6017 int32_t index);
6018
6025FLECS_API
6027 const ecs_table_t *table);
6028
6036FLECS_API
6038 const ecs_table_t *table);
6039
6046FLECS_API
6048 const ecs_table_t *table);
6049
6060FLECS_API
6062 const ecs_world_t *world,
6063 const ecs_table_t *table,
6064 ecs_id_t component);
6065
6076FLECS_API
6078 const ecs_world_t *world,
6079 const ecs_table_t *table,
6080 ecs_entity_t relationship,
6081 int32_t index);
6082
6093FLECS_API
6095 const ecs_world_t *world,
6096 const ecs_table_t *table,
6097 ecs_entity_t rel);
6098
6108FLECS_API
6110 ecs_world_t *world,
6111 ecs_table_t *table,
6112 ecs_id_t component);
6113
6124FLECS_API
6126 ecs_world_t *world,
6127 const ecs_id_t *ids,
6128 int32_t id_count);
6129
6139FLECS_API
6141 ecs_world_t *world,
6142 ecs_table_t *table,
6143 ecs_id_t component);
6144
6160FLECS_API
6162 ecs_world_t *world,
6163 ecs_table_t *table);
6164
6171FLECS_API
6173 ecs_world_t *world,
6174 ecs_table_t *table);
6175
6185FLECS_API
6187 ecs_table_t *table,
6188 ecs_flags32_t flags);
6189
6197FLECS_API
6199 const ecs_table_t *table);
6200
6210FLECS_API
6212 ecs_world_t* world,
6213 ecs_table_t* table,
6214 int32_t row_1,
6215 int32_t row_2);
6216
6241FLECS_API
6243 ecs_world_t *world,
6244 ecs_entity_t entity,
6245 ecs_record_t *record,
6246 ecs_table_t *table,
6247 const ecs_type_t *added,
6248 const ecs_type_t *removed);
6249
6250
6270FLECS_API
6272 const ecs_world_t *world,
6273 const ecs_table_t *table,
6274 ecs_id_t component,
6275 ecs_id_t *component_out);
6276
6312FLECS_API
6314 const ecs_world_t *world,
6315 const ecs_table_t *table,
6316 int32_t offset,
6317 ecs_id_t component,
6318 ecs_id_t *component_out);
6319
6360FLECS_API
6362 const ecs_world_t *world,
6363 const ecs_table_t *table,
6364 int32_t offset,
6365 ecs_id_t component,
6366 ecs_entity_t rel,
6367 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
6368 ecs_entity_t *tgt_out,
6369 ecs_id_t *component_out,
6370 struct ecs_table_record_t **tr_out);
6371
6387FLECS_API
6389 const ecs_world_t *world,
6390 ecs_entity_t entity,
6391 ecs_id_t id,
6392 ecs_entity_t rel,
6393 bool self,
6395 ecs_entity_t *tgt_out,
6396 ecs_id_t *id_out,
6397 struct ecs_table_record_t **tr_out);
6398
6406FLECS_API
6408 ecs_world_t* world,
6409 ecs_table_t* table);
6410
6427FLECS_API
6429 const ecs_world_t *world,
6430 ecs_entity_t type,
6431 void *ptr);
6432
6440FLECS_API
6442 const ecs_world_t *world,
6443 const ecs_type_info_t *ti,
6444 void *ptr);
6445
6452FLECS_API
6454 ecs_world_t *world,
6455 ecs_entity_t type);
6456
6464 ecs_world_t *world,
6465 const ecs_type_info_t *ti);
6466
6475 const ecs_world_t *world,
6476 const ecs_type_info_t *ti,
6477 void *ptr);
6478
6486FLECS_API
6488 const ecs_world_t *world,
6489 ecs_entity_t type,
6490 void* ptr);
6491
6499FLECS_API
6501 ecs_world_t *world,
6502 ecs_entity_t type,
6503 void* ptr);
6504
6513FLECS_API
6515 const ecs_world_t *world,
6516 const ecs_type_info_t *ti,
6517 void* dst,
6518 const void *src);
6519
6528FLECS_API
6530 const ecs_world_t *world,
6531 ecs_entity_t type,
6532 void* dst,
6533 const void *src);
6534
6544 const ecs_world_t *world,
6545 const ecs_type_info_t *ti,
6546 void* dst,
6547 void *src);
6548
6558 const ecs_world_t *world,
6559 ecs_entity_t type,
6560 void* dst,
6561 void *src);
6562
6572 const ecs_world_t *world,
6573 const ecs_type_info_t *ti,
6574 void* dst,
6575 void *src);
6576
6586 const ecs_world_t *world,
6587 ecs_entity_t type,
6588 void* dst,
6589 void *src);
6590
6604#include "flecs/addons/flecs_c.h"
6605
6606#ifdef __cplusplus
6607}
6608#endif
6609
6610#include "flecs/private/addons.h"
6611
6612#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
Utility to hold a 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:493
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:428
struct ecs_ref_t ecs_ref_t
A ref is a fast way to fetch a component for a specific entity.
Definition flecs.h:477
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:381
struct ecs_table_record_t ecs_table_record_t
Opaque type for table record.
Definition flecs.h:527
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:425
struct ecs_mixins_t ecs_mixins_t
Type that stores poly mixins.
Definition flecs.h:517
uint64_t ecs_id_t
IDs are the things that can be added to an entity.
Definition flecs.h:374
struct ecs_observable_t ecs_observable_t
An observable produces events that can be listened for by an observer.
Definition flecs.h:461
struct ecs_record_t ecs_record_t
Information about an entity, like its table and row.
Definition flecs.h:490
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:431
void ecs_poly_t
A poly object.
Definition flecs.h:514
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:637
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:617
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:679
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:655
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:630
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:595
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:624
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:606
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:587
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:577
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:665
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:685
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:650
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:641
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:672
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:691
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:568
void(* ecs_ctx_free_t)(void *ctx)
Function to clean up context data.
Definition flecs.h:646
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:599
void(* ecs_xtor_t)(void *ptr, int32_t count, const ecs_type_info_t *type_info)
Constructor/destructor callback.
Definition flecs.h:659
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)
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.
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.
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:316
#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:310
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:326
#define FLECS_TREE_SPAWNER_DEPTH_CACHE_SIZE
Size of the depth cache in the tree spawner component.
Definition flecs.h:359
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.
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:725
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:704
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:714
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:728
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:726
@ EcsQueryCacheNone
No caching.
Definition flecs.h:729
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:727
@ EcsOut
Term is only written.
Definition flecs.h:710
@ EcsInOut
Term is both read and written.
Definition flecs.h:708
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:707
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:705
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:706
@ EcsIn
Term is only read.
Definition flecs.h:709
@ EcsNot
The term must not match.
Definition flecs.h:717
@ EcsOptional
The term may match.
Definition flecs.h:718
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:716
@ EcsOrFrom
Term must match at least one component from term ID.
Definition flecs.h:720
@ EcsAnd
The term must match.
Definition flecs.h:715
@ EcsNotFrom
Term must match none of the components from term ID.
Definition flecs.h:721
@ EcsAndFrom
Term must match all components from term ID.
Definition flecs.h:719
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.
int ecs_value_fini_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *ptr)
Destruct a value.
int ecs_value_fini(const ecs_world_t *world, ecs_entity_t type, void *ptr)
Destruct a value.
int ecs_value_copy(const ecs_world_t *world, ecs_entity_t type, void *dst, const void *src)
Copy a value.
int ecs_value_move(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move a value.
int ecs_value_move_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, void *src)
Move a value.
void * ecs_value_new_w_type_info(ecs_world_t *world, const ecs_type_info_t *ti)
Construct a value in new storage.
int ecs_value_move_ctor_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, void *src)
Move-construct a value.
int ecs_value_copy_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, const void *src)
Copy a value.
int ecs_value_init_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *ptr)
Construct a value in existing storage.
void * ecs_value_new(ecs_world_t *world, ecs_entity_t type)
Construct a value in new storage.
int ecs_value_free(ecs_world_t *world, ecs_entity_t type, void *ptr)
Destruct a value and free storage.
int ecs_value_move_ctor(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move-construct a value.
int ecs_value_init(const ecs_world_t *world, ecs_entity_t type, void *ptr)
Construct a value in existing storage.
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:1574
ecs_size_t size
Component size.
Definition flecs.h:1575
ecs_size_t alignment
Component alignment.
Definition flecs.h:1576
When added to an entity, this informs serialization formats which component to use when a value is as...
Definition flecs.h:1589
ecs_id_t component
Default component ID.
Definition flecs.h:1590
A (string) identifier.
Definition flecs.h:1565
ecs_size_t length
Length of identifier.
Definition flecs.h:1567
char * value
Identifier string.
Definition flecs.h:1566
ecs_hashmap_t * index
Current index.
Definition flecs.h:1570
uint64_t hash
Hash of current value.
Definition flecs.h:1568
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1569
Non-fragmenting ChildOf relationship.
Definition flecs.h:1594
ecs_entity_t value
Parent entity.
Definition flecs.h:1595
Component for storing a poly object.
Definition flecs.h:1580
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1581
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:1618
ecs_tree_spawner_t data[(6)]
Cache data indexed by depth.
Definition flecs.h:1619
Type with information about the current Flecs build.
Definition flecs.h:1464
const char ** flags
Compile-time settings.
Definition flecs.h:1467
int16_t version_major
Major Flecs version.
Definition flecs.h:1469
const char ** addons
Addons included in the build.
Definition flecs.h:1466
const char * version
Stringified version.
Definition flecs.h:1468
const char * compiler
Compiler used to compile Flecs.
Definition flecs.h:1465
bool sanitize
Is this a sanitize build?
Definition flecs.h:1473
bool perf_trace
Is this a perf tracing build?
Definition flecs.h:1474
int16_t version_minor
Minor Flecs version.
Definition flecs.h:1470
bool debug
Is this a debug build?
Definition flecs.h:1472
int16_t version_patch
Patch Flecs version.
Definition flecs.h:1471
Used with ecs_bulk_init().
Definition flecs.h:1088
ecs_id_t ids[32]
IDs to create the entities with.
Definition flecs.h:1098
void ** data
Array with component data to insert.
Definition flecs.h:1100
int32_t count
Number of entities to create/populate.
Definition flecs.h:1096
int32_t _canary
Used for validity testing.
Definition flecs.h:1089
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:1091
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1107
Used with ecs_component_init().
Definition flecs.h:1118
int32_t _canary
Used for validity testing.
Definition flecs.h:1119
ecs_type_info_t type
Parameters for type (size, hooks, ...).
Definition flecs.h:1125
ecs_entity_t entity
Existing entity to associate with a component (optional).
Definition flecs.h:1122
Used with ecs_delete_empty_tables().
Definition flecs.h:2752
uint16_t delete_generation
Delete table when generation > delete_generation.
Definition flecs.h:2757
double time_budget_seconds
Amount of time operation is allowed to spend.
Definition flecs.h:2760
uint16_t clear_generation
Free table data when generation > clear_generation.
Definition flecs.h:2754
int32_t offset
Table index to start scanning at.
Definition flecs.h:2764
Type returned by ecs_get_entities().
Definition flecs.h:2092
int32_t alive_count
Number of alive entity IDs.
Definition flecs.h:2095
int32_t count
Total number of entity IDs.
Definition flecs.h:2094
const ecs_entity_t * ids
Array with all entity IDs in the world.
Definition flecs.h:2093
Used with ecs_entity_init().
Definition flecs.h:1042
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:1054
const char * root_sep
Optional, used for identifiers relative to the root.
Definition flecs.h:1058
const char * name
Name of the entity.
Definition flecs.h:1049
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:1070
const char * symbol
Optional entity symbol.
Definition flecs.h:1060
int32_t _canary
Used for validity testing.
Definition flecs.h:1043
const ecs_id_t * add
0-terminated array of IDs to add to the entity.
Definition flecs.h:1075
const char * add_expr
String expression with components to add.
Definition flecs.h:1081
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:1078
ecs_entity_t id
Set to modify existing entity (optional).
Definition flecs.h:1045
ecs_entity_t parent
Parent entity.
Definition flecs.h:1047
Type that stores an entity id range.
Definition flecs.h:1548
uint32_t max
Last id in range (inclusive, 0 = unlimited).
Definition flecs.h:1550
uint32_t cur
Last issued id in range.
Definition flecs.h:1551
ecs_vec_t recycled
Recycled entity ids (vec<entity_t>).
Definition flecs.h:1552
uint32_t min
First id in range (inclusive).
Definition flecs.h:1549
Used with ecs_emit().
Definition flecs.h:1410
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1435
const void * const_param
Same as param, but with the guarantee that the value won't be modified.
Definition flecs.h:1446
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1420
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1432
ecs_table_t * other_table
Optional second table to notify.
Definition flecs.h:1424
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1427
const ecs_type_t * ids
Component IDs.
Definition flecs.h:1417
ecs_poly_t * observable
Observable (usually the world).
Definition flecs.h:1449
ecs_entity_t event
The event ID.
Definition flecs.h:1412
ecs_flags32_t flags
Event flags.
Definition flecs.h:1452
void * param
Optional context.
Definition flecs.h:1441
Header for ecs_poly_t objects.
Definition flecs.h:520
int32_t type
Magic number indicating which type of Flecs object.
Definition flecs.h:521
int32_t refcount
Refcount, to enable RAII handles.
Definition flecs.h:522
ecs_mixins_t * mixins
Table with offsets to (optional) mixins.
Definition flecs.h:523
Iterator.
Definition flecs.h:1166
ecs_world_t * real_world
Actual world.
Definition flecs.h:1169
void * param
Param passed to ecs_run().
Definition flecs.h:1202
ecs_entity_t event
The event (if applicable).
Definition flecs.h:1190
int32_t frame_offset
Offset relative to the start of iteration.
Definition flecs.h:1213
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1184
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1217
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1216
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1224
void * ctx
System context.
Definition flecs.h:1203
void * run_ctx
Run language binding context.
Definition flecs.h:1206
ecs_table_t * table
Current table.
Definition flecs.h:1178
int32_t offset
Offset relative to the current table.
Definition flecs.h:1172
ecs_id_t event_id
The (component) ID for the event.
Definition flecs.h:1191
ecs_iter_fini_action_t fini
Function to clean up iterator resources.
Definition flecs.h:1223
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1218
ecs_world_t * world
The world.
Definition flecs.h:1168
void * callback_ctx
Callback language binding context.
Definition flecs.h:1205
ecs_entity_t * sources
Entity on which the ID was matched (0 if same as entities).
Definition flecs.h:1181
void * binding_ctx
System binding context.
Definition flecs.h:1204
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1185
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1210
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1199
int8_t term_index
Index of the term that emitted an event.
Definition flecs.h:1196
ecs_entity_t system
The system (if applicable).
Definition flecs.h:1189
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1183
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1177
float delta_time
Time elapsed since last frame.
Definition flecs.h:1209
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1186
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1222
int8_t field_count
Number of fields in the iterator.
Definition flecs.h:1195
ecs_table_t * other_table
Previous or next table when adding or removing.
Definition flecs.h:1179
int32_t event_cur
Unique event ID.
Definition flecs.h:1192
const ecs_table_record_t ** trs
Info on where to find the field in the table.
Definition flecs.h:1176
int32_t count
Number of entities to iterate.
Definition flecs.h:1173
void ** ptrs
Component pointers.
Definition flecs.h:1175
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1221
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1174
ecs_id_t * ids
(Component) IDs.
Definition flecs.h:1180
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1182
Used with ecs_observer_init().
Definition flecs.h:1349
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1398
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1386
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1395
ecs_entity_t entity
Existing entity to associate with an observer (optional).
Definition flecs.h:1354
int32_t * last_event_id
Used for internal purposes.
Definition flecs.h:1401
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1389
void * ctx
User context to pass to callback.
Definition flecs.h:1383
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1357
ecs_flags32_t flags_
Used for internal purposes.
Definition flecs.h:1403
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1392
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1402
bool global_observer
Global observers are tied to the lifespan of the world.
Definition flecs.h:1369
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1372
bool yield_existing
When an observer is created, generate events from existing data.
Definition flecs.h:1364
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1380
ecs_entity_t events[8]
Events to observe (OnAdd, OnRemove, OnSet).
Definition flecs.h:1360
int32_t _canary
Used for validity testing.
Definition flecs.h:1351
An observer reacts to events matching a query.
Definition flecs.h:875
int32_t event_count
Number of events.
Definition flecs.h:882
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:884
ecs_entity_t entity
Entity associated with the observer.
Definition flecs.h:898
ecs_observable_t * observable
Observable for the observer.
Definition flecs.h:895
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:885
ecs_header_t hdr
Object header.
Definition flecs.h:876
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:891
ecs_entity_t events[8]
Observer events.
Definition flecs.h:881
void * run_ctx
Run language binding context.
Definition flecs.h:889
ecs_world_t * world
The world.
Definition flecs.h:897
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:893
void * callback_ctx
Callback language binding context.
Definition flecs.h:888
void * ctx
Observer context.
Definition flecs.h:887
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:892
ecs_query_t * query
Observer query.
Definition flecs.h:878
Struct returned by ecs_query_count().
Definition flecs.h:5222
int32_t entities
Number of entities returned by the query.
Definition flecs.h:5224
int32_t results
Number of results returned by the query.
Definition flecs.h:5223
int32_t tables
Number of tables returned by the query.
Definition flecs.h:5225
Used with ecs_query_init().
Definition flecs.h:1275
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1336
ecs_id_t group_by
Component ID to be used for grouping.
Definition flecs.h:1306
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1280
int32_t _canary
Used for validity testing.
Definition flecs.h:1277
void * ctx
User context to pass to callback.
Definition flecs.h:1330
ecs_ctx_free_t group_by_ctx_free
Function to free group_by_ctx.
Definition flecs.h:1327
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1324
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1333
ecs_entity_t order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition flecs.h:1302
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1294
ecs_group_create_action_t on_group_create
Callback that is invoked when a new group is created.
Definition flecs.h:1317
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:1342
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1339
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1313
ecs_group_delete_action_t on_group_delete
Callback that is invoked when an existing group is deleted.
Definition flecs.h:1321
ecs_sort_table_action_t order_by_table_callback
Callback used for ordering query results.
Definition flecs.h:1298
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1289
ecs_query_cache_kind_t cache_kind
Caching policy of the query.
Definition flecs.h:1286
const char * expr
Query DSL expression (optional).
Definition flecs.h:1283
Type that contains information about a query group.
Definition flecs.h:1538
int32_t table_count
Number of tables in group.
Definition flecs.h:1541
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1542
uint64_t id
Group ID.
Definition flecs.h:1539
int32_t match_count
How often tables have been matched or unmatched.
Definition flecs.h:1540
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:834
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:854
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:851
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:853
ecs_header_t hdr
Object header.
Definition flecs.h:835
int8_t var_count
Number of query variables.
Definition flecs.h:843
ecs_flags32_t fixed_fields
Bitmasks for quick field information lookups.
Definition flecs.h:848
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:849
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:852
int32_t eval_count
Number of times the query is evaluated.
Definition flecs.h:869
ecs_world_t * world
World or stage the query was created with.
Definition flecs.h:867
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:850
uint64_t bloom_filter
Bitmask used to quickly discard tables.
Definition flecs.h:841
ecs_world_t * real_world
Actual world.
Definition flecs.h:866
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:856
ecs_entity_t entity
Entity associated with query (optional).
Definition flecs.h:865
void * ctx
User context to pass to callback.
Definition flecs.h:862
int32_t * sizes
Component sizes.
Definition flecs.h:838
ecs_id_t * ids
Component ids.
Definition flecs.h:839
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:855
ecs_term_t * terms
Query terms.
Definition flecs.h:837
ecs_query_cache_kind_t cache_kind
Caching policy of the query.
Definition flecs.h:858
int8_t term_count
Number of query terms.
Definition flecs.h:844
char ** vars
Array with variable names for the iterator.
Definition flecs.h:860
int8_t field_count
Number of fields returned by the query.
Definition flecs.h:845
ecs_flags32_t flags
Query flags.
Definition flecs.h:842
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:863
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:795
const char * name
Name.
Definition flecs.h:802
ecs_entity_t id
Entity ID.
Definition flecs.h:796
Type that describes a term (single element in a query).
Definition flecs.h:810
ecs_term_ref_t src
Source of term.
Definition flecs.h:816
int8_t field_index
Index of the field for the term in the iterator.
Definition flecs.h:827
ecs_id_t id
Component ID to be matched by term.
Definition flecs.h:811
int16_t oper
Operator of term.
Definition flecs.h:825
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:818
ecs_flags16_t flags_
Flags that help evaluation, set by ecs_query_init().
Definition flecs.h:828
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:820
int16_t inout
Access to contents matched by term.
Definition flecs.h:824
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:817
Component with data to instantiate a non-fragmenting tree.
Definition flecs.h:1599
uint32_t child
Prefab child entity (without generation).
Definition flecs.h:1602
int32_t parent_index
Index into the children vector.
Definition flecs.h:1603
const char * child_name
Name of the prefab child.
Definition flecs.h:1600
ecs_table_t * table
Table in which the child will be stored.
Definition flecs.h:1601
Tree spawner data for a single hierarchy depth.
Definition flecs.h:1607
ecs_vec_t children
vector<ecs_tree_spawner_child_t>.
Definition flecs.h:1608
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:957
void * lifecycle_ctx
Component lifecycle context (see meta addon).
Definition flecs.h:1008
void * ctx
User-defined context.
Definition flecs.h:1006
ecs_iter_action_t on_remove
Callback that is invoked when an instance of the component is removed.
Definition flecs.h:998
void * binding_ctx
Language binding context.
Definition flecs.h:1007
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:972
ecs_flags32_t flags
Hook flags.
Definition flecs.h:984
ecs_cmp_t cmp
Compare hook.
Definition flecs.h:975
ecs_copy_t copy
copy assignment.
Definition flecs.h:953
ecs_ctx_free_t lifecycle_ctx_free
Callback to free lifecycle_ctx.
Definition flecs.h:1012
ecs_iter_action_t on_set
Callback that is invoked when an instance of the component is set.
Definition flecs.h:993
ecs_move_t move
move assignment.
Definition flecs.h:954
ecs_xtor_t ctor
ctor.
Definition flecs.h:951
ecs_iter_action_t on_replace
Callback that is invoked with the existing and new value before the value is assigned.
Definition flecs.h:1004
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1010
ecs_iter_action_t on_add
Callback that is invoked when an instance of a component is added.
Definition flecs.h:988
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1011
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:960
ecs_equals_t equals
Equals hook.
Definition flecs.h:978
ecs_move_t ctor_move_dtor
Ctor + move + dtor (or move_ctor + dtor).
Definition flecs.h:966
ecs_xtor_t dtor
dtor.
Definition flecs.h:952
Type that contains component information (passed to ctors/dtors/...).
Definition flecs.h:1019
ecs_size_t alignment
Alignment of the type.
Definition flecs.h:1021
ecs_size_t size
Size of the type.
Definition flecs.h:1020
const char * name
Type name.
Definition flecs.h:1024
ecs_entity_t component
Handle to component (do not set).
Definition flecs.h:1023
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:1022
A type is a list of (component) IDs.
Definition flecs.h:398
ecs_id_t * array
Array with IDs.
Definition flecs.h:399
int32_t count
Number of elements in array.
Definition flecs.h:400
Utility to hold a value of a dynamic type.
Definition flecs.h:1033
void * ptr
Pointer to value.
Definition flecs.h:1035
ecs_entity_t type
Type of value.
Definition flecs.h:1034
Type that contains information about the world.
Definition flecs.h:1478
int64_t observers_ran_total
Total number of times an observer was invoked.
Definition flecs.h:1504
float delta_time
Time passed to or computed by ecs_progress().
Definition flecs.h:1482
int64_t systems_ran_total
Total number of systems run.
Definition flecs.h:1503
int64_t set_count
Set commands processed.
Definition flecs.h:1521
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1490
int32_t tag_id_count
Number of tag (no data) IDs in the world.
Definition flecs.h:1507
int32_t component_id_count
Number of component (data) IDs in the world.
Definition flecs.h:1508
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1502
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1495
int32_t table_count
Number of tables.
Definition flecs.h:1511
float delta_time_raw
Raw delta time (no time scaling).
Definition flecs.h:1481
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1485
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1500
float system_time_total
Total time spent in systems.
Definition flecs.h:1486
int64_t id_delete_total
Total number of times an ID was deleted.
Definition flecs.h:1499
float merge_time_total
Total time spent in merges.
Definition flecs.h:1488
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:1524
int64_t clear_count
Clear commands processed.
Definition flecs.h:1520
ecs_entity_t last_component_id
Last issued component entity ID.
Definition flecs.h:1479
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1493
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1494
int64_t other_count
Other commands processed.
Definition flecs.h:1526
int64_t batched_command_count
Commands batched.
Definition flecs.h:1528
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1501
int64_t queries_ran_total
Total number of times a query was evaluated.
Definition flecs.h:1505
int64_t delete_count
Delete commands processed.
Definition flecs.h:1519
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1496
int64_t id_create_total
Total number of times a new ID was created.
Definition flecs.h:1498
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1527
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1483
int32_t pair_id_count
Number of pair IDs in the world.
Definition flecs.h:1509
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1489
int64_t ensure_count
Ensure or emplace commands processed.
Definition flecs.h:1522
float target_fps
Target FPS.
Definition flecs.h:1484
double world_time_total_raw
Time elapsed in simulation (no scaling).
Definition flecs.h:1491
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1487
uint32_t creation_time
Time when world was created.
Definition flecs.h:1513
int64_t modified_count
Modified commands processed.
Definition flecs.h:1523
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1531
int64_t event_count
Enqueued custom events.
Definition flecs.h:1525
int64_t add_count
Add commands processed.
Definition flecs.h:1517
int64_t remove_count
Remove commands processed.
Definition flecs.h:1518