fl::Fx Class Reference

Detailed Description

Definition at line 18 of file fx.h.

Inheritance diagram for fl::Fx:

Public Types
using	DrawContext = _DrawContext

Public Member Functions
	Fx (uint16_t numLeds)
virtual void	draw (DrawContext context)=0
virtual bool	hasFixedFrameRate (float *fps) const
virtual fl::Str	fxName () const =0
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

Protected Attributes
uint16_t	mNumLeds

Additional Inherited Members
Protected Member Functions inherited from fl::Referent
	Referent (const Referent &)
Referent &	operator= (const Referent &)
	Referent (Referent &&)
Referent &	operator= (Referent &&)
virtual void	ref ()
virtual void	unref ()
virtual void	destroy ()

Member Typedef Documentation

DrawContext

using fl::Fx::DrawContext = _DrawContext

Definition at line 21 of file fx.h.

Constructor & Destructor Documentation

Fx()

fl::Fx::Fx ( uint16_t numLeds )

inline

Definition at line 23 of file fx.h.

~Fx()

virtual fl::Fx::~Fx ( )

inlineprotectedvirtual

Definition at line 49 of file fx.h.

Member Function Documentation

draw()

virtual void fl::Fx::draw ( DrawContext context )

pure virtual

Parameters

now	The current time in milliseconds. Fx writers are encouraged to use this instead of millis() directly as this will more deterministic behavior.

Implemented in fl::Animartrix, fl::Cylon, fl::DemoReel100, fl::Fire2012, fl::NoisePalette, fl::NoiseWave, fl::Pacifica, fl::Pride2015, fl::RedSquare, fl::ScaleUp, fl::TwinkleFox, fl::Video, and fl::VideoFxWrapper.

getNumLeds()

uint16_t fl::Fx::getNumLeds ( ) const

inline

Definition at line 46 of file fx.h.

hasFixedFrameRate()

virtual bool fl::Fx::hasFixedFrameRate ( float * fps ) const

inlinevirtual

Definition at line 33 of file fx.h.

pause()

virtual void fl::Fx::pause ( uint32_t now )

inlinevirtual

Definition at line 42 of file fx.h.

resume()

virtual void fl::Fx::resume ( uint32_t now )

inlinevirtual

Definition at line 43 of file fx.h.

Member Data Documentation

mNumLeds

uint16_t fl::Fx::mNumLeds

protected

Definition at line 50 of file fx.h.

---

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

• /home/runner/work/FastLED/FastLED/src/fx/fx.h