Mercurial > py-sdl2

changeset 156:4c39eaa64df7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- documented missing subsprite() method
author Marcus von Appen <marcus@sysfault.org>
date Mon, 17 Feb 2014 08:06:23 +0100
parents 5273aa4a7b22
children 3beff16eecd2
files doc/modules/sdl2ext_sprite.rst
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/modules/sdl2ext_sprite.rst	Mon Feb 17 08:05:38 2014 +0100
+++ b/doc/modules/sdl2ext_sprite.rst	Mon Feb 17 08:06:23 2014 +0100
@@ -62,6 +62,12 @@
 
       The size of the :class:`SoftwareSprite` as tuple.
 
+   .. method:: subsprite(area : (int, int, int, int)) -> SoftwareSprite
+
+      Creates another :class:`SoftwareSprite` from a part of the
+      :class:`SoftwareSprite`. The two sprites share pixel data, so if the 
+      parent sprite's surface is not managed by the sprite (``free`` is False),
+      you will need to keep it alive while the subsprite exists.
 
 .. class:: TextureSprite()