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
2020-12-08 11:07:26 -08:00
parent d1b472631e
commit 6e2c41bf9a
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
NeoPixelBus-object-API.md

@@ -34,7 +34,7 @@ Due to the hardware protocol, if you call this quickly after the last time it wa
Based upon the Method used, sometimes this may take some time before it returns depending on the number of pixels or it may return almost immediately. If the method defined for the bus uses hardware, it will return quickly and send the data asynchronously. Otherwise, 300 pixel strip can take 9ms to send the data. The more pixels, the longer it takes, the less pixels, the quicker it can send them.
### bool CanShow()
This will return true if enough time has passed since the last time Show() was called. This also means that calling Show() will not cause any undue waiting. If the method for the defined bus is hardware that sends asynchronously, them call CanShow() will let you know if it has finished sending the data from the last Show().
This will return true if enough time has passed since the last time Show() was called. This also means that calling Show() will not cause any undue waiting. If the method for the defined bus is hardware that sends asynchronously, then call CanShow() will let you know if it has finished sending the data from the last Show().
Normally, you really shouldn't worry about this as either you have enough other things in your sketch to process, or you have so little you don't care if Show() waits.
### bool IsDirty()