Macros
#define	PA_UpdateOAM0() dmaCopyWords(3, (void)PA_obj, (void)OAM0, 256 * 4)
	Update the sprite infos for screen 0 only. Do this in the VBL.

#define	PA_UpdateOAM1() dmaCopyWords(3, (void)PA_obj + 256, (void)OAM1, 256 * 4)
	Update the sprite infos for screen 1 only. Do this in the VBL.

#define	PA_UpdateSpriteGfx(screen, obj_number, obj_data) PA_UpdateGfx(screen, PA_GetSpriteGfx(screen, obj_number), obj_data)
	Update the Gfx of a given sprite.

#define	PA_SetSpriteRotEnable(screen, sprite, rotset) do{PA_obj[screen][sprite].atr0 \|= OBJ_ROT; PA_obj[screen][sprite].atr1 = (PA_obj[screen][sprite].atr1 & ALL_BUT_ROTSET) + ((rotset) << 9);}while(0)
	Rotate and zoom a sprite.

#define	PA_SetSpriteRotDisable(screen, sprite) do{PA_obj[screen][sprite].atr0 &= ALL_BUT(OBJ_ROT); PA_obj[screen][sprite].atr1 &= ALL_BUT_ROTSET;}while(0)
	Stop rotating and zooming a sprite.

#define	PA_SetSpriteX(screen, obj, x) PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(PA_OBJ_X)) + ((x) & PA_OBJ_X)
	Set the X position of a sprite on screen.

#define	PA_GetSpriteX(screen, obj) (PA_obj[screen][obj].atr1 & (PA_OBJ_X))
	Get the X position of a sprite on screen.

#define	PA_SetSpriteY(screen, obj, y) PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(PA_OBJ_Y)) + ((y) & PA_OBJ_Y)
	Set the Y position of a sprite on screen.

#define	PA_GetSpriteY(screen, obj) (PA_obj[screen][obj].atr0 & PA_OBJ_Y)
	Get the Y position of a sprite on screen.

#define	PA_SetSpritePal(screen, obj, pal) PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT_PAL) + ((pal) << 12)
	Set the sprite's palette number.

#define	PA_GetSpritePal(screen, obj) (PA_obj[screen][obj].atr2 >> 12)
	Get thepalette used by a sprite.

#define	PA_SetSpriteDblsize(screen, obj, dblsize) PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(DBLSIZE)) + ((dblsize) << 9)
	Enable or disable double size for a given sprite.

#define	PA_GetSpriteDblsize(screen, obj) ((PA_obj[screen][obj].atr0 & DBLSIZE) >> 9)
	Get the double size state for a given sprite.

#define	PA_SetSpriteColors(screen, sprite, n_colors) PA_obj[screen][sprite].atr0 = (PA_obj[screen][sprite].atr0 & ALL_BUT(N_COLORS)) + ((n_colors) << 13)
	Change the sprite's color mode.

#define	PA_GetSpriteColors(screen, sprite) ((PA_obj[screen][sprite].atr0 & N_COLORS) >> 13)
	Get a sprite's color mode.

#define	PA_SetSpriteMode(screen, sprite, obj_mode) PA_obj[screen][sprite].atr0 = (PA_obj[screen][sprite].atr0 & ALL_BUT(OBJ_MODE)) + ((obj_mode) << 10)
	Set the sprite's mode : 0 for normal, 1 for alpha blending, 2 for window.

#define	PA_GetSpriteMode(screen, obj) ((PA_obj[screen][obj].atr0 & OBJ_MODE) >> 10)
	Get the sprite's mode : 0 for normal, 1 for alpha blending, 2 for window.

#define	PA_SetSpriteMosaic(screen, obj, mosaic) PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(OBJ_MOSAIC)) + ((mosaic) << 12)
	Enable or disable mosaic mode for a given sprite.

#define	PA_GetSpriteMosaic(screen, obj) ((PA_obj[screen][obj].atr0 & OBJ_MOSAIC) >> 12)
	Get the mosaic mode for a given sprite.

#define	PA_SetSpriteHflip(screen, obj, hflip) PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(OBJ_HFLIP)) + ((hflip) << 12)
	Enable or disable horizontal flip for a given sprite.

#define	PA_GetSpriteHflip(screen, obj) ((PA_obj[screen][obj].atr1 & OBJ_HFLIP) >> 12)
	Get the horizontal flip state for a given sprite.

#define	PA_SetSpriteVflip(screen, obj, vflip) PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(OBJ_VFLIP)) + ((vflip) << 13)
	Enable or disable vertical flip for a given sprite.

#define	PA_GetSpriteVflip(screen, obj) ((PA_obj[screen][obj].atr1 & OBJ_VFLIP) >> 13)
	Get the vertical flip state for a given sprite.

#define	PA_SetSpriteGfx(screen, obj, gfx) PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT(OBJ_GFX)) + ((gfx) & OBJ_GFX)
	Change the gfx used by a sprite.

#define	PA_GetSpriteGfx(screen, obj) (PA_obj[screen][obj].atr2 & OBJ_GFX)
	Get the gfx used by a sprite.

