Makuna/NeoPixelBus
1
0
Fork 1
mirror of https://github.com/Makuna/NeoPixelBus.git synced 2025-08-10 06:14:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated RgbwColor object API (markdown)

Michael Miller
2016-02-27 09:45:06 -08:00
parent f8d1a6a690
commit 7444fceb34
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
RgbwColor-object-API.md

@@ -35,7 +35,7 @@ CAUTION: The R,G,B,W members are not initialized and may not be consistent unti
## Methods ## Methods
### uint8_t CalculateBrightness(); ### uint8_t CalculateBrightness();
CalculateBrightness will calculate the overall brightness. CalculateBrightness will calculate the overall brightness.
NOTE: For color objects with only W set, it will return W. For color objects with W set to zero this is a simple linear brightness. For color objects with values in W and another color component, the overall brightness is an equal mix of the color components and the W. NOTE: For color objects with only W set, it will return W. For color objects with W set to zero this is a simple linear brightness. For color objects with values in W and another color component, the overall brightness is the brighter of the color components and the W.
### void Darken(uint8_t delta); ### void Darken(uint8_t delta);
Darken will adjust the color by the given delta toward black. Darken will adjust the color by the given delta toward black.