SPRFile Class Reference

Class for files in C1's SPR format. More...

Inheritance diagram for SPRFile:

Collaboration diagram for SPRFile:

List of all members.

Public Member Functions
	SPRFile (IReader $reader)
	Instantiates a new SPRFile.
	Compile ()
	Compiles the SPR file into a binary string.
	GetFrame ($frame)
	Gets a SpriteFrame from the SpriteFile.
	GetFrames ()
	Gets the entire frame array.
	AddFrame (SpriteFrame $frame, $position=false)
	Adds a SpriteFrame to the SpriteFile.
	ReplaceFrame (SpriteFrame $frame, $position)
	Replaces a frame in the SpriteFile.
	GetFrameCount ()
	Gets the number of frames currently stored in this SpriteFile.
	DeleteFrame ($frame)
	Deletes the frame in the given position.
	ToPNG ($frame)
	Converts the given frame to PNG. Deprecated.

---

Detailed Description

Class for files in C1's SPR format.

Creating new SPR files is currently unsupported.
TODO: Allow creating SPR files.

Definition at line 11 of file SPRFile.php.

---

Member Function Documentation

SpriteFile::AddFrame	(	SpriteFrame $	frame,
		$	position = false
	)		[inherited]

Adds a SpriteFrame to the SpriteFile.

If necessary, this function converts the SpriteFrame to the correct format. At the moment, this can only add a SpriteFrame to the end of the SpriteFile. TODO: I aim to fix this by the CCSF 2011.

Parameters:

$frame	A SpriteFrame
$position	Where to put the frame. Currently un-used.

Definition at line 57 of file SpriteFile.php.

SPRFile::Compile

(

)

Compiles the SPR file into a binary string.

Reimplemented from SpriteFile.

Definition at line 31 of file SPRFile.php.

SpriteFile::DeleteFrame

(

$

frame

)

[inherited]

Deletes the frame in the given position.

Parameters:

$frame

The 0-based index of the frame to delete.

Definition at line 98 of file SpriteFile.php.

SpriteFile::GetFrame

(

$

frame

)

[inherited]

Gets a SpriteFrame from the SpriteFile.

Parameters:

$frame

The 0-based index of the frame to get.

Returns:

A SpriteFrame

Definition at line 24 of file SpriteFile.php.

SpriteFile::GetFrameCount

(

)

[inherited]

Gets the number of frames currently stored in this SpriteFile.

Returns:

The number of frames

Definition at line 91 of file SpriteFile.php.

SpriteFile::GetFrames

(

)

[inherited]

Gets the entire frame array.

Returns:

An array of SpriteFrames

Definition at line 31 of file SpriteFile.php.

SpriteFile::ReplaceFrame	(	SpriteFrame $	frame,
		$	position
	)		[inherited]

Replaces a frame in the SpriteFile.

Replaces the frame in the given position Uses the same magic as AddFrame

Parameters:

$frame	A SpriteFrame of any type.
$position	Which frame to replace. If negative, counts backwards from the end of the frames array.

Definition at line 81 of file SpriteFile.php.

SPRFile::SPRFile

(

IReader $

reader

)

Instantiates a new SPRFile.

Reads in the IReader and creates SPRFrames as required.

Parameters:

$reader

An IReader to read from.

Definition at line 18 of file SPRFile.php.

SpriteFile::ToPNG

(

$

frame

)

[inherited]

Converts the given frame to PNG. Deprecated.

May be removed in a future release. Use GetFrame($frame)->ToPNG() instead.

Parameters:

$frame

The 0-based index of the frame to delete.

Returns:

A binary string containing a PNG.

Definition at line 108 of file SpriteFile.php.

---

The documentation for this class was generated from the following file:

• sprites/SPRFile.php