diff options
| author | Pablo MartÃnez <58857054+elpekenin@users.noreply.github.com> | 2025-05-22 15:31:15 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-05-22 23:31:15 +1000 |
| commit | 955809bd5aee8b1444595b450eeeef1f42799995 (patch) | |
| tree | 08da1f696605925286f681a2b738fa5f35cd0386 /docs | |
| parent | fa24b0fcce2c5f3330f2d798c3caf91a130babdb (diff) | |
Add `compiler_support.h` (#25274)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/quantum_painter_qff.md | 4 | ||||
| -rw-r--r-- | docs/quantum_painter_qgf.md | 8 |
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/quantum_painter_qff.md b/docs/quantum_painter_qff.md index 3695be2c5b..198d87384a 100644 --- a/docs/quantum_painter_qff.md +++ b/docs/quantum_painter_qff.md | |||
| @@ -44,7 +44,7 @@ typedef struct __attribute__((packed)) qff_font_descriptor_v1_t { | |||
| 44 | uint8_t compression_scheme; // compression scheme, see below. | 44 | uint8_t compression_scheme; // compression scheme, see below. |
| 45 | uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) | 45 | uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) |
| 46 | } qff_font_descriptor_v1_t; | 46 | } qff_font_descriptor_v1_t; |
| 47 | // _Static_assert(sizeof(qff_font_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 20), "qff_font_descriptor_v1_t must be 25 bytes in v1 of QFF"); | 47 | // STATIC_ASSERT(sizeof(qff_font_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 20), "qff_font_descriptor_v1_t must be 25 bytes in v1 of QFF"); |
| 48 | ``` | 48 | ``` |
| 49 | 49 | ||
| 50 | The values for `format`, `flags`, `compression_scheme`, and `transparency_index` match [QGF's frame descriptor block](quantum_painter_qgf#qgf-frame-descriptor), with the exception that the `delta` flag is ignored by QFF. | 50 | The values for `format`, `flags`, `compression_scheme`, and `transparency_index` match [QGF's frame descriptor block](quantum_painter_qgf#qgf-frame-descriptor), with the exception that the `delta` flag is ignored by QFF. |
| @@ -66,7 +66,7 @@ typedef struct __attribute__((packed)) qff_ascii_glyph_table_v1_t { | |||
| 66 | qgf_block_header_v1_t header; // = { .type_id = 0x01, .neg_type_id = (~0x01), .length = 285 } | 66 | qgf_block_header_v1_t header; // = { .type_id = 0x01, .neg_type_id = (~0x01), .length = 285 } |
| 67 | uint24_t glyph[95]; // 95 glyphs, 0x20..0x7E, see bits/masks above for values | 67 | uint24_t glyph[95]; // 95 glyphs, 0x20..0x7E, see bits/masks above for values |
| 68 | } qff_ascii_glyph_table_v1_t; | 68 | } qff_ascii_glyph_table_v1_t; |
| 69 | // _Static_assert(sizeof(qff_ascii_glyph_table_v1_t) == (sizeof(qgf_block_header_v1_t) + 285), "qff_ascii_glyph_table_v1_t must be 290 bytes in v1 of QFF"); | 69 | // STATIC_ASSERT(sizeof(qff_ascii_glyph_table_v1_t) == (sizeof(qgf_block_header_v1_t) + 285), "qff_ascii_glyph_table_v1_t must be 290 bytes in v1 of QFF"); |
| 70 | ``` | 70 | ``` |
| 71 | 71 | ||
| 72 | ## Unicode glyph table {#qff-unicode-table} | 72 | ## Unicode glyph table {#qff-unicode-table} |
diff --git a/docs/quantum_painter_qgf.md b/docs/quantum_painter_qgf.md index 700b78d105..dd525e4b83 100644 --- a/docs/quantum_painter_qgf.md +++ b/docs/quantum_painter_qgf.md | |||
| @@ -32,7 +32,7 @@ typedef struct __attribute__((packed)) qgf_block_header_v1_t { | |||
| 32 | uint8_t neg_type_id; // Negated type ID, used for detecting parsing errors | 32 | uint8_t neg_type_id; // Negated type ID, used for detecting parsing errors |
| 33 | uint24_t length; // 24-bit blob length, allowing for block sizes of a maximum of 16MB | 33 | uint24_t length; // 24-bit blob length, allowing for block sizes of a maximum of 16MB |
| 34 | } qgf_block_header_v1_t; | 34 | } qgf_block_header_v1_t; |
| 35 | // _Static_assert(sizeof(qgf_block_header_v1_t) == 5, "qgf_block_header_v1_t must be 5 bytes in v1 of QGF"); | 35 | // STATIC_ASSERT(sizeof(qgf_block_header_v1_t) == 5, "qgf_block_header_v1_t must be 5 bytes in v1 of QGF"); |
| 36 | ``` | 36 | ``` |
| 37 | The _length_ describes the number of octets in the data following the block header -- a block header may specify a _length_ of `0` if no blob is specified. | 37 | The _length_ describes the number of octets in the data following the block header -- a block header may specify a _length_ of `0` if no blob is specified. |
| 38 | 38 | ||
| @@ -56,7 +56,7 @@ typedef struct __attribute__((packed)) qgf_graphics_descriptor_v1_t { | |||
| 56 | uint16_t image_height; // in pixels | 56 | uint16_t image_height; // in pixels |
| 57 | uint16_t frame_count; // minimum of 1 | 57 | uint16_t frame_count; // minimum of 1 |
| 58 | } qgf_graphics_descriptor_v1_t; | 58 | } qgf_graphics_descriptor_v1_t; |
| 59 | // _Static_assert(sizeof(qgf_graphics_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 18), "qgf_graphics_descriptor_v1_t must be 23 bytes in v1 of QGF"); | 59 | // STATIC_ASSERT(sizeof(qgf_graphics_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 18), "qgf_graphics_descriptor_v1_t must be 23 bytes in v1 of QGF"); |
| 60 | ``` | 60 | ``` |
| 61 | 61 | ||
| 62 | ## Frame offset block {#qgf-frame-offset-descriptor} | 62 | ## Frame offset block {#qgf-frame-offset-descriptor} |
| @@ -95,7 +95,7 @@ typedef struct __attribute__((packed)) qgf_frame_v1_t { | |||
| 95 | uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) | 95 | uint8_t transparency_index; // palette index used for transparent pixels (not yet implemented) |
| 96 | uint16_t delay; // frame delay time for animations (in units of milliseconds) | 96 | uint16_t delay; // frame delay time for animations (in units of milliseconds) |
| 97 | } qgf_frame_v1_t; | 97 | } qgf_frame_v1_t; |
| 98 | // _Static_assert(sizeof(qgf_frame_v1_t) == (sizeof(qgf_block_header_v1_t) + 6), "qgf_frame_v1_t must be 11 bytes in v1 of QGF"); | 98 | // STATIC_ASSERT(sizeof(qgf_frame_v1_t) == (sizeof(qgf_block_header_v1_t) + 6), "qgf_frame_v1_t must be 11 bytes in v1 of QGF"); |
| 99 | ``` | 99 | ``` |
| 100 | 100 | ||
| 101 | If this frame is grayscale, the _frame descriptor block_ (or _frame delta block_ if flags denote a delta frame) is immediately followed by this frame's corresponding _frame data block_. | 101 | If this frame is grayscale, the _frame descriptor block_ (or _frame delta block_ if flags denote a delta frame) is immediately followed by this frame's corresponding _frame data block_. |
| @@ -160,7 +160,7 @@ typedef struct __attribute__((packed)) qgf_delta_v1_t { | |||
| 160 | uint16_t right; // The right pixel location to to draw the delta image | 160 | uint16_t right; // The right pixel location to to draw the delta image |
| 161 | uint16_t bottom; // The bottom pixel location to to draw the delta image | 161 | uint16_t bottom; // The bottom pixel location to to draw the delta image |
| 162 | } qgf_delta_v1_t; | 162 | } qgf_delta_v1_t; |
| 163 | // _Static_assert(sizeof(qgf_delta_v1_t) == 13, "qgf_delta_v1_t must be 13 bytes in v1 of QGF"); | 163 | // STATIC_ASSERT(sizeof(qgf_delta_v1_t) == 13, "qgf_delta_v1_t must be 13 bytes in v1 of QGF"); |
| 164 | ``` | 164 | ``` |
| 165 | 165 | ||
| 166 | ## Frame data block {#qgf-frame-data-descriptor} | 166 | ## Frame data block {#qgf-frame-data-descriptor} |
