XMap Class Reference

Detailed Description

Definition at line 28 of file xmap.h.

Public Types
enum	Type { kLinear = 0 , kReverse , kFunction , kLookUpTable }

Public Member Functions
	XMap (uint16_t length, bool is_reverse=false, uint16_t offset=0)
	XMap (const XMap &other)
XMap &	operator= (const XMap &other)
void	convertToLookUpTable ()
uint16_t	mapToIndex (uint16_t x) const
uint16_t	getLength () const
Type	getType () const

Static Public Member Functions
static XMap	constructWithUserFunction (uint16_t length, XFunction xFunction, uint16_t offset=0)
static XMap	constructWithLookUpTable (uint16_t length, const uint16_t *lookUpTable, uint16_t offset=0)

Member Enumeration Documentation

Type

enum XMap::Type

Definition at line 31 of file xmap.h.

Constructor & Destructor Documentation

XMap() [1/2]

XMap::XMap ( uint16_t length, bool is_reverse = false, uint16_t offset = 0 )

inline

Definition at line 55 of file xmap.h.

XMap() [2/2]

XMap::XMap ( const XMap & other )

inline

Definition at line 61 of file xmap.h.

Member Function Documentation

constructWithLookUpTable()

static XMap XMap::constructWithLookUpTable ( uint16_t length, const uint16_t * lookUpTable, uint16_t offset = 0 )

inlinestatic

Definition at line 47 of file xmap.h.

constructWithUserFunction()

static XMap XMap::constructWithUserFunction ( uint16_t length, XFunction xFunction, uint16_t offset = 0 )

inlinestatic

Definition at line 38 of file xmap.h.

convertToLookUpTable()

void XMap::convertToLookUpTable ( )

inline

Definition at line 83 of file xmap.h.

getLength()

uint16_t XMap::getLength ( ) const

inline

Definition at line 120 of file xmap.h.

getType()

Type XMap::getType ( ) const

inline

Definition at line 124 of file xmap.h.

mapToIndex()

uint16_t XMap::mapToIndex ( uint16_t x ) const

inline

Definition at line 98 of file xmap.h.

operator=()

XMap & XMap::operator= ( const XMap & other )

inline

Definition at line 71 of file xmap.h.

---

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

• /home/runner/work/FastLED/FastLED/src/xmap.h