Appearance

@fibbojs / core / StandardPipeline

Class: abstract StandardPipeline ​

A standard pipeline is a pipeline that runs at max FPS, using requestAnimationFrame. This means that the frame method will be called as fast as possible. Do not compute heavy tasks using this pipeline, as it will run at max FPS depending on the user's screen refresh rate.

Extends ​

Constructors ​

new StandardPipeline() ​

new StandardPipeline(): StandardPipeline

Returns ​

StandardPipeline

Overrides ​

Pipeline.constructor

Defined in ​

core/src/pipeline/StandardPipeline.ts:10

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/StandardPipeline.ts:14

stop() ​

stop(): void

Stop the pipeline

Returns ​

void

Overrides ​

Pipeline.stop

Defined in ​

core/src/pipeline/StandardPipeline.ts:19

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

state ​

state: PipelineState

The current state of the pipeline.

Inherited from ​

Pipeline.state

Defined in ​

core/src/pipeline/Pipeline.ts:21