Just Show - AlbertGBarber/PixelSpork GitHub Wiki

See the Documentation Guide for help understanding each page section.

Description:

This utility just calls Segment Drawing Functions show() function at a set rate, writing the FastLED LED color data to your strip. May be useful if you're trying to manage frame rates or balance updating multiple simultaneous effects with different update rates.

Note that the utility does require a segment set, but when it is updated it will update all LEDs by calling FastLED.show().

Otherwise this utility behaves like a effect, it has an update rate, a showNow var, etc.

Example Calls:

JustShowPS justShow(mainSegments, 30);
//Will call FastLED.show() every 30ms

Constructor Definitions:

JustShowPS(SegmentSetPS &SegSet, uint16_t Rate);

Constructor Inputs:

  • SegmentSetPS* segSet -- A segment set, required for the utility, but the exact segment set doesn't matter, since FastLED.show() updates all LEDs.

  • uint16_t* rate -- Update rate (ms). Is a pointer, allowing you to bind it to an external variable. By default it's bound the effect's local variable, rateOrig. See common vars rate entry for more.

Other Settings:

  • bool active (default true) -- If false, the utility/effect will be disabled (updates() will be ignored). See common vars active entry for more details.

  • bool showNow (default true) -- Controls if the effect "draws" during each update cycle by calling FastLED.show(). Common to all effects. See common vars showNow entry for more details.

Class Functions:

  • void update();
    Updates the effect.