FastLED 3.9.3
Loading...
Searching...
No Matches
Cylon Class Reference

Detailed Description

An animation that moves a single LED back and forth (Larson Scanner effect)

Definition at line 13 of file cylon.hpp.

#include <cylon.hpp>

+ Inheritance diagram for Cylon:

Public Member Functions

 Cylon (uint16_t num_leds, uint8_t fade_amount=250, uint8_t delay_ms=10)
 
void lazyInit () override
 
void draw (DrawContext context) override
 
const char * fxName (int) const override
 
- Public Member Functions inherited from FxStrip
 FxStrip (uint16_t numLeds)
 
void setXmap (const XMap &xMap)
 
uint16_t xyMap (uint16_t x) const
 
- Public Member Functions inherited from Fx
 Fx (uint16_t numLeds)
 
virtual bool hasAlphaChannel () const
 
virtual bool hasFixedFrameRate (float *fps) const
 
virtual int fxNum () const
 
virtual void fxSet (int fx)
 
virtual void fxNext (int fx=1)
 
virtual int fxGet () const
 
virtual void pause ()
 
virtual void resume ()
 
virtual void destroy ()
 
uint16_t getNumLeds () const
 
- Public Member Functions inherited from Referent
virtual int ref_count () const
 

Public Attributes

uint8_t delay_ms
 

Additional Inherited Members

- Public Types inherited from Fx
using DrawContext = _DrawContext
 
- Protected Member Functions inherited from Referent
 Referent (const Referent &)
 
Referentoperator= (const Referent &)
 
 Referent (Referent &&)
 
Referentoperator= (Referent &&)
 
virtual void ref ()
 
virtual void unref ()
 
- Protected Attributes inherited from FxStrip
XMap mXMap
 
- Protected Attributes inherited from Fx
uint16_t mNumLeds
 

Constructor & Destructor Documentation

◆ Cylon()

Cylon::Cylon ( uint16_t num_leds,
uint8_t fade_amount = 250,
uint8_t delay_ms = 10 )
inline

Definition at line 16 of file cylon.hpp.

Member Function Documentation

◆ draw()

void Cylon::draw ( DrawContext context)
inlineoverridevirtual
Parameters
nowThe current time in milliseconds. Fx writers are encouraged to use this instead of millis() directly as this will more deterministic behavior.

Implements Fx.

Definition at line 25 of file cylon.hpp.

◆ fxName()

const char * Cylon::fxName ( int ) const
inlineoverridevirtual

Implements Fx.

Definition at line 56 of file cylon.hpp.

◆ lazyInit()

void Cylon::lazyInit ( )
inlineoverridevirtual

Reimplemented from Fx.

Definition at line 21 of file cylon.hpp.

Member Data Documentation

◆ delay_ms

uint8_t Cylon::delay_ms

Definition at line 15 of file cylon.hpp.


The documentation for this class was generated from the following file: