Class default

The Matter.Render module is a simple canvas based renderer for visualising instances of Matter.Engine. It is intended for development and debugging purposes, but may also be suitable for simple games. It includes a number of drawing options including wireframe, vector with support for sprites and viewports.

Hierarchy

default

Constructors

constructor

new default(): default
Returns default

Properties

`Static` `Protected` _cancelAnimationFrame

_cancelAnimationFrame: ((handle) => void) & ((handle) => void) = ...

Type declaration

- (handle): void
- Parameters
  - handle: number
  Returns void

Type declaration

- (handle): void
- Parameters
  - handle: number
  Returns void

`Static` `Protected` _goodDelta

_goodDelta: number = ...

`Static` `Protected` _goodFps

_goodFps: number = 30

`Static` `Protected` _requestAnimationFrame

_requestAnimationFrame: ((callback) => number) & ((callback) => number) = ...

Type declaration

- (callback): number
- Parameters
  - callback: FrameRequestCallback
  Returns number

Type declaration

- (callback): number
- Parameters
  - callback: FrameRequestCallback
  Returns number

Methods

`Static` `Protected` _applyBackground

_applyBackground(render, background): void
Applies the background to the canvas using CSS.
Parameters
- render: IRender
- background: string
Returns void

Method
applyBackground
- Defined in src/render/Render.ts:2078

`Static` `Protected` _createCanvas

_createCanvas(width, height): HTMLCanvasElement
Parameters
- width: number
- height: number
Returns HTMLCanvasElement
canvas

Method
_createCanvas
- Defined in src/render/Render.ts:2020

`Static` `Protected` _getPixelRatio

_getPixelRatio(_canvas?): number
Gets the pixel ratio of the canvas.
Parameters
- Optional _canvas: HTMLCanvasElement
Returns number
pixel ratio

Method
_getPixelRatio
- Defined in src/render/Render.ts:2042

`Static` `Protected` _getTexture

_getTexture(render, imagePath): HTMLImageElement
Gets the requested texture (an Image) via its path
Parameters
- render: IRender
- imagePath: string
Returns HTMLImageElement
texture

Method
_getTexture
- Defined in src/render/Render.ts:2056

`Static` `Protected` _mean

_mean(values): number
Returns the mean value of the given numbers.
Parameters
- values: number[]
Returns number
the mean of given values

Method
_mean
- Defined in src/render/Render.ts:2006

`Static` `Protected` _updateTiming

_updateTiming(render, time?): void
Updates render timing.
Parameters
- render: IRender
- Optional time: number
Returns void

Method
_updateTiming
- Defined in src/render/Render.ts:1955

`Static` `Protected` bodies

bodies(render, bodies, context): void
Description
Parameters
- render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodies
- Defined in src/render/Render.ts:1167

`Static` `Protected` bodyAxes

bodyAxes(render, bodies, context): void
Draws body angle indicators and axes
Parameters
- render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyAxes
- Defined in src/render/Render.ts:1512

`Static` `Protected` bodyBounds

bodyBounds(render, bodies, context): void
Draws body bounds
Parameters
- render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyBounds
- Defined in src/render/Render.ts:1468

`Static` `Protected` bodyConvexHulls

bodyConvexHulls(_render, bodies, context): void
Optimised method for drawing body convex hull wireframes in one pass
Parameters
- _render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyConvexHulls
- Defined in src/render/Render.ts:1382

`Static` `Protected` bodyIds

bodyIds(_render, bodies, context): void
Draws body ids
Parameters
- _render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyIds
- Defined in src/render/Render.ts:1675

`Static` `Protected` bodyPositions

bodyPositions(render, bodies, context): void
Draws body positions
Parameters
- render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyPositions
- Defined in src/render/Render.ts:1581

`Static` `Protected` bodyVelocity

bodyVelocity(_render, bodies, context): void
Draws body velocity
Parameters
- _render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyVelocity
- Defined in src/render/Render.ts:1643

`Static` `Protected` bodyWireframes

