source: trunk/SRC/Documentation/idldoc_html_output/Colors/color24.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 4.4 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>color24.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="color24.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Colors//color24.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74&lt;&lt; prev file | <a href="colorbar.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="color24.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Colors/</a></h1>
82      <h2 class="pro_file">color24.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"> 
90 The purpose of this function is to convert a RGB color triple
91 into the equivalent 24-big long integer.
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_color24">
106
107          <h2><a class="top" href="#container">top</a>color24 <span class="categories"> Graphics, Color
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>color24(<span class="result"><a href="#_color24_param_rgb_triple">rgb_triple</a></span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat"> 
117 a 24-bit long integer that is equivalent the input color.
118 The color is described in terms of a hexadecimal number (e.g., FF206A)
119 where the left two digits represent the blue color, the
120 middle two digits represent the green color, and the right
121 two digits represent the red color.
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_color24_param_rgb_triple">rgb_triple&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments"> 
140 A three-element column or row array representing
141 a color triple. The values of the elements must be between 0 and 255.
142</div>
143           
144
145         
146
147         
148
149          <h3>Examples</h3><div class="preformat"> 
150 To convert the color triple for the color YELLOW,
151 (255, 255, 0), to the hexadecimal value '00FFFF'x
152 or the decimal number 65535, type:
153
154 IDL> color = COLOR24([255, 255, 0])
155       
156 This routine was written to be used with routines like COLORS or GETCOLOR
157</div>
158          <h3>Version history</h3>
159         
160          <h4>Version</h4><div class="preformat"> $Id: color24.pro 163 2006-08-29 12:59:46Z navarro $
161</div>
162          <h4>History</h4><div class="preformat">
163       Written by:     David Fanning, 3 February 96.
164</div>
165         
166         
167         
168         
169         
170         
171         
172       
173         
174         
175         
176         
177         
178         
179         
180       
181          <h3>Statistics</h3>
182          <table class="statistics">
183            <tr><td>McCabe cyclic</td><td>           4</td></tr>
184            <tr><td>McCabe essential</td><td>           1</td></tr>
185            <tr><td>McCabe modular design</td><td>           1</td></tr>
186          </table>
187         
188       
189        </div>
190       
191      </div>
192
193     
194
195      <div id="tagline">Produced by IDLdoc 2.0.</div>
196
197    </div>
198
199  </body>
200</html>
Note: See TracBrowser for help on using the repository browser.