Pipelines

Pipelines order and schedule systems for execution. More...

Collaboration diagram for Pipelines:

Classes
struct	flecs::pipeline_builder< Components >
	Pipeline builder. More...
struct	flecs::pipeline_builder_i< Base >
	Pipeline builder interface. More...
struct	flecs::pipeline< Components >
	Forward declaration for pipeline. More...
flecs::pipeline_builder	flecs::world::pipeline (const char *name=nullptr) const
	Create a new pipeline.
template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
flecs::pipeline_builder	pipeline () const
	Create a new pipeline.
void	set_pipeline (const flecs::entity pip) const
	Set the pipeline.
template<typename Pipeline >
void	set_pipeline () const
	Set the pipeline.
flecs::entity	get_pipeline () const
	Get the pipeline.
bool	progress (ecs_ftime_t delta_time=0.0) const
	Progress the world one tick.
void	run_pipeline (const flecs::entity_t pip, ecs_ftime_t delta_time=0.0) const
	Run a pipeline.
template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
void	run_pipeline (ecs_ftime_t delta_time=0.0) const
	Run a pipeline.
void	set_threads (int32_t threads) const
	Set the number of threads.
int32_t	get_threads () const
	Get the number of threads.
void	set_task_threads (int32_t task_threads) const
	Set the number of task threads.
bool	using_task_threads () const
	Return true if task thread use has been requested.

Detailed Description

Pipelines order and schedule systems for execution.

Function Documentation

get_pipeline()

flecs::entity get_pipeline ( ) const

related

Get the pipeline.

See also

ecs_get_pipeline()

get_threads()

int32_t get_threads ( ) const

related

Get the number of threads.

See also

ecs_get_stage_count()

pipeline() [1/2]

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>

flecs::pipeline_builder pipeline ( ) const

related

Create a new pipeline.

Template Parameters

Pipeline

Type associated with the pipeline.

Returns

A pipeline builder.

pipeline() [2/2]

flecs::pipeline_builder pipeline

(

const char *

name = nullptr

)

const

Create a new pipeline.

Parameters

name	The pipeline name (optional).

Returns

A pipeline builder.

progress()

bool progress ( ecs_ftime_t delta_time = 0.0 ) const

related

Progress the world one tick.

See also

ecs_progress()

run_pipeline() [1/2]

void run_pipeline ( const flecs::entity_t pip, ecs_ftime_t delta_time = 0.0 ) const

related

Run a pipeline.

See also

ecs_run_pipeline()

run_pipeline() [2/2]

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>

void run_pipeline ( ecs_ftime_t delta_time = 0.0 ) const

related

Run a pipeline.

Template Parameters

Pipeline

Type associated with the pipeline.

See also

ecs_run_pipeline()

set_pipeline() [1/2]

template<typename Pipeline >

void set_pipeline ( ) const

related

Set the pipeline.

See also

ecs_set_pipeline()

set_pipeline() [2/2]

void set_pipeline ( const flecs::entity pip ) const

related

Set the pipeline.

See also

ecs_set_pipeline()

set_task_threads()

void set_task_threads ( int32_t task_threads ) const

related

Set the number of task threads.

See also

ecs_set_task_threads()

set_threads()

void set_threads ( int32_t threads ) const

related

Set the number of threads.

See also

ecs_set_threads()

using_task_threads()

bool using_task_threads ( ) const

related

Return true if task thread use has been requested.

See also

ecs_using_task_threads()