diff options
| author | Michael R Sweet <michael.r.sweet@gmail.com> | 2002-07-25 12:46:12 +0000 |
|---|---|---|
| committer | Michael R Sweet <michael.r.sweet@gmail.com> | 2002-07-25 12:46:12 +0000 |
| commit | d240b98ff6187831aba7309cca012cef410b4b29 (patch) | |
| tree | c6c0c810cda46fdf8acbae78a0f1e7b9960bec77 /documentation/functions.html | |
| parent | 749ebab917fc55ef367e5635609140ea1da36961 (diff) | |
Add missing color function documentation.
Fix Fl_Tabs document WRT coloring of the tabs and pane.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.1@2549 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/functions.html')
| -rw-r--r-- | documentation/functions.html | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/documentation/functions.html b/documentation/functions.html index d38f2615f..cdd3f7666 100644 --- a/documentation/functions.html +++ b/documentation/functions.html @@ -13,10 +13,13 @@ A</A>. <LI><A HREF="#fl_alert"><TT>fl_alert</TT></A></LI> <LI><A HREF="#fl_ask"><TT>fl_ask</TT></A></LI> + <LI><A HREF="#fl_average_color"><TT>fl_average_color</TT></A></LI> <LI><A HREF="#fl_beep"><TT>fl_beep</TT></A></LI> <LI><A HREF="#fl_choice2"><TT>fl_choice</TT></A></LI> <LI><A HREF="#fl_color_chooser_func"><TT>fl_color_chooser</TT></A></LI> <LI><A HREF="#fl_color_cube"><TT>fl_color_cube</TT></A></LI> + <LI><A HREF="#fl_contrast"><TT>fl_contrast</TT></A></LI> + <LI><A HREF="#fl_darker"><TT>fl_darker</TT></A></LI> <LI><A HREF="#fl_dir_chooser"><TT>fl_dir_chooser</TT></A></LI> <LI><A HREF="#fl_file_chooser2"><TT>fl_file_chooser</TT></A></LI> <LI><A HREF="#fl_file_chooser_callback"><TT>fl_file_chooser_callback</TT></A></LI> @@ -31,6 +34,7 @@ A</A>. <LI><A HREF="#fl_filename_setext"><TT>fl_filename_setext</TT></A></LI> <LI><A HREF="#fl_gray_ramp"><TT>fl_gray_ramp</TT></A></LI> <LI><A HREF="#fl_input2"><TT>fl_input</TT></A></LI> + <LI><A HREF="#fl_lighter"><TT>fl_lighter</TT></A></LI> <LI><A HREF="#fl_message"><TT>fl_message</TT></A></LI> <LI><A HREF="#fl_message_font"><TT>fl_message_font</TT></A></LI> <LI><A HREF="#fl_message_icon"><TT>fl_message_icon</TT></A></LI> @@ -67,8 +71,12 @@ A</A>. <LI>Drawing Functions <UL> + <LI><A HREF="#fl_average_color"><TT>fl_average_color</TT></A></LI> <LI><A HREF="#fl_color_cube"><TT>fl_color_cube</TT></A></LI> + <LI><A HREF="#fl_contrast"><TT>fl_contrast</TT></A></LI> + <LI><A HREF="#fl_darker"><TT>fl_darker</TT></A></LI> <LI><A HREF="#fl_gray_ramp"><TT>fl_gray_ramp</TT></A></LI> + <LI><A HREF="#fl_lighter"><TT>fl_lighter</TT></A></LI> <LI><A HREF="#fl_rgb_color"><TT>fl_rgb_color</TT></A></LI> </UL> @@ -149,6 +157,37 @@ a shortcut for No. <!-- NEED 4in --> +<H2><A NAME="fl_average_color">fl_average_color</A></H2> + +<HR> + +<H3>Include Files</H3> + +<UL><PRE> +#include <FL/Enumerations.H> +</PRE></UL> + +<H3>Prototype</H3> + +<UL><PRE> +Fl_Color fl_average_color(Fl_Color c1, Fl_Color c2, float weight); +</PRE></UL> + +<H3>Description</H3> + +<P>Returns the weighted average color between the two colors. +The red, green, and blue values are averaged using the following +formula: + +<UL><PRE> +color = c1 * weight + c2 * (1 - weight) +</PRE></UL> + +<P>Thus, a <CODE>weight</CODE> value of 1.0 will return the +first color, while a value of 0.0 will return the second color. + + +<!-- NEED 4in --> <H2><A name="fl_beep">fl_beep</A></H2> <HR> @@ -304,6 +343,53 @@ fl_color_cube(R * (FL_NUM_RED - 1) / 255, <!-- NEED 4in --> +<H2><A NAME="fl_contrast">fl_contrast</A></H2> + +<HR> + +<H3>Include Files</H3> + +<UL><PRE> +#include <FL/Enumerations.H> +</PRE></UL> + +<H3>Prototype</H3> + +<UL><PRE> +Fl_Color fl_contrast(Fl_Color fg, Fl_Color bg); +</PRE></UL> + +<H3>Description</H3> + +<P>Returns the foreground color if it contrasts sufficiently +with the background color. Otherwise, returns +<CODE>FL_WHITE</CODE> or <CODE>FL_BLACK</CODE> depending on +which color provides the best contrast. + + +<!-- NEED 4in --> +<H2><A NAME="fl_darker">fl_darker</A></H2> + +<HR> + +<H3>Include Files</H3> + +<UL><PRE> +#include <FL/Enumerations.H> +</PRE></UL> + +<H3>Prototype</H3> + +<UL><PRE> +Fl_Color fl_darker(Fl_Color c); +</PRE></UL> + +<H3>Description</H3> + +<P>Returns a darker version of the specified color. + + +<!-- NEED 4in --> <H2><A NAME="fl_dir_chooser">fl_dir_chooser</A></H2> <HR> @@ -807,6 +893,28 @@ label are after the default value. <!-- NEED 4in --> +<H2><A NAME="fl_lighter">fl_lighter</A></H2> + +<HR> + +<H3>Include Files</H3> + +<UL><PRE> +#include <FL/Enumerations.H> +</PRE></UL> + +<H3>Prototype</H3> + +<UL><PRE> +Fl_Color fl_lighter(Fl_Color c); +</PRE></UL> + +<H3>Description</H3> + +<P>Returns a lighter version of the specified color. + + +<!-- NEED 4in --> <H2><A name="fl_message">fl_message</A></H2> <HR> |