#define	PA_SetSpritePrio(screen, obj, prio) PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT(OBJ_PRIO)) + ((prio) << 10)
	Set a sprite's Background priority.

#define	PA_GetSpritePrio(screen, obj) ((PA_obj[screen][obj].atr2 & OBJ_PRIO) >> 10)
	Get a sprite's Background priority.

#define	PA_GetSpriteLx(screen, sprite) PA_size[PA_obj[screen][sprite].atr0 >> 14][PA_obj[screen][sprite].atr1 >> 14].lx
	Get a sprite's length.

#define	PA_GetSpriteLy(screen, sprite) PA_size[PA_obj[screen][sprite].atr0 >> 14][PA_obj[screen][sprite].atr1 >> 14].ly
	Get a sprite's height.

#define	PA_CloneSprite(screen, obj, target) do{PA_obj[screen][obj].atr0 = PA_obj[screen][target].atr0; PA_obj[screen][obj].atr1 = PA_obj[screen][target].atr1; PA_obj[screen][obj].atr2 = PA_obj[screen][target].atr2; ++obj_per_gfx[screen][PA_GetSpriteGfx(screen, target)];}while(0)
	Clone a sprite. Works only for sprites on the same screen.

Functions
void	PA_UpdateOAM (void)
	Update the sprite infos for both screens. Do this in the VBL.

u16	PA_CreateGfx (u8 screen, void *obj_data, u8 obj_shape, u8 obj_size, u8 color_mode)
	Load in mémory a gfx to use later on for a sprite. Returns the gfx's number in memory.

void	PA_ResetSpriteSys (void)
	Reset the sprite system, memory, etc...

static void	PA_CreateSprite (u8 screen, u8 obj_number, void *obj_data, u8 obj_shape, u8 obj_size, u8 color_mode, u8 palette, s16 x, s16 y)
	Create a sprite with it's gfx. This is the simple version of the function.

static void	PA_CreateSpriteEx (u8 screen, u8 obj_number, void *obj_data, u8 obj_shape, u8 obj_size, u8 color_mode, u8 palette, u8 obj_mode, u8 mosaic, u8 hflip, u8 vflip, u8 prio, u8 dblsize, s16 x, s16 y)
	Create a sprite with it's gfx. This is the complex version of the function.

static void	PA_Create16bitSpriteEx (u8 screen, u8 obj_number, void *obj_data, u8 obj_shape, u8 obj_size, u8 mosaic, u8 hflip, u8 vflip, u8 prio, u8 dblsize, s16 x, s16 y)
	Create a 16 bit sprite with it's gfx. This is the complex version of the function. Warning : a 16bit sprite MUST be 128 pixels large, even if you sprite only takes up a small part on the left...

static void	PA_Create16bitSpriteFromGfx (u8 screen, u8 obj_number, u16 gfx, u8 obj_shape, u8 obj_size, s16 x, s16 y)
	Create a 16 bit sprite using a given gfx.

static void	PA_Create16bitSprite (u8 screen, u8 obj_number, void *obj_data, u8 obj_shape, u8 obj_size, s16 x, s16 y)
	Create a 16 bit sprite with it's gfx. This is the simple version of the function. Warning : a 16bit sprite MUST be 128 pixels large, even if you sprite only takes up a small part on the left...

static void	PA_CreateSpriteFromGfx (u8 screen, u8 obj_number, u16 obj_gfx, u8 obj_shape, u8 obj_size, u8 color_mode, u8 palette, s16 x, s16 y)
	Create a sprite with it's gfx. This is the simple version of the function.

static void	PA_CreateSpriteExFromGfx (u8 screen, u8 obj_number, u16 obj_gfx, u8 obj_shape, u8 obj_size, u8 color_mode, u8 palette, u8 obj_mode, u8 mosaic, u8 hflip, u8 vflip, u8 prio, u8 dblsize, s16 x, s16 y)
	Create a sprite with it's gfx. This is the complex version of the function.

static void	PA_UpdateGfx (u8 screen, u16 gfx_number, void *obj_data)
	Update a given Gfx.

static void	PA_UpdateGfxAndMem (u8 screen, u8 gfx_number, void *obj_data)
	Update the Gfx of a given sprite and updates the PAlib animation pointer... Only for advanced users.

void	PA_DeleteGfx (u8 screen, u16 obj_gfx)
	Delete a given Gfx. If a sprite uses this gfx, it'll become invisible.

void	PA_DeleteSprite (u8 screen, u8 obj_number)
	Delete a given sprite. If it is the only one to use it's gfx, it'll be deleted too.

static void	PA_SetRotset (u8 screen, u8 rotset, s16 angle, u16 zoomx, u16 zoomy)
	Rotate and zoom a sprite.

static void	PA_SetRotsetNoZoom (u8 screen, u8 rotset, s16 angle)
	Rotate a sprite without zooming. It's a bit faster than the normal PA_SetRotset function.

static void	PA_SetRotsetNoAngle (u8 screen, u8 rotset, u16 zoomx, u16 zoomy)
	Zoom a sprite without rotating. It's a bit faster than the normal PA_SetRotset function.

