Fx Class Reference

Detailed Description

Definition at line 16 of file fx.h.

Inheritance diagram for Fx:

Public Types
using	DrawContext = _DrawContext

Public Member Functions
	Fx (uint16_t numLeds)
virtual void	draw (DrawContext context)=0
virtual bool	hasAlphaChannel () const
virtual bool	hasFixedFrameRate (float *fps) const
virtual const char *	fxName (int which=-1) const =0
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 ()
virtual void	lazyInit ()
uint16_t	getNumLeds () const
Public Member Functions inherited from Referent
virtual int	ref_count () const

Protected Attributes
uint16_t	mNumLeds

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

Member Typedef Documentation

DrawContext

using Fx::DrawContext = _DrawContext

Definition at line 19 of file fx.h.

Constructor & Destructor Documentation

Fx()

Fx::Fx ( uint16_t numLeds )

inline

Definition at line 21 of file fx.h.

~Fx()

virtual Fx::~Fx ( )

inlineprotectedvirtual

Definition at line 61 of file fx.h.

Member Function Documentation

destroy()

virtual void Fx::destroy ( )

inlinevirtual

Reimplemented from Referent.

Definition at line 54 of file fx.h.

draw()

virtual void 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 Animartrix, Cylon, DemoReel100, Fire2012, NoisePalette, NoiseWave, Pacifica, Pride2015, RedSquare, ScaleUp, TwinkleFox, and VideoFx.

fxGet()

virtual int Fx::fxGet ( ) const

inlinevirtual

Definition at line 47 of file fx.h.

fxNext()

virtual void Fx::fxNext ( int fx = 1 )

inlinevirtual

Definition at line 46 of file fx.h.

fxNum()

virtual int Fx::fxNum ( ) const

inlinevirtual

Definition at line 40 of file fx.h.

fxSet()

virtual void Fx::fxSet ( int fx )

inlinevirtual

Definition at line 43 of file fx.h.

getNumLeds()

uint16_t Fx::getNumLeds ( ) const

inline

Definition at line 58 of file fx.h.

hasAlphaChannel()

virtual bool Fx::hasAlphaChannel ( ) const

inlinevirtual

Definition at line 30 of file fx.h.

hasFixedFrameRate()

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

inlinevirtual

Definition at line 34 of file fx.h.

lazyInit()

virtual void Fx::lazyInit ( )

inlinevirtual

Definition at line 57 of file fx.h.

pause()

virtual void Fx::pause ( )

inlinevirtual

Definition at line 49 of file fx.h.

resume()

virtual void Fx::resume ( )

inlinevirtual

Definition at line 51 of file fx.h.

Member Data Documentation

mNumLeds

uint16_t Fx::mNumLeds

protected

Definition at line 62 of file fx.h.

---

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

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