mirror of https://github.com/MLXXXp/Arduboy2.git
130 lines
4.0 KiB
C
130 lines
4.0 KiB
C
|
#ifndef Sprites_h
|
||
|
|
#define Sprites_h
|
||
|
|
|
||
|
|
#include "Arduboy2.h"
|
||
|
|
|
||
|
|
#define SPRITE_MASKED 1
|
||
|
|
#define SPRITE_UNMASKED 2
|
||
|
|
#define SPRITE_OVERWRITE 2
|
||
|
|
#define SPRITE_PLUS_MASK 3
|
||
|
|
#define SPRITE_IS_MASK 250
|
||
|
|
#define SPRITE_IS_MASK_ERASE 251
|
||
|
|
#define SPRITE_AUTO_MODE 255
|
||
|
|
|
||
|
|
class Sprites
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
/// drawExternalMask() uses a separate mask to mask image (MASKED)
|
||
|
|
///
|
||
|
|
/// image mask before after
|
||
|
|
///
|
||
|
|
/// ..... .OOO. ..... .....
|
||
|
|
/// ..O.. OOOOO ..... ..O..
|
||
|
|
/// OO.OO OO.OO ..... OO.OO
|
||
|
|
/// ..O.. OOOOO ..... ..O..
|
||
|
|
/// ..... .OOO. ..... .....
|
||
|
|
///
|
||
|
|
/// image mask before after
|
||
|
|
///
|
||
|
|
/// ..... .OOO. OOOOO O...O
|
||
|
|
/// ..O.. OOOOO OOOOO ..O..
|
||
|
|
/// OO.OO OOOOO OOOOO OO.OO
|
||
|
|
/// ..O.. OOOOO OOOOO ..O..
|
||
|
|
/// ..... .OOO. OOOOO O...O
|
||
|
|
///
|
||
|
|
void drawExternalMask(int16_t x, int16_t y, const uint8_t *bitmap,
|
||
|
|
const uint8_t *mask, uint8_t frame, uint8_t mask_frame);
|
||
|
|
|
||
|
|
/// drawPlusMask() has the same behavior as `drawExternalMask()` except
|
||
|
|
/// the data is arranged in byte tuples interposing the mask right along
|
||
|
|
/// with the image data (SPRITE_PLUS_MASK)
|
||
|
|
///
|
||
|
|
/// typical image data (8 bytes):
|
||
|
|
/// [I][I][I][I][I][I][I][I]
|
||
|
|
///
|
||
|
|
/// interposed image/mask data (8 byes):
|
||
|
|
/// [I][M][I][M][I][M][I][M]
|
||
|
|
///
|
||
|
|
/// The byte order does not change, just for every image byte you mix
|
||
|
|
/// in it's matching mask byte. Softare tools make easy work of this.
|
||
|
|
///
|
||
|
|
/// See: https://github.com/yyyc514/img2ard
|
||
|
|
///
|
||
|
|
void drawPlusMask(int16_t x, int16_t y, const uint8_t *bitmap, uint8_t frame);
|
||
|
|
|
||
|
|
/// drawOverwrite() replaces the existing content completely (UNMASKED)
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... ..... .....
|
||
|
|
/// ..O.. ..... ..O..
|
||
|
|
/// OO.OO ..... OO.OO
|
||
|
|
/// ..O.. ..... ..O..
|
||
|
|
/// ..... ..... .....
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... OOOOO .....
|
||
|
|
/// ..O.. OOOOO ..O..
|
||
|
|
/// OO.OO OOOOO OO.OO
|
||
|
|
/// ..O.. OOOOO ..O..
|
||
|
|
/// ..... OOOOO .....
|
||
|
|
///
|
||
|
|
void drawOverwrite(int16_t x, int16_t y, const uint8_t *bitmap, uint8_t frame);
|
||
|
|
|
||
|
|
/// drawErase() removes the lit pixels in the image from the display
|
||
|
|
/// (SPRITE_IS_MASK_ERASE)
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... ..... .....
|
||
|
|
/// ..O.. ..... .....
|
||
|
|
/// OO.OO ..... .....
|
||
|
|
/// ..O.. ..... .....
|
||
|
|
/// ..... ..... .....
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... OOOOO OOOOO
|
||
|
|
/// ..O.. OOOOO OO.OO
|
||
|
|
/// OO.OO OOOOO ..O..
|
||
|
|
/// ..O.. OOOOO OO.OO
|
||
|
|
/// ..... OOOOO OOOOO
|
||
|
|
///
|
||
|
|
void drawErase(int16_t x, int16_t y, const uint8_t *bitmap, uint8_t frame);
|
||
|
|
|
||
|
|
/// drawSelfMasked() only draws lit pixels, black pixels in
|
||
|
|
/// your image are treated as "transparent" (SPRITE_IS_MASK)
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... ..... .....
|
||
|
|
/// ..O.. ..... ..O..
|
||
|
|
/// OO.OO ..... OO.OO
|
||
|
|
/// ..O.. ..... ..O..
|
||
|
|
/// ..... ..... .....
|
||
|
|
///
|
||
|
|
/// image before after
|
||
|
|
///
|
||
|
|
/// ..... OOOOO OOOOO (no change because all pixels were
|
||
|
|
/// ..O.. OOOOO OOOOO already white)
|
||
|
|
/// OO.OO OOOOO OOOOO
|
||
|
|
/// ..O.. OOOOO OOOOO
|
||
|
|
/// ..... OOOOO OOOOO
|
||
|
|
///
|
||
|
|
void drawSelfMasked(int16_t x, int16_t y, const uint8_t *bitmap, uint8_t frame);
|
||
|
|
|
||
|
|
/// Master function. Needs to be abstracted into separate function for
|
||
|
|
/// every render type
|
||
|
|
void draw(int16_t x, int16_t y,
|
||
|
|
const uint8_t *bitmap, uint8_t frame,
|
||
|
|
const uint8_t *mask, uint8_t sprite_frame,
|
||
|
|
uint8_t drawMode);
|
||
|
|
|
||
|
|
void drawBitmap(int16_t x, int16_t y,
|
||
|
|
const uint8_t *bitmap, const uint8_t *mask,
|
||
|
|
int8_t w, int8_t h, uint8_t draw_mode);
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif
|