Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-09 22:04:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Normalize API doc styling

Nick Benik
2018-12-21 17:02:41 -05:00
parent 51febe86aa
commit 6a0f0e85db
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
NeoPixelBrightnessBus-object-API.md

@@ -3,19 +3,19 @@ Please see the base class [NeoPixelBus object API](https://github.com/Makuna/Neo
# Methods # Methods
### void SetBrightness(uint8_t brightness) ### 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. 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. > * _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. CAUTION: Setting this to low values causes the colors to loose accuracy and may lead to complete loss of color.
### uint8_t GetBrightness() ### uint8_t GetBrightness()
This will return the current brightness level of the NeoPixelBus. This will return the current brightness level of the NeoPixelBus.
\<return\> - (0-255) the current level > * \<return\> - (0-255) the current level
### void SetPixelColor(uint16_t indexPixel, ColorObject color) ### 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. This will set the color for the given pixel; it will be modified by the current brightness level.
_indexPixel_ - the pixel number > * _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. > * _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) ### 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()`. 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 > * _indexPixel_ - the pixel number
\<return\>, a color object, RgbColor or RgbwColor. > * \<return\>, a color object, RgbColor or RgbwColor.