2
// Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
4
// This program is free software; you can redistribute it and/or modify
5
// it under the terms of the GNU General Public License as published by
6
// the Free Software Foundation; either version 3 of the License, or
7
// (at your option) any later version.
9
// This program is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
// GNU General Public License for more details.
14
// You should have received a copy of the GNU General Public License
15
// along with this program; if not, write to the Free Software
16
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
//------------------------------------------------------------------
19
// NOTE: this header is still here just as a place-holder for
20
// Doxygen page about Sprites
21
//------------------------------------------------------------------
23
/// \page Sprite Sprites and MovieClips
25
/// A Sprite, or MovieClip, is a mini movie-within-a-movie.
27
/// It doesn't define its own characters;
28
/// it uses the characters from the parent
29
/// movie, but it has its own frame counter, display list, etc.
31
/// @@ are we sure it doesn't define its own chars ?
33
/// The sprite implementation is divided into
34
/// gnash::sprite_definition and gnash::sprite_instance.
36
/// The _definition holds the immutable data for a sprite (as read
37
/// from an SWF stream), while the _instance contains the state for
38
/// a specific run of if (frame being played, mouse state, timers,
39
/// display list as updated by actions, ...)