diff options
| author | Daniel Friesel <derf@finalrewind.org> | 2016-01-31 18:44:23 +0100 |
|---|---|---|
| committer | Daniel Friesel <derf@finalrewind.org> | 2016-01-31 18:44:23 +0100 |
| commit | d9f650fc6e723dabeccc800c16ca4d809f4bb94a (patch) | |
| tree | 8680c16baba6b863c63e1be5fd1e183e9ff08f17 /src/display.h | |
| parent | 631ccf9ba6924d5af077bf31ef84f1212b471f3d (diff) | |
document Modem and System classes
Diffstat (limited to 'src/display.h')
| -rw-r--r-- | src/display.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/src/display.h b/src/display.h index c7cf5f8..e382a25 100644 --- a/src/display.h +++ b/src/display.h @@ -4,6 +4,10 @@ #include <util/delay.h> #include <stdlib.h> +/** + * Describes the type of an animation object. The Storage class reserves four + * bits for the animation type, so up to 16 types are supported. + */ enum class AnimationType : uint8_t { TEXT = 1, FRAMES = 2 @@ -26,7 +30,7 @@ struct animation { uint8_t length; /** - * * If mode == TEXT: Text scroll speed in columns per TODO + * * If mode == AnimationType::TEXT: Text scroll speed in columns per TODO * * If mode == FRAMES: Frames per TODO */ uint8_t speed; @@ -42,7 +46,7 @@ struct animation { uint8_t direction; /** - * * If mode == TEXT: character array pointing to the + * * If mode == AnimationType::TEXT: character array pointing to the * animation text in standard ASCII format (+ special font chars) * * If mode == FRAMES: Frame array. Each element encodes * a display column (starting with the leftmost one), each group of |