source: trunk/SRC/Colors/color24.pro @ 155

Last change on this file since 155 was 137, checked in by smasson, 18 years ago

review of Colors and Calendar routines

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.5 KB
Line 
1;+
2;
3; @file_comments
4; The purpose of this function is to convert a RGB color triple
5; into the equivalent 24-big long integer.
6;
7; @categories Graphics, Color
8;
9; @param rgb_triple {in}{required}
10; A three-element column or row array representing
11; a color triple. The values of the elements must be between 0 and 255.
12;
13; @returns
14; a 24-bit long integer that is equivalent the input color.
15; The color is described in terms of a hexadecimal number (e.g., FF206A)
16; where the left two digits represent the blue color, the
17; middle two digits represent the green color, and the right
18; two digits represent the red color.
19;
20; @examples
21; To convert the color triple for the color YELLOW,
22; (255, 255, 0), to the hexadecimal value '00FFFF'x
23; or the decimal number 65535, type:
24;
25; IDL> color = COLOR24([255, 255, 0])
26;       
27; This routine was written to be used with routines like COLORS or GETCOLOR
28;
29; @history
30;       Written by:     David Fanning, 3 February 96.
31;
32; @version $Id$
33;
34;-
35FUNCTION COLOR24, rgb_triple
36;
37  compile_opt idl2, strictarrsubs
38;   
39ON_ERROR, 1
40
41IF N_ELEMENTS(rgb_triple) NE 3 THEN $
42   MESSAGE, 'Argument must be a three-element vector.'
43
44IF MAX(rgb_triple) GT 255 OR MIN(rgb_triple) LT 0 THEN $
45   MESSAGE, 'Argument values must be in range of 0-255'
46
47base16 = [[1L, 16L], [256L, 4096L], [65536L, 1048576L]]
48
49num24bit = 0L
50
51FOR j=0,2 DO num24bit = num24bit + ((rgb_triple[j] MOD 16) * base16[0,j]) + $
52   (Fix(rgb_triple[j]/16) * base16[1,j])
53   
54RETURN, num24bit
55END
Note: See TracBrowser for help on using the repository browser.