823 lines
53 KiB
HTML
823 lines
53 KiB
HTML
<!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;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 2.5.1</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><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_1RenderTarget.html">RenderTarget</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classsf_1_1RenderTarget-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sf::RenderTarget Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Base class for all render targets (window, texture, ...)
|
|
<a href="classsf_1_1RenderTarget.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="RenderTarget_8hpp_source.html">RenderTarget.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sf::RenderTarget:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsf_1_1RenderTarget.png" usemap="#sf::RenderTarget_map" alt=""/>
|
|
<map id="sf::RenderTarget_map" name="sf::RenderTarget_map">
|
|
<area href="classsf_1_1NonCopyable.html" title="Utility class that makes any derived class non-copyable. " alt="sf::NonCopyable" shape="rect" coords="61,0,174,24"/>
|
|
<area href="classsf_1_1RenderTexture.html" title="Target for off-screen 2D rendering into a texture. " alt="sf::RenderTexture" shape="rect" coords="0,112,113,136"/>
|
|
<area href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing. " alt="sf::RenderWindow" shape="rect" coords="123,112,236,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:a9abd1654a99fba46f6887b9c625b9b06"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a9abd1654a99fba46f6887b9c625b9b06">~RenderTarget</a> ()</td></tr>
|
|
<tr class="memdesc:a9abd1654a99fba46f6887b9c625b9b06"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a9abd1654a99fba46f6887b9c625b9b06">More...</a><br /></td></tr>
|
|
<tr class="separator:a9abd1654a99fba46f6887b9c625b9b06"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6bb6f0ba348f2b1e2f46114aeaf60f26"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a6bb6f0ba348f2b1e2f46114aeaf60f26">clear</a> (const <a class="el" href="classsf_1_1Color.html">Color</a> &color=<a class="el" href="classsf_1_1Color.html">Color</a>(0, 0, 0, 255))</td></tr>
|
|
<tr class="memdesc:a6bb6f0ba348f2b1e2f46114aeaf60f26"><td class="mdescLeft"> </td><td class="mdescRight">Clear the entire target with a single color. <a href="#a6bb6f0ba348f2b1e2f46114aeaf60f26">More...</a><br /></td></tr>
|
|
<tr class="separator:a6bb6f0ba348f2b1e2f46114aeaf60f26"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a063db6dd0a14913504af30e50cb6d946"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a063db6dd0a14913504af30e50cb6d946">setView</a> (const <a class="el" href="classsf_1_1View.html">View</a> &view)</td></tr>
|
|
<tr class="memdesc:a063db6dd0a14913504af30e50cb6d946"><td class="mdescLeft"> </td><td class="mdescRight">Change the current active view. <a href="#a063db6dd0a14913504af30e50cb6d946">More...</a><br /></td></tr>
|
|
<tr class="separator:a063db6dd0a14913504af30e50cb6d946"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c179503b4dcdf5282ef6426d317602c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1View.html">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a2c179503b4dcdf5282ef6426d317602c">getView</a> () const</td></tr>
|
|
<tr class="memdesc:a2c179503b4dcdf5282ef6426d317602c"><td class="mdescLeft"> </td><td class="mdescRight">Get the view currently in use in the render target. <a href="#a2c179503b4dcdf5282ef6426d317602c">More...</a><br /></td></tr>
|
|
<tr class="separator:a2c179503b4dcdf5282ef6426d317602c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3b533c3f899d7044d981ed607aef9be"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1View.html">View</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#ad3b533c3f899d7044d981ed607aef9be">getDefaultView</a> () const</td></tr>
|
|
<tr class="memdesc:ad3b533c3f899d7044d981ed607aef9be"><td class="mdescLeft"> </td><td class="mdescRight">Get the default view of the render target. <a href="#ad3b533c3f899d7044d981ed607aef9be">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3b533c3f899d7044d981ed607aef9be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a865d462915dc2a1fae2ebfb3300382ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Rect.html">IntRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a865d462915dc2a1fae2ebfb3300382ac">getViewport</a> (const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:a865d462915dc2a1fae2ebfb3300382ac"><td class="mdescLeft"> </td><td class="mdescRight">Get the viewport of a view, applied to this render target. <a href="#a865d462915dc2a1fae2ebfb3300382ac">More...</a><br /></td></tr>
|
|
<tr class="separator:a865d462915dc2a1fae2ebfb3300382ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0103ebebafa43a97e6e6414f8560d5e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a0103ebebafa43a97e6e6414f8560d5e3">mapPixelToCoords</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2i</a> &point) const</td></tr>
|
|
<tr class="memdesc:a0103ebebafa43a97e6e6414f8560d5e3"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from target coordinates to world coordinates, using the current view. <a href="#a0103ebebafa43a97e6e6414f8560d5e3">More...</a><br /></td></tr>
|
|
<tr class="separator:a0103ebebafa43a97e6e6414f8560d5e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d3e9d7c4a1f5ea7e52b06f53e3011f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a2d3e9d7c4a1f5ea7e52b06f53e3011f9">mapPixelToCoords</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2i</a> &point, const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:a2d3e9d7c4a1f5ea7e52b06f53e3011f9"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from target coordinates to world coordinates. <a href="#a2d3e9d7c4a1f5ea7e52b06f53e3011f9">More...</a><br /></td></tr>
|
|
<tr class="separator:a2d3e9d7c4a1f5ea7e52b06f53e3011f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad92a9f0283aa5f3f67e473c1105b68cf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#ad92a9f0283aa5f3f67e473c1105b68cf">mapCoordsToPixel</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &point) const</td></tr>
|
|
<tr class="memdesc:ad92a9f0283aa5f3f67e473c1105b68cf"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from world coordinates to target coordinates, using the current view. <a href="#ad92a9f0283aa5f3f67e473c1105b68cf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad92a9f0283aa5f3f67e473c1105b68cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a848eee44b72ac3f16fa9182df26e83bc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a848eee44b72ac3f16fa9182df26e83bc">mapCoordsToPixel</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &point, const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:a848eee44b72ac3f16fa9182df26e83bc"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from world coordinates to target coordinates. <a href="#a848eee44b72ac3f16fa9182df26e83bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a848eee44b72ac3f16fa9182df26e83bc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12417a3bcc245c41d957b29583556f39"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a12417a3bcc245c41d957b29583556f39">draw</a> (const <a class="el" href="classsf_1_1Drawable.html">Drawable</a> &drawable, const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a>)</td></tr>
|
|
<tr class="memdesc:a12417a3bcc245c41d957b29583556f39"><td class="mdescLeft"> </td><td class="mdescRight">Draw a drawable object to the render target. <a href="#a12417a3bcc245c41d957b29583556f39">More...</a><br /></td></tr>
|
|
<tr class="separator:a12417a3bcc245c41d957b29583556f39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a976bc94057799eb9f8a18ac5fdfd9b73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a976bc94057799eb9f8a18ac5fdfd9b73">draw</a> (const <a class="el" href="classsf_1_1Vertex.html">Vertex</a> *vertices, std::size_t vertexCount, <a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a> type, const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a>)</td></tr>
|
|
<tr class="memdesc:a976bc94057799eb9f8a18ac5fdfd9b73"><td class="mdescLeft"> </td><td class="mdescRight">Draw primitives defined by an array of vertices. <a href="#a976bc94057799eb9f8a18ac5fdfd9b73">More...</a><br /></td></tr>
|
|
<tr class="separator:a976bc94057799eb9f8a18ac5fdfd9b73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dc4d06f081d36ca1e8f1a1298d49abc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a3dc4d06f081d36ca1e8f1a1298d49abc">draw</a> (const <a class="el" href="classsf_1_1VertexBuffer.html">VertexBuffer</a> &vertexBuffer, const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a>)</td></tr>
|
|
<tr class="memdesc:a3dc4d06f081d36ca1e8f1a1298d49abc"><td class="mdescLeft"> </td><td class="mdescRight">Draw primitives defined by a vertex buffer. <a href="#a3dc4d06f081d36ca1e8f1a1298d49abc">More...</a><br /></td></tr>
|
|
<tr class="separator:a3dc4d06f081d36ca1e8f1a1298d49abc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07cb25d4557a30146b24b25b242310ea"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a07cb25d4557a30146b24b25b242310ea">draw</a> (const <a class="el" href="classsf_1_1VertexBuffer.html">VertexBuffer</a> &vertexBuffer, std::size_t firstVertex, std::size_t vertexCount, const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a>)</td></tr>
|
|
<tr class="memdesc:a07cb25d4557a30146b24b25b242310ea"><td class="mdescLeft"> </td><td class="mdescRight">Draw primitives defined by a vertex buffer. <a href="#a07cb25d4557a30146b24b25b242310ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a07cb25d4557a30146b24b25b242310ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e5ade2457d9fb4c4907ae5b3d9e94a5"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classsf_1_1Vector2.html">Vector2u</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a2e5ade2457d9fb4c4907ae5b3d9e94a5">getSize</a> () const =0</td></tr>
|
|
<tr class="memdesc:a2e5ade2457d9fb4c4907ae5b3d9e94a5"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the rendering region of the target. <a href="#a2e5ade2457d9fb4c4907ae5b3d9e94a5">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e5ade2457d9fb4c4907ae5b3d9e94a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adc225ead22a70843ffa9b7eebefa0ce1"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#adc225ead22a70843ffa9b7eebefa0ce1">setActive</a> (bool active=true)</td></tr>
|
|
<tr class="memdesc:adc225ead22a70843ffa9b7eebefa0ce1"><td class="mdescLeft"> </td><td class="mdescRight">Activate or deactivate the render target for rendering. <a href="#adc225ead22a70843ffa9b7eebefa0ce1">More...</a><br /></td></tr>
|
|
<tr class="separator:adc225ead22a70843ffa9b7eebefa0ce1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d1998464ccc54e789aaf990242b47f7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a8d1998464ccc54e789aaf990242b47f7">pushGLStates</a> ()</td></tr>
|
|
<tr class="memdesc:a8d1998464ccc54e789aaf990242b47f7"><td class="mdescLeft"> </td><td class="mdescRight">Save the current OpenGL render states and matrices. <a href="#a8d1998464ccc54e789aaf990242b47f7">More...</a><br /></td></tr>
|
|
<tr class="separator:a8d1998464ccc54e789aaf990242b47f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5a98401113df931ddcd54c080f7aa8e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#ad5a98401113df931ddcd54c080f7aa8e">popGLStates</a> ()</td></tr>
|
|
<tr class="memdesc:ad5a98401113df931ddcd54c080f7aa8e"><td class="mdescLeft"> </td><td class="mdescRight">Restore the previously saved OpenGL render states and matrices. <a href="#ad5a98401113df931ddcd54c080f7aa8e">More...</a><br /></td></tr>
|
|
<tr class="separator:ad5a98401113df931ddcd54c080f7aa8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac7504990d27dada4bfe3c7866920765"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#aac7504990d27dada4bfe3c7866920765">resetGLStates</a> ()</td></tr>
|
|
<tr class="memdesc:aac7504990d27dada4bfe3c7866920765"><td class="mdescLeft"> </td><td class="mdescRight">Reset the internal OpenGL states so that the target is ready for drawing. <a href="#aac7504990d27dada4bfe3c7866920765">More...</a><br /></td></tr>
|
|
<tr class="separator:aac7504990d27dada4bfe3c7866920765"><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:a2997c96cbd93cb8ce0aba2ddae35b86f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a2997c96cbd93cb8ce0aba2ddae35b86f">RenderTarget</a> ()</td></tr>
|
|
<tr class="memdesc:a2997c96cbd93cb8ce0aba2ddae35b86f"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a2997c96cbd93cb8ce0aba2ddae35b86f">More...</a><br /></td></tr>
|
|
<tr class="separator:a2997c96cbd93cb8ce0aba2ddae35b86f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af530274b34159d644e509b4b4dc43eb7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#af530274b34159d644e509b4b4dc43eb7">initialize</a> ()</td></tr>
|
|
<tr class="memdesc:af530274b34159d644e509b4b4dc43eb7"><td class="mdescLeft"> </td><td class="mdescRight">Performs the common initialization step after creation. <a href="#af530274b34159d644e509b4b4dc43eb7">More...</a><br /></td></tr>
|
|
<tr class="separator:af530274b34159d644e509b4b4dc43eb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Base class for all render targets (window, texture, ...) </p>
|
|
<p><a class="el" href="classsf_1_1RenderTarget.html" title="Base class for all render targets (window, texture, ...) ">sf::RenderTarget</a> defines the common behavior of all the 2D render targets usable in the graphics module.</p>
|
|
<p>It makes it possible to draw 2D entities like sprites, shapes, text without using any OpenGL command directly.</p>
|
|
<p>A <a class="el" href="classsf_1_1RenderTarget.html" title="Base class for all render targets (window, texture, ...) ">sf::RenderTarget</a> is also able to use views (<a class="el" href="classsf_1_1View.html" title="2D camera that defines what region is shown on screen ">sf::View</a>), which are a kind of 2D cameras. With views you can globally scroll, rotate or zoom everything that is drawn, without having to transform every single entity. See the documentation of <a class="el" href="classsf_1_1View.html" title="2D camera that defines what region is shown on screen ">sf::View</a> for more details and sample pieces of code about this class.</p>
|
|
<p>On top of that, render targets are still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands. When doing so, make sure that OpenGL states are not messed up by calling the pushGLStates/popGLStates functions.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing. ">sf::RenderWindow</a>, <a class="el" href="classsf_1_1RenderTexture.html" title="Target for off-screen 2D rendering into a texture. ">sf::RenderTexture</a>, <a class="el" href="classsf_1_1View.html" title="2D camera that defines what region is shown on screen ">sf::View</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RenderTarget_8hpp_source.html#l00052">52</a> of file <a class="el" href="RenderTarget_8hpp_source.html">RenderTarget.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a9abd1654a99fba46f6887b9c625b9b06"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9abd1654a99fba46f6887b9c625b9b06">◆ </a></span>~RenderTarget()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual sf::RenderTarget::~RenderTarget </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2997c96cbd93cb8ce0aba2ddae35b86f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2997c96cbd93cb8ce0aba2ddae35b86f">◆ </a></span>RenderTarget()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTarget::RenderTarget </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6bb6f0ba348f2b1e2f46114aeaf60f26"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6bb6f0ba348f2b1e2f46114aeaf60f26">◆ </a></span>clear()</h2>
|
|
|
|
<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.html">Color</a> & </td>
|
|
<td class="paramname"><em>color</em> = <code><a class="el" href="classsf_1_1Color.html">Color</a>(0, 0, 0, 255)</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear the entire target with a single color. </p>
|
|
<p>This function is usually called once every frame, to clear the previous contents of the target.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">color</td><td>Fill color to use to clear the render target </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12417a3bcc245c41d957b29583556f39"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12417a3bcc245c41d957b29583556f39">◆ </a></span>draw() <span class="overload">[1/4]</span></h2>
|
|
|
|
<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.html">Drawable</a> & </td>
|
|
<td class="paramname"><em>drawable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> & </td>
|
|
<td class="paramname"><em>states</em> = <code><a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw a drawable object to the render target. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">drawable</td><td>Object to draw </td></tr>
|
|
<tr><td class="paramname">states</td><td>Render states to use for drawing </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a976bc94057799eb9f8a18ac5fdfd9b73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a976bc94057799eb9f8a18ac5fdfd9b73">◆ </a></span>draw() <span class="overload">[2/4]</span></h2>
|
|
|
|
<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_1Vertex.html">Vertex</a> * </td>
|
|
<td class="paramname"><em>vertices</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>vertexCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__graphics.html#ga5ee56ac1339984909610713096283b1b">PrimitiveType</a> </td>
|
|
<td class="paramname"><em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> & </td>
|
|
<td class="paramname"><em>states</em> = <code><a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw primitives defined by an array of vertices. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vertices</td><td>Pointer to the vertices </td></tr>
|
|
<tr><td class="paramname">vertexCount</td><td>Number of vertices in the array </td></tr>
|
|
<tr><td class="paramname">type</td><td>Type of primitives to draw </td></tr>
|
|
<tr><td class="paramname">states</td><td>Render states to use for drawing </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3dc4d06f081d36ca1e8f1a1298d49abc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3dc4d06f081d36ca1e8f1a1298d49abc">◆ </a></span>draw() <span class="overload">[3/4]</span></h2>
|
|
|
|
<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_1VertexBuffer.html">VertexBuffer</a> & </td>
|
|
<td class="paramname"><em>vertexBuffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> & </td>
|
|
<td class="paramname"><em>states</em> = <code><a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw primitives defined by a vertex buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vertexBuffer</td><td><a class="el" href="classsf_1_1Vertex.html" title="Define a point with color and texture coordinates. ">Vertex</a> buffer </td></tr>
|
|
<tr><td class="paramname">states</td><td>Render states to use for drawing </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07cb25d4557a30146b24b25b242310ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07cb25d4557a30146b24b25b242310ea">◆ </a></span>draw() <span class="overload">[4/4]</span></h2>
|
|
|
|
<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_1VertexBuffer.html">VertexBuffer</a> & </td>
|
|
<td class="paramname"><em>vertexBuffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>firstVertex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>vertexCount</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderStates.html">RenderStates</a> & </td>
|
|
<td class="paramname"><em>states</em> = <code><a class="el" href="classsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Draw primitives defined by a vertex buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vertexBuffer</td><td><a class="el" href="classsf_1_1Vertex.html" title="Define a point with color and texture coordinates. ">Vertex</a> buffer </td></tr>
|
|
<tr><td class="paramname">firstVertex</td><td>Index of the first vertex to render </td></tr>
|
|
<tr><td class="paramname">vertexCount</td><td>Number of vertices to render </td></tr>
|
|
<tr><td class="paramname">states</td><td>Render states to use for drawing </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3b533c3f899d7044d981ed607aef9be"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3b533c3f899d7044d981ed607aef9be">◆ </a></span>getDefaultView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1View.html">View</a>& sf::RenderTarget::getDefaultView </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the default view of the render target. </p>
|
|
<p>The default view has the initial size of the render target, and never changes after the target has been created.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The default view of the render target</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a063db6dd0a14913504af30e50cb6d946" title="Change the current active view. ">setView</a>, <a class="el" href="classsf_1_1RenderTarget.html#a2c179503b4dcdf5282ef6426d317602c" title="Get the view currently in use in the render target. ">getView</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e5ade2457d9fb4c4907ae5b3d9e94a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e5ade2457d9fb4c4907ae5b3d9e94a5">◆ </a></span>getSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="classsf_1_1Vector2.html">Vector2u</a> sf::RenderTarget::getSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the size of the rendering region of the target. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size in pixels </dd></dl>
|
|
|
|
<p>Implemented in <a class="el" href="classsf_1_1RenderTexture.html#a6685315b5c4c25a5dcb75b4280b381ba">sf::RenderTexture</a>, and <a class="el" href="classsf_1_1RenderWindow.html#ae3eacf93661c8068fca7a78d57dc7e14">sf::RenderWindow</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2c179503b4dcdf5282ef6426d317602c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c179503b4dcdf5282ef6426d317602c">◆ </a></span>getView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1View.html">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 view currently in use in the render target. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The view object that is currently used</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a063db6dd0a14913504af30e50cb6d946" title="Change the current active view. ">setView</a>, <a class="el" href="classsf_1_1RenderTarget.html#ad3b533c3f899d7044d981ed607aef9be" title="Get the default view of the render target. ">getDefaultView</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a865d462915dc2a1fae2ebfb3300382ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a865d462915dc2a1fae2ebfb3300382ac">◆ </a></span>getViewport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Rect.html">IntRect</a> sf::RenderTarget::getViewport </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1View.html">View</a> & </td>
|
|
<td class="paramname"><em>view</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the viewport of a view, applied to this render target. </p>
|
|
<p>The viewport is defined in the view as a ratio, this function simply applies this ratio to the current dimensions of the render target to calculate the pixels rectangle that the viewport actually covers in the target.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td>The view for which we want to compute the viewport</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Viewport rectangle, expressed in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af530274b34159d644e509b4b4dc43eb7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af530274b34159d644e509b4b4dc43eb7">◆ </a></span>initialize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTarget::initialize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Performs the common initialization step after creation. </p>
|
|
<p>The derived classes must call this function after the target is created and ready for drawing. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad92a9f0283aa5f3f67e473c1105b68cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad92a9f0283aa5f3f67e473c1105b68cf">◆ </a></span>mapCoordsToPixel() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2i</a> sf::RenderTarget::mapCoordsToPixel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>point</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a point from world coordinates to target coordinates, using the current view. </p>
|
|
<p>This function is an overload of the mapCoordsToPixel function that implicitly uses the current view. It is equivalent to: </p><div class="fragment"><div class="line">target.<a class="code" href="classsf_1_1RenderTarget.html#ad92a9f0283aa5f3f67e473c1105b68cf">mapCoordsToPixel</a>(point, target.<a class="code" href="classsf_1_1RenderTarget.html#a2c179503b4dcdf5282ef6426d317602c">getView</a>());</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">point</td><td>Point to convert</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The converted point, in target coordinates (pixels)</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a0103ebebafa43a97e6e6414f8560d5e3" title="Convert a point from target coordinates to world coordinates, using the current view. ">mapPixelToCoords</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a848eee44b72ac3f16fa9182df26e83bc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a848eee44b72ac3f16fa9182df26e83bc">◆ </a></span>mapCoordsToPixel() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2i</a> sf::RenderTarget::mapCoordsToPixel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>point</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1View.html">View</a> & </td>
|
|
<td class="paramname"><em>view</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a point from world coordinates to target coordinates. </p>
|
|
<p>This function finds the pixel of the render target that matches the given 2D point. In other words, it goes through the same process as the graphics card, to compute the final position of a rendered point.</p>
|
|
<p>Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (150, 75) in your 2D world may map to the pixel (10, 50) of your render target – if the view is translated by (140, 25).</p>
|
|
<p>This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">point</td><td>Point to convert </td></tr>
|
|
<tr><td class="paramname">view</td><td>The view to use for converting the point</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The converted point, in target coordinates (pixels)</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a0103ebebafa43a97e6e6414f8560d5e3" title="Convert a point from target coordinates to world coordinates, using the current view. ">mapPixelToCoords</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0103ebebafa43a97e6e6414f8560d5e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0103ebebafa43a97e6e6414f8560d5e3">◆ </a></span>mapPixelToCoords() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> sf::RenderTarget::mapPixelToCoords </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2i</a> & </td>
|
|
<td class="paramname"><em>point</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a point from target coordinates to world coordinates, using the current view. </p>
|
|
<p>This function is an overload of the mapPixelToCoords function that implicitly uses the current view. It is equivalent to: </p><div class="fragment"><div class="line">target.<a class="code" href="classsf_1_1RenderTarget.html#a0103ebebafa43a97e6e6414f8560d5e3">mapPixelToCoords</a>(point, target.<a class="code" href="classsf_1_1RenderTarget.html#a2c179503b4dcdf5282ef6426d317602c">getView</a>());</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">point</td><td>Pixel to convert</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The converted point, in "world" coordinates</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#ad92a9f0283aa5f3f67e473c1105b68cf" title="Convert a point from world coordinates to target coordinates, using the current view. ">mapCoordsToPixel</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2d3e9d7c4a1f5ea7e52b06f53e3011f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d3e9d7c4a1f5ea7e52b06f53e3011f9">◆ </a></span>mapPixelToCoords() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> sf::RenderTarget::mapPixelToCoords </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2i</a> & </td>
|
|
<td class="paramname"><em>point</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1View.html">View</a> & </td>
|
|
<td class="paramname"><em>view</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a point from target coordinates to world coordinates. </p>
|
|
<p>This function finds the 2D position that matches the given pixel of the render target. In other words, it does the inverse of what the graphics card does, to find the initial position of a rendered pixel.</p>
|
|
<p>Initially, both coordinate systems (world units and target pixels) match perfectly. But if you define a custom view or resize your render target, this assertion is not true anymore, i.e. a point located at (10, 50) in your render target may map to the point (150, 75) in your 2D world – if the view is translated by (140, 25).</p>
|
|
<p>For render-windows, this function is typically used to find which point (or object) is located below the mouse cursor.</p>
|
|
<p>This version uses a custom view for calculations, see the other overload of the function if you want to use the current view of the render target.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">point</td><td>Pixel to convert </td></tr>
|
|
<tr><td class="paramname">view</td><td>The view to use for converting the point</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The converted point, in "world" units</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#ad92a9f0283aa5f3f67e473c1105b68cf" title="Convert a point from world coordinates to target coordinates, using the current view. ">mapCoordsToPixel</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5a98401113df931ddcd54c080f7aa8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5a98401113df931ddcd54c080f7aa8e">◆ </a></span>popGLStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTarget::popGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restore the previously saved OpenGL render states and matrices. </p>
|
|
<p>See the description of pushGLStates to get a detailed description of these functions.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a8d1998464ccc54e789aaf990242b47f7" title="Save the current OpenGL render states and matrices. ">pushGLStates</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d1998464ccc54e789aaf990242b47f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d1998464ccc54e789aaf990242b47f7">◆ </a></span>pushGLStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTarget::pushGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Save the current OpenGL render states and matrices. </p>
|
|
<p>This function can be used when you mix SFML drawing and direct OpenGL rendering. Combined with popGLStates, it ensures that: </p><ul>
|
|
<li>SFML's internal states are not messed up by your OpenGL code </li>
|
|
<li>your OpenGL states are not modified by a call to a SFML function</li>
|
|
</ul>
|
|
<p>More specifically, it must be used around code that calls Draw functions. Example: </p><div class="fragment"><div class="line"><span class="comment">// OpenGL code here...</span></div><div class="line">window.pushGLStates();</div><div class="line">window.draw(...);</div><div class="line">window.draw(...);</div><div class="line">window.popGLStates();</div><div class="line"><span class="comment">// OpenGL code here...</span></div></div><!-- fragment --><p>Note that this function is quite expensive: it saves all the possible OpenGL states and matrices, even the ones you don't care about. Therefore it should be used wisely. It is provided for convenience, but the best results will be achieved if you handle OpenGL states yourself (because you know which states have really changed, and need to be saved and restored). Take a look at the resetGLStates function if you do so.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#ad5a98401113df931ddcd54c080f7aa8e" title="Restore the previously saved OpenGL render states and matrices. ">popGLStates</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac7504990d27dada4bfe3c7866920765"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac7504990d27dada4bfe3c7866920765">◆ </a></span>resetGLStates()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTarget::resetGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset the internal OpenGL states so that the target is ready for drawing. </p>
|
|
<p>This function can be used when you mix SFML drawing and direct OpenGL rendering, if you choose not to use pushGLStates/popGLStates. It makes sure that all OpenGL states needed by SFML are set, so that subsequent <a class="el" href="classsf_1_1RenderTarget.html#a12417a3bcc245c41d957b29583556f39" title="Draw a drawable object to the render target. ">draw()</a> calls will work as expected.</p>
|
|
<p>Example: </p><div class="fragment"><div class="line"><span class="comment">// OpenGL code here...</span></div><div class="line">glPushAttrib(...);</div><div class="line">window.resetGLStates();</div><div class="line">window.draw(...);</div><div class="line">window.draw(...);</div><div class="line">glPopAttrib(...);</div><div class="line"><span class="comment">// OpenGL code here...</span></div></div><!-- fragment -->
|
|
</div>
|
|
</div>
|
|
<a id="adc225ead22a70843ffa9b7eebefa0ce1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adc225ead22a70843ffa9b7eebefa0ce1">◆ </a></span>setActive()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual bool sf::RenderTarget::setActive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>active</em> = <code>true</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Activate or deactivate the render target for rendering. </p>
|
|
<p>This function makes the render target's context current for future OpenGL rendering operations (so you shouldn't care about it if you're not doing direct OpenGL stuff). A render target's context is active only on the current thread, if you want to make it active on another thread you have to deactivate it on the previous thread first if it was active. Only one context can be current in a thread, so if you want to draw OpenGL geometry to another render target don't forget to activate it again. Activating a render target will automatically deactivate the previously active context (if any).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">active</td><td>True to activate, false to deactivate</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if operation was successful, false otherwise </dd></dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="classsf_1_1RenderTexture.html#a5da95ecdbce615a80bb78399012508cf">sf::RenderTexture</a>, and <a class="el" href="classsf_1_1RenderWindow.html#aee6c53eced675e885931eb3e91f11155">sf::RenderWindow</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a063db6dd0a14913504af30e50cb6d946"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a063db6dd0a14913504af30e50cb6d946">◆ </a></span>setView()</h2>
|
|
|
|
<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.html">View</a> & </td>
|
|
<td class="paramname"><em>view</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Change the current active view. </p>
|
|
<p>The view is like a 2D camera, it controls which part of the 2D scene is visible, and how it is viewed in the render target. The new view will affect everything that is drawn, until another view is set. The render target keeps its own copy of the view object, so it is not necessary to keep the original one alive after calling this function. To restore the original view of the target, you can pass the result of <a class="el" href="classsf_1_1RenderTarget.html#ad3b533c3f899d7044d981ed607aef9be" title="Get the default view of the render target. ">getDefaultView()</a> to this function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">view</td><td>New view to use</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1RenderTarget.html#a2c179503b4dcdf5282ef6426d317602c" title="Get the view currently in use in the render target. ">getView</a>, <a class="el" href="classsf_1_1RenderTarget.html#ad3b533c3f899d7044d981ed607aef9be" title="Get the default view of the render target. ">getDefaultView</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="RenderTarget_8hpp_source.html">RenderTarget.hpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div>
|
|
<div id="footer-container">
|
|
<div id="footer">
|
|
SFML is licensed under the terms and conditions of the <a href="https://www.sfml-dev.org/license.php">zlib/png license</a>.<br>
|
|
Copyright © Laurent Gomila ::
|
|
Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen</a> ::
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|