Show:
API

Matter.Mouse

Defined in: src/core/Mouse.js:1

The Matter.Mouse module contains methods for creating and manipulating mouse inputs.

Methods

Matter.Mouse._getRelativeMousePosition

(event, element, pixelRatio)
→ Object private

Gets the mouse position relative to an element given a screen pixel ratio.

Parameters

Returns

src/core/Mouse.js:170 · Usages · Examples

Matter.Mouse.clearSourceEvents

(mouse)

Clears all captured source events.

Parameters

src/core/Mouse.js:131 · Usages · Examples

Matter.Mouse.create

(element)
→ Mouse

Creates a mouse input.

Parameters

Returns

Mouse

A new mouse

src/core/Mouse.js:15 · Usages · Examples

Matter.Mouse.setElement

(mouse, element)

Sets the element the mouse is bound to (and relative to).

Parameters

src/core/Mouse.js:111 · Usages · Examples

Matter.Mouse.setOffset

(mouse, offset)

Sets the mouse position offset.

Parameters

src/core/Mouse.js:144 · Usages · Examples

Matter.Mouse.setScale

(mouse, scale)

Sets the mouse position scale.

Parameters

src/core/Mouse.js:157 · Usages · Examples