Flecs v4.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
pipeline.h
Go to the documentation of this file.
1
16#ifdef FLECS_PIPELINE
17
26#ifndef FLECS_MODULE
27#define FLECS_MODULE
28#endif
29
30#ifndef FLECS_SYSTEM
31#define FLECS_SYSTEM
32#endif
33
34#if !defined(FLECS_OS_API_IMPL) && !defined(FLECS_NO_OS_API_IMPL)
35#define FLECS_OS_API_IMPL
36#endif
37
38#ifndef FLECS_PIPELINE_H
39#define FLECS_PIPELINE_H
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45#ifndef FLECS_LEGACY
46
54#define ECS_PIPELINE_DEFINE(world, id_, ...) \
55 { \
56 ecs_pipeline_desc_t desc = {0}; \
57 ecs_entity_desc_t edesc = {0}; \
58 edesc.id = id_;\
59 edesc.name = #id_;\
60 desc.entity = ecs_entity_init(world, &edesc);\
61 desc.query.expr = #__VA_ARGS__; \
62 id_ = ecs_pipeline_init(world, &desc); \
63 ecs_id(id_) = id_;\
64 } \
65 ecs_assert(id_ != 0, ECS_INVALID_PARAMETER, "failed to create pipeline");
66
74#define ECS_PIPELINE(world, id, ...) \
75 ecs_entity_t id = 0, ecs_id(id) = 0; ECS_PIPELINE_DEFINE(world, id, __VA_ARGS__);\
76 (void)id;\
77 (void)ecs_id(id);
78
82#define ecs_pipeline(world, ...)\
83 ecs_pipeline_init(world, &(ecs_pipeline_desc_t) __VA_ARGS__ )
84
85#endif
86
117
127FLECS_API
129 ecs_world_t *world,
130 const ecs_pipeline_desc_t *desc);
131
141FLECS_API
143 ecs_world_t *world,
144 ecs_entity_t pipeline,
145 const ecs_pipeline_desc_t *desc);
146
153FLECS_API
155 ecs_world_t *world,
156 ecs_entity_t pipeline);
157
164FLECS_API
166 const ecs_world_t *world);
167
186FLECS_API
188 ecs_world_t *world,
189 ecs_ftime_t delta_time);
190
197FLECS_API
199 ecs_world_t *world,
200 ecs_ftime_t scale);
201
207FLECS_API
209 ecs_world_t *world);
210
227FLECS_API
229 ecs_world_t *world,
230 ecs_entity_t pipeline,
231 ecs_ftime_t delta_time);
232
233
237
249FLECS_API
251 ecs_world_t *world,
252 int32_t threads);
253
270FLECS_API
272 ecs_world_t *world,
273 int32_t task_threads);
274
280FLECS_API
282 ecs_world_t *world);
283
287
296FLECS_API
298 ecs_world_t *world);
299
300#ifdef __cplusplus
301}
302#endif
303
304#endif
305
308#endif
FLECS_API void ecs_set_threads(ecs_world_t *world, int32_t threads)
Set number of worker threads.
FLECS_API void ecs_set_time_scale(ecs_world_t *world, ecs_ftime_t scale)
Set time scale.
FLECS_API void ecs_set_pipeline(ecs_world_t *world, ecs_entity_t pipeline)
Set a custom pipeline.
FLECS_API ecs_entity_t ecs_get_pipeline(const ecs_world_t *world)
Get the current pipeline.
FLECS_API bool ecs_progress(ecs_world_t *world, ecs_ftime_t delta_time)
Progress a world.
FLECS_API void ecs_reset_clock(ecs_world_t *world)
Reset world clock.
FLECS_API void ecs_run_pipeline(ecs_world_t *world, ecs_entity_t pipeline, ecs_ftime_t delta_time)
Run pipeline.
struct ecs_pipeline_desc_t ecs_pipeline_desc_t
Pipeline descriptor, used with ecs_pipeline_init().
FLECS_API ecs_entity_t ecs_pipeline_update(ecs_world_t *world, ecs_entity_t pipeline, const ecs_pipeline_desc_t *desc)
Replace the pipeline query on an existing entity.
FLECS_API bool ecs_using_task_threads(ecs_world_t *world)
Return true if task thread use has been requested.
FLECS_API void ecs_set_task_threads(ecs_world_t *world, int32_t task_threads)
Set number of worker task threads.
FLECS_API void FlecsPipelineImport(ecs_world_t *world)
Pipeline module import function.
FLECS_API ecs_entity_t ecs_pipeline_init(ecs_world_t *world, const ecs_pipeline_desc_t *desc)
Create a custom pipeline.
ecs_id_t ecs_entity_t
An entity identifier.
Definition flecs.h:385
struct ecs_world_t ecs_world_t
A world is the container for all ECS data and supporting features.
Definition flecs.h:429
#define ecs_ftime_t
Customizable precision for scalar time values.
Definition flecs.h:59
Pipeline descriptor, used with ecs_pipeline_init().
Definition pipeline.h:88
ecs_entity_t entity
Existing entity to associate with the pipeline (optional).
Definition pipeline.h:90
ecs_query_desc_t query
The pipeline query.
Definition pipeline.h:115
Used with ecs_query_init().
Definition flecs.h:1301