From def07ee5ccbf1d0888fab29ae4c17145888ed5ba Mon Sep 17 00:00:00 2001 From: Michael Miller Date: Wed, 6 Apr 2016 18:11:27 -0700 Subject: [PATCH] Updated NeoPixelBus object API (markdown) --- NeoPixelBus-object-API.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/NeoPixelBus-object-API.md b/NeoPixelBus-object-API.md index b499653..6af210f 100644 --- a/NeoPixelBus-object-API.md +++ b/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. \ No newline at end of file +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.