Class RenderLoop

Conveniently provides a way to have a render loop called at a constant frame rate.

Index

Constructors

Properties

canvas options renderLoop

Accessors

Methods

Constructors

constructor

new RenderLoop(
    renderLoop: RenderLoopCallback,
    canvas: Canvas,
    options?: Partial<RenderLoopOptions>,
): RenderLoop
Constructs a new RenderLoop.
Parameters
- renderLoop: RenderLoopCallback
  The function to call when a new frame should be drawn.
- canvas: Canvas
  The canvas we're rendering to.
- options: Partial<RenderLoopOptions> = {}
  The configuration for thie RenderLoop.
Returns RenderLoop
- Defined in source/graphics/render-loop.ts:90

Properties

`Readonly`canvas

canvas: Canvas

The Canvas we're rendering to.

`Readonly`options

options: Readonly<Partial<RenderLoopOptions>>

The configuration that was used for this render loop.

`Readonly`renderLoop

renderLoop: RenderLoopCallback

A function that we call when a new frame should be drawn.

Accessors

frameCounter

get frameCounter(): number
Retrieves the amount of frames drawn to the DOM throughout the loops lifetime.

Returns number
The frame count.
- Defined in source/graphics/render-loop.ts:80

Methods

block

block(): void
Stop the render loop.

Returns void
- Defined in source/graphics/render-loop.ts:105

unblock

unblock(): void
Start the render loop.

Returns void
- Defined in source/graphics/render-loop.ts:120