Theo Bestenlehner / TinyBitmap
Revision:
2:1cc49c9c552e
Parent:
0:f068fae80257
Child:
3:457eaa2c6ed5
diff -r e52881eae197 -r 1cc49c9c552e TinyBitmap.h
--- a/TinyBitmap.h	Wed Aug 02 09:50:46 2017 +0000
+++ b/TinyBitmap.h	Wed Aug 02 10:05:23 2017 +0000
@@ -19,14 +19,14 @@
     char Bit7;
     
 public:
-    TinyBitmap(int width, int height, int commandbytes = 0, int bitmaplayout = 0x00);
+    TinyBitmap(int width, int height, int commandbytes = 0, int bitmaplayout = 0x00);//Constructor; creates a bitmap-handler with the given size and layout, can also leave some space for command-bytes to control a display. The bitmap (char[]) itself has to be created seperately.
 
-    void DrawPixel(char *framebuffer, int x, int y);
-    void DrawLine(char *framebuffer, int x1, int y1, int x2, int y2);
-    void DrawCircle(char *framebuffer, int x, int y, int radius);
-    void DrawRectangle(char *framebuffer, int x1, int y1, int x2, int y2);
-    void DrawLineDirection(char *framebuffer, int x, int y, int degree, int lenght);
-    void DrawText(char *framebuffer, int x, int y, char *CharArray, bool UseLargeFont = false);
-    void ClearScreen(char *framebuffer);
+    void DrawPixel(char *framebuffer, int x, int y); //Draws a single pixel
+    void DrawLine(char *framebuffer, int x1, int y1, int x2, int y2);//Draws a line between two points
+    void DrawCircle(char *framebuffer, int x, int y, int radius);//Draws a circle
+    void DrawRectangle(char *framebuffer, int x1, int y1, int x2, int y2); //Draws a rectangle. The coordinates are the opposite corners
+    void DrawLineDirection(char *framebuffer, int x, int y, int degree, int lenght); //Draws a line from a point into a direction with a given length. 0° is from the starting point to the right.
+    void DrawText(char *framebuffer, int x, int y, char *CharArray, bool UseLargeFont = false); //Draws basic text in two different sizes on the given location.
+    void ClearScreen(char *framebuffer); //Clears the content of the bitmap to zeros
 };
 #endif
\ No newline at end of file