Romulus.Nes.SpriteDef Class Reference

Defines a set of tile sprites to be combined into a larger composite sprite. More...

List of all members.

Public Member Functions
	SpriteDef ()
	Creates an empty sprite.
	SpriteDef (SpriteTile[] data)
	Creates a SpriteDef from the specified tile data.
IEnumerator< SpriteTile >	GetEnumerator ()
	Gets a SpriteTile enumerator.
Static Public Member Functions
static SpriteDef	FromSquareLayout (int width, int pal, params byte[] tiles)
	Creates a SpriteDef with tiles arranged in a grid.
static SpriteDef	FromSquareLayoutAligned (int width, int pal, SpriteAlign align, byte[] tiles, int offsetX, int offsetY)
	Creates a SpriteDef with tiles arranged in a grid, aligned on a specified edge.
static SpriteDef	FromSquareLayoutAligned (int width, int pal, SpriteAlign align, params byte[] tiles)
	Creates a SpriteDef with tiles arranged in a grid, aligned on a specified edge.
Properties
IList< SpriteTile >	Data [get]
	Gets the defining tile data.
int	Count [get]
	Gets the number of sprite tiles in this sprite def.
SpriteTile	this [int index] [get, set]
	Gets or sets a SpriteTile in this SpriteDef.

---

Detailed Description

Defines a set of tile sprites to be combined into a larger composite sprite.

---

Constructor & Destructor Documentation

Romulus.Nes.SpriteDef.SpriteDef

(

)

Creates an empty sprite.

Romulus.Nes.SpriteDef.SpriteDef

(

SpriteTile[]

data

)

Creates a SpriteDef from the specified tile data.

Parameters:

data

An array of tile data.

---

Member Function Documentation

static SpriteDef Romulus.Nes.SpriteDef.FromSquareLayout	(	int	width,
		int	pal,
		params byte[]	tiles
	)			[static]

Creates a SpriteDef with tiles arranged in a grid.

Parameters:

	width	The width of the sprite (in tiles).
	pal	The index of the palette to use.
	tiles	The list of tile indecies to use.

Returns:

A new SpriteDef

static SpriteDef Romulus.Nes.SpriteDef.FromSquareLayoutAligned	(	int	width,
		int	pal,
		SpriteAlign	align,
		byte[]	tiles,
		int	offsetX,
		int	offsetY
	)			[static]

Creates a SpriteDef with tiles arranged in a grid, aligned on a specified edge.

Parameters:

	width	The width of the sprite (in tiles).
	pal	The index of the palette to use.
	tiles	The list of tile indecies to use.
	align	The edge to align tiles on.
	offsetX	An amount to offset the location of each tile.
	offsetY	An amount to offset the location of each tile.

Returns:

A new SpriteDef.

static SpriteDef Romulus.Nes.SpriteDef.FromSquareLayoutAligned	(	int	width,
		int	pal,
		SpriteAlign	align,
		params byte[]	tiles
	)			[static]

Creates a SpriteDef with tiles arranged in a grid, aligned on a specified edge.

Parameters:

	width	The width of the sprite (in tiles).
	pal	The index of the palette to use.
	tiles	The list of tile indecies to use.
	align	The edge to align tiles on.

Returns:

A new SpriteDef.

IEnumerator<SpriteTile> Romulus.Nes.SpriteDef.GetEnumerator

(

)

Gets a SpriteTile enumerator.

Returns:

A SpriteTile enumerator.

---

Property Documentation

int Romulus.Nes.SpriteDef.Count [get]

Gets the number of sprite tiles in this sprite def.

IList<SpriteTile> Romulus.Nes.SpriteDef.Data [get]

Gets the defining tile data.

SpriteTile Romulus.Nes.SpriteDef.this[int index] [get, set]

Gets or sets a SpriteTile in this SpriteDef.

Parameters:

index

Index of a SpriteTile.

Returns:

A SpriteTile from this SpriteDef.

---

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

• D:/VS/Romulus/RomulusPublic/Nes/SpriteDef.cs