Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-07 12:54:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated NeoPixelBus object API (markdown)

Michael Miller
2016-12-29 01:16:32 -08:00
parent bd7cb460ce
commit 7859026062
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
NeoPixelBus-object-API.md

@@ -39,7 +39,8 @@ This will force the internal state to think that SetPixelColor() was called. Th
This will force the internal state to think that Show() has happened and there is nothing new to send.
### uint8_t* Pixels()
This will return a pointer to the internal buffer of pixels. See PixelsSize() and PixelSize() to understand how large this buffer is and how its laid out. If you modify the buffer contents, you will need to let the NeoPixelBus know this by calling the `Dirty()` method otherwise `Show()` will not update the pixels.
This will return a pointer to the internal buffer of pixels. See PixelsSize() and PixelSize() to understand how large this buffer is and how its laid out. If you modify the buffer contents, you will need to let the NeoPixelBus know this by calling the `Dirty()` method otherwise `Show()` will not update the pixels.
**CAUTION:** The pointer returned should not be cached or retained between calls of Show(). The value may change after calling `Show()`
### size_t PixelsSize()
This will return the number of bytes of the internal buffer that calling Pixels() returns.