Skip to content
Flecs v4.1
flecs.hpp
Go to the documentation of this file.
1/**
2 * @file addons/cpp/flecs.hpp
3 * @brief Flecs C++17 API.
4 */
5
6#pragma once
7
8// STL includes
9#include <type_traits>
10
11/**
12 * @defgroup cpp C++ API
13 * @{
14 */
15
16namespace flecs
17{
18
19struct world;
20struct world_async_stage;
21struct iter;
22struct entity_view;
23struct entity;
24struct type;
25struct table;
26struct table_range;
27struct untyped_component;
28
29template <typename T>
30struct component;
31
32struct untyped_ref;
33template <typename T>
34struct ref;
35
36namespace _
37{
38template <typename T, typename U = int>
39struct type;
40
41template <typename Func, typename ... Components>
42struct each_delegate;
43
44} // namespace _
45} // namespace flecs
46
47// Types imported from C API
48#include "c_types.hpp"
49
50// C++ utilities
51#include "utils/utils.hpp"
52#include "utils/map.hpp"
53
54// Mixin forward declarations
55#include "mixins/id/decl.hpp"
56#include "mixins/term/decl.hpp"
57#include "mixins/query/decl.hpp"
58#include "mixins/event/decl.hpp"
59#include "mixins/observer/decl.hpp"
60#ifdef FLECS_SYSTEM
61#include "mixins/system/decl.hpp"
62#endif
63#ifdef FLECS_PIPELINE
64#include "mixins/pipeline/decl.hpp"
65#endif
66#ifdef FLECS_TIMER
67#include "mixins/timer/decl.hpp"
68#endif
69#ifdef FLECS_DOC
70#include "mixins/doc/decl.hpp"
71#endif
72#ifdef FLECS_REST
73#include "mixins/rest/decl.hpp"
74#endif
75#ifdef FLECS_META
76#include "mixins/meta/decl.hpp"
77#endif
78#ifdef FLECS_UNITS
79#include "mixins/units/decl.hpp"
80#endif
81#ifdef FLECS_STATS
82#include "mixins/stats/decl.hpp"
83#endif
84#ifdef FLECS_METRICS
85#include "mixins/metrics/decl.hpp"
86#endif
87#ifdef FLECS_ALERTS
88#include "mixins/alerts/decl.hpp"
89#endif
90#ifdef FLECS_JSON
91#include "mixins/json/decl.hpp"
92#endif
93#ifdef FLECS_APP
94#include "mixins/app/decl.hpp"
95#endif
96#ifdef FLECS_SCRIPT
97#include "mixins/script/decl.hpp"
98#endif
99
100#include "log.hpp"
101#include "pair.hpp"
102#include "lifecycle_traits.hpp"
103#include "utils/component_id.hpp"
104#include "mixins/event/builder.hpp"
105#include "world.hpp"
106#include "field.hpp"
107#include "iter.hpp"
108#include "ref.hpp"
109#include "entity.hpp"
110#include "delegate.hpp"
111#include "component.hpp"
112#include "mixins/query/sparse_query.hpp"
113#include "type.hpp"
114#include "table.hpp"
115#include "utils/iterable.hpp"
116
117// Mixin implementations
118#include "mixins/id/impl.hpp"
119#ifdef FLECS_ENTITY_RANGES
120#include "mixins/entity_ranges/impl.hpp"
121#endif
122#ifdef FLECS_FRAME
123#include "mixins/frame/impl.hpp"
124#endif
125#include "mixins/entity/impl.hpp"
126#ifdef FLECS_PREFAB
127#include "mixins/prefab/impl.hpp"
128#endif
129#include "mixins/component/impl.hpp"
130#include "mixins/term/impl.hpp"
131#include "mixins/query/impl.hpp"
132#include "mixins/observer/impl.hpp"
133#include "mixins/event/impl.hpp"
134#include "mixins/enum/impl.hpp"
135#ifdef FLECS_MODULE
136#include "mixins/module/impl.hpp"
137#endif
138#ifdef FLECS_SYSTEM
139#include "mixins/system/impl.hpp"
140#endif
141#ifdef FLECS_PIPELINE
142#include "mixins/pipeline/impl.hpp"
143#endif
144#ifdef FLECS_TIMER
145#include "mixins/timer/impl.hpp"
146#endif
147#ifdef FLECS_DOC
148#include "mixins/doc/impl.hpp"
149#endif
150#ifdef FLECS_REST
151#include "mixins/rest/impl.hpp"
152#endif
153#ifdef FLECS_META
154#include "mixins/meta/impl.hpp"
155#endif
156#ifdef FLECS_UNITS
157#include "mixins/units/impl.hpp"
158#endif
159#ifdef FLECS_STATS
160#include "mixins/stats/impl.hpp"
161#endif
162#ifdef FLECS_METRICS
163#include "mixins/metrics/impl.hpp"
164#endif
165#ifdef FLECS_ALERTS
166#include "mixins/alerts/impl.hpp"
167#endif
168#ifdef FLECS_SCRIPT
169#include "mixins/script/impl.hpp"
170#endif
171
172#include "impl/field.hpp"
173#include "impl/iter.hpp"
174#include "impl/world.hpp"
175
176/**
177 * @defgroup cpp_core Core
178 * Core ECS functionality (entities, storage, queries).
179 *
180 * @{
181 * @}
182 */
183
184/**
185 * @defgroup cpp_addons Addons
186 * C++ APIs for addons.
187 *
188 * @{
189 * @}
190 */
191
192/** @} */
decl.hpp
Alert declarations.
impl.hpp
Alerts module implementation.
decl.hpp
App addon declarations.
c_types.hpp
Aliases for types/constants from C API.
impl.hpp
Component mixin implementation.
component.hpp
Registering/obtaining info from components.
delegate.hpp
Wrappers around C++ functions that provide callbacks for C APIs.
decl.hpp
Doc mixin declarations.
impl.hpp
Doc mixin implementation.
impl.hpp
Entity implementation.
entity.hpp
Entity class.
impl.hpp
Entity ranges implementation.
impl.hpp
Enum implementation.
decl.hpp
Event declarations.
impl.hpp
Event implementation.
field.hpp
Wrapper classes for fields returned by flecs::iter.
impl.hpp
Frame implementation.
decl.hpp
ID class.
impl.hpp
ID class implementation.
field.hpp
Field implementation.
iter.hpp
Iterator implementation.
world.hpp
World implementation.
iter.hpp
Wrapper classes for ecs_iter_t and component arrays.
iterable.hpp
Base class for iterable objects, like queries.
decl.hpp
JSON addon declarations.
lifecycle_traits.hpp
Utilities for discovering and registering component lifecycle hooks.
log.hpp
Logging functions.
map.hpp
Minimal C++ wrapper for ecs_map_t iteration.
decl.hpp
Meta declarations.
impl.hpp
Meta implementation.
decl.hpp
Metrics declarations.
impl.hpp
Metrics module implementation.
builder.hpp
Event builder.
impl.hpp
Module implementation.
flecs::_
Int to enum.
Definition component.hpp:18
decl.hpp
Observer declarations.
impl.hpp
Observer implementation.
pair.hpp
Utilities for working with compile-time pairs.
decl.hpp
Pipeline module declarations.
impl.hpp
Pipeline module implementation.
impl.hpp
Prefab implementation.
decl.hpp
Query declarations.
impl.hpp
Query implementation.
ref.hpp
Class that caches data to speed up get operations.
decl.hpp
Rest module declarations.
impl.hpp
Rest module implementation.
decl.hpp
Script declarations.
impl.hpp
Script implementation.
sparse_query.hpp
Direct iteration of sparse component storages.
decl.hpp
Stats module declarations.
impl.hpp
Stats module implementation.
flecs::_::each_delegate
Definition delegate.hpp:135
flecs::_::type
Definition flecs.hpp:39
flecs::component
Component class.
Definition component.hpp:499
flecs::entity_view
Entity view.
Definition entity_view.hpp:30
flecs::entity
Entity.
Definition entity.hpp:30
flecs::iter
Class for iterating over query results.
Definition iter.hpp:68
flecs::ref
Component reference.
Definition ref.hpp:109
flecs::table_range
Table range.
Definition table.hpp:205
flecs::table
Table.
Definition table.hpp:23
flecs::type
Type class.
Definition type.hpp:21
flecs::untyped_component
Untyped component class.
Definition component.hpp:368
flecs::untyped_ref
Untyped component reference.
Definition ref.hpp:22
flecs::world
The world.
Definition world.hpp:129
decl.hpp
System module declarations.
impl.hpp
System module implementation.
table.hpp
Direct access to table data.
decl.hpp
Term declarations.
impl.hpp
Term implementation.
decl.hpp
Timer module declarations.
impl.hpp
Timer module implementation.
type.hpp
Utility functions for ID vector.
decl.hpp
Units module declarations.
impl.hpp
Units module implementation.
utils.hpp
Flecs STL (FTL?).
world.hpp
World class.