upload tizen2.0 source
[framework/uifw/xorg/lib/libx11.git] / man / XcmsTekHVCQueryMaxC.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 XcmsTekHVCQueryMaxC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
143 .SH NAME
144 XcmsTekHVCQueryMaxC, XcmsTekHVCQueryMaxV, XcmsTekHVCQueryMaxVC, XcmsTekHVCQueryMaxVSamples, XcmsTekHVCQueryMinV \- obtain the TekHVC coordinates
145 .SH SYNTAX
146 .HP
147 Status XcmsTekHVCQueryMaxC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^,
148 XcmsFloat \fIvalue\fP\^, XcmsColor *\fIcolor_return\fP\^); 
149 .HP
150 Status XcmsTekHVCQueryMaxV\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^,
151 XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); 
152 .HP
153 Status XcmsTekHVCQueryMaxVC\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^,
154 XcmsColor *\fIcolor_return\fP\^); 
155 .HP
156 Status XcmsTekHVCQueryMaxVSamples\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat
157 \fIhue\fP\^, XcmsColor \fIcolors_return[]\fP\^, unsigned int
158 \fInsamples\fP\^); 
159 .HP
160 Status XcmsTekHVCQueryMinV\^(\^XcmsCCC \fIccc\fP\^, XcmsFloat \fIhue\fP\^,
161 XcmsFloat \fIchroma\fP\^, XcmsColor *\fIcolor_return\fP\^); 
162 .SH ARGUMENTS
163 .IP \fIccc\fP 1i
164 Specifies the CCC.
165 Note that the CCC's Client White Point and White Point Adjustment procedures
166 are ignored.
167 .ds Ch maximum Value (MaxV)
168 .IP \fIchroma\fP 1i
169 Specifies the chroma at which to find \*(Ch.
170 .IP \fIcolors_return\fP 1i
171 Returns nsamples of color specifications in XcmsTekHVC
172 such that the Chroma is the maximum attainable for the Value and Hue.
173 The white point associated with the returned
174 color specification is the Screen White Point.
175 The value returned in the pixel member is undefined.
176 .ds Lc maximum Chroma along with the actual Hue and Value (MaxC), \
177 maximum Value along with the Hue and Chroma (MaxV), \
178 color specification in XcmsTekHVC for the maximum Chroma, \
179 the Value at which that maximum Chroma is reached and actual Hue (MaxVC) \
180 or minimum Value and the actual Hue and Chroma (MinL)
181 .ds lC maximum Chroma (MaxC and MaxVC), maximum Value (MaxV), or \
182 minimum Value (MinL)
183 .IP \fIcolor_return\fP 1i
184 Returns the \*(Lc at which the \*(lC was found.
185 The white point associated with the returned
186 color specification is the Screen White Point.
187 The value returned in the pixel member is undefined.
188 .ds Hu in which to find the maximum Chroma (MaxC and MaxVC), \
189 maximum Value (MaxV), the maximum Chroma/Value samples (MaxVSamples), \
190 or the minimum Value (MinL)
191 .IP \fIhue\fP 1i
192 Specifies the Hue \*(Hu.
193 .IP \fInsamples\fP 1i
194 Specifies the number of samples.
195 .ds Va maximum Chroma (MaxC) or minimum Value (MinL)
196 .IP \fIvalue\fP 1i
197 Specifies the Value in which to find the \*(Va.
198 .SH DESCRIPTION
199 The
200 .ZN XcmsTekHVCQueryMaxC
201 function, given a Hue and Value,
202 determines the maximum Chroma in TekHVC color space
203 displayable by the screen.
204 It returns the maximum Chroma along with the actual Hue
205 and Value at which the maximum Chroma was found.
206 .LP
207 The
208 .ZN XcmsTekHVCQueryMaxV
209 function, given a Hue and Chroma,
210 determines the maximum Value in TekHVC color space
211 displayable by the screen.
212 It returns the maximum Value and the actual Hue and Chroma
213 at which the maximum Value was found.
214 .LP
215 The
216 .ZN XcmsTekHVCQueryMaxVC
217 function, given a Hue,
218 determines the maximum Chroma in TekHVC color space displayable by the screen
219 and the Value at which that maximum Chroma is reached.
220 It returns the maximum Chroma,
221 the Value at which that maximum Chroma is reached,
222 and the actual Hue for which the maximum Chroma was found.
223 .LP
224 The
225 .ZN XcmsTekHVCQueryMaxVSamples
226 returns nsamples of maximum Value, the Chroma at which that maximum Value
227 is reached, and the actual Hue for which the maximum Chroma was found.
228 These sample points may then be used to plot the maximum Value/Chroma
229 boundary of the screen's color gamut for the specified Hue in TekHVC color
230 space.
231 .LP
232 The
233 .ZN XcmsTekHVCQueryMinV
234 function, given a Hue and Chroma,
235 determines the minimum Value in TekHVC color space displayable by the screen.
236 It returns the minimum Value and the actual Hue and Chroma at which
237 the minimum Value was found.
238 .SH "SEE ALSO"
239 XcmsCIELabQueryMaxC(__libmansuffix__),
240 XcmsCIELuvQueryMaxC(__libmansuffix__),
241 XcmsQueryBlack(__libmansuffix__)
242 .br
243 \fI\*(xL\fP