Sprites / SpritesB Library

From Arduboy Wiki
Revision as of 03:17, 11 August 2024 by Filmote (talk | contribs)
Jump to navigation Jump to search

What are Sprites?

Sprites are a computer graphic which can be rendered and moved on screen as a single unit.  In older systems such as the Commodore 64 and Atari, the sprite was rendered by hardware as an overlay to the normal screen image.  As the sprite is an overlay, it can be moved around without it affecting the background image.

The Arduboy library has support for sprites but due to the lack of a powerful graphics processor handles them differently.  When rendering a sprite, the image is mapped into a single display buffer that may already have a background image drawn on it.  If you move the sprite you need to regenerate the background from its old position.

The Arduboy library also provides some nice masking utilities that allow you to render a sprite over a background and have it take that background into account.  The drawing functions include:

  • drawOverwrite()
  • drawErase()
  • drawExternalMask()
  • drawPlusMask()
  • drawSefMasked()

But what do they each do?  Consider the following image and mask:


Using these images with the various draw functions produces different results:

drawOverwrite() -  The sprite is drawn by simply overwriting what was already there. A bit set to 1 in the frame will set the pixel to 1 in the buffer, and a 0 in the array will set a 0 in the buffer.  In the example below, the black corners of the ball are visible as the ball passes into the white area.


drawErase() -  Erases the sprite.  When "erasing" a sprite, bits set to 1 in the sprite will set the corresponding pixel in the background to 0.  Sprite bits set to 0 will not affect the background.  In the example below, the ball is not visible on the left hand side of the screen as the white portions of the image has set the background to black.  The right hand shows that the white sections of the image have ‘erased’ the white background.