static void	PA_SetSpriteXY (u8 screen, u8 sprite, s16 x, s16 y)
	Set the X and Y position of a sprite on screen.

static void	PA_Set16bitSpriteAlpha (u8 screen, u8 sprite, u8 alpha)
	Set the X position of a sprite on screen.

static void	PA_SetSpriteAnimEx (u8 screen, u8 sprite, u8 lx, u8 ly, u8 ncolors, s16 animframe)
	Set the animation frame for a given sprite. This function is faster than the normal PA_SetSpriteAnim because it doesn't have to lookup the sprite dimensions...

static void	PA_SetSpriteAnim (u8 screen, u8 sprite, s16 animframe)
	Set the animation frame for a given sprite. Same as PA_SetSpriteAnimEx, but a bit slower and easier to use...

void	PA_StartSpriteAnimEx (u8 screen, u8 sprite, s16 firstframe, s16 lastframe, s16 speed, u8 type, s16 ncycles)
	Start a sprite animation. Once started, it continues on and on by itself until you stop it !

static void	PA_StartSpriteAnim (u8 screen, u8 sprite, s16 firstframe, s16 lastframe, s16 speed)
	Start a sprite animation. Once started, it continues on and on by itself until you stop it !

static void	PA_StopSpriteAnim (u8 screen, u8 sprite)
	Stop a sprite animation.

static void	PA_SetSpriteAnimFrame (u8 screen, u8 sprite, u16 frame)
	Set the current animation frame number.

static u16	PA_GetSpriteAnimFrame (u8 screen, u8 sprite)
	Returns the current animation frame number.

static void	PA_SetSpriteAnimSpeed (u8 screen, u8 sprite, s16 speed)
	Set the current animation speed.

static u16	PA_GetSpriteAnimSpeed (u8 screen, u8 sprite)
	Returns the current animation speed.

static void	PA_SetSpriteNCycles (u8 screen, u8 sprite, s32 NCycles)
	Set the current animation cycles left (-1 for inifinite loop)

static s32	PA_GetSpriteNCycles (u8 screen, u8 sprite)
	Returns the current number of animation cycles left.

static void	PA_SpriteAnimPause (u8 screen, u8 sprite, u8 pause)
	Pause or UnPause a sprite animation.

static void	PA_SetSpritePixel (u8 screen, u8 sprite, u8 x, u8 y, u8 color)
	Set a sprite's pixel to a given palette color. Like PA_SetSpritePixelEx, with less options, but a little slower.

static u8	PA_GetSpritePixel (u8 screen, u8 sprite, u8 x, u8 y)
	Get a sprite's pixel color. Like PA_GetSpritePixelEx, with less options, but a little slower.

static u8	PA_GetSprite16cPixel (u8 screen, u8 sprite, u8 x, u8 y)
	Get a 16 color sprite's pixel color.

void	PA_InitSpriteDraw (u8 screen, u8 sprite)
	Initialise a sprite to be able to draw on it !

static void	PA_InitAllSpriteDraw (void)
	Initialise all the onscreen sprites to draw on them.

void	PA_InitSpriteExtPrio (u8 SpritePrio)
	Enable the PAlib sprite priority system. Slower than the normal priority system, but offering 256 levels of priority for the sprites (overrides the sprite number's priority)

Detailed Description

Load Sprite, move them around, rotate them...

Macro Definition Documentation

◆ PA_UpdateSpriteGfx

#define PA_UpdateSpriteGfx	(	screen,
		obj_number,
		obj_data
	)	PA_UpdateGfx(screen, PA_GetSpriteGfx(screen, obj_number), obj_data)

Update the Gfx of a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number in the sprite system
obj_data	Gfx to load

◆ PA_SetSpriteRotEnable

#define PA_SetSpriteRotEnable	(	screen,
		sprite,
		rotset
	)	do{PA_obj[screen][sprite].atr0 \|= OBJ_ROT; PA_obj[screen][sprite].atr1 = (PA_obj[screen][sprite].atr1 & ALL_BUT_ROTSET) + ((rotset) << 9);}while(0)

Rotate and zoom a sprite.

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite you want to rotate
rotset	Rotset you want to give to that sprite (0-31). You can apparently use a rotset for multiple sprites if zoomed/rotated identically...

◆ PA_SetSpriteRotDisable

#define PA_SetSpriteRotDisable	(	screen,
		sprite
	)	do{PA_obj[screen][sprite].atr0 &= ALL_BUT(OBJ_ROT); PA_obj[screen][sprite].atr1 &= ALL_BUT_ROTSET;}while(0)

Stop rotating and zooming a sprite.

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite you want to rotate

◆ PA_SetSpriteX

#define PA_SetSpriteX	(	screen,
		obj,
		x
	)	PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(PA_OBJ_X)) + ((x) & PA_OBJ_X)

Set the X position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
x	X position

◆ PA_GetSpriteX

#define PA_GetSpriteX	(	screen,
		obj
	)	(PA_obj[screen][obj].atr1 & (PA_OBJ_X))

