FFXAFDimmer Class Reference

#include <FFXAFDimmer.h>

Inheritance diagram for FFXAFDimmer:

Public Member Functions
	FFXAFDimmer ()
	FFXAFDimmer (unsigned int initInterval)
	FFXAFDimmer (unsigned int initInterval, uint8_t initValue)
virtual	~FFXAFDimmer ()
virtual void	onUpdate (CRGBSet &pixels) override
Public Member Functions inherited from FFXAutoFader
	FFXAutoFader ()
	FFXAutoFader (uint8_t initValue)
virtual	~FFXAutoFader ()
bool	isFading ()
bool	isUpdated ()
uint8_t	getTarget ()
void	setTarget (uint8_t newTarget)
uint8_t	getValue ()
void	update (CRGBSet &pixels)
void	setInterval (uint16_t ms)
uint16_t	getInterval ()
void	updateFader ()

Detailed Description

FXAFDimmer - used by FFXSegment to provide dimming for individual ranges of pixels. Incorporates auto-fade for smooth dimming appearance.

setTarget() to set desired dimming level (255 = no dimming/full brightness, 0 = off) getTarget() to return the set level (when fading - the level may not have been reached yet) getValue() to return the current level - when fading, this may not be equal to the target value apply( CRGBSet& ) applies the dimmer to the pixels passed in the CRGBSet reference isUpdated() return true when the dimming value is not the same as the last time apply() was called setInterval( uint16_t ms) to set the speed of fade transitions - will complete in ms milliseconds

Constructor & Destructor Documentation

FFXAFDimmer() [1/3]

FFXAFDimmer::FFXAFDimmer ( )

inline

FFXAFDimmer() [2/3]

FFXAFDimmer::FFXAFDimmer ( unsigned int  initInterval )

inline

FFXAFDimmer() [3/3]

FFXAFDimmer::FFXAFDimmer ( unsigned int  initInterval, uint8_t  initValue  )

inline

~FFXAFDimmer()

virtual FFXAFDimmer::~FFXAFDimmer ( )

inlinevirtual

Member Function Documentation

onUpdate()

void FFXAFDimmer::onUpdate ( CRGBSet &  pixels )

overridevirtual

Implements FFXAutoFader.