summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-04 12:13:59 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-04 12:13:59 +0000
commitb40c69272fc4f788a7595b8834ab61dd6e2ba4f0 (patch)
tree483c3d55aae63d6bb29db68b88cd042723d12560
parent5fcfaa2fa1e2552077c9c059540f9c153664d2bc (diff)
Added return comments to rgb and hsv color chooser methods.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6370 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
-rw-r--r--src/Fl_Color_Chooser.cxx4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Fl_Color_Chooser.cxx b/src/Fl_Color_Chooser.cxx
index 9a49e5caf..677a46cfb 100644
--- a/src/Fl_Color_Chooser.cxx
+++ b/src/Fl_Color_Chooser.cxx
@@ -142,6 +142,7 @@ void Fl_Color_Chooser::set_valuators() {
Does not do the callback. Does not clamp (but out of range values will
produce psychedelic effects in the hue selector).
\param[in] R, G, B color components.
+ \return 1 if a new rgb value was set, 0 if the rgb value was the previous one.
*/
int Fl_Color_Chooser::rgb(double R, double G, double B) {
if (R == r_ && G == g_ && B == b_) return 0;
@@ -169,7 +170,8 @@ int Fl_Color_Chooser::rgb(double R, double G, double B) {
The passed values are clamped (or for hue, modulus 6 is used) to get
legal values. Does not do the callback.
\param[in] H, S, V color components.
- */
+ \return 1 if a new hsv value was set, 0 if the hsv value was the previous one.
+*/
int Fl_Color_Chooser::hsv(double H, double S, double V) {
H = fmod(H,6.0); if (H < 0.0) H += 6.0;
if (S < 0.0) S = 0.0; else if (S > 1.0) S = 1.0;