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

Normalize API doc styling

Nick Benik
2018-12-21 17:51:09 -05:00
parent 47b5d1f87f
commit c3a0226012
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
HsbColor-object-API.md

@@ -16,9 +16,13 @@ float B;
### HsbColor(float h, float s, float b) :
Constructs a HsbColor using Hue, Saturation, and Brightness color component values.
> * _h_ - value for Hue component (0.0f - 1.0f).
> * _s_ - value for Saturation component (0.0f - 1.0f).
> * _b_ - value for Brightness (0.0f - 1.0f).
### HsbColor(RgbColor color);
Construct a HsbColor using RgbColor, converting the Rgb to Hsb
> * _color_ - a RgbColor object.
### HsbColor()
Construct a HsbColor that will have its values set in latter operations.
@@ -28,9 +32,9 @@ CAUTION: The H,S,B members are not initialized and may not be consistent until
### template \<typename T_NEOHUEBLEND\> static HsbColor LinearBlend(HsbColor left, HsbColor right, float progress)
This will blend between two colors by the amount defined by the progress variable.
T_NEOHUEBLEND - [a NeoHueBlend object](https://github.com/Makuna/NeoPixelBus/wiki/NeoHueBlend-objects), that will define how the colors are blended.
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...
```
HsbColor results = HsbColor::LinearBlend<NeoHueBlendShortestDistance>(HsbColor(0.88f,1.0f,1.0f), HsbColor(0.12f,1.0f,1.0f), 0.33f);