Merge pull request #45 from Pharap/add-drawexternalmask-comment

Add additional information to drawExternalMask
2019-07-14 11:46:00 -04:00 · 2019-07-14 11:46:00 -04:00 · bc4e0ed0b5
parent 2fbde21e66 891f68a0be
commit bc4e0ed0b5
1 changed files with 3 additions and 0 deletions
--- a/src/Sprites.h
+++ b/src/Sprites.h
@ -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.