gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-12-04 17:05:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
164d75ab4d
qmk_firmware/quantum_painter_qgf.html

67 lines
119 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>QMK Graphics Format | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.R_mF0amW.css" as="style">
Deploying to gh-pages from @ qmk/qmk_firmware@b39285807e1d21300e8a5dbbf6f2c43a8aab3494 🚀
2024-05-30 09:01:49 +00:00
<script type="module" src="/assets/app.B02gM4TG.js"></script>
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.DyMmIvSC.js">
Deploying to gh-pages from @ qmk/qmk_firmware@b39285807e1d21300e8a5dbbf6f2c43a8aab3494 🚀
2024-05-30 09:01:49 +00:00
<link rel="modulepreload" href="/assets/chunks/theme.Y8mokbzj.js">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<link rel="modulepreload" href="/assets/quantum_painter_qgf.md.BJNSu2s0.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/badge-community-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/badge-community-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><!----><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="./" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719 4.3125 31.3125 3.843
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> type_id;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // See each respective block type</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> neg_type_id;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Negated type ID, used for detecting parsing errors</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> uint24_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> length;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // 24-bit blob length, allowing for block sizes of a maximum of 16MB</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// _Static_assert(sizeof(qgf_block_header_v1_t) == 5, &quot;qgf_block_header_v1_t must be 5 bytes in v1 of QGF&quot;);</span></span></code></pre></div><p>The <em>length</em> describes the number of octets in the data following the block header -- a block header may specify a <em>length</em> of <code>0</code> if no blob is specified.</p><h2 id="qgf-graphics-descriptor" tabindex="-1">Graphics descriptor block <a class="header-anchor" href="#qgf-graphics-descriptor" aria-label="Permalink to &quot;Graphics descriptor block {#qgf-graphics-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x00</li><li><em>length</em> = 18</li></ul><p>This block must be located at the start of the file contents, and can exist a maximum of once in an entire QGF file. It is always followed by the <em>frame offset block</em>.</p><p><em>Block</em> format:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_graphics_descriptor_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x00, .neg_type_id = (~0x00), .length = 18 }</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> uint24_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> magic;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // constant, equal to 0x464751 (&quot;QGF&quot;)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> qgf_version;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // constant, equal to 0x01</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint32_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> total_file_size;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // total size of the entire file, starting at offset zero</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint32_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> neg_total_file_size;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // negated value of total_file_size, used for detecting parsing errors</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> image_width;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // in pixels</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> image_height;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // in pixels</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> frame_count;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // minimum of 1</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_graphics_descriptor_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// _Static_assert(sizeof(qgf_graphics_descriptor_v1_t) == (sizeof(qgf_block_header_v1_t) + 18), &quot;qgf_graphics_descriptor_v1_t must be 23 bytes in v1 of QGF&quot;);</span></span></code></pre></div><h2 id="qgf-frame-offset-descriptor" tabindex="-1">Frame offset block <a class="header-anchor" href="#qgf-frame-offset-descriptor" aria-label="Permalink to &quot;Frame offset block {#qgf-frame-offset-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x01</li><li><em>length</em> = variable</li></ul><p>This block denotes the offsets within the file to each frame&#39;s <em>frame descriptor block</em>, relative to the start of the file. The <em>frame offset block</em> always immediately follows the <em>graphics descriptor block</em>. The contents of this block are an array of U32&#39;s, with one entry for each frame.</p><p>Duplicate frame offsets in this block are allowed, if a certain frame is to be shown multiple times during animation.</p><p><em>Block</em> format:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_frame_offsets_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x01, .neg_type_id = (~0x01), .length = (N * sizeof(uint32_t)) }</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint32_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> offset</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[N];</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // where &#39;N&#39; is the number of frames in the file</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_frame_offsets_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span></code></pre></div><h2 id="qgf-frame-descriptor" tabindex="-1">Frame descriptor block <a class="header-anchor" href="#qgf-frame-descriptor" aria-label="Permalink to &quot;Frame descriptor block {#qgf-frame-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x02</li><li><em>length</em> = 5</li></ul><p>This block denotes the start of a frame.</p><p><em>Block</em> format:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_frame_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x02, .neg_type_id = (~0x02), .length = 5 }</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> format;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Frame format, see below.</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> flags;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Frame flags, see below.</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> compression_scheme;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Compression scheme, see below.</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> transparency_index;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // palette index used for transparent pixels (not yet implemented)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> delay;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // frame delay time for animations (in units of milliseconds)</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_frame_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// _Static_assert(sizeof(qgf_frame_v1_t) == (sizeof(qgf_block_header_v1_t) + 6), &quot;qgf_frame_v1_t must be 11 bytes in v1 of QGF&quot;);</span></span></code></pre></div><p>If this frame is grayscale, the <em>frame descriptor block</em> (or <em>frame delta block</em> if flags denote a delta frame) is immediately followed by this frame&#39;s corresponding <em>frame data block</em>.</p><p>If the frame uses an indexed palette, the <em>frame descriptor block</em> (or <em>frame delta block</em> if flags denote a delta frame) is immediately followed by this frame&#39;s corresponding <em>frame palette block</em>.</p><p>Frame format possible values:</p><ul><li><code>0x00</code>: 1bpp grayscale, no palette, <code>0</code> = black, <code>1</code> = white, LSb first pixel</li><li><code>0x01</code>: 2bpp grayscale, no palette, <code>0</code> = black, <code>3</code> = white, linear interpolation of brightness, LSb first pixel</li><li><code>0x02</code>: 4bpp grayscale, no palette, <code>0</code> = black, <code>15</code> = white, linear interpolation of brightness, LSb first pixel</li><li><code>0x03</code>: 8bpp grayscale, no palette, <code>0</code> = black, <code>255</code> = white, linear interpolation of brightness, LSb first pixel</li><li><code>0x04</code>: 1bpp indexed palette, 2 colors, LSb first pixel</li><li><code>0x05</code>: 2bpp indexed palette, 4 colors, LSb first pixel</li><li><code>0x06</code>: 4bpp indexed palette, 16 colors, LSb first pixel</li><li><code>0x07</code>: 8bpp indexed palette, 256 colors, LSb first pixel</li></ul><p>Frame flags is a bitmask with the following format:</p><table><thead><tr><th><code>bit 7</code></th><th><code>bit 6</code></th><th><code>bit 5</code></th><th><code>bit 4</code></th><th><code>bit 3</code></th><th><code>bit 2</code></th><th><code>bit 1</code></th><th><code>bit 0</code></th></tr></thead><tbody><tr><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>-</td><td>Delta</td><td>Transparency</td></tr></tbody></table><ul><li><code>[1]</code> -- Delta: Signifies that the current frame is a delta frame, which specifies only a sub-image. The <em>frame delta block</em> follows the <em>frame palette block</em> if the image format specifies a palette, otherwise it directly follows the <em>frame descriptor block</em>.</li><li><code>[0]</code> -- Transparency: The transparent palette index in the <em>blob</em> is considered valid and should be used when considering which pixels should be transparent during rendering this frame, if possible.</li></ul><p>Compression scheme possible values:</p><ul><li><code>0x00</code>: No compression</li><li><code>0x01</code>: <a href="./quantum_painter_rle">QMK RLE</a></li></ul><h2 id="qgf-frame-palette-descriptor" tabindex="-1">Frame palette block <a class="header-anchor" href="#qgf-frame-palette-descriptor" aria-label="Permalink to &quot;Frame palette block {#qgf-frame-palette-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x03</li><li><em>length</em> = variable</li></ul><p>This block describes the palette used for the frame. The <em>blob</em> contains an array of palette entries -- one palette entry is present for each color used -- each palette entry is in QMK HSV888 format:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_palette_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x03, .neg_type_id = (~0x03), .length = (N * 3 * sizeof(uint8_t)) }</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // container for a single HSV palette entry</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> h;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // hue component: `[0,360)` degrees is mapped to `[0,255]` uint8_t.</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> s;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // saturation component: `[0,1]` is mapped to `[0,255]` uint8_t.</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> v;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // value component: `[0,1]` is mapped to `[0,255]` uint8_t.</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> } </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">hsv</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[N];</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // N * hsv, where N is the number of palette entries depending on the frame format in the descriptor</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_palette_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span></code></pre></div><h2 id="qgf-frame-delta-descriptor" tabindex="-1">Frame delta block <a class="header-anchor" href="#qgf-frame-delta-descriptor" aria-label="Permalink to &quot;Frame delta block {#qgf-frame-delta-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x04</li><li><em>length</em> = 8</li></ul><p>This block describes where the delta frame should be drawn, with respect to the top left location of the image.</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_delta_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x04, .neg_type_id = (~0x04), .length = 8 }</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> left;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The left pixel location to draw the delta image</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> top;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The top pixel location to draw the delta image</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> right;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The right pixel location to to draw the delta image</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint16_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> bottom;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // The bottom pixel location to to draw the delta image</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_delta_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// _Static_assert(sizeof(qgf_delta_v1_t) == 13, &quot;qgf_delta_v1_t must be 13 bytes in v1 of QGF&quot;);</span></span></code></pre></div><h2 id="qgf-frame-data-descriptor" tabindex="-1">Frame data block <a class="header-anchor" href="#qgf-frame-data-descriptor" aria-label="Permalink to &quot;Frame data block {#qgf-frame-data-descriptor}&quot;">​</a></h2><ul><li><em>typeid</em> = 0x05</li><li><em>length</em> = variable</li></ul><p>This block describes the data associated with the frame. The <em>blob</em> contains an array of bytes containing the data corresponding to the frame&#39;s image format:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">typedef</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> struct</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> __attribute__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((packed)) </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_data_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> qgf_block_header_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> header;</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // = { .type_id = 0x05, .neg_type_id = (~0x05), .length = N }</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> data</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[N];</span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // N data octets</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">qgf_data_v1_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span></code></pre></div></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><!----></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/newbs" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Next page</span><span class="title" data-v-09de1c0f>Introduction</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
Deploying to gh-pages from @ qmk/qmk_firmware@b39285807e1d21300e8a5dbbf6f2c43a8aab3494 🚀
2024-05-30 09:01:49 +00:00
<script>window.__VP_HASH_MAP__=JSON.parse("{\"feature_programmable_button.md\":\"BP5-HUlT\",\"feature_wpm.md\":\"C-SARAXc\",\"feature_eeprom.md\":\"vdeTTfI0\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"api_development_overview.md\":\"Dcey4ntL\",\"feature_ps2_mouse.md\":\"DgKRvSpd\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"audio_driver.md\":\"YKqJ1wkZ\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"cli.md\":\"BLzAdA6l\",\"cli_configuration.md\":\"CGSB128P\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"api_overview.md\":\"0FPaUsMb\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"cli_development.md\":\"CczMJOE3\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"cli_commands.md\":\"DCpejdln\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"configurator_architecture.md\":\"DEFTvTlS\",\"changelog_20200829.md\":\"CoqrOffn\",\"data_driven_config.md\":\"BvLQ7P20\",\"changelog_20230226.md\":\"CEQKb2Sw\",\"documentation_best_practices.md\":\"D_UwEt1C\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"BIO-iq8r\",\"easy_maker.md\":\"BLadB4D_\",\"eeprom_driver.md\":\"CJGhJYmK\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"feature_advanced_keycodes.md\":\"jN1BLaPG\",\"feature_audio.md\":\"CSdy-B0q\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20220528.md\":\"BdSPPJS6\",\"changelog_20211127.md\":\"BDzkUAQX\",\"changelog_20230528.md\":\"BMuuw__T\",\"changelog_20220827.md\":\"I6ja7C5w\",\"changelog_20200229.md\":\"DNsowwM1\",\"faq_build.md\":\"Bryo1ywz\",\"faq_general.md\":\"BC3pFw4U\",\"feature_encoders.md\":\"DzEjkR0q\",\"feature_caps_word.md\":\"DFEidvi5\",\"feature_mouse_keys.md\":\"Iyt3Hb3p\",\"feature_command.md\":\"DyD1wEzr\",\"feature_combo.md\":\"BFcSajDz\",\"feature_converters.md\":\"Bmv29bqN\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_oled_driver.md\":\"C3msZUgf\",\"feature_digitizer.md\":\"D7mG1fUR\",\"feature_dip_switch.md\":\"BRm_919T\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"feature_secure.md\":\"DTio1NtX\",\"feature_macros.md\":\"DpKdCniT\",\"feature_tri_layer.md\":\"H5S9g49a\",\"feature_send_string.md\":\"ucKdf_1f\",\"feature_pointing_device.md\":\"D8bKydDH\",\"feature_unicode.md\":\"CmuIgTId\",\"feature_split_keyboard.md\":\"dSXqGTcC\",\"flash_driver.md\":\"BTZjpIxy\",\"feature_rgb_matrix.md\":\"DjrTztSt\",\"flashing_bootloadhid.md\":\"aXGP0bN5\",\"flashing.md\":\"CGYYQUk5\",\"feature_space_cadet.md\":\"BadigqA6\",\"faq_keymap.md\":\"BNm1UZCq\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"index.md\":\"Q8qZBSI9\",\"pr_checklist.md\":\"B5cKcG_-\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"quantum_painter_qff.md\":\"kLNwshez\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"isp_flashing_guide.md\":\"DfzdHli4\",\"ref_functions.md\":\"BqUSY2Jo\",\"reference_configurator_support.md\":\"FaBQzIj6\",\"reference_glossary.md\":\"2AN0RaWE\",\"spi_driver.md\":\"BUPXWtdm\",\"serial_driver.md\":\"FRk1ebke\",\"squeezing_avr.md\":\"BmcLYKOr\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"support.md\":\"CwJ_H6Qx\",\"reference_info_json.md\":\"DLkUuXVh\",\"syllabus.md\":\"0-MOMJnE\",\"uart_driver.md\":\"Cby_2B9q\",\"tap_hold.md\":\"54I6XHRj\",\"changelog_20221126.md\":\"BOpHhXi2\",\"feature_midi.md\":\"6rA7lbe-\",\"feature_sequencer.md\":\"B9A4Z8EN\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"hardware_drivers.md\":\"DFF5LGTT\",\"getting_started_introduction.md\":\"BOJreqSs\",\"feature_autocorrect.md\":\"MXySdvB8\",\"feature_bluetooth.md\":\"bG-tYvch\",\"newbs_building_firmware.md\":\"C7XiOjZf\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"newbs_flashing.md\":\"B42m5Wln\",\"feature_tap_dance.md\":\"B6ipWqOP\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
</body>
</html>
Reference in New Issue Copy Permalink