Get the X position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteY

#define PA_SetSpriteY	(	screen,
		obj,
		y
	)	PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(PA_OBJ_Y)) + ((y) & PA_OBJ_Y)

Set the Y position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
y	Y position

◆ PA_GetSpriteY

#define PA_GetSpriteY	(	screen,
		obj
	)	(PA_obj[screen][obj].atr0 & PA_OBJ_Y)

Get the Y position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpritePal

#define PA_SetSpritePal	(	screen,
		obj,
		pal
	)	PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT_PAL) + ((pal) << 12)

Set the sprite's palette number.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
pal	Palette number (0 - 15)

◆ PA_GetSpritePal

#define PA_GetSpritePal	(	screen,
		obj
	)	(PA_obj[screen][obj].atr2 >> 12)

Get thepalette used by a sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteDblsize

#define PA_SetSpriteDblsize	(	screen,
		obj,
		dblsize
	)	PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(DBLSIZE)) + ((dblsize) << 9)

Enable or disable double size for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
dblsize	1 to enable doublesize, 0 to disable it...

◆ PA_GetSpriteDblsize

#define PA_GetSpriteDblsize	(	screen,
		obj
	)	((PA_obj[screen][obj].atr0 & DBLSIZE) >> 9)

Get the double size state for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteColors

#define PA_SetSpriteColors	(	screen,
		sprite,
		n_colors
	)	PA_obj[screen][sprite].atr0 = (PA_obj[screen][sprite].atr0 & ALL_BUT(N_COLORS)) + ((n_colors) << 13)

Change the sprite's color mode.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system
n_colors	0 for 16 colors, 1 for 256

◆ PA_GetSpriteColors

#define PA_GetSpriteColors	(	screen,
		sprite
	)	((PA_obj[screen][sprite].atr0 & N_COLORS) >> 13)

Get a sprite's color mode.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system

◆ PA_SetSpriteMode

#define PA_SetSpriteMode	(	screen,
		sprite,
		obj_mode
	)	PA_obj[screen][sprite].atr0 = (PA_obj[screen][sprite].atr0 & ALL_BUT(OBJ_MODE)) + ((obj_mode) << 10)

Set the sprite's mode : 0 for normal, 1 for alpha blending, 2 for window.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system
obj_mode	Object mode : 0 for normal, 1 for alpha blending, 2 for window ; not working yet

◆ PA_GetSpriteMode

#define PA_GetSpriteMode	(	screen,
		obj
	)	((PA_obj[screen][obj].atr0 & OBJ_MODE) >> 10)

Get the sprite's mode : 0 for normal, 1 for alpha blending, 2 for window.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteMosaic

#define PA_SetSpriteMosaic	(	screen,
		obj,
		mosaic
	)	PA_obj[screen][obj].atr0 = (PA_obj[screen][obj].atr0 & ALL_BUT(OBJ_MOSAIC)) + ((mosaic) << 12)

Enable or disable mosaic mode for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
mosaic	Set mosaic on (1) or off (0)

◆ PA_GetSpriteMosaic

#define PA_GetSpriteMosaic	(	screen,
		obj
	)	((PA_obj[screen][obj].atr0 & OBJ_MOSAIC) >> 12)

Get the mosaic mode for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteHflip

#define PA_SetSpriteHflip	(	screen,
		obj,
		hflip
	)	PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(OBJ_HFLIP)) + ((hflip) << 12)

Enable or disable horizontal flip for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
hflip	Horizontal flip, 1 to enable, 0 to disable...

◆ PA_GetSpriteHflip

#define PA_GetSpriteHflip	(	screen,
		obj
	)	((PA_obj[screen][obj].atr1 & OBJ_HFLIP) >> 12)

Get the horizontal flip state for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteVflip

#define PA_SetSpriteVflip	(	screen,
		obj,
		vflip
	)	PA_obj[screen][obj].atr1 = (PA_obj[screen][obj].atr1 & ALL_BUT(OBJ_VFLIP)) + ((vflip) << 13)

Enable or disable vertical flip for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
vflip	Vertical flip, 1 to enable, 0 to disable...

◆ PA_GetSpriteVflip

#define PA_GetSpriteVflip	(	screen,
		obj
	)	((PA_obj[screen][obj].atr1 & OBJ_VFLIP) >> 13)

Get the vertical flip state for a given sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpriteGfx

#define PA_SetSpriteGfx	(	screen,
		obj,
		gfx
	)	PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT(OBJ_GFX)) + ((gfx) & OBJ_GFX)

Change the gfx used by a sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
gfx	Gfx number ; you can get one by using PA_CreateGfx or PA_GetSpriteGfx(obj_number);

◆ PA_GetSpriteGfx

#define PA_GetSpriteGfx	(	screen,
		obj
	)	(PA_obj[screen][obj].atr2 & OBJ_GFX)

Get the gfx used by a sprite.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_SetSpritePrio

#define PA_SetSpritePrio	(	screen,
		obj,
		prio
	)	PA_obj[screen][obj].atr2 = (PA_obj[screen][obj].atr2 & ALL_BUT(OBJ_PRIO)) + ((prio) << 10)