bodyWireframes(render, bodies, context): void
Optimised method for drawing body wireframes in one pass
Parameters
- render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
bodyWireframes
- Defined in src/render/Render.ts:1328

`Static` `Protected` collisions

collisions(render, pairs, context): void
Description
Parameters
- render: IRender
- pairs: IPair[]
- context: CanvasRenderingContext2D
Returns void

Method
collisions
- Defined in src/render/Render.ts:1706

`Static` `Protected` constraints

constraints(constraints, context): void
Description
Parameters
- constraints: IConstraint[]
- context: CanvasRenderingContext2D
Returns void

Method
constraints
- Defined in src/render/Render.ts:1084

`Static` create

create(options?): IRender
Creates a new renderer. The options parameter is an object that specifies any properties you wish to override the defaults. All properties have default values, and many are pre-calculated automatically based on other properties. See the properties section below for detailed information on what you can pass via the options object.
Parameters
- options: Partial<Omit<IRender, "options">> & {
  options?: Partial<IRenderOptions>;
  } = {}
Returns IRender
A new renderer

Method
create
- Defined in src/render/Render.ts:349

`Static` endViewTransform

endViewTransform(render): void
Resets all transforms on the render context.
Parameters
- render: IRender
Returns void

Method
endViewTransform
- Defined in src/render/Render.ts:671

`Static` `Protected` inspector

inspector(inspector, context): void
Description
Parameters
- inspector: IInspector
- context: CanvasRenderingContext2D
Returns void

Method
inspector
- Defined in src/render/Render.ts:1864

`Static` lookAt

lookAt(render, objects, padding?, center?): void
Positions and sizes the viewport around the given object bounds. Objects must have at least one of the following properties:
- object.bounds
- object.position
- object.min and object.max
- object.x and object.y
Parameters
- render: IRender
- objects: any
- padding: IVector = ...
- center: boolean = true
Returns void

Method
lookAt
- Defined in src/render/Render.ts:550

`Static` `Protected` mousePosition

mousePosition(_render, mouse, context): void
Renders mouse position.
Parameters
- _render: IRender
- mouse: IMouse
- context: CanvasRenderingContext2D
Returns void

Method
mousePosition
- Defined in src/render/Render.ts:1448

`Static` `Protected` performance

performance(render, context): void
Renders engine and render performance information.
Parameters
- render: IRender
- context: CanvasRenderingContext2D
Returns void

Method
performance
- Defined in src/render/Render.ts:914

`Static` run

run(render): void
Continuously updates the render canvas on the requestAnimationFrame event.
Parameters
- render: IRender
Returns void

Method
run
- Defined in src/render/Render.ts:451

`Static` `Protected` separations

separations(render, pairs, context): void
Description
Parameters
- render: IRender
- pairs: IPair[]
- context: CanvasRenderingContext2D
Returns void

Method
separations
- Defined in src/render/Render.ts:1800

`Static` setPixelRatio

setPixelRatio(render, pr): void
Sets the pixel ratio of the renderer and updates the canvas. To automatically detect the correct ratio, pass the string 'auto' for pixelRatio.
Parameters
- render: IRender
- pr: number | "auto"
Returns void

Method
setPixelRatio
- Defined in src/render/Render.ts:488

`Static` setSize

setSize(render, width, height): void
Sets the render width and height.

Updates the canvas accounting for render.options.pixelRatio.

Updates the bottom right render bound render.bounds.max relative to the provided width and height. The top left render bound render.bounds.min isn't changed.

Follow this call with Render.lookAt if you need to change the render bounds.

See also Render.setPixelRatio.
Parameters
- render: IRender
- width: number
  
  The width (in CSS pixels)
- height: number
  
  The height (in CSS pixels)
Returns void

Method
setSize
- Defined in src/render/Render.ts:523

`Static` startViewTransform

startViewTransform(render): void
Applies viewport transforms based on render.bounds to a render context.
Parameters
- render: IRender
Returns void

