SpriteFrame Class Reference

Class representing a single frame of a sprite. More...

Inheritance diagram for SpriteFrame:

List of all members.

Public Member Functions
	GetGDImage ()
	Gets the GD Image resource for this sprite frame. Deprecated
	GetWidth ()
	Gets the width of the frame in pixels.
	GetHeight ()
	Gets the height of the frame in pixels.
	GetPixel ($x, $y)
	Gets the colour of the pixel at the given position.
	SetPixel ($x, $y, $r, $g, $b)
	Sets the colour of a pixel.
	ToSpriteFrame ($type)
	Converts this SpriteFrame into one of another type.
	ToPNG ()
	Converts this SpriteFrame into a PNG.

---

Detailed Description

Class representing a single frame of a sprite.

All SpriteFrame classes may also be used in the abscence of a parent SpriteFile.

Definition at line 7 of file SpriteFrame.php.

---

Member Function Documentation

SpriteFrame::GetGDImage

(

)

Gets the GD Image resource for this sprite frame. Deprecated

Returns:

a GD image resource. See http://php.net/image

Definition at line 47 of file SpriteFrame.php.

SpriteFrame::GetHeight

(

)

Gets the height of the frame in pixels.

Definition at line 57 of file SpriteFrame.php.

SpriteFrame::GetPixel	(	$	x,
		$	y
	)

Gets the colour of the pixel at the given position.

Returns an array like the following:

 Array
 ( 
    [red] => 226
    [green] => 222
    [blue] => 252
    [alpha] => 0 
 )

See also:

http://php.net/imagecolorsforindex

Parameters:

$x	The x-coordinate of the pixel to get.
$y	The y-coordinate of the pixel to get.

Returns:

An associative array containing the keys 'red','green','blue','alpha'.

Definition at line 76 of file SpriteFrame.php.

SpriteFrame::GetWidth

(

)

Gets the width of the frame in pixels.

Definition at line 53 of file SpriteFrame.php.

SpriteFrame::SetPixel	(	$	x,
		$	y,
		$	r,
		$	g,
		$	b
	)

Sets the colour of a pixel.

Parameters:

$x	The x-coordinate of the pixel to change.
$y	The y-coordinate of the pixel to change.
$r	The red component of the pixel. 0-255.
$g	The green component of the pixel. 0-255.
$b	The blue component of the pixel. 0-255.

Definition at line 91 of file SpriteFrame.php.

SpriteFrame::ToPNG

(

)

Converts this SpriteFrame into a PNG.

Returns:

A binary string in PNG format, ready for output! :)

Definition at line 155 of file SpriteFrame.php.

SpriteFrame::ToSpriteFrame

(

$

type

)

Converts this SpriteFrame into one of another type.

This is called internally by SpriteFile, and is not really for public use. A way of converting I'd approve of more is to create a SpriteFile of the right type and then call AddFrame.

See also:

SpriteFile::AddFrame()

Parameters:

$type

The type of SpriteFrame to convert this to.

Definition at line 134 of file SpriteFrame.php.

---

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

• sprites/SpriteFrame.php