Set a sprite's Background priority.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
prio	Sprite priority : 0 is over background 0, 1 over Bg 1, etc... (0-3)

◆ PA_GetSpritePrio

#define PA_GetSpritePrio	(	screen,
		obj
	)	((PA_obj[screen][obj].atr2 & OBJ_PRIO) >> 10)

Get a sprite's Background priority.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system

◆ PA_GetSpriteLx

#define PA_GetSpriteLx	(	screen,
		sprite
	)	PA_size[PA_obj[screen][sprite].atr0 >> 14][PA_obj[screen][sprite].atr1 >> 14].lx

Get a sprite's length.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system

◆ PA_GetSpriteLy

#define PA_GetSpriteLy	(	screen,
		sprite
	)	PA_size[PA_obj[screen][sprite].atr0 >> 14][PA_obj[screen][sprite].atr1 >> 14].ly

Get a sprite's height.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system

◆ PA_CloneSprite

#define PA_CloneSprite	(	screen,
		obj,
		target
	)	do{PA_obj[screen][obj].atr0 = PA_obj[screen][target].atr0; PA_obj[screen][obj].atr1 = PA_obj[screen][target].atr1; PA_obj[screen][obj].atr2 = PA_obj[screen][target].atr2; ++obj_per_gfx[screen][PA_GetSpriteGfx(screen, target)];}while(0)

Clone a sprite. Works only for sprites on the same screen.

Parameters

screen	Chose de screen (0 or 1)
obj	Object number in the sprite system
target	Target sprite to clone

Function Documentation

◆ PA_CreateGfx()

u16 PA_CreateGfx	(	u8	screen,
		void *	obj_data,
		u8	obj_shape,
		u8	obj_size,
		u8	color_mode
	)

Load in mémory a gfx to use later on for a sprite. Returns the gfx's number in memory.

Parameters

screen	Chose de screen (0 or 1)
obj_data	Gfx to load
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
color_mode	256 or 16 color mode (1 or 0), or 2 for 16bit

◆ PA_CreateSprite()

static inline void PA_CreateSprite	(	u8	screen,
		u8	obj_number,
		void *	obj_data,
		u8	obj_shape,
		u8	obj_size,
		u8	color_mode,
		u8	palette,
		s16	x,
		s16	y
	)

inlinestatic

Create a sprite with it's gfx. This is the simple version of the function.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_data	Gfx to load
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
color_mode	256 or 16 color mode (1 or 0).
palette	Palette to use (0-15).
x	X position of the sprite
y	Y position of the sprite

◆ PA_CreateSpriteEx()

static inline void PA_CreateSpriteEx	(	u8	screen,
		u8	obj_number,
		void *	obj_data,
		u8	obj_shape,
		u8	obj_size,
		u8	color_mode,
		u8	palette,
		u8	obj_mode,
		u8	mosaic,
		u8	hflip,
		u8	vflip,
		u8	prio,
		u8	dblsize,
		s16	x,
		s16	y
	)

inlinestatic

Create a sprite with it's gfx. This is the complex version of the function.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_data	Gfx to load
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
color_mode	256 or 16 color mode (1 or 0).
palette	Palette to use (0-15).
obj_mode	Object mode (normal, transparent, window). Not functionnal yet, please leave to 0 for now
mosaic	Activate Mosaic for the sprite or not. Not yet functionnal either :p
hflip	Horizontal flip on or off...
vflip	Vertical flip...
prio	Sprite priority regarding backgrounds : in front of which background to show it (0-3)
dblsize	Double the possible sprite size. Activate only if you are going to rotate and zoom in the sprite
x	X position of the sprite
y	Y position of the sprite

◆ PA_Create16bitSpriteEx()

static inline void PA_Create16bitSpriteEx	(	u8	screen,
		u8	obj_number,
		void *	obj_data,
		u8	obj_shape,
		u8	obj_size,
		u8	mosaic,
		u8	hflip,
		u8	vflip,
		u8	prio,
		u8	dblsize,
		s16	x,
		s16	y
	)

inlinestatic

Create a 16 bit sprite with it's gfx. This is the complex version of the function. Warning : a 16bit sprite MUST be 128 pixels large, even if you sprite only takes up a small part on the left...

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_data	Gfx to load
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
mosaic	Activate Mosaic for the sprite or not. Not yet functionnal either :p
hflip	Horizontal flip on or off...
vflip	Vertical flip...
prio	Sprite priority regarding backgrounds : in front of which background to show it (0-3)
dblsize	Double the possible sprite size. Activate only if you are going to rotate and zoom in the sprite
x	X position of the sprite
y	Y position of the sprite

◆ PA_Create16bitSpriteFromGfx()

static inline void PA_Create16bitSpriteFromGfx	(	u8	screen,
		u8	obj_number,
		u16	gfx,
		u8	obj_shape,
		u8	obj_size,
		s16	x,
		s16	y
	)

inlinestatic

Create a 16 bit sprite using a given gfx.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
gfx	Gfx to use
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
x	X position of the sprite
y	Y position of the sprite

