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

Normalize API doc styling

Nick Benik
2018-12-21 17:16:48 -05:00
parent c75b671726
commit f32c374175
1 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
RgbwColor-object-API.md

@@ -13,20 +13,27 @@ uint8_t W;
### RgbwColor(uint8_t r, uint8_t g, uint8_t b, uint8_t w) :
Constructs a RgbwColor using Red, Green, Blue, and White component values.
> * _r_ - value for the Red component (0 - 255)
> * _g_ - value for the Green component (0 - 255)
> * _b_ - value for the Blue component (0 - 255)
> * _w_ - value for the White component (0 - 255)
### RgbwColor(uint8_t brightness)
Constructs a RgbwColor using a single brightness value(0 - 255). This works well for creating gray tone colors.
(0) = black, (255) = white, (128) = gray.
This will only effect the W color element.
> * _brightness_ - value for the white component where (0) = black, (128) = gray, (255) = white.
This will only affect the W color element.
### RgbwColor(RgbColor color);
Construct a RgbwColor using RgbColor, copying the R,G,B values and setting W to zero.
> * _color_ - a RgbColor object.
### RgbwColor(HslColor color);
Construct a RgbwColor using HslColor, converting the Hsl to Rgbw
> * _color_ - a HslColor object.
### RgbwColor(HsbColor color);
Construct a RgbwColor using HsbColor, converting the Hsb to Rgbw
> * _color_ - a HsbColor object.
### RgbwColor()
Construct a RgbwColor that will have its values set in latter operations.
@@ -40,27 +47,27 @@ NOTE: For color objects with only W set, it will return W. For color objects wi
### void Darken(uint8_t delta);
Darken will adjust the color by the given delta toward black.
NOTE: This is a simple linear change.
delta - (0-255) the amount to dim the color by.
> * _delta_ - (0-255) the amount to dim the color by.
### void Lighten(uint8_t delta);
Lighten will adjust the color by the given delta toward white.
NOTE: This is a simple linear change. If the color only has W value set, only W will be modified; otherwise only the R,G,B will be modified leaving W alone.
delta - (0-255) the amount to lighten the color by.
> * _delta_ - (0-255) the amount to lighten the color by.
### static RgbwColor LinearBlend(RgbwColor left, RgbwColor right, float progress);
This will blend between two colors by the amount defined by the progress variable.
left - the color to start the blend at.
right - the color to end the blend at.
progress - (0.0f - 1.0f) value where 0.0f will return left and 1.0f will return right and a value between will blend the color weighted linearly between them.
> * _left_ - the color to start the blend at.
> * _right_ - the color to end the blend at.
> * _progress_ - (0.0f - 1.0f) value where 0.0f will return left and 1.0f will return right and a value between will blend the color weighted linearly between them.
This is a static function, which means you need to call it scoped to the object class and not an instance like...
```
RgbwColor results = RgbwColor::LinearBlend(RgbwColor(255,0,0,0), RgbwColor(0,255,0,10), 0.33f);
```
### static RgbwColor BilinearBlend(RgbwColor c00, RgbwColor c01, RgbwColor c10, RgbwColor c11, float x, float y);
This will blend between four colors by the amount defined by 2d weighting values.
c00 - upper left quadrant color
c01 - upper right quadrant color
c10 - lower left quadrant color
c11 - lower right quadrant color
x - unit value (0.0 - 1.0) that defines the blend progress in horizontal space
y - unit value (0.0 - 1.0) that defines the blend progress in vertical space
> * _c00_ - upper left quadrant color
> * _c01_ - upper right quadrant color
> * _c10_ - lower left quadrant color
> * _c11_ - lower right quadrant color
> * _x_ - unit value (0.0 - 1.0) that defines the blend progress in horizontal space
> * _y_ - unit value (0.0 - 1.0) that defines the blend progress in vertical space