mirror of
https://github.com/liabru/matter-js.git
synced 2024-11-27 09:50:52 -05:00
added docs for additional engine timing and render properties
This commit is contained in:
parent
e94b8b87c9
commit
8017bdb47c
2 changed files with 66 additions and 0 deletions
|
@ -433,6 +433,25 @@ var Body = require('../body/Body');
|
|||
* @default 0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A `Number` that represents the total execution time elapsed during the last `Engine.update` in milliseconds.
|
||||
* It is updated by timing from the start of the last `Engine.update` call until it ends.
|
||||
*
|
||||
* This value will also include the total execution time of all event handlers directly or indirectly triggered by the engine update.
|
||||
*
|
||||
* @property timing.lastElapsed
|
||||
* @type number
|
||||
* @default 0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A `Number` that represents the `delta` value used in the last engine update.
|
||||
*
|
||||
* @property timing.lastDelta
|
||||
* @type number
|
||||
* @default 0
|
||||
*/
|
||||
|
||||
/**
|
||||
* A `Matter.Grid` instance.
|
||||
*
|
||||
|
|
|
@ -1683,6 +1683,53 @@ var Mouse = require('../core/Mouse');
|
|||
* @default false
|
||||
*/
|
||||
|
||||
/**
|
||||
* A flag to enable or disable all debug information overlays together.
|
||||
* This includes and has priority over the values of:
|
||||
*
|
||||
* - `render.options.showStats`
|
||||
* - `render.options.showPerformance`
|
||||
*
|
||||
* @property options.showDebug
|
||||
* @type boolean
|
||||
* @default false
|
||||
*/
|
||||
|
||||
/**
|
||||
* A flag to enable or disable the engine stats info overlay.
|
||||
* From left to right, the values shown are:
|
||||
*
|
||||
* - body parts total
|
||||
* - body total
|
||||
* - constraints total
|
||||
* - composites total
|
||||
* - collision pairs total
|
||||
*
|
||||
* @property options.showStats
|
||||
* @type boolean
|
||||
* @default false
|
||||
*/
|
||||
|
||||
/**
|
||||
* A flag to enable or disable performance charts.
|
||||
* From left to right, the values shown are:
|
||||
*
|
||||
* - average render frequency (e.g. 60 fps)
|
||||
* - exact engine delta time used for last update (e.g. 16.66ms)
|
||||
* - average engine execution duration (e.g. 5.00ms)
|
||||
* - average render execution duration (e.g. 0.40ms)
|
||||
* - average effective play speed (e.g. '1.00x' is 'real-time')
|
||||
*
|
||||
* Each value is recorded over a fixed sample of past frames (60 frames).
|
||||
*
|
||||
* A chart shown below each value indicates the variance from the average over the sample.
|
||||
* The more stable or fixed the value is the flatter the chart will appear.
|
||||
*
|
||||
* @property options.showPerformance
|
||||
* @type boolean
|
||||
* @default false
|
||||
*/
|
||||
|
||||
/**
|
||||
* A flag to enable or disable rendering entirely.
|
||||
*
|
||||
|
|
Loading…
Reference in a new issue