aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0988e6e..dbc90c0 100644
--- a/README.md
+++ b/README.md
@@ -76,4 +76,30 @@ make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_HIFI"
76make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI" 76make run ROM_SRC=roms/audio.rom CONFIG="-DAUDIO_LOFI"
77``` 77```
78 78
79### Text layer
80
81When writing text to the screen (for example using the console device) the text
82will be drawn by default on the foreground layer. This can be controlled by
83setting the `TEXT_MODE` option to 0 for foreground mode or 1 for background
84mode.
85
86```
87make run CONFIG="-DTEXT_MODE=1"
88```
89
90### Performance metrics
91
92To enable profiling, the `PROF_ENABLE` macro can be used. This will display the
93cycle count for input handling (INPUT), loop uxn evaluation (EVAL), screen
94buffer flip (FLIP) and audio mixing (MIX). If `PROF_ENABLE` is set to 0, the
95current frame numbers will be displayed, if set to 1, the maximum cycle count
96for each section will be used instead. Enabling profiling can have a small
97performance impact, so these numbers may not be 100% accurate, but should give
98a good indication. Using `PROF_SHOW_X` and `PROF_SHOW_Y` we can control at which
99tile the cycle count text will be located.
100
101```
102make run CONFIG="-DPROF_ENABLE=0 -DPROF_SHOW_Y=8 -DPROF_SHOW_X=8"
103```
104
79[noodle]: https://wiki.xxiivv.com/site/noodle.html 105[noodle]: https://wiki.xxiivv.com/site/noodle.html