mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Corrected some documentation.

Browse source
This commit is contained in:
jules 2015-11-01 18:11:13 +00:00 • committed by Joshua Gerrard
parent 226eaa86f3
commit a004df192a
1 changed files with 1 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

8
modules/juce_graphics/colour/juce_Colour.h
View file

@ -282,30 +282,25 @@ public:
Colour withBrightness (float newBrightness) const noexcept;
/** Returns a copy of this colour with it hue rotated.
The new colour's hue is ((this->getHue() + amountToRotate) % 1.0)
@see brighter, darker, withMultipliedBrightness
*/
Colour withRotatedHue (float amountToRotate) const noexcept;
/** Returns a copy of this colour with its saturation multiplied by the given value.
The new colour's saturation is (this->getSaturation() * multiplier)
(the result is clipped to legal limits).
*/
Colour withMultipliedSaturation (float multiplier) const noexcept;
/** Returns a copy of this colour with its brightness multiplied by the given value.
The new colour's saturation is (this->getBrightness() * multiplier)
The new colour's brightness is (this->getBrightness() * multiplier)
(the result is clipped to legal limits).
*/
Colour withMultipliedBrightness (float amount) const noexcept;
//==============================================================================
/** Returns a brighter version of this colour.
@param amountBrighter how much brighter to make it - a value from 0 to 1.0 where 0 is
unchanged, and higher values make it brighter
@see withMultipliedBrightness
@ -313,7 +308,6 @@ public:
Colour brighter (float amountBrighter = 0.4f) const noexcept;
/** Returns a darker version of this colour.
@param amountDarker how much darker to make it - a value from 0 to 1.0 where 0 is
unchanged, and higher values make it darker
@see withMultipliedBrightness