summaryrefslogtreecommitdiff
path: root/shared-bindings/_pixelbuf/PixelBuf.c
diff options
context:
space:
mode:
authordherrada <33632497+dherrada@users.noreply.github.com>2020-05-12 12:26:02 -0400
committerGitHub <noreply@github.com>2020-05-12 12:26:02 -0400
commitc534a872a2b5a2d5e6b7543f56539afb24261443 (patch)
treea1b6f8333811dfb103cdfdbcf2db33fea896dacb /shared-bindings/_pixelbuf/PixelBuf.c
parent6490137812eb9f0c0b08ad81bc77ea21f5f31d04 (diff)
parent62b835ad7637c5336f210ab688289dc607bec661 (diff)
Merge branch 'master' into master
Diffstat (limited to 'shared-bindings/_pixelbuf/PixelBuf.c')
-rw-r--r--shared-bindings/_pixelbuf/PixelBuf.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/shared-bindings/_pixelbuf/PixelBuf.c b/shared-bindings/_pixelbuf/PixelBuf.c
index 1c0888802..2d1f4fff2 100644
--- a/shared-bindings/_pixelbuf/PixelBuf.c
+++ b/shared-bindings/_pixelbuf/PixelBuf.c
@@ -45,7 +45,7 @@ extern const int32_t colorwheel(float pos);
static void parse_byteorder(mp_obj_t byteorder_obj, pixelbuf_byteorder_details_t* parsed);
//| class PixelBuf:
-//| """.. currentmodule:: pixelbuf
+//| """.. currentmodule:: _pixelbuf
//|
//| :class:`PixelBuf` -- A fast RGB[W] pixel buffer for LED and similar devices
//| ===========================================================================
@@ -63,7 +63,12 @@ static void parse_byteorder(mp_obj_t byteorder_obj, pixelbuf_byteorder_details_t
//| brightness (0.0-1.0) and will enable a Dotstar compatible 1st byte in the
//| output buffer (``buf``).
//|
-//| :param ~int size: Number of pixelsx
+//| When ``P`` (pwm duration) is present as the first character of the byteorder
+//| string, the 4th value in the tuple/list for a pixel is the individual pixel
+//| brightness (0.0-1.0) and will enable a Dotstar compatible 1st byte in the
+//| output buffer (``buf``).
+//|
+//| :param ~int size: Number of pixels
//| :param ~str byteorder: Byte order string (such as "BGR" or "PBGR")
//| :param ~float brightness: Brightness (0 to 1.0, default 1.0)
//| :param ~bool auto_write: Whether to automatically write pixels (Default False)