Mercurial > malikania
annotate docs/specs/sprite.md @ 75:88d996df3eba
Docs: add sprite specifications
author | David Demelier <markand@malikania.fr> |
---|---|
date | Thu, 29 Dec 2016 11:34:40 +0100 |
parents | |
children | 835c8ee3f9e5 |
rev | line source |
---|---|
75
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
1 # Sprite |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
2 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
3 A sprite is an object that splits an image into several cells. It is primarily |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
4 designed to combine multiple related images into one for better performance and |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
5 easier usage. |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
6 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
7 Sprites are mostly used as character design, some GUI elements, map tilesets |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
8 and other data that require lots of related images. |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
9 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
10 Sprites can be created natively in C++, Javascript or using the resource loader |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
11 with an appropriate JSON description. |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
12 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
13 ## JSON specification |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
14 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
15 ### Synopsis |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
16 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
17 ````json |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
18 { |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
19 "image": "image identifier", |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
20 "cell": [ 0, 0 ], |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
21 "margin": [ 0, 0 ], |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
22 "space": [ 0, 0 ], |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
23 "size": [ 50, 50 ] |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
24 } |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
25 ```` |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
26 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
27 ### Properties |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
28 |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
29 - **image**: unique identifier to an image, |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
30 - **cell**: size of sprite cells, |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
31 - **margin**: top/left and bottom/right margins (Optional: default none), |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
32 - **space**: |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
33 space between each cell horizontally/vertically (Optional: default none), |
88d996df3eba
Docs: add sprite specifications
David Demelier <markand@malikania.fr>
parents:
diff
changeset
|
34 - **size**: override image size (Optional: default automatic). |