65465d8994f052821ac2c7ce58d079c7ea961eb2
[platform/upstream/libX11.git] / man / XcmsCreateCCC.man
1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
2 .\"
3 .\" Permission is hereby granted, free of charge, to any person obtaining
4 .\" a copy of this software and associated documentation files (the
5 .\" "Software"), to deal in the Software without restriction, including
6 .\" without limitation the rights to use, copy, modify, merge, publish,
7 .\" distribute, sublicense, and/or sell copies of the Software, and to
8 .\" permit persons to whom the Software is furnished to do so, subject to
9 .\" the following conditions:
10 .\"
11 .\" The above copyright notice and this permission notice shall be included
12 .\" in all copies or substantial portions of the Software.
13 .\"
14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 .\" OTHER DEALINGS IN THE SOFTWARE.
21 .\"
22 .\" Except as contained in this notice, the name of the X Consortium shall
23 .\" not be used in advertising or otherwise to promote the sale, use or
24 .\" other dealings in this Software without prior written authorization
25 .\" from the X Consortium.
26 .\"
27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
28 .\" Digital Equipment Corporation
29 .\"
30 .\" Portions Copyright \(co 1990, 1991 by
31 .\" Tektronix, Inc.
32 .\"
33 .\" Permission to use, copy, modify and distribute this documentation for
34 .\" any purpose and without fee is hereby granted, provided that the above
35 .\" copyright notice appears in all copies and that both that copyright notice
36 .\" and this permission notice appear in all copies, and that the names of
37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
38 .\" to this documentation without specific, written prior permission.
39 .\" Digital and Tektronix makes no representations about the suitability
40 .\" of this documentation for any purpose.
41 .\" It is provided ``as is'' without express or implied warranty.
42 .\" 
43 .\"
44 .ds xT X Toolkit Intrinsics \- C Language Interface
45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
46 .ds xL Xlib \- C Language X Interface
47 .ds xC Inter-Client Communication Conventions Manual
48 .na
49 .de Ds
50 .nf
51 .\\$1D \\$2 \\$1
52 .ft 1
53 .\".ps \\n(PS
54 .\".if \\n(VS>=40 .vs \\n(VSu
55 .\".if \\n(VS<=39 .vs \\n(VSp
56 ..
57 .de De
58 .ce 0
59 .if \\n(BD .DF
60 .nr BD 0
61 .in \\n(OIu
62 .if \\n(TM .ls 2
63 .sp \\n(DDu
64 .fi
65 ..
66 .de FD
67 .LP
68 .KS
69 .TA .5i 3i
70 .ta .5i 3i
71 .nf
72 ..
73 .de FN
74 .fi
75 .KE
76 .LP
77 ..
78 .de IN          \" send an index entry to the stderr
79 ..
80 .de C{
81 .KS
82 .nf
83 .D
84 .\"
85 .\"     choose appropriate monospace font
86 .\"     the imagen conditional, 480,
87 .\"     may be changed to L if LB is too
88 .\"     heavy for your eyes...
89 .\"
90 .ie "\\*(.T"480" .ft L
91 .el .ie "\\*(.T"300" .ft L
92 .el .ie "\\*(.T"202" .ft PO
93 .el .ie "\\*(.T"aps" .ft CW
94 .el .ft R
95 .ps \\n(PS
96 .ie \\n(VS>40 .vs \\n(VSu
97 .el .vs \\n(VSp
98 ..
99 .de C}
100 .DE
101 .R
102 ..
103 .de Pn
104 .ie t \\$1\fB\^\\$2\^\fR\\$3
105 .el \\$1\fI\^\\$2\^\fP\\$3
106 ..
107 .de ZN
108 .ie t \fB\^\\$1\^\fR\\$2
109 .el \fI\^\\$1\^\fP\\$2
110 ..
111 .de hN
112 .ie t <\fB\\$1\fR>\\$2
113 .el <\fI\\$1\fP>\\$2
114 ..
115 .de NT
116 .ne 7
117 .ds NO Note
118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
120 .ie n .sp
121 .el .sp 10p
122 .TB
123 .ce
124 \\*(NO
125 .ie n .sp
126 .el .sp 5p
127 .if '\\$1'C' .ce 99
128 .if '\\$2'C' .ce 99
129 .in +5n
130 .ll -5n
131 .R
132 ..
133 .               \" Note End -- doug kraft 3/85
134 .de NE
135 .ce 0
136 .in -5n
137 .ll +5n
138 .ie n .sp
139 .el .sp 10p
140 ..
141 .ny0
142 .TH XcmsCreateCCC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
143 .SH NAME
144 XcmsCreateCCC, XcmsFreeCCC \- creating and destroying CCCs
145 .SH SYNTAX
146 .HP
147 XcmsCCC XcmsCreateCCC\^(\^Display *\fIdisplay\fP\^, int \fIscreen_number\fP\^,
148 Visual *\fIvisual\fP\^, XcmsColor *\fIclient_white_point\fP\^,
149 XcmsCompressionProc \fIcompression_proc\fP\^, XPointer
150 \fIcompression_client_data\fP\^, XcmsWhiteAdjustProc
151 \fIwhite_adjust_proc\fP\^, XPointer \fIwhite_adjust_client_data\fP\^); 
152 .LP
153 void XcmsFreeCCC\^(\^XcmsCCC \fIccc\fP\^); 
154 .SH ARGUMENTS
155 .IP \fIdisplay\fP 1i
156 Specifies the connection to the X server.
157 .IP \fIccc\fP 1i
158 Specifies the CCC.
159 .IP \fIclient_white_point\fP 1i
160 Specifies the Client White Point.
161 If NULL is specified, 
162 the Client White Point is to be assumed to be the same as the
163 Screen White Point.
164 Note that the pixel member is ignored.
165 .IP \fIcompression_client_data\fP 1i
166 Specifies client data for use by the gamut compression procedure or NULL.
167 .IP \fIcompression_proc\fP 1i
168 Specifies the gamut compression procedure that is to be applied 
169 when a color lies outside the screen's color gamut.
170 If NULL is specified and a function using this CCC must convert
171 a color specification to a device-dependent format and encounters a color
172 that lies outside the screen's color gamut, 
173 that function will return
174 .ZN XcmsFailure .
175 .IP \fIscreen_number\fP 1i
176 Specifies the appropriate screen number on the host server.
177 .IP \fIvisual\fP 1i
178 Specifies the visual type.
179 .IP \fIwhite_adjust_client_data\fP 1i
180 Specifies client data for use with the white point adjustment procedure or NULL.
181 .IP \fIwhite_adjust_proc\fP 1i
182 Specifies the white adjustment procedure that is to be applied
183 when the Client White Point differs from the Screen White Point.
184 NULL indicates that no white point adjustment is desired.
185 .SH DESCRIPTION
186 The
187 .ZN XcmsCreateCCC
188 function creates a CCC for the specified display, screen, and visual.
189 .LP
190 The
191 .ZN XcmsFreeCCC
192 function frees the memory used for the specified CCC.
193 Note that default CCCs and those currently associated with colormaps
194 are ignored.
195 .SH "SEE ALSO"
196 DisplayOfCCC(__libmansuffix__),
197 XcmsCCCOfColormap(__libmansuffix__),
198 XcmsConvertColors(__libmansuffix__),
199 XcmsDefaultCCC(__libmansuffix__),
200 XcmsSetWhitePoint(__libmansuffix__)
201 .br
202 \fI\*(xL\fP