summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2023-11-29 02:24:16 +0000
committerQMK Bot <hello@qmk.fm>2023-11-29 02:24:16 +0000
commit6bba3c657801774fb751e58f6ed1f655a14b22c0 (patch)
tree2a3e91286784752540bffc5c4f93b7ba80c640a6 /docs
parent81d601b72548de1b3eab70b6124252ac540cac41 (diff)
parent5c20a845402158086e66bd60ce009c57231b1062 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/quantum_painter.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/quantum_painter.md b/docs/quantum_painter.md
index e8fa1bdece..181abf8bb3 100644
--- a/docs/quantum_painter.md
+++ b/docs/quantum_painter.md
@@ -488,10 +488,10 @@ The maximum number of surfaces can be configured by changing the following in yo
To transfer the contents of the surface to another display of the same pixel format, the following API can be invoked:
```c
-bool qp_surface_draw(painter_device_t surface, painter_device_t display, uint16_t x, uint16_t y);
+bool qp_surface_draw(painter_device_t surface, painter_device_t display, uint16_t x, uint16_t y, bool entire_surface);
```
-The `surface` is the surface to copy out from. The `display` is the target display to draw into. `x` and `y` are the target location to draw the surface pixel data. Under normal circumstances, the location should be consistent, as the dirty region is calculated with respect to the `x` and `y` coordinates -- changing those will result in partial, overlapping draws.
+The `surface` is the surface to copy out from. The `display` is the target display to draw into. `x` and `y` are the target location to draw the surface pixel data. Under normal circumstances, the location should be consistent, as the dirty region is calculated with respect to the `x` and `y` coordinates -- changing those will result in partial, overlapping draws. `entire_surface` whether the entire surface should be drawn, instead of just the dirty region.
!> The surface and display panel must have the same native pixel format.