Skip to content
Snippets Groups Projects
Verified Commit b7e210c9 authored by rahix's avatar rahix
Browse files

docs: Fixup API docs in a few places


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent 8765f08c
No related branches found
No related tags found
No related merge requests found
...@@ -280,8 +280,8 @@ API(API_LEDS_SET, void epic_leds_set(int led, uint8_t r, uint8_t g, uint8_t b)); ...@@ -280,8 +280,8 @@ API(API_LEDS_SET, void epic_leds_set(int led, uint8_t r, uint8_t g, uint8_t b));
API(API_STREAM_READ, int epic_stream_read(int sd, void *buf, size_t count)); API(API_STREAM_READ, int epic_stream_read(int sd, void *buf, size_t count));
/** /**
* Misc * Vibration Motor
* ==== * ===============
*/ */
/** /**
...@@ -303,11 +303,14 @@ API(API_VIBRA_VIBRATE, void epic_vibra_vibrate(int millis)); ...@@ -303,11 +303,14 @@ API(API_VIBRA_VIBRATE, void epic_vibra_vibrate(int millis));
* ======= * =======
* The card10 has an LCD screen that can be accessed from user code. * The card10 has an LCD screen that can be accessed from user code.
* *
* There are two main ways to access the display: * There are two ways to access the display:
* - immediate mode, where you ask epicardium to draw shapes and text for you *
* - framebuffer mode, where you provide epicardium with a memory range where * - *immediate mode*, where you ask Epicardium to draw shapes and text for
* you already drew graphics whichever way you wanted, and epicardium will * you. Most functions in this subsection are related to *immediate mode*.
* copy them to the display. * - *framebuffer mode*, where you provide Epicardium with a memory range where
* you already drew graphics whichever way you wanted and Epicardium will
* copy them to the display. To use *framebuffer mode*, use the
* :c:func:`epic_disp_framebuffer` function.
*/ */
/** Line-Style */ /** Line-Style */
...@@ -332,16 +335,16 @@ enum disp_fillstyle { ...@@ -332,16 +335,16 @@ enum disp_fillstyle {
/** Height of display in pixels */ /** Height of display in pixels */
#define DISP_HEIGHT 80 #define DISP_HEIGHT 80
/** Raw framebuffer */
union disp_framebuffer {
/** /**
* The frambuffer stores pixels as RGB565, but byte swapped. * Framebuffer
* That is, for every (x, y) coordinate, there are two uint8_ts *
* storing 16 bits of pixel data. * The frambuffer stores pixels as RGB565, but byte swapped. That is, for every ``(x, y)`` coordinate, there are two ``uint8_t``\ s storing 16 bits of pixel data.
* *
* TODO(q3k): document (x, y) in relation to chirality * .. todo::
* *
* **Example: fill framebuffer with red**: * Document (x, y) in relation to chirality.
*
* **Example**: Fill framebuffer with red
* *
* .. code-block:: cpp * .. code-block:: cpp
* *
...@@ -354,9 +357,11 @@ union disp_framebuffer { ...@@ -354,9 +357,11 @@ union disp_framebuffer {
* } * }
* } * }
* epic_disp_framebuffer(&fb); * epic_disp_framebuffer(&fb);
*
*/ */
union disp_framebuffer {
/** Coordinate based access (as shown in the example above). */
uint8_t fb[DISP_HEIGHT][DISP_WIDTH][2]; uint8_t fb[DISP_HEIGHT][DISP_WIDTH][2];
/** Raw byte-indexed access. */
uint8_t raw[DISP_HEIGHT*DISP_WIDTH*2]; uint8_t raw[DISP_HEIGHT*DISP_WIDTH*2];
}; };
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment