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

Normalize API doc styling

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

30
RgbColor-object-API.md

@@ -11,19 +11,25 @@ uint8_t B;
### RgbColor(uint8_t r, uint8_t g, uint8_t b) : ### RgbColor(uint8_t r, uint8_t g, uint8_t b) :
Constructs a RgbColor using Red, Green, and Blue color component values. Constructs a RgbColor using Red, Green, and Blue color component values.
> * r - value of Red component (0 - 255)
> * g - value of Green component (0 - 255)
> * b - value of Blue component (0 - 255)
### RgbColor(uint8_t brightness) ### RgbColor(uint8_t brightness)
Constructs a RgbColor using a single brightness value(0 - 255). This works well for creating gray tone colors. Constructs a RgbColor using a single brightness value(0 - 255). This works well for creating gray tone colors.
(0) = black, (255) = white, (128) = gray > * _brightness_ - brightness value where (0) = black, (128) = gray, (255) = white
### RgbColor(HtmlColor color); ### RgbColor(HtmlColor color);
Construct a RgbColor using HtmlColor, converting the Html single value to Rgb component values Construct a RgbColor using HtmlColor, converting the Html single value to Rgb component values
> * _color_ - an HtmlColor object
### RgbColor(HslColor color); ### RgbColor(HslColor color);
Construct a RgbColor using HslColor, converting the Hsl to Rgb Construct a RgbColor using HslColor, converting the Hsl to Rgb
> * _color_ - an HslColor object
### RgbColor(HsbColor color); ### RgbColor(HsbColor color);
Construct a RgbColor using HsbColor, converting the Hsb to Rgb Construct a RgbColor using HsbColor, converting the Hsb to Rgb
> * _color_ - an HsbColor object
### RgbColor() ### RgbColor()
Construct a RgbColor that will have its values set in latter operations. Construct a RgbColor that will have its values set in latter operations.
@@ -37,27 +43,27 @@ NOTE: This is a simple linear brightness
### 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.
NOTE: This is a simple linear change. 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); ### void Lighten(uint8_t delta);
Lighten will adjust the color by the given delta toward white. Lighten will adjust the color by the given delta toward white.
NOTE: This is a simple linear change. NOTE: This is a simple linear change.
delta - (0-255) the amount to lighten the color by. > * _delta_ - (0-255) the amount to lighten the color by.
### static RgbColor LinearBlend(RgbColor left, RgbColor right, float progress); ### static RgbColor LinearBlend(RgbColor left, RgbColor right, float progress);
This will blend between two colors by the amount defined by the progress variable. This will blend between two colors by the amount defined by the progress variable.
left - the color to start the blend at. > * _left_ - the color to start the blend at.
right - the color to end 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. > * _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... This is a static function, which means you need to call it scoped to the object class and not an instance like...
``` ```
RgbColor results = RgbColor::LinearBlend(RgbColor(255,0,0), RgbColor(0,255,0), 0.33f); RgbColor results = RgbColor::LinearBlend(RgbColor(255,0,0), RgbColor(0,255,0), 0.33f);
``` ```
### static RgbColor BilinearBlend(RgbColor c00, RgbColor c01, RgbColor c10, RgbColor c11, float x, float y); ### static RgbColor BilinearBlend(RgbColor c00, RgbColor c01, RgbColor c10, RgbColor c11, float x, float y);
This will blend between four colors by the amount defined by 2d weighting values. This will blend between four colors by the amount defined by 2d weighting values.
c00 - upper left quadrant color > * _c00_ - upper left quadrant color
c01 - upper right quadrant color > * _c01_ - upper right quadrant color
c10 - lower left quadrant color > * _c10_ - lower left quadrant color
c11 - lower right quadrant color > * _c11_ - lower right quadrant color
x - unit value (0.0 - 1.0) that defines the blend progress in horizontal space > * _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 > * _y_ - unit value (0.0 - 1.0) that defines the blend progress in vertical space