AgateLib.Sprites.IFrameList Interface Reference

Iterface implemented by a list of sprite frames. This provides a read-only view into the frames in a sprite. More...

Inheritance diagram for AgateLib.Sprites.IFrameList:

List of all members.

Public Member Functions
int	IndexOf (ISpriteFrame item)
	Searches for a particular frame.
bool	Contains (ISpriteFrame item)
	Returns a bool indicating whether the specified frame is contained in the list.
void	CopyTo (ISpriteFrame[] array, int arrayIndex)
	Copies the list of frame to a target array.
Properties
int	Count [get]
	Returns the number of frames in the list.
ISpriteFrame	this [int index] [get]
	Gets a frame by index.

---

Detailed Description

Iterface implemented by a list of sprite frames. This provides a read-only view into the frames in a sprite.

---

Member Function Documentation

bool AgateLib.Sprites.IFrameList.Contains

(

ISpriteFrame

item

)

Returns a bool indicating whether the specified frame is contained in the list.

Parameters:

item

Returns:

void AgateLib.Sprites.IFrameList.CopyTo	(	ISpriteFrame[]	array,
		int	arrayIndex
	)

Copies the list of frame to a target array.

Parameters:

	array
	arrayIndex

int AgateLib.Sprites.IFrameList.IndexOf

(

ISpriteFrame

item

)

Searches for a particular frame.

Parameters:

item

Returns:

---

Property Documentation

int AgateLib.Sprites.IFrameList.Count [get]

Returns the number of frames in the list.

Implemented in AgateLib.Sprites.FrameList< T >.

ISpriteFrame AgateLib.Sprites.IFrameList.this[int index] [get]

Gets a frame by index.

Parameters:

index

Returns:

Implemented in AgateLib.Sprites.FrameList< T >.

---

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

• Sprites/IFrameList.cs