Skip to content

Commit 7db3982

Browse files
committed
Docs
1 parent fe731c3 commit 7db3982

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

docs/README.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Module Documentation
2+
## Module Graphics.Canvas
3+
4+
### Types
5+
6+
type Arc = { end :: Prim.Number, start :: Prim.Number, r :: Prim.Number, cy :: Prim.Number, cx :: Prim.Number }
7+
8+
data Canvas :: !
9+
10+
data CanvasElement :: *
11+
12+
data Context2D :: *
13+
14+
type Rectangle = { h :: Prim.Number, w :: Prim.Number, y :: Prim.Number, x :: Prim.Number }
15+
16+
type ScaleTransform = { scaleY :: Prim.Number, scaleX :: Prim.Number }
17+
18+
type Transform = { m32 :: Prim.Number, m31 :: Prim.Number, m22 :: Prim.Number, m21 :: Prim.Number, m12 :: Prim.Number, m11 :: Prim.Number }
19+
20+
type TranslateTransform = { translateY :: Prim.Number, translateX :: Prim.Number }
21+
22+
23+
### Type Classes
24+
25+
26+
### Type Class Instances
27+
28+
29+
### Values
30+
31+
arc :: forall eff. Context2D -> Arc -> Eff (canvas :: Canvas | eff) Context2D
32+
33+
beginPath :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
34+
35+
clearRect :: forall eff. Context2D -> Rectangle -> Eff (canvas :: Canvas | eff) Context2D
36+
37+
clip :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
38+
39+
fill :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
40+
41+
fillPath :: forall eff a. Context2D -> Eff (canvas :: Canvas | eff) a -> Eff (canvas :: Canvas | eff) a
42+
43+
fillRect :: forall eff. Context2D -> Rectangle -> Eff (canvas :: Canvas | eff) Context2D
44+
45+
getContext2D :: forall eff. CanvasElement -> Eff (canvas :: Canvas | eff) Context2D
46+
47+
lineTo :: forall eff. Context2D -> Prim.Number -> Prim.Number -> Eff (canvas :: Canvas | eff) Context2D
48+
49+
moveTo :: forall eff. Context2D -> Prim.Number -> Prim.Number -> Eff (canvas :: Canvas | eff) Context2D
50+
51+
rect :: forall eff. Context2D -> Rectangle -> Eff (canvas :: Canvas | eff) Context2D
52+
53+
restore :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
54+
55+
rotate :: forall eff. Prim.Number -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
56+
57+
save :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
58+
59+
scale :: forall eff. ScaleTransform -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
60+
61+
setFillStyle :: forall eff. Prim.String -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
62+
63+
setLineWidth :: forall eff. Prim.Number -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
64+
65+
setShadowBlur :: forall eff. Prim.Number -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
66+
67+
setShadowColor :: forall eff. Prim.String -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
68+
69+
setShadowOffsetX :: forall eff. Prim.Number -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
70+
71+
setShadowOffsetY :: forall eff. Prim.Number -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
72+
73+
setStrokeStyle :: forall eff. Prim.String -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
74+
75+
stroke :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
76+
77+
strokePath :: forall eff a. Context2D -> Eff (canvas :: Canvas | eff) a -> Eff (canvas :: Canvas | eff) a
78+
79+
strokeRect :: forall eff. Context2D -> Rectangle -> Eff (canvas :: Canvas | eff) Context2D
80+
81+
transform :: forall eff. Transform -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
82+
83+
translate :: forall eff. TranslateTransform -> Context2D -> Eff (canvas :: Canvas | eff) Context2D
84+
85+
withContext :: forall eff a. Context2D -> Eff (canvas :: Canvas | eff) a -> Eff (canvas :: Canvas | eff) a
86+
87+
88+

0 commit comments

Comments
 (0)