Mercurial > molko

annotate doc/api-molko-painter.rst @ 195:02285657294c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
examples: fix drawable animation delay
author David Demelier <markand@malikania.fr>
date Sat, 07 Nov 2020 21:08:47 +0100
parents 633a25df450e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .. toctree::
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .. _api-molko-painter:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
3
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 Molko.Painter
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 =============
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 Module for drawing operation into the screen or a texture. It is a low level
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 module with primitives operations.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 You must open a window before using this module. See :ref:`api-molko-window`.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 Constructors
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 ------------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
14
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .. js:function:: Molko.Painter()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
16
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 Create a painter object. This function MUST be called as a constructor, not
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 doing so will also raise an error.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 Methods
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 -------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .. js:method:: Molko.Painter.clear()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 Clear the rendering target with the current color.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .. js:method:: Molko.Painter.drawLine(line)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 Molko.Painter.drawLine(x1, x2, x2, y2)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
29
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 :param object line: A line segment.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 :param int x1: Start position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 :param int y1: Start position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 :param int x2: End position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 :param int y2: End position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 Draw a line, two signatures are allowed.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
37
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 In the second form, each argument is passed individually, in the first form it
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 it takes an object with the following properties:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
40
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 ``x1 (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 Start position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 ``y1 (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 Start position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 ``x2 (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 End position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 ``y2 (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 End position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
49
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .. js:method:: Molko.Painter.drawPoint(point)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 Molko.Painter.drawPoint(x, y)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
52
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 :param object point: A point.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 :param int x: Start position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 :param int y: Start position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 Draw a unique point, two signatures are allowed.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
58
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 In the second form, each argument is passed individually, in the first form it
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 it takes an object with the following properties:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
61
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .. js:method:: Molko.Painter.drawRectangle(rectangle)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 Molko.Painter.drawRectangle(x, y, w, h)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 :param object rectangle: A rectangle.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 :param int x: Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 :param int y: Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 :param int w: Rectangle width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 :param int h: Height width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
75
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 Fill a rectangle region, two signatures are allowed.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
77
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 In the second form, each argument is passed individually, in the first form it
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 it takes an object with the following properties:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
80
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 ``w (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
86 Rectangle width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 ``h (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 Height width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
89
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 .. js:method:: Molko.Painter.drawCircle(circle)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 Molko.Painter.drawCircle(x, y, r)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
92
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 :param object circle: A circle.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 :param int x: Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
95 :param int y: Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 :param number radius: Radius.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
97
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 Draw a circle, two signatures are allowed.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
99
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
100 In the second form, each argument is passed individually, in the first form it
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 it takes an object with the following properties:
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
102
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
105 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 Position in y;
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 ``radius (number)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 Radius.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
109
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
110 .. js:method:: Molko.Painter.present()
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
111
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 Present the rendered operations to the screen.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
113
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 Properties
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
115 ----------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
116
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 .. js:attribute:: Molko.Painter.color
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
118
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 (Read-write) Color for next drawing operation.