Add additional information to drawExternalMask

This information is already contained in the main details block,
but providing it here as well should make it more obvious.
This commit is contained in:
Pharap 2019-07-13 10:33:29 +01:00 committed by GitHub
parent 2fbde21e66
commit 891f68a0be
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 0 deletions

View File

@ -89,6 +89,9 @@ class Sprites
* An array containing the image frames, and another array containing
* corresponding mask frames, are used to draw a sprite.
*
* For the mask array, the width and height are not included but must
* contain data of the same dimensions as the corresponding image array.
*
* Bits set to 1 in the mask indicate that the pixel will be set to the
* value of the corresponding image bit. Bits set to 0 in the mask will be
* left unchanged.