upload tizen2.0 source
[framework/uifw/xorg/lib/libx11.git] / man / XcmsColor.man
1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
2 .\" Permission is hereby granted, free of charge, to any person obtaining
3 .\" a copy of this software and associated documentation files (the
4 .\" "Software"), to deal in the Software without restriction, including
5 .\" without limitation the rights to use, copy, modify, merge, publish,
6 .\" distribute, sublicense, and/or sell copies of the Software, and to
7 .\" permit persons to whom the Software is furnished to do so, subject to
8 .\" the following conditions:
9 .\"
10 .\" The above copyright notice and this permission notice shall be included
11 .\" in all copies or substantial portions of the Software.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
17 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19 .\" OTHER DEALINGS IN THE SOFTWARE.
20 .\"
21 .\" Except as contained in this notice, the name of the X Consortium shall
22 .\" not be used in advertising or otherwise to promote the sale, use or
23 .\" other dealings in this Software without prior written authorization
24 .\" from the X Consortium.
25 .\"
26 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
27 .\" Digital Equipment Corporation
28 .\"
29 .\" Portions Copyright \(co 1990, 1991 by
30 .\" Tektronix, Inc.
31 .\"
32 .\" Permission to use, copy, modify and distribute this documentation for
33 .\" any purpose and without fee is hereby granted, provided that the above
34 .\" copyright notice appears in all copies and that both that copyright notice
35 .\" and this permission notice appear in all copies, and that the names of
36 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
37 .\" to this documentation without specific, written prior permission.
38 .\" Digital and Tektronix makes no representations about the suitability
39 .\" of this documentation for any purpose.
40 .\" It is provided ``as is'' without express or implied warranty.
41 .\" 
42 .\"
43 .ds xT X Toolkit Intrinsics \- C Language Interface
44 .ds xW Athena X Widgets \- C Language X Toolkit Interface
45 .ds xL Xlib \- C Language X Interface
46 .ds xC Inter-Client Communication Conventions Manual
47 .na
48 .de Ds
49 .nf
50 .\\$1D \\$2 \\$1
51 .ft 1
52 .\".ps \\n(PS
53 .\".if \\n(VS>=40 .vs \\n(VSu
54 .\".if \\n(VS<=39 .vs \\n(VSp
55 ..
56 .de De
57 .ce 0
58 .if \\n(BD .DF
59 .nr BD 0
60 .in \\n(OIu
61 .if \\n(TM .ls 2
62 .sp \\n(DDu
63 .fi
64 ..
65 .de FD
66 .LP
67 .KS
68 .TA .5i 3i
69 .ta .5i 3i
70 .nf
71 ..
72 .de FN
73 .fi
74 .KE
75 .LP
76 ..
77 .de IN          \" send an index entry to the stderr
78 ..
79 .de C{
80 .KS
81 .nf
82 .D
83 .\"
84 .\"     choose appropriate monospace font
85 .\"     the imagen conditional, 480,
86 .\"     may be changed to L if LB is too
87 .\"     heavy for your eyes...
88 .\"
89 .ie "\\*(.T"480" .ft L
90 .el .ie "\\*(.T"300" .ft L
91 .el .ie "\\*(.T"202" .ft PO
92 .el .ie "\\*(.T"aps" .ft CW
93 .el .ft R
94 .ps \\n(PS
95 .ie \\n(VS>40 .vs \\n(VSu
96 .el .vs \\n(VSp
97 ..
98 .de C}
99 .DE
100 .R
101 ..
102 .de Pn
103 .ie t \\$1\fB\^\\$2\^\fR\\$3
104 .el \\$1\fI\^\\$2\^\fP\\$3
105 ..
106 .de ZN
107 .ie t \fB\^\\$1\^\fR\\$2
108 .el \fI\^\\$1\^\fP\\$2
109 ..
110 .de hN
111 .ie t <\fB\\$1\fR>\\$2
112 .el <\fI\\$1\fP>\\$2
113 ..
114 .de NT
115 .ne 7
116 .ds NO Note
117 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
118 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
119 .ie n .sp
120 .el .sp 10p
121 .TB
122 .ce
123 \\*(NO
124 .ie n .sp
125 .el .sp 5p
126 .if '\\$1'C' .ce 99
127 .if '\\$2'C' .ce 99
128 .in +5n
129 .ll -5n
130 .R
131 ..
132 .               \" Note End -- doug kraft 3/85
133 .de NE
134 .ce 0
135 .in -5n
136 .ll +5n
137 .ie n .sp
138 .el .sp 10p
139 ..
140 .ny0
141 .de EX
142 .sp
143 .nf
144 .ft CW
145 ..
146 .de EE
147 .ft R
148 .fi
149 .sp
150 ..
151 .TH XcmsColor __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
152 .SH NAME
153 XcmsColor, XcmsRGB, XcmsRGBi, XcmsCIEXYZ, XcmsCIEuvY, XcmsCIExyY, XcmsCIELab, XcmsCIELuv, XcmsTekHVC, XcmsPad \- Xcms color structure
154 .SH STRUCTURES
155 The structure for
156 .ZN XcmsColor
157 contains:
158 .LP
159 .EX
160 typedef unsigned long XcmsColorFormat;                  /\&* Color Specification Format */
161
162 typedef struct {
163         union {
164                 XcmsRGB RGB;
165                 XcmsRGBi RGBi;
166                 XcmsCIEXYZ CIEXYZ;
167                 XcmsCIEuvY CIEuvY;
168                 XcmsCIExyY CIExyY;
169                 XcmsCIELab CIELab;
170                 XcmsCIELuv CIELuv;
171                 XcmsTekHVC TekHVC;
172                 XcmsPad Pad;
173         } spec;
174         unsigned long pixel;
175         XcmsColorFormat format;
176 } XcmsColor;                    /\&* Xcms Color Structure */
177 .EE
178 .LP
179 .EX
180 typedef double XcmsFloat;
181
182 typedef struct {
183         unsigned short red;     /\&* 0x0000 to 0xffff */
184         unsigned short green;   /\&* 0x0000 to 0xffff */
185         unsigned short blue;    /\&* 0x0000 to 0xffff */
186 } XcmsRGB;              /\&* RGB Device */
187 .EE
188 .LP
189 .EX
190 typedef struct {
191         XcmsFloat red;  /\&* 0.0 to 1.0 */
192         XcmsFloat green;        /\&* 0.0 to 1.0 */
193         XcmsFloat blue; /\&* 0.0 to 1.0 */
194 } XcmsRGBi;             /\&* RGB Intensity */
195 .EE
196 .LP
197 .EX
198 typedef struct {
199         XcmsFloat X;
200         XcmsFloat Y;    /\&* 0.0 to 1.0 */
201         XcmsFloat Z;
202 } XcmsCIEXYZ;           /\&* CIE XYZ */
203 .EE
204 .LP
205 .EX
206 typedef struct {
207         XcmsFloat u_prime;      /\&* 0.0 to ~0.6 */
208         XcmsFloat v_prime;      /\&* 0.0 to ~0.6 */
209         XcmsFloat Y;    /\&* 0.0 to 1.0 */
210 } XcmsCIEuvY;           /\&* CIE u'v'Y */
211 .EE
212 .LP
213 .EX
214 typedef struct {
215         XcmsFloat x;    /\&* 0.0 to ~.75 */
216         XcmsFloat y;    /\&* 0.0 to ~.85 */
217         XcmsFloat Y;    /\&* 0.0 to 1.0 */
218 } XcmsCIExyY;           /\&* CIE xyY */
219 .EE
220 .LP
221 .EX
222 typedef struct {
223         XcmsFloat L_star;       /\&* 0.0 to 100.0 */
224         XcmsFloat a_star;
225         XcmsFloat b_star;
226 } XcmsCIELab;           /\&* CIE L*a*b* */
227 .EE
228 .LP
229 .EX
230 typedef struct {
231         XcmsFloat L_star;       /\&* 0.0 to 100.0 */
232         XcmsFloat u_star;
233         XcmsFloat v_star;
234 } XcmsCIELuv;           /\&* CIE L*u*v* */
235 .EE
236 .LP
237 .EX
238 typedef struct {
239         XcmsFloat H;    /\&* 0.0 to 360.0 */
240         XcmsFloat V;    /\&* 0.0 to 100.0 */
241         XcmsFloat C;    /\&* 0.0 to 100.0 */
242 } XcmsTekHVC;           /\&* TekHVC */
243 .EE
244 .LP
245 .EX
246 typedef struct {
247         XcmsFloat pad0;
248         XcmsFloat pad1;
249         XcmsFloat pad2;
250         XcmsFloat pad3;
251 } XcmsPad;              /\&* four doubles */
252 .EE
253 .SH DESCRIPTION
254 The
255 .ZN XcmsColor
256 structure contains a union of substructures,
257 each supporting color specification encoding for a particular color space.
258 .SH "SEE ALSO"
259 XcmsAllocColor(__libmansuffix__),
260 XcmsStoreColor(__libmansuffix__),
261 XcmsConvertColors(__libmansuffix__),
262 .LP
263 \fI\*(xL\fP