Method
startViewTransform
- Defined in src/render/Render.ts:648

`Static` `Protected` stats

stats(render, context, _time?): void
Renders statistics about the engine and world useful for debugging.
Parameters
- render: IRender
- context: CanvasRenderingContext2D
- Optional _time: number
Returns void

Method
stats
- Defined in src/render/Render.ts:857

`Static` `Protected` status

status(context, x, y, width, height, count, label, indicator, plotY): void
Renders a label, indicator and a chart.
Parameters
- context: CanvasRenderingContext2D
- x: number
- y: number
- width: number
- height: number
- count: number
- label: string
- indicator: number
- plotY: ((idx) => number)
  - - (idx): number
    - Parameters
      
      idx: number
      
      Returns number
Returns void

Method
status
- Defined in src/render/Render.ts:1037

`Static` stop

stop(render): void
Ends execution of Render.run on the given render, by canceling the animation frame request event loop.
Parameters
- render: IRender
Returns void

Method
stop
- Defined in src/render/Render.ts:475

`Static` `Protected` vertexNumbers

vertexNumbers(_render, bodies, context): void
Renders body vertex numbers.
Parameters
- _render: IRender
- bodies: IBody[]
- context: CanvasRenderingContext2D
Returns void

Method
vertexNumbers
- Defined in src/render/Render.ts:1418

`Static` world

world(render, _time?): void
Renders the given engine's Matter.World object. This is the entry point for all rendering and should be called every time the scene changes.
Parameters
- render: IRender
- Optional _time: number
Returns void

Method
world
- Defined in src/render/Render.ts:689

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

Static Protected _cancelAnimationFrame

Type declaration

Parameters

handle: number

Returns void

Type declaration

Parameters

handle: number

Returns void

Static Protected _goodDelta

Static Protected _goodFps

Static Protected _requestAnimationFrame

Type declaration

Parameters

callback: FrameRequestCallback

Returns number

Type declaration

Parameters

callback: FrameRequestCallback

Returns number

Methods

Static Protected _applyBackground

Parameters

render: IRender

background: string

Returns void

Method

Static Protected _createCanvas

Parameters

width: number

height: number

Returns HTMLCanvasElement

Method

Static Protected _getPixelRatio

Parameters

Optional _canvas: HTMLCanvasElement

Returns number

Method

Static Protected _getTexture

Parameters

render: IRender

imagePath: string

Returns HTMLImageElement

Method

Static Protected _mean

Parameters

values: number[]

Returns number

Method

Static Protected _updateTiming

Parameters

render: IRender

Optional time: number

Returns void

Method

Static Protected bodies

Parameters

render: IRender

bodies: IBody[]

context: CanvasRenderingContext2D

Returns void

Method

Static Protected bodyAxes

Parameters

render: IRender

bodies: IBody[]

context: CanvasRenderingContext2D

Returns void

Method

Static Protected bodyBounds

`Static` `Protected` _cancelAnimationFrame

`Static` `Protected` _goodDelta

`Static` `Protected` _goodFps

`Static` `Protected` _requestAnimationFrame

`Static` `Protected` _applyBackground

`Static` `Protected` _createCanvas

`Static` `Protected` _getPixelRatio

`Optional` _canvas: HTMLCanvasElement

`Static` `Protected` _getTexture

`Static` `Protected` _mean

`Static` `Protected` _updateTiming

`Optional` time: number

`Static` `Protected` bodies

`Static` `Protected` bodyAxes

`Static` `Protected` bodyBounds

`Static` `Protected` bodyConvexHulls

`Static` `Protected` bodyIds

`Static` `Protected` bodyPositions

`Static` `Protected` bodyVelocity

`Static` `Protected` bodyWireframes

`Static` `Protected` collisions

`Static` `Protected` constraints

`Static` create

options: Partial<Omit<IRender, "options">> & {
options?: Partial<IRenderOptions>;
} = {}

`Static` endViewTransform

`Static` `Protected` inspector