FastLED 3.9.15
Loading...
Searching...
No Matches
WS2816< DATA_PIN, RGB_ORDER > Class Template Reference

Detailed Description

template<uint8_t DATA_PIN, EOrder RGB_ORDER>
class WS2816< DATA_PIN, RGB_ORDER >

WS2816 controller class.

Examples
WS2816.ino.

Definition at line 201 of file FastLED.h.

#include <FastLED.h>

+ Inheritance diagram for WS2816< DATA_PIN, RGB_ORDER >:
+ Collaboration diagram for WS2816< DATA_PIN, RGB_ORDER >:

Additional Inherited Members

- Public Types inherited from WS2816Controller< DATA_PIN, RGB_ORDER >
typedef WS2812Controller800Khz< DATA_PIN, RGBControllerBaseT
 
- Public Member Functions inherited from WS2816Controller< DATA_PIN, RGB_ORDER >
 WS2816Controller ()
 
 ~WS2816Controller ()
 
virtual void * beginShowLeds (int size) override
 
virtual void endShowLeds (void *data) override
 
virtual void showPixels (PixelController< RGB_ORDER, LANES, MASK > &pixels) override
 Send the LED data to the strip.
 
- Public Member Functions inherited from CPixelLEDController< RGB_ORDER, WS2812Controller800Khz< DATA_PIN, RGB >::LANES_VALUE, WS2812Controller800Khz< DATA_PIN, RGB >::MASK_VALUE >
 CPixelLEDController ()
 
int lanes () override
 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_IF_NOT_AVR ~CLEDController ()
 
void clearLedDataInternal (int nLeds=-1)
 Zero out the LED data managed by this controller.
 
VIRTUAL_IF_NOT_AVR void clearLeds (int nLeds=-1)
 Clear out/zero out the given number of LEDs.
 
CRGB getAdjustment (uint8_t scale)
 Get the combined brightness/color adjustment for this controller.
 
ColorAdjustment getAdjustmentData (uint8_t brightness)
 
CRGB getCorrection ()
 Get the correction value used by this controller.
 
uint8_t getDither ()
 Get the dithering option currently set for this controller.
 
bool getEnabled ()
 
virtual uint16_t getMaxRefreshRate () const
 Gets the maximum possible refresh rate of the strip.
 
Rgbw getRgbw () const
 
CRGB getTemperature ()
 Get the color temperature, aka white point, for this controller.
 
CRGBleds ()
 Pointer to the CRGB array for this controller.
 
CLEDControllernext ()
 Get the next controller in the linked list after this one.
 
CRGBoperator[] (int x)
 Reference to the n'th LED managed by the 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.
 
CLEDControllersetDither (uint8_t ditherMode=BINARY_DITHER)
 Set the dithering mode for this controller to use.
 
void setEnabled (bool enabled)
 
CLEDControllersetLeds (CRGB *data, int nLeds)
 Set the default array of LEDs to be used by this controller.
 
CLEDControllersetRgbw (const Rgbw &arg=RgbwDefault::value())
 
CLEDControllersetScreenMap (const fl::ScreenMap &map)
 
CLEDControllersetScreenMap (const fl::XYMap &map)
 
CLEDControllersetScreenMap (uint16_t width, uint16_t height)
 
CLEDControllersetTemperature (ColorTemperature temperature)
 Set the color temperature, aka white point, for this controller.
 
CLEDControllersetTemperature (CRGB temperature)
 Set the color temperature, aka white point, for this controller.
 
void showColorInternal (const struct CRGB &data, int nLeds, uint8_t brightness)
 
void showColorInternal (const struct CRGB &data, uint8_t brightness)
 
void showInternal (const struct CRGB *data, int nLeds, uint8_t brightness)
 
VIRTUAL_IF_NOT_AVR void showLeds (uint8_t brightness)
 
void showLedsInternal (uint8_t brightness)
 Write the data to the LEDs managed by this controller.
 
virtual int size ()
 How many LEDs does this controller manage?
 
- Static Public Member Functions inherited from CLEDController
static CLEDControllerhead ()
 Get the first LED controller in the linked list of controllers.
 
- Public Attributes inherited from CLEDController
Rgbw mRgbMode = RgbwInvalid::value()
 
- Static Public Attributes inherited from WS2816Controller< DATA_PIN, RGB_ORDER >
static const int LANES
 
static const uint32_t MASK
 
- Static Public Attributes inherited from CPixelLEDController< RGB_ORDER, WS2812Controller800Khz< DATA_PIN, RGB >::LANES_VALUE, WS2812Controller800Khz< DATA_PIN, RGB >::MASK_VALUE >
static const int LANES_VALUE
 The number of lanes for this controller.
 
static const uint32_t MASK_VALUE
 The mask for the lanes for this controller.
 
static const EOrder RGB_ORDER_VALUE
 The RGB ordering for this controller.
 
- Protected Member Functions inherited from CPixelLEDController< RGB_ORDER, WS2812Controller800Khz< DATA_PIN, RGB >::LANES_VALUE, WS2812Controller800Khz< DATA_PIN, RGB >::MASK_VALUE >
virtual void show (const struct CRGB *data, int nLeds, uint8_t brightness) override
 Write the passed in RGB data out to the LEDs managed by this controller.
 
virtual void showColor (const CRGB &data, int nLeds, uint8_t brightness) override
 Set all the LEDs on the controller to a given color.
 
- Protected Attributes inherited from CLEDController
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()
 
CRGBm_Data
 pointer to the LED data used by this controller
 
EDitherMode m_DitherMode
 the current dither mode of the controller
 
bool m_enabled = true
 
int m_nLeds
 the number of LEDs in the LED data array
 
CLEDControllerm_pNext
 pointer to the next LED controller in the linked list
 
- 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
 

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