Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 04:44:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated NeoPixelAnimator object API (markdown)

Michael Miller
2020-11-10 10:04:35 -08:00
parent 0d52695aa9
commit 815c709c49
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
NeoPixelAnimator-object-API.md

@@ -3,12 +3,14 @@
Construct an animator with the number of animation channels, using the given timescale for all time values.
The timescale is number of milliseconds per time unit. The following flags are available.
```
NEO_MILLISECONDS
NEO_CENTISECONDS
NEO_DECISECONDS
NEO_SECONDS
NEO_DECASECONDS
NEO_MILLISECONDS // ~65 seconds max duration, ms updates
NEO_CENTISECONDS // ~10.9 minutes max duration, centisecond updates
NEO_DECISECONDS // ~1.8 hours max duration, decisecond updates
NEO_SECONDS // ~18.2 hours max duration, second updates
NEO_DECASECONDS // ~7.5 days, 10 second updates
```
The timescale affects not only how often the animation can be called per second; but also how long an animation can be. If you need animations that are called often so they are smooth, then leave it at the default of NEO_MILLISECONDS or at worst NEO_CENTISECONDS. If a change per second or longer is ok and you need animations that run very long, then NEO_SECONDS might be your choice. It is a trade off of fast and smooth versus slow and coarse.
# Methods
## bool IsAnimating()
Return true if there is at least one active running animation.