This is the mail archive of the
java-patches@gcc.gnu.org
mailing list for the Java project.
[gui] Add IndexColorModel docs
- From: Jerry Quinn <jlquinn at optonline dot net>
- To: java-patches at gcc dot gnu dot org
- Date: Mon, 27 Sep 2004 21:18:08 -0400
- Subject: [gui] Add IndexColorModel docs
2004-09-27 Jerry Quinn <jlquinn@optonline.net>
* java/awt/image/IndexColorModel.java: Add class docs.
Index: IndexColorModel.java
===================================================================
RCS file: /cvs/gcc/gcc/libjava/java/awt/image/IndexColorModel.java,v
retrieving revision 1.6.14.1
retrieving revision 1.6.14.2
diff -u -r1.6.14.1 -r1.6.14.2
--- IndexColorModel.java 26 Sep 2004 18:25:41 -0000 1.6.14.1
+++ IndexColorModel.java 28 Sep 2004 01:13:13 -0000 1.6.14.2
@@ -39,8 +39,28 @@
package java.awt.image;
import java.awt.color.ColorSpace;
import java.math.BigInteger;
/**
+ * Color model similar to pseudo visual in X11.
+ *
+ * This color model maps linear pixel values to actual RGB and alpha
colors.
+ * Thus, pixel values are indexes into the color map. Each color
component is
+ * an 8-bit unsigned value.
+ *
+ * The IndexColorModel supports a map of valid pixels, allowing the
+ * representation of holes in the the color map. The valid map is
represented
+ * as a BigInteger where each bit indicates the validity of the map
entry with
+ * the same index.
+ *
+ * Colors can have alpha components for transparency support. If alpha
+ * component values aren't given, color values are opaque. The model also
+ * supports a reserved pixel value to represent completely transparent
colors,
+ * no matter what the actual color component values are.
+ *
+ * IndexColorModel supports anywhere from 1 to 16 bit index values. The
+ * allowed transfer types are DataBuffer.TYPE_BYTE and
DataBuffer.TYPE_USHORT.
+ *
* @author C. Brian Jones (cbj@gnu.org)
*/
public class IndexColorModel extends ColorModel