Root/
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>SFML - Simple and Fast Multimedia Library</title> <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/> <!--<link rel='stylesheet' type='text/css' href="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>--> <link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" /> </head> <body> <div id="banner-container"> <div id="banner"> <span id="sfml">SFML</span> </div> </div> <div id="content"><!-- Generated by Doxygen 1.8.2 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.htm"><span>Main Page</span></a></li> <li><a href="modules.htm"><span>Modules</span></a></li> <li class="current"><a href="annotated.htm"><span>Classes</span></a></li> <li><a href="files.htm"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.htm"><span>Class List</span></a></li> <li><a href="classes.htm"><span>Class Index</span></a></li> <li><a href="hierarchy.htm"><span>Class Hierarchy</span></a></li> <li><a href="functions.htm"><span>Class Members</span></a></li> </ul> </div><div id="nav-path" class="navpath"> <ul><li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1Drawable.htm">Drawable</a></li> </ul></div></div><!-- top --><div class="header"> <div class="summary"><a href="#pub-methods">Public Member Functions</a> |<a href="#pro-methods">Protected Member Functions</a> |<a href="#friends">Friends</a> |<a href="classsf_1_1Drawable-members.htm">List of all members</a> </div> <div class="headertitle"><div class="title">sf::Drawable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__graphics.htm">Graphics module</a></div></div> </div></div><!--header--><div class="contents"><p>Abstract base class for objects that can be drawn to a render target. <a href="classsf_1_1Drawable.htm#details">More...</a></p><p><code>#include <<a class="el" href="Drawable_8hpp_source.htm">Drawable.hpp</a>></code></p><div class="dynheader">Inheritance diagram for sf::Drawable:</div><div class="dyncontent"> <div class="center"> <img src="classsf_1_1Drawable.png" usemap="#sf::Drawable_map" alt=""/> <map id="sf::Drawable_map" name="sf::Drawable_map"><area href="classsf_1_1Shape.htm" title="Base class for textured shapes with outline." alt="sf::Shape" shape="rect" coords="130,56,250,80"/><area href="classsf_1_1Sprite.htm" title="Drawable representation of a texture, with its own transformations, color, etc." alt="sf::Sprite" shape="rect" coords="260,56,380,80"/><area href="classsf_1_1Text.htm" title="Graphical text that can be drawn to a render target." alt="sf::Text" shape="rect" coords="390,56,510,80"/><area href="classsf_1_1VertexArray.htm" title="Define a set of one or more 2D primitives." alt="sf::VertexArray" shape="rect" coords="520,56,640,80"/><area href="classsf_1_1CircleShape.htm" title="Specialized shape representing a circle." alt="sf::CircleShape" shape="rect" coords="0,112,120,136"/><area href="classsf_1_1ConvexShape.htm" title="Specialized shape representing a convex polygon." alt="sf::ConvexShape" shape="rect" coords="130,112,250,136"/><area href="classsf_1_1RectangleShape.htm" title="Specialized shape representing a rectangle." alt="sf::RectangleShape" shape="rect" coords="260,112,380,136"/></map> </div></div><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>Public Member Functions</h2></td></tr><tr class="memitem:a906002f2df7beb5edbddf5bbef96f120"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Drawable.htm#a906002f2df7beb5edbddf5bbef96f120">~Drawable</a> ()</td></tr><tr class="memdesc:a906002f2df7beb5edbddf5bbef96f120"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a906002f2df7beb5edbddf5bbef96f120"></a><br/></td></tr><tr class="separator:a906002f2df7beb5edbddf5bbef96f120"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>Protected Member Functions</h2></td></tr><tr class="memitem:a90d2c88bba9b035a0844eccb380ef631"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Drawable.htm#a90d2c88bba9b035a0844eccb380ef631">draw</a> (<a class="el" href="classsf_1_1RenderTarget.htm">RenderTarget</a> &target, <a class="el" href="classsf_1_1RenderStates.htm">RenderStates</a> states) const =0</td></tr><tr class="memdesc:a90d2c88bba9b035a0844eccb380ef631"><td class="mdescLeft"> </td><td class="mdescRight">Draw the object to a render target. <a href="#a90d2c88bba9b035a0844eccb380ef631"></a><br/></td></tr><tr class="separator:a90d2c88bba9b035a0844eccb380ef631"><td class="memSeparator" colspan="2"> </td></tr></table><table class="memberdecls"><tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>Friends</h2></td></tr><tr class="memitem:aa5afc6f82b7b587ed5ada4d227ce32aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5afc6f82b7b587ed5ada4d227ce32aa"></a>class </td><td class="memItemRight" valign="bottom"><b>RenderTarget</b></td></tr><tr class="separator:aa5afc6f82b7b587ed5ada4d227ce32aa"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p>Abstract base class for objects that can be drawn to a render target. </p><p><a class="el" href="classsf_1_1Drawable.htm" title="Abstract base class for objects that can be drawn to a render target.">sf::Drawable</a> is a very simple base class that allows objects of derived classes to be drawn to a <a class="el" href="classsf_1_1RenderTarget.htm" title="Base class for all render targets (window, texture, ...)">sf::RenderTarget</a>.</p><p>All you have to do in your derived class is to override the draw virtual function.</p><p>Note that inheriting from <a class="el" href="classsf_1_1Drawable.htm" title="Abstract base class for objects that can be drawn to a render target.">sf::Drawable</a> is not mandatory, but it allows this nice syntax "window.draw(object)" rather than "object.draw(window)", which is more consistent with other SFML classes.</p><p>Example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyDrawable : <span class="keyword">public</span> <a class="code" href="classsf_1_1Drawable.htm" title="Abstract base class for objects that can be drawn to a render target.">sf::Drawable</a></div><div class="line">{</div><div class="line"><span class="keyword">public</span> :</div><div class="line"></div><div class="line"> ...</div><div class="line"></div><div class="line">private :</div><div class="line"></div><div class="line"> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsf_1_1Drawable.htm#a90d2c88bba9b035a0844eccb380ef631" title="Draw the object to a render target.">draw</a>(<a class="code" href="classsf_1_1RenderTarget.htm" title="Base class for all render targets (window, texture, ...)">sf::RenderTarget</a>& target, <a class="code" href="classsf_1_1RenderStates.htm" title="Define the states used for drawing to a RenderTarget.">sf::RenderStates</a> states)<span class="keyword"> const</span></div><div class="line"><span class="keyword"> </span>{</div><div class="line"> <span class="comment">// You can draw other high-level objects</span></div><div class="line"> target.<a class="code" href="classsf_1_1RenderTarget.htm#a12417a3bcc245c41d957b29583556f39" title="Draw a drawable object to the render-target.">draw</a>(m_sprite, states);</div><div class="line"></div><div class="line"> <span class="comment">// ... or use the low-level API</span></div><div class="line"> states.<a class="code" href="classsf_1_1RenderStates.htm#a457fc5a41731889de9cf39cf9b3436c3" title="Texture.">texture</a> = &m_texture;</div><div class="line"> target.<a class="code" href="classsf_1_1RenderTarget.htm#a12417a3bcc245c41d957b29583556f39" title="Draw a drawable object to the render-target.">draw</a>(m_vertices, states);</div><div class="line"></div><div class="line"> <span class="comment">// ... or draw with OpenGL directly</span></div><div class="line"> glBegin(GL_QUADS);</div><div class="line"> ...</div><div class="line"> glEnd();</div><div class="line"> }</div><div class="line"></div><div class="line"> <a class="code" href="classsf_1_1Sprite.htm" title="Drawable representation of a texture, with its own transformations, color, etc.">sf::Sprite</a> m_sprite;</div><div class="line"> <a class="code" href="classsf_1_1Texture.htm" title="Image living on the graphics card that can be used for drawing.">sf::Texture</a> m_texture;</div><div class="line"> <a class="code" href="classsf_1_1VertexArray.htm" title="Define a set of one or more 2D primitives.">sf::VertexArray</a> m_vertices;</div><div class="line">};</div></div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classsf_1_1RenderTarget.htm" title="Base class for all render targets (window, texture, ...)">sf::RenderTarget</a> </dd></dl><p>Definition at line <a class="el" href="Drawable_8hpp_source.htm#l00044">44</a> of file <a class="el" href="Drawable_8hpp_source.htm">Drawable.hpp</a>.</p></div><h2 class="groupheader">Constructor & Destructor Documentation</h2><a class="anchor" id="a906002f2df7beb5edbddf5bbef96f120"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual sf::Drawable::~Drawable </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr></table></div><div class="memdoc"><p>Virtual destructor. </p><p>Definition at line <a class="el" href="Drawable_8hpp_source.htm#l00052">52</a> of file <a class="el" href="Drawable_8hpp_source.htm">Drawable.hpp</a>.</p></div></div><h2 class="groupheader">Member Function Documentation</h2><a class="anchor" id="a90d2c88bba9b035a0844eccb380ef631"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void sf::Drawable::draw </td> <td>(</td> <td class="paramtype"><a class="el" href="classsf_1_1RenderTarget.htm">RenderTarget</a> & </td> <td class="paramname"><em>target</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="classsf_1_1RenderStates.htm">RenderStates</a> </td> <td class="paramname"><em>states</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td> </tr></table></div><div class="memdoc"><p>Draw the object to a render target. </p><p>This is a pure virtual function that has to be implemented by the derived class to define how the drawable should be drawn.</p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">target</td><td>Render target to draw to </td></tr> <tr><td class="paramname">states</td><td>Current render states </td></tr> </table> </dd></dl></div></div><hr/>The documentation for this class was generated from the following file:<ul><li><a class="el" href="Drawable_8hpp_source.htm">Drawable.hpp</a></li></ul></div><!-- contents --> </div> <div id="footer-container"> <div id="footer"> Copyright � Laurent Gomila :: Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> :: </div> </div> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-41898676-1', 'srchub.org'); ga('send', 'pageview'); |
| Source at commit tip created 11 years 11 months ago. By Nathan Adams, Initial commit |
|---|
