Ciaran Kane / Bitmap

b

Bitmap.h@0:f2d1f9532b62, 2022-02-04 (annotated)

Committer:
ciarankane123
Date:
Fri Feb 04 23:40:27 2022 +0000
Revision:
0:f2d1f9532b62
d

Who changed what in which revision?

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