lunny/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qmk_firmware/quantum_painter.html

43 lines
117 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>Quantum Painter | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
Deploying to gh-pages from @ qmk/qmk_firmware@119e54e9e3db66355a07be5f8db9fcc81b65f1ff 🚀
2024-05-31 00:38:24 +00:00
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
Deploying to gh-pages from @ qmk/qmk_firmware@f0eb2460d9e5b6e71ff76da3f341795ac53e1ec2 🚀
2024-12-03 19:32:44 +00:00
<script type="module" src="/assets/app.DyBQnxno.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="">
Deploying to gh-pages from @ qmk/qmk_firmware@f0eb2460d9e5b6e71ff76da3f341795ac53e1ec2 🚀
2024-12-03 19:32:44 +00:00
<link rel="modulepreload" href="/assets/chunks/theme.CuUwN9QV.js">
Deploying to gh-pages from @ qmk/qmk_firmware@93cc3f58b1e99945268dd039d98feb71d70a0acd 🚀
2024-09-24 08:56:37 +00:00
<link rel="modulepreload" href="/assets/chunks/framework.B9AX-CPi.js">
Deploying to gh-pages from @ qmk/qmk_firmware@9f76541b29056150cf57d69569a14a59e13995c7 🚀
2024-11-27 10:33:24 +00:00
<link rel="modulepreload" href="/assets/quantum_painter.md.DJiLUI1o.lean.js">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<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>
Deploying to gh-pages from @ qmk/qmk_firmware@9f76541b29056150cf57d69569a14a59e13995c7 🚀
2024-11-27 10:33:24 +00:00
<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="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></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
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">QUANTUM_PAINTER_DRIVERS += ......</span></span></code></pre></div><p>You will also likely need to select an appropriate driver in <code>rules.mk</code>, which is listed below.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>Quantum Painter is not currently integrated with system-level operations such as when the keyboard goes into suspend. Users will need to handle this manually at the current time.</p></div><p>The QMK CLI can be used to convert from normal images such as PNG files or animated GIFs, as well as fonts from TTF files.</p><p>Supported devices:</p><table><thead><tr><th>Display Panel</th><th>Panel Type</th><th>Size</th><th>Comms Transport</th><th>Driver</th></tr></thead><tbody><tr><td>GC9A01</td><td>RGB LCD (circular)</td><td>240x240</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += gc9a01_spi</code></td></tr><tr><td>ILI9163</td><td>RGB LCD</td><td>128x128</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ili9163_spi</code></td></tr><tr><td>ILI9341</td><td>RGB LCD</td><td>240x320</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ili9341_spi</code></td></tr><tr><td>ILI9486</td><td>RGB LCD</td><td>320x480</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ili9486_spi</code></td></tr><tr><td>ILI9488</td><td>RGB LCD</td><td>320x480</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ili9488_spi</code></td></tr><tr><td>LD7032 (SPI)</td><td>Monochrome OLED</td><td>128x40</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ld7032_spi</code></td></tr><tr><td>LD7032 (I2C)</td><td>Monochrome OLED</td><td>128x40</td><td>I2C</td><td><code>QUANTUM_PAINTER_DRIVERS += ld7032_i2c</code></td></tr><tr><td>SSD1351</td><td>RGB OLED</td><td>128x128</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += ssd1351_spi</code></td></tr><tr><td>ST7735</td><td>RGB LCD</td><td>132x162, 80x160</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += st7735_spi</code></td></tr><tr><td>ST7789</td><td>RGB LCD</td><td>240x320, 240x240</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += st7789_spi</code></td></tr><tr><td>SH1106 (SPI)</td><td>Monochrome OLED</td><td>128x64</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += sh1106_spi</code></td></tr><tr><td>SH1106 (I2C)</td><td>Monochrome OLED</td><td>128x64</td><td>I2C</td><td><code>QUANTUM_PAINTER_DRIVERS += sh1106_i2c</code></td></tr><tr><td>SSD1306 (SPI)</td><td>Monochrome OLED</td><td>128x64</td><td>SPI + D/C + RST</td><td><code>QUANTUM_PAINTER_DRIVERS += sh1106_spi</code></td></tr><tr><td>SSD1306 (I2C)</td><td>Monochrome OLED</td><td>128x32</td><td>I2C</td><td><code>QUANTUM_PAINTER_DRIVERS += sh1106_i2c</code></td></tr><tr><td>Surface</td><td>Virtual</td><td>User-defined</td><td>None</td><td><code>QUANTUM_PAINTER_DRIVERS += surface</code></td></tr></tbody></table><h2 id="quantum-painter-config" tabindex="-1">Quantum Painter Configuration <a class="header-anchor" href="#quantum-painter-config" aria-label="Permalink to &quot;Quantum Painter Configuration {#quantum-painter-config}&quot;">​</a></h2><table><thead><tr><th>Option</th><th>Default</th><th>Purpose</th></tr></thead><tbody><tr><td><code>QUANTUM_PAINTER_DISPLAY_TIMEOUT</code></td><td><code>30000</code></td><td>This controls the amount of time (in milliseconds) that all displays will remain on after the last user input. If set to <code>0</code>, the display will remain on indefinitely.</td></tr><tr><td><code>QUANTUM_PAINTER_TASK_THROTTLE</code></td><td><code>1</code></td><td>This controls the amount of time (in milliseconds) that the Quantum Painter internal task will wait between each execution. Affects animations, display timeout, and LVGL timing if enabled.</td></tr><tr><td><code>QUANTUM_PAINTER_NUM_IMAGES</code></td><td><code>8</code></td><td>The maximum number of images/animations that can be loaded at any one time.</td></tr><tr><td><code>QUANTUM_PAINTER_NUM_FONTS</code></td><td><code>4</code><
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<span class="line"><span></span></span>
<span class="line"><span>options:</span></span>
<span class="line"><span> -h, --help show this help message and exit</span></span>
<span class="line"><span> -w, --raw Writes out the QGF file as raw data instead of c/h combo.</span></span>
<span class="line"><span> -d, --no-deltas Disables the use of delta frames when encoding animations.</span></span>
<span class="line"><span> -r, --no-rle Disables the use of RLE when encoding images.</span></span>
<span class="line"><span> -f FORMAT, --format FORMAT</span></span>
<span class="line"><span> Output format, valid types: rgb888, rgb565, pal256, pal16, pal4, pal2, mono256, mono16, mono4, mono2</span></span>
<span class="line"><span> -o OUTPUT, --output OUTPUT</span></span>
<span class="line"><span> Specify output directory. Defaults to same directory as input.</span></span>
<span class="line"><span> -i INPUT, --input INPUT</span></span>
<span class="line"><span> Specify input graphic file.</span></span>
<span class="line"><span> -v, --verbose Turns on verbose output.</span></span></code></pre></div><p>The <code>INPUT</code> argument can be any image file loadable by Python&#39;s Pillow module. Common formats include PNG, or Animated GIF.</p><p>The <code>OUTPUT</code> argument needs to be a directory, and will default to the same directory as the input argument.</p><p>The <code>FORMAT</code> argument can be any of the following:</p><table><thead><tr><th>Format</th><th>Meaning</th></tr></thead><tbody><tr><td><code>rgb888</code></td><td>16,777,216 colors in 8-8-8 RGB format (requires <code>QUANTUM_PAINTER_SUPPORTS_NATIVE_COLORS</code>)</td></tr><tr><td><code>rgb565</code></td><td>65,536 colors in 5-6-5 RGB format (requires <code>QUANTUM_PAINTER_SUPPORTS_NATIVE_COLORS</code>)</td></tr><tr><td><code>pal256</code></td><td>256-color palette (requires <code>QUANTUM_PAINTER_SUPPORTS_256_PALETTE</code>)</td></tr><tr><td><code>pal16</code></td><td>16-color palette</td></tr><tr><td><code>pal4</code></td><td>4-color palette</td></tr><tr><td><code>pal2</code></td><td>2-color palette</td></tr><tr><td><code>mono256</code></td><td>256-shade grayscale (requires <code>QUANTUM_PAINTER_SUPPORTS_256_PALETTE</code>)</td></tr><tr><td><code>mono16</code></td><td>16-shade grayscale</td></tr><tr><td><code>mono4</code></td><td>4-shade grayscale</td></tr><tr><td><code>mono2</code></td><td>2-shade grayscale</td></tr></tbody></table><p><strong>Examples</strong>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>$ cd /home/qmk/qmk_firmware/keyboards/my_keeb</span></span>
<span class="line"><span>$ qmk painter-convert-graphics -f mono16 -i my_image.gif -o ./generated/</span></span>
<span class="line"><span>Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/my_image.qgf.h...</span></span>
<span class="line"><span>Writing /home/qmk/qmk_firmware/keyboards/my_keeb/generated/my_image.qgf.c...</span></span></code></pre></div><!--]--></div><!----><!----><!--]--></div><h2 id="quantum-painter-drivers" tabindex="-1">Quantum Painter Display Drivers <a class="header-anchor" href="#quantum-painter-drivers" aria-label="Permalink to &quot;Quantum Painter Display Drivers {#quantum-painter-drivers}&quot;">​</a></h2><div class="plugin-tabs"><div class="plugin-tabs--tab-list" role="tablist"><!--[--><button id="tab-LCD-9" role="tab" class="plugin-tabs--tab" aria-selected="true" aria-controls="panel-LCD-9" tabindex="0">LCD</button><button id="tab-OLED-9" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-OLED-9" tabindex="-1">OLED</button><button id="tab-Surface-9" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Surface-9" tabindex="-1">Surface</button><!--]--></div><!--[--><div id="panel-LCD-9" class="plugin-tabs--content" role="tabpanel" tabindex="0" aria-labelledby="tab-LCD-9" data-v-b2b19630><!--[--><p>Most TFT display panels use a 5-pin interface -- SPI SCK, SPI MOSI, SPI CS, D/C, and RST pins.</p><p>For these displays, QMK&#39;s <code>spi_master</code> must already be correctly configured for the platform you&#39;re building for.</p><p>The pin assignments for SPI CS, D/C, and RST are specified during device construction.</p><div class="plugin-tabs"><div class="plugin-tabs--tab-list" role="tablist"><!--[--><button id="tab-GC9A01-10" role="tab" class="plugin-tabs--tab" aria-selected="true" aria-controls="panel-GC9A01-10" tabindex="0">GC9A01</button><button id="tab-ILI9163-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ILI9163-10" tabindex="-1">ILI9163</button><button id="tab-ILI9341-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ILI9341-10" tabindex="-1">ILI9341</button><button id="tab-ILI9486-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ILI9486-10" tabindex="-1">ILI9486</button><button id="tab-ILI9488-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ILI9488-10" tabindex="-1">ILI9488</button><button id="tab-ST7735-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ST7735-10" tabindex="-1">ST7735</button><button id="tab-ST7789-10" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-ST7789-10" tabindex="-1">ST7789</button><!--]--></div><!--[--><div id="panel-GC9A01-10" class="plugin-tabs--content" role="tabpanel" tabindex="0" aria-labelledby="tab-GC9A01-10" data-v-b2b19630><!--[--><p>Enabling support for the GC9A01 in Quantum Painter is done by adding the following to <code>rules.mk</code>:</p><div class="language-make vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">make</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">QUANTUM_PAINTER_ENABLE = yes</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">QUANTUM_PAINTER_DRIVERS += gc9a01_spi</span></span></code></pre></div><p>Creating a GC9A01 device in firmware can then be done with the following API:</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:#005CC5;--shiki-dark:#79B8FF;">painter_device_t</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> qp_gc9a01_make_spi_device</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint16_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> panel_width</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint16_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> panel_height</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">pin_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> chip_select_pin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">pin_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> dc_pin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">pin_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> reset_pin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint16_t</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> spi_divisor</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">int</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> spi_mode</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><p>The device handle returned from the <code>qp_gc9a01_make_spi_device</code> function can be used to perform all other drawing operations.</p><p>The maximum number of displays can be configured by changing the following in your <code>config.h</code> (default is 1):</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:#6A737D;--shiki-dark:#6A737D;">// 3 displays:</span></span>
Deploying to gh-pages from @ qmk/qmk_firmware@3d4da6de29c8635c9cd232ce456d8fec8d31921b 🚀
2024-11-12 02:22:17 +00:00
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> GC9A01_NUM_DEVICES</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 3</span></span></code></pre></div><p>Native color format rgb565 is compatible with GC9A01</p><!--]--></div><!----><!----><!----><!----><!----><!----><!--]--></div><!--]--></div><!----><!----><!--]--></div><h2 id="quantum-painter-api" tabindex="-1">Quantum Painter Drawing API <a class="header-anchor" href="#quantum-painter-api" aria-label="Permalink to &quot;Quantum Painter Drawing API {#quantum-painter-api}&quot;">​</a></h2><p>All APIs require a <code>painter_device_t</code> object as their first parameter -- this object comes from the specific device initialisation, and instructions on creating it can be found in each driver&#39;s respective section.</p><p>To use any of the APIs, you need to include <code>qp.h</code>:</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;">#include</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &lt;qp.h&gt;</span></span></code></pre></div><div class="plugin-tabs"><div class="plugin-tabs--tab-list" role="tablist"><!--[--><button id="tab-General Notes-11" role="tab" class="plugin-tabs--tab" aria-selected="true" aria-controls="panel-General Notes-11" tabindex="0">General Notes</button><button id="tab-Device Control-11" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Device Control-11" tabindex="-1">Device Control</button><button id="tab-Drawing Primitives-11" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Drawing Primitives-11" tabindex="-1">Drawing Primitives</button><button id="tab-Image Functions-11" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Image Functions-11" tabindex="-1">Image Functions</button><button id="tab-Font Functions-11" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Font Functions-11" tabindex="-1">Font Functions</button><button id="tab-Advanced Functions-11" role="tab" class="plugin-tabs--tab" aria-selected="false" aria-controls="panel-Advanced Functions-11" tabindex="-1">Advanced Functions</button><!--]--></div><!--[--><div id="panel-General Notes-11" class="plugin-tabs--content" role="tabpanel" tabindex="0" aria-labelledby="tab-General Notes-11" data-v-b2b19630><!--[--><p>The coordinate system used in Quantum Painter generally accepts <code>left</code>, <code>top</code>, <code>right</code>, and <code>bottom</code> instead of x/y/width/height, and each coordinate is inclusive of where pixels should be drawn. This is required as some datatypes used by display panels have a maximum value of <code>255</code> -- for any value or geometry extent that matches <code>256</code>, this would be represented as a <code>0</code>, instead.</p><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Drawing a horizontal line 8 pixels long, starting from 4 pixels inside the left side of the display, will need <code>left=4</code>, <code>right=11</code>.</p></div><p>All color data matches the standard QMK HSV triplet definitions:</p><ul><li>Hue is of the range <code>0...255</code> and is internally mapped to 0...360 degrees.</li><li>Saturation is of the range <code>0...255</code> and is internally mapped to 0...100% saturation.</li><li>Value is of the range <code>0...255</code> and is internally mapped to 0...100% brightness.</li></ul><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Colors used in Quantum Painter are not subject to the RGB lighting CIE curve, if it is enabled.</p></div><!--]--></div><!----><!----><!----><!----><!----><!--]--></div></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><div class="edit-info" data-
Deploying to gh-pages from @ qmk/qmk_firmware@f0eb2460d9e5b6e71ff76da3f341795ac53e1ec2 🚀
2024-12-03 19:32:44 +00:00
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"D5Gv0xM2\",\"changelog_20200229.md\":\"TBlkCyr5\",\"changelog_20200530.md\":\"TIsD4IJ6\",\"changelog_20200829.md\":\"DLRic7TT\",\"changelog_20201128.md\":\"Ba_rFlxl\",\"changelog_20210227.md\":\"DvqXERXt\",\"changelog_20210529.md\":\"D6J1RidB\",\"changelog_20210828.md\":\"C3lFgq5A\",\"changelog_20211127.md\":\"KawnpmKg\",\"changelog_20220226.md\":\"KLnmRn9F\",\"changelog_20220528.md\":\"Boue42eA\",\"changelog_20220827.md\":\"BmGjSteF\",\"changelog_20221126.md\":\"B7IFykhd\",\"changelog_20230226.md\":\"twCbPT9A\",\"changelog_20230528.md\":\"BzLLaFNh\",\"changelog_20230827.md\":\"BrhCShVH\",\"changelog_20231126.md\":\"DVLm2eGv\",\"changelog_20240225.md\":\"CXS3FgKU\",\"changelog_20240526.md\":\"BM7fxQBp\",\"changelog_20240825.md\":\"BDFY9wpG\",\"changelog_20241124.md\":\"Q_tHeHAa\",\"capabilities.md\":\"a_Nbgg0n\",\"capabilities_inc.md\":\"Cor-lDIx\",\"api_development_environment.md\":\"pCQRKF_M\",\"api_development_overview.md\":\"D5Zus3EP\",\"api_docs.md\":\"CCHPm9Ph\",\"api_overview.md\":\"Bo6l-c66\",\"arm_debugging.md\":\"DcrpfiyI\",\"breaking_changes.md\":\"y5xbzT8a\",\"breaking_changes_history.md\":\"DnerrifT\",\"breaking_changes_instructions.md\":\"y3u4ruQJ\",\"chibios_upgrade_instructions.md\":\"p6uZF4kP\",\"cli.md\":\"D3UYWDOB\",\"cli_commands.md\":\"DmaB9sac\",\"cli_configuration.md\":\"gftml-GJ\",\"cli_development.md\":\"CV5X2u0i\",\"cli_tab_complete.md\":\"BjhR5TFS\",\"coding_conventions_c.md\":\"DDXrsq6j\",\"coding_conventions_python.md\":\"BpeQIiJ8\",\"compatible_microcontrollers.md\":\"Bp5Cuz5M\",\"config_options.md\":\"C0ey_0zq\",\"configurator_architecture.md\":\"-1IamgaM\",\"configurator_default_keymaps.md\":\"Csbe8pIs\",\"configurator_step_by_step.md\":\"BQXI9udF\",\"configurator_troubleshooting.md\":\"A5MEdd6g\",\"contributing.md\":\"CJpSA-c9\",\"custom_matrix.md\":\"BBjT28gr\",\"custom_quantum_functions.md\":\"7Wtzp8l7\",\"data_driven_config.md\":\"fJsS9ZqH\",\"documentation_best_practices.md\":\"DG91aPmN\",\"documentation_templates.md\":\"C2-rIfQ7\",\"driver_installation_zadig.md\":\"quInZVrl\",\"drivers_adc.md\":\"DEzkLXsb\",\"drivers_apa102.md\":\"DZyCh2Hs\",\"drivers_audio.md\":\"D7D3osxI\",\"drivers_aw20216s.md\":\"CRGZz1xZ\",\"drivers_eeprom.md\":\"D2Ip1OAY\",\"drivers_flash.md\":\"BgL2PtmD\",\"drivers_gpio.md\":\"DMCKpyic\",\"drivers_i2c.md\":\"CZ78jxRE\",\"drivers_is31fl3218.md\":\"DgfDKi5r\",\"drivers_is31fl3236.md\":\"DO7FGjNM\",\"drivers_is31fl3729.md\":\"BmFD_YGz\",\"drivers_is31fl3731.md\":\"k9wXgexF\",\"drivers_is31fl3733.md\":\"CTovyg7g\",\"drivers_is31fl3736.md\":\"C-ibqmvt\",\"drivers_is31fl3737.md\":\"DuW4Ycqu\",\"drivers_is31fl3741.md\":\"Bd8tDEGh\",\"drivers_is31fl3742a.md\":\"o6103t5c\",\"drivers_is31fl3743a.md\":\"e2xEXYVf\",\"drivers_is31fl3745.md\":\"C0VypsOf\",\"drivers_is31fl3746a.md\":\"Dc_MBCTu\",\"drivers_serial.md\":\"CJRpA3ob\",\"drivers_snled27351.md\":\"DkoZ0nOF\",\"drivers_spi.md\":\"vFN5MRzl\",\"drivers_uart.md\":\"DfVpzltt\",\"drivers_ws2812.md\":\"Obzw-GTj\",\"easy_maker.md\":\"yfFLYEZu\",\"faq_build.md\":\"ClAW0aMe\",\"faq_debug.md\":\"DaRqKHet\",\"faq_general.md\":\"0Ixv74_I\",\"faq_keymap.md\":\"BLluC4NV\",\"faq_misc.md\":\"CVtsey6K\",\"feature_advanced_keycodes.md\":\"C2iBp6mf\",\"feature_converters.md\":\"rz_anpjy\",\"feature_debounce_type.md\":\"CYIyyhFB\",\"feature_eeprom.md\":\"Bhzy4RDv\",\"feature_layers.md\":\"B59e5DpO\",\"feature_layouts.md\":\"BK7vfZuH\",\"feature_macros.md\":\"4VvYwf-t\",\"feature_userspace.md\":\"CF52Rhjy\",\"features_audio.md\":\"xQ9VRAsq\",\"features_auto_shift.md\":\"DOcRLWqv\",\"features_autocorrect.md\":\"iXmGH9ee\",\"features_backlight.md\":\"Cvuqwm3F\",\"features_bootmagic.md\":\"BjDrYOUH\",\"features_caps_word.md\":\"CYfZhNN7\",\"features_combo.md\":\"v8KQE72a\",\"features_command.md\":\"ajsjx5Wc\",\"features_digitizer.md\":\"BouFmMBP\",\"features_dip_switch.md\":\"BphpeXE7\",\"features_dynamic_macros.md\":\"CnLDkQKC\",\"features_encoders.md\":\"CGtgEWxD\",\"features_grave_esc.md\":\"DXES6Ttb\",\"features_haptic_feedback.md\":\"COJ0M8E1\",\"features_hd4
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