From 891f68a0be195e10d9c60a14793e6e90928f67ef Mon Sep 17 00:00:00 2001
From: Pharap <2933055+Pharap@users.noreply.github.com>
Date: Sat, 13 Jul 2019 10:33:29 +0100
Subject: [PATCH] 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.
---
 src/Sprites.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/Sprites.h b/src/Sprites.h
index e0ba046..fb37b4a 100644
--- 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.