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