javaquery/canvas/src/main/java/net/java/html/canvas/ImageData.java
branchcanvas
changeset 1445 493cae4fd458
parent 1440 c943709738df
     1.1 --- a/javaquery/canvas/src/main/java/net/java/html/canvas/ImageData.java	Tue Feb 11 13:35:35 2014 +0100
     1.2 +++ b/javaquery/canvas/src/main/java/net/java/html/canvas/ImageData.java	Wed Feb 12 08:43:07 2014 +0100
     1.3 @@ -1,19 +1,19 @@
     1.4  /**
     1.5 - * Back 2 Browser Bytecode Translator
     1.6 - * Copyright (C) 2012 Jaroslav Tulach <jaroslav.tulach@apidesign.org>
     1.7 + * Back 2 Browser Bytecode Translator Copyright (C) 2012 Jaroslav Tulach
     1.8 + * <jaroslav.tulach@apidesign.org>
     1.9   *
    1.10 - * This program is free software: you can redistribute it and/or modify
    1.11 - * it under the terms of the GNU General Public License as published by
    1.12 - * the Free Software Foundation, version 2 of the License.
    1.13 + * This program is free software: you can redistribute it and/or modify it under
    1.14 + * the terms of the GNU General Public License as published by the Free Software
    1.15 + * Foundation, version 2 of the License.
    1.16   *
    1.17 - * This program is distributed in the hope that it will be useful,
    1.18 - * but WITHOUT ANY WARRANTY; without even the implied warranty of
    1.19 - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    1.20 - * GNU General Public License for more details.
    1.21 + * This program is distributed in the hope that it will be useful, but WITHOUT
    1.22 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    1.23 + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
    1.24 + * details.
    1.25   *
    1.26 - * You should have received a copy of the GNU General Public License
    1.27 - * along with this program. Look for COPYING file in the top folder.
    1.28 - * If not, see http://opensource.org/licenses/GPL-2.0.
    1.29 + * You should have received a copy of the GNU General Public License along with
    1.30 + * this program. Look for COPYING file in the top folder. If not, see
    1.31 + * http://opensource.org/licenses/GPL-2.0.
    1.32   */
    1.33  package net.java.html.canvas;
    1.34  
    1.35 @@ -26,23 +26,89 @@
    1.36   */
    1.37  public interface ImageData {
    1.38  
    1.39 +    /**
    1.40 +     * get the height.
    1.41 +     *
    1.42 +     * @return the height
    1.43 +     */
    1.44      public double getHeight();
    1.45  
    1.46 +    /**
    1.47 +     * get the width
    1.48 +     *
    1.49 +     * @return the width
    1.50 +     */
    1.51      public double getWidth();
    1.52  
    1.53 +    /**
    1.54 +     * get the red value at a specified coordinate
    1.55 +     *
    1.56 +     * @param x
    1.57 +     * @param y
    1.58 +     * @return the red value as an int (0 -255)
    1.59 +     */
    1.60      public int getR(int x, int y);
    1.61  
    1.62 +    /**
    1.63 +     * get the green value at a specified coordinate
    1.64 +     *
    1.65 +     * @param x
    1.66 +     * @param y
    1.67 +     * @return the green value as an int (0 -255)
    1.68 +     */
    1.69      public int getG(int x, int y);
    1.70  
    1.71 +    /**
    1.72 +     * get the blue value at a specified coordinate
    1.73 +     *
    1.74 +     * @param x
    1.75 +     * @param y
    1.76 +     * @return the blue value as an int (0 -255)
    1.77 +     */
    1.78      public int getB(int x, int y);
    1.79  
    1.80 +    /**
    1.81 +     * get the alpha (transparency) value at a specified coordinate
    1.82 +     *
    1.83 +     * @param x
    1.84 +     * @param y
    1.85 +     * @return the alpha value as an int (0 - 255)
    1.86 +     */
    1.87      public int getA(int x, int y);
    1.88  
    1.89 +     /**
    1.90 +     * set the red value at a specified coordinate
    1.91 +     *
    1.92 +     * @param x
    1.93 +     * @param y
    1.94 +     * @param value the red value as an int (0 - 255)
    1.95 +     */
    1.96      public void setR(int x, int y, int value);
    1.97  
    1.98 +     /**
    1.99 +     * set the green value at a specified coordinate
   1.100 +     *
   1.101 +     * @param x
   1.102 +     * @param y
   1.103 +     * @param value the green value as an int (0 - 255)
   1.104 +     */
   1.105      public void setG(int x, int y, int value);
   1.106  
   1.107 +     /**
   1.108 +     * set the blue value at a specified coordinate
   1.109 +     *
   1.110 +     * @param x
   1.111 +     * @param y
   1.112 +     * @param value the blue value as an int (0 - 255)
   1.113 +     */
   1.114      public void setB(int x, int y, int value);
   1.115  
   1.116 +    /**
   1.117 +     * set the alpha (transparency) value at a specified coordinate
   1.118 +     *
   1.119 +     * @param x
   1.120 +     * @param y
   1.121 +     * @param value the alpha value as an int (0 - 255)
   1.122 +     */
   1.123      public void setA(int x, int y, int value);
   1.124  }