Debian Codegraph @

java/doc/org/libjpegturbo/turbojpeg/TJ.html

raw
1 <!DOCTYPE HTML>
2 <!-- NewPage -->
3 <html lang="en">
4 <head>
5 <!-- Generated by javadoc -->
6 <title>TJ</title>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9 <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.min.css" title="Style">
10 <link rel="stylesheet" type="text/css" href="../../../jquery-ui.overrides.css" title="Style">
11 <script type="text/javascript" src="../../../script.js"></script>
12 <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
13 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
14 <!--[if IE]>
15 <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
16 <![endif]-->
17 <script type="text/javascript" src="../../../jquery/jquery-3.7.1.min.js"></script>
18 <script type="text/javascript" src="../../../jquery/jquery-ui.min.js"></script>
19 </head>
20 <body>
21 <script type="text/javascript"><!--
22 try {
23 if (location.href.indexOf('is-external=true') == -1) {
24 parent.document.title="TJ";
25 }
26 }
27 catch(err) {
28 }
29 //-->
30 var data = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9};
31 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
32 var altColor = "altColor";
33 var rowColor = "rowColor";
34 var tableTab = "tableTab";
35 var activeTableTab = "activeTableTab";
36 var pathtoroot = "../../../";
37 var useModuleDirectories = true;
38 loadScripts(document, 'script');</script>
39 <noscript>
40 <div>JavaScript is disabled on your browser.</div>
41 </noscript>
42 <header role="banner">
43 <nav role="navigation">
44 <div class="fixedNav">
45 <!-- ========= START OF TOP NAVBAR ======= -->
46 <div class="topNav"><a id="navbar.top">
47 <!-- -->
48 </a>
49 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
50 <a id="navbar.top.firstrow">
51 <!-- -->
52 </a>
53 <ul class="navList" title="Navigation">
54 <li><a href="package-summary.html">Package</a></li>
55 <li class="navBarCell1Rev">Class</li>
56 <li><a href="package-tree.html">Tree</a></li>
57 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
58 <li><a href="../../../index-all.html">Index</a></li>
59 <li><a href="../../../help-doc.html">Help</a></li>
60 </ul>
61 </div>
62 <div class="subNav">
63 <ul class="navList" id="allclasses_navbar_top">
64 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
65 </ul>
66 <ul class="navListSearch">
67 <li><label for="search">SEARCH:</label>
68 <input type="text" id="search" value="search" disabled="disabled">
69 <input type="reset" id="reset" value="reset" disabled="disabled">
70 </li>
71 </ul>
72 <div>
73 <script type="text/javascript"><!--
74 allClassesLink = document.getElementById("allclasses_navbar_top");
75 if(window==top) {
76 allClassesLink.style.display = "block";
77 }
78 else {
79 allClassesLink.style.display = "none";
80 }
81 //-->
82 </script>
83 <noscript>
84 <div>JavaScript is disabled on your browser.</div>
85 </noscript>
86 </div>
87 <div>
88 <ul class="subNavList">
89 <li>Summary:&nbsp;</li>
90 <li>Nested&nbsp;|&nbsp;</li>
91 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
92 <li>Constr&nbsp;|&nbsp;</li>
93 <li><a href="#method.summary">Method</a></li>
94 </ul>
95 <ul class="subNavList">
96 <li>Detail:&nbsp;</li>
97 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
98 <li>Constr&nbsp;|&nbsp;</li>
99 <li><a href="#method.detail">Method</a></li>
100 </ul>
101 </div>
102 <a id="skip.navbar.top">
103 <!-- -->
104 </a></div>
105 <!-- ========= END OF TOP NAVBAR ========= -->
106 </div>
107 <div class="navPadding">&nbsp;</div>
108 <script type="text/javascript"><!--
109 $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
110 //-->
111 </script>
112 </nav>
113 </header>
114 <!-- ======== START OF CLASS DATA ======== -->
115 <main role="main">
116 <div class="header">
117 <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.libjpegturbo.turbojpeg</a></div>
118 <h2 title="Class TJ" class="title">Class TJ</h2>
119 </div>
120 <div class="contentContainer">
121 <ul class="inheritance">
122 <li>java.lang.Object</li>
123 <li>
124 <ul class="inheritance">
125 <li>org.libjpegturbo.turbojpeg.TJ</li>
126 </ul>
127 </li>
128 </ul>
129 <div class="description">
130 <ul class="blockList">
131 <li class="blockList">
132 <hr>
133 <pre>public final class <span class="typeNameLabel">TJ</span>
134 extends java.lang.Object</pre>
135 <div class="block">TurboJPEG utility class (cannot be instantiated)</div>
136 </li>
137 </ul>
138 </div>
139 <div class="summary">
140 <ul class="blockList">
141 <li class="blockList">
142 <!-- =========== FIELD SUMMARY =========== -->
143 <section>
144 <ul class="blockList">
145 <li class="blockList"><a id="field.summary">
146 <!-- -->
147 </a>
148 <h3>Field Summary</h3>
149 <table class="memberSummary">
150 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
151 <tr>
152 <th class="colFirst" scope="col">Modifier and Type</th>
153 <th class="colSecond" scope="col">Field</th>
154 <th class="colLast" scope="col">Description</th>
155 </tr>
156 <tr class="altColor">
157 <td class="colFirst"><code>static int</code></td>
158 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CS_CMYK">CS_CMYK</a></span></code></th>
159 <td class="colLast">
160 <div class="block">CMYK colorspace</div>
161 </td>
162 </tr>
163 <tr class="rowColor">
164 <td class="colFirst"><code>static int</code></td>
165 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CS_GRAY">CS_GRAY</a></span></code></th>
166 <td class="colLast">
167 <div class="block">Grayscale colorspace</div>
168 </td>
169 </tr>
170 <tr class="altColor">
171 <td class="colFirst"><code>static int</code></td>
172 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CS_RGB">CS_RGB</a></span></code></th>
173 <td class="colLast">
174 <div class="block">RGB colorspace</div>
175 </td>
176 </tr>
177 <tr class="rowColor">
178 <td class="colFirst"><code>static int</code></td>
179 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CS_YCbCr">CS_YCbCr</a></span></code></th>
180 <td class="colLast">
181 <div class="block">YCbCr colorspace</div>
182 </td>
183 </tr>
184 <tr class="altColor">
185 <td class="colFirst"><code>static int</code></td>
186 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CS_YCCK">CS_YCCK</a></span></code></th>
187 <td class="colLast">
188 <div class="block">YCCK colorspace</div>
189 </td>
190 </tr>
191 <tr class="rowColor">
192 <td class="colFirst"><code>static int</code></td>
193 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ERR_FATAL">ERR_FATAL</a></span></code></th>
194 <td class="colLast">
195 <div class="block">The error was fatal and non-recoverable.</div>
196 </td>
197 </tr>
198 <tr class="altColor">
199 <td class="colFirst"><code>static int</code></td>
200 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ERR_WARNING">ERR_WARNING</a></span></code></th>
201 <td class="colLast">
202 <div class="block">The error was non-fatal and recoverable, but the destination image may
203 still be corrupt.</div>
204 </td>
205 </tr>
206 <tr class="rowColor">
207 <td class="colFirst"><code>static int</code></td>
208 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NUMCS">NUMCS</a></span></code></th>
209 <td class="colLast">
210 <div class="block">The number of JPEG colorspaces</div>
211 </td>
212 </tr>
213 <tr class="altColor">
214 <td class="colFirst"><code>static int</code></td>
215 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NUMERR">NUMERR</a></span></code></th>
216 <td class="colLast">
217 <div class="block">The number of error codes</div>
218 </td>
219 </tr>
220 <tr class="rowColor">
221 <td class="colFirst"><code>static int</code></td>
222 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NUMPF">NUMPF</a></span></code></th>
223 <td class="colLast">
224 <div class="block">The number of pixel formats</div>
225 </td>
226 </tr>
227 <tr class="altColor">
228 <td class="colFirst"><code>static int</code></td>
229 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#NUMSAMP">NUMSAMP</a></span></code></th>
230 <td class="colLast">
231 <div class="block">The number of chrominance subsampling options</div>
232 </td>
233 </tr>
234 <tr class="rowColor">
235 <td class="colFirst"><code>static int</code></td>
236 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_ARITHMETIC">PARAM_ARITHMETIC</a></span></code></th>
237 <td class="colLast">
238 <div class="block">Arithmetic entropy coding</div>
239 </td>
240 </tr>
241 <tr class="altColor">
242 <td class="colFirst"><code>static int</code></td>
243 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_BOTTOMUP">PARAM_BOTTOMUP</a></span></code></th>
244 <td class="colLast">
245 <div class="block">Row order in packed-pixel source/destination images</div>
246 </td>
247 </tr>
248 <tr class="rowColor">
249 <td class="colFirst"><code>static int</code></td>
250 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_COLORSPACE">PARAM_COLORSPACE</a></span></code></th>
251 <td class="colLast">
252 <div class="block">JPEG colorspace</div>
253 </td>
254 </tr>
255 <tr class="altColor">
256 <td class="colFirst"><code>static int</code></td>
257 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_DENSITYUNITS">PARAM_DENSITYUNITS</a></span></code></th>
258 <td class="colLast">
259 <div class="block">JPEG pixel density units</div>
260 </td>
261 </tr>
262 <tr class="rowColor">
263 <td class="colFirst"><code>static int</code></td>
264 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_FASTDCT">PARAM_FASTDCT</a></span></code></th>
265 <td class="colLast">
266 <div class="block">DCT/IDCT algorithm [lossy compression and decompression]</div>
267 </td>
268 </tr>
269 <tr class="altColor">
270 <td class="colFirst"><code>static int</code></td>
271 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_FASTUPSAMPLE">PARAM_FASTUPSAMPLE</a></span></code></th>
272 <td class="colLast">
273 <div class="block">Chrominance upsampling algorithm [lossy decompression only]</div>
274 </td>
275 </tr>
276 <tr class="rowColor">
277 <td class="colFirst"><code>static int</code></td>
278 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_JPEGHEIGHT">PARAM_JPEGHEIGHT</a></span></code></th>
279 <td class="colLast">
280 <div class="block">JPEG height (in pixels) [decompression only, read-only]</div>
281 </td>
282 </tr>
283 <tr class="altColor">
284 <td class="colFirst"><code>static int</code></td>
285 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_JPEGWIDTH">PARAM_JPEGWIDTH</a></span></code></th>
286 <td class="colLast">
287 <div class="block">JPEG width (in pixels) [decompression only, read-only]</div>
288 </td>
289 </tr>
290 <tr class="rowColor">
291 <td class="colFirst"><code>static int</code></td>
292 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_LOSSLESS">PARAM_LOSSLESS</a></span></code></th>
293 <td class="colLast">
294 <div class="block">Lossless JPEG</div>
295 </td>
296 </tr>
297 <tr class="altColor">
298 <td class="colFirst"><code>static int</code></td>
299 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_LOSSLESSPSV">PARAM_LOSSLESSPSV</a></span></code></th>
300 <td class="colLast">
301 <div class="block">Lossless JPEG predictor selection value (PSV)</div>
302 </td>
303 </tr>
304 <tr class="rowColor">
305 <td class="colFirst"><code>static int</code></td>
306 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_LOSSLESSPT">PARAM_LOSSLESSPT</a></span></code></th>
307 <td class="colLast">
308 <div class="block">Lossless JPEG point transform (Pt)</div>
309 </td>
310 </tr>
311 <tr class="altColor">
312 <td class="colFirst"><code>static int</code></td>
313 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_MAXMEMORY">PARAM_MAXMEMORY</a></span></code></th>
314 <td class="colLast">
315 <div class="block">Memory limit for intermediate buffers</div>
316 </td>
317 </tr>
318 <tr class="rowColor">
319 <td class="colFirst"><code>static int</code></td>
320 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_MAXPIXELS">PARAM_MAXPIXELS</a></span></code></th>
321 <td class="colLast">
322 <div class="block">Image size limit [decompression, lossless transformation]</div>
323 </td>
324 </tr>
325 <tr class="altColor">
326 <td class="colFirst"><code>static int</code></td>
327 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_OPTIMIZE">PARAM_OPTIMIZE</a></span></code></th>
328 <td class="colLast">
329 <div class="block">Huffman table optimization [lossy compression, lossless transformation]</div>
330 </td>
331 </tr>
332 <tr class="rowColor">
333 <td class="colFirst"><code>static int</code></td>
334 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_PRECISION">PARAM_PRECISION</a></span></code></th>
335 <td class="colLast">
336 <div class="block">Data precision (bits per sample)</div>
337 </td>
338 </tr>
339 <tr class="altColor">
340 <td class="colFirst"><code>static int</code></td>
341 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_PROGRESSIVE">PARAM_PROGRESSIVE</a></span></code></th>
342 <td class="colLast">
343 <div class="block">Progressive JPEG</div>
344 </td>
345 </tr>
346 <tr class="rowColor">
347 <td class="colFirst"><code>static int</code></td>
348 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_QUALITY">PARAM_QUALITY</a></span></code></th>
349 <td class="colLast">
350 <div class="block">Perceptual quality of lossy JPEG images [compression only]</div>
351 </td>
352 </tr>
353 <tr class="altColor">
354 <td class="colFirst"><code>static int</code></td>
355 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_RESTARTBLOCKS">PARAM_RESTARTBLOCKS</a></span></code></th>
356 <td class="colLast">
357 <div class="block">JPEG restart marker interval in MCUs [lossy compression only]</div>
358 </td>
359 </tr>
360 <tr class="rowColor">
361 <td class="colFirst"><code>static int</code></td>
362 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_RESTARTROWS">PARAM_RESTARTROWS</a></span></code></th>
363 <td class="colLast">
364 <div class="block">JPEG restart marker interval in MCU rows [compression only]</div>
365 </td>
366 </tr>
367 <tr class="altColor">
368 <td class="colFirst"><code>static int</code></td>
369 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_SAVEMARKERS">PARAM_SAVEMARKERS</a></span></code></th>
370 <td class="colLast">
371 <div class="block">Marker copying behavior [decompression, lossless transformation]</div>
372 </td>
373 </tr>
374 <tr class="rowColor">
375 <td class="colFirst"><code>static int</code></td>
376 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_SCANLIMIT">PARAM_SCANLIMIT</a></span></code></th>
377 <td class="colLast">
378 <div class="block">Progressive JPEG scan limit for lossy JPEG images [decompression, lossless
379 transformation]</div>
380 </td>
381 </tr>
382 <tr class="altColor">
383 <td class="colFirst"><code>static int</code></td>
384 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_STOPONWARNING">PARAM_STOPONWARNING</a></span></code></th>
385 <td class="colLast">
386 <div class="block">Error handling behavior</div>
387 </td>
388 </tr>
389 <tr class="rowColor">
390 <td class="colFirst"><code>static int</code></td>
391 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_SUBSAMP">PARAM_SUBSAMP</a></span></code></th>
392 <td class="colLast">
393 <div class="block">Chrominance subsampling level</div>
394 </td>
395 </tr>
396 <tr class="altColor">
397 <td class="colFirst"><code>static int</code></td>
398 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_XDENSITY">PARAM_XDENSITY</a></span></code></th>
399 <td class="colLast">
400 <div class="block">JPEG horizontal pixel density</div>
401 </td>
402 </tr>
403 <tr class="rowColor">
404 <td class="colFirst"><code>static int</code></td>
405 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PARAM_YDENSITY">PARAM_YDENSITY</a></span></code></th>
406 <td class="colLast">
407 <div class="block">JPEG vertical pixel density</div>
408 </td>
409 </tr>
410 <tr class="altColor">
411 <td class="colFirst"><code>static int</code></td>
412 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_ABGR">PF_ABGR</a></span></code></th>
413 <td class="colLast">
414 <div class="block">ABGR pixel format</div>
415 </td>
416 </tr>
417 <tr class="rowColor">
418 <td class="colFirst"><code>static int</code></td>
419 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_ARGB">PF_ARGB</a></span></code></th>
420 <td class="colLast">
421 <div class="block">ARGB pixel format</div>
422 </td>
423 </tr>
424 <tr class="altColor">
425 <td class="colFirst"><code>static int</code></td>
426 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_BGR">PF_BGR</a></span></code></th>
427 <td class="colLast">
428 <div class="block">BGR pixel format</div>
429 </td>
430 </tr>
431 <tr class="rowColor">
432 <td class="colFirst"><code>static int</code></td>
433 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_BGRA">PF_BGRA</a></span></code></th>
434 <td class="colLast">
435 <div class="block">BGRA pixel format</div>
436 </td>
437 </tr>
438 <tr class="altColor">
439 <td class="colFirst"><code>static int</code></td>
440 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_BGRX">PF_BGRX</a></span></code></th>
441 <td class="colLast">
442 <div class="block">BGRX pixel format</div>
443 </td>
444 </tr>
445 <tr class="rowColor">
446 <td class="colFirst"><code>static int</code></td>
447 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_CMYK">PF_CMYK</a></span></code></th>
448 <td class="colLast">
449 <div class="block">CMYK pixel format</div>
450 </td>
451 </tr>
452 <tr class="altColor">
453 <td class="colFirst"><code>static int</code></td>
454 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_GRAY">PF_GRAY</a></span></code></th>
455 <td class="colLast">
456 <div class="block">Grayscale pixel format
457
458 Each 1-sample pixel represents a luminance (brightness) level from 0 to
459 the maximum sample value (which is, for instance, 255 for 8-bit samples
460 or 4095 for 12-bit samples or 65535 for 16-bit samples.)</div>
461 </td>
462 </tr>
463 <tr class="rowColor">
464 <td class="colFirst"><code>static int</code></td>
465 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_RGB">PF_RGB</a></span></code></th>
466 <td class="colLast">
467 <div class="block">RGB pixel format</div>
468 </td>
469 </tr>
470 <tr class="altColor">
471 <td class="colFirst"><code>static int</code></td>
472 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_RGBA">PF_RGBA</a></span></code></th>
473 <td class="colLast">
474 <div class="block">RGBA pixel format</div>
475 </td>
476 </tr>
477 <tr class="rowColor">
478 <td class="colFirst"><code>static int</code></td>
479 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_RGBX">PF_RGBX</a></span></code></th>
480 <td class="colLast">
481 <div class="block">RGBX pixel format</div>
482 </td>
483 </tr>
484 <tr class="altColor">
485 <td class="colFirst"><code>static int</code></td>
486 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_UNKNOWN">PF_UNKNOWN</a></span></code></th>
487 <td class="colLast">
488 <div class="block">Unknown pixel format</div>
489 </td>
490 </tr>
491 <tr class="rowColor">
492 <td class="colFirst"><code>static int</code></td>
493 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_XBGR">PF_XBGR</a></span></code></th>
494 <td class="colLast">
495 <div class="block">XBGR pixel format</div>
496 </td>
497 </tr>
498 <tr class="altColor">
499 <td class="colFirst"><code>static int</code></td>
500 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#PF_XRGB">PF_XRGB</a></span></code></th>
501 <td class="colLast">
502 <div class="block">XRGB pixel format</div>
503 </td>
504 </tr>
505 <tr class="rowColor">
506 <td class="colFirst"><code>static int</code></td>
507 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_411">SAMP_411</a></span></code></th>
508 <td class="colLast">
509 <div class="block">4:1:1 chrominance subsampling</div>
510 </td>
511 </tr>
512 <tr class="altColor">
513 <td class="colFirst"><code>static int</code></td>
514 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_420">SAMP_420</a></span></code></th>
515 <td class="colLast">
516 <div class="block">4:2:0 chrominance subsampling</div>
517 </td>
518 </tr>
519 <tr class="rowColor">
520 <td class="colFirst"><code>static int</code></td>
521 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_422">SAMP_422</a></span></code></th>
522 <td class="colLast">
523 <div class="block">4:2:2 chrominance subsampling</div>
524 </td>
525 </tr>
526 <tr class="altColor">
527 <td class="colFirst"><code>static int</code></td>
528 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_440">SAMP_440</a></span></code></th>
529 <td class="colLast">
530 <div class="block">4:4:0 chrominance subsampling</div>
531 </td>
532 </tr>
533 <tr class="rowColor">
534 <td class="colFirst"><code>static int</code></td>
535 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_441">SAMP_441</a></span></code></th>
536 <td class="colLast">
537 <div class="block">4:4:1 chrominance subsampling</div>
538 </td>
539 </tr>
540 <tr class="altColor">
541 <td class="colFirst"><code>static int</code></td>
542 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_444">SAMP_444</a></span></code></th>
543 <td class="colLast">
544 <div class="block">4:4:4 chrominance subsampling (no chrominance subsampling)</div>
545 </td>
546 </tr>
547 <tr class="rowColor">
548 <td class="colFirst"><code>static int</code></td>
549 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_GRAY">SAMP_GRAY</a></span></code></th>
550 <td class="colLast">
551 <div class="block">Grayscale</div>
552 </td>
553 </tr>
554 <tr class="altColor">
555 <td class="colFirst"><code>static int</code></td>
556 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#SAMP_UNKNOWN">SAMP_UNKNOWN</a></span></code></th>
557 <td class="colLast">
558 <div class="block">Unknown subsampling</div>
559 </td>
560 </tr>
561 <tr class="rowColor">
562 <td class="colFirst"><code>static java.awt.Rectangle</code></td>
563 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNCROPPED">UNCROPPED</a></span></code></th>
564 <td class="colLast">
565 <div class="block">A <code>java.awt.Rectangle</code> instance that specifies no cropping</div>
566 </td>
567 </tr>
568 <tr class="altColor">
569 <td class="colFirst"><code>static <a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a></code></td>
570 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#UNSCALED">UNSCALED</a></span></code></th>
571 <td class="colLast">
572 <div class="block">A <a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg"><code>TJScalingFactor</code></a> instance that specifies a scaling factor of 1/1
573 (no scaling)</div>
574 </td>
575 </tr>
576 </table>
577 </li>
578 </ul>
579 </section>
580 <!-- ========== METHOD SUMMARY =========== -->
581 <section>
582 <ul class="blockList">
583 <li class="blockList"><a id="method.summary">
584 <!-- -->
585 </a>
586 <h3>Method Summary</h3>
587 <table class="memberSummary">
588 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
589 <tr>
590 <th class="colFirst" scope="col">Modifier and Type</th>
591 <th class="colSecond" scope="col">Method</th>
592 <th class="colLast" scope="col">Description</th>
593 </tr>
594 <tr id="i0" class="altColor">
595 <td class="colFirst"><code>static int</code></td>
596 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bufSize(int,int,int)">bufSize</a></span>&#8203;(int&nbsp;width,
597 int&nbsp;height,
598 int&nbsp;jpegSubsamp)</code></th>
599 <td class="colLast">
600 <div class="block">Returns the maximum size of the buffer (in bytes) required to hold a JPEG
601 image with the given width, height, and level of chrominance subsampling.</div>
602 </td>
603 </tr>
604 <tr id="i1" class="rowColor">
605 <td class="colFirst"><code>static int</code></td>
606 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#bufSizeYUV(int,int,int,int)">bufSizeYUV</a></span>&#8203;(int&nbsp;width,
607 int&nbsp;align,
608 int&nbsp;height,
609 int&nbsp;subsamp)</code></th>
610 <td class="colLast">
611 <div class="block">Returns the size of the buffer (in bytes) required to hold a unified
612 planar YUV image with the given width, height, and level of chrominance
613 subsampling.</div>
614 </td>
615 </tr>
616 <tr id="i2" class="altColor">
617 <td class="colFirst"><code>static int</code></td>
618 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAlphaOffset(int)">getAlphaOffset</a></span>&#8203;(int&nbsp;pixelFormat)</code></th>
619 <td class="colLast">
620 <div class="block">For the given pixel format, returns the number of samples that the alpha
621 component is offset from the start of the pixel.</div>
622 </td>
623 </tr>
624 <tr id="i3" class="rowColor">
625 <td class="colFirst"><code>static int</code></td>
626 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBlueOffset(int)">getBlueOffset</a></span>&#8203;(int&nbsp;pixelFormat)</code></th>
627 <td class="colLast">
628 <div class="block">For the given pixel format, returns the number of samples that the blue
629 component is offset from the start of the pixel.</div>
630 </td>
631 </tr>
632 <tr id="i4" class="altColor">
633 <td class="colFirst"><code>static int</code></td>
634 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getGreenOffset(int)">getGreenOffset</a></span>&#8203;(int&nbsp;pixelFormat)</code></th>
635 <td class="colLast">
636 <div class="block">For the given pixel format, returns the number of samples that the green
637 component is offset from the start of the pixel.</div>
638 </td>
639 </tr>
640 <tr id="i5" class="rowColor">
641 <td class="colFirst"><code>static int</code></td>
642 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMCUHeight(int)">getMCUHeight</a></span>&#8203;(int&nbsp;subsamp)</code></th>
643 <td class="colLast">
644 <div class="block">Returns the iMCU height for the given level of chrominance subsampling.</div>
645 </td>
646 </tr>
647 <tr id="i6" class="altColor">
648 <td class="colFirst"><code>static int</code></td>
649 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMCUWidth(int)">getMCUWidth</a></span>&#8203;(int&nbsp;subsamp)</code></th>
650 <td class="colLast">
651 <div class="block">Returns the iMCU width for the given level of chrominance subsampling.</div>
652 </td>
653 </tr>
654 <tr id="i7" class="rowColor">
655 <td class="colFirst"><code>static int</code></td>
656 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPixelSize(int)">getPixelSize</a></span>&#8203;(int&nbsp;pixelFormat)</code></th>
657 <td class="colLast">
658 <div class="block">Returns the pixel size (in samples) for the given pixel format.</div>
659 </td>
660 </tr>
661 <tr id="i8" class="altColor">
662 <td class="colFirst"><code>static int</code></td>
663 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRedOffset(int)">getRedOffset</a></span>&#8203;(int&nbsp;pixelFormat)</code></th>
664 <td class="colLast">
665 <div class="block">For the given pixel format, returns the number of samples that the red
666 component is offset from the start of the pixel.</div>
667 </td>
668 </tr>
669 <tr id="i9" class="rowColor">
670 <td class="colFirst"><code>static <a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>[]</code></td>
671 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getScalingFactors()">getScalingFactors</a></span>()</code></th>
672 <td class="colLast">
673 <div class="block">Returns a list of fractional scaling factors that the JPEG decompressor
674 supports.</div>
675 </td>
676 </tr>
677 <tr id="i10" class="altColor">
678 <td class="colFirst"><code>static int</code></td>
679 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planeHeight(int,int,int)">planeHeight</a></span>&#8203;(int&nbsp;componentID,
680 int&nbsp;height,
681 int&nbsp;subsamp)</code></th>
682 <td class="colLast">
683 <div class="block">Returns the plane height of a YUV image plane with the given parameters.</div>
684 </td>
685 </tr>
686 <tr id="i11" class="rowColor">
687 <td class="colFirst"><code>static int</code></td>
688 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planeSizeYUV(int,int,int,int,int)">planeSizeYUV</a></span>&#8203;(int&nbsp;componentID,
689 int&nbsp;width,
690 int&nbsp;stride,
691 int&nbsp;height,
692 int&nbsp;subsamp)</code></th>
693 <td class="colLast">
694 <div class="block">Returns the size of the buffer (in bytes) required to hold a YUV image
695 plane with the given parameters.</div>
696 </td>
697 </tr>
698 <tr id="i12" class="altColor">
699 <td class="colFirst"><code>static int</code></td>
700 <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#planeWidth(int,int,int)">planeWidth</a></span>&#8203;(int&nbsp;componentID,
701 int&nbsp;width,
702 int&nbsp;subsamp)</code></th>
703 <td class="colLast">
704 <div class="block">Returns the plane width of a YUV image plane with the given parameters.</div>
705 </td>
706 </tr>
707 </table>
708 <ul class="blockList">
709 <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
710 <!-- -->
711 </a>
712 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
713 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
714 </ul>
715 </li>
716 </ul>
717 </section>
718 </li>
719 </ul>
720 </div>
721 <div class="details">
722 <ul class="blockList">
723 <li class="blockList">
724 <!-- ============ FIELD DETAIL =========== -->
725 <section>
726 <ul class="blockList">
727 <li class="blockList"><a id="field.detail">
728 <!-- -->
729 </a>
730 <h3>Field Detail</h3>
731 <a id="NUMSAMP">
732 <!-- -->
733 </a>
734 <ul class="blockList">
735 <li class="blockList">
736 <h4>NUMSAMP</h4>
737 <pre>public static final&nbsp;int NUMSAMP</pre>
738 <div class="block">The number of chrominance subsampling options</div>
739 <dl>
740 <dt><span class="seeLabel">See Also:</span></dt>
741 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.NUMSAMP">Constant Field Values</a></dd>
742 </dl>
743 </li>
744 </ul>
745 <a id="SAMP_444">
746 <!-- -->
747 </a>
748 <ul class="blockList">
749 <li class="blockList">
750 <h4>SAMP_444</h4>
751 <pre>public static final&nbsp;int SAMP_444</pre>
752 <div class="block">4:4:4 chrominance subsampling (no chrominance subsampling)
753
754 <p>The JPEG or YUV image will contain one chrominance component for every
755 pixel in the source image.</div>
756 <dl>
757 <dt><span class="seeLabel">See Also:</span></dt>
758 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_444">Constant Field Values</a></dd>
759 </dl>
760 </li>
761 </ul>
762 <a id="SAMP_422">
763 <!-- -->
764 </a>
765 <ul class="blockList">
766 <li class="blockList">
767 <h4>SAMP_422</h4>
768 <pre>public static final&nbsp;int SAMP_422</pre>
769 <div class="block">4:2:2 chrominance subsampling
770
771 <p>The JPEG or YUV image will contain one chrominance component for every
772 2x1 block of pixels in the source image.</div>
773 <dl>
774 <dt><span class="seeLabel">See Also:</span></dt>
775 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_422">Constant Field Values</a></dd>
776 </dl>
777 </li>
778 </ul>
779 <a id="SAMP_420">
780 <!-- -->
781 </a>
782 <ul class="blockList">
783 <li class="blockList">
784 <h4>SAMP_420</h4>
785 <pre>public static final&nbsp;int SAMP_420</pre>
786 <div class="block">4:2:0 chrominance subsampling
787
788 <p>The JPEG or YUV image will contain one chrominance component for every
789 2x2 block of pixels in the source image.</div>
790 <dl>
791 <dt><span class="seeLabel">See Also:</span></dt>
792 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_420">Constant Field Values</a></dd>
793 </dl>
794 </li>
795 </ul>
796 <a id="SAMP_GRAY">
797 <!-- -->
798 </a>
799 <ul class="blockList">
800 <li class="blockList">
801 <h4>SAMP_GRAY</h4>
802 <pre>public static final&nbsp;int SAMP_GRAY</pre>
803 <div class="block">Grayscale
804
805 <p>The JPEG or YUV image will contain no chrominance components.</div>
806 <dl>
807 <dt><span class="seeLabel">See Also:</span></dt>
808 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_GRAY">Constant Field Values</a></dd>
809 </dl>
810 </li>
811 </ul>
812 <a id="SAMP_440">
813 <!-- -->
814 </a>
815 <ul class="blockList">
816 <li class="blockList">
817 <h4>SAMP_440</h4>
818 <pre>public static final&nbsp;int SAMP_440</pre>
819 <div class="block">4:4:0 chrominance subsampling
820
821 <p>The JPEG or YUV image will contain one chrominance component for every
822 1x2 block of pixels in the source image.
823
824 <p>NOTE: 4:4:0 subsampling is not fully accelerated in libjpeg-turbo.</div>
825 <dl>
826 <dt><span class="seeLabel">See Also:</span></dt>
827 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_440">Constant Field Values</a></dd>
828 </dl>
829 </li>
830 </ul>
831 <a id="SAMP_411">
832 <!-- -->
833 </a>
834 <ul class="blockList">
835 <li class="blockList">
836 <h4>SAMP_411</h4>
837 <pre>public static final&nbsp;int SAMP_411</pre>
838 <div class="block">4:1:1 chrominance subsampling
839
840 <p>The JPEG or YUV image will contain one chrominance component for every
841 4x1 block of pixels in the source image. All else being equal, a JPEG
842 image with 4:1:1 subsampling is almost exactly the same size as a JPEG
843 image with 4:2:0 subsampling, and in the aggregate, both subsampling
844 methods produce approximately the same perceptual quality. However, 4:1:1
845 is better able to reproduce sharp horizontal features.
846
847 <p>NOTE: 4:1:1 subsampling is not fully accelerated in libjpeg-turbo.</div>
848 <dl>
849 <dt><span class="seeLabel">See Also:</span></dt>
850 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_411">Constant Field Values</a></dd>
851 </dl>
852 </li>
853 </ul>
854 <a id="SAMP_441">
855 <!-- -->
856 </a>
857 <ul class="blockList">
858 <li class="blockList">
859 <h4>SAMP_441</h4>
860 <pre>public static final&nbsp;int SAMP_441</pre>
861 <div class="block">4:4:1 chrominance subsampling
862
863 <p>The JPEG or YUV image will contain one chrominance component for every
864 1x4 block of pixels in the source image. All else being equal, a JPEG
865 image with 4:4:1 subsampling is almost exactly the same size as a JPEG
866 image with 4:2:0 subsampling, and in the aggregate, both subsampling
867 methods produce approximately the same perceptual quality. However, 4:4:1
868 is better able to reproduce sharp vertical features.
869
870 <p>NOTE: 4:4:1 subsampling is not fully accelerated in libjpeg-turbo.</div>
871 <dl>
872 <dt><span class="seeLabel">See Also:</span></dt>
873 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_441">Constant Field Values</a></dd>
874 </dl>
875 </li>
876 </ul>
877 <a id="SAMP_UNKNOWN">
878 <!-- -->
879 </a>
880 <ul class="blockList">
881 <li class="blockList">
882 <h4>SAMP_UNKNOWN</h4>
883 <pre>public static final&nbsp;int SAMP_UNKNOWN</pre>
884 <div class="block">Unknown subsampling
885
886 <p>The JPEG image uses an unusual type of chrominance subsampling. Such
887 images can be decompressed into packed-pixel images, but they cannot be
888 <ul>
889 <li> decompressed into planar YUV images,
890 <li> losslessly transformed if <a href="TJTransform.html#OPT_CROP"><code>TJTransform.OPT_CROP</code></a> is specified
891 and <a href="TJTransform.html#OPT_GRAY"><code>TJTransform.OPT_GRAY</code></a> is not specified,
892 or
893 <li> partially decompressed using a cropping region.
894 </ul></div>
895 <dl>
896 <dt><span class="seeLabel">See Also:</span></dt>
897 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.SAMP_UNKNOWN">Constant Field Values</a></dd>
898 </dl>
899 </li>
900 </ul>
901 <a id="NUMPF">
902 <!-- -->
903 </a>
904 <ul class="blockList">
905 <li class="blockList">
906 <h4>NUMPF</h4>
907 <pre>public static final&nbsp;int NUMPF</pre>
908 <div class="block">The number of pixel formats</div>
909 <dl>
910 <dt><span class="seeLabel">See Also:</span></dt>
911 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.NUMPF">Constant Field Values</a></dd>
912 </dl>
913 </li>
914 </ul>
915 <a id="PF_RGB">
916 <!-- -->
917 </a>
918 <ul class="blockList">
919 <li class="blockList">
920 <h4>PF_RGB</h4>
921 <pre>public static final&nbsp;int PF_RGB</pre>
922 <div class="block">RGB pixel format
923
924 <p>The red, green, and blue components in the image are stored in 3-sample
925 pixels in the order R, G, B from lowest to highest memory address within
926 each pixel.</div>
927 <dl>
928 <dt><span class="seeLabel">See Also:</span></dt>
929 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_RGB">Constant Field Values</a></dd>
930 </dl>
931 </li>
932 </ul>
933 <a id="PF_BGR">
934 <!-- -->
935 </a>
936 <ul class="blockList">
937 <li class="blockList">
938 <h4>PF_BGR</h4>
939 <pre>public static final&nbsp;int PF_BGR</pre>
940 <div class="block">BGR pixel format
941
942 <p>The red, green, and blue components in the image are stored in 3-sample
943 pixels in the order B, G, R from lowest to highest memory address within
944 each pixel.</div>
945 <dl>
946 <dt><span class="seeLabel">See Also:</span></dt>
947 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_BGR">Constant Field Values</a></dd>
948 </dl>
949 </li>
950 </ul>
951 <a id="PF_RGBX">
952 <!-- -->
953 </a>
954 <ul class="blockList">
955 <li class="blockList">
956 <h4>PF_RGBX</h4>
957 <pre>public static final&nbsp;int PF_RGBX</pre>
958 <div class="block">RGBX pixel format
959
960 <p>The red, green, and blue components in the image are stored in 4-sample
961 pixels in the order R, G, B from lowest to highest memory address within
962 each pixel. The X component is ignored when compressing/encoding and
963 undefined when decompressing/decoding.</div>
964 <dl>
965 <dt><span class="seeLabel">See Also:</span></dt>
966 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_RGBX">Constant Field Values</a></dd>
967 </dl>
968 </li>
969 </ul>
970 <a id="PF_BGRX">
971 <!-- -->
972 </a>
973 <ul class="blockList">
974 <li class="blockList">
975 <h4>PF_BGRX</h4>
976 <pre>public static final&nbsp;int PF_BGRX</pre>
977 <div class="block">BGRX pixel format
978
979 <p>The red, green, and blue components in the image are stored in 4-sample
980 pixels in the order B, G, R from lowest to highest memory address within
981 each pixel. The X component is ignored when compressing/encoding and
982 undefined when decompressing/decoding.</div>
983 <dl>
984 <dt><span class="seeLabel">See Also:</span></dt>
985 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_BGRX">Constant Field Values</a></dd>
986 </dl>
987 </li>
988 </ul>
989 <a id="PF_XBGR">
990 <!-- -->
991 </a>
992 <ul class="blockList">
993 <li class="blockList">
994 <h4>PF_XBGR</h4>
995 <pre>public static final&nbsp;int PF_XBGR</pre>
996 <div class="block">XBGR pixel format
997
998 <p>The red, green, and blue components in the image are stored in 4-sample
999 pixels in the order R, G, B from highest to lowest memory address within
1000 each pixel. The X component is ignored when compressing/encoding and
1001 undefined when decompressing/decoding.</div>
1002 <dl>
1003 <dt><span class="seeLabel">See Also:</span></dt>
1004 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_XBGR">Constant Field Values</a></dd>
1005 </dl>
1006 </li>
1007 </ul>
1008 <a id="PF_XRGB">
1009 <!-- -->
1010 </a>
1011 <ul class="blockList">
1012 <li class="blockList">
1013 <h4>PF_XRGB</h4>
1014 <pre>public static final&nbsp;int PF_XRGB</pre>
1015 <div class="block">XRGB pixel format
1016
1017 <p>The red, green, and blue components in the image are stored in 4-sample
1018 pixels in the order B, G, R from highest to lowest memory address within
1019 each pixel. The X component is ignored when compressing/encoding and
1020 undefined when decompressing/decoding.</div>
1021 <dl>
1022 <dt><span class="seeLabel">See Also:</span></dt>
1023 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_XRGB">Constant Field Values</a></dd>
1024 </dl>
1025 </li>
1026 </ul>
1027 <a id="PF_GRAY">
1028 <!-- -->
1029 </a>
1030 <ul class="blockList">
1031 <li class="blockList">
1032 <h4>PF_GRAY</h4>
1033 <pre>public static final&nbsp;int PF_GRAY</pre>
1034 <div class="block">Grayscale pixel format
1035
1036 Each 1-sample pixel represents a luminance (brightness) level from 0 to
1037 the maximum sample value (which is, for instance, 255 for 8-bit samples
1038 or 4095 for 12-bit samples or 65535 for 16-bit samples.)</div>
1039 <dl>
1040 <dt><span class="seeLabel">See Also:</span></dt>
1041 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_GRAY">Constant Field Values</a></dd>
1042 </dl>
1043 </li>
1044 </ul>
1045 <a id="PF_RGBA">
1046 <!-- -->
1047 </a>
1048 <ul class="blockList">
1049 <li class="blockList">
1050 <h4>PF_RGBA</h4>
1051 <pre>public static final&nbsp;int PF_RGBA</pre>
1052 <div class="block">RGBA pixel format
1053
1054 <p>This is the same as <a href="#PF_RGBX"><code>PF_RGBX</code></a>, except that when
1055 decompressing/decoding, the X component is guaranteed to be equal to the
1056 maximum sample value, which can be interpreted as an opaque alpha channel.</div>
1057 <dl>
1058 <dt><span class="seeLabel">See Also:</span></dt>
1059 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_RGBA">Constant Field Values</a></dd>
1060 </dl>
1061 </li>
1062 </ul>
1063 <a id="PF_BGRA">
1064 <!-- -->
1065 </a>
1066 <ul class="blockList">
1067 <li class="blockList">
1068 <h4>PF_BGRA</h4>
1069 <pre>public static final&nbsp;int PF_BGRA</pre>
1070 <div class="block">BGRA pixel format
1071
1072 <p>This is the same as <a href="#PF_BGRX"><code>PF_BGRX</code></a>, except that when
1073 decompressing/decoding, the X component is guaranteed to be equal to the
1074 maximum sample value, which can be interpreted as an opaque alpha channel.</div>
1075 <dl>
1076 <dt><span class="seeLabel">See Also:</span></dt>
1077 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_BGRA">Constant Field Values</a></dd>
1078 </dl>
1079 </li>
1080 </ul>
1081 <a id="PF_ABGR">
1082 <!-- -->
1083 </a>
1084 <ul class="blockList">
1085 <li class="blockList">
1086 <h4>PF_ABGR</h4>
1087 <pre>public static final&nbsp;int PF_ABGR</pre>
1088 <div class="block">ABGR pixel format
1089
1090 <p>This is the same as <a href="#PF_XBGR"><code>PF_XBGR</code></a>, except that when
1091 decompressing/decoding, the X component is guaranteed to be equal to the
1092 maximum sample value, which can be interpreted as an opaque alpha channel.</div>
1093 <dl>
1094 <dt><span class="seeLabel">See Also:</span></dt>
1095 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_ABGR">Constant Field Values</a></dd>
1096 </dl>
1097 </li>
1098 </ul>
1099 <a id="PF_ARGB">
1100 <!-- -->
1101 </a>
1102 <ul class="blockList">
1103 <li class="blockList">
1104 <h4>PF_ARGB</h4>
1105 <pre>public static final&nbsp;int PF_ARGB</pre>
1106 <div class="block">ARGB pixel format
1107
1108 <p>This is the same as <a href="#PF_XRGB"><code>PF_XRGB</code></a>, except that when
1109 decompressing/decoding, the X component is guaranteed to be equal to the
1110 maximum sample value, which can be interpreted as an opaque alpha channel.</div>
1111 <dl>
1112 <dt><span class="seeLabel">See Also:</span></dt>
1113 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_ARGB">Constant Field Values</a></dd>
1114 </dl>
1115 </li>
1116 </ul>
1117 <a id="PF_CMYK">
1118 <!-- -->
1119 </a>
1120 <ul class="blockList">
1121 <li class="blockList">
1122 <h4>PF_CMYK</h4>
1123 <pre>public static final&nbsp;int PF_CMYK</pre>
1124 <div class="block">CMYK pixel format
1125
1126 <p>Unlike RGB, which is an additive color model used primarily for
1127 display, CMYK (Cyan/Magenta/Yellow/Key) is a subtractive color model used
1128 primarily for printing. In the CMYK color model, the value of each color
1129 component typically corresponds to an amount of cyan, magenta, yellow, or
1130 black ink that is applied to a white background. In order to convert
1131 between CMYK and RGB, it is necessary to use a color management system
1132 (CMS.) A CMS will attempt to map colors within the printer's gamut to
1133 perceptually similar colors in the display's gamut and vice versa, but the
1134 mapping is typically not 1:1 or reversible, nor can it be defined with a
1135 simple formula. Thus, such a conversion is out of scope for a codec
1136 library. However, the TurboJPEG API allows for compressing packed-pixel
1137 CMYK images into YCCK JPEG images (see <a href="#CS_YCCK"><code>CS_YCCK</code></a>) and decompressing
1138 YCCK JPEG images into packed-pixel CMYK images.</div>
1139 <dl>
1140 <dt><span class="seeLabel">See Also:</span></dt>
1141 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_CMYK">Constant Field Values</a></dd>
1142 </dl>
1143 </li>
1144 </ul>
1145 <a id="PF_UNKNOWN">
1146 <!-- -->
1147 </a>
1148 <ul class="blockList">
1149 <li class="blockList">
1150 <h4>PF_UNKNOWN</h4>
1151 <pre>public static final&nbsp;int PF_UNKNOWN</pre>
1152 <div class="block">Unknown pixel format
1153
1154 <p>Currently this is only used by
1155 <a href="TJCompressor.html#loadSourceImage(java.lang.String,int,int)"><code>TJCompressor.loadSourceImage()</code></a>.</div>
1156 <dl>
1157 <dt><span class="seeLabel">See Also:</span></dt>
1158 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PF_UNKNOWN">Constant Field Values</a></dd>
1159 </dl>
1160 </li>
1161 </ul>
1162 <a id="NUMCS">
1163 <!-- -->
1164 </a>
1165 <ul class="blockList">
1166 <li class="blockList">
1167 <h4>NUMCS</h4>
1168 <pre>public static final&nbsp;int NUMCS</pre>
1169 <div class="block">The number of JPEG colorspaces</div>
1170 <dl>
1171 <dt><span class="seeLabel">See Also:</span></dt>
1172 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.NUMCS">Constant Field Values</a></dd>
1173 </dl>
1174 </li>
1175 </ul>
1176 <a id="CS_RGB">
1177 <!-- -->
1178 </a>
1179 <ul class="blockList">
1180 <li class="blockList">
1181 <h4>CS_RGB</h4>
1182 <pre>public static final&nbsp;int CS_RGB</pre>
1183 <div class="block">RGB colorspace
1184
1185 <p>When generating the JPEG image, the R, G, and B components in the
1186 source image are reordered into image planes, but no colorspace conversion
1187 or subsampling is performed. RGB JPEG images can be generated from and
1188 decompressed to packed-pixel images with any of the extended RGB or
1189 grayscale pixel formats, but they cannot be generated from or
1190 decompressed to planar YUV images.</div>
1191 <dl>
1192 <dt><span class="seeLabel">See Also:</span></dt>
1193 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.CS_RGB">Constant Field Values</a></dd>
1194 </dl>
1195 </li>
1196 </ul>
1197 <a id="CS_YCbCr">
1198 <!-- -->
1199 </a>
1200 <ul class="blockList">
1201 <li class="blockList">
1202 <h4>CS_YCbCr</h4>
1203 <pre>public static final&nbsp;int CS_YCbCr</pre>
1204 <div class="block">YCbCr colorspace
1205
1206 <p>YCbCr is not an absolute colorspace but rather a mathematical
1207 transformation of RGB designed solely for storage and transmission. YCbCr
1208 images must be converted to RGB before they can be displayed. In the
1209 YCbCr colorspace, the Y (luminance) component represents the black &amp;
1210 white portion of the original image, and the Cb and Cr (chrominance)
1211 components represent the color portion of the original image.
1212 Historically, the analog equivalent of this transformation allowed the
1213 same signal to be displayed to both black &amp; white and color
1214 televisions, but JPEG images use YCbCr primarily because it allows the
1215 color data to be optionally subsampled in order to reduce network and disk
1216 usage. YCbCr is the most common JPEG colorspace, and YCbCr JPEG images
1217 can be generated from and decompressed to packed-pixel images with any of
1218 the extended RGB or grayscale pixel formats. YCbCr JPEG images can also
1219 be generated from and decompressed to planar YUV images.</div>
1220 <dl>
1221 <dt><span class="seeLabel">See Also:</span></dt>
1222 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.CS_YCbCr">Constant Field Values</a></dd>
1223 </dl>
1224 </li>
1225 </ul>
1226 <a id="CS_GRAY">
1227 <!-- -->
1228 </a>
1229 <ul class="blockList">
1230 <li class="blockList">
1231 <h4>CS_GRAY</h4>
1232 <pre>public static final&nbsp;int CS_GRAY</pre>
1233 <div class="block">Grayscale colorspace
1234
1235 <p>The JPEG image retains only the luminance data (Y component), and any
1236 color data from the source image is discarded. Grayscale JPEG images can
1237 be generated from and decompressed to packed-pixel images with any of the
1238 extended RGB or grayscale pixel formats, or they can be generated from and
1239 decompressed to planar YUV images.</div>
1240 <dl>
1241 <dt><span class="seeLabel">See Also:</span></dt>
1242 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.CS_GRAY">Constant Field Values</a></dd>
1243 </dl>
1244 </li>
1245 </ul>
1246 <a id="CS_CMYK">
1247 <!-- -->
1248 </a>
1249 <ul class="blockList">
1250 <li class="blockList">
1251 <h4>CS_CMYK</h4>
1252 <pre>public static final&nbsp;int CS_CMYK</pre>
1253 <div class="block">CMYK colorspace
1254
1255 <p>When generating the JPEG image, the C, M, Y, and K components in the
1256 source image are reordered into image planes, but no colorspace conversion
1257 or subsampling is performed. CMYK JPEG images can only be generated from
1258 and decompressed to packed-pixel images with the CMYK pixel format.</div>
1259 <dl>
1260 <dt><span class="seeLabel">See Also:</span></dt>
1261 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.CS_CMYK">Constant Field Values</a></dd>
1262 </dl>
1263 </li>
1264 </ul>
1265 <a id="CS_YCCK">
1266 <!-- -->
1267 </a>
1268 <ul class="blockList">
1269 <li class="blockList">
1270 <h4>CS_YCCK</h4>
1271 <pre>public static final&nbsp;int CS_YCCK</pre>
1272 <div class="block">YCCK colorspace
1273
1274 <p>YCCK (AKA "YCbCrK") is not an absolute colorspace but rather a
1275 mathematical transformation of CMYK designed solely for storage and
1276 transmission. It is to CMYK as YCbCr is to RGB. CMYK pixels can be
1277 reversibly transformed into YCCK, and as with YCbCr, the chrominance
1278 components in the YCCK pixels can be subsampled without incurring major
1279 perceptual loss. YCCK JPEG images can only be generated from and
1280 decompressed to packed-pixel images with the CMYK pixel format.</div>
1281 <dl>
1282 <dt><span class="seeLabel">See Also:</span></dt>
1283 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.CS_YCCK">Constant Field Values</a></dd>
1284 </dl>
1285 </li>
1286 </ul>
1287 <a id="PARAM_STOPONWARNING">
1288 <!-- -->
1289 </a>
1290 <ul class="blockList">
1291 <li class="blockList">
1292 <h4>PARAM_STOPONWARNING</h4>
1293 <pre>public static final&nbsp;int PARAM_STOPONWARNING</pre>
1294 <div class="block">Error handling behavior
1295
1296 <p><b>Value</b>
1297 <ul>
1298 <li> <code>0</code> <i>[default]</i> Allow the current
1299 compression/decompression/transform operation to complete unless a fatal
1300 error is encountered.
1301 <li> <code>1</code> Immediately discontinue the current
1302 compression/decompression/transform operation if a warning (non-fatal
1303 error) occurs.
1304 </ul></div>
1305 <dl>
1306 <dt><span class="seeLabel">See Also:</span></dt>
1307 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_STOPONWARNING">Constant Field Values</a></dd>
1308 </dl>
1309 </li>
1310 </ul>
1311 <a id="PARAM_BOTTOMUP">
1312 <!-- -->
1313 </a>
1314 <ul class="blockList">
1315 <li class="blockList">
1316 <h4>PARAM_BOTTOMUP</h4>
1317 <pre>public static final&nbsp;int PARAM_BOTTOMUP</pre>
1318 <div class="block">Row order in packed-pixel source/destination images
1319
1320 <p><b>Value</b>
1321 <ul>
1322 <li> <code>0</code> <i>[default]</i> top-down (X11) order
1323 <li> <code>1</code> bottom-up (Windows, OpenGL) order
1324 </ul></div>
1325 <dl>
1326 <dt><span class="seeLabel">See Also:</span></dt>
1327 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_BOTTOMUP">Constant Field Values</a></dd>
1328 </dl>
1329 </li>
1330 </ul>
1331 <a id="PARAM_QUALITY">
1332 <!-- -->
1333 </a>
1334 <ul class="blockList">
1335 <li class="blockList">
1336 <h4>PARAM_QUALITY</h4>
1337 <pre>public static final&nbsp;int PARAM_QUALITY</pre>
1338 <div class="block">Perceptual quality of lossy JPEG images [compression only]
1339
1340 <p><b>Value</b>
1341 <ul>
1342 <li> <code>1</code>-<code>100</code> (<code>1</code> = worst quality but
1343 best compression, <code>100</code> = best quality but worst compression)
1344 <i>[no default; must be explicitly specified]</i>
1345 </ul></div>
1346 <dl>
1347 <dt><span class="seeLabel">See Also:</span></dt>
1348 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_QUALITY">Constant Field Values</a></dd>
1349 </dl>
1350 </li>
1351 </ul>
1352 <a id="PARAM_SUBSAMP">
1353 <!-- -->
1354 </a>
1355 <ul class="blockList">
1356 <li class="blockList">
1357 <h4>PARAM_SUBSAMP</h4>
1358 <pre>public static final&nbsp;int PARAM_SUBSAMP</pre>
1359 <div class="block">Chrominance subsampling level
1360
1361 <p>The JPEG or YUV image uses (decompression, decoding) or will use (lossy
1362 compression, encoding) the specified level of chrominance subsampling.
1363
1364 <p>When pixels are converted from RGB to YCbCr (see <a href="#CS_YCbCr"><code>CS_YCbCr</code></a>) or
1365 from CMYK to YCCK (see <a href="#CS_YCCK"><code>CS_YCCK</code></a>) as part of the JPEG compression
1366 process, some of the Cb and Cr (chrominance) components can be discarded
1367 or averaged together to produce a smaller image with little perceptible
1368 loss of image quality. (The human eye is more sensitive to small changes
1369 in brightness than to small changes in color.) This is called
1370 "chrominance subsampling".
1371
1372 <p><b>Value</b>
1373 <ul>
1374 <li> One of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a> <i>[no default; must be explicitly
1375 specified for lossy compression, encoding, and decoding]</i>
1376 </ul></div>
1377 <dl>
1378 <dt><span class="seeLabel">See Also:</span></dt>
1379 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_SUBSAMP">Constant Field Values</a></dd>
1380 </dl>
1381 </li>
1382 </ul>
1383 <a id="PARAM_JPEGWIDTH">
1384 <!-- -->
1385 </a>
1386 <ul class="blockList">
1387 <li class="blockList">
1388 <h4>PARAM_JPEGWIDTH</h4>
1389 <pre>public static final&nbsp;int PARAM_JPEGWIDTH</pre>
1390 <div class="block">JPEG width (in pixels) [decompression only, read-only]</div>
1391 <dl>
1392 <dt><span class="seeLabel">See Also:</span></dt>
1393 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_JPEGWIDTH">Constant Field Values</a></dd>
1394 </dl>
1395 </li>
1396 </ul>
1397 <a id="PARAM_JPEGHEIGHT">
1398 <!-- -->
1399 </a>
1400 <ul class="blockList">
1401 <li class="blockList">
1402 <h4>PARAM_JPEGHEIGHT</h4>
1403 <pre>public static final&nbsp;int PARAM_JPEGHEIGHT</pre>
1404 <div class="block">JPEG height (in pixels) [decompression only, read-only]</div>
1405 <dl>
1406 <dt><span class="seeLabel">See Also:</span></dt>
1407 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_JPEGHEIGHT">Constant Field Values</a></dd>
1408 </dl>
1409 </li>
1410 </ul>
1411 <a id="PARAM_PRECISION">
1412 <!-- -->
1413 </a>
1414 <ul class="blockList">
1415 <li class="blockList">
1416 <h4>PARAM_PRECISION</h4>
1417 <pre>public static final&nbsp;int PARAM_PRECISION</pre>
1418 <div class="block">Data precision (bits per sample)
1419
1420 <p>The JPEG image uses (decompression) or will use (lossless compression)
1421 the specified number of bits per sample. This parameter also specifies
1422 the target data precision when loading a PBMPLUS file with
1423 <a href="TJCompressor.html#loadSourceImage(java.lang.String,int,int)"><code>TJCompressor.loadSourceImage()</code></a> and
1424 the source data precision when saving a PBMPLUS file with
1425 <a href="TJDecompressor.html#saveImage(java.lang.String,java.lang.Object,int,int,int,int,int,int)"><code>TJDecompressor.saveImage()</code></a>.
1426
1427 <p>The data precision is the number of bits in the maximum sample value,
1428 which may not be the same as the width of the data type used to store the
1429 sample.
1430
1431 <p><b>Value</b>
1432 <ul>
1433 <li> <code>8</code> or <code>12</code> for lossy JPEG images;
1434 <code>2</code> to <code>16</code> for lossless JPEG and PBMPLUS images
1435 </ul>
1436
1437 <p>12-bit JPEG data precision implies <a href="#PARAM_OPTIMIZE"><code>PARAM_OPTIMIZE</code></a> unless
1438 <a href="#PARAM_ARITHMETIC"><code>PARAM_ARITHMETIC</code></a> is set.</div>
1439 <dl>
1440 <dt><span class="seeLabel">See Also:</span></dt>
1441 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_PRECISION">Constant Field Values</a></dd>
1442 </dl>
1443 </li>
1444 </ul>
1445 <a id="PARAM_COLORSPACE">
1446 <!-- -->
1447 </a>
1448 <ul class="blockList">
1449 <li class="blockList">
1450 <h4>PARAM_COLORSPACE</h4>
1451 <pre>public static final&nbsp;int PARAM_COLORSPACE</pre>
1452 <div class="block">JPEG colorspace
1453
1454 <p>The JPEG image uses (decompression) or will use (lossy compression) the
1455 specified colorspace.
1456
1457 <p><b>Value</b>
1458 <ul>
1459 <li> One of <a href="#CS_RGB"><code>TJ.CS_*</code></a> <i>[default for lossy compression:
1460 automatically selected based on the subsampling level and pixel
1461 format]</i>
1462 </ul></div>
1463 <dl>
1464 <dt><span class="seeLabel">See Also:</span></dt>
1465 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_COLORSPACE">Constant Field Values</a></dd>
1466 </dl>
1467 </li>
1468 </ul>
1469 <a id="PARAM_FASTUPSAMPLE">
1470 <!-- -->
1471 </a>
1472 <ul class="blockList">
1473 <li class="blockList">
1474 <h4>PARAM_FASTUPSAMPLE</h4>
1475 <pre>public static final&nbsp;int PARAM_FASTUPSAMPLE</pre>
1476 <div class="block">Chrominance upsampling algorithm [lossy decompression only]
1477
1478 <p><b>Value</b>
1479 <ul>
1480 <li> <code>0</code> <i>[default]</i> Use smooth upsampling when
1481 decompressing a JPEG image that was generated using chrominance
1482 subsampling. This creates a smooth transition between neighboring
1483 chrominance components in order to reduce upsampling artifacts in the
1484 decompressed image.
1485 <li> <code>1</code> Use the fastest chrominance upsampling algorithm
1486 available, which may combine upsampling with color conversion.
1487 </ul></div>
1488 <dl>
1489 <dt><span class="seeLabel">See Also:</span></dt>
1490 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_FASTUPSAMPLE">Constant Field Values</a></dd>
1491 </dl>
1492 </li>
1493 </ul>
1494 <a id="PARAM_FASTDCT">
1495 <!-- -->
1496 </a>
1497 <ul class="blockList">
1498 <li class="blockList">
1499 <h4>PARAM_FASTDCT</h4>
1500 <pre>public static final&nbsp;int PARAM_FASTDCT</pre>
1501 <div class="block">DCT/IDCT algorithm [lossy compression and decompression]
1502
1503 <p><b>Value</b>
1504 <ul>
1505 <li> <code>0</code> <i>[default]</i> Use the most accurate DCT/IDCT
1506 algorithm available.
1507 <li> <code>1</code> Use the fastest DCT/IDCT algorithm available.
1508 </ul>
1509
1510 <p>This parameter is provided mainly for backward compatibility with
1511 libjpeg, which historically implemented several different DCT/IDCT
1512 algorithms because of performance limitations with 1990s CPUs. In the
1513 libjpeg-turbo implementation of the TurboJPEG API:
1514
1515 <ul>
1516 <li> The "fast" and "accurate" DCT/IDCT algorithms perform similarly on
1517 modern x86/x86-64 CPUs that support AVX2 instructions.
1518 <li> The "fast" algorithm is generally only about 5-15% faster than the
1519 "accurate" algorithm on other types of CPUs.
1520 <li> The difference in accuracy between the "fast" and "accurate"
1521 algorithms is the most pronounced at JPEG quality levels above 90 and
1522 tends to be more pronounced with decompression than with compression.
1523 <li> For JPEG quality levels above 97, the "fast" algorithm degrades and
1524 is not fully accelerated, so it is slower than the "accurate" algorithm.
1525 </ul></div>
1526 <dl>
1527 <dt><span class="seeLabel">See Also:</span></dt>
1528 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_FASTDCT">Constant Field Values</a></dd>
1529 </dl>
1530 </li>
1531 </ul>
1532 <a id="PARAM_OPTIMIZE">
1533 <!-- -->
1534 </a>
1535 <ul class="blockList">
1536 <li class="blockList">
1537 <h4>PARAM_OPTIMIZE</h4>
1538 <pre>public static final&nbsp;int PARAM_OPTIMIZE</pre>
1539 <div class="block">Huffman table optimization [lossy compression, lossless transformation]
1540
1541 <p><b>Value</b>
1542 <ul>
1543 <li> <code>0</code> <i>[default]</i> The JPEG image will use the default
1544 Huffman tables.
1545 <li> <code>1</code> Optimal Huffman tables will be computed for the JPEG
1546 image. For lossless transformation, this can also be specified using
1547 <a href="TJTransform.html#OPT_OPTIMIZE"><code>TJTransform.OPT_OPTIMIZE</code></a>.
1548 </ul>
1549
1550 <p>Huffman table optimization improves compression slightly (generally 5%
1551 or less), but it reduces compression performance considerably.</div>
1552 <dl>
1553 <dt><span class="seeLabel">See Also:</span></dt>
1554 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_OPTIMIZE">Constant Field Values</a></dd>
1555 </dl>
1556 </li>
1557 </ul>
1558 <a id="PARAM_PROGRESSIVE">
1559 <!-- -->
1560 </a>
1561 <ul class="blockList">
1562 <li class="blockList">
1563 <h4>PARAM_PROGRESSIVE</h4>
1564 <pre>public static final&nbsp;int PARAM_PROGRESSIVE</pre>
1565 <div class="block">Progressive JPEG
1566
1567 <p>In a progressive JPEG image, the DCT coefficients are split across
1568 multiple "scans" of increasing quality. Thus, a low-quality scan
1569 containing the lowest-frequency DCT coefficients can be transmitted first
1570 and refined with subsequent higher-quality scans containing
1571 higher-frequency DCT coefficients. When using Huffman entropy coding, the
1572 progressive JPEG format also provides an "end-of-bands (EOB) run" feature
1573 that allows large groups of zeroes, potentially spanning multiple MCUs, to
1574 be represented using only a few bytes.
1575
1576 <p><b>Value</b>
1577 <ul>
1578 <li> <code>0</code> <i>[default for compression, lossless
1579 transformation]</i> The lossy JPEG image is (decompression) or will be
1580 (compression, lossless transformation) single-scan.
1581 <li> <code>1</code> The lossy JPEG image is (decompression) or will be
1582 (compression, lossless transformation) progressive. For lossless
1583 transformation, this can also be specified using
1584 <a href="TJTransform.html#OPT_PROGRESSIVE"><code>TJTransform.OPT_PROGRESSIVE</code></a>.
1585 </ul>
1586
1587 <p>Progressive JPEG images generally have better compression ratios than
1588 single-scan JPEG images (much better if the image has large areas of solid
1589 color), but progressive JPEG compression and decompression is considerably
1590 slower than single-scan JPEG compression and decompression. Can be
1591 combined with <a href="#PARAM_ARITHMETIC"><code>PARAM_ARITHMETIC</code></a>. Implies <a href="#PARAM_OPTIMIZE"><code>PARAM_OPTIMIZE</code></a>
1592 unless <a href="#PARAM_ARITHMETIC"><code>PARAM_ARITHMETIC</code></a> is also set.</div>
1593 <dl>
1594 <dt><span class="seeLabel">See Also:</span></dt>
1595 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_PROGRESSIVE">Constant Field Values</a></dd>
1596 </dl>
1597 </li>
1598 </ul>
1599 <a id="PARAM_SCANLIMIT">
1600 <!-- -->
1601 </a>
1602 <ul class="blockList">
1603 <li class="blockList">
1604 <h4>PARAM_SCANLIMIT</h4>
1605 <pre>public static final&nbsp;int PARAM_SCANLIMIT</pre>
1606 <div class="block">Progressive JPEG scan limit for lossy JPEG images [decompression, lossless
1607 transformation]
1608
1609 <p>Setting this parameter causes the decompression and transform
1610 operations to throw an error if the number of scans in a progressive JPEG
1611 image exceeds the specified limit. The primary purpose of this is to
1612 allow security-critical applications to guard against an exploit of the
1613 progressive JPEG format described in
1614 <a href="https://libjpeg-turbo.org/pmwiki/uploads/About/TwoIssueswiththeJPEGStandard.pdf" target="_blank">this report</a>.
1615
1616 <p><b>Value</b>
1617 <ul>
1618 <li> maximum number of progressive JPEG scans that the decompression and
1619 transform operations will process <i>[default: <code>0</code> (no
1620 limit)]</i>
1621 </ul></div>
1622 <dl>
1623 <dt><span class="seeLabel">See Also:</span></dt>
1624 <dd><a href="#PARAM_PROGRESSIVE"><code>PARAM_PROGRESSIVE</code></a>,
1625 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_SCANLIMIT">Constant Field Values</a></dd>
1626 </dl>
1627 </li>
1628 </ul>
1629 <a id="PARAM_ARITHMETIC">
1630 <!-- -->
1631 </a>
1632 <ul class="blockList">
1633 <li class="blockList">
1634 <h4>PARAM_ARITHMETIC</h4>
1635 <pre>public static final&nbsp;int PARAM_ARITHMETIC</pre>
1636 <div class="block">Arithmetic entropy coding
1637
1638 <p><b>Value</b>
1639 <ul>
1640 <li> <code>0</code> <i>[default for compression, lossless
1641 transformation]</i> The lossy JPEG image uses (decompression) or will use
1642 (compression, lossless transformation) Huffman entropy coding.
1643 <li> <code>1</code> The lossy JPEG image uses (decompression) or will use
1644 (compression, lossless transformation) arithmetic entropy coding. For
1645 lossless transformation, this can also be specified using
1646 <a href="TJTransform.html#OPT_ARITHMETIC"><code>TJTransform.OPT_ARITHMETIC</code></a>.
1647 </ul>
1648
1649 <p>Arithmetic entropy coding generally improves compression relative to
1650 Huffman entropy coding, but it reduces compression and decompression
1651 performance considerably. Can be combined with
1652 <a href="#PARAM_PROGRESSIVE"><code>PARAM_PROGRESSIVE</code></a>.</div>
1653 <dl>
1654 <dt><span class="seeLabel">See Also:</span></dt>
1655 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_ARITHMETIC">Constant Field Values</a></dd>
1656 </dl>
1657 </li>
1658 </ul>
1659 <a id="PARAM_LOSSLESS">
1660 <!-- -->
1661 </a>
1662 <ul class="blockList">
1663 <li class="blockList">
1664 <h4>PARAM_LOSSLESS</h4>
1665 <pre>public static final&nbsp;int PARAM_LOSSLESS</pre>
1666 <div class="block">Lossless JPEG
1667
1668 <p><b>Value</b>
1669 <ul>
1670 <li> <code>0</code> <i>[default for compression]</i> The JPEG image is
1671 (decompression) or will be (compression) lossy/DCT-based.
1672 <li> <code>1</code> The JPEG image is (decompression) or will be
1673 (compression) lossless/predictive.
1674 </ul>
1675
1676 <p>In most cases, lossless JPEG compression and decompression is
1677 considerably slower than lossy JPEG compression and decompression, and
1678 lossless JPEG images are much larger than lossy JPEG images. Thus,
1679 lossless JPEG images are typically used only for applications that require
1680 mathematically lossless compression. Also note that the following
1681 features are not available with lossless JPEG images:
1682 <ul>
1683 <li> Colorspace conversion (lossless JPEG images always use
1684 <a href="#CS_RGB"><code>CS_RGB</code></a>, <a href="#CS_GRAY"><code>CS_GRAY</code></a>, or <a href="#CS_CMYK"><code>CS_CMYK</code></a>, depending on the
1685 pixel format of the source image)
1686 <li> Chrominance subsampling (lossless JPEG images always use
1687 <a href="#SAMP_444"><code>SAMP_444</code></a>)
1688 <li> JPEG quality selection
1689 <li> DCT/IDCT algorithm selection
1690 <li> Progressive JPEG
1691 <li> Arithmetic entropy coding
1692 <li> Compression from/decompression to planar YUV images
1693 <li> Decompression scaling
1694 <li> Lossless transformation
1695 </ul></div>
1696 <dl>
1697 <dt><span class="seeLabel">See Also:</span></dt>
1698 <dd><a href="#PARAM_LOSSLESSPSV"><code>PARAM_LOSSLESSPSV</code></a>,
1699 <a href="#PARAM_LOSSLESSPT"><code>PARAM_LOSSLESSPT</code></a>,
1700 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_LOSSLESS">Constant Field Values</a></dd>
1701 </dl>
1702 </li>
1703 </ul>
1704 <a id="PARAM_LOSSLESSPSV">
1705 <!-- -->
1706 </a>
1707 <ul class="blockList">
1708 <li class="blockList">
1709 <h4>PARAM_LOSSLESSPSV</h4>
1710 <pre>public static final&nbsp;int PARAM_LOSSLESSPSV</pre>
1711 <div class="block">Lossless JPEG predictor selection value (PSV)
1712
1713 <p><b>Value</b>
1714 <ul>
1715 <li> <code>1</code>-<code>7</code> <i>[default for compression:
1716 <code>1</code>]</i>
1717 </ul>
1718
1719 <p>Lossless JPEG compression shares no algorithms with lossy JPEG
1720 compression. Instead, it uses differential pulse-code modulation (DPCM),
1721 an algorithm whereby each sample is encoded as the difference between the
1722 sample's value and a "predictor", which is based on the values of
1723 neighboring samples. If Ra is the sample immediately to the left of the
1724 current sample, Rb is the sample immediately above the current sample, and
1725 Rc is the sample diagonally to the left and above the current sample, then
1726 the relationship between the predictor selection value and the predictor
1727 is as follows:
1728
1729 <table border=1>
1730 <caption></caption>
1731 <tr> <th>PSV</th> <th>Predictor</th> </tr>
1732 <tr> <td>1</td> <td>Ra</td> </tr>
1733 <tr> <td>2</td> <td>Rb</td> </tr>
1734 <tr> <td>3</td> <td>Rc</td> </tr>
1735 <tr> <td>4</td> <td>Ra + Rb – Rc</td> </tr>
1736 <tr> <td>5</td> <td>Ra + (Rb – Rc) / 2</td> </tr>
1737 <tr> <td>6</td> <td>Rb + (Ra – Rc) / 2</td> </tr>
1738 <tr> <td>7</td> <td>(Ra + Rb) / 2</td> </tr>
1739 </table>
1740
1741 <p>Predictors 1-3 are 1-dimensional predictors, whereas Predictors 4-7 are
1742 2-dimensional predictors. The best predictor for a particular image
1743 depends on the image.</div>
1744 <dl>
1745 <dt><span class="seeLabel">See Also:</span></dt>
1746 <dd><a href="#PARAM_LOSSLESS"><code>PARAM_LOSSLESS</code></a>,
1747 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_LOSSLESSPSV">Constant Field Values</a></dd>
1748 </dl>
1749 </li>
1750 </ul>
1751 <a id="PARAM_LOSSLESSPT">
1752 <!-- -->
1753 </a>
1754 <ul class="blockList">
1755 <li class="blockList">
1756 <h4>PARAM_LOSSLESSPT</h4>
1757 <pre>public static final&nbsp;int PARAM_LOSSLESSPT</pre>
1758 <div class="block">Lossless JPEG point transform (Pt)
1759
1760 <p><b>Value</b>
1761 <ul>
1762 <li> <code>0</code> through <i><b>precision</b> - 1</i>, where
1763 <b><i>precision</i></b> is the JPEG data precision in bits <i>[default for
1764 compression: <code>0</code>]</i>
1765 </ul>
1766
1767 <p>A point transform value of <code>0</code> is necessary in order to
1768 generate a fully lossless JPEG image. (A non-zero point transform value
1769 right-shifts the input samples by the specified number of bits, which is
1770 effectively a form of lossy color quantization.)</div>
1771 <dl>
1772 <dt><span class="seeLabel">See Also:</span></dt>
1773 <dd><a href="#PARAM_LOSSLESS"><code>PARAM_LOSSLESS</code></a>,
1774 <a href="#PARAM_PRECISION"><code>PARAM_PRECISION</code></a>,
1775 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_LOSSLESSPT">Constant Field Values</a></dd>
1776 </dl>
1777 </li>
1778 </ul>
1779 <a id="PARAM_RESTARTBLOCKS">
1780 <!-- -->
1781 </a>
1782 <ul class="blockList">
1783 <li class="blockList">
1784 <h4>PARAM_RESTARTBLOCKS</h4>
1785 <pre>public static final&nbsp;int PARAM_RESTARTBLOCKS</pre>
1786 <div class="block">JPEG restart marker interval in MCUs [lossy compression only]
1787
1788 <p>The nature of entropy coding is such that a corrupt JPEG image cannot
1789 be decompressed beyond the point of corruption unless it contains restart
1790 markers. A restart marker stops and restarts the entropy coding algorithm
1791 so that, if a JPEG image is corrupted, decompression can resume at the
1792 next marker. Thus, adding more restart markers improves the fault
1793 tolerance of the JPEG image, but adding too many restart markers can
1794 adversely affect the compression ratio and performance.
1795
1796 <p>In typical JPEG images, an MCU (Minimum Coded Unit) is the minimum set
1797 of interleaved "data units" (8x8 DCT blocks if the image is lossy or
1798 samples if the image is lossless) necessary to represent at least one data
1799 unit per component. (For example, an MCU in an interleaved lossy JPEG
1800 image that uses 4:2:2 subsampling consists of two luminance blocks
1801 followed by one block for each chrominance component.) In
1802 single-component or non-interleaved JPEG images, an MCU is the same as a
1803 data unit.
1804
1805 <p><b>Value</b>
1806 <ul>
1807 <li> the number of MCUs between each restart marker <i>[default:
1808 <code>0</code> (no restart markers)]</i>
1809 </ul>
1810
1811 <p> Setting this parameter to a non-zero value sets
1812 <a href="#PARAM_RESTARTROWS"><code>PARAM_RESTARTROWS</code></a> to 0.</div>
1813 <dl>
1814 <dt><span class="seeLabel">See Also:</span></dt>
1815 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_RESTARTBLOCKS">Constant Field Values</a></dd>
1816 </dl>
1817 </li>
1818 </ul>
1819 <a id="PARAM_RESTARTROWS">
1820 <!-- -->
1821 </a>
1822 <ul class="blockList">
1823 <li class="blockList">
1824 <h4>PARAM_RESTARTROWS</h4>
1825 <pre>public static final&nbsp;int PARAM_RESTARTROWS</pre>
1826 <div class="block">JPEG restart marker interval in MCU rows [compression only]
1827
1828 <p>See <a href="#PARAM_RESTARTBLOCKS"><code>PARAM_RESTARTBLOCKS</code></a> for a description of restart markers
1829 and MCUs. An MCU row is a row of MCUs spanning the entire width of the
1830 image.
1831
1832 <p><b>Value</b>
1833 <ul>
1834 <li> the number of MCU rows between each restart marker <i>[default:
1835 <code>0</code> (no restart markers)]</i>
1836 </ul>
1837
1838 <p>Setting this parameter to a non-zero value sets
1839 <a href="#PARAM_RESTARTBLOCKS"><code>PARAM_RESTARTBLOCKS</code></a> to 0.</div>
1840 <dl>
1841 <dt><span class="seeLabel">See Also:</span></dt>
1842 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_RESTARTROWS">Constant Field Values</a></dd>
1843 </dl>
1844 </li>
1845 </ul>
1846 <a id="PARAM_XDENSITY">
1847 <!-- -->
1848 </a>
1849 <ul class="blockList">
1850 <li class="blockList">
1851 <h4>PARAM_XDENSITY</h4>
1852 <pre>public static final&nbsp;int PARAM_XDENSITY</pre>
1853 <div class="block">JPEG horizontal pixel density
1854
1855 <p><b>Value</b>
1856 <ul>
1857 <li> The JPEG image has (decompression) or will have (compression) the
1858 specified horizontal pixel density <i>[default for compression:
1859 <code>1</code>]</i>.
1860 </ul>
1861
1862 <p>This value is stored in or read from the JPEG header. It does not
1863 affect the contents of the JPEG image. Note that this parameter is set by
1864 <a href="TJCompressor.html#loadSourceImage(java.lang.String,int,int)"><code>TJCompressor.loadSourceImage()</code></a> when
1865 loading a Windows BMP file that contains pixel density information, and
1866 the value of this parameter is stored to a Windows BMP file by
1867 <a href="TJDecompressor.html#saveImage(java.lang.String,java.lang.Object,int,int,int,int,int,int)"><code>TJDecompressor.saveImage()</code></a> if the value
1868 of <a href="#PARAM_DENSITYUNITS"><code>PARAM_DENSITYUNITS</code></a> is <code>2</code>.
1869
1870 <p>This parameter has no effect unless the JPEG colorspace (see
1871 <a href="#PARAM_COLORSPACE"><code>PARAM_COLORSPACE</code></a>) is <a href="#CS_YCbCr"><code>CS_YCbCr</code></a> or <a href="#CS_GRAY"><code>CS_GRAY</code></a>.</div>
1872 <dl>
1873 <dt><span class="seeLabel">See Also:</span></dt>
1874 <dd><a href="#PARAM_DENSITYUNITS"><code>PARAM_DENSITYUNITS</code></a>,
1875 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_XDENSITY">Constant Field Values</a></dd>
1876 </dl>
1877 </li>
1878 </ul>
1879 <a id="PARAM_YDENSITY">
1880 <!-- -->
1881 </a>
1882 <ul class="blockList">
1883 <li class="blockList">
1884 <h4>PARAM_YDENSITY</h4>
1885 <pre>public static final&nbsp;int PARAM_YDENSITY</pre>
1886 <div class="block">JPEG vertical pixel density
1887
1888 <p><b>Value</b>
1889 <ul>
1890 <li> The JPEG image has (decompression) or will have (compression) the
1891 specified vertical pixel density <i>[default for compression:
1892 <code>1</code>]</i>.
1893 </ul>
1894
1895 <p>This value is stored in or read from the JPEG header. It does not
1896 affect the contents of the JPEG image. Note that this parameter is set by
1897 <a href="TJCompressor.html#loadSourceImage(java.lang.String,int,int)"><code>TJCompressor.loadSourceImage()</code></a> when
1898 loading a Windows BMP file that contains pixel density information, and
1899 the value of this parameter is stored to a Windows BMP file by
1900 <a href="TJDecompressor.html#saveImage(java.lang.String,java.lang.Object,int,int,int,int,int,int)"><code>TJDecompressor.saveImage()</code></a> if the value
1901 of <a href="#PARAM_DENSITYUNITS"><code>PARAM_DENSITYUNITS</code></a> is <code>2</code>.
1902
1903 <p>This parameter has no effect unless the JPEG colorspace (see
1904 <a href="#PARAM_COLORSPACE"><code>PARAM_COLORSPACE</code></a>) is <a href="#CS_YCbCr"><code>CS_YCbCr</code></a> or <a href="#CS_GRAY"><code>CS_GRAY</code></a>.</div>
1905 <dl>
1906 <dt><span class="seeLabel">See Also:</span></dt>
1907 <dd><a href="#PARAM_DENSITYUNITS"><code>PARAM_DENSITYUNITS</code></a>,
1908 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_YDENSITY">Constant Field Values</a></dd>
1909 </dl>
1910 </li>
1911 </ul>
1912 <a id="PARAM_DENSITYUNITS">
1913 <!-- -->
1914 </a>
1915 <ul class="blockList">
1916 <li class="blockList">
1917 <h4>PARAM_DENSITYUNITS</h4>
1918 <pre>public static final&nbsp;int PARAM_DENSITYUNITS</pre>
1919 <div class="block">JPEG pixel density units
1920
1921 <p><b>Value</b>
1922 <ul>
1923 <li> <code>0</code> <i>[default for compression]</i> The pixel density of
1924 the JPEG image is expressed (decompression) or will be expressed
1925 (compression) in unknown units.
1926 <li> <code>1</code> The pixel density of the JPEG image is expressed
1927 (decompression) or will be expressed (compression) in units of
1928 pixels/inch.
1929 <li> <code>2</code> The pixel density of the JPEG image is expressed
1930 (decompression) or will be expressed (compression) in units of pixels/cm.
1931 </ul>
1932
1933 <p>This value is stored in or read from the JPEG header. It does not
1934 affect the contents of the JPEG image. Note that this parameter is set by
1935 <a href="TJCompressor.html#loadSourceImage(java.lang.String,int,int)"><code>TJCompressor.loadSourceImage()</code></a> when
1936 loading a Windows BMP file that contains pixel density information, and
1937 the value of this parameter is stored to a Windows BMP file by
1938 <a href="TJDecompressor.html#saveImage(java.lang.String,java.lang.Object,int,int,int,int,int,int)"><code>TJDecompressor.saveImage()</code></a> if the value
1939 is <code>2</code>.
1940
1941 <p>This parameter has no effect unless the JPEG colorspace (see
1942 <a href="#PARAM_COLORSPACE"><code>PARAM_COLORSPACE</code></a>) is <a href="#CS_YCbCr"><code>CS_YCbCr</code></a> or <a href="#CS_GRAY"><code>CS_GRAY</code></a>.</div>
1943 <dl>
1944 <dt><span class="seeLabel">See Also:</span></dt>
1945 <dd><a href="#PARAM_XDENSITY"><code>PARAM_XDENSITY</code></a>,
1946 <a href="#PARAM_YDENSITY"><code>PARAM_YDENSITY</code></a>,
1947 <a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_DENSITYUNITS">Constant Field Values</a></dd>
1948 </dl>
1949 </li>
1950 </ul>
1951 <a id="PARAM_MAXMEMORY">
1952 <!-- -->
1953 </a>
1954 <ul class="blockList">
1955 <li class="blockList">
1956 <h4>PARAM_MAXMEMORY</h4>
1957 <pre>public static final&nbsp;int PARAM_MAXMEMORY</pre>
1958 <div class="block">Memory limit for intermediate buffers
1959
1960 <p><b>Value</b>
1961 <ul>
1962 <li> the maximum amount of memory (in megabytes) that will be allocated
1963 for intermediate buffers, which are used with progressive JPEG compression
1964 and decompression, Huffman table optimization, lossless JPEG compression,
1965 and lossless transformation <i>[default: <code>0</code> (no limit)]</i>
1966 </ul></div>
1967 <dl>
1968 <dt><span class="seeLabel">See Also:</span></dt>
1969 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_MAXMEMORY">Constant Field Values</a></dd>
1970 </dl>
1971 </li>
1972 </ul>
1973 <a id="PARAM_MAXPIXELS">
1974 <!-- -->
1975 </a>
1976 <ul class="blockList">
1977 <li class="blockList">
1978 <h4>PARAM_MAXPIXELS</h4>
1979 <pre>public static final&nbsp;int PARAM_MAXPIXELS</pre>
1980 <div class="block">Image size limit [decompression, lossless transformation]
1981
1982 <p>Setting this parameter causes the decompression and transform
1983 operations to throw an error if the number of pixels in the JPEG source
1984 image exceeds the specified limit. This allows security-critical
1985 applications to guard against excessive memory consumption.
1986
1987 <p><b>Value</b>
1988 <ul>
1989 <li> maximum number of pixels that the decompression and transform
1990 operations will process <i>[default: <code>0</code> (no limit)]</i>
1991 </ul></div>
1992 <dl>
1993 <dt><span class="seeLabel">See Also:</span></dt>
1994 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_MAXPIXELS">Constant Field Values</a></dd>
1995 </dl>
1996 </li>
1997 </ul>
1998 <a id="PARAM_SAVEMARKERS">
1999 <!-- -->
2000 </a>
2001 <ul class="blockList">
2002 <li class="blockList">
2003 <h4>PARAM_SAVEMARKERS</h4>
2004 <pre>public static final&nbsp;int PARAM_SAVEMARKERS</pre>
2005 <div class="block">Marker copying behavior [decompression, lossless transformation]
2006
2007 <p><b>Value [lossless transformation]</b>
2008 <ul>
2009 <li> <code>0</code> Do not copy any extra markers (including comments,
2010 JFIF thumbnails, Exif data, and ICC profile data) from the source image to
2011 the destination image.
2012 <li> <code>1</code> Do not copy any extra markers, except comment (COM)
2013 markers, from the source image to the destination image.
2014 <li> <code>2</code> <i>[default]</i> Copy all extra markers from the
2015 source image to the destination image.
2016 <li> <code>3</code> Copy all extra markers, except ICC profile data (APP2
2017 markers), from the source image to the destination image.
2018 <li> <code>4</code> Do not copy any extra markers, except ICC profile data
2019 (APP2 markers), from the source image to the destination image.
2020 </ul>
2021
2022 <p><a href="TJTransform.html#OPT_COPYNONE"><code>TJTransform.OPT_COPYNONE</code></a> overrides this parameter for a
2023 particular transform. This parameter overrides any ICC profile that was
2024 previously associated with a compressor instance using
2025 <a href="TJCompressor.html#setICCProfile(byte%5B%5D)"><code>TJCompressor.setICCProfile()</code></a> or with a
2026 transformer instance using <a href="TJTransformer.html#setICCProfile(byte%5B%5D)"><code>TJTransformer.setICCProfile()</code></a>.
2027
2028 <p>When decompressing, associating a JPEG source image with the
2029 decompressor instance extracts the ICC profile from the source image if
2030 this parameter is set to <code>2</code> or <code>4</code>.
2031 <a href="TJDecompressor.html#getICCProfile()"><code>TJDecompressor.getICCProfile()</code></a> can then be used to retrieve the
2032 profile.</div>
2033 <dl>
2034 <dt><span class="seeLabel">See Also:</span></dt>
2035 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.PARAM_SAVEMARKERS">Constant Field Values</a></dd>
2036 </dl>
2037 </li>
2038 </ul>
2039 <a id="NUMERR">
2040 <!-- -->
2041 </a>
2042 <ul class="blockList">
2043 <li class="blockList">
2044 <h4>NUMERR</h4>
2045 <pre>public static final&nbsp;int NUMERR</pre>
2046 <div class="block">The number of error codes</div>
2047 <dl>
2048 <dt><span class="seeLabel">See Also:</span></dt>
2049 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.NUMERR">Constant Field Values</a></dd>
2050 </dl>
2051 </li>
2052 </ul>
2053 <a id="ERR_WARNING">
2054 <!-- -->
2055 </a>
2056 <ul class="blockList">
2057 <li class="blockList">
2058 <h4>ERR_WARNING</h4>
2059 <pre>public static final&nbsp;int ERR_WARNING</pre>
2060 <div class="block">The error was non-fatal and recoverable, but the destination image may
2061 still be corrupt.
2062
2063 <p>NOTE: Due to the design of the TurboJPEG Java API, only certain methods
2064 (specifically, <a href="TJDecompressor.html" title="class in org.libjpegturbo.turbojpeg"><code>TJDecompressor.decompress*()</code></a> methods
2065 with a void return type) will complete and leave the destination image in
2066 a fully recoverable state after a non-fatal error occurs.</div>
2067 <dl>
2068 <dt><span class="seeLabel">See Also:</span></dt>
2069 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.ERR_WARNING">Constant Field Values</a></dd>
2070 </dl>
2071 </li>
2072 </ul>
2073 <a id="ERR_FATAL">
2074 <!-- -->
2075 </a>
2076 <ul class="blockList">
2077 <li class="blockList">
2078 <h4>ERR_FATAL</h4>
2079 <pre>public static final&nbsp;int ERR_FATAL</pre>
2080 <div class="block">The error was fatal and non-recoverable.</div>
2081 <dl>
2082 <dt><span class="seeLabel">See Also:</span></dt>
2083 <dd><a href="../../../constant-values.html#org.libjpegturbo.turbojpeg.TJ.ERR_FATAL">Constant Field Values</a></dd>
2084 </dl>
2085 </li>
2086 </ul>
2087 <a id="UNSCALED">
2088 <!-- -->
2089 </a>
2090 <ul class="blockList">
2091 <li class="blockList">
2092 <h4>UNSCALED</h4>
2093 <pre>public static final&nbsp;<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a> UNSCALED</pre>
2094 <div class="block">A <a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg"><code>TJScalingFactor</code></a> instance that specifies a scaling factor of 1/1
2095 (no scaling)</div>
2096 </li>
2097 </ul>
2098 <a id="UNCROPPED">
2099 <!-- -->
2100 </a>
2101 <ul class="blockListLast">
2102 <li class="blockList">
2103 <h4>UNCROPPED</h4>
2104 <pre>public static final&nbsp;java.awt.Rectangle UNCROPPED</pre>
2105 <div class="block">A <code>java.awt.Rectangle</code> instance that specifies no cropping</div>
2106 </li>
2107 </ul>
2108 </li>
2109 </ul>
2110 </section>
2111 <!-- ============ METHOD DETAIL ========== -->
2112 <section>
2113 <ul class="blockList">
2114 <li class="blockList"><a id="method.detail">
2115 <!-- -->
2116 </a>
2117 <h3>Method Detail</h3>
2118 <a id="getMCUWidth(int)">
2119 <!-- -->
2120 </a>
2121 <ul class="blockList">
2122 <li class="blockList">
2123 <h4>getMCUWidth</h4>
2124 <pre class="methodSignature">public static&nbsp;int&nbsp;getMCUWidth&#8203;(int&nbsp;subsamp)</pre>
2125 <div class="block">Returns the iMCU width for the given level of chrominance subsampling.
2126
2127 <p>In a typical lossy JPEG image, 8x8 blocks of DCT coefficients for each
2128 component are interleaved in a single scan. If the image uses chrominance
2129 subsampling, then multiple luminance blocks are stored together, followed
2130 by a single block for each chrominance component. The minimum set of
2131 full-resolution luminance block(s) and corresponding (possibly subsampled)
2132 chrominance blocks necessary to represent at least one DCT block per
2133 component is called a "Minimum Coded Unit" or "MCU". (For example, an MCU
2134 in an interleaved lossy JPEG image that uses 4:2:2 subsampling consists of
2135 two luminance blocks followed by one block for each chrominance
2136 component.) In a non-interleaved lossy JPEG image, each component is
2137 stored in a separate scan, and an MCU is a single DCT block, so we use the
2138 term "iMCU" (interleaved MCU) to refer to the equivalent of an MCU in an
2139 interleaved JPEG image. For the common case of interleaved JPEG images,
2140 an iMCU is the same as an MCU.</div>
2141 <dl>
2142 <dt><span class="paramLabel">Parameters:</span></dt>
2143 <dd><code>subsamp</code> - the level of chrominance subsampling (one of
2144 <a href="#SAMP_444"><code>SAMP_*</code></a>)</dd>
2145 <dt><span class="returnLabel">Returns:</span></dt>
2146 <dd>the iMCU width for the given level of chrominance subsampling.</dd>
2147 </dl>
2148 </li>
2149 </ul>
2150 <a id="getMCUHeight(int)">
2151 <!-- -->
2152 </a>
2153 <ul class="blockList">
2154 <li class="blockList">
2155 <h4>getMCUHeight</h4>
2156 <pre class="methodSignature">public static&nbsp;int&nbsp;getMCUHeight&#8203;(int&nbsp;subsamp)</pre>
2157 <div class="block">Returns the iMCU height for the given level of chrominance subsampling.
2158
2159 <p>In a typical lossy JPEG image, 8x8 blocks of DCT coefficients for each
2160 component are interleaved in a single scan. If the image uses chrominance
2161 subsampling, then multiple luminance blocks are stored together, followed
2162 by a single block for each chrominance component. The minimum set of
2163 full-resolution luminance block(s) and corresponding (possibly subsampled)
2164 chrominance blocks necessary to represent at least one DCT block per
2165 component is called a "Minimum Coded Unit" or "MCU". (For example, an MCU
2166 in an interleaved lossy JPEG image that uses 4:2:2 subsampling consists of
2167 two luminance blocks followed by one block for each chrominance
2168 component.) In a non-interleaved lossy JPEG image, each component is
2169 stored in a separate scan, and an MCU is a single DCT block, so we use the
2170 term "iMCU" (interleaved MCU) to refer to the equivalent of an MCU in an
2171 interleaved JPEG image. For the common case of interleaved JPEG images,
2172 an iMCU is the same as an MCU.</div>
2173 <dl>
2174 <dt><span class="paramLabel">Parameters:</span></dt>
2175 <dd><code>subsamp</code> - the level of chrominance subsampling (one of
2176 <a href="#SAMP_444"><code>SAMP_*</code></a>)</dd>
2177 <dt><span class="returnLabel">Returns:</span></dt>
2178 <dd>the iMCU height for the given level of chrominance subsampling.</dd>
2179 </dl>
2180 </li>
2181 </ul>
2182 <a id="getPixelSize(int)">
2183 <!-- -->
2184 </a>
2185 <ul class="blockList">
2186 <li class="blockList">
2187 <h4>getPixelSize</h4>
2188 <pre class="methodSignature">public static&nbsp;int&nbsp;getPixelSize&#8203;(int&nbsp;pixelFormat)</pre>
2189 <div class="block">Returns the pixel size (in samples) for the given pixel format.</div>
2190 <dl>
2191 <dt><span class="paramLabel">Parameters:</span></dt>
2192 <dd><code>pixelFormat</code> - the pixel format (one of <a href="#PF_RGB"><code>PF_*</code></a>)</dd>
2193 <dt><span class="returnLabel">Returns:</span></dt>
2194 <dd>the pixel size (in samples) for the given pixel format.</dd>
2195 </dl>
2196 </li>
2197 </ul>
2198 <a id="getRedOffset(int)">
2199 <!-- -->
2200 </a>
2201 <ul class="blockList">
2202 <li class="blockList">
2203 <h4>getRedOffset</h4>
2204 <pre class="methodSignature">public static&nbsp;int&nbsp;getRedOffset&#8203;(int&nbsp;pixelFormat)</pre>
2205 <div class="block">For the given pixel format, returns the number of samples that the red
2206 component is offset from the start of the pixel. For instance, if an
2207 8-bit-per-sample pixel of format <code>TJ.PF_BGRX</code> is stored in
2208 <code>char pixel[]</code>, then the red component is
2209 <code>pixel[TJ.getRedOffset(TJ.PF_BGRX)]</code>.</div>
2210 <dl>
2211 <dt><span class="paramLabel">Parameters:</span></dt>
2212 <dd><code>pixelFormat</code> - the pixel format (one of <a href="#PF_RGB"><code>PF_*</code></a>)</dd>
2213 <dt><span class="returnLabel">Returns:</span></dt>
2214 <dd>the red offset for the given pixel format, or -1 if the pixel
2215 format does not have a red component.</dd>
2216 </dl>
2217 </li>
2218 </ul>
2219 <a id="getGreenOffset(int)">
2220 <!-- -->
2221 </a>
2222 <ul class="blockList">
2223 <li class="blockList">
2224 <h4>getGreenOffset</h4>
2225 <pre class="methodSignature">public static&nbsp;int&nbsp;getGreenOffset&#8203;(int&nbsp;pixelFormat)</pre>
2226 <div class="block">For the given pixel format, returns the number of samples that the green
2227 component is offset from the start of the pixel. For instance, if an
2228 8-bit-per-sample pixel of format <code>TJ.PF_BGRX</code> is stored in
2229 <code>char pixel[]</code>, then the green component is
2230 <code>pixel[TJ.getGreenOffset(TJ.PF_BGRX)]</code>.</div>
2231 <dl>
2232 <dt><span class="paramLabel">Parameters:</span></dt>
2233 <dd><code>pixelFormat</code> - the pixel format (one of <a href="#PF_RGB"><code>PF_*</code></a>)</dd>
2234 <dt><span class="returnLabel">Returns:</span></dt>
2235 <dd>the green offset for the given pixel format, or -1 if the pixel
2236 format does not have a green component.</dd>
2237 </dl>
2238 </li>
2239 </ul>
2240 <a id="getBlueOffset(int)">
2241 <!-- -->
2242 </a>
2243 <ul class="blockList">
2244 <li class="blockList">
2245 <h4>getBlueOffset</h4>
2246 <pre class="methodSignature">public static&nbsp;int&nbsp;getBlueOffset&#8203;(int&nbsp;pixelFormat)</pre>
2247 <div class="block">For the given pixel format, returns the number of samples that the blue
2248 component is offset from the start of the pixel. For instance, if an
2249 8-bit-per-sample pixel of format <code>TJ.PF_BGRX</code> is stored in
2250 <code>char pixel[]</code>, then the blue component is
2251 <code>pixel[TJ.getBlueOffset(TJ.PF_BGRX)]</code>.</div>
2252 <dl>
2253 <dt><span class="paramLabel">Parameters:</span></dt>
2254 <dd><code>pixelFormat</code> - the pixel format (one of <a href="#PF_RGB"><code>PF_*</code></a>)</dd>
2255 <dt><span class="returnLabel">Returns:</span></dt>
2256 <dd>the blue offset for the given pixel format, or -1 if the pixel
2257 format does not have a blue component.</dd>
2258 </dl>
2259 </li>
2260 </ul>
2261 <a id="getAlphaOffset(int)">
2262 <!-- -->
2263 </a>
2264 <ul class="blockList">
2265 <li class="blockList">
2266 <h4>getAlphaOffset</h4>
2267 <pre class="methodSignature">public static&nbsp;int&nbsp;getAlphaOffset&#8203;(int&nbsp;pixelFormat)</pre>
2268 <div class="block">For the given pixel format, returns the number of samples that the alpha
2269 component is offset from the start of the pixel. For instance, if an
2270 8-bit-per-sample pixel of format <code>TJ.PF_BGRA</code> is stored in
2271 <code>char pixel[]</code>, then the alpha component is
2272 <code>pixel[TJ.getAlphaOffset(TJ.PF_BGRA)]</code>.</div>
2273 <dl>
2274 <dt><span class="paramLabel">Parameters:</span></dt>
2275 <dd><code>pixelFormat</code> - the pixel format (one of <a href="#PF_RGB"><code>PF_*</code></a>)</dd>
2276 <dt><span class="returnLabel">Returns:</span></dt>
2277 <dd>the alpha offset for the given pixel format, or -1 if the pixel
2278 format does not have a alpha component.</dd>
2279 </dl>
2280 </li>
2281 </ul>
2282 <a id="bufSize(int,int,int)">
2283 <!-- -->
2284 </a>
2285 <ul class="blockList">
2286 <li class="blockList">
2287 <h4>bufSize</h4>
2288 <pre class="methodSignature">public static&nbsp;int&nbsp;bufSize&#8203;(int&nbsp;width,
2289 int&nbsp;height,
2290 int&nbsp;jpegSubsamp)</pre>
2291 <div class="block">Returns the maximum size of the buffer (in bytes) required to hold a JPEG
2292 image with the given width, height, and level of chrominance subsampling.</div>
2293 <dl>
2294 <dt><span class="paramLabel">Parameters:</span></dt>
2295 <dd><code>width</code> - the width (in pixels) of the JPEG image</dd>
2296 <dd><code>height</code> - the height (in pixels) of the JPEG image</dd>
2297 <dd><code>jpegSubsamp</code> - the level of chrominance subsampling to be used when
2298 generating the JPEG image (one of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a>.)
2299 <a href="#SAMP_UNKNOWN"><code>SAMP_UNKNOWN</code></a> is treated like <a href="#SAMP_444"><code>SAMP_444</code></a>, since a buffer
2300 large enough to hold a JPEG image with no subsampling should also be large
2301 enough to hold a JPEG image with an arbitrary level of subsampling. Note
2302 that lossless JPEG images always use <a href="#SAMP_444"><code>SAMP_444</code></a>.</dd>
2303 <dt><span class="returnLabel">Returns:</span></dt>
2304 <dd>the maximum size of the buffer (in bytes) required to hold a JPEG
2305 image with the given width, height, and level of chrominance subsampling.</dd>
2306 </dl>
2307 </li>
2308 </ul>
2309 <a id="bufSizeYUV(int,int,int,int)">
2310 <!-- -->
2311 </a>
2312 <ul class="blockList">
2313 <li class="blockList">
2314 <h4>bufSizeYUV</h4>
2315 <pre class="methodSignature">public static&nbsp;int&nbsp;bufSizeYUV&#8203;(int&nbsp;width,
2316 int&nbsp;align,
2317 int&nbsp;height,
2318 int&nbsp;subsamp)</pre>
2319 <div class="block">Returns the size of the buffer (in bytes) required to hold a unified
2320 planar YUV image with the given width, height, and level of chrominance
2321 subsampling.</div>
2322 <dl>
2323 <dt><span class="paramLabel">Parameters:</span></dt>
2324 <dd><code>width</code> - the width (in pixels) of the YUV image</dd>
2325 <dd><code>align</code> - row alignment (in bytes) of the YUV image (must be a power of
2326 2.) Setting this parameter to n specifies that each row in each plane of
2327 the YUV image will be padded to the nearest multiple of n bytes
2328 (1 = unpadded.)</dd>
2329 <dd><code>height</code> - the height (in pixels) of the YUV image</dd>
2330 <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV
2331 image (one of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd>
2332 <dt><span class="returnLabel">Returns:</span></dt>
2333 <dd>the size of the buffer (in bytes) required to hold a unified
2334 planar YUV image with the given width, height, and level of chrominance
2335 subsampling.</dd>
2336 </dl>
2337 </li>
2338 </ul>
2339 <a id="planeSizeYUV(int,int,int,int,int)">
2340 <!-- -->
2341 </a>
2342 <ul class="blockList">
2343 <li class="blockList">
2344 <h4>planeSizeYUV</h4>
2345 <pre class="methodSignature">public static&nbsp;int&nbsp;planeSizeYUV&#8203;(int&nbsp;componentID,
2346 int&nbsp;width,
2347 int&nbsp;stride,
2348 int&nbsp;height,
2349 int&nbsp;subsamp)</pre>
2350 <div class="block">Returns the size of the buffer (in bytes) required to hold a YUV image
2351 plane with the given parameters.</div>
2352 <dl>
2353 <dt><span class="paramLabel">Parameters:</span></dt>
2354 <dd><code>componentID</code> - ID number of the image plane (0 = Y, 1 = U/Cb,
2355 2 = V/Cr)</dd>
2356 <dd><code>width</code> - width (in pixels) of the YUV image. NOTE: This is the width
2357 of the whole image, not the plane width.</dd>
2358 <dd><code>stride</code> - bytes per row in the image plane.</dd>
2359 <dd><code>height</code> - height (in pixels) of the YUV image. NOTE: This is the
2360 height of the whole image, not the plane height.</dd>
2361 <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV
2362 image (one of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd>
2363 <dt><span class="returnLabel">Returns:</span></dt>
2364 <dd>the size of the buffer (in bytes) required to hold a YUV image
2365 plane with the given parameters.</dd>
2366 </dl>
2367 </li>
2368 </ul>
2369 <a id="planeWidth(int,int,int)">
2370 <!-- -->
2371 </a>
2372 <ul class="blockList">
2373 <li class="blockList">
2374 <h4>planeWidth</h4>
2375 <pre class="methodSignature">public static&nbsp;int&nbsp;planeWidth&#8203;(int&nbsp;componentID,
2376 int&nbsp;width,
2377 int&nbsp;subsamp)</pre>
2378 <div class="block">Returns the plane width of a YUV image plane with the given parameters.
2379 Refer to <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> for a description of plane width.</div>
2380 <dl>
2381 <dt><span class="paramLabel">Parameters:</span></dt>
2382 <dd><code>componentID</code> - ID number of the image plane (0 = Y, 1 = U/Cb,
2383 2 = V/Cr)</dd>
2384 <dd><code>width</code> - width (in pixels) of the YUV image</dd>
2385 <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image
2386 (one of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd>
2387 <dt><span class="returnLabel">Returns:</span></dt>
2388 <dd>the plane width of a YUV image plane with the given parameters.</dd>
2389 </dl>
2390 </li>
2391 </ul>
2392 <a id="planeHeight(int,int,int)">
2393 <!-- -->
2394 </a>
2395 <ul class="blockList">
2396 <li class="blockList">
2397 <h4>planeHeight</h4>
2398 <pre class="methodSignature">public static&nbsp;int&nbsp;planeHeight&#8203;(int&nbsp;componentID,
2399 int&nbsp;height,
2400 int&nbsp;subsamp)</pre>
2401 <div class="block">Returns the plane height of a YUV image plane with the given parameters.
2402 Refer to <a href="YUVImage.html" title="class in org.libjpegturbo.turbojpeg"><code>YUVImage</code></a> for a description of plane height.</div>
2403 <dl>
2404 <dt><span class="paramLabel">Parameters:</span></dt>
2405 <dd><code>componentID</code> - ID number of the image plane (0 = Y, 1 = U/Cb,
2406 2 = V/Cr)</dd>
2407 <dd><code>height</code> - height (in pixels) of the YUV image</dd>
2408 <dd><code>subsamp</code> - the level of chrominance subsampling used in the YUV image
2409 (one of <a href="#SAMP_444"><code>TJ.SAMP_*</code></a>)</dd>
2410 <dt><span class="returnLabel">Returns:</span></dt>
2411 <dd>the plane height of a YUV image plane with the given parameters.</dd>
2412 </dl>
2413 </li>
2414 </ul>
2415 <a id="getScalingFactors()">
2416 <!-- -->
2417 </a>
2418 <ul class="blockListLast">
2419 <li class="blockList">
2420 <h4>getScalingFactors</h4>
2421 <pre class="methodSignature">public static&nbsp;<a href="TJScalingFactor.html" title="class in org.libjpegturbo.turbojpeg">TJScalingFactor</a>[]&nbsp;getScalingFactors()</pre>
2422 <div class="block">Returns a list of fractional scaling factors that the JPEG decompressor
2423 supports.</div>
2424 <dl>
2425 <dt><span class="returnLabel">Returns:</span></dt>
2426 <dd>a list of fractional scaling factors that the JPEG decompressor
2427 supports.</dd>
2428 </dl>
2429 </li>
2430 </ul>
2431 </li>
2432 </ul>
2433 </section>
2434 </li>
2435 </ul>
2436 </div>
2437 </div>
2438 </main>
2439 <!-- ========= END OF CLASS DATA ========= -->
2440 <footer role="contentinfo">
2441 <nav role="navigation">
2442 <!-- ======= START OF BOTTOM NAVBAR ====== -->
2443 <div class="bottomNav"><a id="navbar.bottom">
2444 <!-- -->
2445 </a>
2446 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
2447 <a id="navbar.bottom.firstrow">
2448 <!-- -->
2449 </a>
2450 <ul class="navList" title="Navigation">
2451 <li><a href="package-summary.html">Package</a></li>
2452 <li class="navBarCell1Rev">Class</li>
2453 <li><a href="package-tree.html">Tree</a></li>
2454 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
2455 <li><a href="../../../index-all.html">Index</a></li>
2456 <li><a href="../../../help-doc.html">Help</a></li>
2457 </ul>
2458 </div>
2459 <div class="subNav">
2460 <ul class="navList" id="allclasses_navbar_bottom">
2461 <li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
2462 </ul>
2463 <div>
2464 <script type="text/javascript"><!--
2465 allClassesLink = document.getElementById("allclasses_navbar_bottom");
2466 if(window==top) {
2467 allClassesLink.style.display = "block";
2468 }
2469 else {
2470 allClassesLink.style.display = "none";
2471 }
2472 //-->
2473 </script>
2474 <noscript>
2475 <div>JavaScript is disabled on your browser.</div>
2476 </noscript>
2477 </div>
2478 <div>
2479 <ul class="subNavList">
2480 <li>Summary:&nbsp;</li>
2481 <li>Nested&nbsp;|&nbsp;</li>
2482 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
2483 <li>Constr&nbsp;|&nbsp;</li>
2484 <li><a href="#method.summary">Method</a></li>
2485 </ul>
2486 <ul class="subNavList">
2487 <li>Detail:&nbsp;</li>
2488 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
2489 <li>Constr&nbsp;|&nbsp;</li>
2490 <li><a href="#method.detail">Method</a></li>
2491 </ul>
2492 </div>
2493 <a id="skip.navbar.bottom">
2494 <!-- -->
2495 </a></div>
2496 <!-- ======== END OF BOTTOM NAVBAR ======= -->
2497 </nav>
2498 </footer>
2499 </body>
2500 </html>