Changeset 9139

Timestamp:

07/01/08 20:47:55 (5 months ago)

Author:

zumbrunn

Message:

added docs for getPixel, resizeFast and setTransparentPixel methods and added docs for dither and alphaToBitmask parameters to the reduceColors method

Files:

• apps/reference/trunk/coreExtensions/Image.js (modified) (4 diffs)

apps/reference/trunk/coreExtensions/Image.js

@@ -249 +249 @@
-
-/**
+ * Returns information about the pixel at x, y. 
+ * <br /><br />
+ * If the image is indexed, it returns the palette index, otherwise 
+ * the rgb code of the color is returned.
+ * 
+ * @param {Number} x the x coordinate of the pixel
+ * @param {Number} y the y coordinate of the pixel
+ * @return the pixel at x, y
+ */
+Image.prototype.getPixel(x,y) {};
+
+
+/**
- * Retrieves a Java-compatible image object from a Helma image object.
- * <br /><br />
@@ -334 +347 @@
- * 
- * @param {Number} colorDepth as Number, value of color depth in an image.
-
-
+
+
+
+
-
-
@@ -362 +377 @@
- * <img src="http://helma.org/static/images/helma/hawatosch.jpg" />
- * 
-
-
+
+
+
- */
-Image.prototype.resize = function(width, heigth) {};
+
+
+/**
+ * Resizes the image, using a fast and cheap algorithm.
+ * 
+ * @param {Number} width as Number, new width of the image.
+ * @param {Number} height as Number, new height of the image.
+ * @see Image.resize
+ */
+Image.prototype.resizeFast = function(width, heigth) {};
-
-
@@ -433 +459 @@
- */
-Image.prototype.setFont = function(name, style, size) {};
+
+
+/**
+ * Sets the palette index of the transparent color for Images with an IndexColorModel.
+ * 
+ * This can be used together with an Image's getPixel method.
+ * 
+ * @param {Number} index as Number, the index position specifying the transparent color.
+ * @see Image.getPixel
+ */
+Image.prototype.setTransparentPixel = function(index) {};