362 lines
18 KiB
HTML
362 lines
18 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_51) on Wed Apr 06 13:11:03 EDT 2016 -->
|
|
<title>IndexPngWriter (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="IndexPngWriter (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/IndexPngWriter.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/image/ImageQueue.html" title="class in edu.rit.image"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/image/PixelUnit.html" title="enum in edu.rit.image"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/image/IndexPngWriter.html" target="_top">Frames</a></li>
|
|
<li><a href="IndexPngWriter.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">edu.rit.image</div>
|
|
<h2 title="Class IndexPngWriter" class="title">Class IndexPngWriter</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>edu.rit.image.IndexPngWriter</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">IndexPngWriter</span>
|
|
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
|
|
<div class="block">Class IndexPngWriter provides an object for writing an indexed color PNG
|
|
image. To write an image:
|
|
<OL TYPE=1>
|
|
<P><LI>
|
|
Create a palette of colors for the image. The palette is an <a href="../../../edu/rit/util/AList.html" title="class in edu.rit.util">AList</a> of <a href="../../../edu/rit/image/Color.html" title="class in edu.rit.image">Color</a>s; it must contain at
|
|
least 1 and at most 256 elements.
|
|
<P><LI>
|
|
Create an instance of class IndexPngWriter, specifying the image dimensions,
|
|
the output stream to which to write the image, and the palette.
|
|
<P><LI>
|
|
Optionally, call the writer's <a href="../../../edu/rit/image/IndexPngWriter.html#setPixelDimensions(int, int, edu.rit.image.PixelUnit)"><code>setPixelDimensions()</code></a> method to set the pixels' physical size. If not
|
|
specified, the default is 300×300 pixels per inch.
|
|
<P><LI>
|
|
Call the writer's <a href="../../../edu/rit/image/IndexPngWriter.html#getImageQueue()"><code>getImageQueue()</code></a> method to get the
|
|
writer's image queue, which is an instance of class <a href="../../../edu/rit/image/ByteImageQueue.html" title="class in edu.rit.image">ByteImageQueue</a>.
|
|
<P><LI>
|
|
Generate rows of pixel data and put them into the image queue by calling the
|
|
image queue's <a href="../../../edu/rit/image/ByteImageQueue.html#put(int, byte[])"><code>put()</code></a> method. Each row
|
|
of pixel data must be stored in a <TT>byte[]</TT> array whose length is equal
|
|
to the number of columns in the image. Each element of the array specifies
|
|
the palette index of the color for one pixel. You must call the image queue's
|
|
<a href="../../../edu/rit/image/ByteImageQueue.html#put(int, byte[])"><code>put()</code></a> method once for every row of
|
|
pixels in the image. You do not have to put the rows in any particular order.
|
|
<P><LI>
|
|
Call the writer's <a href="../../../edu/rit/image/IndexPngWriter.html#write()"><code>write()</code></a> method to write the pixel data to
|
|
the PNG image.
|
|
</OL>
|
|
<P>
|
|
Steps 5 and 6 can be performed concurrently in separate threads. In Step 5,
|
|
multiple threads can put the pixel data rows into the image queue
|
|
concurrently.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><strong><a href="../../../edu/rit/image/IndexPngWriter.html#IndexPngWriter(int, int, java.io.OutputStream, edu.rit.util.AList)">IndexPngWriter</a></strong>(int rows,
|
|
int cols,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
|
|
<a href="../../../edu/rit/util/AList.html" title="class in edu.rit.util">AList</a><<a href="../../../edu/rit/image/Color.html" title="class in edu.rit.image">Color</a>> palette)</code>
|
|
<div class="block">Construct a new indexed color PNG writer.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/image/ByteImageQueue.html" title="class in edu.rit.image">ByteImageQueue</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/image/IndexPngWriter.html#getImageQueue()">getImageQueue</a></strong>()</code>
|
|
<div class="block">Returns this indexed color PNG writer's image queue.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/image/IndexPngWriter.html#setPixelDimensions(int, int, edu.rit.image.PixelUnit)">setPixelDimensions</a></strong>(int xPpu,
|
|
int yPpu,
|
|
<a href="../../../edu/rit/image/PixelUnit.html" title="enum in edu.rit.image">PixelUnit</a> unit)</code>
|
|
<div class="block">Set this indexed color PNG writer's physical pixel dimensions to the
|
|
given values.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/image/IndexPngWriter.html#write()">write</a></strong>()</code>
|
|
<div class="block">Write this indexed color PNG writer's image to the underlying output
|
|
stream.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="IndexPngWriter(int, int, java.io.OutputStream, edu.rit.util.AList)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>IndexPngWriter</h4>
|
|
<pre>public IndexPngWriter(int rows,
|
|
int cols,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out,
|
|
<a href="../../../edu/rit/util/AList.html" title="class in edu.rit.util">AList</a><<a href="../../../edu/rit/image/Color.html" title="class in edu.rit.image">Color</a>> palette)</pre>
|
|
<div class="block">Construct a new indexed color PNG writer. The PNG image consists of the
|
|
given number of rows and columns. The PNG image will be written to the
|
|
given output stream. The PNG image will use the given palette.
|
|
<P>
|
|
The palette is an <a href="../../../edu/rit/util/AList.html" title="class in edu.rit.util">AList</a> of <a href="../../../edu/rit/image/Color.html" title="class in edu.rit.image">Color</a>s; it must contain at least 1 and at most 256 elements.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rows</code> - Number of rows. Must be ≥ 1.</dd><dd><code>cols</code> - Number of columns. Must be ≥ 1.</dd><dd><code>out</code> - Output stream.</dd><dd><code>palette</code> - Palette.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>out</TT> is null or
|
|
<TT>palette</TT> is null.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>rows</TT> < 1 or <TT>cols</TT>
|
|
< 1. Thrown if the number of elements in <TT>palette</TT> is
|
|
illegal.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="setPixelDimensions(int, int, edu.rit.image.PixelUnit)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPixelDimensions</h4>
|
|
<pre>public void setPixelDimensions(int xPpu,
|
|
int yPpu,
|
|
<a href="../../../edu/rit/image/PixelUnit.html" title="enum in edu.rit.image">PixelUnit</a> unit)</pre>
|
|
<div class="block">Set this indexed color PNG writer's physical pixel dimensions to the
|
|
given values. If not specified, the default is 300×300 pixels per
|
|
inch.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>xPpu</code> - Pixels per unit, X axis.</dd><dd><code>yPpu</code> - Pixels per unit, Y axis.</dd><dd><code>unit</code> - Pixel dimension units.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getImageQueue()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getImageQueue</h4>
|
|
<pre>public <a href="../../../edu/rit/image/ByteImageQueue.html" title="class in edu.rit.image">ByteImageQueue</a> getImageQueue()</pre>
|
|
<div class="block">Returns this indexed color PNG writer's image queue.</div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>Image queue.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="write()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>write</h4>
|
|
<pre>public void write()
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
|
|
<div class="block">Write this indexed color PNG writer's image to the underlying output
|
|
stream. The pixel data is obtained from the image queue. The underlying
|
|
output stream is closed once the image is written.</div>
|
|
<dl><dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown if an I/O error occurred.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code> - Thrown if the calling thread is interrupted while blocked in this
|
|
method.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/IndexPngWriter.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/image/ImageQueue.html" title="class in edu.rit.image"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/image/PixelUnit.html" title="enum in edu.rit.image"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/image/IndexPngWriter.html" target="_top">Frames</a></li>
|
|
<li><a href="IndexPngWriter.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_summary">Constr</a> | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor_detail">Constr</a> | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small><FONT SIZE="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|