◆ PA_Create16bitSprite()

static inline void PA_Create16bitSprite	(	u8	screen,
		u8	obj_number,
		void *	obj_data,
		u8	obj_shape,
		u8	obj_size,
		s16	x,
		s16	y
	)

inlinestatic

Create a 16 bit sprite with it's gfx. This is the simple version of the function. Warning : a 16bit sprite MUST be 128 pixels large, even if you sprite only takes up a small part on the left...

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_data	Gfx to load
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
x	X position of the sprite
y	Y position of the sprite

◆ PA_CreateSpriteFromGfx()

static inline void PA_CreateSpriteFromGfx	(	u8	screen,
		u8	obj_number,
		u16	obj_gfx,
		u8	obj_shape,
		u8	obj_size,
		u8	color_mode,
		u8	palette,
		s16	x,
		s16	y
	)

inlinestatic

Create a sprite with it's gfx. This is the simple version of the function.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_gfx	Memory gfx to use. Get it by using PA_GetSpriteGfx or PA_CreateGfx
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
color_mode	256 or 16 color mode (1 or 0).
palette	Palette to use (0-15).
x	X position of the sprite
y	Y position of the sprite

◆ PA_CreateSpriteExFromGfx()

static inline void PA_CreateSpriteExFromGfx	(	u8	screen,
		u8	obj_number,
		u16	obj_gfx,
		u8	obj_shape,
		u8	obj_size,
		u8	color_mode,
		u8	palette,
		u8	obj_mode,
		u8	mosaic,
		u8	hflip,
		u8	vflip,
		u8	prio,
		u8	dblsize,
		s16	x,
		s16	y
	)

inlinestatic

Create a sprite with it's gfx. This is the complex version of the function.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Object number you want to use (0-127 for each screen seperately).
obj_gfx	Memory gfx to use. Get it by using PA_GetSpriteGfx or PA_CreateGfx
obj_shape	Object shape, from 0 to 2. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
obj_size	Object size. Use the OBJ_SIZE_32X32 (...) macros for object shape and obj_size...
color_mode	256 or 16 color mode (1 or 0).
palette	Palette to use (0-15).
obj_mode	Object mode (normal, transparent, window). Not functionnal yet, please leave to 0 for now
mosaic	Activate Mosaic for the sprite or not. Not yet functionnal either :p
hflip	Horizontal flip on or off...
vflip	Vertical flip...
prio	Sprite priority regarding backgrounds : in front of which background to show it (0-3)
dblsize	Double the possible sprite size. Activate only if you are going to rotate and zoom in the sprite
x	X position of the sprite
y	Y position of the sprite

◆ PA_UpdateGfx()

static inline void PA_UpdateGfx	(	u8	screen,
		u16	gfx_number,
		void *	obj_data
	)

inlinestatic

Update a given Gfx.

Parameters

screen	Chose de screen (0 or 1)
gfx_number	Gfx number in memory
obj_data	Gfx to load

◆ PA_UpdateGfxAndMem()

static inline void PA_UpdateGfxAndMem	(	u8	screen,
		u8	gfx_number,
		void *	obj_data
	)

inlinestatic

Update the Gfx of a given sprite and updates the PAlib animation pointer... Only for advanced users.

Parameters

screen	Chose de screen (0 or 1)
gfx_number	Gfx number in memory
obj_data	Gfx to load

◆ PA_DeleteGfx()

void PA_DeleteGfx	(	u8	screen,
		u16	obj_gfx
	)

Delete a given Gfx. If a sprite uses this gfx, it'll become invisible.

Parameters

screen	Chose de screen (0 or 1)
obj_gfx	Gfx number in memory

◆ PA_DeleteSprite()

void PA_DeleteSprite	(	u8	screen,
		u8	obj_number
	)

Delete a given sprite. If it is the only one to use it's gfx, it'll be deleted too.

Parameters

screen	Chose de screen (0 or 1)
obj_number	Sprite number

◆ PA_SetRotset()

static inline void PA_SetRotset	(	u8	screen,
		u8	rotset,
		s16	angle,
		u16	zoomx,
		u16	zoomy
	)

inlinestatic

Rotate and zoom a sprite.

Parameters

screen	Chose de screen (0 or 1)
rotset	Rotset you want to change. To give a sprite a rotset, use PA_SetSpriteRotEnable...
angle	Angle, between 0 and 512 (not 360, be carefull)
zoomx	Horizontal zoom. 256 is unzoomed, 512 is 2 times smaller, and 128 twice as big... So adjust at will ! :p
zoomy	Vertical zoom. 256 is unzoomed, 512 is 2 times smaller, and 128 twice as big... So adjust at will ! :p

◆ PA_SetRotsetNoZoom()

static inline void PA_SetRotsetNoZoom	(	u8	screen,
		u8	rotset,
		s16	angle
	)

inlinestatic

Rotate a sprite without zooming. It's a bit faster than the normal PA_SetRotset function.

Parameters

