FastLED 3.9.7
Loading...
Searching...
No Matches
fl::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 fl::Cylon:

Public Member Functions

 Cylon (uint16_t num_leds, uint8_t fade_amount=250, uint8_t delay_ms=10)
 
void draw (DrawContext context) override
 
fl::Str fxName () const override
 
- Public Member Functions inherited from fl::Fx1d
 Fx1d (uint16_t numLeds)
 
void setXmap (const XMap &xMap)
 
uint16_t xyMap (uint16_t x) const
 
- Public Member Functions inherited from fl::Fx
 Fx (uint16_t numLeds)
 
virtual bool hasFixedFrameRate (float *fps) const
 
virtual void pause (uint32_t now)
 
virtual void resume (uint32_t now)
 
uint16_t getNumLeds () const
 
- Public Member Functions inherited from fl::Referent
virtual int ref_count () const
 

Public Attributes

uint8_t delay_ms
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ Cylon()

fl::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 fl::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 fl::Fx.

Definition at line 20 of file cylon.hpp.

◆ fxName()

fl::Str fl::Cylon::fxName ( ) const
inlineoverridevirtual

Implements fl::Fx.

Definition at line 51 of file cylon.hpp.

Member Data Documentation

◆ delay_ms

uint8_t fl::Cylon::delay_ms

Definition at line 15 of file cylon.hpp.


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