Skip to content

Commit 2dcc0d2

Browse files
committed
further explain width and height, it can't hurt
1 parent 81ad2e0 commit 2dcc0d2

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

shared-bindings/rgbmatrix/RGBMatrix.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
188188
//| A RGBMatrix is often used in conjunction with a
189189
//| `framebufferio.FramebufferDisplay`.
190190
//|
191-
//| :param int width: The overall width of the whole matrix in pixels
192-
//| :param int height: The overall height of the whole matrix in pixels
191+
//| :param int width: The overall width of the whole matrix in pixels. For a matrix with multiple panels in row, this is the width of a single panel times the number of panels across.
192+
//| :param int height: The overall height of the whole matrix in pixels. For a matrix with multiple rows of panels, this is the height of a single panel times the number of panels down.
193193
//| :param int tile: In a multi-row matrix, the number of rows of panels
194194
//| :param int bit_depth: The color depth of the matrix. A value of 1 gives 8 colors, a value of 2 gives 64 colors, and so on. Increasing bit depth increases the CPU and RAM usage of the RGBMatrix, and may lower the panel refresh rate. The framebuffer is always in RGB565 format regardless of the bit depth setting
195195
//| :param bool serpentine: In a multi-row matrix, True when alternate rows of panels are rotated 180°, which can reduce wiring length

0 commit comments

Comments
 (0)