From 815c709c49b5360f4bf408a906964fa96c83a7c5 Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Tue, 10 Nov 2020 10:04:35 -0800 Subject: [PATCH] Updated NeoPixelAnimator object API (markdown) --- NeoPixelAnimator-object-API.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/NeoPixelAnimator-object-API.md b/NeoPixelAnimator-object-API.md index 08ef2b5..8f81d36 100644 --- a/NeoPixelAnimator-object-API.md +++ b/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.