diff --git a/NeoPixelBrightnessBus-object-API.md b/NeoPixelBrightnessBus-object-API.md new file mode 100644 index 0000000..162902d --- /dev/null +++ b/NeoPixelBrightnessBus-object-API.md @@ -0,0 +1,21 @@ +Please see the base class [NeoPixelBus object API](https://github.com/Makuna/NeoPixelBus/wiki/NeoPixelBus-object-API) for constructors and other methods. Below only documents the enhancements. + +# Methods +### void SetBrightness(uint8_t brightness) +This will change the brightness of the NeoPixelBus. All current pixels will be modified to the new brightness; and any subsequent calls to `SetPixelColor()` will also be modified. +_brightness_ - (0-255), where 255 is the value of the original color, and 0 is near black. +CAUTION: Setting this to low values causes the colors to loose accuracy and may lead to complete loss of color. + +### uint8_t GetBrightness() +This will return the current brightness level of the NeoPixelBus. +\ - (0-255) the current level + +### void SetPixelColor(uint16_t indexPixel, ColorObject color) +This will set the color for the given pixel; it will be modified by the current brightness level. +_indexPixel_ - the pixel number +_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. + +### ColorObject GetPixelColor(uint16_t indexPixel) +This will return the color for the given pixel; but due to calls to brightness level, it will often not be the same color as set by the call to `SetPixelColor()`. +_indexPixel_ - the pixel number +\, a color object, RgbColor or RgbwColor.