FastLED 3.9.3
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | List of all members
XYMap Class Reference

Detailed Description

Examples
NoisePlusPalette.ino.

Definition at line 39 of file xymap.h.

Public Types

enum  XyMapType { kSeperentine = 0 , kLineByLine , kFunction , kLookUpTable }
 

Public Member Functions

 XYMap (uint16_t width, uint16_t height, bool is_serpentine=true, uint16_t offset=0)
 
 XYMap (const XYMap &other)=default
 
ScreenMap toScreenMap () const
 
void mapPixels (const CRGB *input, CRGB *output) const
 
void convertToLookUpTable ()
 
void setRectangularGrid ()
 
uint16_t mapToIndex (uint16_t x, uint16_t y) const
 
uint16_t getWidth () const
 
uint16_t getHeight () const
 
uint16_t getTotal () const
 
XyMapType getType () const
 

Static Public Member Functions

static XYMap constructWithUserFunction (uint16_t width, uint16_t height, XYFunction xyFunction, uint16_t offset=0)
 
static XYMap constructRectangularGrid (uint16_t width, uint16_t height, uint16_t offset=0)
 
static XYMap constructWithLookUpTable (uint16_t width, uint16_t height, const uint16_t *lookUpTable, uint16_t offset=0)
 

Member Enumeration Documentation

◆ XyMapType

enum XYMap::XyMapType

Definition at line 41 of file xymap.h.

Constructor & Destructor Documentation

◆ XYMap()

XYMap::XYMap ( uint16_t width,
uint16_t height,
bool is_serpentine = true,
uint16_t offset = 0 )
inline

Definition at line 69 of file xymap.h.

Member Function Documentation

◆ constructRectangularGrid()

static XYMap XYMap::constructRectangularGrid ( uint16_t width,
uint16_t height,
uint16_t offset = 0 )
inlinestatic

Definition at line 51 of file xymap.h.

◆ constructWithLookUpTable()

static XYMap XYMap::constructWithLookUpTable ( uint16_t width,
uint16_t height,
const uint16_t * lookUpTable,
uint16_t offset = 0 )
inlinestatic

Definition at line 57 of file xymap.h.

◆ constructWithUserFunction()

static XYMap XYMap::constructWithUserFunction ( uint16_t width,
uint16_t height,
XYFunction xyFunction,
uint16_t offset = 0 )
inlinestatic

Definition at line 43 of file xymap.h.

◆ convertToLookUpTable()

void XYMap::convertToLookUpTable ( )
inline

Definition at line 87 of file xymap.h.

◆ getHeight()

uint16_t XYMap::getHeight ( ) const
inline

Definition at line 134 of file xymap.h.

◆ getTotal()

uint16_t XYMap::getTotal ( ) const
inline

Definition at line 135 of file xymap.h.

◆ getType()

XyMapType XYMap::getType ( ) const
inline

Definition at line 136 of file xymap.h.

◆ getWidth()

uint16_t XYMap::getWidth ( ) const
inline

Definition at line 133 of file xymap.h.

◆ mapPixels()

void XYMap::mapPixels ( const CRGB * input,
CRGB * output ) const
inline

Definition at line 77 of file xymap.h.

◆ mapToIndex()

uint16_t XYMap::mapToIndex ( uint16_t x,
uint16_t y ) const
inline

Definition at line 108 of file xymap.h.

◆ setRectangularGrid()

void XYMap::setRectangularGrid ( )
inline

Definition at line 102 of file xymap.h.

◆ toScreenMap()

ScreenMap XYMap::toScreenMap ( ) const

Definition at line 12 of file xymap.cpp.

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