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 4
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
201// #define FLECS_CUSTOM_BUILD
202
203#ifndef FLECS_CUSTOM_BUILD
204#define FLECS_ALERTS
205#define FLECS_APP
206// #define FLECS_C /**< C API convenience macros, always enabled */
207#define FLECS_CPP
208#define FLECS_DOC
209// #define FLECS_JOURNAL /**< Journaling addon */
210#define FLECS_JSON
211#define FLECS_HTTP
212#define FLECS_LOG
213#define FLECS_META
214#define FLECS_METRICS
215#define FLECS_MODULE
216#define FLECS_OS_API_IMPL
217// #define FLECS_PERF_TRACE /**< Enable performance tracing */
218#define FLECS_PIPELINE
219#define FLECS_REST
220#define FLECS_PARSER
221#define FLECS_QUERY_DSL
222#define FLECS_SCRIPT
223// #define FLECS_SCRIPT_MATH /**< Math functions for flecs script (may require linking with libm) */
224#define FLECS_SYSTEM
225#define FLECS_STATS
226#define FLECS_TIMER
227#define FLECS_UNITS
228#endif // ifndef FLECS_CUSTOM_BUILD
229
233// #define FLECS_LOW_FOOTPRINT
234#ifdef FLECS_LOW_FOOTPRINT
235#define FLECS_HI_COMPONENT_ID (16)
236#define FLECS_HI_ID_RECORD_ID (16)
237#define FLECS_SPARSE_PAGE_BITS (4)
238#define FLECS_ENTITY_PAGE_BITS (6)
239#define FLECS_USE_OS_ALLOC
240#endif
241
252#ifndef FLECS_HI_COMPONENT_ID
253#define FLECS_HI_COMPONENT_ID (256)
254#endif
255
262#ifndef FLECS_HI_ID_RECORD_ID
263#define FLECS_HI_ID_RECORD_ID (1024)
264#endif
265
271#ifndef FLECS_SPARSE_PAGE_BITS
272#define FLECS_SPARSE_PAGE_BITS (6)
273#endif
274
277#ifndef FLECS_ENTITY_PAGE_BITS
278#define FLECS_ENTITY_PAGE_BITS (12)
279#endif
280
285// #define FLECS_USE_OS_ALLOC
286
289#ifndef FLECS_ID_DESC_MAX
290#define FLECS_ID_DESC_MAX (32)
291#endif
292
295#ifndef FLECS_EVENT_DESC_MAX
296#define FLECS_EVENT_DESC_MAX (8)
297#endif
298
301#define FLECS_VARIABLE_COUNT_MAX (64)
302
305#ifndef FLECS_TERM_COUNT_MAX
306#define FLECS_TERM_COUNT_MAX 32
307#endif
308
311#ifndef FLECS_TERM_ARG_COUNT_MAX
312#define FLECS_TERM_ARG_COUNT_MAX (16)
313#endif
314
317#ifndef FLECS_QUERY_VARIABLE_COUNT_MAX
318#define FLECS_QUERY_VARIABLE_COUNT_MAX (64)
319#endif
320
323#ifndef FLECS_QUERY_SCOPE_NESTING_MAX
324#define FLECS_QUERY_SCOPE_NESTING_MAX (8)
325#endif
326
331#ifndef FLECS_DAG_DEPTH_MAX
332#define FLECS_DAG_DEPTH_MAX (128)
333#endif
334
337#include "flecs/private/api_defines.h"
338#include "flecs/datastructures/vec.h" /* Vector datatype */
339#include "flecs/datastructures/sparse.h" /* Sparse set */
340#include "flecs/datastructures/block_allocator.h" /* Block allocator */
341#include "flecs/datastructures/stack_allocator.h" /* Stack allocator */
342#include "flecs/datastructures/map.h" /* Map */
343#include "flecs/datastructures/switch_list.h" /* Switch list */
344#include "flecs/datastructures/allocator.h" /* Allocator */
345#include "flecs/datastructures/strbuf.h" /* String builder */
346#include "flecs/os_api.h" /* Abstraction for operating system functions */
347
348#ifdef __cplusplus
349extern "C" {
350#endif
351
368typedef uint64_t ecs_id_t;
369
376
392typedef struct {
394 int32_t count;
395} ecs_type_t;
396
420
423
426
428typedef struct ecs_term_t ecs_term_t;
429
432
451
456
461typedef struct ecs_iter_t ecs_iter_t;
462
471typedef struct ecs_ref_t ecs_ref_t;
472
477
482
485
488
508typedef void ecs_poly_t;
509
512
520
528
535
546
565typedef void (*ecs_run_action_t)(
566 ecs_iter_t *it);
567
574typedef void (*ecs_iter_action_t)(
575 ecs_iter_t *it);
576
585 ecs_iter_t *it);
586
593 ecs_iter_t *it);
594
597 ecs_entity_t e1,
598 const void *ptr1,
599 ecs_entity_t e2,
600 const void *ptr2);
601
604 ecs_world_t* world,
605 ecs_table_t* table,
606 ecs_entity_t* entities,
607 void* ptr,
608 int32_t size,
609 int32_t lo,
610 int32_t hi,
611 ecs_order_by_action_t order_by);
612
614typedef uint64_t (*ecs_group_by_action_t)(
615 ecs_world_t *world,
616 ecs_table_t *table,
617 ecs_id_t group_id,
618 void *ctx);
619
621typedef void* (*ecs_group_create_action_t)(
622 ecs_world_t *world,
623 uint64_t group_id,
624 void *group_by_ctx); /* from ecs_query_desc_t */
625
628 ecs_world_t *world,
629 uint64_t group_id,
630 void *group_ctx, /* return value from ecs_group_create_action_t */
631 void *group_by_ctx); /* from ecs_query_desc_t */
632
634typedef void (*ecs_module_action_t)(
635 ecs_world_t *world);
636
638typedef void (*ecs_fini_action_t)(
639 ecs_world_t *world,
640 void *ctx);
641
643typedef void (*ecs_ctx_free_t)(
644 void *ctx);
645
647typedef int (*ecs_compare_action_t)(
648 const void *ptr1,
649 const void *ptr2);
650
652typedef uint64_t (*ecs_hash_value_action_t)(
653 const void *ptr);
654
656typedef void (*ecs_xtor_t)(
657 void *ptr,
658 int32_t count,
659 const ecs_type_info_t *type_info);
660
662typedef void (*ecs_copy_t)(
663 void *dst_ptr,
664 const void *src_ptr,
665 int32_t count,
666 const ecs_type_info_t *type_info);
667
669typedef void (*ecs_move_t)(
670 void *dst_ptr,
671 void *src_ptr,
672 int32_t count,
673 const ecs_type_info_t *type_info);
674
676typedef void (*flecs_poly_dtor_t)(
677 ecs_poly_t *poly);
678
697
708
716
717/* Term id flags */
718
723#define EcsSelf (1llu << 63)
724
729#define EcsUp (1llu << 62)
730
735#define EcsTrav (1llu << 61)
736
741#define EcsCascade (1llu << 60)
742
747#define EcsDesc (1llu << 59)
748
753#define EcsIsVariable (1llu << 58)
754
759#define EcsIsEntity (1llu << 57)
760
765#define EcsIsName (1llu << 56)
766
771#define EcsTraverseFlags (EcsSelf|EcsUp|EcsTrav|EcsCascade|EcsDesc)
772
777#define EcsTermRefFlags (EcsTraverseFlags|EcsIsVariable|EcsIsEntity|EcsIsName)
778
793
815
826 ecs_flags32_t flags;
827 int8_t var_count;
828 int8_t term_count;
829 int8_t field_count;
831 /* Bitmasks for quick field information lookups */
832 ecs_termset_t fixed_fields;
833 ecs_termset_t var_fields;
834 ecs_termset_t static_id_fields;
835 ecs_termset_t data_fields;
836 ecs_termset_t write_fields;
837 ecs_termset_t read_fields;
838 ecs_termset_t row_fields;
840 ecs_termset_t set_fields;
844 char **vars;
846 void *ctx;
853 int32_t eval_count;
854};
855
884
892/* Flags that can be used to check which hooks a type has set */
893#define ECS_TYPE_HOOK_CTOR (1 << 0)
894#define ECS_TYPE_HOOK_DTOR (1 << 1)
895#define ECS_TYPE_HOOK_COPY (1 << 2)
896#define ECS_TYPE_HOOK_MOVE (1 << 3)
897#define ECS_TYPE_HOOK_COPY_CTOR (1 << 4)
898#define ECS_TYPE_HOOK_MOVE_CTOR (1 << 5)
899#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR (1 << 6)
900#define ECS_TYPE_HOOK_MOVE_DTOR (1 << 7)
901
902/* Flags that can be used to set/check which hooks of a type are invalid */
903#define ECS_TYPE_HOOK_CTOR_ILLEGAL (1 << 8)
904#define ECS_TYPE_HOOK_DTOR_ILLEGAL (1 << 9)
905#define ECS_TYPE_HOOK_COPY_ILLEGAL (1 << 10)
906#define ECS_TYPE_HOOK_MOVE_ILLEGAL (1 << 11)
907#define ECS_TYPE_HOOK_COPY_CTOR_ILLEGAL (1 << 12)
908#define ECS_TYPE_HOOK_MOVE_CTOR_ILLEGAL (1 << 13)
909#define ECS_TYPE_HOOK_CTOR_MOVE_DTOR_ILLEGAL (1 << 14)
910#define ECS_TYPE_HOOK_MOVE_DTOR_ILLEGAL (1 << 15)
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)
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)
924
977
989
990#include "flecs/private/api_types.h" /* Supporting API types */
991#include "flecs/private/api_support.h" /* Supporting API functions */
992#include "flecs/datastructures/hashmap.h" /* Hashmap */
993
999
1004typedef struct ecs_entity_desc_t {
1005 int32_t _canary;
1011 const char *name;
1016 const char *sep;
1020 const char *root_sep;
1022 const char *symbol;
1038
1041
1043 const char *add_expr;
1045
1075
1089
1129 /* World */
1133 /* Matched data */
1135 const ecs_size_t *sizes;
1139 ecs_var_t *variables;
1142 ecs_flags64_t constrained_vars;
1143 uint64_t group_id;
1144 ecs_termset_t set_fields;
1145 ecs_termset_t ref_fields;
1146 ecs_termset_t row_fields;
1147 ecs_termset_t up_fields;
1149 /* Input information */
1153 int32_t event_cur;
1155 /* Query information */
1157 int8_t term_index;
1164 /* Context */
1165 void *param;
1166 void *ctx;
1169 void *run_ctx;
1171 /* Time */
1175 /* Iterator counters */
1177 int32_t offset;
1178 int32_t count;
1180 /* Misc */
1181 ecs_flags32_t flags;
1183 ecs_iter_private_t priv_;
1185 /* Chained iterators */
1190};
1191
1192
1197#define EcsQueryMatchPrefab (1u << 1u)
1198
1203#define EcsQueryMatchDisabled (1u << 2u)
1204
1209#define EcsQueryMatchEmptyTables (1u << 3u)
1210
1215#define EcsQueryAllowUnresolvedByName (1u << 6u)
1216
1221#define EcsQueryTableOnly (1u << 7u)
1222
1223
1297
1359
1364typedef struct ecs_event_desc_t {
1367
1372
1375
1379
1381 int32_t offset;
1382
1386 int32_t count;
1387
1390
1395 void *param;
1396
1400 const void *const_param;
1401
1404
1406 ecs_flags32_t flags;
1408
1409
1418typedef struct ecs_build_info_t {
1419 const char *compiler;
1420 const char **addons;
1421 const char *version;
1425 bool debug;
1429
1488
1495
1506typedef struct EcsIdentifier {
1507 char *value;
1508 ecs_size_t length;
1509 uint64_t hash;
1510 uint64_t index_hash;
1511 ecs_hashmap_t *index;
1513
1515typedef struct EcsComponent {
1516 ecs_size_t size;
1517 ecs_size_t alignment;
1519
1524
1533
1537/* Only include deprecated definitions if deprecated addon is required */
1538#ifdef FLECS_DEPRECATED
1540#endif
1541
1557FLECS_API extern const ecs_id_t ECS_PAIR;
1558
1560FLECS_API extern const ecs_id_t ECS_AUTO_OVERRIDE;
1561
1563FLECS_API extern const ecs_id_t ECS_TOGGLE;
1564
1572/* Builtin component ids */
1573
1575FLECS_API extern const ecs_entity_t ecs_id(EcsComponent);
1576
1578FLECS_API extern const ecs_entity_t ecs_id(EcsIdentifier);
1579
1581FLECS_API extern const ecs_entity_t ecs_id(EcsPoly);
1582
1584FLECS_API extern const ecs_entity_t ecs_id(EcsDefaultChildComponent);
1585
1587FLECS_API extern const ecs_entity_t EcsQuery;
1588
1590FLECS_API extern const ecs_entity_t EcsObserver;
1591
1593FLECS_API extern const ecs_entity_t EcsSystem;
1594
1596FLECS_API extern const ecs_entity_t ecs_id(EcsTickSource);
1597
1599FLECS_API extern const ecs_entity_t ecs_id(EcsPipelineQuery);
1600
1602FLECS_API extern const ecs_entity_t ecs_id(EcsTimer);
1603
1605FLECS_API extern const ecs_entity_t ecs_id(EcsRateFilter);
1606
1608FLECS_API extern const ecs_entity_t EcsFlecs;
1609
1611FLECS_API extern const ecs_entity_t EcsFlecsCore;
1612
1614FLECS_API extern const ecs_entity_t EcsWorld;
1615
1617FLECS_API extern const ecs_entity_t EcsWildcard;
1618
1620FLECS_API extern const ecs_entity_t EcsAny;
1621
1623FLECS_API extern const ecs_entity_t EcsThis;
1624
1626FLECS_API extern const ecs_entity_t EcsVariable;
1627
1629#define EcsSingleton EcsVariable
1630
1638FLECS_API extern const ecs_entity_t EcsTransitive;
1639
1647FLECS_API extern const ecs_entity_t EcsReflexive;
1648
1659FLECS_API extern const ecs_entity_t EcsFinal;
1660
1666FLECS_API extern const ecs_entity_t EcsInheritable;
1667
1669FLECS_API extern const ecs_entity_t EcsOnInstantiate;
1670
1674FLECS_API extern const ecs_entity_t EcsOverride;
1675
1679FLECS_API extern const ecs_entity_t EcsInherit;
1680
1685FLECS_API extern const ecs_entity_t EcsDontInherit;
1686
1694FLECS_API extern const ecs_entity_t EcsSymmetric;
1695
1705FLECS_API extern const ecs_entity_t EcsExclusive;
1706
1708FLECS_API extern const ecs_entity_t EcsAcyclic;
1709
1712FLECS_API extern const ecs_entity_t EcsTraversable;
1713
1723FLECS_API extern const ecs_entity_t EcsWith;
1724
1734FLECS_API extern const ecs_entity_t EcsOneOf;
1735
1737FLECS_API extern const ecs_entity_t EcsCanToggle;
1738
1742FLECS_API extern const ecs_entity_t EcsTrait;
1743
1753FLECS_API extern const ecs_entity_t EcsRelationship;
1754
1764FLECS_API extern const ecs_entity_t EcsTarget;
1765
1768FLECS_API extern const ecs_entity_t EcsPairIsTag;
1769
1771FLECS_API extern const ecs_entity_t EcsName;
1772
1774FLECS_API extern const ecs_entity_t EcsSymbol;
1775
1777FLECS_API extern const ecs_entity_t EcsAlias;
1778
1780FLECS_API extern const ecs_entity_t EcsChildOf;
1781
1783FLECS_API extern const ecs_entity_t EcsIsA;
1784
1786FLECS_API extern const ecs_entity_t EcsDependsOn;
1787
1789FLECS_API extern const ecs_entity_t EcsSlotOf;
1790
1792FLECS_API extern const ecs_entity_t EcsModule;
1793
1795FLECS_API extern const ecs_entity_t EcsPrivate;
1796
1799FLECS_API extern const ecs_entity_t EcsPrefab;
1800
1803FLECS_API extern const ecs_entity_t EcsDisabled;
1804
1808FLECS_API extern const ecs_entity_t EcsNotQueryable;
1809
1811FLECS_API extern const ecs_entity_t EcsOnAdd;
1812
1814FLECS_API extern const ecs_entity_t EcsOnRemove;
1815
1817FLECS_API extern const ecs_entity_t EcsOnSet;
1818
1820FLECS_API extern const ecs_entity_t EcsMonitor;
1821
1823FLECS_API extern const ecs_entity_t EcsOnTableCreate;
1824
1826FLECS_API extern const ecs_entity_t EcsOnTableDelete;
1827
1829FLECS_API extern const ecs_entity_t EcsOnDelete;
1830
1833FLECS_API extern const ecs_entity_t EcsOnDeleteTarget;
1834
1837FLECS_API extern const ecs_entity_t EcsRemove;
1838
1841FLECS_API extern const ecs_entity_t EcsDelete;
1842
1845FLECS_API extern const ecs_entity_t EcsPanic;
1846
1848FLECS_API extern const ecs_entity_t EcsSparse;
1849
1851FLECS_API extern const ecs_entity_t EcsUnion;
1852
1854FLECS_API extern const ecs_entity_t EcsPredEq;
1855
1857FLECS_API extern const ecs_entity_t EcsPredMatch;
1858
1860FLECS_API extern const ecs_entity_t EcsPredLookup;
1861
1863FLECS_API extern const ecs_entity_t EcsScopeOpen;
1864
1866FLECS_API extern const ecs_entity_t EcsScopeClose;
1867
1872FLECS_API extern const ecs_entity_t EcsEmpty;
1873
1874FLECS_API extern const ecs_entity_t ecs_id(EcsPipeline);
1875FLECS_API extern const ecs_entity_t EcsOnStart;
1876FLECS_API extern const ecs_entity_t EcsPreFrame;
1877FLECS_API extern const ecs_entity_t EcsOnLoad;
1878FLECS_API extern const ecs_entity_t EcsPostLoad;
1879FLECS_API extern const ecs_entity_t EcsPreUpdate;
1880FLECS_API extern const ecs_entity_t EcsOnUpdate;
1881FLECS_API extern const ecs_entity_t EcsOnValidate;
1882FLECS_API extern const ecs_entity_t EcsPostUpdate;
1883FLECS_API extern const ecs_entity_t EcsPreStore;
1884FLECS_API extern const ecs_entity_t EcsOnStore;
1885FLECS_API extern const ecs_entity_t EcsPostFrame;
1886FLECS_API extern const ecs_entity_t EcsPhase;
1888FLECS_API extern const ecs_entity_t EcsConstant;
1892#define EcsLastInternalComponentId (ecs_id(EcsPoly))
1893
1896#define EcsFirstUserComponentId (8)
1897
1900#define EcsFirstUserEntityId (FLECS_HI_COMPONENT_ID + 128)
1901
1902/* When visualized the reserved id ranges look like this:
1903 * - [1..8]: Builtin components
1904 * - [9..FLECS_HI_COMPONENT_ID]: Low ids reserved for application components
1905 * - [FLECS_HI_COMPONENT_ID + 1..EcsFirstUserEntityId]: Builtin entities
1906 */
1907
1929FLECS_API
1931
1938FLECS_API
1940
1948FLECS_API
1950 int argc,
1951 char *argv[]);
1952
1959FLECS_API
1961 ecs_world_t *world);
1962
1970FLECS_API
1972 const ecs_world_t *world);
1973
1981FLECS_API
1983 ecs_world_t *world,
1984 ecs_fini_action_t action,
1985 void *ctx);
1986
1993
2020FLECS_API
2022 const ecs_world_t *world);
2023
2031FLECS_API
2033 const ecs_world_t *world);
2034
2060FLECS_API
2062 ecs_world_t *world,
2063 ecs_ftime_t delta_time);
2064
2071FLECS_API
2073 ecs_world_t *world);
2074
2082FLECS_API
2084 ecs_world_t *world,
2085 ecs_fini_action_t action,
2086 void *ctx);
2087
2094FLECS_API
2096 ecs_world_t *world);
2097
2104FLECS_API
2106 const ecs_world_t *world);
2107
2120 ecs_world_t *world,
2121 bool enable);
2122
2134 ecs_world_t *world,
2135 bool enable);
2136
2152FLECS_API
2154 ecs_world_t *world,
2155 ecs_ftime_t fps);
2156
2170FLECS_API
2172 ecs_world_t *world,
2173 ecs_flags32_t flags);
2174
2251FLECS_API
2253 ecs_world_t *world,
2254 bool multi_threaded);
2255
2263FLECS_API
2265 ecs_world_t *world);
2266
2277FLECS_API
2279 ecs_world_t *world);
2280
2296FLECS_API
2298 ecs_world_t *world);
2299
2310FLECS_API
2312 const ecs_world_t *world);
2313
2327FLECS_API
2329 ecs_world_t *world);
2330
2345FLECS_API
2347 ecs_world_t *world);
2348
2359FLECS_API
2361 ecs_world_t *world);
2362
2376FLECS_API
2378 ecs_world_t *world,
2379 int32_t stages);
2380
2387FLECS_API
2389 const ecs_world_t *world);
2390
2406FLECS_API
2408 const ecs_world_t *world,
2409 int32_t stage_id);
2410
2418FLECS_API
2420 const ecs_world_t *world);
2421
2429FLECS_API
2431 ecs_world_t *world);
2432
2437FLECS_API
2439 ecs_world_t *stage);
2440
2448FLECS_API
2450 const ecs_world_t *world);
2451
2467FLECS_API
2469 ecs_world_t *world,
2470 void *ctx,
2471 ecs_ctx_free_t ctx_free);
2472
2481FLECS_API
2483 ecs_world_t *world,
2484 void *ctx,
2485 ecs_ctx_free_t ctx_free);
2486
2494FLECS_API
2496 const ecs_world_t *world);
2497
2505FLECS_API
2507 const ecs_world_t *world);
2508
2514FLECS_API
2516
2522FLECS_API
2524 const ecs_world_t *world);
2525
2534FLECS_API
2536 ecs_world_t *world,
2537 int32_t entity_count);
2538
2554FLECS_API
2556 ecs_world_t *world,
2557 ecs_entity_t id_start,
2558 ecs_entity_t id_end);
2559
2570FLECS_API
2572 ecs_world_t *world,
2573 bool enable);
2574
2580FLECS_API
2582 const ecs_world_t *world);
2583
2597FLECS_API
2599 ecs_world_t *world,
2600 ecs_flags32_t flags);
2601
2613
2643FLECS_API
2645 ecs_world_t *world,
2646 const ecs_delete_empty_tables_desc_t *desc);
2647
2653FLECS_API
2655 const ecs_poly_t *poly);
2656
2662FLECS_API
2664 const ecs_poly_t *poly);
2665
2679FLECS_API
2681 const ecs_poly_t *object,
2682 int32_t type);
2683
2687#define flecs_poly_is(object, type)\
2688 flecs_poly_is_(object, type##_magic)
2689
2698FLECS_API
2700 ecs_entity_t first,
2701 ecs_entity_t second);
2702
2729FLECS_API
2731 ecs_world_t *world);
2732
2750FLECS_API
2752 ecs_world_t *world);
2753
2762FLECS_API
2764 ecs_world_t *world,
2765 ecs_id_t id);
2766
2774FLECS_API
2776 ecs_world_t *world,
2777 ecs_table_t *table);
2778
2797FLECS_API
2799 ecs_world_t *world,
2800 const ecs_entity_desc_t *desc);
2801
2828FLECS_API
2830 ecs_world_t *world,
2831 const ecs_bulk_desc_t *desc);
2832
2842FLECS_API
2844 ecs_world_t *world,
2845 ecs_id_t id,
2846 int32_t count);
2847
2863FLECS_API
2865 ecs_world_t *world,
2866 ecs_entity_t dst,
2867 ecs_entity_t src,
2868 bool copy_value);
2869
2878FLECS_API
2880 ecs_world_t *world,
2881 ecs_entity_t entity);
2882
2890FLECS_API
2892 ecs_world_t *world,
2893 ecs_id_t id);
2894
2912FLECS_API
2914 ecs_world_t *world,
2915 ecs_entity_t entity,
2916 ecs_id_t id);
2917
2926FLECS_API
2928 ecs_world_t *world,
2929 ecs_entity_t entity,
2930 ecs_id_t id);
2931
2983FLECS_API
2985 ecs_world_t *world,
2986 ecs_entity_t entity,
2987 ecs_id_t id);
2988
2995FLECS_API
2997 ecs_world_t *world,
2998 ecs_entity_t entity);
2999
3007FLECS_API
3009 ecs_world_t *world,
3010 ecs_id_t id);
3011
3019FLECS_API
3021 ecs_world_t *world,
3022 ecs_id_t id);
3023
3030FLECS_API
3032 const ecs_world_t *world);
3033
3052FLECS_API
3054 ecs_world_t *world,
3055 ecs_entity_t entity,
3056 bool enabled);
3057
3071FLECS_API
3073 ecs_world_t *world,
3074 ecs_entity_t entity,
3075 ecs_id_t id,
3076 bool enable);
3077
3088FLECS_API
3090 const ecs_world_t *world,
3091 ecs_entity_t entity,
3092 ecs_id_t id);
3093
3117FLECS_API
3118const void* ecs_get_id(
3119 const ecs_world_t *world,
3120 ecs_entity_t entity,
3121 ecs_id_t id);
3122
3134FLECS_API
3136 const ecs_world_t *world,
3137 ecs_entity_t entity,
3138 ecs_id_t id);
3139
3157FLECS_API
3159 ecs_world_t *world,
3160 ecs_entity_t entity,
3161 ecs_id_t id);
3162
3174FLECS_API
3176 ecs_world_t *world,
3177 ecs_entity_t entity,
3178 ecs_id_t id);
3179
3190FLECS_API
3192 const ecs_world_t *world,
3193 ecs_entity_t entity,
3194 ecs_id_t id);
3195
3204FLECS_API
3206 const ecs_world_t *world,
3207 ecs_ref_t *ref,
3208 ecs_id_t id);
3209
3217FLECS_API
3219 const ecs_world_t *world,
3220 ecs_ref_t *ref);
3221
3229FLECS_API
3231 const ecs_world_t *world,
3232 ecs_entity_t entity);
3233
3252FLECS_API
3254 ecs_world_t *world,
3255 ecs_entity_t entity);
3256
3263FLECS_API
3265 ecs_record_t *record);
3266
3286FLECS_API
3288 ecs_world_t *world,
3289 ecs_entity_t entity);
3290
3296FLECS_API
3298 const ecs_record_t *record);
3299
3306FLECS_API
3308 const ecs_record_t *record);
3309
3325FLECS_API
3327 const ecs_world_t *world,
3328 const ecs_record_t *record,
3329 ecs_id_t id);
3330
3339FLECS_API
3341 ecs_world_t *world,
3342 ecs_record_t *record,
3343 ecs_id_t id);
3344
3352FLECS_API
3354 ecs_world_t *world,
3355 const ecs_record_t *record,
3356 ecs_id_t id);
3357
3374FLECS_API
3376 const ecs_record_t *record,
3377 int32_t column,
3378 size_t size);
3379
3399FLECS_API
3401 ecs_world_t *world,
3402 ecs_entity_t entity,
3403 ecs_id_t id,
3404 bool *is_new);
3405
3415FLECS_API
3417 ecs_world_t *world,
3418 ecs_entity_t entity,
3419 ecs_id_t id);
3420
3436FLECS_API
3438 ecs_world_t *world,
3439 ecs_entity_t entity,
3440 ecs_id_t id,
3441 size_t size,
3442 const void *ptr);
3443
3471FLECS_API
3473 const ecs_world_t *world,
3474 ecs_entity_t e);
3475
3501FLECS_API
3503 const ecs_world_t *world,
3504 ecs_entity_t e);
3505
3511FLECS_API
3513 ecs_entity_t e);
3514
3531FLECS_API
3533 const ecs_world_t *world,
3534 ecs_entity_t e);
3535
3558FLECS_API
3560 ecs_world_t *world,
3561 ecs_entity_t entity);
3562
3581FLECS_API
3583 ecs_world_t *world,
3584 ecs_id_t id);
3585
3593FLECS_API
3595 const ecs_world_t *world,
3596 ecs_entity_t entity);
3597
3612FLECS_API
3614 ecs_world_t *world,
3615 ecs_entity_t entity);
3616
3632FLECS_API
3634 const ecs_world_t *world,
3635 ecs_entity_t entity);
3636
3643FLECS_API
3645 const ecs_world_t *world,
3646 ecs_entity_t entity);
3647
3655FLECS_API
3657 const ecs_world_t *world,
3658 const ecs_type_t* type);
3659
3671FLECS_API
3673 const ecs_world_t *world,
3674 const ecs_table_t *table);
3675
3690FLECS_API
3692 const ecs_world_t *world,
3693 ecs_entity_t entity);
3694
3705FLECS_API
3707 const ecs_world_t *world,
3708 ecs_entity_t entity,
3709 ecs_id_t id);
3710
3721FLECS_API
3723 const ecs_world_t *world,
3724 ecs_entity_t entity,
3725 ecs_id_t id);
3726
3741FLECS_API
3743 const ecs_world_t *world,
3744 ecs_entity_t entity,
3745 ecs_entity_t rel,
3746 int32_t index);
3747
3761FLECS_API
3763 const ecs_world_t *world,
3764 ecs_entity_t entity);
3765
3786FLECS_API
3788 const ecs_world_t *world,
3789 ecs_entity_t entity,
3790 ecs_entity_t rel,
3791 ecs_id_t id);
3792
3803FLECS_API
3805 const ecs_world_t *world,
3806 ecs_entity_t entity,
3807 ecs_entity_t rel);
3808
3816FLECS_API
3818 const ecs_world_t *world,
3819 ecs_id_t entity);
3820
3840FLECS_API
3841const char* ecs_get_name(
3842 const ecs_world_t *world,
3843 ecs_entity_t entity);
3844
3854FLECS_API
3855const char* ecs_get_symbol(
3856 const ecs_world_t *world,
3857 ecs_entity_t entity);
3858
3872FLECS_API
3874 ecs_world_t *world,
3875 ecs_entity_t entity,
3876 const char *name);
3877
3891FLECS_API
3893 ecs_world_t *world,
3894 ecs_entity_t entity,
3895 const char *symbol);
3896
3908FLECS_API
3910 ecs_world_t *world,
3911 ecs_entity_t entity,
3912 const char *alias);
3913
3929FLECS_API
3931 const ecs_world_t *world,
3932 const char *path);
3933
3948FLECS_API
3950 const ecs_world_t *world,
3951 ecs_entity_t parent,
3952 const char *name);
3953
3976FLECS_API
3978 const ecs_world_t *world,
3979 ecs_entity_t parent,
3980 const char *path,
3981 const char *sep,
3982 const char *prefix,
3983 bool recursive);
3984
4002FLECS_API
4004 const ecs_world_t *world,
4005 const char *symbol,
4006 bool lookup_as_path,
4007 bool recursive);
4008
4030FLECS_API
4032 const ecs_world_t *world,
4033 ecs_entity_t parent,
4034 ecs_entity_t child,
4035 const char *sep,
4036 const char *prefix);
4037
4051 const ecs_world_t *world,
4052 ecs_entity_t parent,
4053 ecs_entity_t child,
4054 const char *sep,
4055 const char *prefix,
4056 ecs_strbuf_t *buf,
4057 bool escape);
4058
4074FLECS_API
4076 ecs_world_t *world,
4077 ecs_entity_t parent,
4078 const char *path,
4079 const char *sep,
4080 const char *prefix);
4081
4096FLECS_API
4098 ecs_world_t *world,
4099 ecs_entity_t entity,
4100 ecs_entity_t parent,
4101 const char *path,
4102 const char *sep,
4103 const char *prefix);
4104
4118FLECS_API
4120 ecs_world_t *world,
4121 ecs_entity_t scope);
4122
4130FLECS_API
4132 const ecs_world_t *world);
4133
4143FLECS_API
4145 ecs_world_t *world,
4146 const char *prefix);
4147
4174FLECS_API
4176 ecs_world_t *world,
4177 const ecs_entity_t *lookup_path);
4178
4185FLECS_API
4187 const ecs_world_t *world);
4188
4213FLECS_API
4215 ecs_world_t *world,
4216 const ecs_component_desc_t *desc);
4217
4227FLECS_API
4229 const ecs_world_t *world,
4230 ecs_id_t id);
4231
4243FLECS_API
4245 ecs_world_t *world,
4246 ecs_entity_t id,
4247 const ecs_type_hooks_t *hooks);
4248
4255FLECS_API
4257 const ecs_world_t *world,
4258 ecs_entity_t id);
4259
4283FLECS_API
4285 const ecs_world_t *world,
4286 ecs_id_t id);
4287
4296FLECS_API
4298 const ecs_world_t *world,
4299 ecs_id_t id);
4300
4320FLECS_API
4322 const ecs_world_t *world,
4323 ecs_id_t id);
4324
4333FLECS_API
4335 ecs_id_t id,
4336 ecs_id_t pattern);
4337
4343FLECS_API
4345 ecs_id_t id);
4346
4352FLECS_API
4354 ecs_id_t id);
4355
4369FLECS_API
4371 const ecs_world_t *world,
4372 ecs_id_t id);
4373
4382FLECS_API
4383ecs_flags32_t ecs_id_get_flags(
4384 const ecs_world_t *world,
4385 ecs_id_t id);
4386
4393FLECS_API
4395 ecs_id_t id_flags);
4396
4404FLECS_API
4406 const ecs_world_t *world,
4407 ecs_id_t id);
4408
4416FLECS_API
4418 const ecs_world_t *world,
4419 ecs_id_t id,
4420 ecs_strbuf_t *buf);
4421
4429FLECS_API
4431 const ecs_world_t *world,
4432 const char *expr);
4433
4447FLECS_API
4449 const ecs_term_ref_t *id);
4450
4462FLECS_API
4464 const ecs_term_t *term);
4465
4480FLECS_API
4482 const ecs_term_t *term);
4483
4496FLECS_API
4498 const ecs_term_t *term);
4499
4508FLECS_API
4510 const ecs_world_t *world,
4511 const ecs_term_t *term);
4512
4520FLECS_API
4522 const ecs_query_t *query);
4523
4564FLECS_API
4566 const ecs_world_t *world,
4567 ecs_id_t id);
4568
4574FLECS_API
4576 ecs_iter_t *it);
4577
4590FLECS_API
4592 const ecs_world_t *world,
4593 ecs_entity_t parent);
4594
4600FLECS_API
4602 ecs_iter_t *it);
4603
4619FLECS_API
4621 ecs_world_t *world,
4622 const ecs_query_desc_t *desc);
4623
4628FLECS_API
4630 ecs_query_t *query);
4631
4640FLECS_API
4642 const ecs_query_t *query,
4643 const char *name);
4644
4652FLECS_API
4654 const ecs_query_t *query,
4655 int32_t var_id);
4656
4667FLECS_API
4669 const ecs_query_t *query,
4670 int32_t var_id);
4671
4740FLECS_API
4742 const ecs_world_t *world,
4743 const ecs_query_t *query);
4744
4752FLECS_API
4754 ecs_iter_t *it);
4755
4774FLECS_API
4776 ecs_query_t *query,
4777 ecs_entity_t entity,
4778 ecs_iter_t *it);
4779
4798FLECS_API
4800 ecs_query_t *query,
4801 ecs_table_t *table,
4802 ecs_iter_t *it);
4803
4830FLECS_API
4832 ecs_query_t *query,
4833 ecs_table_range_t *range,
4834 ecs_iter_t *it);
4835
4843FLECS_API
4845 const ecs_query_t *query);
4846
4856FLECS_API
4858 const ecs_query_t *query);
4859
4874FLECS_API
4876 const ecs_query_t *query,
4877 const ecs_iter_t *it);
4878
4896FLECS_API
4898 ecs_query_t *query,
4899 ecs_iter_t *it,
4900 const char *expr);
4901
4929FLECS_API
4931 ecs_query_t *query);
4932
4941FLECS_API
4943 const ecs_world_t *world,
4944 ecs_entity_t query);
4945
4956FLECS_API
4958 ecs_iter_t *it);
4959
4982FLECS_API
4984 ecs_iter_t *it,
4985 uint64_t group_id);
4986
4995FLECS_API
4997 const ecs_query_t *query,
4998 uint64_t group_id);
4999
5008FLECS_API
5010 const ecs_query_t *query,
5011 uint64_t group_id);
5012
5020
5027FLECS_API
5029 const ecs_query_t *query);
5030
5036FLECS_API
5038 const ecs_query_t *query);
5039
5048FLECS_API
5050 const ecs_query_t *query);
5051
5080FLECS_API
5082 ecs_world_t *world,
5083 ecs_event_desc_t *desc);
5084
5095FLECS_API
5097 ecs_world_t *world,
5098 ecs_event_desc_t *desc);
5099
5110FLECS_API
5112 ecs_world_t *world,
5113 const ecs_observer_desc_t *desc);
5114
5123FLECS_API
5125 const ecs_world_t *world,
5126 ecs_entity_t observer);
5127
5150FLECS_API
5152 ecs_iter_t *it);
5153
5163FLECS_API
5165 ecs_iter_t *it);
5166
5178FLECS_API
5180 ecs_iter_t *it);
5181
5194FLECS_API
5196 ecs_iter_t *it);
5197
5205FLECS_API
5207 ecs_iter_t *it);
5208
5247FLECS_API
5249 ecs_iter_t *it,
5250 int32_t var_id,
5251 ecs_entity_t entity);
5252
5263FLECS_API
5265 ecs_iter_t *it,
5266 int32_t var_id,
5267 const ecs_table_t *table);
5268
5279FLECS_API
5281 ecs_iter_t *it,
5282 int32_t var_id,
5283 const ecs_table_range_t *range);
5284
5297FLECS_API
5299 ecs_iter_t *it,
5300 int32_t var_id);
5301
5315FLECS_API
5317 ecs_iter_t *it,
5318 int32_t var_id);
5319
5333FLECS_API
5335 ecs_iter_t *it,
5336 int32_t var_id);
5337
5349FLECS_API
5351 ecs_iter_t *it,
5352 int32_t var_id);
5353
5365FLECS_API
5367 ecs_iter_t *it);
5368
5380FLECS_API
5382 const ecs_iter_t *it);
5383
5399FLECS_API
5401 const ecs_iter_t *it,
5402 int32_t offset,
5403 int32_t limit);
5404
5411FLECS_API
5413 ecs_iter_t *it);
5414
5435FLECS_API
5437 const ecs_iter_t *it,
5438 int32_t index,
5439 int32_t count);
5440
5447FLECS_API
5449 ecs_iter_t *it);
5450
5492FLECS_API
5494 const ecs_iter_t *it,
5495 size_t size,
5496 int8_t index);
5497
5519FLECS_API
5521 const ecs_iter_t *it,
5522 size_t size,
5523 int8_t index,
5524 int32_t row);
5525
5534FLECS_API
5536 const ecs_iter_t *it,
5537 int8_t index);
5538
5549FLECS_API
5551 const ecs_iter_t *it,
5552 int8_t index);
5553
5560FLECS_API
5562 const ecs_iter_t *it,
5563 int8_t index);
5564
5571FLECS_API
5573 const ecs_iter_t *it,
5574 int8_t index);
5575
5584FLECS_API
5586 const ecs_iter_t *it,
5587 int8_t index);
5588
5596FLECS_API
5598 const ecs_iter_t *it,
5599 int8_t index);
5600
5608FLECS_API
5610 const ecs_iter_t *it,
5611 int8_t index);
5612
5626FLECS_API
5628 const ecs_iter_t *it,
5629 int8_t index);
5630
5646FLECS_API
5648 const ecs_table_t *table);
5649
5660FLECS_API
5662 const ecs_world_t *world,
5663 const ecs_table_t *table,
5664 ecs_id_t id);
5665
5675FLECS_API
5677 const ecs_world_t *world,
5678 const ecs_table_t *table,
5679 ecs_id_t id);
5680
5688FLECS_API
5690 const ecs_table_t *table);
5691
5705FLECS_API
5707 const ecs_table_t *table,
5708 int32_t index);
5709
5718FLECS_API
5720 const ecs_table_t *table,
5721 int32_t index);
5722
5731FLECS_API
5733 const ecs_table_t *table,
5734 int32_t index,
5735 int32_t offset);
5736
5746FLECS_API
5748 const ecs_world_t *world,
5749 const ecs_table_t *table,
5750 ecs_id_t id,
5751 int32_t offset);
5752
5760FLECS_API
5762 const ecs_table_t *table,
5763 int32_t index);
5764
5771FLECS_API
5773 const ecs_table_t *table);
5774
5782FLECS_API
5784 const ecs_table_t *table);
5785
5792FLECS_API
5794 const ecs_table_t *table);
5795
5806FLECS_API
5808 const ecs_world_t *world,
5809 const ecs_table_t *table,
5810 ecs_id_t id);
5811
5822FLECS_API
5824 const ecs_world_t *world,
5825 const ecs_table_t *table,
5826 ecs_entity_t rel);
5827
5837FLECS_API
5839 ecs_world_t *world,
5840 ecs_table_t *table,
5841 ecs_id_t id);
5842
5853FLECS_API
5855 ecs_world_t *world,
5856 const ecs_id_t *ids,
5857 int32_t id_count);
5858
5868FLECS_API
5870 ecs_world_t *world,
5871 ecs_table_t *table,
5872 ecs_id_t id);
5873
5889FLECS_API
5891 ecs_world_t *world,
5892 ecs_table_t *table);
5893
5900FLECS_API
5902 ecs_world_t *world,
5903 ecs_table_t *table);
5904
5914FLECS_API
5916 ecs_table_t *table,
5917 ecs_flags32_t flags);
5918
5926FLECS_API
5928 ecs_world_t* world,
5929 ecs_table_t* table,
5930 int32_t row_1,
5931 int32_t row_2);
5932
5955FLECS_API
5957 ecs_world_t *world,
5958 ecs_entity_t entity,
5959 ecs_record_t *record,
5960 ecs_table_t *table,
5961 const ecs_type_t *added,
5962 const ecs_type_t *removed);
5963
5964
5983FLECS_API
5985 const ecs_world_t *world,
5986 const ecs_table_t *table,
5987 ecs_id_t id,
5988 ecs_id_t *id_out);
5989
6025FLECS_API
6027 const ecs_world_t *world,
6028 const ecs_table_t *table,
6029 int32_t offset,
6030 ecs_id_t id,
6031 ecs_id_t *id_out);
6032
6074FLECS_API
6076 const ecs_world_t *world,
6077 const ecs_table_t *table,
6078 int32_t offset,
6079 ecs_id_t id,
6080 ecs_entity_t rel,
6081 ecs_flags64_t flags, /* EcsSelf and/or EcsUp */
6082 ecs_entity_t *subject_out,
6083 ecs_id_t *id_out,
6084 struct ecs_table_record_t **tr_out);
6085
6093FLECS_API
6095 ecs_world_t* world,
6096 ecs_table_t* table);
6097
6114FLECS_API
6116 const ecs_world_t *world,
6117 ecs_entity_t type,
6118 void *ptr);
6119
6127FLECS_API
6129 const ecs_world_t *world,
6130 const ecs_type_info_t *ti,
6131 void *ptr);
6132
6139FLECS_API
6141 ecs_world_t *world,
6142 ecs_entity_t type);
6143
6151 ecs_world_t *world,
6152 const ecs_type_info_t *ti);
6153
6162 const ecs_world_t *world,
6163 const ecs_type_info_t *ti,
6164 void *ptr);
6165
6173FLECS_API
6175 const ecs_world_t *world,
6176 ecs_entity_t type,
6177 void* ptr);
6178
6186FLECS_API
6188 ecs_world_t *world,
6189 ecs_entity_t type,
6190 void* ptr);
6191
6200FLECS_API
6202 const ecs_world_t *world,
6203 const ecs_type_info_t *ti,
6204 void* dst,
6205 const void *src);
6206
6215FLECS_API
6217 const ecs_world_t *world,
6218 ecs_entity_t type,
6219 void* dst,
6220 const void *src);
6221
6231 const ecs_world_t *world,
6232 const ecs_type_info_t *ti,
6233 void* dst,
6234 void *src);
6235
6245 const ecs_world_t *world,
6246 ecs_entity_t type,
6247 void* dst,
6248 void *src);
6249
6259 const ecs_world_t *world,
6260 const ecs_type_info_t *ti,
6261 void* dst,
6262 void *src);
6263
6273 const ecs_world_t *world,
6274 ecs_entity_t type,
6275 void* dst,
6276 void *src);
6277
6291#include "flecs/addons/flecs_c.h"
6292
6293#ifdef __cplusplus
6294}
6295#endif
6296
6297#include "flecs/private/addons.h"
6298
6299#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 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_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:422
struct ecs_ref_t ecs_ref_t
A ref is a fast way to fetch a component for a specific entity.
Definition flecs.h:471
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:375
struct ecs_table_record_t ecs_table_record_t
Metadata describing where a component id is stored in a table.
struct ecs_id_record_t ecs_id_record_t
Information about a (component) id, such as type info and tables with the id.
Definition flecs.h:487
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:419
struct ecs_mixins_t ecs_mixins_t
Type that stores poly mixins.
Definition flecs.h:511
uint64_t ecs_id_t
Ids are the things that can be added to an entity.
Definition flecs.h:368
struct ecs_observable_t ecs_observable_t
An observable produces events that can be listened for by an observer.
Definition flecs.h:455
struct ecs_table_t ecs_table_t
A table stores entities and components for a specific type.
Definition flecs.h:425
void ecs_poly_t
A poly object.
Definition flecs.h:508
struct ecs_table_cache_hdr_t ecs_table_cache_hdr_t
Header for table cache elements.
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:634
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:614
uint64_t(* ecs_hash_value_action_t)(const void *ptr)
Callback used for hashing values.
Definition flecs.h:652
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:627
void(* ecs_iter_fini_action_t)(ecs_iter_t *it)
Function prototype for freeing an iterator.
Definition flecs.h:592
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:621
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:603
bool(* ecs_iter_next_action_t)(ecs_iter_t *it)
Function prototype for iterating an iterator.
Definition flecs.h:584
void(* ecs_iter_action_t)(ecs_iter_t *it)
Function prototype for iterables.
Definition flecs.h:574
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:662
int(* ecs_compare_action_t)(const void *ptr1, const void *ptr2)
Callback used for sorting values.
Definition flecs.h:647
void(* ecs_fini_action_t)(ecs_world_t *world, void *ctx)
Action callback on world exit.
Definition flecs.h:638
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:669
void(* flecs_poly_dtor_t)(ecs_poly_t *poly)
Destructor function for poly objects.
Definition flecs.h:676
void(* ecs_run_action_t)(ecs_iter_t *it)
Function prototype for runnables (systems, observers).
Definition flecs.h:565
void(* ecs_ctx_free_t)(void *ctx)
Function to cleanup context data.
Definition flecs.h:643
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:596
void(* ecs_xtor_t)(void *ptr, int32_t count, const ecs_type_info_t *type_info)
Constructor/destructor callback.
Definition flecs.h:656
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.
ecs_entity_t ecs_record_get_entity(const ecs_record_t *record)
Get entity corresponding with record.
void ecs_ref_update(const ecs_world_t *world, ecs_ref_t *ref)
Update ref.
const void * ecs_record_get_id(const ecs_world_t *world, const ecs_record_t *record, ecs_id_t id)
Get component from entity record.
void * ecs_record_get_by_column(const ecs_record_t *record, int32_t column, size_t size)
Get component pointer from column/record.
void ecs_read_end(const ecs_record_t *record)
End read access to entity.
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_write_end(ecs_record_t *record)
End exclusive write access to entity.
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.
bool ecs_record_has_id(ecs_world_t *world, const ecs_record_t *record, ecs_id_t id)
Test if entity for record has a (component) id.
void * ecs_record_ensure_id(ecs_world_t *world, ecs_record_t *record, ecs_id_t id)
Same as ecs_record_get_id(), but returns a mutable pointer.
const void * ecs_get_id(const ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Get an immutable pointer to a component.
ecs_record_t * ecs_write_begin(ecs_world_t *world, ecs_entity_t entity)
Begin exclusive write access to entity.
void ecs_modified_id(ecs_world_t *world, ecs_entity_t entity, ecs_id_t id)
Signal that a component has been modified.
ecs_record_t * ecs_record_find(const ecs_world_t *world, ecs_entity_t entity)
Find record for entity.
const ecs_record_t * ecs_read_begin(ecs_world_t *world, ecs_entity_t entity)
Begin read access to entity.
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:296
#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:290
#define FLECS_TERM_COUNT_MAX
Maximum number of terms in queries.
Definition flecs.h:306
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:710
ecs_inout_kind_t
Specify read/write access for term.
Definition flecs.h:689
ecs_oper_kind_t
Specify operator for term.
Definition flecs.h:699
@ EcsQueryCacheAll
Require that all query terms can be cached.
Definition flecs.h:713
@ EcsQueryCacheDefault
Behavior determined by query creation context.
Definition flecs.h:711
@ EcsQueryCacheNone
No caching.
Definition flecs.h:714
@ EcsQueryCacheAuto
Cache query terms that are cacheable.
Definition flecs.h:712
@ EcsOut
Term is only written.
Definition flecs.h:695
@ EcsInOut
Term is both read and written.
Definition flecs.h:693
@ EcsInOutFilter
Same as InOutNone + prevents term from triggering observers.
Definition flecs.h:692
@ EcsInOutDefault
InOut for regular terms, In for shared terms.
Definition flecs.h:690
@ EcsInOutNone
Term is neither read nor written.
Definition flecs.h:691
@ EcsIn
Term is only read.
Definition flecs.h:694
@ EcsNot
The term must not match.
Definition flecs.h:702
@ EcsOptional
The term may match.
Definition flecs.h:703
@ EcsOr
One of the terms in an or chain must match.
Definition flecs.h:701
@ EcsOrFrom
Term must match at least one component from term id.
Definition flecs.h:705
@ EcsAnd
The term must match.
Definition flecs.h:700
@ EcsNotFrom
Term must match none of the components from term id.
Definition flecs.h:706
@ EcsAndFrom
Term must match all components from term id.
Definition flecs.h:704
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_get_binding_ctx(const ecs_world_t *world)
Get the world binding context.
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().
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:1515
ecs_size_t size
Component size.
Definition flecs.h:1516
ecs_size_t alignment
Component alignment.
Definition flecs.h:1517
When added to an entity this informs serialization formats which component to use when a value is ass...
Definition flecs.h:1530
ecs_id_t component
Default component id.
Definition flecs.h:1531
A (string) identifier.
Definition flecs.h:1506
ecs_size_t length
Length of identifier.
Definition flecs.h:1508
char * value
Identifier string.
Definition flecs.h:1507
ecs_hashmap_t * index
Current index.
Definition flecs.h:1511
uint64_t hash
Hash of current value.
Definition flecs.h:1509
uint64_t index_hash
Hash of existing record in current index.
Definition flecs.h:1510
Component for storing a poly object.
Definition flecs.h:1521
ecs_poly_t * poly
Pointer to poly object.
Definition flecs.h:1522
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:1418
int16_t version_major
Major flecs version.
Definition flecs.h:1422
const char ** addons
Addons included in build.
Definition flecs.h:1420
const char * version
Stringified version.
Definition flecs.h:1421
const char * compiler
Compiler used to compile flecs.
Definition flecs.h:1419
bool sanitize
Is this a sanitize build.
Definition flecs.h:1426
bool perf_trace
Is this a perf tracing build.
Definition flecs.h:1427
int16_t version_minor
Minor flecs version.
Definition flecs.h:1423
bool debug
Is this a debug build.
Definition flecs.h:1425
int16_t version_patch
Patch flecs version.
Definition flecs.h:1424
Used with ecs_bulk_init().
Definition flecs.h:1050
void ** data
Array with component data to insert.
Definition flecs.h:1062
ecs_id_t ids[(32)]
Ids to create the entities with.
Definition flecs.h:1060
int32_t count
Number of entities to create/populate.
Definition flecs.h:1058
int32_t _canary
Used for validity testing.
Definition flecs.h:1051
ecs_entity_t * entities
Entities to bulk insert.
Definition flecs.h:1053
ecs_table_t * table
Table to insert the entities into.
Definition flecs.h:1069
Used with ecs_component_init().
Definition flecs.h:1080
int32_t _canary
Used for validity testing.
Definition flecs.h:1081
ecs_type_info_t type
Parameters for type (size, hooks, ...)
Definition flecs.h:1087
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1084
Used with ecs_delete_empty_tables().
Definition flecs.h:2603
uint16_t delete_generation
Delete table when generation > delete_generation.
Definition flecs.h:2608
double time_budget_seconds
Amount of time operation is allowed to spend.
Definition flecs.h:2611
uint16_t clear_generation
Free table data when generation > clear_generation.
Definition flecs.h:2605
Type returned by ecs_get_entities().
Definition flecs.h:1988
int32_t alive_count
Number of alive entity ids.
Definition flecs.h:1991
int32_t count
Total number of entity ids.
Definition flecs.h:1990
const ecs_entity_t * ids
Array with all entity ids in the world.
Definition flecs.h:1989
Used with ecs_entity_init().
Definition flecs.h:1004
const char * sep
Optional custom separator for hierarchical names.
Definition flecs.h:1016
const char * root_sep
Optional, used for identifiers relative to root.
Definition flecs.h:1020
const char * name
Name of the entity.
Definition flecs.h:1011
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:1032
const char * symbol
Optional entity symbol.
Definition flecs.h:1022
int32_t _canary
Used for validity testing.
Definition flecs.h:1005
const ecs_id_t * add
0-terminated array of ids to add to the entity.
Definition flecs.h:1037
const char * add_expr
String expression with components to add.
Definition flecs.h:1043
const ecs_value_t * set
0-terminated array of values to set on the entity.
Definition flecs.h:1040
ecs_entity_t id
Set to modify existing entity (optional)
Definition flecs.h:1007
ecs_entity_t parent
Parent entity.
Definition flecs.h:1009
Used with ecs_emit().
Definition flecs.h:1364
ecs_entity_t entity
Single-entity alternative to setting table / offset / count.
Definition flecs.h:1389
const void * const_param
Same as param, but with the guarantee that the value won't be modified.
Definition flecs.h:1400
ecs_table_t * table
The table for which to notify.
Definition flecs.h:1374
int32_t count
Limit number of notified entities to count.
Definition flecs.h:1386
ecs_table_t * other_table
Optional 2nd table to notify.
Definition flecs.h:1378
int32_t offset
Limit notified entities to ones starting from offset (row) in table.
Definition flecs.h:1381
const ecs_type_t * ids
Component ids.
Definition flecs.h:1371
ecs_poly_t * observable
Observable (usually the world)
Definition flecs.h:1403
ecs_entity_t event
The event id.
Definition flecs.h:1366
ecs_flags32_t flags
Event flags.
Definition flecs.h:1406
void * param
Optional context.
Definition flecs.h:1395
Header for ecs_poly_t objects.
Definition flecs.h:514
int32_t magic
Magic number verifying it's a flecs object.
Definition flecs.h:515
int32_t type
Magic number indicating which type of flecs object.
Definition flecs.h:516
int32_t refcount
Refcount, to enable RAII handles.
Definition flecs.h:517
ecs_mixins_t * mixins
Table with offsets to (optional) mixins.
Definition flecs.h:518
Iterator.
Definition flecs.h:1128
ecs_world_t * real_world
Actual world.
Definition flecs.h:1131
void * param
Param passed to ecs_run.
Definition flecs.h:1165
ecs_entity_t event
The event (if applicable)
Definition flecs.h:1151
int32_t frame_offset
Offset relative to start of iteration.
Definition flecs.h:1176
char ** variable_names
Names of variables (if any)
Definition flecs.h:1162
ecs_flags32_t ref_fields
Bitset with fields that aren't component arrays.
Definition flecs.h:1145
int8_t variable_count
Number of variables for query.
Definition flecs.h:1160
ecs_entity_t interrupted_by
When set, system execution is interrupted.
Definition flecs.h:1182
ecs_flags32_t flags
Iterator flags.
Definition flecs.h:1181
ecs_iter_t * chain_it
Optional, allows for creating iterator chains.
Definition flecs.h:1189
void * ctx
System context.
Definition flecs.h:1166
void * run_ctx
Run language binding context.
Definition flecs.h:1169
ecs_table_t * table
Current table.
Definition flecs.h:1136
int32_t offset
Offset relative to current table.
Definition flecs.h:1177
ecs_id_t event_id
The (component) id for the event.
Definition flecs.h:1152
ecs_iter_fini_action_t fini
Function to cleanup iterator resources.
Definition flecs.h:1188
ecs_var_t * variables
Values of variables (if any)
Definition flecs.h:1139
ecs_iter_private_t priv_
Private data.
Definition flecs.h:1183
ecs_world_t * world
The world.
Definition flecs.h:1130
void * callback_ctx
Callback language binding context.
Definition flecs.h:1168
ecs_entity_t * sources
Entity on which the id was matched (0 if same as entities)
Definition flecs.h:1141
void * binding_ctx
System binding context.
Definition flecs.h:1167
ecs_flags32_t row_fields
Fields that must be obtained with field_at.
Definition flecs.h:1146
float delta_system_time
Time elapsed since last system invocation.
Definition flecs.h:1173
const ecs_query_t * query
Query being evaluated.
Definition flecs.h:1161
int8_t term_index
Index of term that emitted an event.
Definition flecs.h:1157
ecs_entity_t system
The system (if applicable)
Definition flecs.h:1150
ecs_flags32_t set_fields
Fields that are set.
Definition flecs.h:1144
const ecs_size_t * sizes
Component sizes.
Definition flecs.h:1135
float delta_time
Time elapsed since last frame.
Definition flecs.h:1172
ecs_flags32_t up_fields
Bitset with fields matched through up traversal.
Definition flecs.h:1147
ecs_iter_action_t callback
Callback of system or observer.
Definition flecs.h:1187
int8_t field_count
Number of fields in iterator.
Definition flecs.h:1156
ecs_table_t * other_table
Prev or next table when adding/removing.
Definition flecs.h:1137
int32_t event_cur
Unique event id.
Definition flecs.h:1153
const ecs_table_record_t ** trs
Info on where to find field in table.
Definition flecs.h:1140
int32_t count
Number of entities to iterate.
Definition flecs.h:1178
uint64_t group_id
Group id for table, if group_by is used.
Definition flecs.h:1143
ecs_iter_next_action_t next
Function to progress iterator.
Definition flecs.h:1186
const ecs_entity_t * entities
Entity identifiers.
Definition flecs.h:1134
ecs_id_t * ids
(Component) ids
Definition flecs.h:1138
ecs_flags64_t constrained_vars
Bitset that marks constrained variables.
Definition flecs.h:1142
Used with ecs_observer_init().
Definition flecs.h:1302
ecs_ctx_free_t run_ctx_free
Callback to free run ctx.
Definition flecs.h:1346
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1334
void * run_ctx
Context associated with run (for language bindings).
Definition flecs.h:1343
ecs_entity_t entity
Existing entity to associate with observer (optional)
Definition flecs.h:1307
ecs_entity_t events[(8)]
Events to observe (OnAdd, OnRemove, OnSet)
Definition flecs.h:1313
int32_t * last_event_id
Optional shared last event id for multiple observers.
Definition flecs.h:1353
void * callback_ctx
Context associated with callback (for language bindings).
Definition flecs.h:1337
void * ctx
User context to pass to callback.
Definition flecs.h:1331
ecs_query_desc_t query
Query for observer.
Definition flecs.h:1310
ecs_poly_t * observable
Observable with which to register the observer.
Definition flecs.h:1349
ecs_ctx_free_t callback_ctx_free
Callback to free callback ctx.
Definition flecs.h:1340
int8_t term_index_
Used for internal purposes.
Definition flecs.h:1356
ecs_iter_action_t callback
Callback to invoke on an event, invoked when the observer matches.
Definition flecs.h:1320
bool yield_existing
When observer is created, generate events from existing data.
Definition flecs.h:1317
ecs_run_action_t run
Callback invoked on an event.
Definition flecs.h:1328
int32_t _canary
Used for validity testing.
Definition flecs.h:1304
An observer reacts to events matching a query.
Definition flecs.h:859
int32_t event_count
Number of events.
Definition flecs.h:866
ecs_iter_action_t callback
See ecs_observer_desc_t::callback.
Definition flecs.h:868
ecs_entity_t entity
Entity associated with observer.
Definition flecs.h:882
ecs_observable_t * observable
Observable for observer.
Definition flecs.h:879
ecs_run_action_t run
See ecs_observer_desc_t::run.
Definition flecs.h:869
ecs_header_t hdr
Object header.
Definition flecs.h:860
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:875
void * run_ctx
Run language binding context.
Definition flecs.h:873
ecs_world_t * world
The world.
Definition flecs.h:881
ecs_ctx_free_t run_ctx_free
Callback to free run_ctx.
Definition flecs.h:877
void * callback_ctx
Callback language binding context.
Definition flecs.h:872
void * ctx
Observer context.
Definition flecs.h:871
ecs_entity_t events[(8)]
Observer events.
Definition flecs.h:865
ecs_ctx_free_t callback_ctx_free
Callback to free callback_ctx.
Definition flecs.h:876
ecs_query_t * query
Observer query.
Definition flecs.h:862
Struct returned by ecs_query_count().
Definition flecs.h:5014
int32_t empty_tables
Number of empty tables returned by query.
Definition flecs.h:5018
int32_t entities
Number of entities returned by query.
Definition flecs.h:5016
int32_t results
Number of results returned by query.
Definition flecs.h:5015
int32_t tables
Number of tables returned by query.
Definition flecs.h:5017
Used with ecs_query_init().
Definition flecs.h:1228
ecs_ctx_free_t ctx_free
Callback to free ctx.
Definition flecs.h:1289
ecs_id_t group_by
Component id to be used for grouping.
Definition flecs.h:1259
ecs_term_t terms[32]
Query terms.
Definition flecs.h:1233
int32_t _canary
Used for validity testing.
Definition flecs.h:1230
void * ctx
User context to pass to callback.
Definition flecs.h:1283
ecs_ctx_free_t group_by_ctx_free
Function to free group_by_ctx.
Definition flecs.h:1280
void * group_by_ctx
Context to pass to group_by.
Definition flecs.h:1277
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:1286
ecs_entity_t order_by
Component to sort on, used together with order_by_callback or order_by_table_callback.
Definition flecs.h:1255
ecs_order_by_action_t order_by_callback
Callback used for ordering query results.
Definition flecs.h:1247
ecs_group_create_action_t on_group_create
Callback that is invoked when a new group is created.
Definition flecs.h:1270
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:1295
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:1292
ecs_group_by_action_t group_by_callback
Callback used for grouping results.
Definition flecs.h:1266
ecs_group_delete_action_t on_group_delete
Callback that is invoked when an existing group is deleted.
Definition flecs.h:1274
ecs_sort_table_action_t order_by_table_callback
Callback used for ordering query results.
Definition flecs.h:1251
ecs_flags32_t flags
Flags for enabling query features.
Definition flecs.h:1242
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:1239
const char * expr
Query DSL expression (optional)
Definition flecs.h:1236
Type that contains information about a query group.
Definition flecs.h:1490
int32_t table_count
Number of tables in group.
Definition flecs.h:1492
void * ctx
Group context, returned by on_group_create.
Definition flecs.h:1493
int32_t match_count
How often tables have been matched/unmatched.
Definition flecs.h:1491
Queries are lists of constraints (terms) that match entities.
Definition flecs.h:819
ecs_flags32_t row_fields
Fields that must be acquired with field_at.
Definition flecs.h:838
ecs_flags32_t data_fields
Fields that have data.
Definition flecs.h:835
ecs_flags32_t read_fields
Fields that read data.
Definition flecs.h:837
ecs_header_t hdr
Object header.
Definition flecs.h:820
ecs_term_t terms[32]
Query terms.
Definition flecs.h:822
int8_t var_count
Number of query variables.
Definition flecs.h:827
ecs_flags32_t fixed_fields
Fields with a fixed source.
Definition flecs.h:832
ecs_flags32_t var_fields
Fields with non-$this variable source.
Definition flecs.h:833
ecs_flags32_t write_fields
Fields that write data.
Definition flecs.h:836
int32_t sizes[32]
Component sizes.
Definition flecs.h:823
int32_t eval_count
Number of times query is evaluated.
Definition flecs.h:853
ecs_world_t * world
World or stage query was created with.
Definition flecs.h:851
ecs_flags32_t static_id_fields
Fields with a static (component) id.
Definition flecs.h:834
ecs_world_t * real_world
Actual world.
Definition flecs.h:850
ecs_flags32_t set_fields
Fields that will be set.
Definition flecs.h:840
ecs_entity_t entity
Entity associated with query (optional)
Definition flecs.h:849
void * ctx
User context to pass to callback.
Definition flecs.h:846
ecs_flags32_t shared_readonly_fields
Fields that don't write shared data.
Definition flecs.h:839
ecs_id_t ids[32]
Component ids.
Definition flecs.h:824
ecs_query_cache_kind_t cache_kind
Caching policy of query.
Definition flecs.h:842
int8_t term_count
Number of query terms.
Definition flecs.h:828
char ** vars
Array with variable names for iterator.
Definition flecs.h:844
int8_t field_count
Number of fields returned by query.
Definition flecs.h:829
ecs_flags32_t flags
Query flags.
Definition flecs.h:826
void * binding_ctx
Context to be used for language bindings.
Definition flecs.h:847
Record for entity index.
Definition flecs.h:522
ecs_table_t * table
Identifies a type (and table) in world.
Definition flecs.h:524
uint32_t row
Table row of the entity.
Definition flecs.h:525
ecs_id_record_t * idr
Id record to (*, entity) for target entities.
Definition flecs.h:523
int32_t dense
Index in dense array of entity index.
Definition flecs.h:526
Header for table cache elements.
Definition flecs.h:530
struct ecs_table_cache_hdr_t * next
Next/previous elements for id in table cache.
Definition flecs.h:533
struct ecs_table_cache_t * cache
Table cache of element.
Definition flecs.h:531
ecs_table_t * table
Table associated with element.
Definition flecs.h:532
Metadata describing where a component id is stored in a table.
Definition flecs.h:540
ecs_table_cache_hdr_t hdr
Table cache header.
Definition flecs.h:541
int16_t index
First type index where id occurs in table.
Definition flecs.h:542
int16_t column
First column index where id occurs.
Definition flecs.h:544
int16_t count
Number of times id occurs in table.
Definition flecs.h:543
Type that describes a reference to an entity or variable in a term.
Definition flecs.h:780
const char * name
Name.
Definition flecs.h:787
ecs_entity_t id
Entity id.
Definition flecs.h:781
Type that describes a term (single element in a query).
Definition flecs.h:795
ecs_term_ref_t src
Source of term.
Definition flecs.h:801
int8_t field_index
Index of field for term in iterator.
Definition flecs.h:812
ecs_id_t id
Component id to be matched by term.
Definition flecs.h:796
int16_t oper
Operator of term.
Definition flecs.h:810
ecs_term_ref_t second
Second element of pair.
Definition flecs.h:803
ecs_flags16_t flags_
Flags that help eval, set by ecs_query_init()
Definition flecs.h:813
ecs_entity_t trav
Relationship to traverse when looking for the component.
Definition flecs.h:805
int16_t inout
Access to contents matched by term.
Definition flecs.h:809
ecs_term_ref_t first
Component or first element of pair.
Definition flecs.h:802
ecs_copy_t copy_ctor
Ctor + copy.
Definition flecs.h:932
void * lifecycle_ctx
Component lifecycle context (see meta add-on)
Definition flecs.h:971
void * ctx
User defined context.
Definition flecs.h:969
ecs_iter_action_t on_remove
Callback that is invoked when an instance of the component is removed.
Definition flecs.h:967
void * binding_ctx
Language binding context.
Definition flecs.h:970
ecs_move_t move_dtor
Move + dtor.
Definition flecs.h:947
ecs_flags32_t flags
Hook flags.
Definition flecs.h:953
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:975
ecs_iter_action_t on_set
Callback that is invoked when an instance of the component is set.
Definition flecs.h:962
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:973
ecs_iter_action_t on_add
Callback that is invoked when an instance of a component is added.
Definition flecs.h:957
ecs_ctx_free_t binding_ctx_free
Callback to free binding_ctx.
Definition flecs.h:974
ecs_move_t move_ctor
Ctor + move.
Definition flecs.h:935
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:982
ecs_size_t alignment
Alignment of type.
Definition flecs.h:984
ecs_size_t size
Size of type.
Definition flecs.h:983
const char * name
Type name.
Definition flecs.h:987
ecs_entity_t component
Handle to component (do not set)
Definition flecs.h:986
ecs_type_hooks_t hooks
Type hooks.
Definition flecs.h:985
A type is a list of (component) ids.
Definition flecs.h:392
ecs_id_t * array
Array with ids.
Definition flecs.h:393
int32_t count
Number of elements in array.
Definition flecs.h:394
Utility to hold a value of a dynamic type.
Definition flecs.h:995
void * ptr
Pointer to value.
Definition flecs.h:997
ecs_entity_t type
Type of value.
Definition flecs.h:996
Type that contains information about the world.
Definition flecs.h:1431
float delta_time
Time passed to or computed by ecs_progress()
Definition flecs.h:1437
ecs_entity_t min_id
First allowed entity id.
Definition flecs.h:1433
int64_t set_count
Set commands processed.
Definition flecs.h:1473
double world_time_total
Time elapsed in simulation.
Definition flecs.h:1445
int32_t tag_id_count
Number of tag (no data) ids in the world.
Definition flecs.h:1461
int32_t component_id_count
Number of component (data) ids in the world.
Definition flecs.h:1462
int64_t pipeline_build_count_total
Total number of pipeline builds.
Definition flecs.h:1457
int64_t eval_comp_monitors_total
Total number of monitor evaluations.
Definition flecs.h:1450
int32_t table_count
Number of tables.
Definition flecs.h:1465
float delta_time_raw
Raw delta time (no time scaling)
Definition flecs.h:1436
float frame_time_total
Total time spent processing a frame.
Definition flecs.h:1440
int64_t table_create_total
Total number of times a table was created.
Definition flecs.h:1455
int64_t observers_ran_frame
Total number of times observer was invoked.
Definition flecs.h:1459
float system_time_total
Total time spent in systems.
Definition flecs.h:1441
int64_t id_delete_total
Total number of times an id was deleted.
Definition flecs.h:1454
int64_t systems_ran_frame
Total number of systems ran in last frame.
Definition flecs.h:1458
float merge_time_total
Total time spent in merges.
Definition flecs.h:1443
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:1476
int64_t clear_count
Clear commands processed.
Definition flecs.h:1472
ecs_entity_t last_component_id
Last issued component entity id.
Definition flecs.h:1432
int64_t frame_count_total
Total number of frames.
Definition flecs.h:1448
ecs_entity_t max_id
Last allowed entity id.
Definition flecs.h:1434
int64_t merge_count_total
Total number of merges.
Definition flecs.h:1449
int64_t other_count
Other commands processed.
Definition flecs.h:1478
int64_t batched_command_count
Commands batched.
Definition flecs.h:1480
int64_t table_delete_total
Total number of times a table was deleted.
Definition flecs.h:1456
int64_t delete_count
Selete commands processed.
Definition flecs.h:1471
int64_t rematch_count_total
Total number of rematches.
Definition flecs.h:1451
int64_t id_create_total
Total number of times a new id was created.
Definition flecs.h:1453
int64_t batched_entity_count
Entities for which commands were batched.
Definition flecs.h:1479
float time_scale
Time scale applied to delta_time.
Definition flecs.h:1438
int32_t pair_id_count
Number of pair ids in the world.
Definition flecs.h:1463
float rematch_time_total
Time spent on query rematching.
Definition flecs.h:1444
int64_t ensure_count
Ensure/emplace commands processed.
Definition flecs.h:1474
float target_fps
Target fps.
Definition flecs.h:1439
double world_time_total_raw
Time elapsed in simulation (no scaling)
Definition flecs.h:1446
float emit_time_total
Total time spent notifying observers.
Definition flecs.h:1442
int64_t modified_count
Modified commands processed.
Definition flecs.h:1475
const char * name_prefix
Value set by ecs_set_name_prefix().
Definition flecs.h:1483
int64_t event_count
Enqueued custom events.
Definition flecs.h:1477
int64_t add_count
Add commands processed.
Definition flecs.h:1469
int64_t remove_count
Remove commands processed.
Definition flecs.h:1470