diff options
Diffstat (limited to 'FL')
| -rw-r--r-- | FL/Fl_Scheme.H | 30 |
1 files changed, 23 insertions, 7 deletions
diff --git a/FL/Fl_Scheme.H b/FL/Fl_Scheme.H index 9a0f3cbf4..48e0e8d0a 100644 --- a/FL/Fl_Scheme.H +++ b/FL/Fl_Scheme.H @@ -1,7 +1,7 @@ // -// Scheme header for the Fast Light Tool Kit (FLTK). +// Fl_Scheme header for the Fast Light Tool Kit (FLTK). // -// Copyright 2022-2023 by Bill Spitzak and others. +// Copyright 2022-2025 by Bill Spitzak and others. // // This library is free software. Distribution and use rights are outlined in // the file "COPYING" which should have been included with this file. If this @@ -14,12 +14,22 @@ // https://www.fltk.org/bugs.php // -#ifndef FL_Fl_Scheme_H_ -#define FL_Fl_Scheme_H_ +#ifndef _FL_Fl_Scheme_H_ +#define _FL_Fl_Scheme_H_ #include <FL/Fl.H> -class Fl_Scheme { +/** + \brief Base class with static methods for future Fl_Scheme classes. + + This class is intentionally not fully documented and is subject to change + in future FLTK versions. + + \note Do not rely on details of this class. + + \since 1.4.0 +*/ +class FL_EXPORT Fl_Scheme { private: @@ -54,11 +64,17 @@ public: return num_schemes_; } - // Adding a scheme name must be a public static method in FLTK 1.4.0. + // Adding a scheme name must be a public static method in (since) FLTK 1.4.0. // This will later be protected or replaced by another method name. static int add_scheme_name(const char *name); + // Set color average parameter of the 'plastic' scheme. + // See GitHub Issue 464: "RFE: plastic scheme with faithful colors". + // See also documentation and implementation in src/fl_plastic.cxx. + + static void plastic_color_average(int av); + }; // class Fl_Scheme -#endif // FL_Fl_Scheme_H_ +#endif // _FL_Fl_Scheme_H_ |