Skip to content

Commit 4859248

Browse files
committed
RGBMatrix: document constructor arguments
Closes: #8283
1 parent 283889b commit 4859248

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

shared-bindings/rgbmatrix/RGBMatrix.c

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,22 @@ STATIC void preflight_pins_or_throw(uint8_t clock_pin, uint8_t *rgb_pins, uint8_
186186
//| flicker during updates.
187187
//|
188188
//| A RGBMatrix is often used in conjunction with a
189-
//| `framebufferio.FramebufferDisplay`."""
189+
//| `framebufferio.FramebufferDisplay`.
190+
//|
191+
//| :param int width: The overall width of the display in pixels
192+
//| :param int height: The overall height of all displays in pixels
193+
//| :param int tile: In a multi-row display, the number of rows of panels
194+
//| :param int bit_depth: The color depth of the display. 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
195+
//| :param bool serpentine: In a multi-row display, True when alternate rows are rotated 180°, which can reduce wiring length
196+
//| :param Sequence[digitalio.DigitalInOut] rgb_pins: The display's "RGB pins"
197+
//| :param Sequence[digitalio.DigitalInOut] addr_pins: The display's "address pins"
198+
//| :param digitalio.DigitalInOut clock_pin: The display's "clock pin"
199+
//| :param digitalio.DigitalInOut latch_pin: The display's "latch pin"
200+
//| :param digitalio.DigitalInOut output_enable_pin: The display's "output enable" pin
201+
//| :param bool doublebuffer: True if the output is double-buffered
202+
//| :param Optional[WriteableBuffer] framebuffer: A pre-allocated framebuffer to use. If unspecified, a framebuffer is allocated
203+
//|
204+
//| """
190205

191206
STATIC mp_obj_t rgbmatrix_rgbmatrix_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *all_args) {
192207
enum { ARG_width, ARG_bit_depth, ARG_rgb_list, ARG_addr_list,

0 commit comments

Comments
 (0)