Skip to content

Commit

Permalink
Small QP surface docs update (qmk#22567)
Browse files Browse the repository at this point in the history
  • Loading branch information
daskygit authored and zgagnon committed Dec 15, 2023
1 parent c40eba2 commit fce8941
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/quantum_painter.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fce8941

Please sign in to comment.