Flecs v4.0
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
flecs.h
Go to the documentation of this file.
1
8#ifndef FLECS_H
9#define FLECS_H
10
33/* Flecs version macros */
34#define FLECS_VERSION_MAJOR 4
35#define FLECS_VERSION_MINOR 0
36#define FLECS_VERSION_PATCH 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
65// #define FLECS_LEGACY
66
72// #define FLECS_ACCURATE_COUNTERS
73
79// #define FLECS_DISABLE_COUNTERS
80
81/* Make sure provided configuration is valid */
82#if defined(FLECS_DEBUG) && defined(FLECS_NDEBUG)
83#error "invalid configuration: cannot both define FLECS_DEBUG and FLECS_NDEBUG"
84#endif
85#if defined(FLECS_DEBUG) && defined(NDEBUG)
86#error "invalid configuration: cannot both define FLECS_DEBUG and NDEBUG"
87#endif
88
93#if !defined(FLECS_DEBUG) && !defined(FLECS_NDEBUG)
94#if defined(NDEBUG)
95#define FLECS_NDEBUG
96#else
97#define FLECS_DEBUG
98#endif
99#endif
100
105#ifdef FLECS_SANITIZE
106#ifndef FLECS_DEBUG
107#define FLECS_DEBUG /* If sanitized mode is enabled, so is debug mode */
108#endif
109#endif
110
115#ifdef FLECS_DEBUG
116#ifndef FLECS_DEBUG_INFO
117#define FLECS_DEBUG_INFO
118#endif
119#endif
120
121/* Tip: if you see weird behavior that you think might be a bug, make sure to
122 * test with the FLECS_DEBUG or FLECS_SANITIZE flags enabled. There's a good
123 * chance that this gives you more information about the issue! */
124
138// #define FLECS_SOFT_ASSERT
139
145// #define FLECS_KEEP_ASSERT
146
153// #define FLECS_DEFAULT_TO_UNCACHED_QUERIES
154
163// #define FLECS_CPP_NO_AUTO_REGISTRATION
164
172// #define FLECS_CPP_NO_ENUM_REFLECTION
173
178// #define FLECS_NO_ALWAYS_INLINE
179
207// #define FLECS_CUSTOM_BUILD
208
209#ifndef FLECS_CUSTOM_BUILD
210#define FLECS_ALERTS
211#define FLECS_APP
212// #define FLECS_C /**< C API convenience macros, always enabled */
213#define FLECS_CPP
214#define FLECS_DOC
215// #define FLECS_JOURNAL /**< Journaling addon */
216#define FLECS_JSON
217#define FLECS_HTTP
218#define FLECS_LOG
219#define FLECS_META
220#define FLECS_METRICS
221#define FLECS_MODULE
222#define FLECS_OS_API_IMPL
223// #define FLECS_PERF_TRACE /**< Enable performance tracing */
224#define FLECS_PIPELINE
225#define FLECS_REST
226#define FLECS_PARSER
227#define FLECS_QUERY_DSL
228#define FLECS_SCRIPT
229// #define FLECS_SCRIPT_MATH /**< Math functions for flecs script (may require linking with libm) */
230#define FLECS_SYSTEM
231#define FLECS_STATS
232#define FLECS_TIMER
233#define FLECS_UNITS
234#endif // ifndef FLECS_CUSTOM_BUILD
235
239// #define FLECS_LOW_FOOTPRINT
240#ifdef FLECS_LOW_FOOTPRINT
241#define FLECS_HI_COMPONENT_ID (16)
242#define FLECS_HI_ID_RECORD_ID (16)
243#define FLECS_ENTITY_PAGE_BITS (6)
244#define FLECS_USE_OS_ALLOC
245#define FLECS_DEFAULT_TO_UNCACHED_QUERIES
246#endif
247
258#ifndef FLECS_HI_COMPONENT_ID
259#define FLECS_HI_COMPONENT_ID (256)
260#endif
261
268#ifndef FLECS_HI_ID_RECORD_ID
269#define FLECS_HI_ID_RECORD_ID (1024)
270#endif
271
277#ifndef FLECS_SPARSE_PAGE_BITS
278#define FLECS_SPARSE_PAGE_BITS (6)
279#endif
280
283#ifndef FLECS_ENTITY_PAGE_BITS
284#define FLECS_ENTITY_PAGE_BITS (10)
285#endif
286
291// #define FLECS_USE_OS_ALLOC
292
295#ifndef FLECS_ID_DESC_MAX
296#define FLECS_ID_DESC_MAX (32)
297#endif
298
301#ifndef FLECS_EVENT_DESC_MAX
302#define FLECS_EVENT_DESC_MAX (8)
303#endif
304
307#define FLECS_VARIABLE_COUNT_MAX (64)
308
311#ifndef FLECS_TERM_COUNT_MAX
312#define FLECS_TERM_COUNT_MAX 32
313#endif
314
317#ifndef FLECS_TERM_ARG_COUNT_MAX
318#define FLECS_TERM_ARG_COUNT_MAX (16)
319#endif
320
323#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
324#define FLECS_QUERY_VARIABLE_COUNT_MAX (64)
325#endif
326
329#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
330#define FLECS_QUERY_SCOPE_NESTING_MAX (8)
331#endif
332
337#ifndef FLECS_DAG_DEPTH_MAX
338#define FLECS_DAG_DEPTH_MAX (128)
339#endif
340
343#include "flecs/private/api_defines.h"
344#include "flecs/datastructures/vec.h" /* Vector datatype */
345#include "flecs/datastructures/sparse.h" /* Sparse set */
346#include "flecs/datastructures/block_allocator.h" /* Block allocator */
347#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
348#include "flecs/datastructures/map.h" /* Map */
349#include "flecs/datastructures/switch_list.h" /* Switch list */
350#include "flecs/datastructures/allocator.h" /* Allocator */
351#include "flecs/datastructures/strbuf.h" /* String builder */
352#include "flecs/os_api.h" /* Abstraction for operating system functions */
353
354#ifdef __cplusplus
355extern "C" {
356#endif
357
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
526typedef struct ecs_table_record_t ecs_table_record_t;
527
546typedef void (*ecs_run_action_t)(
547 ecs_iter_t *it);
548
555typedef void (*ecs_iter_action_t)(
556 ecs_iter_t *it);
557
566 ecs_iter_t *it);
567
574 ecs_iter_t *it);
575
578 ecs_entity_t e1,
579 const void *ptr1,
580 ecs_entity_t e2,
581 const void *ptr2);
582
585 ecs_world_t* world,
586 ecs_table_t* table,
587 ecs_entity_t* entities,
588 void* ptr,
589 int32_t size,
590 int32_t lo,
591 int32_t hi,
592 ecs_order_by_action_t order_by);
593
595typedef uint64_t (*ecs_group_by_action_t)(
596 ecs_world_t *world,
597 ecs_table_t *table,
598 ecs_id_t group_id,
599 void *ctx);
600
602typedef void* (*ecs_group_create_action_t)(
603 ecs_world_t *world,
604 uint64_t group_id,
605 void *group_by_ctx); /* from ecs_query_desc_t */
606
609 ecs_world_t *world,
610 uint64_t group_id,
611 void *group_ctx, /* return value from ecs_group_create_action_t */
612 void *group_by_ctx); /* from ecs_query_desc_t */
613
615typedef void (*ecs_module_action_t)(
616 ecs_world_t *world);
617
619typedef void (*ecs_fini_action_t)(
620 ecs_world_t *world,
621 void *ctx);
622
624typedef void (*ecs_ctx_free_t)(
625 void *ctx);
626
628typedef int (*ecs_compare_action_t)(
629 const void *ptr1,
630 const void *ptr2);
631
633typedef uint64_t (*ecs_hash_value_action_t)(
634 const void *ptr);
635
637typedef void (*ecs_xtor_t)(
638 void *ptr,
639 int32_t count,
640 const ecs_type_info_t *type_info);
641
643typedef void (*ecs_copy_t)(
644 void *dst_ptr,
645 const void *src_ptr,
646 int32_t count,
647 const ecs_type_info_t *type_info);
648
650typedef void (*ecs_move_t)(
651 void *dst_ptr,
652 void *src_ptr,
653 int32_t count,
654 const ecs_type_info_t *type_info);
655
657typedef int (*ecs_cmp_t)(
658 const void *a_ptr,
659 const void *b_ptr,
660 const ecs_type_info_t *type_info);
661
663typedef bool (*ecs_equals_t)(
664 const void *a_ptr,
665 const void *b_ptr,
666 const ecs_type_info_t *type_info);
667
669typedef void (*flecs_poly_dtor_t)(
670 ecs_poly_t *poly);
671
690
701
709
710/* Term id flags */
711
716#define EcsSelf (1llu << 63)
717
722#define EcsUp (1llu << 62)
723
728#define EcsTrav (1llu << 61)
729
734#define EcsCascade (1llu << 60)
735
740#define EcsDesc (1llu << 59)
741
746#define EcsIsVariable (1llu << 58)
747
752#define EcsIsEntity (1llu << 57)
753
758#define EcsIsName (1llu << 56)
759
764#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
765
770#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
771
786
808
816 int32_t *sizes;
819 uint64_t bloom_filter;
820 ecs_flags32_t flags;
821 int8_t var_count;
822 int8_t term_count;
823 int8_t field_count;
825 /* Bitmasks for quick field information lookups */
826 ecs_termset_t fixed_fields;
827 ecs_termset_t var_fields;
828 ecs_termset_t static_id_fields;
829 ecs_termset_t data_fields;
830 ecs_termset_t write_fields;
831 ecs_termset_t read_fields;
832 ecs_termset_t row_fields;
834 ecs_termset_t set_fields;
838 char **vars;
840 void *ctx;
847 int32_t eval_count;
848};
849
878
886/* Flags that can be used to check which hooks a type has set */
887#define ECS_TYPE_HOOK_CTOR ECS_CAST(ecs_flags32_t, 1 << 0)
888#define ECS_TYPE_HOOK_DTOR ECS_CAST(ecs_flags32_t, 1 << 1)
889#define ECS_TYPE_HOOK_COPY ECS_CAST(ecs_flags32_t, 1 << 2)
890#define ECS_TYPE_HOOK_MOVE ECS_CAST(ecs_flags32_t, 1 << 3)
891#define ECS_TYPE_HOOK_COPY_CTOR ECS_CAST(ecs_flags32_t, 1 << 4)
892#define ECS_TYPE_HOOK_MOVE_CTOR ECS_CAST(ecs_flags32_t, 1 << 5)
893#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 6)
894#define ECS_TYPE_HOOK_MOVE_DTOR ECS_CAST(ecs_flags32_t, 1 << 7)
895#define ECS_TYPE_HOOK_CMP ECS_CAST(ecs_flags32_t, 1 << 8)
896#define ECS_TYPE_HOOK_EQUALS ECS_CAST(ecs_flags32_t, 1 << 9)
897
898
899/* Flags that can be used to set/check which hooks of a type are invalid */
900#define ECS_TYPE_HOOK_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 10)
901#define ECS_TYPE_HOOK_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 12)
902#define ECS_TYPE_HOOK_COPY_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 13)
903#define ECS_TYPE_HOOK_MOVE_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 14)
904#define ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 15)
905#define ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 16)
906#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 17)
907#define ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 18)
908#define ECS_TYPE_HOOK_CMP_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 19)
909#define ECS_TYPE_HOOK_EQUALS_ILLEGAL ECS_CAST(ecs_flags32_t, 1 << 20)
910
911
912/* All valid hook flags */
913#define ECS_TYPE_HOOKS (ECS_TYPE_HOOK_CTOR|ECS_TYPE_HOOK_DTOR|\
914 ECS_TYPE_HOOK_COPY|ECS_TYPE_HOOK_MOVE|ECS_TYPE_HOOK_COPY_CTOR|\
915 ECS_TYPE_HOOK_MOVE_CTOR|ECS_TYPE_HOOK_CTOR_MOVE_DTOR|\
916 ECS_TYPE_HOOK_MOVE_DTOR|ECS_TYPE_HOOK_CMP|ECS_TYPE_HOOK_EQUALS)
917
918/* All invalid hook flags */
919#define ECS_TYPE_HOOKS_ILLEGAL (ECS_TYPE_HOOK_CTOR_ILLEGAL|\
920 ECS_TYPE_HOOK_DTOR_ILLEGAL|ECS_TYPE_HOOK_COPY_ILLEGAL|\
921 ECS_TYPE_HOOK_MOVE_ILLEGAL|ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL|\
922 ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL|ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL|\
923 ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL|ECS_TYPE_HOOK_CMP_ILLEGAL|\
924 ECS_TYPE_HOOK_EQUALS_ILLEGAL)
984
996
997#include "flecs/private/api_types.h" /* Supporting API types */
998#include "flecs/private/api_support.h" /* Supporting API functions */
999#include "flecs/datastructures/hashmap.h" /* Hashmap */
1000#include "flecs/private/api_internals.h" /* Supporting API functions */
1001
1007
1012typedef struct ecs_entity_desc_t {
1013 int32_t _canary;
1019 const char *name;
1024 const char *sep;
1028 const char *root_sep;
1030 const char *symbol;
1046
1049
1051 const char *add_expr;
1053
1083
1097
1137 /* World */
1141 /* Matched data */
1143 const ecs_size_t *sizes;
1147 ecs_var_t *variables;
1148 const ecs_table_record_t **trs;
1150 ecs_flags64_t constrained_vars;
1151 uint64_t group_id;
1152 ecs_termset_t set_fields;
1153 ecs_termset_t ref_fields;
1154 ecs_termset_t row_fields;
1155 ecs_termset_t up_fields;
1157 /* Input information */
1161 int32_t event_cur;
1163 /* Query information */
1165 int8_t term_index;
1172 /* Context */
1173 void *param;
1174 void *ctx;
1177 void *run_ctx;
1179 /* Time */
1183 /* Iterator counters */
1185 int32_t offset;
1186 int32_t count;
1188 /* Misc */
1189 ecs_flags32_t flags;
1191 ecs_iter_private_t priv_;
1193 /* Chained iterators */
1198};
1199
1200
1205#define EcsQueryMatchPrefab (1u << 1u)
1206
1211#define EcsQueryMatchDisabled (1u << 2u)
1212
1217#define EcsQueryMatchEmptyTables (1u << 3u)
1218
1223#define EcsQueryAllowUnresolvedByName (1u << 6u)
1224
1229#define EcsQueryTableOnly (1u << 7u)
1230
1231
1305
1367
1372typedef struct ecs_event_desc_t {
1375
1380
1383
1387
1389 int32_t offset;
1390
1394 int32_t count;
1395
1398
1403 void *param;
1404
1408 const void *const_param;
1409
1412
1414 ecs_flags32_t flags;
1416
1417
1426typedef struct ecs_build_info_t {
1427 const char *compiler;
1428 const char **addons;
1429 const char *version;
1433 bool debug;
1437
1496
1503
1514typedef struct EcsIdentifier {
1515 char *value;
1516 ecs_size_t length;
1517 uint64_t hash;
1518 uint64_t index_hash;
1519 ecs_hashmap_t *index;
1521
1523typedef struct EcsComponent {
1524 ecs_size_t size;
1525 ecs_size_t alignment;
1527
1532
1541
1545/* Only include deprecated definitions if deprecated addon is required */
1546#ifdef FLECS_DEPRECATED
1548#endif
1549
1565FLECS_API extern const ecs_id_t ECS_PAIR;
1566
1568FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1569
1571FLECS_API extern const ecs_id_t ECS_TOGGLE;
1572
1580/* Builtin component ids */
1581
1583FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1584
1586FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1587
1589FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1590
1592FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1593
1595FLECS_API extern const ecs_entity_t EcsQuery;
1596
1598FLECS_API extern const ecs_entity_t EcsObserver;
1599
1601FLECS_API extern const ecs_entity_t EcsSystem;
1602
1604FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1605
1607FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1608
1610FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1611
1613FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1614
1616FLECS_API extern const ecs_entity_t EcsFlecs;
1617
1619FLECS_API extern const ecs_entity_t EcsFlecsCore;
1620
1622FLECS_API extern const ecs_entity_t EcsWorld;
1623
1625FLECS_API extern const ecs_entity_t EcsWildcard;
1626
1628FLECS_API extern const ecs_entity_t EcsAny;
1629
1631FLECS_API extern const ecs_entity_t EcsThis;
1632
1634FLECS_API extern const ecs_entity_t EcsVariable;
1635
1637#define EcsSingleton EcsVariable
1638
1646FLECS_API extern const ecs_entity_t EcsTransitive;
1647
1655FLECS_API extern const ecs_entity_t EcsReflexive;
1656
1667FLECS_API extern const ecs_entity_t EcsFinal;
1668
1674FLECS_API extern const ecs_entity_t EcsInheritable;
1675
1677FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1678
1682FLECS_API extern const ecs_entity_t EcsOverride;
1683
1687FLECS_API extern const ecs_entity_t EcsInherit;
1688
1693FLECS_API extern const ecs_entity_t EcsDontInherit;
1694
1702FLECS_API extern const ecs_entity_t EcsSymmetric;
1703
1713FLECS_API extern const ecs_entity_t EcsExclusive;
1714
1716FLECS_API extern const ecs_entity_t EcsAcyclic;
1717
1720FLECS_API extern const ecs_entity_t EcsTraversable;
1721
1731FLECS_API extern const ecs_entity_t EcsWith;
1732
1742FLECS_API extern const ecs_entity_t EcsOneOf;
1743
1745FLECS_API extern const ecs_entity_t EcsCanToggle;
1746
1750FLECS_API extern const ecs_entity_t EcsTrait;
1751
1761FLECS_API extern const ecs_entity_t EcsRelationship;
1762
1772FLECS_API extern const ecs_entity_t EcsTarget;
1773
1776FLECS_API extern const ecs_entity_t EcsPairIsTag;
1777
1779FLECS_API extern const ecs_entity_t EcsName;
1780
1782FLECS_API extern const ecs_entity_t EcsSymbol;
1783
1785FLECS_API extern const ecs_entity_t EcsAlias;
1786
1788FLECS_API extern const ecs_entity_t EcsChildOf;
1789
1791FLECS_API extern const ecs_entity_t EcsIsA;
1792
1794FLECS_API extern const ecs_entity_t EcsDependsOn;
1795
1797FLECS_API extern const ecs_entity_t EcsSlotOf;
1798
1800FLECS_API extern const ecs_entity_t EcsModule;
1801
1803FLECS_API extern const ecs_entity_t EcsPrivate;
1804
1807FLECS_API extern const ecs_entity_t EcsPrefab;
1808
1811FLECS_API extern const ecs_entity_t EcsDisabled;
1812
1816FLECS_API extern const ecs_entity_t EcsNotQueryable;
1817
1819FLECS_API extern const ecs_entity_t EcsOnAdd;
1820
1822FLECS_API extern const ecs_entity_t EcsOnRemove;
1823
1825FLECS_API extern const ecs_entity_t EcsOnSet;
1826
1828FLECS_API extern const ecs_entity_t EcsMonitor;
1829
1831FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1832
1834FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1835
1837FLECS_API extern const ecs_entity_t EcsOnDelete;
1838
1841FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1842
1845FLECS_API extern const ecs_entity_t EcsRemove;
1846
1849FLECS_API extern const ecs_entity_t EcsDelete;
1850
1853FLECS_API extern const ecs_entity_t EcsPanic;
1854
1856FLECS_API extern const ecs_entity_t EcsSparse;
1857
1859FLECS_API extern const ecs_entity_t EcsDontFragment;
1860
1862FLECS_API extern const ecs_entity_t EcsUnion;
1863
1865FLECS_API extern const ecs_entity_t EcsPredEq;
1866
1868FLECS_API extern const ecs_entity_t EcsPredMatch;
1869
1871FLECS_API extern const ecs_entity_t EcsPredLookup;
1872
1874FLECS_API extern const ecs_entity_t EcsScopeOpen;
1875
1877FLECS_API extern const ecs_entity_t EcsScopeClose;
1878
1883FLECS_API extern const ecs_entity_t EcsEmpty;
1884
1885FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
1886FLECS_API extern const ecs_entity_t EcsOnStart;
1887FLECS_API extern const ecs_entity_t EcsPreFrame;
1888FLECS_API extern const ecs_entity_t EcsOnLoad;
1889FLECS_API extern const ecs_entity_t EcsPostLoad;
1890FLECS_API extern const ecs_entity_t EcsPreUpdate;
1891FLECS_API extern const ecs_entity_t EcsOnUpdate;
1892FLECS_API extern const ecs_entity_t EcsOnValidate;
1893FLECS_API extern const ecs_entity_t EcsPostUpdate;
1894FLECS_API extern const ecs_entity_t EcsPreStore;
1895FLECS_API extern const ecs_entity_t EcsOnStore;
1896FLECS_API extern const ecs_entity_t EcsPostFrame;
1897FLECS_API extern const ecs_entity_t EcsPhase;
1899FLECS_API extern const ecs_entity_t EcsConstant;
1903#define EcsLastInternalComponentId (ecs_id(EcsPoly))
1904
1907#define EcsFirstUserComponentId (8)
1908
1911#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
1912
1913/* When visualized the reserved id ranges look like this:
1914 * - [1..8]: Builtin components
1915 * - [9..FLECS_HI_COMPONENT_ID]: Low ids reserved for application components
1916 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Builtin entities
1917 */
1918
1940FLECS_API
1942
1949FLECS_API
1951
1959FLECS_API
1961 int argc,
1962 char *argv[]);
1963
1970FLECS_API
1972 ecs_world_t *world);
1973
1981FLECS_API
1983 const ecs_world_t *world);
1984
1992FLECS_API
1994 ecs_world_t *world,
1995 ecs_fini_action_t action,
1996 void *ctx);
1997
2004
2031FLECS_API
2033 const ecs_world_t *world);
2034
2042FLECS_API
2044 const ecs_world_t *world);
2045
2071FLECS_API
2073 ecs_world_t *world,
2074 ecs_ftime_t delta_time);
2075
2082FLECS_API
2084 ecs_world_t *world);
2085
2093FLECS_API
2095 ecs_world_t *world,
2096 ecs_fini_action_t action,
2097 void *ctx);
2098
2105FLECS_API
2107 ecs_world_t *world);
2108
2115FLECS_API
2117 const ecs_world_t *world);
2118
2131 ecs_world_t *world,
2132 bool enable);
2133
2145 ecs_world_t *world,
2146 bool enable);
2147
2163FLECS_API
2165 ecs_world_t *world,
2166 ecs_ftime_t fps);
2167
2181FLECS_API
2183 ecs_world_t *world,
2184 ecs_flags32_t flags);
2185
2262FLECS_API
2264 ecs_world_t *world,
2265 bool multi_threaded);
2266
2274FLECS_API
2276 ecs_world_t *world);
2277
2288FLECS_API
2290 ecs_world_t *world);
2291
2307FLECS_API
2309 ecs_world_t *world);
2310
2321FLECS_API
2323 const ecs_world_t *world);
2324
2338FLECS_API
2340 ecs_world_t *world);
2341
2356FLECS_API
2358 ecs_world_t *world);
2359
2370FLECS_API
2372 ecs_world_t *world);
2373
2387FLECS_API
2389 ecs_world_t *world,
2390 int32_t stages);
2391
2398FLECS_API
2400 const ecs_world_t *world);
2401
2417FLECS_API
2419 const ecs_world_t *world,
2420 int32_t stage_id);
2421
2429FLECS_API
2431 const ecs_world_t *world);
2432
2440FLECS_API
2442 ecs_world_t *world);
2443
2448FLECS_API
2450 ecs_world_t *stage);
2451
2459FLECS_API
2461 const ecs_world_t *world);
2462
2478FLECS_API
2480 ecs_world_t *world,
2481 void *ctx,
2482 ecs_ctx_free_t ctx_free);
2483
2492FLECS_API
2494 ecs_world_t *world,
2495 void *ctx,
2496 ecs_ctx_free_t ctx_free);
2497
2505FLECS_API
2507 const ecs_world_t *world);
2508
2516FLECS_API
2518 const ecs_world_t *world);
2519
2525FLECS_API
2527
2533FLECS_API
2535 const ecs_world_t *world);
2536
2545FLECS_API
2547 ecs_world_t *world,
2548 int32_t entity_count);
2549
2564FLECS_API
2566 ecs_world_t *world);
2567
2583FLECS_API
2585 ecs_world_t *world,
2586 ecs_entity_t id_start,
2587 ecs_entity_t id_end);
2588
2599FLECS_API
2601 ecs_world_t *world,
2602 bool enable);
2603
2609FLECS_API
2611 const ecs_world_t *world);
2612
2626FLECS_API
2628 ecs_world_t *world,
2629 ecs_flags32_t flags);
2630
2642
2672FLECS_API
2674 ecs_world_t *world,
2675 const ecs_delete_empty_tables_desc_t *desc);
2676
2682FLECS_API
2684 const ecs_poly_t *poly);
2685
2691FLECS_API
2693 const ecs_poly_t *poly);
2694
2708FLECS_API
2710 const ecs_poly_t *object,
2711 int32_t type);
2712
2716#define flecs_poly_is(object, type)\
2717 flecs_poly_is_(object, type##_magic)
2718
2727FLECS_API
2729 ecs_entity_t first,
2730 ecs_entity_t second);
2731
2749FLECS_API
2751 ecs_world_t *world);
2752
2764FLECS_API
2766 ecs_world_t *world);
2767
2794FLECS_API
2796 ecs_world_t *world);
2797
2815FLECS_API
2817 ecs_world_t *world);
2818
2827FLECS_API
2829 ecs_world_t *world,
2830 ecs_id_t id);
2831
2839FLECS_API
2841 ecs_world_t *world,
2842 ecs_table_t *table);
2843
2862FLECS_API
2864 ecs_world_t *world,
2865 const ecs_entity_desc_t *desc);
2866
2893FLECS_API
2895 ecs_world_t *world,
2896 const ecs_bulk_desc_t *desc);
2897
2907FLECS_API
2909 ecs_world_t *world,
2910 ecs_id_t id,
2911 int32_t count);
2912
2928FLECS_API
2930 ecs_world_t *world,
2931 ecs_entity_t dst,
2932 ecs_entity_t src,
2933 bool copy_value);
2934
2943FLECS_API
2945 ecs_world_t *world,
2946 ecs_entity_t entity);
2947
2955FLECS_API
2957 ecs_world_t *world,
2958 ecs_id_t id);
2959
2977FLECS_API
2979 ecs_world_t *world,
2980 ecs_entity_t entity,
2981 ecs_id_t id);
2982
2991FLECS_API
2993 ecs_world_t *world,
2994 ecs_entity_t entity,
2995 ecs_id_t id);
2996
3048FLECS_API
3050 ecs_world_t *world,
3051 ecs_entity_t entity,
3052 ecs_id_t id);
3053
3060FLECS_API
3062 ecs_world_t *world,
3063 ecs_entity_t entity);
3064
3072FLECS_API
3074 ecs_world_t *world,
3075 ecs_id_t id);
3076
3084FLECS_API
3086 ecs_world_t *world,
3087 ecs_id_t id);
3088
3095FLECS_API
3097 const ecs_world_t *world);
3098
3117FLECS_API
3119 ecs_world_t *world,
3120 ecs_entity_t entity,
3121 bool enabled);
3122
3136FLECS_API
3138 ecs_world_t *world,
3139 ecs_entity_t entity,
3140 ecs_id_t id,
3141 bool enable);
3142
3153FLECS_API
3155 const ecs_world_t *world,
3156 ecs_entity_t entity,
3157 ecs_id_t id);
3158
3182FLECS_API
3183FLECS_ALWAYS_INLINE const void* ecs_get_id(
3184 const ecs_world_t *world,
3185 ecs_entity_t entity,
3186 ecs_id_t id);
3187
3199FLECS_API
3200FLECS_ALWAYS_INLINE void* ecs_get_mut_id(
3201 const ecs_world_t *world,
3202 ecs_entity_t entity,
3203 ecs_id_t id);
3204
3222FLECS_API
3224 ecs_world_t *world,
3225 ecs_entity_t entity,
3226 ecs_id_t id);
3227
3239FLECS_API
3241 ecs_world_t *world,
3242 ecs_entity_t entity,
3243 ecs_id_t id);
3244
3255FLECS_API
3257 const ecs_world_t *world,
3258 ecs_entity_t entity,
3259 ecs_id_t id);
3260
3269FLECS_API
3271 const ecs_world_t *world,
3272 ecs_ref_t *ref,
3273 ecs_id_t id);
3274
3282FLECS_API
3284 const ecs_world_t *world,
3285 ecs_ref_t *ref);
3286
3306FLECS_API
3308 ecs_world_t *world,
3309 ecs_entity_t entity,
3310 ecs_id_t id,
3311 bool *is_new);
3312
3322FLECS_API
3324 ecs_world_t *world,
3325 ecs_entity_t entity,
3326 ecs_id_t id);
3327
3343FLECS_API
3345 ecs_world_t *world,
3346 ecs_entity_t entity,
3347 ecs_id_t id,
3348 size_t size,
3349 const void *ptr);
3350
3378FLECS_API
3380 const ecs_world_t *world,
3381 ecs_entity_t e);
3382
3408FLECS_API
3410 const ecs_world_t *world,
3411 ecs_entity_t e);
3412
3418FLECS_API
3420 ecs_entity_t e);
3421
3438FLECS_API
3440 const ecs_world_t *world,
3441 ecs_entity_t e);
3442
3465FLECS_API
3467 ecs_world_t *world,
3468 ecs_entity_t entity);
3469
3488FLECS_API
3490 ecs_world_t *world,
3491 ecs_id_t id);
3492
3500FLECS_API
3502 const ecs_world_t *world,
3503 ecs_entity_t entity);
3504
3519FLECS_API
3521 ecs_world_t *world,
3522 ecs_entity_t entity);
3523
3539FLECS_API
3541 const ecs_world_t *world,
3542 ecs_entity_t entity);
3543
3550FLECS_API
3552 const ecs_world_t *world,
3553 ecs_entity_t entity);
3554
3562FLECS_API
3564 const ecs_world_t *world,
3565 const ecs_type_t* type);
3566
3578FLECS_API
3580 const ecs_world_t *world,
3581 const ecs_table_t *table);
3582
3597FLECS_API
3599 const ecs_world_t *world,
3600 ecs_entity_t entity);
3601
3612FLECS_API
3613FLECS_ALWAYS_INLINE bool ecs_has_id(
3614 const ecs_world_t *world,
3615 ecs_entity_t entity,
3616 ecs_id_t id);
3617
3628FLECS_API
3629FLECS_ALWAYS_INLINE bool ecs_owns_id(
3630 const ecs_world_t *world,
3631 ecs_entity_t entity,
3632 ecs_id_t id);
3633
3648FLECS_API
3650 const ecs_world_t *world,
3651 ecs_entity_t entity,
3652 ecs_entity_t rel,
3653 int32_t index);
3654
3668FLECS_API
3670 const ecs_world_t *world,
3671 ecs_entity_t entity);
3672
3693FLECS_API
3695 const ecs_world_t *world,
3696 ecs_entity_t entity,
3697 ecs_entity_t rel,
3698 ecs_id_t id);
3699
3710FLECS_API
3712 const ecs_world_t *world,
3713 ecs_entity_t entity,
3714 ecs_entity_t rel);
3715
3723FLECS_API
3725 const ecs_world_t *world,
3726 ecs_id_t entity);
3727
3747FLECS_API
3748const char* ecs_get_name(
3749 const ecs_world_t *world,
3750 ecs_entity_t entity);
3751
3761FLECS_API
3762const char* ecs_get_symbol(
3763 const ecs_world_t *world,
3764 ecs_entity_t entity);
3765
3779FLECS_API
3781 ecs_world_t *world,
3782 ecs_entity_t entity,
3783 const char *name);
3784
3798FLECS_API
3800 ecs_world_t *world,
3801 ecs_entity_t entity,
3802 const char *symbol);
3803
3815FLECS_API
3817 ecs_world_t *world,
3818 ecs_entity_t entity,
3819 const char *alias);
3820
3836FLECS_API
3838 const ecs_world_t *world,
3839 const char *path);
3840
3855FLECS_API
3857 const ecs_world_t *world,
3858 ecs_entity_t parent,
3859 const char *name);
3860
3883FLECS_API
3885 const ecs_world_t *world,
3886 ecs_entity_t parent,
3887 const char *path,
3888 const char *sep,
3889 const char *prefix,
3890 bool recursive);
3891
3909FLECS_API
3911 const ecs_world_t *world,
3912 const char *symbol,
3913 bool lookup_as_path,
3914 bool recursive);
3915
3937FLECS_API
3939 const ecs_world_t *world,
3940 ecs_entity_t parent,
3941 ecs_entity_t child,
3942 const char *sep,
3943 const char *prefix);
3944
3957FLECS_API
3959 const ecs_world_t *world,
3960 ecs_entity_t parent,
3961 ecs_entity_t child,
3962 const char *sep,
3963 const char *prefix,
3964 ecs_strbuf_t *buf,
3965 bool escape);
3966
3982FLECS_API
3984 ecs_world_t *world,
3985 ecs_entity_t parent,
3986 const char *path,
3987 const char *sep,
3988 const char *prefix);
3989
4004FLECS_API
4006 ecs_world_t *world,
4007 ecs_entity_t entity,
4008 ecs_entity_t parent,
4009 const char *path,
4010 const char *sep,
4011 const char *prefix);
4012
4026FLECS_API
4028 ecs_world_t *world,
4029 ecs_entity_t scope);
4030
4038FLECS_API
4040 const ecs_world_t *world);
4041
4051FLECS_API
4053 ecs_world_t *world,
4054 const char *prefix);
4055
4082FLECS_API
4084 ecs_world_t *world,
4085 const ecs_entity_t *lookup_path);
4086
4093FLECS_API
4095 const ecs_world_t *world);
4096
4121FLECS_API
4123 ecs_world_t *world,
4124 const ecs_component_desc_t *desc);
4125
4135FLECS_API
4137 const ecs_world_t *world,
4138 ecs_id_t id);
4139
4151FLECS_API
4153 ecs_world_t *world,
4154 ecs_entity_t id,
4155 const ecs_type_hooks_t *hooks);
4156
4163FLECS_API
4165 const ecs_world_t *world,
4166 ecs_entity_t id);
4167
4191FLECS_API
4193 const ecs_world_t *world,
4194 ecs_id_t id);
4195
4204FLECS_API
4206 const ecs_world_t *world,
4207 ecs_id_t id);
4208
4228FLECS_API
4230 const ecs_world_t *world,
4231 ecs_id_t id);
4232
4241FLECS_API
4243 ecs_id_t id,
4244 ecs_id_t pattern);
4245
4251FLECS_API
4253 ecs_id_t id);
4254
4260FLECS_API
4262 ecs_id_t id);
4263
4277FLECS_API
4279 const ecs_world_t *world,
4280 ecs_id_t id);
4281
4290FLECS_API
4291ecs_flags32_t ecs_id_get_flags(
4292 const ecs_world_t *world,
4293 ecs_id_t id);
4294
4301FLECS_API
4303 ecs_id_t id_flags);
4304
4312FLECS_API
4314 const ecs_world_t *world,
4315 ecs_id_t id);
4316
4324FLECS_API
4326 const ecs_world_t *world,
4327 ecs_id_t id,
4328 ecs_strbuf_t *buf);
4329
4337FLECS_API
4339 const ecs_world_t *world,
4340 const char *expr);
4341
4355FLECS_API
4357 const ecs_term_ref_t *id);
4358
4370FLECS_API
4372 const ecs_term_t *term);
4373
4388FLECS_API
4390 const ecs_term_t *term);
4391
4404FLECS_API
4406 const ecs_term_t *term);
4407
4416FLECS_API
4418 const ecs_world_t *world,
4419 const ecs_term_t *term);
4420
4428FLECS_API
4430 const ecs_query_t *query);
4431
4472FLECS_API
4474 const ecs_world_t *world,
4475 ecs_id_t id);
4476
4482FLECS_API
4484 ecs_iter_t *it);
4485
4498FLECS_API
4500 const ecs_world_t *world,
4501 ecs_entity_t parent);
4502
4508FLECS_API
4510 ecs_iter_t *it);
4511
4527FLECS_API
4529 ecs_world_t *world,
4530 const ecs_query_desc_t *desc);
4531
4536FLECS_API
4538 ecs_query_t *query);
4539
4548FLECS_API
4550 const ecs_query_t *query,
4551 const char *name);
4552
4560FLECS_API
4562 const ecs_query_t *query,
4563 int32_t var_id);
4564
4575FLECS_API
4577 const ecs_query_t *query,
4578 int32_t var_id);
4579
4648FLECS_API
4650 const ecs_world_t *world,
4651 const ecs_query_t *query);
4652
4660FLECS_API
4662 ecs_iter_t *it);
4663
4682FLECS_API
4684 ecs_query_t *query,
4685 ecs_entity_t entity,
4686 ecs_iter_t *it);
4687
4706FLECS_API
4708 ecs_query_t *query,
4709 ecs_table_t *table,
4710 ecs_iter_t *it);
4711
4738FLECS_API
4740 ecs_query_t *query,
4741 ecs_table_range_t *range,
4742 ecs_iter_t *it);
4743
4751FLECS_API
4753 const ecs_query_t *query);
4754
4764FLECS_API
4766 const ecs_query_t *query);
4767
4782FLECS_API
4784 const ecs_query_t *query,
4785 const ecs_iter_t *it);
4786
4804FLECS_API
4806 ecs_query_t *query,
4807 ecs_iter_t *it,
4808 const char *expr);
4809
4837FLECS_API
4839 ecs_query_t *query);
4840
4849FLECS_API
4851 const ecs_world_t *world,
4852 ecs_entity_t query);
4853
4864FLECS_API
4866 ecs_iter_t *it);
4867
4890FLECS_API
4892 ecs_iter_t *it,
4893 uint64_t group_id);
4894
4903FLECS_API
4905 const ecs_query_t *query,
4906 uint64_t group_id);
4907
4916FLECS_API
4918 const ecs_query_t *query,
4919 uint64_t group_id);
4920
4928
4935FLECS_API
4937 const ecs_query_t *query);
4938
4944FLECS_API
4946 const ecs_query_t *query);
4947
4956FLECS_API
4958 const ecs_query_t *query);
4959
4988FLECS_API
4990 ecs_world_t *world,
4991 ecs_event_desc_t *desc);
4992
5003FLECS_API
5005 ecs_world_t *world,
5006 ecs_event_desc_t *desc);
5007
5018FLECS_API
5020 ecs_world_t *world,
5021 const ecs_observer_desc_t *desc);
5022
5031FLECS_API
5033 const ecs_world_t *world,
5034 ecs_entity_t observer);
5035
5058FLECS_API
5060 ecs_iter_t *it);
5061
5071FLECS_API
5073 ecs_iter_t *it);
5074
5086FLECS_API
5088 ecs_iter_t *it);
5089
5102FLECS_API
5104 ecs_iter_t *it);
5105
5113FLECS_API
5115 ecs_iter_t *it);
5116
5155FLECS_API
5157 ecs_iter_t *it,
5158 int32_t var_id,
5159 ecs_entity_t entity);
5160
5171FLECS_API
5173 ecs_iter_t *it,
5174 int32_t var_id,
5175 const ecs_table_t *table);
5176
5187FLECS_API
5189 ecs_iter_t *it,
5190 int32_t var_id,
5191 const ecs_table_range_t *range);
5192
5205FLECS_API
5207 ecs_iter_t *it,
5208 int32_t var_id);
5209
5223FLECS_API
5225 ecs_iter_t *it,
5226 int32_t var_id);
5227
5241FLECS_API
5243 ecs_iter_t *it,
5244 int32_t var_id);
5245
5257FLECS_API
5259 ecs_iter_t *it,
5260 int32_t var_id);
5261
5273FLECS_API
5275 ecs_iter_t *it);
5276
5288FLECS_API
5290 const ecs_iter_t *it);
5291
5307FLECS_API
5309 const ecs_iter_t *it,
5310 int32_t offset,
5311 int32_t limit);
5312
5319FLECS_API
5321 ecs_iter_t *it);
5322
5343FLECS_API
5345 const ecs_iter_t *it,
5346 int32_t index,
5347 int32_t count);
5348
5355FLECS_API
5357 ecs_iter_t *it);
5358
5400FLECS_API
5402 const ecs_iter_t *it,
5403 size_t size,
5404 int8_t index);
5405
5427FLECS_API
5429 const ecs_iter_t *it,
5430 size_t size,
5431 int8_t index,
5432 int32_t row);
5433
5442FLECS_API
5444 const ecs_iter_t *it,
5445 int8_t index);
5446
5457FLECS_API
5459 const ecs_iter_t *it,
5460 int8_t index);
5461
5468FLECS_API
5470 const ecs_iter_t *it,
5471 int8_t index);
5472
5479FLECS_API
5481 const ecs_iter_t *it,
5482 int8_t index);
5483
5492FLECS_API
5494 const ecs_iter_t *it,
5495 int8_t index);
5496
5504FLECS_API
5506 const ecs_iter_t *it,
5507 int8_t index);
5508
5516FLECS_API
5518 const ecs_iter_t *it,
5519 int8_t index);
5520
5534FLECS_API
5536 const ecs_iter_t *it,
5537 int8_t index);
5538
5554FLECS_API
5556 const ecs_table_t *table);
5557
5568FLECS_API
5570 const ecs_world_t *world,
5571 const ecs_table_t *table,
5572 ecs_id_t id);
5573
5583FLECS_API
5585 const ecs_world_t *world,
5586 const ecs_table_t *table,
5587 ecs_id_t id);
5588
5596FLECS_API
5598 const ecs_table_t *table);
5599
5613FLECS_API
5615 const ecs_table_t *table,
5616 int32_t index);
5617
5626FLECS_API
5628 const ecs_table_t *table,
5629 int32_t index);
5630
5639FLECS_API
5641 const ecs_table_t *table,
5642 int32_t index,
5643 int32_t offset);
5644
5654FLECS_API
5656 const ecs_world_t *world,
5657 const ecs_table_t *table,
5658 ecs_id_t id,
5659 int32_t offset);
5660
5668FLECS_API
5670 const ecs_table_t *table,
5671 int32_t index);
5672
5679FLECS_API
5681 const ecs_table_t *table);
5682
5690FLECS_API
5692 const ecs_table_t *table);
5693
5700FLECS_API
5702 const ecs_table_t *table);
5703
5714FLECS_API
5716 const ecs_world_t *world,
5717 const ecs_table_t *table,
5718 ecs_id_t id);
5719
5730FLECS_API
5732 const ecs_world_t *world,
5733 const ecs_table_t *table,
5734 ecs_entity_t rel);
5735
5745FLECS_API
5747 ecs_world_t *world,
5748 ecs_table_t *table,
5749 ecs_id_t id);
5750
5761FLECS_API
5763 ecs_world_t *world,
5764 const ecs_id_t *ids,
5765 int32_t id_count);
5766
5776FLECS_API
5778 ecs_world_t *world,
5779 ecs_table_t *table,
5780 ecs_id_t id);
5781
5797FLECS_API
5799 ecs_world_t *world,
5800 ecs_table_t *table);
5801
5808FLECS_API
5810 ecs_world_t *world,
5811 ecs_table_t *table);
5812
5822FLECS_API
5824 ecs_table_t *table,
5825 ecs_flags32_t flags);
5826
5834FLECS_API
5836 ecs_world_t* world,
5837 ecs_table_t* table,
5838 int32_t row_1,
5839 int32_t row_2);
5840
5863FLECS_API
5865 ecs_world_t *world,
5866 ecs_entity_t entity,
5867 ecs_record_t *record,
5868 ecs_table_t *table,
5869 const ecs_type_t *added,
5870 const ecs_type_t *removed);
5871
5872
5891FLECS_API
5893 const ecs_world_t *world,
5894 const ecs_table_t *table,
5895 ecs_id_t id,
5896 ecs_id_t *id_out);
5897
5933FLECS_API
5935 const ecs_world_t *world,
5936 const ecs_table_t *table,
5937 int32_t offset,
5938 ecs_id_t id,
5939 ecs_id_t *id_out);
5940
5982FLECS_API
5984 const ecs_world_t *world,
5985 const ecs_table_t *table,
5986 int32_t offset,
5987 ecs_id_t id,
5988 ecs_entity_t rel,
5989 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
5990 ecs_entity_t *subject_out,
5991 ecs_id_t *id_out,
5992 struct ecs_table_record_t **tr_out);
5993
6001FLECS_API
6003 ecs_world_t* world,
6004 ecs_table_t* table);
6005
6022FLECS_API
6024 const ecs_world_t *world,
6025 ecs_entity_t type,
6026 void *ptr);
6027
6035FLECS_API
6037 const ecs_world_t *world,
6038 const ecs_type_info_t *ti,
6039 void *ptr);
6040
6047FLECS_API
6049 ecs_world_t *world,
6050 ecs_entity_t type);
6051
6059 ecs_world_t *world,
6060 const ecs_type_info_t *ti);
6061
6070 const ecs_world_t *world,
6071 const ecs_type_info_t *ti,
6072 void *ptr);
6073
6081FLECS_API
6083 const ecs_world_t *world,
6084 ecs_entity_t type,
6085 void* ptr);
6086
6094FLECS_API
6096 ecs_world_t *world,
6097 ecs_entity_t type,
6098 void* ptr);
6099
6108FLECS_API
6110 const ecs_world_t *world,
6111 const ecs_type_info_t *ti,
6112 void* dst,
6113 const void *src);
6114
6123FLECS_API
6125 const ecs_world_t *world,
6126 ecs_entity_t type,
6127 void* dst,
6128 const void *src);
6129
6139 const ecs_world_t *world,
6140 const ecs_type_info_t *ti,
6141 void* dst,
6142 void *src);
6143
6153 const ecs_world_t *world,
6154 ecs_entity_t type,
6155 void* dst,
6156 void *src);
6157
6167 const ecs_world_t *world,
6168 const ecs_type_info_t *ti,
6169 void* dst,
6170 void *src);
6171
6181 const ecs_world_t *world,
6182 ecs_entity_t type,
6183 void* dst,
6184 void *src);
6185
6199#include "flecs/addons/flecs_c.h"
6200
6201#ifdef __cplusplus
6202}
6203#endif
6204
6205#include "flecs/private/addons.h"
6206
6207#endif
The deprecated addon contains deprecated operations.
Extends the core API with convenience macros for C applications.
ecs_entity_t ecs_set_with(ecs_world_t *world, ecs_id_t id)
Set current with id.
void ecs_add_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Add a (component) id to an entity.
void ecs_remove_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Remove a (component) id from an entity.
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 current with id.
void ecs_remove_all(ecs_world_t *world, ecs_id_t id)
Remove all instances of the specified (component) id.
void ecs_auto_override_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Add auto override for (component) id.
struct ecs_value_t ecs_value_t
Utility to hold a value of a dynamic type.
struct EcsIdentifier EcsIdentifier
A (string) identifier.
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 ass...
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
Marks a relationship as acyclic.
const ecs_entity_t EcsSymmetric
Marks 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
Marks 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 query is empty.
const ecs_entity_t EcsOneOf
Ensure that relationship target is child of 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 pair as relationship.
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 EcsDontFragment
Mark component as non-fragmenting.
const ecs_entity_t EcsTraversable
Marks 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 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
Marks 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 observer when an entity starts/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 EcsPrivate
Tag to indicate an entity/component/system is private to a module.
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 EcsUnion
Mark relationship as union.
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 pair as target.
const ecs_entity_t EcsWith
Ensure that a component always is 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 builtin 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 querie...
const ecs_entity_t EcsDontInherit
Never inherit component on instantiate.
const ecs_entity_t EcsPairIsTag
Can be added to relationship to indicate that it should never hold data, even when it or the relation...
const ecs_entity_t EcsPanic
Panic cleanup policy.
const ecs_entity_t EcsFinal
Ensures that entity/component cannot be used as target in IsA relationship.
const ecs_entity_t EcsVariable
Variable entity ("$").
const ecs_entity_t EcsConstant
Tag added to enum/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 unmanaged stage.
bool ecs_defer_end(ecs_world_t *world)
End 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 end of 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 current stage.
void ecs_stage_free(ecs_world_t *stage)
Free unmanaged stage.
void ecs_merge(ecs_world_t *world)
Merge world or stage.
int32_t ecs_stage_get_id(const ecs_world_t *world)
Get 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 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 world to have N stages.
void ecs_readonly_end(ecs_world_t *world)
End readonly mode.
ecs_entity_t ecs_component_init(ecs_world_t *world, const ecs_component_desc_t *desc)
Find or create a component.
void ecs_set_hooks_id(ecs_world_t *world, ecs_entity_t id, const ecs_type_hooks_t *hooks)
Register hooks for component.
struct ecs_component_desc_t ecs_component_desc_t
Used with ecs_component_init().
const ecs_type_info_t * ecs_get_type_info(const ecs_world_t *world, ecs_id_t id)
Get the type for an id.
const ecs_type_hooks_t * ecs_get_hooks_id(const ecs_world_t *world, ecs_entity_t id)
Get hooks for 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_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.
ecs_entity_t ecs_new_w_id(ecs_world_t *world, ecs_id_t id)
Create new entity with (component) id.
const ecs_entity_t * ecs_bulk_init(ecs_world_t *world, const ecs_bulk_desc_t *desc)
Bulk create/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 This operation clones the components of one entity into another entity.
const ecs_entity_t * ecs_bulk_new_w_id(ecs_world_t *world, ecs_id_t id, int32_t count)
Create N new entities.
ecs_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_with(ecs_world_t *world, ecs_id_t id)
Delete all entities with the specified id.
void ecs_delete(ecs_world_t *world, ecs_entity_t entity)
Delete an entity.
ecs_entity_t ecs_new_w_table(ecs_world_t *world, ecs_table_t *table)
Create new entity in table.
bool ecs_children_next(ecs_iter_t *it)
Progress an iterator created with ecs_children().
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 parent.
ecs_iter_t ecs_each_id(const ecs_world_t *world, ecs_id_t id)
Iterate all entities with specified (component id).
bool ecs_is_enabled_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if component is enabled.
void ecs_enable_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, bool enable)
Enable or disable component.
void ecs_enable(ecs_world_t *world, ecs_entity_t entity, bool enabled)
Enable or disable 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 entity to 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 parent (target of ChildOf relationship) for entity.
const ecs_type_t * ecs_get_type(const ecs_world_t *world, ecs_entity_t entity)
Get the type of an entity.
bool ecs_has_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if an entity has an id.
char * ecs_type_str(const ecs_world_t *world, const ecs_type_t *type)
Convert type to string.
char * ecs_table_str(const ecs_world_t *world, const ecs_table_t *table)
Convert table to string.
int32_t ecs_count_id(const ecs_world_t *world, ecs_id_t entity)
Count entities that have the specified id.
bool ecs_owns_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Test if an entity owns an id.
int32_t ecs_get_depth(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel)
Return depth for entity in tree for the specified relationship.
ecs_entity_t ecs_get_target_for_id(const ecs_world_t *world, ecs_entity_t entity, ecs_entity_t rel, ecs_id_t id)
Get the target of a relationship for a given id.
ecs_table_t * ecs_get_table(const ecs_world_t *world, ecs_entity_t entity)
Get the table of an entity.
void(* ecs_module_action_t)(ecs_world_t *world)
Initialization action for modules.
Definition flecs.h:615
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:595
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:657
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:633
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:608
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:573
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:602
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:584
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:565
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:555
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:643
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:663
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:628
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:619
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:650
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:669
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:546
void(* ecs_ctx_free_t)(void *ctx)
Function to cleanup context data.
Definition flecs.h:624
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:577
void(* ecs_xtor_t)(void *ptr, int32_t count, const ecs_type_info_t *type_info)
Constructor/destructor callback.
Definition flecs.h:637
void * ecs_get_mut_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get a mutable pointer to a component.
ecs_ref_t ecs_ref_init_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Create a component ref.
void ecs_ref_update(const ecs_world_t *world, ecs_ref_t *ref)
Update ref.
void * ecs_emplace_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, bool *is_new)
Emplace a component.
void * ecs_ensure_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get a mutable pointer to a component.
void ecs_set_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id, size_t size, const void *ptr)
Set the value of a component.
void * ecs_ensure_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Combines ensure + modified in single operation.
void * ecs_ref_get_id(const ecs_world_t *world, ecs_ref_t *ref, ecs_id_t id)
Get component from ref.
const void * ecs_get_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get an immutable pointer to a component.
void ecs_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Signal that a component has been modified.
const ecs_id_t ECS_PAIR
Indicates 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
Adds bitset to storage which allows component to be enabled/disabled.
bool ecs_id_is_valid(const ecs_world_t *world, ecs_id_t id)
Utility to check if id is valid.
bool ecs_id_is_pair(ecs_id_t id)
Utility to check if id is a pair.
ecs_entity_t ecs_get_typeid(const ecs_world_t *world, ecs_id_t id)
Get the type for an id.
bool ecs_id_match(ecs_id_t id, ecs_id_t pattern)
Utility to match an id with a pattern.
const char * ecs_id_flag_str(ecs_id_t id_flags)
Convert id flag to string.
bool ecs_id_in_use(const ecs_world_t *world, ecs_id_t id)
Returns whether specified id is in use.
bool ecs_id_is_tag(const ecs_world_t *world, ecs_id_t id)
Returns whether specified id a tag.
void ecs_id_str_buf(const ecs_world_t *world, ecs_id_t id, ecs_strbuf_t *buf)
Write (component) id string to buffer.
char * ecs_id_str(const ecs_world_t *world, ecs_id_t id)
Convert (component) id to string.
bool ecs_id_is_wildcard(ecs_id_t id)
Utility to check if id is a wildcard.
ecs_id_t ecs_id_from_str(const ecs_world_t *world, const char *expr)
Convert string to a (component) id.
ecs_flags32_t ecs_id_get_flags(const ecs_world_t *world, ecs_id_t id)
Get flags associated with id.
ecs_entity_t ecs_field_src(const ecs_iter_t *it, int8_t index)
Return field source.
bool ecs_iter_changed(ecs_iter_t *it)
Returns whether current iterator result has changed.
bool ecs_field_is_writeonly(const ecs_iter_t *it, int8_t index)
Test whether the field is writeonly.
bool ecs_field_is_readonly(const ecs_iter_t *it, int8_t index)
Test whether the field is readonly.
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 iterator is true.
void ecs_iter_fini(ecs_iter_t *it)
Cleanup iterator resources.
char * ecs_iter_str(const ecs_iter_t *it)
Convert iterator to string.
bool ecs_iter_var_is_constrained(ecs_iter_t *it, int32_t var_id)
Returns whether variable is constrained.
ecs_iter_t ecs_page_iter(const ecs_iter_t *it, int32_t offset, int32_t limit)
Create a paged iterator.
void * ecs_field_at_w_size(const ecs_iter_t *it, size_t size, int8_t index, int32_t row)
Get data for field at specified row.
ecs_id_t ecs_field_id(const ecs_iter_t *it, int8_t index)
Return id matched for field.
bool ecs_field_is_set(const ecs_iter_t *it, int8_t index)
Test whether field is set.
void ecs_iter_set_var(ecs_iter_t *it, int32_t var_id, ecs_entity_t entity)
Set value for 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 value of iterator variable as entity.
bool ecs_worker_next(ecs_iter_t *it)
Progress a worker iterator.
ecs_entity_t ecs_iter_first(ecs_iter_t *it)
Get first matching entity from iterator.
int32_t ecs_field_column(const ecs_iter_t *it, int8_t index)
Return index of matched table column.
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 value of iterator variable as table.
void * ecs_field_w_size(const ecs_iter_t *it, size_t size, int8_t index)
Get data for field.
int32_t ecs_iter_count(ecs_iter_t *it)
Count number of matched entities in 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 This constrains the variable to a range of en...
size_t ecs_field_size(const ecs_iter_t *it, int8_t index)
Return field type size.
ecs_table_range_t ecs_iter_get_var_as_range(ecs_iter_t *it, int32_t var_id)
Get value of iterator variable as table range.
ecs_id_t ecs_strip_generation(ecs_entity_t e)
Remove generation from entity id.
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 id is alive.
void ecs_make_alive_id(ecs_world_t *world, ecs_id_t id)
Same as ecs_make_alive(), but for (component) ids.
ecs_entity_t ecs_get_alive(const ecs_world_t *world, ecs_entity_t e)
Get alive identifier.
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_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 event.
void ecs_enqueue(ecs_world_t *world, ecs_event_desc_t *desc)
Enqueue event.
ecs_entity_t ecs_observer_init(ecs_world_t *world, const ecs_observer_desc_t *desc)
Create observer.
const ecs_observer_t * ecs_observer_get(const ecs_world_t *world, ecs_entity_t observer)
Get 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:302
#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 ecs_entity_desc_t / ecs_bulk_desc_t.
Definition flecs.h:296
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:312
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 entity from path.
ecs_entity_t ecs_lookup_symbol(const ecs_world_t *world, const char *symbol, bool lookup_as_path, bool recursive)
Lookup an entity by its symbol name.
void ecs_set_alias(ecs_world_t *world, ecs_entity_t entity, const char *alias)
Set alias for entity.
ecs_entity_t ecs_lookup(const ecs_world_t *world, const char *path)
Lookup an entity by it's 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 path identifier to buffer.
ecs_entity_t * ecs_set_lookup_path(ecs_world_t *world, const ecs_entity_t *lookup_path)
Set 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)
Lookup 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)
Lookup 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 specified path to entity.
ecs_entity_t * ecs_get_lookup_path(const ecs_world_t *world)
Get 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.
void ecs_iter_set_group(ecs_iter_t *it, uint64_t group_id)
Set group to iterate for query iterator.
const ecs_query_t * ecs_query_get(const ecs_world_t *world, ecs_entity_t query)
Get query object.
bool ecs_query_next(ecs_iter_t *it)
Progress 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 query group.
bool ecs_query_has(ecs_query_t *query, ecs_entity_t entity, ecs_iter_t *it)
Match entity with query.
bool ecs_query_is_true(const ecs_query_t *query)
Does query return one or more results.
char * ecs_term_str(const ecs_world_t *world, const ecs_term_t *term)
Convert term to string expression.
int32_t ecs_query_find_var(const ecs_query_t *query, const char *name)
Find variable index.
void ecs_query_fini(ecs_query_t *query)
Delete a query.
char * ecs_query_plan_w_profile(const ecs_query_t *query, const ecs_iter_t *it)
Convert query to string with 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 key-value string.
int32_t ecs_query_match_count(const ecs_query_t *query)
Returns how often a match event happened for a cached query.
char * ecs_query_plan(const ecs_query_t *query)
Convert 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 query to string expression.
bool ecs_query_var_is_entity(const ecs_query_t *query, int32_t var_id)
Test if 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)
Returns whether the query data changed since the last iteration.
bool ecs_query_has_range(ecs_query_t *query, ecs_table_range_t *range, ecs_iter_t *it)
Match range with query.
const char * ecs_query_var_name(const ecs_query_t *query, int32_t var_id)
Get variable name.
bool ecs_term_match_this(const ecs_term_t *term)
Is term matched on $this variable.
bool ecs_query_has_table(ecs_query_t *query, ecs_table_t *table, ecs_iter_t *it)
Match table with query.
void * ecs_query_get_group_ctx(const ecs_query_t *query, uint64_t group_id)
Get context of query group.
ecs_query_count_t ecs_query_count(const ecs_query_t *query)
Returns number of entities and results the query matches with.
bool ecs_term_ref_is_set(const ecs_term_ref_t *id)
Test whether term id is set.
bool ecs_term_is_initialized(const ecs_term_t *term)
Test whether a term 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 term matched on 0 source.
const ecs_query_t * ecs_query_get_cache_query(const ecs_query_t *query)
Get query used to populate 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:703
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:682
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:692
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:706
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:704
@ EcsQueryCacheNone
No caching.
Definition flecs.h:707
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:705
@ EcsOut
Term is only written.
Definition flecs.h:688
@ EcsInOut
Term is both read and written.
Definition flecs.h:686
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:685
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:683
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:684
@ EcsIn
Term is only read.
Definition flecs.h:687
@ EcsNot
The term must not match.
Definition flecs.h:695
@ EcsOptional
The term may match.
Definition flecs.h:696
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:694
@ EcsOrFrom
Term must match at least one component from term id.
Definition flecs.h:698
@ EcsAnd
The term must match.
Definition flecs.h:693
@ EcsNotFrom
Term must match none of the components from term id.
Definition flecs.h:699
@ EcsAndFrom
Term must match all components from term id.
Definition flecs.h:697
ecs_table_t * ecs_table_add_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t id)
Get table that has all components of current table plus the specified id.
int32_t ecs_search(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id, ecs_id_t *id_out)
Search for component id in table type.
const ecs_type_t * ecs_table_get_type(const ecs_table_t *table)
Get type for table.
int32_t ecs_search_offset(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t id, ecs_id_t *id_out)
Search for component id in table type starting from an offset.
int32_t ecs_table_size(const ecs_table_t *table)
Returns allocated size of table.
bool ecs_table_has_flags(ecs_table_t *table, ecs_flags32_t flags)
Test table for flags.
int32_t ecs_table_column_to_type_index(const ecs_table_t *table, int32_t index)
Convert column index to type index.
int32_t ecs_table_column_count(const ecs_table_t *table)
Return number of columns in 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) entity to a table.
void * ecs_table_get_column(const ecs_table_t *table, int32_t index, int32_t offset)
Get column from table by column index.
bool ecs_table_has_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Test if table has id.
ecs_table_t * ecs_table_remove_id(ecs_world_t *world, ecs_table_t *table, ecs_id_t id)
Get table that has all components of current table minus the specified id.
int32_t ecs_table_count(const ecs_table_t *table)
Returns the number of entities in the table.
const ecs_entity_t * ecs_table_entities(const ecs_table_t *table)
Returns array with entity ids for table.
void ecs_table_unlock(ecs_world_t *world, ecs_table_t *table)
Unlock a table.
int32_t ecs_table_get_depth(const ecs_world_t *world, const ecs_table_t *table, ecs_entity_t rel)
Return depth for table in tree for relationship rel.
void * ecs_table_get_id(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id, int32_t offset)
Get column from table by component id.
void ecs_table_swap_rows(ecs_world_t *world, ecs_table_t *table, int32_t row_1, int32_t row_2)
Swaps two elements inside the table.
int32_t ecs_table_get_column_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Get column index for id.
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 table from id array.
int32_t ecs_table_get_type_index(const ecs_world_t *world, const ecs_table_t *table, ecs_id_t id)
Get type index for id.
size_t ecs_table_get_column_size(const ecs_table_t *table, int32_t index)
Get column size from table.
void ecs_table_clear_entities(ecs_world_t *world, ecs_table_t *table)
Remove all entities in a table.
int32_t ecs_search_relation(const ecs_world_t *world, const ecs_table_t *table, int32_t offset, ecs_id_t id, ecs_entity_t rel, ecs_flags64_t flags, ecs_entity_t *subject_out, ecs_id_t *id_out, struct ecs_table_record_t **tr_out)
Search for component/relationship id in table type starting from an offset.
int32_t ecs_table_type_to_column_index(const ecs_table_t *table, int32_t index)
Convert type index to 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 value.
int ecs_value_move(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move value.
int ecs_value_move_w_type_info(const ecs_world_t *world, const ecs_type_info_t *ti, void *dst, void *src)
Move 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 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 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, free storage.
int ecs_value_move_ctor(const ecs_world_t *world, ecs_entity_t type, void *dst, void *src)
Move construct 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 action to be executed when world is destroyed.
bool ecs_is_fini(const ecs_world_t *world)
Returns 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 world.
void ecs_set_target_fps(ecs_world_t *world, float fps)
Set target frames per second (FPS) for 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 action to be executed once after 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 default query flags.
void ecs_quit(ecs_world_t *world)
Signal exit This operation signals that the application should quit.
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 entity from 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 pointer is of specified type.
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_exclusive_access_begin(ecs_world_t *world)
Begin exclusive thread access.
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.
void ecs_set_entity_range(ecs_world_t *world, ecs_entity_t id_start, ecs_entity_t id_end)
Set a range for issuing new entity ids.
const ecs_world_info_t * ecs_get_world_info(const ecs_world_t *world)
Get world info.
const ecs_world_t * ecs_get_world(const ecs_poly_t *poly)
Get world from poly.
void ecs_set_ctx(ecs_world_t *world, void *ctx, ecs_ctx_free_t ctx_free)
Set a world context.
int32_t ecs_delete_empty_tables(ecs_world_t *world, const ecs_delete_empty_tables_desc_t *desc)
Cleanup empty tables.
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)
End exclusive thread access.
bool ecs_enable_range_check(ecs_world_t *world, bool enable)
Enable/disable range limits.
void * ecs_get_ctx(const ecs_world_t *world)
Get the world context.
Operating system abstraction API.
Component information.
Definition flecs.h:1523
ecs_size_t size
Component size.
Definition flecs.h:1524
ecs_size_t alignment
Component alignment.
Definition flecs.h:1525
When added to an entity this informs serialization formats which component to use when a value is ass...
Definition flecs.h:1538
ecs_id_t component
Default component id.
Definition flecs.h:1539
A (string) identifier.
Definition flecs.h:1514
ecs_size_t length
Length of identifier.
Definition flecs.h:1516
char * value
Identifier string.
Definition flecs.h:1515
ecs_hashmap_t * index
Current index.
Definition flecs.h:1519
uint64_t hash
Hash of current value.
Definition flecs.h:1517
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1518
Component for storing a poly object.
Definition flecs.h:1529
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1530
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/interval timer functionality.
Definition timer.h:35
Type with information about the current Flecs build.
Definition flecs.h:1426
int16_t version_major
Major flecs version.
Definition flecs.h:1430
const char ** addons
Addons included in build.
Definition flecs.h:1428
const char * version
Stringified version.
Definition flecs.h:1429
const char * compiler
Compiler used to compile flecs.
Definition flecs.h:1427
bool sanitize
Is this a sanitize build.
Definition flecs.h:1434
bool perf_trace
Is this a perf tracing build.
Definition flecs.h:1435
int16_t version_minor
Minor flecs version.
Definition flecs.h:1431
bool debug
Is this a debug build.
Definition flecs.h:1433
int16_t version_patch
Patch flecs version.
Definition flecs.h:1432
Used with ecs_bulk_init().
Definition flecs.h:1058
void ** data
Array with component data to insert.
Definition flecs.h:1070
ecs_id_t ids[(32)]
Ids to create the entities with.
Definition flecs.h:1068
int32_t count
Number of entities to create/populate.
Definition flecs.h:1066
int32_t _canary
Used for validity testing.
Definition flecs.h:1059
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:1061
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1077
Used with ecs_component_init().
Definition flecs.h:1088
int32_t _canary
Used for validity testing.
Definition flecs.h:1089
ecs_type_info_t type
Parameters for type (size, hooks, ...)
Definition flecs.h:1095
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1092
Used with ecs_delete_empty_tables().
Definition flecs.h:2632
uint16_t delete_generation
Delete table when generation > delete_generation.
Definition flecs.h:2637
double time_budget_seconds
Amount of time operation is allowed to spend.
Definition flecs.h:2640
uint16_t clear_generation
Free table data when generation > clear_generation.
Definition flecs.h:2634
Type returned by ecs_get_entities().
Definition flecs.h:1999
int32_t alive_count
Number of alive entity ids.
Definition flecs.h:2002
int32_t count
Total number of entity ids.
Definition flecs.h:2001
const ecs_entity_t * ids
Array with all entity ids in the world.
Definition flecs.h:2000
Used with ecs_entity_init().
Definition flecs.h:1012
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:1024
const char * root_sep
Optional, used for identifiers relative to root.
Definition flecs.h:1028
const char * name
Name of the entity.
Definition flecs.h:1019
bool use_low_id
When set to true, a low id (typically reserved for components) will be used to create the entity,...
Definition flecs.h:1040
const char * symbol
Optional entity symbol.
Definition flecs.h:1030
int32_t _canary
Used for validity testing.
Definition flecs.h:1013
const ecs_id_t * add
0-terminated array of ids to add to the entity.
Definition flecs.h:1045
const char * add_expr
String expression with components to add.
Definition flecs.h:1051
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:1048
ecs_entity_t id
Set to modify existing entity (optional)
Definition flecs.h:1015
ecs_entity_t parent
Parent entity.
Definition flecs.h:1017
Used with ecs_emit().
Definition flecs.h:1372
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1397
const void * const_param
Same as param, but with the guarantee that the value won't be modified.
Definition flecs.h:1408
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1382
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1394
ecs_table_t * other_table
Optional 2nd table to notify.
Definition flecs.h:1386
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1389
const ecs_type_t * ids
Component ids.
Definition flecs.h:1379
ecs_poly_t * observable
Observable (usually the world)
Definition flecs.h:1411
ecs_entity_t event
The event id.
Definition flecs.h:1374
ecs_flags32_t flags
Event flags.
Definition flecs.h:1414
void * param
Optional context.
Definition flecs.h:1403
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:1136
ecs_world_t * real_world
Actual world.
Definition flecs.h:1139
void * param
Param passed to ecs_run.
Definition flecs.h:1173
ecs_entity_t event
The event (if applicable)
Definition flecs.h:1159
int32_t frame_offset
Offset relative to start of iteration.
Definition flecs.h:1184
char ** variable_names
Names of variables (if any)
Definition flecs.h:1170
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1153
int8_t variable_count
Number of variables for query.
Definition flecs.h:1168
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1190
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1189
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1197
void * ctx
System context.
Definition flecs.h:1174
void * run_ctx
Run language binding context.
Definition flecs.h:1177
ecs_table_t * table
Current table.
Definition flecs.h:1144
int32_t offset
Offset relative to current table.
Definition flecs.h:1185
ecs_id_t event_id
The (component) id for the event.
Definition flecs.h:1160
ecs_iter_fini_action_t fini
Function to cleanup iterator resources.
Definition flecs.h:1196
ecs_var_t * variables
Values of variables (if any)
Definition flecs.h:1147
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1191
ecs_world_t * world
The world.
Definition flecs.h:1138
void * callback_ctx
Callback language binding context.
Definition flecs.h:1176
ecs_entity_t * sources
Entity on which the id was matched (0 if same as entities)
Definition flecs.h:1149
void * binding_ctx
System binding context.
Definition flecs.h:1175
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1154
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1181
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1169
int8_t term_index
Index of term that emitted an event.
Definition flecs.h:1165
ecs_entity_t system
The system (if applicable)
Definition flecs.h:1158
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1152
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1143
float delta_time
Time elapsed since last frame.
Definition flecs.h:1180
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1155
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1195
int8_t field_count
Number of fields in iterator.
Definition flecs.h:1164
ecs_table_t * other_table
Prev or next table when adding/removing.
Definition flecs.h:1145
int32_t event_cur
Unique event id.
Definition flecs.h:1161
const ecs_table_record_t ** trs
Info on where to find field in table.
Definition flecs.h:1148
int32_t count
Number of entities to iterate.
Definition flecs.h:1186
uint64_t group_id
Group id for table, if group_by is used.
Definition flecs.h:1151
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1194
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1142
ecs_id_t * ids
(Component) ids
Definition flecs.h:1146
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1150
Used with ecs_observer_init().
Definition flecs.h:1310
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1354
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1342
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1351
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1315
ecs_entity_t events[(8)]
Events to observe (OnAdd, OnRemove, OnSet)
Definition flecs.h:1321
int32_t * last_event_id
Optional shared last event id for multiple observers.
Definition flecs.h:1361
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1345
void * ctx
User context to pass to callback.
Definition flecs.h:1339
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1318
ecs_poly_t * observable
Observable with which to register the observer.
Definition flecs.h:1357
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1348
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1364
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1328
bool yield_existing
When observer is created, generate events from existing data.
Definition flecs.h:1325
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1336
int32_t _canary
Used for validity testing.
Definition flecs.h:1312
An observer reacts to events matching a query.
Definition flecs.h:853
int32_t event_count
Number of events.
Definition flecs.h:860
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:862
ecs_entity_t entity
Entity associated with observer.
Definition flecs.h:876
ecs_observable_t * observable
Observable for observer.
Definition flecs.h:873
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:863
ecs_header_t hdr
Object header.
Definition flecs.h:854
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:869
void * run_ctx
Run language binding context.
Definition flecs.h:867
ecs_world_t * world
The world.
Definition flecs.h:875
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:871
void * callback_ctx
Callback language binding context.
Definition flecs.h:866
void * ctx
Observer context.
Definition flecs.h:865
ecs_entity_t events[(8)]
Observer events.
Definition flecs.h:859
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:870
ecs_query_t * query
Observer query.
Definition flecs.h:856
Struct returned by ecs_query_count().
Definition flecs.h:4922
int32_t empty_tables
Number of empty tables returned by query.
Definition flecs.h:4926
int32_t entities
Number of entities returned by query.
Definition flecs.h:4924
int32_t results
Number of results returned by query.
Definition flecs.h:4923
int32_t tables
Number of tables returned by query.
Definition flecs.h:4925
Used with ecs_query_init().
Definition flecs.h:1236
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1297
ecs_id_t group_by
Component id to be used for grouping.
Definition flecs.h:1267
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1241
int32_t _canary
Used for validity testing.
Definition flecs.h:1238
void * ctx
User context to pass to callback.
Definition flecs.h:1291
ecs_ctx_free_t group_by_ctx_free
Function to free group_by_ctx.
Definition flecs.h:1288
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1285
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1294
ecs_entity_t order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition flecs.h:1263
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1255
ecs_group_create_action_t on_group_create
Callback that is invoked when a new group is created.
Definition flecs.h:1278
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:1303
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1300
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1274
ecs_group_delete_action_t on_group_delete
Callback that is invoked when an existing group is deleted.
Definition flecs.h:1282
ecs_sort_table_action_t order_by_table_callback
Callback used for ordering query results.
Definition flecs.h:1259
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1250
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:1247
const char * expr
Query DSL expression (optional)
Definition flecs.h:1244
Type that contains information about a query group.
Definition flecs.h:1498
int32_t table_count
Number of tables in group.
Definition flecs.h:1500
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1501
int32_t match_count
How often tables have been matched/unmatched.
Definition flecs.h:1499
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:812
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:832
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:829
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:831
ecs_header_t hdr
Object header.
Definition flecs.h:813
int8_t var_count
Number of query variables.
Definition flecs.h:821
ecs_flags32_t fixed_fields
Fields with a fixed source.
Definition flecs.h:826
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:827
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:830
int32_t eval_count
Number of times query is evaluated.
Definition flecs.h:847
ecs_world_t * world
World or stage query was created with.
Definition flecs.h:845
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:828
uint64_t bloom_filter
Bitmask used to quickly discard tables.
Definition flecs.h:819
ecs_world_t * real_world
Actual world.
Definition flecs.h:844
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:834
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:843
void * ctx
User context to pass to callback.
Definition flecs.h:840
int32_t * sizes
Component sizes.
Definition flecs.h:816
ecs_id_t * ids
Component ids.
Definition flecs.h:817
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:833
ecs_term_t * terms
Query terms.
Definition flecs.h:815
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:836
int8_t term_count
Number of query terms.
Definition flecs.h:822
char ** vars
Array with variable names for iterator.
Definition flecs.h:838
int8_t field_count
Number of fields returned by query.
Definition flecs.h:823
ecs_flags32_t flags
Query flags.
Definition flecs.h:820
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:841
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:773
const char * name
Name.
Definition flecs.h:780
ecs_entity_t id
Entity id.
Definition flecs.h:774
Type that describes a term (single element in a query).
Definition flecs.h:788
ecs_term_ref_t src
Source of term.
Definition flecs.h:794
int8_t field_index
Index of field for term in iterator.
Definition flecs.h:805
ecs_id_t id
Component id to be matched by term.
Definition flecs.h:789
int16_t oper
Operator of term.
Definition flecs.h:803
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:796
ecs_flags16_t flags_
Flags that help eval, set by ecs_query_init()
Definition flecs.h:806
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:798
int16_t inout
Access to contents matched by term.
Definition flecs.h:802
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:795
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:932
void * lifecycle_ctx
Component lifecycle context (see meta add-on)
Definition flecs.h:978
void * ctx
User defined context.
Definition flecs.h:976
ecs_iter_action_t on_remove
Callback that is invoked when an instance of the component is removed.
Definition flecs.h:974
void * binding_ctx
Language binding context.
Definition flecs.h:977
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:947
ecs_flags32_t flags
Hook flags.
Definition flecs.h:959
ecs_cmp_t cmp
Compare hook.
Definition flecs.h:950
ecs_copy_t copy
copy assignment
Definition flecs.h:928
ecs_ctx_free_t lifecycle_ctx_free
Callback to free lifecycle_ctx.
Definition flecs.h:982
ecs_iter_action_t on_set
Callback that is invoked when an instance of the component is set.
Definition flecs.h:969
ecs_move_t move
move assignment
Definition flecs.h:929
ecs_xtor_t ctor
ctor
Definition flecs.h:926
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:980
ecs_iter_action_t on_add
Callback that is invoked when an instance of a component is added.
Definition flecs.h:964
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:981
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:935
ecs_equals_t equals
Equals hook.
Definition flecs.h:953
ecs_move_t ctor_move_dtor
Ctor + move + dtor (or move_ctor + dtor).
Definition flecs.h:941
ecs_xtor_t dtor
dtor
Definition flecs.h:927
Type that contains component information (passed to ctors/dtors/...)
Definition flecs.h:989
ecs_size_t alignment
Alignment of type.
Definition flecs.h:991
ecs_size_t size
Size of type.
Definition flecs.h:990
const char * name
Type name.
Definition flecs.h:994
ecs_entity_t component
Handle to component (do not set)
Definition flecs.h:993
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:992
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:1003
void * ptr
Pointer to value.
Definition flecs.h:1005
ecs_entity_t type
Type of value.
Definition flecs.h:1004
Type that contains information about the world.
Definition flecs.h:1439
float delta_time
Time passed to or computed by ecs_progress()
Definition flecs.h:1445
ecs_entity_t min_id
First allowed entity id.
Definition flecs.h:1441
int64_t set_count
Set commands processed.
Definition flecs.h:1481
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1453
int32_t tag_id_count
Number of tag (no data) ids in the world.
Definition flecs.h:1469
int32_t component_id_count
Number of component (data) ids in the world.
Definition flecs.h:1470
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1465
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1458
int32_t table_count
Number of tables.
Definition flecs.h:1473
float delta_time_raw
Raw delta time (no time scaling)
Definition flecs.h:1444
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1448
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1463
int64_t observers_ran_frame
Total number of times observer was invoked.
Definition flecs.h:1467
float system_time_total
Total time spent in systems.
Definition flecs.h:1449
int64_t id_delete_total
Total number of times an id was deleted.
Definition flecs.h:1462
int64_t systems_ran_frame
Total number of systems ran in last frame.
Definition flecs.h:1466
float merge_time_total
Total time spent in merges.
Definition flecs.h:1451
struct ecs_world_info_t::@0 cmd
Command statistics.
int64_t discard_count
Commands discarded, happens when entity is no longer alive when running the command.
Definition flecs.h:1484
int64_t clear_count
Clear commands processed.
Definition flecs.h:1480
ecs_entity_t last_component_id
Last issued component entity id.
Definition flecs.h:1440
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1456
ecs_entity_t max_id
Last allowed entity id.
Definition flecs.h:1442
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1457
int64_t other_count
Other commands processed.
Definition flecs.h:1486
int64_t batched_command_count
Commands batched.
Definition flecs.h:1488
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1464
int64_t delete_count
Selete commands processed.
Definition flecs.h:1479
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1459
int64_t id_create_total
Total number of times a new id was created.
Definition flecs.h:1461
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1487
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1446
int32_t pair_id_count
Number of pair ids in the world.
Definition flecs.h:1471
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1452
int64_t ensure_count
Ensure/emplace commands processed.
Definition flecs.h:1482
float target_fps
Target fps.
Definition flecs.h:1447
double world_time_total_raw
Time elapsed in simulation (no scaling)
Definition flecs.h:1454
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1450
int64_t modified_count
Modified commands processed.
Definition flecs.h:1483
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1491
int64_t event_count
Enqueued custom events.
Definition flecs.h:1485
int64_t add_count
Add commands processed.
Definition flecs.h:1477
int64_t remove_count
Remove commands processed.
Definition flecs.h:1478