diff options
| author | TPReal <tpreal@gmail.com> | 2022-11-16 12:37:43 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2022-11-17 23:18:22 +1100 |
| commit | 859d0e9529b90d6745dba347271d0d9b610da4aa (patch) | |
| tree | b25f20fb7bf3e670a8f1f4137bee97ef207e0590 | |
| parent | 4ff10b59767b408aad24602176b7c49e48ceeb46 (diff) | |
docs/library/framebuf: Clarify docs for blit regarding palette.
Clarified the behaviour when both key and palette are specified.
| -rw-r--r-- | docs/library/framebuf.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/library/framebuf.rst b/docs/library/framebuf.rst index 78ae0c1c3..149f4d660 100644 --- a/docs/library/framebuf.rst +++ b/docs/library/framebuf.rst @@ -133,7 +133,9 @@ Other methods Draw another FrameBuffer on top of the current one at the given coordinates. If *key* is specified then it should be a color integer and the corresponding color will be considered transparent: all pixels with that - color value will not be drawn. + color value will not be drawn. (If the *palette* is specified then the *key* + is compared to the value from *palette*, not to the value directly from + *fbuf*.) The *palette* argument enables blitting between FrameBuffers with differing formats. Typical usage is to render a monochrome or grayscale glyph/icon to |