Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smallhelm/simple-timestepper
simply pass in two callbacks, one that get's called at a fixed time step i.e. 60 fps, the other is called on every animation frame
https://github.com/smallhelm/simple-timestepper
animation game simulation
Last synced: 2 months ago
JSON representation
simply pass in two callbacks, one that get's called at a fixed time step i.e. 60 fps, the other is called on every animation frame
- Host: GitHub
- URL: https://github.com/smallhelm/simple-timestepper
- Owner: smallhelm
- License: mit
- Created: 2014-11-29T15:40:32.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-12-03T23:42:54.000Z (about 10 years ago)
- Last Synced: 2024-11-17T10:12:54.604Z (3 months ago)
- Topics: animation, game, simulation
- Language: JavaScript
- Homepage:
- Size: 145 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What it does
Makes your games and simulations update smoothly at a constant time step.
It separates update ticks and rendering frames. This way when writing games and simulations the state of the game updates at a constant time step while the rendering happens as fast as the browsers requestAnimationFrame updates.
# How to use it
```js
var onUpdate = function(){
//update the state (i.e. update positions, do physics etc...)
};
var onRender = function(){
//render to the canvas or whatever your render target is
};
var t = timestepper(onUpdate, onRender);
t.start();//start the loop
...
t.stop();//pause the loop
...
t.start();//start the loop again
```
By default it calls update 60 times a second, however you can customize this rate. For example: if you want it to update 30 times a second do this
```js
var t = timestepper(onUpdate, onRender, 1/30);
```
By default the frame rate is the native requestAnimationFrame, however you can customize this interval.
```js
var t = timestepper(onUpdate, onRender, 1/30, 1000/30);
```
There are 3 ways to include this library
## With browserify
```js
var timestepper = require('simple-timestepper');
...
```
## With a script tag
Download [this](https://github.com/smallhelm/simple-timestepper/blob/master/simple-timestepper.min.js) script then include it in your html
```html
```
Then use it
```js
var timestepper = SIMPLE_TIMESTEPPER;
...
```
## With RequireJS
```js
require(['simple-timestepper'], function(timestepper) {
...
});
```
# License
The MIT License (MIT)
Copyright (c) 2014 Small Helm LLC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.