Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/samme/phaser-plugin-advanced-timing
Shows FPS, frame intervals, and performance info. Phaser 2/CE
https://github.com/samme/phaser-plugin-advanced-timing
fps phaser phaser-plugin
Last synced: 3 months ago
JSON representation
Shows FPS, frame intervals, and performance info. Phaser 2/CE
- Host: GitHub
- URL: https://github.com/samme/phaser-plugin-advanced-timing
- Owner: samme
- Created: 2016-11-22T21:34:42.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-18T01:06:40.000Z (over 1 year ago)
- Last Synced: 2024-09-28T14:01:46.072Z (3 months ago)
- Topics: fps, phaser, phaser-plugin
- Language: CoffeeScript
- Homepage: https://samme.github.io/phaser-plugin-advanced-timing/
- Size: 1.98 MB
- Stars: 28
- Watchers: 6
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Shows FPS, frame intervals, draw count, and other performance info. [Demo](https://samme.github.io/phaser-plugin-advanced-timing/)
Usage
-----
```javascript
game.plugins.add(Phaser.Plugin.AdvancedTiming);
// or
game.plugins.add(Phaser.Plugin.AdvancedTiming, {mode: 'graph'});
```
The display modes are `domMeter`, `domText`, `graph`, `meter`, and `text`. The default mode is `text`.
You can save a reference to switch modes later:
```javascript
var plugin = game.plugins.add(Phaser.Plugin.AdvancedTiming);
// …
plugin.mode = 'text';
```
The plugin also provides two [debug methods](#debug-methods):
```javascript
game.debug.gameInfo(x, y);
game.debug.gameTimeInfo(x, y);
```
Beware that [debug display can be slow in WebGL](https://phaser.io/docs/2.6.2/Phaser.Utils.Debug.html).
DOM Text, Text
--------------
```javascript
plugin.mode = 'domText';
plugin.mode = 'text';
```
Both show [FPS][fps], [render type][renderType], and WebGL draw count.
`text` is drawn on the game canvas. `domText` is a separate HTML element.
The `domText` element can be styled as
```css
.ppat-text {
position: absolute;
left: 0;
top: 0;
margin: 0;
font: 16px/1 monospace;
}
```
DOM Meter
---------
```javascript
plugin.mode = 'domMeter';
```
Shows [FPS](fps). It can be styled as
```css
.ppat-fps {
position: absolute;
left: 0;
top: 0;
}
```
Graph
-----
```javascript
plugin.mode = 'graph';
```
Plots values for the last 60 updates:
- [FPS](fps) (blue)
- [update duration][updateLogic] (orange)
- [render duration][updateRender] (violet)
- spiraling (red)
- [updatesThisFrame](updatesThisFrame) (dark blue; only when [forceSingleUpdate][forceSingleUpdate] is off)
Meter
-----
```javascript
plugin.mode = 'meter';
```
Shows [FPS](fps) (blue), [update duration][updateLogic] (orange), and [render duration][updateRender] (violet).
Debug Methods
-------------
```javascript
game.debug.gameInfo(x, y);
game.debug.gameTimeInfo(x, y);
```
### debug.gameInfo()
Prints values for
- [game.forceSingleUpdate][forceSingleUpdate]
- `game._lastCount`: “how many ‘catch-up’ iterations were used on the logic update last frame”
- [game.lockRender][lockRender]
- [game.renderType][renderType]
- `game._spiraling`: “if the ‘catch-up’ iterations are spiraling out of control, this counter is incremented”
- [game.updatesThisFrame][updatesThisFrame]: “number of logic updates expected to occur this render frame; will be 1 unless there are catch-ups required (and allowed)”
### debug.gameTimeInfo()
Prints values for
- [game.time.desiredFps][desiredFps]
- [game.time.elapsed][elapsed] (and min–max range)
- [game.time.elapsedMS][elapsedMS]
- [game.time.fps][fps] (and min–max range)
- [game.time.physicsElapsedMS][physicsElapsedMS]
- [game.time.slowMotion][slowMotion]
- [game.time.suggestedFps][suggestedFps]
[desiredFps]: http://phaser.io/docs/2.6.2/Phaser.Time.html#desiredFps
[elapsed]: http://phaser.io/docs/2.6.2/Phaser.Time.html#elapsed
[elapsedMS]: http://phaser.io/docs/2.6.2/Phaser.Time.html#elapsedMS
[forceSingleUpdate]: http://phaser.io/docs/2.6.2/Phaser.Game.html#forceSingleUpdate
[fps]: http://phaser.io/docs/2.6.2/Phaser.Time.html#fps
[lockRender]: http://phaser.io/docs/2.6.2/Phaser.Game.html#lockRender
[physicsElapsedMS]: http://phaser.io/docs/2.6.2/Phaser.Time.html#physicsElapsedMS
[renderType]: http://phaser.io/docs/2.6.2/Phaser.Game.html#renderType
[slowMotion]: http://phaser.io/docs/2.6.2/Phaser.Time.html#slowMotion
[suggestedFps]: http://phaser.io/docs/2.6.2/Phaser.Time.html#suggestedFps
[updatesThisFrame]: http://phaser.io/docs/2.6.2/Phaser.Game.html#updatesThisFrame
[updateLogic]: http://phaser.io/docs/2.6.2/Phaser.Game.html#updateLogic
[updateRender]: http://phaser.io/docs/2.6.2/Phaser.Game.html#updateRender