Java doc: Terminology tweaks
- "function" = "method" - "decompression and transform functions" = "decompression and transform operations" (for consistency with the 2.1.x documentation) - "return an error" = "throw an error" - "ceil()" = "Math.ceil()"
This commit is contained in:
@@ -1567,7 +1567,7 @@ extends java.lang.Object</pre>
|
||||
transformation]
|
||||
|
||||
<p>Setting this parameter will cause the decompression and transform
|
||||
functions to return an error if the number of scans in a progressive JPEG
|
||||
operations to throw an error if the number of scans in a progressive JPEG
|
||||
image exceeds the specified limit. The primary purpose of this is to
|
||||
allow security-critical applications to guard against an exploit of the
|
||||
progressive JPEG format described in
|
||||
@@ -1576,7 +1576,7 @@ extends java.lang.Object</pre>
|
||||
<p><b>Value</b>
|
||||
<ul>
|
||||
<li> maximum number of progressive JPEG scans that the decompression and
|
||||
transform functions will process <i>[default: <code>0</code> (no
|
||||
transform operations will process <i>[default: <code>0</code> (no
|
||||
limit)]</i>
|
||||
</ul></div>
|
||||
<dl>
|
||||
|
||||
@@ -153,7 +153,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
||||
int transformID,
|
||||
<a href="TJTransform.html" title="class in org.libjpegturbo.turbojpeg">TJTransform</a> transform)</code></th>
|
||||
<td class="colLast">
|
||||
<div class="block">A callback function that can be used to modify the DCT coefficients after
|
||||
<div class="block">A callback method that can be used to modify the DCT coefficients after
|
||||
they are losslessly transformed but before they are transcoded to a new
|
||||
JPEG image.</div>
|
||||
</td>
|
||||
@@ -188,7 +188,7 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
||||
int transformID,
|
||||
<a href="TJTransform.html" title="class in org.libjpegturbo.turbojpeg">TJTransform</a> transform)
|
||||
throws <a href="TJException.html" title="class in org.libjpegturbo.turbojpeg">TJException</a></pre>
|
||||
<div class="block">A callback function that can be used to modify the DCT coefficients after
|
||||
<div class="block">A callback method that can be used to modify the DCT coefficients after
|
||||
they are losslessly transformed but before they are transcoded to a new
|
||||
JPEG image. This allows for custom filters or other transformations to be
|
||||
applied in the frequency domain.</div>
|
||||
@@ -197,12 +197,12 @@ $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
|
||||
<dd><code>coeffBuffer</code> - a buffer containing transformed DCT coefficients.
|
||||
(NOTE: this buffer is not guaranteed to be valid once the callback
|
||||
returns, so applications wishing to hand off the DCT coefficients to
|
||||
another function or library should make a copy of them within the body of
|
||||
the callback.)</dd>
|
||||
another method should make a copy of them within the body of the
|
||||
callback.)</dd>
|
||||
<dd><code>bufferRegion</code> - rectangle containing the width and height of
|
||||
<code>coeffBuffer</code> as well as its offset relative to the component
|
||||
plane. TurboJPEG implementations may choose to split each component plane
|
||||
into multiple DCT coefficient buffers and call the callback function once
|
||||
into multiple DCT coefficient buffers and call the callback method once
|
||||
for each buffer.</dd>
|
||||
<dd><code>planeRegion</code> - rectangle containing the width and height of the
|
||||
component plane to which <code>coeffBuffer</code> belongs</dd>
|
||||
|
||||
@@ -299,9 +299,9 @@ extends java.lang.Object</pre>
|
||||
<li class="blockList">
|
||||
<h4>getScaled</h4>
|
||||
<pre class="methodSignature">public int getScaled​(int dimension)</pre>
|
||||
<div class="block">Returns the scaled value of <code>dimension</code>. This function
|
||||
performs the integer equivalent of
|
||||
<code>ceil(dimension * scalingFactor)</code>.</div>
|
||||
<div class="block">Returns the scaled value of <code>dimension</code>. This method performs
|
||||
the integer equivalent of
|
||||
<code>Math.ceil(dimension * scalingFactor)</code>.</div>
|
||||
<dl>
|
||||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||||
<dd><code>dimension</code> - width or height to multiply by this scaling factor</dd>
|
||||
|
||||
Reference in New Issue
Block a user