From dfaa104fb0a90a09cf027b4f52d1063516cc28c5 Mon Sep 17 00:00:00 2001
From: Sergiusz Bazanski <q3k@q3k.org>
Date: Sun, 28 Jul 2019 22:07:25 +0200
Subject: [PATCH] epicardium: fix disp_framebuffer comment, add chirality TODO
---
epicardium/epicardium.h | 10 ++++++----
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index b6097f7d..295e4ddf 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -279,17 +279,19 @@ struct disp_framebuffer {
* That is, for every (x, y) coordinate, there are two uint8_ts
* storing 16 bits of pixel data.
*
+ * TODO(q3k): document (x, y) in relation to chirality
+ *
* **Example: fill framebuffer with red**:
*
* .. code-block:: cpp
*
- * struct disp_framebuffer **fb;
- * epic_disp_framebuffer(fb);
+ * struct disp_framebuffer *fb;
+ * epic_disp_framebuffer(&fb);
* uint16_t red = 0b1111100000000000;
* for (int y = 0; y < DISP_HEIGHT; y++) {
* for (int x = 0; x < DISP_WIDTH; x++) {
- * (*fb)->fb[y][x][0] = red >> 8;
- * (*fb)->fb[y][x][1] = red & 0xFF;
+ * fb->fb[y][x][0] = red >> 8;
+ * fb->fb[y][x][1] = red & 0xFF;
* }
* }
* epic_disp_update();
--
GitLab