AgateLib.Resources.SpriteResource Class Reference
Resource which loads a sprite. There are two different types of sprites, a general purpose sprite, implemented as the Sprite class, and a packed version which maximizes the memory efficiency, implemented as PackedSprite.XML Attributes:
string name, bool packed, Size size, string image, double timePerFrame (in milliseconds). More...
Inheritance diagram for AgateLib.Resources.SpriteResource:
Classes | |
| class | SpriteFrameResource |
| Class representing a frame of a sprite in a SpriteResource. More... | |
Public Member Functions | |
| SpriteResource (string name) | |
| Constructs a SpriteResource object. | |
Protected Member Functions | |
| override AgateResource | Clone () |
| Clones the resource. | |
Properties | |
| bool | Packed [get, set] |
| Gets or sets whether or not this sprite uses the PackedSprite class. | |
| Size | Size [get, set] |
| Gets or sets the size of this sprite. | |
| double | TimePerFrame [get, set] |
| Gets or sets the amount of time each frame should be displayed, in milliseconds. | |
| List< SpriteFrameResource > | Frames [get] |
| Gets the list of frames. | |
| string | Filename [get, set] |
| Gets or sets the default filename for sprite frames. | |
Detailed Description
Resource which loads a sprite. There are two different types of sprites, a general purpose sprite, implemented as the Sprite class, and a packed version which maximizes the memory efficiency, implemented as PackedSprite.XML Attributes:
string name, bool packed, Size size, string image, double timePerFrame (in milliseconds).
XML Nodes:
Frame: Required attributes: Rectangle rect, Point offset Optional attribute: string image
Constructor & Destructor Documentation
| AgateLib.Resources.SpriteResource.SpriteResource | ( | string | name | ) |
Member Function Documentation
| override AgateResource AgateLib.Resources.SpriteResource.Clone | ( | ) | [protected, virtual] |
Property Documentation
string AgateLib.Resources.SpriteResource.Filename [get, set] |
Gets or sets the default filename for sprite frames.
List<SpriteFrameResource> AgateLib.Resources.SpriteResource.Frames [get] |
Gets the list of frames.
bool AgateLib.Resources.SpriteResource.Packed [get, set] |
Gets or sets whether or not this sprite uses the PackedSprite class.
Size AgateLib.Resources.SpriteResource.Size [get, set] |
Gets or sets the size of this sprite.
double AgateLib.Resources.SpriteResource.TimePerFrame [get, set] |
Gets or sets the amount of time each frame should be displayed, in milliseconds.
The documentation for this class was generated from the following file:
- Resources/SpriteResource.cs
