Jack Cripps / N5110

Library for interfacing to Nokia 5110 LCD display (as found on the SparkFun website).

Fork of N5110 by Craig Evans

Bitmap.h@44:cd9bc22f656d, 2017-05-03 (annotated)

Committer:
JackCripps
Date:
Wed May 03 12:52:37 2017 +0000
Revision:
44:cd9bc22f656d
Parent:
40:c9262294f2e1 
Added getBrightness function and flashing string function

Who changed what in which revision?

UserRevisionLine numberNew contents of line
valavanisalex 38:92fad278c2c3 1 #ifndef BITMAP_H
valavanisalex 38:92fad278c2c3 2 #define BITMAP_H
valavanisalex 38:92fad278c2c3 3
valavanisalex 38:92fad278c2c3 4 #include <vector>
valavanisalex 38:92fad278c2c3 5
valavanisalex 40:c9262294f2e1 6 // Forward declarations
valavanisalex 40:c9262294f2e1 7 class N5110;
valavanisalex 40:c9262294f2e1 8
valavanisalex 38:92fad278c2c3 9 /**
valavanisalex 40:c9262294f2e1 10 * @brief A black & white bitmap that can be rendered on an N5110 screen
valavanisalex 40:c9262294f2e1 11 * @author Alex Valavanis <a.valavanis@leeds.ac.uk>
valavanisalex 40:c9262294f2e1 12 *
JackCripps 44:cd9bc22f656d 13 * @detail Slight modification by Jack Cripps to deal with transparency issue
JackCripps 44:cd9bc22f656d 14 *
valavanisalex 40:c9262294f2e1 15 * @code
valavanisalex 40:c9262294f2e1 16 // First declare the pixel map data using '1' for black,
JackCripps 44:cd9bc22f656d 17 // or '0' for white pixels, or '2' for transparent
valavanisalex 40:c9262294f2e1 18 static int sprite_data[] = {
valavanisalex 40:c9262294f2e1 19 0,0,1,0,0,
valavanisalex 40:c9262294f2e1 20 0,1,1,1,0,
valavanisalex 40:c9262294f2e1 21 0,0,1,0,0,
valavanisalex 40:c9262294f2e1 22 0,1,1,1,0,
valavanisalex 40:c9262294f2e1 23 1,1,1,1,1,
valavanisalex 40:c9262294f2e1 24 1,1,1,1,1,
valavanisalex 40:c9262294f2e1 25 1,1,0,1,1,
valavanisalex 40:c9262294f2e1 26 1,1,0,1,1
valavanisalex 40:c9262294f2e1 27 };
valavanisalex 40:c9262294f2e1 28
valavanisalex 40:c9262294f2e1 29 // Instantiate the Bitmap object using the data above
valavanisalex 40:c9262294f2e1 30 Bitmap sprite(sprite_data, 8, 5); // Specify rows and columns in sprite
valavanisalex 40:c9262294f2e1 31
valavanisalex 40:c9262294f2e1 32 // We can render the bitmap wherever we want on the screen
valavanisalex 40:c9262294f2e1 33 sprite.render(lcd, 20, 6); // x and y locations for rendering
valavanisalex 40:c9262294f2e1 34 sprite.render(lcd, 30, 10);
valavanisalex 40:c9262294f2e1 35
valavanisalex 40:c9262294f2e1 36 // We can also print its values to the terminal
valavanisalex 40:c9262294f2e1 37 sprite.print();
valavanisalex 40:c9262294f2e1 38 * @endcode
valavanisalex 38:92fad278c2c3 39 */
valavanisalex 38:92fad278c2c3 40 class Bitmap
valavanisalex 38:92fad278c2c3 41 {
valavanisalex 38:92fad278c2c3 42 private:
valavanisalex 38:92fad278c2c3 43 /**
valavanisalex 38:92fad278c2c3 44 * @brief The contents of the drawing, with pixels stored in row-major order
JackCripps 44:cd9bc22f656d 45 * @details '1' represents a black pixel; '0' represents white, '2' transparent
valavanisalex 38:92fad278c2c3 46 */
valavanisalex 38:92fad278c2c3 47 std::vector<int> _contents;
valavanisalex 38:92fad278c2c3 48
valavanisalex 38:92fad278c2c3 49 unsigned int _height; ///< The height of the drawing in pixels
valavanisalex 38:92fad278c2c3 50 unsigned int _width; ///< The width of the drawing in pixels
valavanisalex 38:92fad278c2c3 51
valavanisalex 38:92fad278c2c3 52 public:
valavanisalex 40:c9262294f2e1 53 Bitmap(int const *contents,
valavanisalex 40:c9262294f2e1 54 unsigned int const height,
valavanisalex 40:c9262294f2e1 55 unsigned int const width);
valavanisalex 38:92fad278c2c3 56
valavanisalex 38:92fad278c2c3 57 int get_pixel(unsigned int const row,
valavanisalex 38:92fad278c2c3 58 unsigned int const column) const;
valavanisalex 40:c9262294f2e1 59
valavanisalex 40:c9262294f2e1 60 void print() const;
valavanisalex 40:c9262294f2e1 61
valavanisalex 40:c9262294f2e1 62 void render(N5110 &lcd,
valavanisalex 40:c9262294f2e1 63 unsigned int const x0,
valavanisalex 40:c9262294f2e1 64 unsigned int const y0) const;
valavanisalex 38:92fad278c2c3 65 };
valavanisalex 38:92fad278c2c3 66
valavanisalex 40:c9262294f2e1 67 #endif // BITMAP_H