Skip to content
Flecs v4.1
decl.hpp
Go to the documentation of this file.
1/**
2 * @file addons/cpp/mixins/pipeline/decl.hpp
3 * @brief Pipeline module declarations.
4 */
5
6#pragma once
7
8namespace flecs {
9
10/**
11 * @defgroup cpp_pipelines Pipelines
12 * @ingroup cpp_addons
13 * Pipelines order and schedule systems for execution.
14 *
15 * @{
16 */
17
18/** Forward declaration for pipeline. */
19template <typename ... Components>
20struct pipeline;
21
22/** Forward declaration for pipeline builder. */
23template <typename ... Components>
24struct pipeline_builder;
25
26/** Built-in pipeline phase run at startup. */
27static const flecs::entity_t OnStart = EcsOnStart;
28/** Built-in pipeline phase run before each frame. */
29static const flecs::entity_t PreFrame = EcsPreFrame;
30/** Built-in pipeline phase for loading data. */
31static const flecs::entity_t OnLoad = EcsOnLoad;
32/** Built-in pipeline phase run after loading data. */
33static const flecs::entity_t PostLoad = EcsPostLoad;
34/** Built-in pipeline phase run before the update. */
35static const flecs::entity_t PreUpdate = EcsPreUpdate;
36/** Built-in pipeline phase for the main update. */
37static const flecs::entity_t OnUpdate = EcsOnUpdate;
38/** Built-in pipeline phase for validation after the update. */
39static const flecs::entity_t OnValidate = EcsOnValidate;
40/** Built-in pipeline phase run after the update. */
41static const flecs::entity_t PostUpdate = EcsPostUpdate;
42/** Built-in pipeline phase run before storing data. */
43static const flecs::entity_t PreStore = EcsPreStore;
44/** Built-in pipeline phase for storing data. */
45static const flecs::entity_t OnStore = EcsOnStore;
46/** Built-in pipeline phase run after each frame. */
47static const flecs::entity_t PostFrame = EcsPostFrame;
48
49/** @} */
50
51}
EcsOnStart
const ecs_entity_t EcsOnStart
OnStart pipeline phase.
EcsOnStore
const ecs_entity_t EcsOnStore
OnStore pipeline phase.
EcsPreStore
const ecs_entity_t EcsPreStore
PreStore pipeline phase.
EcsOnLoad
const ecs_entity_t EcsOnLoad
OnLoad pipeline phase.
EcsPostUpdate
const ecs_entity_t EcsPostUpdate
PostUpdate pipeline phase.
EcsOnValidate
const ecs_entity_t EcsOnValidate
OnValidate pipeline phase.
EcsPreUpdate
const ecs_entity_t EcsPreUpdate
PreUpdate pipeline phase.
EcsPostFrame
const ecs_entity_t EcsPostFrame
PostFrame pipeline phase.
EcsPostLoad
const ecs_entity_t EcsPostLoad
PostLoad pipeline phase.
EcsPreFrame
const ecs_entity_t EcsPreFrame
PreFrame pipeline phase.
EcsOnUpdate
const ecs_entity_t EcsOnUpdate
OnUpdate pipeline phase.
flecs::entity_t
ecs_entity_t entity_t
Entity type.
Definition c_types.hpp:21
flecs::pipeline_builder
Pipeline builder.
Definition builder.hpp:24
flecs::pipeline
Forward declaration for pipeline.
Definition impl.hpp:13