screen	Chose de screen (0 or 1)
rotset	Rotset you want to change. To give a sprite a rotset, use PA_SetSpriteRotEnable...
angle	Angle, between 0 and 512 (not 360, be carefull)

◆ PA_SetRotsetNoAngle()

static inline void PA_SetRotsetNoAngle	(	u8	screen,
		u8	rotset,
		u16	zoomx,
		u16	zoomy
	)

inlinestatic

Zoom a sprite without rotating. It's a bit faster than the normal PA_SetRotset function.

Parameters

screen	Chose de screen (0 or 1)
rotset	Rotset you want to change. To give a sprite a rotset, use PA_SetSpriteRotEnable...
zoomx	Horizontal zoom. 256 is unzoomed, 512 is 2 times smaller, and 128 twice as big... So adjust at will ! :p
zoomy	Vertical zoom. 256 is unzoomed, 512 is 2 times smaller, and 128 twice as big... So adjust at will ! :p

◆ PA_SetSpriteXY()

static inline void PA_SetSpriteXY	(	u8	screen,
		u8	sprite,
		s16	x,
		s16	y
	)

inlinestatic

Set the X and Y position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
x	X position
y	X position

◆ PA_Set16bitSpriteAlpha()

static inline void PA_Set16bitSpriteAlpha	(	u8	screen,
		u8	sprite,
		u8	alpha
	)

inlinestatic

Set the X position of a sprite on screen.

Parameters

screen	Chose de screen (0 or 1)
sprite	Object number in the sprite system, only for 16bit sprites
alpha	Alpha parameter, 0-15

◆ PA_SetSpriteAnimEx()

static inline void PA_SetSpriteAnimEx	(	u8	screen,
		u8	sprite,
		u8	lx,
		u8	ly,
		u8	ncolors,
		s16	animframe
	)

inlinestatic

Set the animation frame for a given sprite. This function is faster than the normal PA_SetSpriteAnim because it doesn't have to lookup the sprite dimensions...

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
lx	Sprite width (8, 16, 32, 64)
ly	Sprite height (8, 16, 32, 64)
ncolors	Sprite color mode (0 for 16 colors, 1 for 256)
animframe	Sprite animation frame (0, 1, 2, etc...)

◆ PA_SetSpriteAnim()

static inline void PA_SetSpriteAnim	(	u8	screen,
		u8	sprite,
		s16	animframe
	)

inlinestatic

Set the animation frame for a given sprite. Same as PA_SetSpriteAnimEx, but a bit slower and easier to use...

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
animframe	Sprite animation frame (0, 1, 2, etc...)

◆ PA_StartSpriteAnimEx()

void PA_StartSpriteAnimEx	(	u8	screen,
		u8	sprite,
		s16	firstframe,
		s16	lastframe,
		s16	speed,
		u8	type,
		s16	ncycles
	)

Start a sprite animation. Once started, it continues on and on by itself until you stop it !

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
firstframe	First frame of the animation sequence, most of the time 0...
lastframe	Last frame to be displayed. When it gets there, it loops back to the first frame
speed	Speed, in frames per second. So speed 1 would mean 1 image per second, so 1 image every game frame
type	Defines how you want it to loop. ANIM_LOOP (0) for a normal loop, ANIM_UPDOWN (1) for back and forth animation.
ncycles	Number of animation cycles before stopping. If using ANIM_UPDOWN, it takes 2 cycles to come back to the original image

◆ PA_StartSpriteAnim()

static inline void PA_StartSpriteAnim	(	u8	screen,
		u8	sprite,
		s16	firstframe,
		s16	lastframe,
		s16	speed
	)

inlinestatic

Start a sprite animation. Once started, it continues on and on by itself until you stop it !

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
firstframe	First frame of the animation sequence, most of the time 0...
lastframe	Last frame to be displayed. When it gets there, it loops back to the first frame
speed	Speed, in frames per second. So speed 1 would mean 1 image per second, so 1 image every game frame

◆ PA_StopSpriteAnim()

static inline void PA_StopSpriteAnim	(	u8	screen,
		u8	sprite
	)

inlinestatic

Stop a sprite animation.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system

◆ PA_SetSpriteAnimFrame()

static inline void PA_SetSpriteAnimFrame	(	u8	screen,
		u8	sprite,
		u16	frame
	)

inlinestatic

Set the current animation frame number.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
frame	Frame number to use...

◆ PA_GetSpriteAnimFrame()

static inline u16 PA_GetSpriteAnimFrame	(	u8	screen,
		u8	sprite
	)

inlinestatic

Returns the current animation frame number.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system

◆ PA_SetSpriteAnimSpeed()

static inline void PA_SetSpriteAnimSpeed	(	u8	screen,
		u8	sprite,
		s16	speed
	)

inlinestatic

Set the current animation speed.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
speed	Speed, in fps...

◆ PA_GetSpriteAnimSpeed()

static inline u16 PA_GetSpriteAnimSpeed	(	u8	screen,
		u8	sprite
	)

inlinestatic

Returns the current animation speed.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system

◆ PA_SetSpriteNCycles()

static inline void PA_SetSpriteNCycles	(	u8	screen,
		u8	sprite,
		s32	NCycles
	)

