timy/SpriteLibrary
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Increase Sprite documentation at the top-most level.

Browse Source
This commit is contained in:
Tim Young 2017-09-25 14:47:33 -05:00
parent ae0883dafb
commit 56d280ae1e
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
SpriteLibrary/Sprite.cs
View File

@ -39,6 +39,11 @@ namespace SpriteLibrary
/// A Sprite is an animated image that has a size, position, rotation, and possible vector /// A Sprite is an animated image that has a size, position, rotation, and possible vector
/// It tracks where in the animation sequence it is, can report colisions, etc. This SpriteController /// It tracks where in the animation sequence it is, can report colisions, etc. This SpriteController
/// draws, moves, and deals with most graphical aspects of the sprites for you. /// draws, moves, and deals with most graphical aspects of the sprites for you.
/// <para/>You want to read up on <seealso cref="SetName(string)"/> for defining named sprites (Sprite Templates),
/// <seealso cref="SpriteDatabase"/> for creating a database of sprites which are accessed on demand (this is just
/// another way of creating Named Sprites, except you can store them in a database instead of making them
/// programatically), and <seealso cref="SpriteController.DuplicateSprite(string)"/> for how to duplicate a
/// sprite from a sprite template.
/// </summary> /// </summary>
public class Sprite public class Sprite
{ {