source: trunk/SRC/Documentation/idldoc_assistant_output/Colors/color24.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 3.3 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>color24.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href=""><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="colorbar.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Colors/</font></h1>
58    <h2>color24.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 The purpose of this function is to convert a RGB color triple
65 into the equivalent 24-big long integer.
66
67
68   
69
70     
71      <a name="#_color24"></a>
72
73      <h2>color24  <font size="-1" color="#006633"> Graphics, Color
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>color24(<i><a href="#_color24_keyword_rgb_triple">rgb_triple</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3> 
82 a 24-bit long integer that is equivalent the input color.
83 The color is described in terms of a hexadecimal number (e.g., FF206A)
84 where the left two digits represent the blue color, the
85 middle two digits represent the green color, and the right
86 two digits represent the red color.
87
88
89   
90    <h3>Parameters</h3>
91   
92
93    <a name="#_color24_keyword_rgb_triple"></a>
94    <h4>rgb_triple&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
95      <font size="-1" color="#006633">in</font>
96     
97     
98      <font size="-1" color="#006633">required</font>
99     
100     
101     
102     
103    </h4>
104
105     
106 A three-element column or row array representing
107 a color triple. The values of the elements must be between 0 and 255.
108
109   
110   
111
112   
113
114    <h3>Examples</h3> 
115 To convert the color triple for the color YELLOW,
116 (255, 255, 0), to the hexadecimal value '00FFFF'x
117 or the decimal number 65535, type:
118
119 IDL> color = COLOR24([255, 255, 0])
120       
121 This routine was written to be used with routines like COLORS or GETCOLOR
122
123    <h3>Version history</h3>
124   
125    <h4>Version</h4> $Id: color24.pro 137 2006-07-12 09:33:44Z smasson $
126
127    <h4>History</h4>
128       Written by:     David Fanning, 3 February 96.
129
130   
131
132   
133   
134   
135   
136   
137
138   
139   
140   
141   
142   
143   
144   
145
146    <font size="-3"><p>&nbsp;</p></font>
147    <hr size="1" color="#CCCCCC"/>
148     
149
150   
151
152    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:05 2006.</font></p>
153
154  </body>
155</html>
Note: See TracBrowser for help on using the repository browser.