<!-- clanlib header begin --> <HTML> <HEAD> <TITLE>CL_SpriteDescription - ClanLib Game SDK</TITLE> <STYLE TYPE="text/css"><!-- HTML BODY { font-family: verdana, helvetica, sans-serif; font-size: 12px; } H1 { font-size: 22px; } H2 { font-size: 18px; } H3 { font-size: 16px; } H4 { font-size: 14px; } P { font-size: 12px; } LI { font-size: 12px; } --></STYLE> </HEAD> <body bgcolor=white text=black link=blue vlink=#800080> <center> <img src="http://clanlib.org/gfx/clanlib.png"> </center> <!-- clanlib header end --> <center> <p> <a href="http://clanlib.org/docs.html">Home</a> | <a href="classes.html">All Classes</a> | <a href="modules.html">Grouped Classes</a> | <a href="index.html">Index</a> | <a href="search.html">Search</a> </p> </center> <h1>Class CL_SpriteDescription</h1> <p> This class contains everything to construct a sprite - its data, default settings etc. <a href="#description">More...</a></p> <p>Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Display (Sprites)</p> <p> #include <ClanLib/display.h> <p> <table border=0 width=100%> </table> <p><b>Construction:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_SpriteDescription__CL_SpriteDescription.html">CL_SpriteDescription</a></p></td><td valign=top><p> Constructs a sprite description.</p></td></tr></table> <p><b>Attributes:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_SpriteDescription__FramePair.html">FramePair</a></p></td><td valign=top><p> CL_PixelBuffer provider, CL_Rect position.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__get_frames.html">get_frames</a></p></td><td valign=top><p> Returns a list over all available frames.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__get_surface_flag.html">get_surface_flag</a></p></td><td valign=top><p> Returns the surface flag to be used.</p></td></tr></table> <p><b>Operations:</b></p> <table border=0 width=100%> <tr><td width=30% valign=top><p><a href="CL_SpriteDescription__operator =.html">operator =</a></p></td><td valign=top><p> Copy assignment operator.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__set_surface_flag.html">set_surface_flag</a></p></td><td valign=top><p> Sets what surface flag CL_Sprite should use for its surfaces.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__add_frame.html">add_frame</a></p></td><td valign=top><p> Adds a single image.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__add_gridclipped_frames.html">add_gridclipped_frames</a></p></td><td valign=top><p> Adds images formed in a grid.</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__add_alphaclipped_frames.html">add_alphaclipped_frames</a></p></td><td valign=top><p> Adds images separated with pure alpha (within trans_limit).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__add_alphaclipped_frames_free.html">add_alphaclipped_frames_free</a></p></td><td valign=top><p> Adds images separated with pure alpha (within trans_limit).</p></td></tr><tr><td width=30% valign=top><p><a href="CL_SpriteDescription__add_paletteclipped_frames.html">add_paletteclipped_frames</a></p></td><td valign=top><p> Adds images separated with palette-colours defining the boundaries.</p></td></tr></table> <a name="#description"><p><b>Detailed description:</b></p> !group=Display/Sprites! !header=display.h! <p>CL_SpriteDescription is used by CL_Sprite to construct itself based on the description. The description class give a big flexibility creating a sprite, individual frames can come from different image sources, or be cut out from an image source using various different techniques.</p> <!-- clanlib footer begin --> <center><br><br><font color="#a0a0a0"> Questions or comments, write to the <a href="http://clanlib.org/contact.html">ClanLib mailing list</a>. </font></center> </body> </html> <!-- clanlib footer end -->