Flecs v3.1
A fast entity component system (ECS) for C & C++
Loading...
Searching...
No Matches
mixin.inl File Reference

Pipeline world mixin. More...

Go to the source code of this file.

Functions

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
flecs::pipeline_builder pipeline () const
 Create a new pipeline. More...
 
void set_pipeline (const flecs::entity pip) const
 Set pipeline. More...
 
template<typename Pipeline >
void set_pipeline () const
 Set pipeline. More...
 
flecs::entity get_pipeline () const
 Get pipeline. More...
 
bool progress (ecs_ftime_t delta_time=0.0) const
 Progress world one tick. More...
 
void run_pipeline (const flecs::entity_t pip, ecs_ftime_t delta_time=0.0) const
 Run pipeline. More...
 
void set_time_scale (ecs_ftime_t mul) const
 Set timescale. More...
 
ecs_ftime_t get_time_scale () const
 Get timescale. More...
 
int64_t get_tick () const
 Get tick. More...
 
void set_target_fps (ecs_ftime_t target_fps) const
 Set target FPS. More...
 
ecs_ftime_t get_target_fps () const
 Get target FPS. More...
 
void reset_clock () const
 Reset simulation clock. More...
 
void set_threads (int32_t threads) const
 Set number of threads. More...
 
int32_t get_threads () const
 Set number of threads. More...
 

Detailed Description

Pipeline world mixin.

Definition in file mixin.inl.

Function Documentation

◆ get_pipeline()

flecs::entity get_pipeline ( ) const

Get pipeline.

See also
ecs_get_pipeline

◆ get_target_fps()

ecs_ftime_t get_target_fps ( ) const

Get target FPS.

Returns
Configured frames per second.

◆ get_threads()

int32_t get_threads ( ) const

Set number of threads.

See also
ecs_get_stage_count

◆ get_tick()

int64_t get_tick ( ) const

Get tick.

Returns
Monotonically increasing frame count.

◆ get_time_scale()

ecs_ftime_t get_time_scale ( ) const

Get timescale.

See also
ecs_get_time_scale

◆ pipeline()

template<typename Pipeline , if_not_t< is_enum< Pipeline >::value > = 0>
flecs::pipeline_builder pipeline ( ) const

Create a new pipeline.

Template Parameters
PipelineType associated with pipeline.
Returns
A pipeline builder.

◆ progress()

bool progress ( ecs_ftime_t  delta_time = 0.0) const

Progress world one tick.

See also
ecs_progress

◆ reset_clock()

void reset_clock ( ) const

Reset simulation clock.

See also
ecs_reset_clock

◆ run_pipeline()

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

Run pipeline.

See also
ecs_run_pipeline

◆ set_pipeline() [1/2]

template<typename Pipeline >
void set_pipeline ( ) const

Set pipeline.

See also
ecs_set_pipeline

◆ set_pipeline() [2/2]

void set_pipeline ( const flecs::entity  pip) const

Set pipeline.

See also
ecs_set_pipeline

◆ set_target_fps()

void set_target_fps ( ecs_ftime_t  target_fps) const

Set target FPS.

See also
ecs_set_target_fps

◆ set_threads()

void set_threads ( int32_t  threads) const

Set number of threads.

See also
ecs_set_threads

◆ set_time_scale()

void set_time_scale ( ecs_ftime_t  mul) const

Set timescale.

See also
ecs_set_time_scale