Appearance

@fibbojs / core / IntervalPipeline

Class: abstract IntervalPipeline ​

Unlike the Standard and Throttled pipelines, the Interval pipeline runs at a fixed frame rate. It relies on setInterval to call the frame method at a fixed interval.

Extends ​

Constructors ​

new IntervalPipeline() ​

new IntervalPipeline(): IntervalPipeline

Returns ​

IntervalPipeline

Overrides ​

Pipeline.constructor

Defined in ​

core/src/pipeline/IntervalPipeline.ts:14

Methods ​

frame() ​

abstract frame(delta): void

The frame method is the main method that is called by the pipeline. It should implement the desired behavior of the pipeline.

Parameters ​

• delta: number

Returns ​

void

Inherited from ​

Pipeline.frame

Defined in ​

core/src/pipeline/Pipeline.ts:40

start() ​

start(): void

Start the pipeline

Returns ​

void

Overrides ​

Pipeline.start

Defined in ​

core/src/pipeline/IntervalPipeline.ts:18

stop() ​

stop(): void

Stop the pipeline

Returns ​

void

Overrides ​

Pipeline.stop

Defined in ​

core/src/pipeline/IntervalPipeline.ts:27

Properties ​

frameRate ​

frameRate: number

The frame rate of the pipeline. This is the number of frames per second that the pipeline will run at. e.g. 30 will run the pipeline at 30 frames per second. The default value is 30.

Inherited from ​

Pipeline.frameRate

Defined in ​

core/src/pipeline/Pipeline.ts:28

intervalId ​

intervalId: undefined | Timeout

The interval ID returned by setInterval.

Defined in ​

core/src/pipeline/IntervalPipeline.ts:12

state ​

state: PipelineState

The current state of the pipeline.

Inherited from ​

Pipeline.state

Defined in ​

core/src/pipeline/Pipeline.ts:21