diff options
| author | Nick Brassel <nick@tzarc.org> | 2022-11-09 02:47:07 +1100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-08 15:47:07 +0000 |
| commit | 9daf77b59373196839d022d621f015e074aa427a (patch) | |
| tree | a481197569920ab942155131613bff5e4a982b0b /docs/quantum_painter.md | |
| parent | bb0856d231a8de244e3057dd095d11e9298414f3 (diff) | |
Add raw output option for QGF/QFF files. (#18998)
Diffstat (limited to 'docs/quantum_painter.md')
| -rw-r--r-- | docs/quantum_painter.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/quantum_painter.md b/docs/quantum_painter.md index ed9cec171b..781b467a45 100644 --- a/docs/quantum_painter.md +++ b/docs/quantum_painter.md | |||
| @@ -55,10 +55,11 @@ This command converts images to a format usable by QMK, i.e. the QGF File Format | |||
| 55 | **Usage**: | 55 | **Usage**: |
| 56 | 56 | ||
| 57 | ``` | 57 | ``` |
| 58 | usage: qmk painter-convert-graphics [-h] [-d] [-r] -f FORMAT [-o OUTPUT] -i INPUT [-v] | 58 | usage: qmk painter-convert-graphics [-h] [-w] [-d] [-r] -f FORMAT [-o OUTPUT] -i INPUT [-v] |
| 59 | 59 | ||
| 60 | optional arguments: | 60 | options: |
| 61 | -h, --help show this help message and exit | 61 | -h, --help show this help message and exit |
| 62 | -w, --raw Writes out the QGF file as raw data instead of c/h combo. | ||
| 62 | -d, --no-deltas Disables the use of delta frames when encoding animations. | 63 | -d, --no-deltas Disables the use of delta frames when encoding animations. |
| 63 | -r, --no-rle Disables the use of RLE when encoding images. | 64 | -r, --no-rle Disables the use of RLE when encoding images. |
| 64 | -f FORMAT, --format FORMAT | 65 | -f FORMAT, --format FORMAT |
| @@ -146,10 +147,11 @@ This command expects an image that conforms to the following format: | |||
| 146 | **Usage**: | 147 | **Usage**: |
| 147 | 148 | ||
| 148 | ``` | 149 | ``` |
| 149 | usage: qmk painter-convert-font-image [-h] [-r] -f FORMAT [-u UNICODE_GLYPHS] [-n] [-o OUTPUT] [-i INPUT] | 150 | usage: qmk painter-convert-font-image [-h] [-w] [-r] -f FORMAT [-u UNICODE_GLYPHS] [-n] [-o OUTPUT] [-i INPUT] |
| 150 | 151 | ||
| 151 | optional arguments: | 152 | options: |
| 152 | -h, --help show this help message and exit | 153 | -h, --help show this help message and exit |
| 154 | -w, --raw Writes out the QFF file as raw data instead of c/h combo. | ||
| 153 | -r, --no-rle Disable the use of RLE to minimise converted image size. | 155 | -r, --no-rle Disable the use of RLE to minimise converted image size. |
| 154 | -f FORMAT, --format FORMAT | 156 | -f FORMAT, --format FORMAT |
| 155 | Output format, valid types: pal256, pal16, pal4, pal2, mono256, mono16, mono4, mono2 | 157 | Output format, valid types: pal256, pal16, pal4, pal2, mono256, mono16, mono4, mono2 |
