Proposed canvas and WebGL cleanup

client/html/generated/src/interface/CanvasRenderingContext2D.dart

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 // WARNING: Do not edit - generated code.
 
 interface CanvasRenderingContext2D extends CanvasRenderingContext {
 
   String get font();
 
@@ skipping 56 matching lines @@
   void bezierCurveTo(num cp1x, num cp1y, num cp2x, num cp2y, num x, num y);
 
   void clearRect(num x, num y, num width, num height);
 
   void clearShadow();
 
   void clip();
 
   void closePath();
 
-  ImageData createImageData(var imagedata_OR_sw, [num sh]);
+  // TODO(jacobr): it looks like createImageData(someImageData)
+  // was only supported by WebKit so it makes sense to remove it and clean up
+  // the API at the same time.
+  ImageData createImageData(num sw, num sh);

[arv (Not doing code reviews), 2011/11/07 23:27:56]

new ImageData(num sw, num sh)
new ImageData.from(ImageData other)

[mattsh, 2011/11/17 01:23:40]

can we give more informative parameter names, e.g. sourceWidth, sourceHeight?

 
   CanvasGradient createLinearGradient(num x0, num y0, num x1, num y1);
 
   CanvasPattern createPattern(var canvas_OR_image, String repetitionType);

[Jacob, 2011/11/04 22:26:13]

TODO(jacobr): cleanup this name as well

 
   CanvasGradient createRadialGradient(num x0, num y0, num r0, num x1, num y1, num r1);
 
-  void drawImage(var canvas_OR_image, num sx_OR_x, num sy_OR_y, [num sw_OR_width, num height_OR_sh, num dx, num dy, num dw, num dh]);

[Jacob, 2011/11/04 19:07:05]

split drawImage into two methods so that the arguments are comprehensible.
TODO(jacobr): add a comment specifying what types are allowed for [image]

+  // TODO(jacobr): use a rectangle class?
+  void drawImage(var image, num dx, num dy, [num dw, num dh]);

[vsm, 2011/11/04 21:26:35]

A Drawable interface to type image?

[Jacob, 2011/11/04 22:26:13]

I agree.

[mattsh, 2011/11/17 01:23:40]

Can we use a Rect type here?
Can we make the first argument be Element rather than var?

[Jacob, 2011/11/17 01:34:43]

I think that makes it more confusing as only a couple specific Element subtypes
are allowed

 
-  void drawImageFromRect(ImageElement image, [num sx, num sy, num sw, num sh, num dx, num dy, num dw, num dh, String compositeOperation]);

[Jacob, 2011/11/04 19:07:05]

removed drawImageFromRect as it appears to be non-standard with functionality
easily enough reproduced by calling
setCompositeOperation and drawImageClipped.

+  void drawImageClipped(var image, num sx, num sy, num sw, num sh,

[mattsh, 2011/11/17 01:23:40]

I think this should take two Rect parameters (called sourceRect and destRect)
rather than all these parameters.

[Jacob, 2011/11/17 01:34:43]

in general i'd agree.  ideally we'd like to support both versions though as this
one will have a little better performance due to fewer object creations
got any idea for appropriate method names  for the versions that require Rect as
args.  *sigh* i wish dart would just support multiple method definitions with
different #s of args.

+      num dx, num dy, num dw, num dh);
 
   void fill();
 
   void fillRect(num x, num y, num width, num height);

[mattsh, 2011/11/17 01:23:40]

use Rect here

 
   void fillText(String text, num x, num y, [num maxWidth]);
 
   ImageData getImageData(num sx, num sy, num sw, num sh);

[mattsh, 2011/11/17 01:23:40]

use Rect here

 
   bool isPointInPath(num x, num y);
 
   void lineTo(num x, num y);
 
   TextMetrics measureText(String text);
 
   void moveTo(num x, num y);
 
   void putImageData(ImageData imagedata, num dx, num dy, [num dirtyX, num dirtyY, num dirtyWidth, num dirtyHeight]);
 
   void quadraticCurveTo(num cpx, num cpy, num x, num y);
 
   void rect(num x, num y, num width, num height);
 
   void restore();
 
   void rotate(num angle);
 
   void save();
 
   void scale(num sx, num sy);
 
   void setAlpha(num alpha);
 
   void setCompositeOperation(String compositeOperation);
 
-  void setFillColor(var c_OR_color_OR_grayLevel_OR_r, [num alpha_OR_g_OR_m, num b_OR_y, num a_OR_k, num a]);

[nweiz, 2011/11/04 21:09:06]

What are this and the other two below being replaced by?

[Jacob, 2011/11/04 22:26:13]

I believe these are WebKit specific methods that never made it into the w3c
spec.  As they are ugly to express in dart I see little value in keeping them.
The 3 removed methods are replaced by
They are replaced by "set shadow\w+" setters. setFileStyle, and setStrokeStyle

[arv (Not doing code reviews), 2011/11/07 23:27:56]

only rgba

-
   void setFillStyle(var color_OR_gradient_OR_pattern);
 
   void setLineCap(String cap);
 
   void setLineJoin(String join);
 
   void setLineWidth(num width);
 
   void setMiterLimit(num limit);
 
-  void setShadow(num width, num height, num blur, [var c_OR_color_OR_grayLevel_OR_r, num alpha_OR_g_OR_m, num b_OR_y, num a_OR_k, num a]);

[arv (Not doing code reviews), 2011/11/07 23:27:56]

seems useful. rgba only though

defaults to rgba(0, 0, 0, 1)

-
-  void setStrokeColor(var c_OR_color_OR_grayLevel_OR_r, [num alpha_OR_g_OR_m, num b_OR_y, num a_OR_k, num a]);

[arv (Not doing code reviews), 2011/11/07 23:27:56]

same

-
   void setStrokeStyle(var color_OR_gradient_OR_pattern);

[Jacob, 2011/11/04 22:26:13]

i'd like to cleanup this one as well.  clearly it doesn't make sense to define a
or type for
{String, Gradient, or Pattern}

 
   void setTransform(num m11, num m12, num m21, num m22, num dx, num dy);
 
   void stroke();
 
   void strokeRect(num x, num y, num width, num height, [num lineWidth]);
 
   void strokeText(String text, num x, num y, [num maxWidth]);
 
   void transform(num m11, num m12, num m21, num m22, num dx, num dy);
 
   void translate(num tx, num ty);
 }