fl::NoisePalette Class Reference

Detailed Description

Examples

FxEngine.ino.

Definition at line 21 of file noisepalette.h.

Inheritance diagram for fl::NoisePalette:

Public Member Functions
	NoisePalette (XYMap xyMap, float fps=60.f)
bool	hasFixedFrameRate (float *fps) const override
void	draw (DrawContext context) override
Str	fxName () const override
void	mapNoiseToLEDsUsingPalette (CRGB *leds)
uint8_t	changeToRandomPalette ()
uint8_t	getPalettePresetCount () const
uint8_t	getPalettePreset () const
void	setPalettePreset (int paletteIndex)
void	setPalette (const CRGBPalette16 &palette, uint16_t speed, uint16_t scale, bool colorLoop)
void	setSpeed (uint16_t speed)
void	setScale (uint16_t scale)
Public Member Functions inherited from fl::Fx2d
	Fx2d (const XYMap &xyMap)
uint16_t	xyMap (uint16_t x, uint16_t y) const
uint16_t	getHeight () const
uint16_t	getWidth () const
void	setXYMap (const XYMap &xyMap)
XYMap &	getXYMap ()
const XYMap &	getXYMap () const
Public Member Functions inherited from fl::Fx
	Fx (uint16_t numLeds)
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

Additional Inherited Members
Public Types inherited from fl::Fx
using	DrawContext = _DrawContext
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 ()
Protected Attributes inherited from fl::Fx2d
XYMap	mXyMap
Protected Attributes inherited from fl::Fx
uint16_t	mNumLeds

Constructor & Destructor Documentation

NoisePalette()

fl::NoisePalette::NoisePalette	(	XYMap	xyMap,
		float	fps = 60.f )

Definition at line 17 of file noisepalette.cpp.

Member Function Documentation

changeToRandomPalette()

uint8_t fl::NoisePalette::changeToRandomPalette

(

)

Definition at line 180 of file noisepalette.cpp.

draw()

void fl::NoisePalette::draw ( DrawContext context )

inlineoverridevirtual

Parameters

now	The 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 33 of file noisepalette.h.

fxName()

Str fl::NoisePalette::fxName ( ) const

inlineoverridevirtual

Implements fl::Fx.

Definition at line 38 of file noisepalette.h.

getPalettePreset()

uint8_t fl::NoisePalette::getPalettePreset ( ) const

inline

Definition at line 46 of file noisepalette.h.

getPalettePresetCount()

uint8_t fl::NoisePalette::getPalettePresetCount ( ) const

inline

Definition at line 45 of file noisepalette.h.

hasFixedFrameRate()

bool fl::NoisePalette::hasFixedFrameRate ( float * fps ) const

inlineoverridevirtual

Reimplemented from fl::Fx.

Definition at line 26 of file noisepalette.h.

mapNoiseToLEDsUsingPalette()

void fl::NoisePalette::mapNoiseToLEDsUsingPalette

(

CRGB *

leds

)

Definition at line 105 of file noisepalette.cpp.

setPalette()

void fl::NoisePalette::setPalette ( const CRGBPalette16 & palette, uint16_t speed, uint16_t scale, bool colorLoop )

inline

Definition at line 48 of file noisepalette.h.

setPalettePreset()

void fl::NoisePalette::setPalettePreset

(

int

paletteIndex

)

Definition at line 37 of file noisepalette.cpp.

setScale()

void fl::NoisePalette::setScale ( uint16_t scale )

inline

Definition at line 56 of file noisepalette.h.

setSpeed()

void fl::NoisePalette::setSpeed ( uint16_t speed )

inline

Definition at line 55 of file noisepalette.h.

---

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

• /home/runner/work/FastLED/FastLED/src/fx/2d/noisepalette.h
• /home/runner/work/FastLED/FastLED/src/fx/2d/noisepalette.cpp