inlinestatic

Set the current animation cycles left (-1 for inifinite loop)

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
NCycles	Number of cycles

◆ PA_GetSpriteNCycles()

static inline s32 PA_GetSpriteNCycles	(	u8	screen,
		u8	sprite
	)

inlinestatic

Returns the current number of animation cycles left.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system

◆ PA_SpriteAnimPause()

static inline u16 PA_SpriteAnimPause	(	u8	screen,
		u8	sprite,
		u8	pause
	)

inlinestatic

Pause or UnPause a sprite animation.

Parameters

screen	Chose de screen (0 or 1)
sprite	sprite number in the sprite system
pause	1 for pause, 0 for unpause

◆ PA_SetSpritePixel()

static inline void PA_SetSpritePixel	(	u8	screen,
		u8	sprite,
		u8	x,
		u8	y,
		u8	color
	)

inlinestatic

Set a sprite's pixel to a given palette color. Like PA_SetSpritePixelEx, with less options, but a little slower.

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite number in the sprite system
x	X coordinate of the pixel to change
y	Y coordinate of the pixel to change
color	New palette color to put

◆ PA_GetSpritePixel()

static inline u8 PA_GetSpritePixel	(	u8	screen,
		u8	sprite,
		u8	x,
		u8	y
	)

inlinestatic

Get a sprite's pixel color. Like PA_GetSpritePixelEx, with less options, but a little slower.

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite number in the sprite system
x	X coordinate of the pixel
y	Y coordinate of the pixel

◆ PA_GetSprite16cPixel()

static inline u8 PA_GetSprite16cPixel	(	u8	screen,
		u8	sprite,
		u8	x,
		u8	y
	)

inlinestatic

Get a 16 color sprite's pixel color.

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite number in the sprite system
x	X coordinate of the pixel
y	Y coordinate of the pixel

◆ PA_InitSpriteDraw()

void PA_InitSpriteDraw	(	u8	screen,
		u8	sprite
	)

Initialise a sprite to be able to draw on it !

Parameters

screen	Chose de screen (0 or 1)
sprite	Sprite number in the sprite system

◆ PA_InitSpriteExtPrio()

void PA_InitSpriteExtPrio ( u8 SpritePrio )

Enable the PAlib sprite priority system. Slower than the normal priority system, but offering 256 levels of priority for the sprites (overrides the sprite number's priority)

Parameters

SpritePrio 1 for on, 0 for off...

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ PA_UpdateSpriteGfx

◆ PA_SetSpriteRotEnable

◆ PA_SetSpriteRotDisable

◆ PA_SetSpriteX

◆ PA_GetSpriteX

◆ PA_SetSpriteY

◆ PA_GetSpriteY

◆ PA_SetSpritePal

◆ PA_GetSpritePal

◆ PA_SetSpriteDblsize

◆ PA_GetSpriteDblsize

◆ PA_SetSpriteColors

◆ PA_GetSpriteColors

◆ PA_SetSpriteMode

◆ PA_GetSpriteMode

◆ PA_SetSpriteMosaic

◆ PA_GetSpriteMosaic

◆ PA_SetSpriteHflip

◆ PA_GetSpriteHflip

◆ PA_SetSpriteVflip

◆ PA_GetSpriteVflip

◆ PA_SetSpriteGfx

◆ PA_GetSpriteGfx

◆ PA_SetSpritePrio

◆ PA_GetSpritePrio

◆ PA_GetSpriteLx

◆ PA_GetSpriteLy

◆ PA_CloneSprite

Function Documentation

◆ PA_CreateGfx()

◆ PA_CreateSprite()

◆ PA_CreateSpriteEx()

◆ PA_Create16bitSpriteEx()

◆ PA_Create16bitSpriteFromGfx()

◆ PA_Create16bitSprite()

◆ PA_CreateSpriteFromGfx()

◆ PA_CreateSpriteExFromGfx()

◆ PA_UpdateGfx()

◆ PA_UpdateGfxAndMem()

◆ PA_DeleteGfx()

◆ PA_DeleteSprite()

◆ PA_SetRotset()

◆ PA_SetRotsetNoZoom()

◆ PA_SetRotsetNoAngle()

◆ PA_SetSpriteXY()

◆ PA_Set16bitSpriteAlpha()

◆ PA_SetSpriteAnimEx()

◆ PA_SetSpriteAnim()

◆ PA_StartSpriteAnimEx()

◆ PA_StartSpriteAnim()

◆ PA_StopSpriteAnim()

◆ PA_SetSpriteAnimFrame()

◆ PA_GetSpriteAnimFrame()

◆ PA_SetSpriteAnimSpeed()

◆ PA_GetSpriteAnimSpeed()

◆ PA_SetSpriteNCycles()

◆ PA_GetSpriteNCycles()

◆ PA_SpriteAnimPause()

◆ PA_SetSpritePixel()

◆ PA_GetSpritePixel()

◆ PA_GetSprite16cPixel()

◆ PA_InitSpriteDraw()

◆ PA_InitSpriteExtPrio()