*******************************************************************************
* sprite.library.I  Written by Readysoft.
* Copyright 1993,1994 RS.  All rights reserved.  1993.08.12.-1994.05.18.
* v2.0.
*******************************************************************************

*******************************************************************************
* Macros
*******************************************************************************

;------------------------------------------------------------------------------
; SpriteName Macro
;------------------------------------------------------------------------------
SPR.NAM		MACRO
		DC.B	'sprite.library',0
		EVEN
		ENDM

*******************************************************************************
* Constant Definitions
*******************************************************************************

;------------------------------------------------------------------------------
; SpriteSetHeader Structure
;------------------------------------------------------------------------------
		RSRESET
spr_sh_Ident	RS.L	1				identifier word 'SPRS'
spr_sh_Version	RS.L	1				version code
spr_sh_Size	RS.L	1				sprite set size
spr_sh_SpriteDS	RS.L	1				sprite data size
spr_sh_AnSprDS	RS.L	1				animsprite data size
spr_sh_AnimDS	RS.L	1				anim data size
spr_sh_Sprites	RS.B	1				number of sprites
spr_sh_AnSprs	RS.B	1				number of animsprites
spr_sh_Anims	RS.B	1				number of anims
spr_sh_Inited	RS.B	1				initialized
spr_sh_SpriteDP	RS.L	1				sprite data ptr
spr_sh_AnSprDP	RS.L	1				animsprite data ptr
spr_sh_AnimDP	RS.L	1				anim data ptr
spr_sh_IndexT	RS.B	256				index table
spr_sh_SpriteT	RS.B	256				sprite table
spr_sh_AnSprT	RS.B	256				animsprite table
spr_sh_SizeOf	RS.B	0

;------------------------------------------------------------------------------
; Sprite Structure
;------------------------------------------------------------------------------
		RSRESET
spr_sp_Code	RS.B	1				identifier code
spr_sp_NotUsed	RS.B	9				not used area
spr_sp_Height	RS.W	1				height in pixel
spr_sp_Data	RS.L	1				ptr to DMA data
spr_sp_SizeOf	RS.B	0

		IF	spr_sp_SizeOf<>16
		PRINTT	'** Incorrect spr_sp_SizeOf !'
		ENDC

;------------------------------------------------------------------------------
; SpriteAnim Structure
;------------------------------------------------------------------------------
		RSRESET
spr_an_Code	RS.B	1				identifier code
spr_an_Speed	RS.B	1				speed (vblank/change)
spr_an_SpeedCnt	RS.B	1				speed counter
spr_an_PhaseCnt	RS.B	1				phase counter
spr_an_Queue	RS.L	1				ptr to sprite queue
spr_an_SizeOf	RS.B	0

		IF	spr_an_SizeOf<>8
		PRINTT	'** Incorrect spr_an_SizeOf !'
		ENDC

;------------------------------------------------------------------------------
; SpriteInfo Structure
;------------------------------------------------------------------------------
		RSRESET
spr_si_XPos	RS.W	1				sprite xpos
spr_si_YPos	RS.W	1				sprite ypos
spr_si_Flags	RS.W	1				flags
spr_si_Height	RS.W	1				height
spr_si_Data	RS.L	1				ptr to DMA data
spr_si_Size	RS.L	1				size of DMA data
spr_si_SizeOf	RS.B	0

;------------------------------------------------------------------------------
; Flag Bit Definitions
;------------------------------------------------------------------------------
spr_fl_b_Attach	EQU	7				attach control

;------------------------------------------------------------------------------
; Flag Bit-Value Definitions
;------------------------------------------------------------------------------
spr_fl_Attach	EQU	1<<spr_fl_b_Attach		attach control

;------------------------------------------------------------------------------
; Index Codes
;------------------------------------------------------------------------------
spr_in_NotUsed	EQU	0
spr_in_Sprite	EQU	1
spr_in_Anim	EQU	2

;------------------------------------------------------------------------------
; AnimControl Codes
;------------------------------------------------------------------------------
spr_ac_End	EQU	0				end of queue
spr_ac_Wait	EQU	1				wait
spr_ac_Speed	EQU	2				set speed

;------------------------------------------------------------------------------
; Error Codes
;------------------------------------------------------------------------------
spr_er_OK	EQU	$00000000			all right
spr_er_NoSprS	EQU	$00830001			not a sprs header
spr_er_Version	EQU	$00830002			different version
spr_er_Inited	EQU	$00830003			not initialized
spr_er_Code	EQU	$00830004			incorrect code
spr_er_Index	EQU	$00830005			incorrect index
spr_er_NoMem	EQU	$00830006			not enough memory
spr_er_NoCList	EQU	$00830007			no CList
spr_er_UnDef	EQU	$8083ffff			undefined error

*******************************************************************************
* Varibles
*******************************************************************************
		RSRESET
spr_SprSTable	RS.L	256				SpriteSet pointers
spr_SInfo0	RS.B	spr_si_SizeOf			sprite info
spr_SInfo1	RS.B	spr_si_SizeOf
spr_SInfo2	RS.B	spr_si_SizeOf
spr_SInfo3	RS.B	spr_si_SizeOf
spr_SInfo4	RS.B	spr_si_SizeOf
spr_SInfo5	RS.B	spr_si_SizeOf
spr_SInfo6	RS.B	spr_si_SizeOf
spr_SInfo7	RS.B	spr_si_SizeOf
spr_MinX	RS.W	1				border
spr_MinY	RS.W	1
spr_MaxX	RS.W	1
spr_MaxY	RS.W	1
spr_CListAddr	RS.L	1				address of sprite CList
spr_SizeOf	RS.B	0

*******************************************************************************
* Routine Offsets
*******************************************************************************
		RSRESET
		RS.B	-6
spr_Init	RS.B	-6
spr_InitSprS	RS.B	-6
spr_SetSprite	RS.B	-6
spr_GetSprite	RS.B	-6
spr_FreeSprite	RS.B	-6
spr_MoveSprite	RS.B	-6
spr_SetSprPos	RS.B	-6
spr_SetBorder	RS.B	-6
spr_AnimStep	RS.B	-6
spr_InsertCL	RS.B	-6
spr_RefreshCL	RS.B	-6