Adafruit_NeoMatrix.h

Go to the documentation of this file.

#ifndef _ADAFRUIT_NEOMATRIX_H_
#define _ADAFRUIT_NEOMATRIX_H_

#if ARDUINO >= 100
#include <Arduino.h>
#else
#include <WProgram.h>
#include <pins_arduino.h>
#endif
#include <Adafruit_GFX.h>
#include <Adafruit_NeoPixel.h>

// Matrix layout information is passed in the 'matrixType' parameter for
// each constructor (the parameter immediately following is the LED type
// from NeoPixel.h).

// These define the layout for a single 'unified' matrix (e.g. one made
// from NeoPixel strips, or a single NeoPixel shield), or for the pixels
// within each matrix of a tiled display (e.g. multiple NeoPixel shields).

#define NEO_MATRIX_TOP 0x00         
#define NEO_MATRIX_BOTTOM 0x01      
#define NEO_MATRIX_LEFT 0x00        
#define NEO_MATRIX_RIGHT 0x02       
#define NEO_MATRIX_CORNER 0x03      
#define NEO_MATRIX_ROWS 0x00        
#define NEO_MATRIX_COLUMNS 0x04     
#define NEO_MATRIX_AXIS 0x04        
#define NEO_MATRIX_PROGRESSIVE 0x00 
#define NEO_MATRIX_ZIGZAG 0x08      
#define NEO_MATRIX_SEQUENCE 0x08    

// These apply only to tiled displays (multiple matrices):

#define NEO_TILE_TOP 0x00         
#define NEO_TILE_BOTTOM 0x10      
#define NEO_TILE_LEFT 0x00        
#define NEO_TILE_RIGHT 0x20       
#define NEO_TILE_CORNER 0x30      
#define NEO_TILE_ROWS 0x00        
#define NEO_TILE_COLUMNS 0x40     
#define NEO_TILE_AXIS 0x40        
#define NEO_TILE_PROGRESSIVE 0x00 
#define NEO_TILE_ZIGZAG 0x80      
#define NEO_TILE_SEQUENCE 0x80    


class Adafruit_NeoMatrix : public Adafruit_GFX, public Adafruit_NeoPixel {

public:
  Adafruit_NeoMatrix(int w, int h, uint8_t pin = 6,
                     uint8_t matrixType = NEO_MATRIX_TOP + NEO_MATRIX_LEFT +
                                          NEO_MATRIX_ROWS,
                     neoPixelType ledType = NEO_GRB + NEO_KHZ800);

  Adafruit_NeoMatrix(uint8_t matrixW, uint8_t matrixH, uint8_t tX, uint8_t tY,
                     uint8_t pin = 6,
                     uint8_t matrixType = NEO_MATRIX_TOP + NEO_MATRIX_LEFT +
                                          NEO_MATRIX_ROWS + NEO_TILE_TOP +
                                          NEO_TILE_LEFT + NEO_TILE_ROWS,
                     neoPixelType ledType = NEO_GRB + NEO_KHZ800);

  virtual ~Adafruit_NeoMatrix() {
  } // Virtual destructor to allow better memory management

  void drawPixel(int16_t x, int16_t y, uint16_t color);

  void fillScreen(uint16_t color);

  void setPassThruColor(uint32_t c);

  void setPassThruColor(void);

  void setRemapFunction(uint16_t (*fn)(uint16_t, uint16_t));

  static uint16_t Color(uint8_t r, uint8_t g, uint8_t b);

private:
  const uint8_t type;
  const uint8_t matrixWidth, matrixHeight, tilesX, tilesY;
  uint16_t (*remapFn)(uint16_t x, uint16_t y);

  uint32_t passThruColor;
  boolean passThruFlag = false;
};

#endif // _ADAFRUIT_NEOMATRIX_H_