doc: explain mechanics of size property

This commit is contained in:
Zen-CODE 2018-12-09 16:44:27 +02:00 committed by Gabriel Pettier
parent 0a6c990320
commit fcaa404220
1 changed files with 7 additions and 2 deletions

View File

@ -81,7 +81,10 @@ You can combine all the png's into one and generate the atlas file with::
myatlas-0.png
As you can see, we get 2 new files: ``myatlas.atlas`` and ``myatlas-0.png``.
``myatlas-0.png`` is a new 256x256 .png composed of all your images.
``myatlas-0.png`` is a new 256x256 .png composed of all your images. If the
size you specify is not large enough to fit all of the source images, more
atlas images will be created as required e.g. ``myatlas-1.png``,
``myatlas-2.png`` etc.
.. note::
@ -234,7 +237,9 @@ class Atlas(EventDispatcher):
`filenames`: list
List of filenames to put in the atlas.
`size`: int or list (width, height)
Size of the atlas image.
Size of the atlas image. If the size is not large enough to
fit all of the source images, more atlas images will created
as required.
`padding`: int, defaults to 2
Padding to put around each image.