Package RASCAL.Sprite

Description	Sprite and sprite area handling.
Author	bbracke
Date	2005/11/21 20:14:33
Revision	1.1

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
Kernel
Ada.Finalization
System.Unsigned_Types
System
Interfaces.C
RASCAL.Memory
RASCAL.Utility
RASCAL.Heap

Use clauses
System
Interfaces.C
Heap
Memory

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Sprite_Area_Ptr	access Sprite_Area_Type
Sprite_List_Type	array (Positive) of SpriteName
Sprite_List_Pointer	access Sprite_List_Type
SpriteName	String (1..12)
Sprite_Area_Type	new Ada.Finalization.Controlled with private

Exceptions
Invalid_SpriteArea

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Get_WimpPools	procedure
Get wimp pool addresses.

*Parameter name*	*Type*	*Mode*	*Default*
Priority	Address	out
High	Address	out
Low	Address	out

Is_PriorityPool	function
*Return*	Boolean
Returns true if there is a priority spritepool.

Count	function
*Return*	Natural
Returns the number of sprites in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in

Count	function
*Return*	Natural
Returns the number of sprites in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Address	in

Get_Name	function
*Return*	String
Returns the name of the sprite SpriteNr in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
SpriteNr	Positive	in

Get_Name	function
*Return*	String
Returns the name of the sprite SpriteNr in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Address	in
SpriteNr	Positive	in

Get_List	function
*Return*	Sprite_List_Type
Returns an array with the names of all sprites in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in

Get_List	function
*Return*	Sprite_List_Type
Returns an array with the names of all sprites in all WIMP spritepools. Names can appear more than once in the list if a sprite with that name is in more than one sprite pools.

Create	procedure
Creates a new blank sprite in SpriteArea

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in out
PixelWidth	Positive	in	640
PixelHeight	Positive	in	480
ModeNumber	System.Unsigned_Types.Unsigned	in	2 ** 5
Name	String	in	"Untitled"
Palette	Boolean	in	True

Save_SpriteArea	procedure
Save the SpriteArea as a spritefile to Path

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Path	String	in

Is_Sprite	function
*Return*	Boolean
Does the sprite (Name) exist in the SpriteArea ?

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Name	String	in

Is_Sprite	function
*Return*	boolean
Does the sprite (Name) exist in the SpriteArea ?

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Address	in
Name	string	in

Is_Sprite	function
*Return*	Boolean
Does the sprite (Name) exist in the Wimp sprite pool ?

*Parameter name*	*Type*	*Mode*	*Default*
Name	String	in

Get_Info	procedure
Return information about a sprite.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Address	in
Name	String	in
Width	Natural	out
Height	Natural	out
ModeOrType	Integer	out

Plot	procedure
Plot sprite (Name) in SpriteArea on to the screen with its bottom left hand corner at the graphics cursor.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Name	String	in

Plot	procedure
Plot sprite (Name) in SpriteArea on to the screen at X_Position, Y_Position.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Name	String	in
X_Position	Integer	in
Y_Position	Integer	in

Rename	procedure
Renames sprite in SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Old_Name	String	in
New_Name	String	in

Delete	procedure
Deletes the named (Name) sprite in the SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
Name	String	in

Save	procedure
Save a single sprite (SpriteNr) from a SpriteArea as a spritefile (Path).

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
SpriteNr	Positive	in
Path	String	in

Copy	procedure
Copy one (spritenr) sprite from one Spritearea (source) to another (target).

*Parameter name*	*Type*	*Mode*	*Default*
Source	Sprite_Area_Type	in
SpriteNr	Positive	in
Target	Sprite_Area_Type	in out

Add	procedure
Adds sprites from spritefile pointed to by 'Path' to existing SpriteArea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in out
Path	String	in

Output_To_Sprite	procedure
Switch output to sprite.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
SpriteName	String	in
Save_Area	Integer	in	0

Output_To_Mask	procedure
Switch output to the sprite mask.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in
SpriteName	String	in
Save_Area	Integer	in	0

Resize_Area	procedure
Resize Sprite area

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in out
Change	Integer	in

Get_Address	function
*Return*	Address
Returns the address of the spritearea.

*Parameter name*	*Type*	*Mode*	*Default*
SpriteArea	Sprite_Area_Type	in