summaryrefslogtreecommitdiff
path: root/FL
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2024-05-17 14:20:01 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2024-05-17 14:20:01 +0200
commitd0922792ae6be8c30fadfa93ad7cd482f38da160 (patch)
treef74b3608b177734e5443bcd582c3c518918dff81 /FL
parent7410498a7f056f4bbfb04ab3bd8286bea2c9ecf3 (diff)
Improve fl_contrast() functionality and documentation
- swap 3rd and 4th parameter of fl_contrast() - change 'Fl_Fontsize fs' to a neutral 'int size' parameter - clarify documentation of fl_contrast_level() and that different contrast algorithms use different level values - clarify that level 39 for the CIELAB mode results in "sufficient" contrast, i.e. /readable/ text which is the only intention of fl_contrast(). Reasoning: swapping the arguments looks more natural, i.e. the context before another argument (size) is what one would usually expect. Since the 'size' argument doesn't have be a font size, making it a simple 'int size' is more flexible and correct for future extensions.
Diffstat (limited to 'FL')
-rw-r--r--FL/Enumerations.H11
1 files changed, 7 insertions, 4 deletions
diff --git a/FL/Enumerations.H b/FL/Enumerations.H
index 3d5bc7f89..ff2f163e1 100644
--- a/FL/Enumerations.H
+++ b/FL/Enumerations.H
@@ -1161,19 +1161,22 @@ FL_EXPORT Fl_Color fl_inactive(Fl_Color c);
with fl_contrast_mode(FL_CONTRAST_CUSTOM).
Example:
\code
- Fl_Color my_contrast(Fl_Color fg, Fl_Color bg, Fl_Fontsize fs, int context) {
+ Fl_Color my_contrast(Fl_Color fg, Fl_Color bg, int context, int size) {
// calculate contrast and ...
return color;
}
// call this early in your main() program:
fl_contrast_function(my_contrast);
fl_contrast_mode(FL_CONTRAST_CUSTOM);
+ fl_contrast_level(50); // optional, must be called after fl_contrast_mode()
\endcode
- \see fl_contrast(Fl_Color, Fl_Color, Fl_Fontsize, int)
+ For parameters and types see fl_contrast(Fl_Color, Fl_Color, int, int).
+
+ \see fl_contrast(Fl_Color, Fl_Color, int, int)
\see fl_contrast_mode(int)
*/
-typedef Fl_Color (Fl_Contrast_Function)(Fl_Color, Fl_Color, Fl_Fontsize, int);
+typedef Fl_Color (Fl_Contrast_Function)(Fl_Color, Fl_Color, int, int);
FL_EXPORT void fl_contrast_function(Fl_Contrast_Function *f);
@@ -1195,7 +1198,7 @@ FL_EXPORT int fl_contrast_level();
FL_EXPORT void fl_contrast_mode(int mode);
FL_EXPORT int fl_contrast_mode();
-FL_EXPORT Fl_Color fl_contrast(Fl_Color fg, Fl_Color bg, Fl_Fontsize fs = 0, int context = 0);
+FL_EXPORT Fl_Color fl_contrast(Fl_Color fg, Fl_Color bg, int context = 0, int size = 0);
FL_EXPORT double fl_lightness(Fl_Color color);
FL_EXPORT double fl_luminance(Fl_Color color);