Metadata-Version: 2.4
Name: deltatiming
Version: 0.1.5
Summary: A clean, useful delta time library for games and simulations.
Author: robert-ish
License-Expression: MIT
Project-URL: Homepage, https://github.com/robert-ish/deltatime
Project-URL: Repository, https://github.com/robert-ish/deltatime
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# Deltatiming
A lightweight library for handling deltatime.
## Installation
```bash
pip install deltatiming
```
## Usage
```python
from deltatiming import Deltatime
dt = Deltatime()
dt.tick()
print('Estimated framerate: '+str(dt.get_framerate()))
```
## Available functions
### Deltatime.tick()
Needed to be called before Deltatime.get_delta() and Deltatime.get_framerate()
### Deltatime.get_delta()
Gets time after last tick() call.
### Deltatime.set_time_scale(value)
Sets time multiplier. Useful for speeding up/slowing down the whole script if the whole script uses deltatime.
### Deltatime.get_time_scale()
Returns current time scale.
### Deltatime.get_framerate(use_time_scale: bool)
Returns current framerate based on delta time.
use_time_scale defaults to False
## License
MIT
