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-04-06 18:11:27 -07:00
parent 7aa104f6a7
commit def07ee5cc
1 changed files with 25 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
NeoPixelBus-object-API.md

@@ -50,4 +50,28 @@ indexPixel - the pixel number
## void ClearTo(ColorObject color)
This will clear all pixels to the given color.
color - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
color - a color object to use, RgbColor, HslColor, and HsbColor will all work and if the NeoPixelBus object was created with the NeoRgbwFeature the RgbwColor will also work.
## void RotateLeft(uint16_t rotationCount, uint16_t first = 0, uint16_t last = 0xffff)
This will rotate all the pixels in the given range by given number of pixels. The pixels on the left will wrap around to the right side.
rotationCount - the number of pixels to rotate left.
first - (optional) the first pixel to include in the rotation.
last - (optional) the last pixel to include in the rotation.
## void ShiftLeft(uint16_t shiftCount, uint16_t first = 0, uint16_t last = 0xffff)
This will shift all the pixels in the given range by given number of pixels. The first `shiftCount` pixels on right will be left alone.
shiftCount - the number of pixels to shift left.
first - (optional) the first pixel to include in the shift.
last - (optional) the last pixel to include in the shift.
## void RotateRight(uint16_t rotationCount, uint16_t first = 0, uint16_t last = 0xffff)
This will rotate all the pixels in the given range by given number of pixels. The pixels on the right will wrap around to the left side.
rotationCount - the number of pixels to rotate left.
first - (optional) the first pixel to include in the rotation.
last - (optional) the last pixel to include in the rotation.
## void ShiftRight(uint16_t shiftCount, uint16_t first = 0, uint16_t last = 0xffff)
This will shift all the pixels in the given range by given number of pixels. The first `shiftCount` pixels on left will be left alone.
shiftCount - the number of pixels to shift right.
first - (optional) the first pixel to include in the shift.
last - (optional) the last pixel to include in the shift.