FastLED 3.6.0
Loading...
Searching...
No Matches
CPixelLEDController< RGB_ORDER, LANES, MASK > Class Template Referenceabstract

Detailed Description

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
class CPixelLEDController< RGB_ORDER, LANES, MASK >

Template extension of the CLEDController class.

Template Parameters
RGB_ORDERthe rgb ordering for the LEDs (e.g. what order red, green, and blue data is written out in)
LANEShow many parallel lanes of output to write
MASKbitmask for the output lanes

Definition at line 616 of file controller.h.

#include <controller.h>

+ Inheritance diagram for CPixelLEDController< RGB_ORDER, LANES, MASK >:

Public Member Functions

int lanes ()
 Get the number of lanes of the Controller.
 
- Public Member Functions inherited from CLEDController
 CLEDController ()
 Create an led controller object, add it to the chain of controllers.
 
virtual void init ()=0
 Initialize the LED controller.
 
virtual void clearLeds (int nLeds)
 Clear out/zero out the given number of LEDs.
 
void show (const struct CRGB *data, int nLeds, uint8_t brightness)
 Write the passed in RGB data out to the LEDs managed by this controller.
 
void showColor (const struct CRGB &data, int nLeds, uint8_t brightness)
 Set all the LEDs to a given color.
 
void showLeds (uint8_t brightness=255)
 Write the data to the LEDs managed by this controller.
 
void showColor (const struct CRGB &data, uint8_t brightness=255)
 Set all the LEDs to a given color.
 
CLEDControllernext ()
 Get the next controller in the linked list after this one.
 
CLEDControllersetLeds (CRGB *data, int nLeds)
 Set the default array of LEDs to be used by this controller.
 
void clearLedData ()
 Zero out the LED data managed by this controller.
 
virtual int size ()
 How many LEDs does this controller manage?
 
virtual int lanes ()
 How many Lanes does this controller manage?
 
CRGBleds ()
 Pointer to the CRGB array for this controller.
 
CRGBoperator[] (int x)
 Reference to the n'th LED managed by the controller.
 
CLEDControllersetDither (uint8_t ditherMode=BINARY_DITHER)
 Set the dithering mode for this controller to use.
 
uint8_t getDither ()
 Get the dithering option currently set for this controller.
 
CLEDControllersetCorrection (CRGB correction)
 The color corrction to use for this controller, expressed as a CRGB object.
 
CLEDControllersetCorrection (LEDColorCorrection correction)
 The color corrction to use for this controller, expressed as a CRGB object.
 
CRGB getCorrection ()
 Get the correction value used by this controller.
 
CLEDControllersetTemperature (CRGB temperature)
 Set the color temperature, aka white point, for this controller.
 
CLEDControllersetTemperature (ColorTemperature temperature)
 Set the color temperature, aka white point, for this controller.
 
CRGB getTemperature ()
 Get the color temperature, aka whipe point, for this controller.
 
CRGB getAdjustment (uint8_t scale)
 Get the combined brightness/color adjustment for this controller.
 
virtual uint16_t getMaxRefreshRate () const
 Gets the maximum possible refresh rate of the strip.
 

Protected Member Functions

virtual void showPixels (PixelController< RGB_ORDER, LANES, MASK > &pixels)=0
 Send the LED data to the strip.
 
virtual void showColor (const struct CRGB &data, int nLeds, CRGB scale)
 Set all the LEDs on the controller to a given color.
 
virtual void show (const struct CRGB *data, int nLeds, CRGB scale)
 Write the passed in RGB data out to the LEDs managed by this controller.
 
virtual void showColor (const struct CRGB &data, int nLeds, CRGB scale)=0
 Set all the LEDs to a given color.
 
virtual void show (const struct CRGB *data, int nLeds, CRGB scale)=0
 Write the passed in RGB data out to the LEDs managed by this controller.
 

Additional Inherited Members

- Static Public Member Functions inherited from CLEDController
static CLEDControllerhead ()
 Get the first LED controller in the linked list of controllers.
 
static CRGB computeAdjustment (uint8_t scale, const CRGB &colorCorrection, const CRGB &colorTemperature)
 Calculates the combined color adjustment to the LEDs at a given scale, color correction, and color temperature.
 
- Protected Attributes inherited from CLEDController
CRGBm_Data
 pointer to the LED data used by this controller
 
CLEDControllerm_pNext
 pointer to the next LED controller in the linked list
 
CRGB m_ColorCorrection
 CRGB object representing the color correction to apply to the strip on show()
 
CRGB m_ColorTemperature
 CRGB object representing the color temperature to apply to the strip on show()
 
EDitherMode m_DitherMode
 the current dither mode of the controller
 
int m_nLeds
 the number of LEDs in the LED data array
 
- Static Protected Attributes inherited from CLEDController
static CLEDControllerm_pHead = NULL
 pointer to the first LED controller in the linked list
 
static CLEDControllerm_pTail = NULL
 pointer to the last LED controller in the linked list
 

Constructor & Destructor Documentation

◆ CPixelLEDController()

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
CPixelLEDController< RGB_ORDER, LANES, MASK >::CPixelLEDController ( )
inline

Definition at line 645 of file controller.h.

Member Function Documentation

◆ lanes()

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
int CPixelLEDController< RGB_ORDER, LANES, MASK >::lanes ( )
inlinevirtual

Get the number of lanes of the Controller.

Returns
LANES from template

Reimplemented from CLEDController.

Definition at line 649 of file controller.h.

◆ show()

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
virtual void CPixelLEDController< RGB_ORDER, LANES, MASK >::show ( const struct CRGB data,
int  nLeds,
CRGB  scale 
)
inlineprotectedvirtual

Write the passed in RGB data out to the LEDs managed by this controller.

Parameters
datathe RGB data to write out to the strip
nLedsthe number of LEDs being written out
scalethe RGB scaling to apply to each LED before writing it out

Implements CLEDController.

Definition at line 635 of file controller.h.

◆ showColor()

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
virtual void CPixelLEDController< RGB_ORDER, LANES, MASK >::showColor ( const struct CRGB data,
int  nLeds,
CRGB  scale 
)
inlineprotectedvirtual

Set all the LEDs on the controller to a given color.

Parameters
datathe CRGB color to set the LEDs to
nLedsthe number of LEDs to set to this color
scalethe RGB scaling value for outputting color

Implements CLEDController.

Definition at line 626 of file controller.h.

◆ showPixels()

template<EOrder RGB_ORDER, int LANES = 1, uint32_t MASK = 0xFFFFFFFF>
virtual void CPixelLEDController< RGB_ORDER, LANES, MASK >::showPixels ( PixelController< RGB_ORDER, LANES, MASK > &  pixels)
protectedpure virtual

Send the LED data to the strip.

Parameters
pixelsthe PixelController object for the LED data

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