diff options
| -rw-r--r-- | common/system.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/common/system.h b/common/system.h index 505ddb5dc4..8c05b6d756 100644 --- a/common/system.h +++ b/common/system.h @@ -617,6 +617,20 @@ public: /** * Blit a graphics buffer to the overlay. * In a sense, this is the reverse of grabOverlay. + * + * @note The pitch parameter actually contains the 'pixel pitch', i.e., + * the number of pixels per scanline, and not as usual the number of bytes + * per scanline. + * + * @todo Change 'pitch' to be byte and not pixel based + * + * @param buf the buffer containing the graphics data source + * @param pitch the pixel pitch of the buffer (number of pixels in a scanline) + * @param x the x coordinate of the destination rectangle + * @param y the y coordinate of the destination rectangle + * @param w the width of the destination rectangle + * @param h the height of the destination rectangle + * * @see copyRectToScreen * @see grabOverlay */ |