ELEC2645 (2018/19) / Mbed 2 deprecated el17ajf

Dependencies:   mbed

Fork of el17ajf by Angus Findlay

Committer:
el17ajf
Date:
Thu May 09 12:37:20 2019 +0000
Revision:
44:44aa01af687e
Parent:
12:beb0d7632531
Found the issue, should have fixed API docs now. (Final Submission. I have read and agreed with Statement of Academic Integrity.)

Who changed what in which revision?

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