diff options
Diffstat (limited to 'doc/html/classsf_1_1RenderTarget.htm')
| -rwxr-xr-x | doc/html/classsf_1_1RenderTarget.htm | 390 |
1 files changed, 0 insertions, 390 deletions
diff --git a/doc/html/classsf_1_1RenderTarget.htm b/doc/html/classsf_1_1RenderTarget.htm deleted file mode 100755 index 5c9f16b..0000000 --- a/doc/html/classsf_1_1RenderTarget.htm +++ /dev/null @@ -1,390 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> - <head> - <title>SFML - Simple and Fast Multimedia Library</title> - <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" /> - <link href="doxygen.css" rel="stylesheet" type="text/css" /> - <link href="tabs.css" rel="stylesheet" type="text/css" /> - </head> - <body> - <div id="logo"> - <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" /> - </div> -<!-- Generated by Doxygen 1.5.8 --> -<div class="navigation" id="top"> - <div class="tabs"> - <ul> - <li><a href="index.htm"><span>Main Page</span></a></li> - <li><a href="namespaces.htm"><span>Namespaces</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 class="tabs"> - <ul> - <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 class="navpath"><b>sf</b>::<a class="el" href="classsf_1_1RenderTarget.htm">RenderTarget</a> - </div> -</div> -<div class="contents"> -<h1>sf::RenderTarget Class Reference</h1><!-- doxytag: class="sf::RenderTarget" -->Base class for all render targets (window, image, . -<a href="#_details">More...</a> -<p> -<code>#include <<a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a>></code> -<p> -<div class="dynheader"> -Inheritance diagram for sf::RenderTarget:</div> -<div class="dynsection"> - -<p><center><img src="classsf_1_1RenderTarget.png" usemap="#sf::RenderTarget_map" border="0" alt=""></center> -<map name="sf::RenderTarget_map"> -<area href="classsf_1_1RenderWindow.htm" alt="sf::RenderWindow" shape="rect" coords="0,56,113,80"> -</map> -</div> - -<p> -<a href="classsf_1_1RenderTarget-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></td></tr> -<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#45414a2f09b257db7e7b37861d70c5a0">~RenderTarget</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#45414a2f09b257db7e7b37861d70c5a0"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#125645088d7b2df07599ea36fbb8b87e">Clear</a> (const <a class="el" href="classsf_1_1Color.htm">Color</a> &FillColor=<a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0))</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the entire target with a single color. <a href="#125645088d7b2df07599ea36fbb8b87e"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#18678bb6afe22b7462e2cf08f701d2ff">Draw</a> (const <a class="el" href="classsf_1_1Drawable.htm">Drawable</a> &Object)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw something into the target. <a href="#18678bb6afe22b7462e2cf08f701d2ff"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#4df749ecfddb5355d8357afe719cf681">GetWidth</a> () const =0</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the width of the rendering region of the target. <a href="#4df749ecfddb5355d8357afe719cf681"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#9495774c371e0dd9ad9835ad2f34a03a">GetHeight</a> () const =0</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the height of the rendering region of the target. <a href="#9495774c371e0dd9ad9835ad2f34a03a"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#7060ca19e685d8d5b7c6f5dd9b5906e1">SetView</a> (const <a class="el" href="classsf_1_1View.htm">View</a> &NewView)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Change the current active view. <a href="#7060ca19e685d8d5b7c6f5dd9b5906e1"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classsf_1_1View.htm">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#d426b7ba51cc6970fb828a2bef020274">GetView</a> () const </td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current view. <a href="#d426b7ba51cc6970fb828a2bef020274"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsf_1_1View.htm">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#16db9179a7f035c59b8ecdd10cc2e699">GetDefaultView</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default view of the window for read / write. <a href="#16db9179a7f035c59b8ecdd10cc2e699"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#b763d16f00166b516fead600d8824c71">PreserveOpenGLStates</a> (bool Preserve)</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. <a href="#b763d16f00166b516fead600d8824c71"></a><br></td></tr> -<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#2997c96cbd93cb8ce0aba2ddae35b86f">RenderTarget</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#2997c96cbd93cb8ce0aba2ddae35b86f"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.htm#3d9265548b6903ab7f645d12177bba24">Initialize</a> ()</td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the derived class when it's ready to be initialized. <a href="#3d9265548b6903ab7f645d12177bba24"></a><br></td></tr> -</table> -<hr><a name="_details"></a><h2>Detailed Description</h2> -Base class for all render targets (window, image, . -<p> -..) -<p>Definition at line <a class="el" href="RenderTarget_8hpp-source.htm#l00043">43</a> of file <a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a>.</p> -<hr><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" name="45414a2f09b257db7e7b37861d70c5a0"></a><!-- doxytag: member="sf::RenderTarget::~RenderTarget" ref="45414a2f09b257db7e7b37861d70c5a0" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">sf::RenderTarget::~RenderTarget </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td><code> [virtual]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Destructor. -<p> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00051">51</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="2997c96cbd93cb8ce0aba2ddae35b86f"></a><!-- doxytag: member="sf::RenderTarget::RenderTarget" ref="2997c96cbd93cb8ce0aba2ddae35b86f" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">sf::RenderTarget::RenderTarget </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td><code> [protected]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Default constructor. -<p> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00039">39</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<hr><h2>Member Function Documentation</h2> -<a class="anchor" name="125645088d7b2df07599ea36fbb8b87e"></a><!-- doxytag: member="sf::RenderTarget::Clear" ref="125645088d7b2df07599ea36fbb8b87e" args="(const Color &FillColor=Color(0, 0, 0))" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void sf::RenderTarget::Clear </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1Color.htm">Color</a> & </td> - <td class="paramname"> <em>FillColor</em> = <code><a class="el" href="classsf_1_1Color.htm">Color</a>(0, 0, 0)</code> </td> - <td> ) </td> - <td></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Clear the entire target with a single color. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>FillColor</em> </td><td>: <a class="el" href="classsf_1_1Color.htm" title="Color is an utility class for manipulating 32-bits RGBA colors.">Color</a> to use to clear the render target </td></tr> - </table> -</dl> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00060">60</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="18678bb6afe22b7462e2cf08f701d2ff"></a><!-- doxytag: member="sf::RenderTarget::Draw" ref="18678bb6afe22b7462e2cf08f701d2ff" args="(const Drawable &Object)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void sf::RenderTarget::Draw </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1Drawable.htm">Drawable</a> & </td> - <td class="paramname"> <em>Object</em> </td> - <td> ) </td> - <td><code> [virtual]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Draw something into the target. -<p> -Draw something on the window.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>Object</em> </td><td>: Object to draw </td></tr> - </table> -</dl> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00076">76</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="16db9179a7f035c59b8ecdd10cc2e699"></a><!-- doxytag: member="sf::RenderTarget::GetDefaultView" ref="16db9179a7f035c59b8ecdd10cc2e699" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="classsf_1_1View.htm">View</a> & sf::RenderTarget::GetDefaultView </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Get the default view of the window for read / write. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Default view </dd></dl> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00147">147</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="9495774c371e0dd9ad9835ad2f34a03a"></a><!-- doxytag: member="sf::RenderTarget::GetHeight" ref="9495774c371e0dd9ad9835ad2f34a03a" args="() const =0" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">virtual unsigned int sf::RenderTarget::GetHeight </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td> const<code> [pure virtual]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Get the height of the rendering region of the target. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Height in pixels </dd></dl> - -<p>Implemented in <a class="el" href="classsf_1_1RenderWindow.htm#efa842a47f9c2415d1f8e93543ed2447">sf::RenderWindow</a>.</p> - -</div> -</div><p> -<a class="anchor" name="d426b7ba51cc6970fb828a2bef020274"></a><!-- doxytag: member="sf::RenderTarget::GetView" ref="d426b7ba51cc6970fb828a2bef020274" args="() const " --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const <a class="el" href="classsf_1_1View.htm">View</a> & sf::RenderTarget::GetView </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td> const</td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Get the current view. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current view active in the window </dd></dl> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00138">138</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="4df749ecfddb5355d8357afe719cf681"></a><!-- doxytag: member="sf::RenderTarget::GetWidth" ref="4df749ecfddb5355d8357afe719cf681" args="() const =0" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">virtual unsigned int sf::RenderTarget::GetWidth </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td> const<code> [pure virtual]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Get the width of the rendering region of the target. -<p> -<dl class="return" compact><dt><b>Returns:</b></dt><dd>Width in pixels </dd></dl> - -<p>Implemented in <a class="el" href="classsf_1_1RenderWindow.htm#e2b04f655a655b7c4bfac22958266e0c">sf::RenderWindow</a>.</p> - -</div> -</div><p> -<a class="anchor" name="3d9265548b6903ab7f645d12177bba24"></a><!-- doxytag: member="sf::RenderTarget::Initialize" ref="3d9265548b6903ab7f645d12177bba24" args="()" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void sf::RenderTarget::Initialize </td> - <td>(</td> - <td class="paramname"> </td> - <td> ) </td> - <td><code> [protected]</code></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Called by the derived class when it's ready to be initialized. -<p> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00170">170</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="b763d16f00166b516fead600d8824c71"></a><!-- doxytag: member="sf::RenderTarget::PreserveOpenGLStates" ref="b763d16f00166b516fead600d8824c71" args="(bool Preserve)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void sf::RenderTarget::PreserveOpenGLStates </td> - <td>(</td> - <td class="paramtype">bool </td> - <td class="paramname"> <em>Preserve</em> </td> - <td> ) </td> - <td></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Tell SFML to preserve external OpenGL states, at the expense of more CPU charge. -<p> -Tell SFML to preserve external OpenGL states, at the expense of more CPU charge.<p> -Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>Preserve</em> </td><td>: True to preserve OpenGL states, false to let SFML optimize</td></tr> - </table> -</dl> -Use this function if you don't want SFML to mess up your own OpenGL states (if any). Don't enable state preservation if not needed, as it will allow SFML to do internal optimizations and improve performances. This parameter is false by default -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00161">161</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<a class="anchor" name="7060ca19e685d8d5b7c6f5dd9b5906e1"></a><!-- doxytag: member="sf::RenderTarget::SetView" ref="7060ca19e685d8d5b7c6f5dd9b5906e1" args="(const View &NewView)" --> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void sf::RenderTarget::SetView </td> - <td>(</td> - <td class="paramtype">const <a class="el" href="classsf_1_1View.htm">View</a> & </td> - <td class="paramname"> <em>NewView</em> </td> - <td> ) </td> - <td></td> - </tr> - </table> -</div> -<div class="memdoc"> - -<p> -Change the current active view. -<p> -<dl compact><dt><b>Parameters:</b></dt><dd> - <table border="0" cellspacing="2" cellpadding="0"> - <tr><td valign="top"></td><td valign="top"><em>NewView</em> </td><td>: New view to use (pass <a class="el" href="classsf_1_1RenderTarget.htm#16db9179a7f035c59b8ecdd10cc2e699" title="Get the default view of the window for read / write.">GetDefaultView()</a> to set the default view) </td></tr> - </table> -</dl> - -<p>Definition at line <a class="el" href="RenderTarget_8cpp-source.htm#l00129">129</a> of file <a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a>.</p> - -</div> -</div><p> -<hr>The documentation for this class was generated from the following files:<ul> -<li><a class="el" href="RenderTarget_8hpp-source.htm">RenderTarget.hpp</a><li><a class="el" href="RenderTarget_8cpp-source.htm">RenderTarget.cpp</a></ul> -</div> - - <p id="footer"> - :: Copyright © 2007-2008 Laurent Gomila, all rights reserved :: - Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> :: - </p> - - </body> -</html> |