core/vgui/vgui_color_text.h
Go to the documentation of this file.
00001 // This is core/vgui/vgui_color_text.h
00002 #ifndef vgui_color_text_h_
00003 #define vgui_color_text_h_
00004 //:
00005 // \file
00006 // \brief  Converts a string naming a colour to the RGB values.
00007 // \author K.Y.McGaul
00008 //
00009 //  e.g. "blue" is converted to "0.000 0.000 1.000".
00010 //
00011 // \verbatim
00012 //  Modifications
00013 //   K.Y.McGaul     25-FEB-2000   Initial version
00014 //   26-APR-2002  K.Y.McGaul - Added doxygen style comments.
00015 // \endverbatim
00016 
00017 #include <vcl_string.h>
00018 
00019 //: Convert a string naming a colour to a string of the RGB values.
00020 vcl_string text_to_color(const vcl_string&);
00021 //: Given a string naming a colour, return its red value.
00022 float red_value(const vcl_string&);
00023 //: Given a string naming a colour, return its green value.
00024 float green_value(const vcl_string&);
00025 //: Given a string naming a colour, return its blue value.
00026 float blue_value(const vcl_string&);
00027 
00028 #endif // vgui_color_text_h_