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_ORDER	the rgb ordering for the LEDs (e.g. what order red, green, and blue data is written out in)
LANES	how many parallel lanes of output to write
MASK	bitmask for the output lanes

Definition at line 26 of file cpixel_ledcontroller.h.

#include <cpixel_ledcontroller.h>

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

Public Member Functions
virtual void	showPixels (PixelController< RGB_ORDER, LANES, MASK > &pixels)=0
	Send the LED data to the strip.

int	lanes () override
	Get the number of lanes of the Controller.

Public Member Functions inherited from CLEDController
CLEDController &	setRgbw (const Rgbw &arg=RgbwDefault::value())

void	setEnabled (bool enabled)

	CLEDController ()
	Create an led controller object, add it to the chain of controllers.

Rgbw	getRgbw () const

virtual void	init ()=0
	Initialize the LED controller.

VIRTUAL_IF_NOT_AVR void	clearLeds (int nLeds=-1)
	Clear out/zero out the given number of LEDs.

VIRTUAL_IF_NOT_AVR void	showLeds (uint8_t brightness)

ColorAdjustment	getAdjustmentData (uint8_t brightness)

void	showInternal (const struct CRGB *data, int nLeds, uint8_t brightness)

void	showColorInternal (const struct CRGB &data, int nLeds, uint8_t brightness)

void	showLedsInternal (uint8_t brightness)
	Write the data to the LEDs managed by this controller.

void	showColorInternal (const struct CRGB &data, uint8_t brightness)

CLEDController *	next ()
	Get the next controller in the linked list after this one.

CLEDController &	setLeds (CRGB *data, int nLeds)
	Set the default array of LEDs to be used by this controller.

void	clearLedDataInternal (int nLeds=-1)
	Zero out the LED data managed by this controller.

virtual int	size ()
	How many LEDs does this controller manage?

CRGB *	leds ()
	Pointer to the CRGB array for this controller.

CRGB &	operator[] (int x)
	Reference to the n'th LED managed by the controller.

CLEDController &	setDither (uint8_t ditherMode=BINARY_DITHER)
	Set the dithering mode for this controller to use.

CLEDController &	setScreenMap (const fl::XYMap &map)

CLEDController &	setScreenMap (const fl::ScreenMap &map)

CLEDController &	setScreenMap (uint16_t width, uint16_t height)

uint8_t	getDither ()
	Get the dithering option currently set for this controller.

virtual void *	beginShowLeds ()

virtual void	endShowLeds (void *data)

CLEDController &	setCorrection (CRGB correction)
	The color corrction to use for this controller, expressed as a CRGB object.

CLEDController &	setCorrection (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.

CLEDController &	setTemperature (CRGB temperature)
	Set the color temperature, aka white point, for this controller.

CLEDController &	setTemperature (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.

Static Public Attributes
static const EOrder	RGB_ORDER_VALUE = RGB_ORDER
	The RGB ordering for this controller.

static const int	LANES_VALUE = LANES
	The number of lanes for this controller.

static const uint32_t	MASK_VALUE = MASK
	The mask for the lanes for this controller.

Protected Member Functions
virtual void	showColor (const CRGB &data, int nLeds, uint8_t brightness) override
	Set all the LEDs on the controller to a given color.

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.

Additional Inherited Members
Static Public Member Functions inherited from CLEDController
static CLEDController *	head ()
	Get the first LED controller in the linked list of controllers.

Public Attributes inherited from CLEDController
Rgbw	mRgbMode = RgbwInvalid::value()

Protected Attributes inherited from CLEDController
CRGB *	m_Data
	pointer to the LED data used by this controller

CLEDController *	m_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

bool	m_enabled = true

int	m_nLeds
	the number of LEDs in the LED data array

Static Protected Attributes inherited from CLEDController
static CLEDController *	m_pHead = NULL
	pointer to the first LED controller in the linked list

static CLEDController *	m_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 61 of file cpixel_ledcontroller.h.

Member Function Documentation

◆ lanes()

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

int CPixelLEDController< RGB_ORDER, LANES, MASK >::lanes ( )

inlineoverridevirtual

Get the number of lanes of the Controller.

Returns: LANES from template

Reimplemented from CLEDController.

Definition at line 69 of file cpixel_ledcontroller.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,
		uint8_t	brightness )

inlineoverrideprotectedvirtual

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

Parameters

data	the RGB data to write out to the strip
nLeds	the number of LEDs being written out
scale_pre_mixed	the RGB scaling of color adjustment + global brightness to apply to each LED (in RGB8 mode).

Implements CLEDController.

Definition at line 47 of file cpixel_ledcontroller.h.

◆ showColor()

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

virtual void CPixelLEDController< RGB_ORDER, LANES, MASK >::showColor	(	const CRGB &	data,
		int	nLeds,
		uint8_t	brightness )

inlineoverrideprotectedvirtual

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

Parameters

data	the CRGB color to set the LEDs to
nLeds	the number of LEDs to set to this color
scale_pre_mixed	the RGB scaling of color adjustment + global brightness to apply to each LED (in RGB8 mode).

Implements CLEDController.

Definition at line 34 of file cpixel_ledcontroller.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 )

pure virtual

Send the LED data to the strip.

Parameters

pixels the PixelController object for the LED data

Implemented in RGBWEmulatedController< CONTROLLER, RGB_ORDER >.

Member Data Documentation

◆ LANES_VALUE

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

const int CPixelLEDController< RGB_ORDER, LANES, MASK >::LANES_VALUE = LANES

static

The number of lanes for this controller.

Definition at line 59 of file cpixel_ledcontroller.h.

◆ MASK_VALUE

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

const uint32_t CPixelLEDController< RGB_ORDER, LANES, MASK >::MASK_VALUE = MASK

static

The mask for the lanes for this controller.

Definition at line 60 of file cpixel_ledcontroller.h.

◆ RGB_ORDER_VALUE

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

const EOrder CPixelLEDController< RGB_ORDER, LANES, MASK >::RGB_ORDER_VALUE = RGB_ORDER

static

The RGB ordering for this controller.

Definition at line 58 of file cpixel_ledcontroller.h.

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

/home/runner/work/FastLED/FastLED/src/cpixel_ledcontroller.h

Detailed Description

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ CPixelLEDController()

Member Function Documentation

◆ lanes()

◆ show()

◆ showColor()

◆ showPixels()

Member Data Documentation

◆ LANES_VALUE

◆ MASK_VALUE

◆ RGB_ORDER_VALUE