changeset 1331:bc5b8880d1db

Fix RT-22129: PixelReader/Writer javadoc refer to nonexistant pixel format.
author flar <James.Graham@oracle.com>
date Mon, 18 Jun 2012 13:57:08 -0700
parents c9fe13cb7935
children af08c7baa21a
files javafx-ui-common/src/javafx/scene/image/PixelFormat.java javafx-ui-common/src/javafx/scene/image/PixelReader.java javafx-ui-common/src/javafx/scene/image/PixelWriter.java
diffstat 3 files changed, 7 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/javafx-ui-common/src/javafx/scene/image/PixelFormat.java	Mon Jun 18 16:15:16 2012 +0200
+++ b/javafx-ui-common/src/javafx/scene/image/PixelFormat.java	Mon Jun 18 13:57:08 2012 -0700
@@ -63,7 +63,7 @@
         /**
          * The opaque pixels are stored in adjacent bytes with the color
          * components stored in order of increasing index:
-         * red, gree, blue.
+         * red, green, blue.
          */
         BYTE_RGB,
         /**
--- a/javafx-ui-common/src/javafx/scene/image/PixelReader.java	Mon Jun 18 16:15:16 2012 +0200
+++ b/javafx-ui-common/src/javafx/scene/image/PixelReader.java	Mon Jun 18 13:57:08 2012 -0700
@@ -54,8 +54,9 @@
      * 
      * @param x the X coordinate of the pixel color to read
      * @param y the Y coordinate of the pixel color to read
-     * @return a 32-bit representation of the color in a format described
-     *         by the {@link PixelFormat.Type.BYTE_ARGB} PixelFormat type.
+     * @return a 32-bit representation of the color in the format
+     *         described by the {@link PixelFormat.Type#INT_ARGB INT_ARGB}
+     *         PixelFormat type.
      */
     public int getArgb(int x, int y);
 
--- a/javafx-ui-common/src/javafx/scene/image/PixelWriter.java	Mon Jun 18 16:15:16 2012 +0200
+++ b/javafx-ui-common/src/javafx/scene/image/PixelWriter.java	Mon Jun 18 13:57:08 2012 -0700
@@ -48,14 +48,14 @@
     /**
      * Stores pixel data for a color into the specified coordinates of the
      * surface.
-     * The 32-bit integer {@code argb} parameter will contain the 4 color
+     * The 32-bit integer {@code argb} parameter should contain the 4 color
      * components in separate 8-bit fields in ARGB order from the most
      * significant byte to the least significant byte.
      * 
      * @param x the X coordinate of the pixel color to write
      * @param y the Y coordinate of the pixel color to write
-     * @param argb the color information to write, specified in a format
-     *         described by the {@link PixelFormat.Type.BYTE_ARGB}
+     * @param argb the color information to write, specified in the format
+     *         described by the {@link PixelFormat.Type#INT_ARGB INT_ARGB}
      *         PixelFormat type.
      */
     public void setArgb(int x, int y, int argb);