diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h index b6097f7d7e2ec9095add077a3f0a3d5bec5ebe36..295e4ddf2816e910f601993a623ad87961002a4e 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();