diff --git a/README.md b/README.md index e16cbe0..7501c78 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,6 @@ See how others are using matter.js physics - Collision queries (raycasting, region tests) - Time scaling (slow-mo, speed-up) - Canvas renderer (supports vectors and textures) -- WebGL renderer (requires [pixi.js](https://github.com/GoodBoyDigital/pixi.js/)) - [MatterTools](https://github.com/liabru/matter-tools) for creating, testing and debugging worlds - World state serialisation (requires [resurrect.js](https://github.com/skeeto/resurrect-js)) - Cross-browser (Chrome, Firefox, Safari, IE8+) @@ -173,7 +172,7 @@ The engine uses the following techniques: - Constraints solved with the Gauss-Siedel method - Semi-variable time step, synced with rendering - A basic sleeping strategy -- HTML5 Canvas / WebGL renderer +- HTML5 Canvas rendering For more information see my post on [Game physics for beginners](http://brm.io/game-physics-for-beginners/). diff --git a/src/core/Runner.js b/src/core/Runner.js index 83f5bf0..8d1ce16 100644 --- a/src/core/Runner.js +++ b/src/core/Runner.js @@ -1,10 +1,9 @@ /** * The `Matter.Runner` module is an optional utility which provides a game loop, -* that handles updating and rendering a `Matter.Engine` for you within a browser. -* It is intended for demo and testing purposes, but may be adequate for simple games. +* that handles continuously updating a `Matter.Engine` for you within a browser. +* It is intended for development and debugging purposes, but may also be suitable for simple games. * If you are using your own game loop instead, then you do not need the `Matter.Runner` module. * Instead just call `Engine.update(engine, delta)` in your own loop. -* Note that the method `Engine.run` is an alias for `Runner.run`. * * See the included usage [examples](https://github.com/liabru/matter-js/tree/master/examples). * @@ -267,6 +266,7 @@ var Common = require('./Common'); * @param {number} event.timestamp The engine.timing.timestamp of the event * @param {} event.source The source object of the event * @param {} event.name The name of the event + * @deprecated */ /** @@ -277,6 +277,7 @@ var Common = require('./Common'); * @param {number} event.timestamp The engine.timing.timestamp of the event * @param {} event.source The source object of the event * @param {} event.name The name of the event + * @deprecated */ /* diff --git a/src/render/Render.js b/src/render/Render.js index d21b630..ff06cae 100644 --- a/src/render/Render.js +++ b/src/render/Render.js @@ -1,11 +1,7 @@ /** -* The `Matter.Render` module is the default `render.controller` used by a `Matter.Engine`. -* This renderer is HTML5 canvas based and supports a number of drawing options including sprites and viewports. -* -* It is possible develop a custom renderer module based on `Matter.Render` and pass an instance of it to `Engine.create` via `options.render`. -* A minimal custom renderer object must define at least three functions: `create`, `clear` and `world` (see `Matter.Render`). -* -* See also `Matter.RenderPixi` for an alternate WebGL, scene-graph based renderer. +* The `Matter.Render` module is a simple HTML5 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. * * @class Render */ diff --git a/src/render/RenderPixi.js b/src/render/RenderPixi.js index 4ba104d..518e8eb 100644 --- a/src/render/RenderPixi.js +++ b/src/render/RenderPixi.js @@ -3,7 +3,7 @@ * See also `Matter.Render` for a canvas based renderer. * * @class RenderPixi -* @deprecated the `Matter.RenderPixi` module will soon be removed from the Matter.js core. +* @deprecated the Matter.RenderPixi module will soon be removed from the Matter.js core. * It will likely be moved to its own repository (but maintenance will be limited). */