1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
use webcore::value::{Reference, ConversionError};
use webcore::try_from::{TryFrom, TryInto};
use webcore::value::{Undefined, Value};
use webapi::html_elements::{CanvasElement, ImageElement};
use webapi::html_element::IHtmlElement;
use webapi::dom_exception::{SyntaxError, IndexSizeError, InvalidStateError, TypeError, SecurityError, NotSupportedError};
/// Trait implemented by rendering contexts which can be obtained from a canvas.
pub trait RenderingContext {
/// Type of error which can occur whilst creating this context
type Error;
/// Name which identifies this kind of rendering context.
fn from_canvas(canvas: &CanvasElement) -> Result<Self, Self::Error> where Self: Sized;
}
/// Used for drawing rectangles, text, images and other objects onto the canvas element.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D)
// https://html.spec.whatwg.org/#canvasrenderingcontext2d
#[derive(Clone, Debug, PartialEq, Eq, ReferenceType)]
#[reference(instance_of = "CanvasRenderingContext2D")]
pub struct CanvasRenderingContext2d(Reference);
/// The CanvasGradient struct represents an opaque object describing a gradient.
/// It is returned by the methods CanvasRenderingContext2D.createLinearGradient() or
/// CanvasRenderingContext2D.createRadialGradient().
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasGradient)
// https://html.spec.whatwg.org/#canvasgradient
#[derive(Clone, Debug, Eq, PartialEq, ReferenceType)]
#[reference(instance_of = "CanvasGradient")]
pub struct CanvasGradient(Reference);
/// The CanvasPattern struct represents an opaque object describing a pattern, based on an image,
/// a canvas or a video, created by the CanvasRenderingContext2D.createPattern() method.
/// Intentionally blank, no non-experimental properties or methods.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasPattern)
// https://html.spec.whatwg.org/#canvaspattern
#[derive(Clone, Debug, Eq, PartialEq, ReferenceType)]
#[reference(instance_of = "CanvasPattern")]
pub struct CanvasPattern(Reference);
/// The ImageData struct represents the underlying pixel data of an area of a <canvas> element.
/// It is created using the ImageData() constructor or creator methods on the CanvasRenderingContext2D
/// object associated with a canvas: createImageData() and getImageData(). It can also be used to set
/// a part of the canvas by using putImageData().
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/ImageData)
// https://html.spec.whatwg.org/#imagedata
#[derive(Clone, Debug, ReferenceType)]
#[reference(instance_of = "ImageData")]
pub struct ImageData(Reference);
/// The TextMetrics struct represents the dimension of a text in the canvas, as created by the CanvasRenderingContext2D.measureText() method.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/TextMetrics)
// https://html.spec.whatwg.org/#textmetrics
#[derive(Clone, Debug, ReferenceType)]
#[reference(instance_of = "TextMetrics")]
pub struct TextMetrics(Reference);
/// The type of compositing operation to apply when drawing new shapes, where type is a string
/// identifying which of the twelve compositing operations to use.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum CompositeOperation {
SourceOver,
SourceIn,
SourceOut,
SourceAtop,
DestinationOver,
DestinationIn,
DestinationAtop,
Lighter,
Copy,
Xor,
Multiply,
Screen,
Overlay,
Darken,
Lighten,
ColorDodge,
ColorBurn,
HardLight,
SoftLight,
Difference,
Exclusion,
Hue,
Saturation,
Color,
Luminosity
}
/// The algorithm by which to determine if a point is inside a path or outside a path.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fill)
// https://html.spec.whatwg.org/#canvasfillrule
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum FillRule {
NonZero,
EvenOdd
}
/// Certain style functions can return multiple types
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CanvasStyle {
/// String representing the style
String(String),
/// CanvasGradient representing the style
CanvasGradient(CanvasGradient),
/// CanvasPattern representing the style
CanvasPattern(CanvasPattern),
}
/// How the end points of every line are drawn.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap)
// https://html.spec.whatwg.org/#canvaslinecap
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum LineCap {
Butt,
Round,
Square
}
/// determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are
/// joined together (degenerate segments with zero lengths, whose specified endpoints and control points are
/// exactly at the same position, are skipped).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin)
// https://html.spec.whatwg.org/#canvaslinejoin
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum LineJoin {
Bevel,
Round,
Miter
}
/// An enum indicating how to repeat the image.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createPattern)
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum Repetition {
Repeat,
RepeatX,
RepeatY,
NoRepeat
}
/// Specifies text alignment
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign)
// https://html.spec.whatwg.org/#canvastextalign
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum TextAlign {
Left,
Right,
Center,
Start,
End
}
/// Text baseline being used when drawing text
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline)
// https://html.spec.whatwg.org/#canvastextbaseline
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum TextBaseline {
Top,
Hanging,
Middle,
Alphabetic,
Ideographic,
Bottom
}
error_enum_boilerplate! {
AddColorStopError,
SyntaxError, IndexSizeError
}
error_enum_boilerplate! {
DrawImageError,
IndexSizeError, InvalidStateError, NotSupportedError, TypeError
}
error_enum_boilerplate! {
GetImageDataError,
IndexSizeError, SecurityError
}
impl TryFrom<Value> for CanvasStyle {
type Error = ConversionError;
/// Performs the conversion.
fn try_from(value: Value) -> Result<Self, Self::Error> {
if let Ok(v) = String::try_from(value.clone()) {
return Ok(CanvasStyle::String(v));
}
if let Ok(v) = CanvasGradient::try_from(value.clone()) {
return Ok(CanvasStyle::CanvasGradient(v));
}
if let Ok(v) = CanvasPattern::try_from(value.clone()) {
return Ok(CanvasStyle::CanvasPattern(v));
}
Err(::webcore::value::ConversionError::type_mismatch( &value ))
}
}
impl Default for FillRule {
fn default() -> FillRule { FillRule::NonZero }
}
impl Default for Repetition {
fn default() -> Repetition { Repetition::Repeat }
}
impl RenderingContext for CanvasRenderingContext2d {
type Error = ConversionError;
fn from_canvas(canvas: &CanvasElement) -> Result<Self, ConversionError> {
js!(
return @{canvas}.getContext("2d");
).try_into()
}
}
impl CanvasGradient {
/// Adds a new stop, defined by an offset and a color, to the gradient. If the offset is
/// not between 0 and 1, an INDEX_SIZE_ERR is returned, if the color can't be parsed as a
/// CSS <color>, a SYNTAX_ERR is returned.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasGradient/addColorStop)
// https://html.spec.whatwg.org/#2dcontext:dom-canvasgradient-addcolorstop
pub fn add_color_stop(&self, offset: f64, color: &str) -> Result<(), AddColorStopError> {
js_try! ( @(no_return)
@{&self.0}.addColorStop(@{offset}, @{color});
).unwrap()
}
}
impl ImageData {
/*
/// Returns a Uint8ClampedArray representing a one-dimensional array containing the data in the RGBA order,
/// with integer values between 0 and 255 (included).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/ImageData/data)
// https://html.spec.whatwg.org/#2dcontext:dom-imagedata-data
// TODO: Return Uint8ClampedArray reference PR 96: https://github.com/koute/stdweb/pull/96
pub fn get_data(&self) -> TypedArray<u8> {
js! (
return @{&self.0}.data;
).try_into().unwrap()
}*/
/// Returns the number of rows in the image data object.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/ImageData/height)
// https://html.spec.whatwg.org/#2dcontext:dom-imagedata-height
pub fn get_height(&self) -> u32 {
js! (
return @{&self.0}.height;
).try_into().unwrap()
}
/// Returns the number of pixels per row in the image data object.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/ImageData/width)
// https://html.spec.whatwg.org/#2dcontext:dom-imagedata-width
pub fn get_width(&self) -> u32 {
js! (
return @{&self.0}.width;
).try_into().unwrap()
}
}
impl CanvasRenderingContext2d {
/// The CanvasRenderingContext2D.canvas property is a read-only reference to the HTMLCanvasElement
/// object that is associated with the context. It might be null if there is no association with an <canvas> element.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/canvas)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-canvas
pub fn get_canvas(&self) -> CanvasElement {
js! (
@{&self.0}.canvas;
).try_into().unwrap()
}
/// The CanvasRenderingContext2D.fillStyle property of the Canvas 2D API specifies the color or style to use inside shapes.
/// The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-fillstyle
pub fn get_fill_style(&self) -> CanvasStyle {
js! (
return @{&self.0}.fillStyle
).try_into().unwrap()
}
/// The CanvasRenderingContext2D.fillStyle property of the Canvas 2D API specifies the color or style to use inside shapes.
/// The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-fillstyle
pub fn set_fill_style_color(&self, color: &str){
js! { @(no_return)
@{&self.0}.fillStyle = @{color};
}
}
/// The CanvasRenderingContext2D.fillStyle property of the Canvas 2D API specifies the color or style to use inside shapes.
/// The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle)
// https://html.spec.whatwg.org/#dom-context-2d-fillstyle
pub fn set_fill_style_gradient(&self, gradient: &CanvasGradient){
js! { @(no_return)
@{&self.0}.fillStyle = @{gradient};
}
}
/// The CanvasRenderingContext2D.fillStyle property of the Canvas 2D API specifies the color or style to use inside shapes.
/// The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillStyle)
// https://html.spec.whatwg.org/#dom-context-2d-fillstyle
pub fn set_fill_style_pattern(&self, pattern: &CanvasPattern){
js! { @(no_return)
@{&self.0}.fillStyle = @{pattern};
}
}
/// The CanvasRenderingContext2D.font property of the Canvas 2D API specifies the current
/// text style being used when drawing text. This string uses the same syntax as the CSS
/// font specifier. The default font is 10px sans-serif.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/font)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-font
pub fn get_font(&self) -> String {
js! (
return @{&self.0}.font
).try_into().unwrap()
}
/// The CanvasRenderingContext2D.font property of the Canvas 2D API specifies the current
/// text style being used when drawing text. This string uses the same syntax as the CSS
/// font specifier. The default font is 10px sans-serif.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/font)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-font
pub fn set_font(&self, font: &str) {
js! { @(no_return)
@{&self.0}.font = @{font};
}
}
/// The CanvasRenderingContext2D.globalAlpha property of the Canvas 2D API specifies the alpha
/// value that is applied to shapes and images before they are drawn onto the canvas.
/// The value is in the range from 0.0 (fully transparent) to 1.0 (fully opaque).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalAlpha)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-globalalpha
pub fn get_global_alpha(&self) -> f64 {
js! (
return @{&self.0}.globalAlpha
).try_into().unwrap()
}
/// The CanvasRenderingContext2D.globalAlpha property of the Canvas 2D API specifies the alpha
/// value that is applied to shapes and images before they are drawn onto the canvas.
/// The value is in the range from 0.0 (fully transparent) to 1.0 (fully opaque).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalAlpha)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-globalalpha
pub fn set_global_alpha(&self, global_alpha: f64) {
js! { @(no_return)
@{&self.0}.globalAlpha = @{global_alpha};
}
}
/// The CanvasRenderingContext2D.globalCompositeOperation property of the Canvas 2D API sets the
/// type of compositing operation to apply when drawing new shapes, where type is a string identifying
/// which of the compositing or blending mode operations to use.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-globalcompositeoperation
pub fn get_global_composite_operation(&self) -> CompositeOperation {
let composite_operation_str: String = js! (
return @{&self.0}.globalCompositeOperation
).try_into().unwrap();
match composite_operation_str.as_ref() {
"source-over" => CompositeOperation::SourceOver,
"source-in" => CompositeOperation::SourceIn,
"source-out" => CompositeOperation::SourceOut,
"source-atop" => CompositeOperation::SourceAtop,
"destination-over" => CompositeOperation::DestinationOver,
"destination-in" => CompositeOperation::DestinationIn,
"destination-atop" => CompositeOperation::DestinationAtop,
"lighter" => CompositeOperation::Lighter,
"copy" => CompositeOperation::Copy,
"xor" => CompositeOperation::Xor,
"multiply" => CompositeOperation::Multiply,
"screen" => CompositeOperation::Screen,
"overlay" => CompositeOperation::Overlay,
"darken" => CompositeOperation::Darken,
"lighten" => CompositeOperation::Lighten,
"color-dodge" => CompositeOperation::ColorDodge,
"color-burn" => CompositeOperation::ColorBurn,
"hard-light" => CompositeOperation::HardLight,
"soft-light" => CompositeOperation::SoftLight,
"difference" => CompositeOperation::Difference,
"exclusion" => CompositeOperation::Exclusion,
"hue" => CompositeOperation::Hue,
"saturation" => CompositeOperation::Saturation,
"color" => CompositeOperation::Color,
"luminosity" => CompositeOperation::Luminosity,
_ => panic!("Unexpected globalCompositeOperation value: {:?}", composite_operation_str),
}
}
/// The CanvasRenderingContext2D.globalCompositeOperation property of the Canvas 2D API sets the
/// type of compositing operation to apply when drawing new shapes, where type is a string identifying
/// which of the compositing or blending mode operations to use.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-globalcompositeoperation
pub fn set_global_composite_operation(&self, composite_operation: CompositeOperation) {
let composite_string = match composite_operation {
CompositeOperation::SourceOver => "source-over",
CompositeOperation::SourceIn => "source-in",
CompositeOperation::SourceOut => "source-out",
CompositeOperation::SourceAtop => "source-atop",
CompositeOperation::DestinationOver => "destination-over",
CompositeOperation::DestinationIn => "destination-in",
CompositeOperation::DestinationAtop => "destination-atop",
CompositeOperation::Lighter => "lighter",
CompositeOperation::Copy => "copy",
CompositeOperation::Xor => "xor",
CompositeOperation::Multiply => "multiply",
CompositeOperation::Screen => "screen",
CompositeOperation::Overlay => "overlay",
CompositeOperation::Darken => "darken",
CompositeOperation::Lighten => "lighten",
CompositeOperation::ColorDodge => "color-dodge",
CompositeOperation::ColorBurn => "color-burn",
CompositeOperation::HardLight => "hard-light",
CompositeOperation::SoftLight => "soft-light",
CompositeOperation::Difference => "difference",
CompositeOperation::Exclusion => "exclusion",
CompositeOperation::Hue => "hue",
CompositeOperation::Saturation => "saturation",
CompositeOperation::Color => "color",
CompositeOperation::Luminosity => "luminosity"
};
js! {@(no_return)
@{&self.0}.globalCompositeOperation = @{composite_string};
}
}
/// Determines how the end points of every line are drawn.
/// There are three possible values for this property and those are: butt, round and square.
/// By default this property is set to butt.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linecap
pub fn get_line_cap(&self) -> LineCap {
let line_cap_str: String = js! (
return @{&self.0}.lineCap
).try_into().unwrap();
match line_cap_str.as_ref() {
"butt" => LineCap::Butt,
"round" => LineCap::Round,
"square" => LineCap::Square,
_ => panic!("Unexpected lineCap value: {:?}", line_cap_str),
}
}
/// Determines how the end points of every line are drawn.
/// There are three possible values for this property and those are: butt, round and square.
/// By default this property is set to butt.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linecap
pub fn set_line_cap(&self, line_cap: LineCap) {
let line_cap_string = match line_cap {
LineCap::Butt => "butt",
LineCap::Round => "round",
LineCap::Square => "square",
};
js! { @(no_return)
@{&self.0}.lineCap = @{line_cap_string};
}
}
/// Sets the line dash pattern offset or "phase" to achieve a "marching ants" effect, for example.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linedashoffset
pub fn get_line_dash_offset(&self) -> f64 {
js! (
return @{&self.0}.lineDashOffset;
).try_into().unwrap()
}
/// Sets the line dash pattern offset or "phase" to achieve a "marching ants" effect, for example.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linedashoffset
pub fn set_line_dash_offset(&self, line_dash_offset: f64) {
js! { @(no_return)
@{&self.0}.lineDashOffset = @{line_dash_offset};
}
}
/// Determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are
/// joined together (degenerate segments with zero lengths, whose specified endpoints and control points are
/// exactly at the same position, are skipped).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linejoin
pub fn get_line_join(&self) -> LineJoin {
let line_join_str: String = js! (
return @{&self.0}.lineJoin;
).try_into().unwrap();
match line_join_str.as_ref() {
"bevel" => LineJoin::Bevel,
"round" => LineJoin::Round,
"miter" => LineJoin::Miter,
_ => panic!("Unexpected lineJoin value: {:?}", line_join_str),
}
}
/// Determines how two connecting segments (of lines, arcs or curves) with non-zero lengths in a shape are
/// joined together (degenerate segments with zero lengths, whose specified endpoints and control points are
/// exactly at the same position, are skipped).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linejoin
pub fn set_line_join(&self, line_join: LineJoin) {
let line_join_str = match line_join {
LineJoin::Bevel => "bevel",
LineJoin::Round => "round",
LineJoin::Miter => "miter",
};
js! { @(no_return)
@{&self.0}.lineJoin = @{line_join_str};
}
}
/// Sets the thickness of lines in space units. When getting, it returns the current value (1.0 by default).
/// When setting, zero, negative, Infinity and NaN values are ignored; otherwise the current value is set to the new value.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linewidth
pub fn get_line_width(&self) -> f64 {
js! (
return @{&self.0}.lineWidth;
).try_into().unwrap()
}
/// Sets the thickness of lines in space units. When getting, it returns the current value (1.0 by default).
/// When setting, zero, negative, Infinity and NaN values are ignored; otherwise the current value is set to the new value.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineWidth)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-linewidth
pub fn set_line_width(&self, line_width: f64) {
js! { @(no_return)
@{&self.0}.lineWidth = @{line_width};
}
}
/// sets the miter limit ratio in space units. When getting, it returns the current value (10.0 by default).
/// When setting, zero, negative, Infinity and NaN values are ignored; otherwise the current value is set to the new value.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-miterlimit
pub fn get_miter_limit(&self) -> f64 {
js! (
return @{&self.0}.miterLimit;
).try_into().unwrap()
}
/// sets the miter limit ratio in space units. When getting, it returns the current value (10.0 by default).
/// When setting, zero, negative, Infinity and NaN values are ignored; otherwise the current value is set to the new value.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/miterLimit)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-miterlimit
pub fn set_miter_limit(&self, miter_limit: f64) {
js! { @(no_return)
@{&self.0}.miterLimit = @{miter_limit};
}
}
/// Specifies the level of the blurring effect; this value doesn't correspond to a number of pixels and is not
/// affected by the current transformation matrix. The default value is 0.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowblur
pub fn get_shadow_blur(&self) -> f64 {
js! (
return @{&self.0}.shadowBlur;
).try_into().unwrap()
}
/// Specifies the level of the blurring effect; this value doesn't correspond to a number of pixels and is not
/// affected by the current transformation matrix. The default value is 0.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowblur
pub fn set_shadow_blur(&self, shadow_blur: f64) {
js! { @(no_return)
@{&self.0}.shadowBlur = @{shadow_blur};
}
}
/// Specifies the color of the shadow.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowcolor
pub fn get_shadow_color(&self) -> String {
js! (
return @{&self.0}.shadowColor;
).try_into().unwrap()
}
/// Specifies the color of the shadow.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowcolor
pub fn set_shadow_color(&self, shadow_color: &str) {
js! { @(no_return)
@{&self.0}.shadowColor = @{shadow_color};
}
}
/// Specifies the distance that the shadow will be offset in horizontal distance.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowoffsetx
pub fn get_shadow_offset_x(&self) -> f64 {
js! (
return @{&self.0}.shadowOffsetX;
).try_into().unwrap()
}
/// Specifies the distance that the shadow will be offset in horizontal distance.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowoffsetx
pub fn set_shadow_offset_x(&self, shadow_offset_x: f64) {
js! { @(no_return)
@{&self.0}.shadowOffsetX = @{shadow_offset_x};
}
}
/// Specifies the distance that the shadow will be offset in vertical distance.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowoffsetx
pub fn get_shadow_offset_y(&self) -> f64 {
js! (
return @{&self.0}.shadowOffsetY;
).try_into().unwrap()
}
/// Specifies the distance that the shadow will be offset in vertical distance.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-shadowoffsetx
pub fn set_shadow_offset_y(&self, shadow_offset_y: f64) {
js! { @(no_return)
@{&self.0}.shadowOffsetY = @{shadow_offset_y};
}
}
/// Specifies the color or style to use for the lines around shapes. The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-strokestyle
pub fn get_stroke_style(&self) -> CanvasStyle {
js! (
return @{&self.0}.strokeStyle;
).try_into().unwrap()
}
/// Specifies the color or style to use for the lines around shapes. The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-strokestyle
pub fn set_stroke_style_color(&self, color: &str){
js! { @(no_return)
@{&self.0}.strokeStyle = @{color};
}
}
/// Specifies the color or style to use for the lines around shapes. The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-strokestyle
pub fn set_stroke_style_gradient(&self, gradient: &CanvasGradient){
js! { @(no_return)
@{&self.0}.strokeStyle = @{gradient};
}
}
/// Specifies the color or style to use for the lines around shapes. The default is #000 (black).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeStyle)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-strokestyle
pub fn set_stroke_style_pattern(&self, pattern: &CanvasPattern){
js! { @(no_return)
@{&self.0}.strokeStyle = @{pattern};
}
}
/// specifies the current text alignment being used when drawing text.
/// Beware that the alignment is based on the x value of the fillText() method.
/// So if textAlign is "center", then the text would be drawn at x - (width / 2).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-textalign
pub fn get_text_align(&self) -> TextAlign {
let text_align_str: String = js! (
return @{&self.0}.textAlign;
).try_into().unwrap();
match text_align_str.as_ref() {
"center" => TextAlign::Center,
"end" => TextAlign::End,
"left" => TextAlign::Left,
"right" => TextAlign::Right,
"start" => TextAlign::Start,
_ => panic!("Unexpected textAlign value: {:?}", text_align_str),
}
}
/// specifies the current text alignment being used when drawing text.
/// Beware that the alignment is based on the x value of the fillText() method.
/// So if textAlign is "center", then the text would be drawn at x - (width / 2).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textAlign)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-textalign
pub fn set_text_align(&self, text_align: TextAlign) {
let text_align_str = match text_align {
TextAlign::Center => "center",
TextAlign::End => "end",
TextAlign::Left => "left",
TextAlign::Right => "right",
TextAlign::Start => "start",
};
js! { @(no_return)
@{&self.0}.textAlign = @{text_align_str};
}
}
/// Specifies the current text baseline being used when drawing text.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-textbaseline
pub fn get_text_baseline(&self) -> TextBaseline {
let text_baseline_str: String = js! (
return @{&self.0}.textBaseline;
).try_into().unwrap();
match text_baseline_str.as_ref() {
"alphabetic" => TextBaseline::Alphabetic,
"bottom" => TextBaseline::Bottom,
"hanging" => TextBaseline::Hanging,
"ideographic" => TextBaseline::Ideographic,
"middle" => TextBaseline::Middle,
"top" => TextBaseline::Top,
_ => panic!("Unexpected textBaseLine value: {:?}", text_baseline_str)
}
}
/// Specifies the current text baseline being used when drawing text.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/textBaseline)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-textbaseline
pub fn set_text_baseline(&self, text_baseline: TextBaseline) {
let text_baseline_str = match text_baseline {
TextBaseline::Alphabetic => "alphabetic",
TextBaseline::Bottom => "bottom",
TextBaseline::Hanging => "hanging",
TextBaseline::Ideographic => "ideographic",
TextBaseline::Middle => "middle",
TextBaseline::Top => "top"
};
js! { @(no_return)
@{&self.0}.textBaseline = @{text_baseline_str};
}
}
/// Adds an arc to the path which is centered at (x, y) position with radius r starting
/// at startAngle and ending at endAngle going in the given direction by anticlockwise
/// (defaulting to clockwise).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/arc)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-arc
pub fn arc(&self, x: f64, y: f64, radius: f64, start_angle: f64, end_angle: f64, anticlockwise: bool) {
js! { @(no_return)
@{&self.0}.arc(@{x}, @{y}, @{radius}, @{start_angle}, @{end_angle}, @{anticlockwise});
}
}
/// Adds an arc to the path with the given control points and radius.
/// The arc drawn will be a part of a circle, never elliptical.
/// Typical use could be making a rounded corner.
/// One way to think about the arc drawn is to imagine two straight segments, from the
/// starting point (latest point in current path) to the first control point, and then
/// from the first control point to the second control point. These two segments form
/// a sharp corner with the first control point being in the corner. Using arcTo, the
/// corner will instead be an arc with the given radius.
/// The arc is tangential to both segments, which can sometimes produce surprising results,
/// e.g. if the radius given is larger than the distance between the starting point and the first control point.
/// If the radius specified doesn't make the arc meet the starting point (latest point in the current path),
/// the starting point is connected to the arc with a straight line segment.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/arcTo)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-arcto
pub fn arc_to(&self, x1: f64, y1: f64, x2: f64, y2: f64, radius: f64) -> Result<(), IndexSizeError> {
js_try! ( @(no_return)
@{&self.0}.arcTo(@{x1}, @{y1}, @{x2}, @{y2}, @{radius});
).unwrap()
}
/// Starts a new path by emptying the list of sub-paths. Call this method when you want to create a new path.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/beginPath)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-beginpath
pub fn begin_path(&self) {
js! { @(no_return)
@{&self.0}.beginPath();
}
}
/// Adds a cubic Bézier curve to the path. It requires three points. The first two points
/// are control points and the third one is the end point. The starting point is the last
/// point in the current path, which can be changed using moveTo() before creating the Bézier curve.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/bezierCurveTo)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-beziercurveto
pub fn bezier_curve_to(&self, cp1x: f64, cp1y: f64, cp2x: f64, cp2y: f64, x: f64, y: f64) {
js! { @(no_return)
@{&self.0}.bezierCurveTo(@{cp1x}, @{cp1y}, @{cp2x}, @{cp2y}, @{x}, @{y});
}
}
/// Sets all pixels in the rectangle defined by starting point (x, y) and size (width, height)
/// to transparent black, erasing any previously drawn content.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/clearRect)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-clearrect
pub fn clear_rect(&self, x: f64, y: f64, width: f64, height: f64) {
js! { @(no_return)
@{&self.0}.clearRect(@{x}, @{y}, @{width}, @{width}, @{height});
}
}
/// Turns the path currently being built into the current clipping path.
/// ctx.clip(path, fillRule) is not supported because [(Path2D)](https://developer.mozilla.org/en-US/docs/Web/API/Path2D) is still experimental
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/clip)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-clip
pub fn clip(&self, fill_rule: FillRule) {
let fill_rule_str = fill_rule_to_str(fill_rule);
js! { @(no_return)
@{&self.0}.clip(@{fill_rule_str});
}
}
/// Causes the point of the pen to move back to the start of the current sub-path. It tries
/// to add a straight line (but does not actually draw it) from the current point to the start.
/// If the shape has already been closed or has only one point, this function does nothing.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/closePath)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-closepath
pub fn close_path(&self) {
js! { @(no_return)
@{&self.0}.closePath();
}
}
/// Creates a gradient along the line given by the coordinates represented by the parameters.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createLinearGradient)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-createlineargradient
pub fn create_linear_gradient(&self, x0: f64, y0: f64, x1: f64, y1: f64) -> CanvasGradient {
js! (
return @{&self.0}.createLinearGradient(@{x0}, @{y0}, @{x1}, @{y1});
).try_into().unwrap()
}
/// Creates a new, blank ImageData object with the specified dimensions.
/// All of the pixels in the new object are transparent black.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createImageData)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-createimagedata
pub fn create_image_data(&self, width: f64, height: f64) -> Result<ImageData, IndexSizeError> {
js_try! (
return @{&self.0}.createImageData(@{width}, @{height});
).unwrap()
}
/// Creates a new, blank ImageData object with the specified dimensions.
/// All of the pixels in the new object are transparent black.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createImageData)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-createimagedata
pub fn create_image_data_size_of(&self, image_data: ImageData) -> ImageData {
js! (
return @{&self.0}.createImageData(@{image_data});
).try_into().unwrap()
}
/// Creates a pattern using the specified image (a CanvasImageSource). It repeats the source in
/// the directions specified by the repetition argument. This method returns a CanvasPattern.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createPattern)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-createpattern
pub fn create_pattern_image(&self, image: ImageElement, repetition: Repetition) -> CanvasPattern {
let repetition_string = match repetition {
Repetition::Repeat => {
"repeat"
}
Repetition::RepeatX => {
"repeat-x"
}
Repetition::RepeatY => {
"repeat-y"
}
Repetition::NoRepeat => {
"no-repeat"
}
};
js! (
return @{&self.0}.createPattern(@{image}, @{repetition_string});
).try_into().unwrap()
}
/// Creates a radial gradient given by the coordinates of the two circles represented by the parameters.
/// This method returns a CanvasGradient.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/createRadialGradient)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-createradialgradient
pub fn create_radial_gradient(&self, x0: f64, y0: f64, r0: f64, x1: f64, y1: f64, r1: f64) -> Result<CanvasGradient, IndexSizeError> {
js_try! (
return @{&self.0}.createRadialGradient(@{x0}, @{y0}, @{r0}, @{x1}, @{y1}, @{r1});
).unwrap()
}
/// Draws a focus ring around the current path or given path, If a given element is focused.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawFocusIfNeeded)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-drawfocusifneeded
pub fn draw_focus_if_needed< T: IHtmlElement >(&self, element: &T) {
js! { @(no_return)
@{&self.0}.drawFocusIfNeeded(@{element.as_ref()});
}
}
/// Provides different ways to draw an image onto the canvas.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawImage)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-drawimage
pub fn draw_image(&self, image: ImageElement, dx: f64, dy: f64) -> Result<(), DrawImageError> {
js_try! (@(no_return)
@{&self.0}.drawImage(@{image}, @{dx}, @{dy});
).unwrap()
}
/// Provides different ways to draw an image onto the canvas.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawImage)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-drawimage
pub fn draw_image_d(&self, image: ImageElement, dx: f64, dy: f64, d_width: f64, d_height: f64) -> Result<(), DrawImageError> {
js_try! (@(no_return)
@{&self.0}.drawImage(@{image}, @{dx}, @{dy}, @{d_width}, @{d_height});
).unwrap()
}
/// Provides different ways to draw an image onto the canvas.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/drawImage)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-drawimage
pub fn draw_image_s(&self, image: ImageElement,
sx: f64, sy: f64, s_width: f64, s_height: f64,
dx: f64, dy: f64, d_width: f64, d_height: f64
) -> Result<(), DrawImageError> {
js_try!(@(no_return)
@{&self.0}.drawImage(@{image}, @{sx}, @{sy}, @{s_width}, @{s_height}, @{dx}, @{dy}, @{d_width}, @{d_height});
).unwrap()
}
/// Fills the current or given path with the current fill style using the non-zero or even-odd winding rule.
///
/// ctx.fill(path, fillRule) is not supported because [(Path2D)](https://developer.mozilla.org/en-US/docs/Web/API/Path2D) is still experimental
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fill)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-fill
pub fn fill(&self, fill_rule: FillRule) {
let fill_rule_str = fill_rule_to_str(fill_rule);
js! { @(no_return)
@{&self.0}.fill(@{fill_rule_str});
}
}
/// Draws a filled rectangle whose starting point is at the coordinates (x, y) with the
/// specified width and height and whose style is determined by the fillStyle attribute.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillRect)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-fillrect
pub fn fill_rect(&self, x: f64, y: f64, width: f64, height: f64) {
js! { @(no_return)
@{&self.0}.fillRect(@{x}, @{y}, @{width}, @{height});
}
}
/// Draws a text string at the specified coordinates, filling the string's characters
/// with the current foreground color. An optional parameter allows specifying a maximum
/// width for the rendered text, which the user agent will achieve by condensing the
/// text or by using a lower font size.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/fillText)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-filltext
pub fn fill_text(&self, text: &str, x: f64, y: f64, max_width: Option<f64>) {
if let Some(max_width) = max_width {
js! { @(no_return)
@{&self.0}.fillText(@{text}, @{x}, @{y}, @{max_width});
}
}
else {
js! { @(no_return)
@{&self.0}.fillText(@{text}, @{x}, @{y});
}
}
}
/// Returns an ImageData object representing the underlying pixel data for the area of the
/// canvas denoted by the rectangle which starts at (sx, sy) and has an sw width and sh height.
/// This method is not affected by the canvas transformation matrix.
/// Pixels outside of the canvas area are present as transparent black values in the returned ImageData.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getImageData)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-getimagedata
pub fn get_image_data(&self, sx: f64, sy: f64, sw: f64, sh: f64) -> Result<ImageData, GetImageDataError> {
js_try! (
return @{&self.0}.getImageData(@{sx}, @{sy}, @{sw}, @{sh});
).unwrap()
}
/// Gets the current line dash pattern.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/getLineDash)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-getlinedash
pub fn get_line_dash(&self) -> Vec<f64> {
js! (
return @{&self.0}.getLineDash();
).try_into().unwrap()
}
/// Reports whether or not the specified point is contained in the current path.
///
/// ctx.isPointInPath(path, x, y) and ctx.isPointInPath(path, x, y, fillRule)
/// are not supported because [(Path2D)](https://developer.mozilla.org/en-US/docs/Web/API/Path2D) is still experimental
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/isPointInPath)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-ispointinpath
pub fn is_point_in_path(&self, x: f64, y: f64, fill_rule: FillRule) -> bool {
let fill_rule_str = fill_rule_to_str(fill_rule);
js! (
return @{&self.0}.isPointInPath(@{x}, @{y}, @{fill_rule_str});
).try_into().unwrap()
}
/// Reports whether or not the specified point is inside the area contained by the stroking of a path.
///
/// ctx.isPointInStroke(path, x, y) is not supported because [(Path2D)](https://developer.mozilla.org/en-US/docs/Web/API/Path2D) is still experimental
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/isPointInStroke)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-ispointinstroke
pub fn is_point_in_stroke(&self, x: f64, y: f64) -> bool {
js! (
return @{&self.0}.isPointInStroke(@{x}, @{y});
).try_into().unwrap()
}
/// Connects the last point in the sub-path to the x, y coordinates with a straight line (but does not actually draw it).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineTo)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-lineto
pub fn line_to(&self, x: f64, y: f64) {
js! { @(no_return)
@{&self.0}.lineTo(@{x}, @{y});
}
}
/// Returns a TextMetrics object that contains information about the measured text (such as its width for example).
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/measureText)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-measuretext
pub fn measure_text(&self, text: &str) -> Result<TextMetrics, SecurityError> {
js_try! (
return @{&self.0}.measureText(@{text});
).unwrap()
}
/// Moves the starting point of a new sub-path to the (x, y) coordinates.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/moveTo)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-moveto
pub fn move_to(&self, x: f64, y: f64) {
js! { @(no_return)
@{&self.0}.moveTo(@{x}, @{y});
}
}
/// Paints data from the given ImageData object onto the bitmap. If a dirty rectangle is provided, only the pixels
/// from that rectangle are painted. This method is not affected by the canvas transformation matrix.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/putImageData)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-putimagedata
pub fn put_image_data(&self,
image_data: ImageData,
dx: f32, dy: f32
) -> Result<(), InvalidStateError> {
js_try! ( @(no_return)
@{&self.0}.putImageData(@{image_data}, @{dx}, @{dy});
).unwrap()
}
/// Paints data from the given ImageData object onto the bitmap. If a dirty rectangle is provided, only the pixels
/// from that rectangle are painted. This method is not affected by the canvas transformation matrix.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/putImageData)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-putimagedata
pub fn put_image_data_dirty(&self,
image_data: ImageData,
dx: f32, dy: f32,
dirty_x: f32, dirty_y: f32,
dirty_width: f32, dirty_height: f32
) -> Result<(), InvalidStateError> {
js_try! ( @(no_return)
@{&self.0}.putImageData(@{image_data}, @{dx}, @{dy}, @{dirty_x}, @{dirty_y}, @{dirty_width}, @{dirty_height});
).unwrap()
}
/// Adds a quadratic Bézier curve to the path. It requires two points.
/// The first point is a control point and the second one is the end point.
/// The starting point is the last point in the current path, which can be changed using
/// moveTo() before creating the quadratic Bézier curve.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/quadraticCurveTo)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-quadraticcurveto
pub fn quadratic_curve_to(&self, cpx: f64, cpy: f64, x:f64, y: f64) {
js! { @(no_return)
@{&self.0}.quadraticCurveTo(@{cpx}, @{cpy}, @{x}, @{y});
}
}
/// Creates a path for a rectangle at position (x, y) with a size that is determined by width and height.
/// Those four points are connected by straight lines and the sub-path is marked as closed,
/// so that you can fill or stroke this rectangle.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/rect)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-rect
pub fn rect(&self, x: f64, y: f64, width: f64, height: f64) {
js! { @(no_return)
@{&self.0}.rect(@{x}, @{y}, @{width}, @{height});
}
}
/// Restores the most recently saved canvas state by popping the top entry in the drawing state stack.
/// If there is no saved state, this method does nothing.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/restore)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-restore
pub fn restore(&self) {
js! { @(no_return)
@{&self.0}.restore();
}
}
/// Adds a rotation to the transformation matrix. The angle argument represents a clockwise rotation angle and is expressed in radians.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/rotate)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-rotate
pub fn rotate(&self, angle: f64) {
js! { @(no_return)
@{&self.0}.rotate(@{angle});
}
}
/// Saves the entire state of the canvas by pushing the current state onto a stack.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/save)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-save
pub fn save(&self) {
js! { @(no_return)
@{&self.0}.save();
}
}
/// adds a scaling transformation to the canvas units by x horizontally and by y vertically.
/// By default, one unit on the canvas is exactly one pixel. If we apply, for instance, a scaling factor of 0.5,
/// the resulting unit would become 0.5 pixels and so shapes would be drawn at half size.
/// In a similar way setting the scaling factor to 2.0 would increase the unit size and one unit now becomes two pixels.
/// This results in shapes being drawn twice as large.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/scale)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-scale
pub fn scale(&self, x: f64, y: f64) {
js! { @(no_return)
@{&self.0}.scale(@{x}, @{y});
}
}
/// Sets the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-setlinedash
pub fn set_line_dash(&self, segments: Vec<f64>) {
js! { @(no_return)
@{&self.0}.setLineDash(@{segments});
}
}
/// Resets (overrides) the current transformation to the identity matrix and then invokes a transformation described by the arguments of this method.
/// See also the transform() method, which does not override the current transform matrix and multiplies it with a given one.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setTransform)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-settransform
pub fn set_transform(&self, a: f64, b: f64, c: f64, d: f64, e: f64, f: f64) {
js! { @(no_return)
@{&self.0}.setTransform(@{a}, @{b}, @{c}, @{d}, @{e}, @{f});
}
}
/// Strokes the current or given path with the current stroke style using the non-zero winding rule.
///
/// ctx.stroke(path) is not supported because [(Path2D)](https://developer.mozilla.org/en-US/docs/Web/API/Path2D) is still experimental
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/stroke)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-stroke
pub fn stroke(&self) {
js! { @(no_return)
@{&self.0}.stroke();
}
}
/// Paints a rectangle which has a starting point at (x, y) and has a w width and an h height onto the canvas, using the current stroke style.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeRect)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-strokerect
pub fn stroke_rect(&self, x: f64, y: f64, width: f64, height: f64) {
js! { @(no_return)
@{&self.0}.strokeRect(@{x}, @{y}, @{width}, @{height});
}
}
/// Strokes — that is, draws the outlines of — the characters of a specified text string at the given (x, y) position.
/// If the optional fourth parameter for a maximum width is provided, the text is scaled to fit that width.
/// See the CanvasRenderingContext2D.fillText() method to draw the text with the characters filled with color rather than having just their outlines drawn.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/strokeText)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-stroketext
pub fn stroke_text(&self, text: &str, x: f64, y: f64, max_width: Option<f64>) {
if let Some(max_width) = max_width {
js! { @(no_return)
@{&self.0}.strokeText(@{text}, @{x}, @{y}, @{max_width});
}
}
else {
js! { @(no_return)
@{&self.0}.strokeText(@{text}, @{x}, @{y}, @{Undefined});
}
}
}
/// Multiplies the current transformation with the matrix described by the arguments of this method.
/// You are able to scale, rotate, move and skew the context.
/// See also the setTransform() method which resets the current transform to the identity matrix and then invokes transform().
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/transform)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-transform
pub fn transform(&self, a: f64, b: f64, c: f64, d: f64, e: f64, f: f64) {
js! { @(no_return)
@{&self.0}.transform(@{a}, @{b}, @{c}, @{d}, @{e}, @{f});
}
}
/// Adds a translation transformation by moving the canvas and its origin x horizontally and y vertically on the grid.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/translate)
// https://html.spec.whatwg.org/#2dcontext:dom-context-2d-translate
pub fn translate(&self, x: f64, y: f64) {
js! { @(no_return)
@{&self.0}.translate(@{x}, @{y});
}
}
}
fn fill_rule_to_str(fill_rule: FillRule) -> &'static str {
match fill_rule {
FillRule::NonZero => {
"nonzero"
}
FillRule::EvenOdd => {
"evenodd"
}
}
}
impl TextMetrics {
/// Contains the text's advance width (the width of that inline box) in CSS pixels.
///
/// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/TextMetrics/width)
// https://html.spec.whatwg.org/#2dcontext:dom-textmetrics-width
pub fn get_width(&self) -> f64 {
js! (
return @{&self.0}.width;
).try_into().unwrap()
}
}
#[cfg(all(test, feature = "web_test"))]
mod test {
use super::*;
use webapi::document::document;
fn new_canvas() -> CanvasRenderingContext2d {
let canvas: CanvasElement = document().create_element("canvas").unwrap().try_into().unwrap();
let ctx: CanvasRenderingContext2d = canvas.get_context().unwrap();
ctx
}
#[test]
fn test_canvas_fill_color() {
let canvas = new_canvas();
canvas.set_fill_style_color("rgb(200,0,0)");
let style = canvas.get_fill_style();
match style {
CanvasStyle::String(s) => assert_eq!(s, "#c80000"),
_ => assert!(false, "Expected style to be a string \"#c80000\" was instead {:?}", style),
}
}
#[test]
fn test_browser_create_radial_gradient() {
let canvas = new_canvas();
canvas.fill_rect(10 as f64, 10 as f64, 55 as f64, 50 as f64);
let res: Result<CanvasGradient, IndexSizeError> = canvas.create_radial_gradient(100 as f64, 100 as f64, -1 as f64, 100 as f64, 100 as f64, 0 as f64);
assert!(res.is_err());
}
}