Mercurial > molko

annotate doc/api-molko-texture.rst @ 212:ddfe0a211169

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
rpg: experiment with map teleport
author David Demelier <markand@malikania.fr>
date Mon, 16 Nov 2020 14:26:13 +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-texture:
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 =============
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 Molko.Texture
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
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 This module provides graphics primites for textures. Textures can be created by
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 hand or loaded from files. It's possible to draw on a texture using the
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 :ref:`api-molko-painter` API.
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 Constants
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:data:: Molko.Texture.BlendMode
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 This enumeration constant contains the following blend mode that can be used as
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 the ``blendMode`` property.
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 ``TEXTURE_BLEND_NONE``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 No modification.
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 ``TEXTURE_BLEND_BLEND``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 Alpha blend mode modulation.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ``TEXTURE_BLEND_ADD``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 Additive modulation.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 ``TEXTURE_BLEND_MODULATE``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 Color modulation.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Constructors
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 ------------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
34
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .. js:function:: Molko.Texture(width, height)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
36
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 :param uint width: Desired texture width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 :param uint height: Desired texture height.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 Construct a new texture with the given dimensions. This function MUST be called
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 as a constructor, not doing so will also raise an error.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
42
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 Functions
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 ---------
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
45
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .. js:function:: Molko.Texture.fromImage(path)
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 :param string path: Path to the image file.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 :throws: Error in case of error.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 :returns: A Texture object.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
51
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 Try to open an image as a texture.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 Methods
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 -------
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 .. js:method:: Molko.Texture.draw(x, y)
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 :param int x: Position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 :param int y: Position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 :throws: Error on errors.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 Draw the whole texture at the given position.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
64
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .. js:method:: Molko.Texture.scale(source, destination, angle = 0)
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 :param object source: Source rectangle.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 :param object destination: Destination rectangle.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 :param number angle: Angle rotation.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 :throws: Error on errors.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
71
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 Scale the texture from the source region into the destination and apply an
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 optional angle.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
74
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
75 The ``source`` and ``destination`` objects MUST contain the following
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 properties:
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 ``x (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 Start position in x.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 ``y (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 Start position in y.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 ``h (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
83 Height to scale.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 ``w (int)``
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 Width to scale.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 Properties
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 ----------
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:attribute:: Molko.Texture.width
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
91
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 (Read-only) Texture's width.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
93
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 .. js:attribute:: Molko.Texture.height
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
95
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 (Read-only) Texture's height.
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 .. js:attribute:: Molko.Texture.blendMode
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 (Write-only) Change the blend mode.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
101
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 .. js:attribute:: Molko.Texture.alphaMod
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
103
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 (Write-only) Change the alpha transparency modulation from 0 to 255.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
105
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 .. js:attribute:: Molko.Texture.colorMod
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
107
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 (Write-only) Change color modulation.