1614 lines
101 KiB
HTML
1614 lines
101 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;charset=UTF-8" />
|
|
<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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link rel="stylesheet" type="text/css" href="search/search.css" />
|
|
<link rel="stylesheet" type="text/css" href="searchOverrides.css" />
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 3.0.0</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<div>
|
|
<!-- Generated by Doxygen 1.12.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="topics.html"><span>Topics</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>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"> </span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacesf.html">sf</a></li><li class="navelem"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="classsf_1_1RenderTexture-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">sf::RenderTexture Class Reference<div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Target for off-screen 2D rendering into a texture.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="RenderTexture_8hpp_source.html">SFML/Graphics/RenderTexture.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sf::RenderTexture:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsf_1_1RenderTexture.png" usemap="#sf::RenderTexture_map" alt=""/>
|
|
<map id="sf::RenderTexture_map" name="sf::RenderTexture_map">
|
|
<area href="classsf_1_1RenderTarget.html" title="Base class for all render targets (window, texture, ...)" alt="sf::RenderTarget" shape="rect" coords="0,0,111,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a19ee6e5b4c40ad251803389b3953a9c6" id="r_a19ee6e5b4c40ad251803389b3953a9c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a19ee6e5b4c40ad251803389b3953a9c6">RenderTexture</a> ()</td></tr>
|
|
<tr class="memdesc:a19ee6e5b4c40ad251803389b3953a9c6"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a19ee6e5b4c40ad251803389b3953a9c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf267822e1f7b6c5564ba46b0a982389" id="r_aaf267822e1f7b6c5564ba46b0a982389"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf267822e1f7b6c5564ba46b0a982389">RenderTexture</a> (<a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size, const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &settings={})</td></tr>
|
|
<tr class="memdesc:aaf267822e1f7b6c5564ba46b0a982389"><td class="mdescLeft"> </td><td class="mdescRight">Construct a render-texture. <br /></td></tr>
|
|
<tr class="separator:aaf267822e1f7b6c5564ba46b0a982389"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fe70797441f914c9b3ce424b8a289ad" id="r_a3fe70797441f914c9b3ce424b8a289ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3fe70797441f914c9b3ce424b8a289ad">~RenderTexture</a> () override</td></tr>
|
|
<tr class="memdesc:a3fe70797441f914c9b3ce424b8a289ad"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a3fe70797441f914c9b3ce424b8a289ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a772a33c6df251d005aa51d717ed11dfa" id="r_a772a33c6df251d005aa51d717ed11dfa"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a772a33c6df251d005aa51d717ed11dfa">RenderTexture</a> (const <a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a772a33c6df251d005aa51d717ed11dfa"><td class="mdescLeft"> </td><td class="mdescRight">Deleted copy constructor. <br /></td></tr>
|
|
<tr class="separator:a772a33c6df251d005aa51d717ed11dfa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3057db6c6cfacf0f7e73ad2dd3ce7fdc" id="r_a3057db6c6cfacf0f7e73ad2dd3ce7fdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3057db6c6cfacf0f7e73ad2dd3ce7fdc">operator=</a> (const <a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a3057db6c6cfacf0f7e73ad2dd3ce7fdc"><td class="mdescLeft"> </td><td class="mdescRight">Deleted copy assignment. <br /></td></tr>
|
|
<tr class="separator:a3057db6c6cfacf0f7e73ad2dd3ce7fdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a500782991bde6ab68a2b4ab3a91b6f2b" id="r_a500782991bde6ab68a2b4ab3a91b6f2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a500782991bde6ab68a2b4ab3a91b6f2b">RenderTexture</a> (<a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:a500782991bde6ab68a2b4ab3a91b6f2b"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a500782991bde6ab68a2b4ab3a91b6f2b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6eac4f331fafbcae9d4bca1fe3e705e5" id="r_a6eac4f331fafbcae9d4bca1fe3e705e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6eac4f331fafbcae9d4bca1fe3e705e5">operator=</a> (<a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:a6eac4f331fafbcae9d4bca1fe3e705e5"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:a6eac4f331fafbcae9d4bca1fe3e705e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaa6b97ea84ce82289f6925d1d198035" id="r_acaa6b97ea84ce82289f6925d1d198035"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#acaa6b97ea84ce82289f6925d1d198035">resize</a> (<a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size, const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &settings={})</td></tr>
|
|
<tr class="memdesc:acaa6b97ea84ce82289f6925d1d198035"><td class="mdescLeft"> </td><td class="mdescRight">Resize the render-texture. <br /></td></tr>
|
|
<tr class="separator:acaa6b97ea84ce82289f6925d1d198035"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af08991e63c6020865dd07b20e27305b6" id="r_af08991e63c6020865dd07b20e27305b6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af08991e63c6020865dd07b20e27305b6">setSmooth</a> (bool smooth)</td></tr>
|
|
<tr class="memdesc:af08991e63c6020865dd07b20e27305b6"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable texture smoothing. <br /></td></tr>
|
|
<tr class="separator:af08991e63c6020865dd07b20e27305b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b43c007ab6643accc5dae84b5bc8f61" id="r_a5b43c007ab6643accc5dae84b5bc8f61"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b43c007ab6643accc5dae84b5bc8f61">isSmooth</a> () const</td></tr>
|
|
<tr class="memdesc:a5b43c007ab6643accc5dae84b5bc8f61"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the smooth filtering is enabled or not. <br /></td></tr>
|
|
<tr class="separator:a5b43c007ab6643accc5dae84b5bc8f61"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8f97b33512bf7d5b6be3da6f65f7365" id="r_af8f97b33512bf7d5b6be3da6f65f7365"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af8f97b33512bf7d5b6be3da6f65f7365">setRepeated</a> (bool repeated)</td></tr>
|
|
<tr class="memdesc:af8f97b33512bf7d5b6be3da6f65f7365"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable texture repeating. <br /></td></tr>
|
|
<tr class="separator:af8f97b33512bf7d5b6be3da6f65f7365"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a81c5a453a21c7e78299b062b97dc8c87" id="r_a81c5a453a21c7e78299b062b97dc8c87"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a81c5a453a21c7e78299b062b97dc8c87">isRepeated</a> () const</td></tr>
|
|
<tr class="memdesc:a81c5a453a21c7e78299b062b97dc8c87"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the texture is repeated or not. <br /></td></tr>
|
|
<tr class="separator:a81c5a453a21c7e78299b062b97dc8c87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ca34c8b7e00793c1d3ef4f9a834f8cc" id="r_a8ca34c8b7e00793c1d3ef4f9a834f8cc"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ca34c8b7e00793c1d3ef4f9a834f8cc">generateMipmap</a> ()</td></tr>
|
|
<tr class="memdesc:a8ca34c8b7e00793c1d3ef4f9a834f8cc"><td class="mdescLeft"> </td><td class="mdescRight">Generate a mipmap using the current texture data. <br /></td></tr>
|
|
<tr class="separator:a8ca34c8b7e00793c1d3ef4f9a834f8cc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a30eda291b7b7179e7a0d1506c953a424" id="r_a30eda291b7b7179e7a0d1506c953a424"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a30eda291b7b7179e7a0d1506c953a424">setActive</a> (bool active=true) override</td></tr>
|
|
<tr class="memdesc:a30eda291b7b7179e7a0d1506c953a424"><td class="mdescLeft"> </td><td class="mdescRight">Activate or deactivate the render-texture for rendering. <br /></td></tr>
|
|
<tr class="separator:a30eda291b7b7179e7a0d1506c953a424"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af92886d5faef3916caff9fa9ab32c555" id="r_af92886d5faef3916caff9fa9ab32c555"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af92886d5faef3916caff9fa9ab32c555">display</a> ()</td></tr>
|
|
<tr class="memdesc:af92886d5faef3916caff9fa9ab32c555"><td class="mdescLeft"> </td><td class="mdescRight">Update the contents of the target texture. <br /></td></tr>
|
|
<tr class="separator:af92886d5faef3916caff9fa9ab32c555"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7acc31207ad749f94805cbf4fa2acf03" id="r_a7acc31207ad749f94805cbf4fa2acf03"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7acc31207ad749f94805cbf4fa2acf03">getSize</a> () const override</td></tr>
|
|
<tr class="memdesc:a7acc31207ad749f94805cbf4fa2acf03"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the rendering region of the texture. <br /></td></tr>
|
|
<tr class="separator:a7acc31207ad749f94805cbf4fa2acf03"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9c9abcd802917012c50009f7b662c0c" id="r_ac9c9abcd802917012c50009f7b662c0c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac9c9abcd802917012c50009f7b662c0c">isSrgb</a> () const override</td></tr>
|
|
<tr class="memdesc:ac9c9abcd802917012c50009f7b662c0c"><td class="mdescLeft"> </td><td class="mdescRight">Tell if the render-texture will use sRGB encoding when drawing on it. <br /></td></tr>
|
|
<tr class="separator:ac9c9abcd802917012c50009f7b662c0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61a6eba45d5c9e5c913aebeccb7b7eda" id="r_a61a6eba45d5c9e5c913aebeccb7b7eda"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61a6eba45d5c9e5c913aebeccb7b7eda">getTexture</a> () const</td></tr>
|
|
<tr class="memdesc:a61a6eba45d5c9e5c913aebeccb7b7eda"><td class="mdescLeft"> </td><td class="mdescRight">Get a read-only reference to the target texture. <br /></td></tr>
|
|
<tr class="separator:a61a6eba45d5c9e5c913aebeccb7b7eda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee353fc2cd35edf0747e710301af3e4c" id="r_aee353fc2cd35edf0747e710301af3e4c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#aee353fc2cd35edf0747e710301af3e4c">clear</a> (<a class="el" href="classsf_1_1Color.html">Color</a> color=<a class="el" href="classsf_1_1Color.html#a77c688197b981338f0b19dc58bd2facd">Color::Black</a>)</td></tr>
|
|
<tr class="memdesc:aee353fc2cd35edf0747e710301af3e4c"><td class="mdescLeft"> </td><td class="mdescRight">Clear the entire target with a single color. <br /></td></tr>
|
|
<tr class="separator:aee353fc2cd35edf0747e710301af3e4c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b4dd9e35771ba842f0feb4ba52cebb9" id="r_a6b4dd9e35771ba842f0feb4ba52cebb9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a6b4dd9e35771ba842f0feb4ba52cebb9">clear</a> (<a class="el" href="classsf_1_1Color.html">Color</a> color, <a class="el" href="structsf_1_1StencilValue.html">StencilValue</a> stencilValue)</td></tr>
|
|
<tr class="memdesc:a6b4dd9e35771ba842f0feb4ba52cebb9"><td class="mdescLeft"> </td><td class="mdescRight">Clear the entire target with a single color and stencil value. <br /></td></tr>
|
|
<tr class="separator:a6b4dd9e35771ba842f0feb4ba52cebb9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5756ecc36a0ad169809063f8f2563cbe" id="r_a5756ecc36a0ad169809063f8f2563cbe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a5756ecc36a0ad169809063f8f2563cbe">clearStencil</a> (<a class="el" href="structsf_1_1StencilValue.html">StencilValue</a> stencilValue)</td></tr>
|
|
<tr class="memdesc:a5756ecc36a0ad169809063f8f2563cbe"><td class="mdescLeft"> </td><td class="mdescRight">Clear the stencil buffer to a specific value. <br /></td></tr>
|
|
<tr class="separator:a5756ecc36a0ad169809063f8f2563cbe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a063db6dd0a14913504af30e50cb6d946" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a063db6dd0a14913504af30e50cb6d946"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbf8dc5a1f4abbe15a3fbb915844c7ea" id="r_adbf8dc5a1f4abbe15a3fbb915844c7ea"><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#adbf8dc5a1f4abbe15a3fbb915844c7ea">getView</a> () const</td></tr>
|
|
<tr class="memdesc:adbf8dc5a1f4abbe15a3fbb915844c7ea"><td class="mdescLeft"> </td><td class="mdescRight">Get the view currently in use in the render target. <br /></td></tr>
|
|
<tr class="separator:adbf8dc5a1f4abbe15a3fbb915844c7ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7741129e3ef7ab4f0a40024fca13480c" id="r_a7741129e3ef7ab4f0a40024fca13480c"><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#a7741129e3ef7ab4f0a40024fca13480c">getDefaultView</a> () const</td></tr>
|
|
<tr class="memdesc:a7741129e3ef7ab4f0a40024fca13480c"><td class="mdescLeft"> </td><td class="mdescRight">Get the default view of the render target. <br /></td></tr>
|
|
<tr class="separator:a7741129e3ef7ab4f0a40024fca13480c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a865d462915dc2a1fae2ebfb3300382ac" id="r_a865d462915dc2a1fae2ebfb3300382ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">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. <br /></td></tr>
|
|
<tr class="separator:a865d462915dc2a1fae2ebfb3300382ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28db5c204007c2ccc806462ed6712da6" id="r_a28db5c204007c2ccc806462ed6712da6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a28db5c204007c2ccc806462ed6712da6">getScissor</a> (const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:a28db5c204007c2ccc806462ed6712da6"><td class="mdescLeft"> </td><td class="mdescRight">Get the scissor rectangle of a view, applied to this render target. <br /></td></tr>
|
|
<tr class="separator:a28db5c204007c2ccc806462ed6712da6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ce02e4fd30e065c4dbeec239ae579b3" id="r_a5ce02e4fd30e065c4dbeec239ae579b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a5ce02e4fd30e065c4dbeec239ae579b3">mapPixelToCoords</a> (<a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> point) const</td></tr>
|
|
<tr class="memdesc:a5ce02e4fd30e065c4dbeec239ae579b3"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from target coordinates to world coordinates, using the current view. <br /></td></tr>
|
|
<tr class="separator:a5ce02e4fd30e065c4dbeec239ae579b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7c5ec0787ffdcabfcee0f2b88dd4536" id="r_af7c5ec0787ffdcabfcee0f2b88dd4536"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#af7c5ec0787ffdcabfcee0f2b88dd4536">mapPixelToCoords</a> (<a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> point, const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:af7c5ec0787ffdcabfcee0f2b88dd4536"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from target coordinates to world coordinates. <br /></td></tr>
|
|
<tr class="separator:af7c5ec0787ffdcabfcee0f2b88dd4536"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab473e0723ba16cf913deb03774c8458c" id="r_ab473e0723ba16cf913deb03774c8458c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#ab473e0723ba16cf913deb03774c8458c">mapCoordsToPixel</a> (<a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> point) const</td></tr>
|
|
<tr class="memdesc:ab473e0723ba16cf913deb03774c8458c"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from world coordinates to target coordinates, using the current view. <br /></td></tr>
|
|
<tr class="separator:ab473e0723ba16cf913deb03774c8458c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07a8da6e2a9e3ce5f36344e3d8e7c41a" id="r_a07a8da6e2a9e3ce5f36344e3d8e7c41a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1RenderTarget.html#a07a8da6e2a9e3ce5f36344e3d8e7c41a">mapCoordsToPixel</a> (<a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> point, const <a class="el" href="classsf_1_1View.html">View</a> &view) const</td></tr>
|
|
<tr class="memdesc:a07a8da6e2a9e3ce5f36344e3d8e7c41a"><td class="mdescLeft"> </td><td class="mdescRight">Convert a point from world coordinates to target coordinates. <br /></td></tr>
|
|
<tr class="separator:a07a8da6e2a9e3ce5f36344e3d8e7c41a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12417a3bcc245c41d957b29583556f39" id="r_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="structsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="structsf_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. <br /></td></tr>
|
|
<tr class="separator:a12417a3bcc245c41d957b29583556f39"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a976bc94057799eb9f8a18ac5fdfd9b73" id="r_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="structsf_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="structsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="structsf_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. <br /></td></tr>
|
|
<tr class="separator:a976bc94057799eb9f8a18ac5fdfd9b73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3dc4d06f081d36ca1e8f1a1298d49abc" id="r_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="structsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="structsf_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. <br /></td></tr>
|
|
<tr class="separator:a3dc4d06f081d36ca1e8f1a1298d49abc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07cb25d4557a30146b24b25b242310ea" id="r_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="structsf_1_1RenderStates.html">RenderStates</a> &states=<a class="el" href="structsf_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. <br /></td></tr>
|
|
<tr class="separator:a07cb25d4557a30146b24b25b242310ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d1998464ccc54e789aaf990242b47f7" id="r_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. <br /></td></tr>
|
|
<tr class="separator:a8d1998464ccc54e789aaf990242b47f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad5a98401113df931ddcd54c080f7aa8e" id="r_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. <br /></td></tr>
|
|
<tr class="separator:ad5a98401113df931ddcd54c080f7aa8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aac7504990d27dada4bfe3c7866920765" id="r_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. <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 id="pub-static-methods" name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8fead30a35e73a6b2c307de4f152792c" id="r_a8fead30a35e73a6b2c307de4f152792c"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8fead30a35e73a6b2c307de4f152792c">getMaximumAntiAliasingLevel</a> ()</td></tr>
|
|
<tr class="memdesc:a8fead30a35e73a6b2c307de4f152792c"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum anti-aliasing level supported by the system. <br /></td></tr>
|
|
<tr class="separator:a8fead30a35e73a6b2c307de4f152792c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:af530274b34159d644e509b4b4dc43eb7" id="r_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. <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>Target for off-screen 2D rendering into a texture. </p>
|
|
<p><code><a class="el" href="classsf_1_1RenderTexture.html" title="Target for off-screen 2D rendering into a texture.">sf::RenderTexture</a></code> is the little brother of <code><a class="el" href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing.">sf::RenderWindow</a></code>.</p>
|
|
<p>It implements the same 2D drawing and OpenGL-related functions (see their base class <code><a class="el" href="classsf_1_1RenderTarget.html" title="Base class for all render targets (window, texture, ...)">sf::RenderTarget</a></code> for more details), the difference is that the result is stored in an off-screen texture rather than being show in a window.</p>
|
|
<p>Rendering to a texture can be useful in a variety of situations: </p><ul>
|
|
<li>precomputing a complex static texture (like a level's background from multiple tiles) </li>
|
|
<li>applying post-effects to the whole scene with shaders </li>
|
|
<li>creating a sprite from a 3D object rendered with OpenGL </li>
|
|
<li>etc.</li>
|
|
</ul>
|
|
<p>Usage example:</p>
|
|
<div class="fragment"><div class="line"><span class="comment">// Create a new render-window</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1RenderWindow.html">sf::RenderWindow</a> window(<a class="code hl_class" href="classsf_1_1VideoMode.html">sf::VideoMode</a>({800, 600}), <span class="stringliteral">"SFML window"</span>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Create a new render-texture</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1RenderTexture.html">sf::RenderTexture</a> texture({500, 500});</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// The main loop</span></div>
|
|
<div class="line"><span class="keywordflow">while</span> (window.<a class="code hl_function" href="classsf_1_1WindowBase.html#aa43559822564ef958dc664a90c57cba0">isOpen</a>())</div>
|
|
<div class="line">{</div>
|
|
<div class="line"> <span class="comment">// Event processing</span></div>
|
|
<div class="line"> <span class="comment">// ...</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Clear the whole texture with red color</span></div>
|
|
<div class="line"> texture.clear(<a class="code hl_variable" href="classsf_1_1Color.html#a127dbf55db9c07d0fa8f4bfcbb97594a">sf::Color::Red</a>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Draw stuff to the texture</span></div>
|
|
<div class="line"> texture.draw(sprite); <span class="comment">// sprite is a sf::Sprite</span></div>
|
|
<div class="line"> texture.draw(shape); <span class="comment">// shape is a sf::Shape</span></div>
|
|
<div class="line"> texture.draw(text); <span class="comment">// text is a sf::Text</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// We're done drawing to the texture</span></div>
|
|
<div class="line"> texture.display();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Now we start rendering to the window, clear it first</span></div>
|
|
<div class="line"> window.<a class="code hl_function" href="classsf_1_1RenderTarget.html#aee353fc2cd35edf0747e710301af3e4c">clear</a>();</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// Draw the texture</span></div>
|
|
<div class="line"> <a class="code hl_class" href="classsf_1_1Sprite.html">sf::Sprite</a> sprite(texture.getTexture());</div>
|
|
<div class="line"> window.<a class="code hl_function" href="classsf_1_1RenderTarget.html#a12417a3bcc245c41d957b29583556f39">draw</a>(sprite);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// End the current frame and display its contents on screen</span></div>
|
|
<div class="line"> window.<a class="code hl_function" href="classsf_1_1Window.html#adabf839cb103ac96cfc82f781638772a">display</a>();</div>
|
|
<div class="line">}</div>
|
|
<div class="ttc" id="aclasssf_1_1Color_html_a127dbf55db9c07d0fa8f4bfcbb97594a"><div class="ttname"><a href="classsf_1_1Color.html#a127dbf55db9c07d0fa8f4bfcbb97594a">sf::Color::Red</a></div><div class="ttdeci">static const Color Red</div><div class="ttdoc">Red predefined color.</div><div class="ttdef"><b>Definition</b> <a href="Color_8hpp_source.html#l00084">Color.hpp:84</a></div></div>
|
|
<div class="ttc" id="aclasssf_1_1RenderTarget_html_a12417a3bcc245c41d957b29583556f39"><div class="ttname"><a href="classsf_1_1RenderTarget.html#a12417a3bcc245c41d957b29583556f39">sf::RenderTarget::draw</a></div><div class="ttdeci">void draw(const Drawable &drawable, const RenderStates &states=RenderStates::Default)</div><div class="ttdoc">Draw a drawable object to the render target.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1RenderTarget_html_aee353fc2cd35edf0747e710301af3e4c"><div class="ttname"><a href="classsf_1_1RenderTarget.html#aee353fc2cd35edf0747e710301af3e4c">sf::RenderTarget::clear</a></div><div class="ttdeci">void clear(Color color=Color::Black)</div><div class="ttdoc">Clear the entire target with a single color.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1RenderTexture_html"><div class="ttname"><a href="classsf_1_1RenderTexture.html">sf::RenderTexture</a></div><div class="ttdoc">Target for off-screen 2D rendering into a texture.</div><div class="ttdef"><b>Definition</b> <a href="RenderTexture_8hpp_source.html#l00053">RenderTexture.hpp:54</a></div></div>
|
|
<div class="ttc" id="aclasssf_1_1RenderWindow_html"><div class="ttname"><a href="classsf_1_1RenderWindow.html">sf::RenderWindow</a></div><div class="ttdoc">Window that can serve as a target for 2D drawing.</div><div class="ttdef"><b>Definition</b> <a href="RenderWindow_8hpp_source.html#l00054">RenderWindow.hpp:55</a></div></div>
|
|
<div class="ttc" id="aclasssf_1_1Sprite_html"><div class="ttname"><a href="classsf_1_1Sprite.html">sf::Sprite</a></div><div class="ttdoc">Drawable representation of a texture, with its own transformations, color, etc.</div><div class="ttdef"><b>Definition</b> <a href="Sprite_8hpp_source.html#l00050">Sprite.hpp:51</a></div></div>
|
|
<div class="ttc" id="aclasssf_1_1VideoMode_html"><div class="ttname"><a href="classsf_1_1VideoMode.html">sf::VideoMode</a></div><div class="ttdoc">VideoMode defines a video mode (size, bpp)</div><div class="ttdef"><b>Definition</b> <a href="VideoMode_8hpp_source.html#l00043">VideoMode.hpp:44</a></div></div>
|
|
<div class="ttc" id="aclasssf_1_1WindowBase_html_aa43559822564ef958dc664a90c57cba0"><div class="ttname"><a href="classsf_1_1WindowBase.html#aa43559822564ef958dc664a90c57cba0">sf::WindowBase::isOpen</a></div><div class="ttdeci">bool isOpen() const</div><div class="ttdoc">Tell whether or not the window is open.</div></div>
|
|
<div class="ttc" id="aclasssf_1_1Window_html_adabf839cb103ac96cfc82f781638772a"><div class="ttname"><a href="classsf_1_1Window.html#adabf839cb103ac96cfc82f781638772a">sf::Window::display</a></div><div class="ttdeci">void display()</div><div class="ttdoc">Display on screen what has been rendered to the window so far.</div></div>
|
|
</div><!-- fragment --><p>Like <code><a class="el" href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing.">sf::RenderWindow</a></code>, <code><a class="el" href="classsf_1_1RenderTexture.html" title="Target for off-screen 2D rendering into a texture.">sf::RenderTexture</a></code> is still able to render direct OpenGL stuff. It is even possible to mix together OpenGL calls and regular SFML drawing commands. If you need a depth buffer for 3D rendering, don't forget to request it when calling <code>RenderTexture::create</code>.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1RenderTarget.html" title="Base class for all render targets (window, texture, ...)">sf::RenderTarget</a></code>, <code><a class="el" href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing.">sf::RenderWindow</a></code>, <code><a class="el" href="classsf_1_1View.html" title="2D camera that defines what region is shown on screen">sf::View</a></code>, <code><a class="el" href="classsf_1_1Texture.html" title="Image living on the graphics card that can be used for drawing.">sf::Texture</a></code> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="RenderTexture_8hpp_source.html#l00053">53</a> of file <a class="el" href="RenderTexture_8hpp_source.html">RenderTexture.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a19ee6e5b4c40ad251803389b3953a9c6" name="a19ee6e5b4c40ad251803389b3953a9c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a19ee6e5b4c40ad251803389b3953a9c6">◆ </a></span>RenderTexture() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTexture::RenderTexture </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Constructs a render-texture with width 0 and height 0.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#acaa6b97ea84ce82289f6925d1d198035" title="Resize the render-texture.">resize</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf267822e1f7b6c5564ba46b0a982389" name="aaf267822e1f7b6c5564ba46b0a982389"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf267822e1f7b6c5564ba46b0a982389">◆ </a></span>RenderTexture() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTexture::RenderTexture </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &</td> <td class="paramname"><span class="paramname"><em>settings</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct a render-texture. </p>
|
|
<p>The last parameter, <code>settings</code>, is useful if you want to enable multi-sampling or use the render-texture for OpenGL rendering that requires a depth or stencil buffer. Otherwise it is unnecessary, and you should leave this parameter at its default value.</p>
|
|
<p>After creation, the contents of the render-texture are undefined. Call <code><a class="el" href="classsf_1_1RenderTarget.html#aee353fc2cd35edf0747e710301af3e4c" title="Clear the entire target with a single color.">RenderTexture::clear</a></code> first to ensure a single color fill.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Width and height of the render-texture </td></tr>
|
|
<tr><td class="paramname">settings</td><td>Additional settings for the underlying OpenGL texture and context</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname"><a class="el" href="classsf_1_1Exception.html" title="Library-specific exception type.">sf::Exception</a></td><td>if creation was unsuccessful </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3fe70797441f914c9b3ce424b8a289ad" name="a3fe70797441f914c9b3ce424b8a289ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3fe70797441f914c9b3ce424b8a289ad">◆ </a></span>~RenderTexture()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTexture::~RenderTexture </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a772a33c6df251d005aa51d717ed11dfa" name="a772a33c6df251d005aa51d717ed11dfa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a772a33c6df251d005aa51d717ed11dfa">◆ </a></span>RenderTexture() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTexture::RenderTexture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deleted copy constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a500782991bde6ab68a2b4ab3a91b6f2b" name="a500782991bde6ab68a2b4ab3a91b6f2b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a500782991bde6ab68a2b4ab3a91b6f2b">◆ </a></span>RenderTexture() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::RenderTexture::RenderTexture </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6b4dd9e35771ba842f0feb4ba52cebb9" name="a6b4dd9e35771ba842f0feb4ba52cebb9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b4dd9e35771ba842f0feb4ba52cebb9">◆ </a></span>clear() <span class="overload">[1/2]</span></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::clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structsf_1_1StencilValue.html">StencilValue</a></td> <td class="paramname"><span class="paramname"><em>stencilValue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear the entire target with a single color and stencil value. </p>
|
|
<p>The specified stencil value is truncated to the bit width of the current stencil buffer.</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>
|
|
<tr><td class="paramname">stencilValue</td><td>Stencil value to clear to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee353fc2cd35edf0747e710301af3e4c" name="aee353fc2cd35edf0747e710301af3e4c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee353fc2cd35edf0747e710301af3e4c">◆ </a></span>clear() <span class="overload">[2/2]</span></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::clear </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Color.html">Color</a></td> <td class="paramname"><span class="paramname"><em>color</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="classsf_1_1Color.html#a77c688197b981338f0b19dc58bd2facd">Color::Black</a></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="a5756ecc36a0ad169809063f8f2563cbe" name="a5756ecc36a0ad169809063f8f2563cbe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5756ecc36a0ad169809063f8f2563cbe">◆ </a></span>clearStencil()</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::clearStencil </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structsf_1_1StencilValue.html">StencilValue</a></td> <td class="paramname"><span class="paramname"><em>stencilValue</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear the stencil buffer to a specific value. </p>
|
|
<p>The specified value is truncated to the bit width of the current stencil buffer.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stencilValue</td><td>Stencil value to clear to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af92886d5faef3916caff9fa9ab32c555" name="af92886d5faef3916caff9fa9ab32c555"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af92886d5faef3916caff9fa9ab32c555">◆ </a></span>display()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTexture::display </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the contents of the target texture. </p>
|
|
<p>This function updates the target texture with what has been drawn so far. Like for windows, calling this function is mandatory at the end of rendering. Not calling it may leave the texture in an undefined state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12417a3bcc245c41d957b29583556f39" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em>drawable</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1RenderStates.html">RenderStates</a> &</td> <td class="paramname"><span class="paramname"><em>states</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTarget::draw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1Vertex.html">Vertex</a> *</td> <td class="paramname"><span class="paramname"><em>vertices</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>vertexCount</em></span>, </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"><span class="paramname"><em>type</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1RenderStates.html">RenderStates</a> &</td> <td class="paramname"><span class="paramname"><em>states</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em>vertexBuffer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1RenderStates.html">RenderStates</a> &</td> <td class="paramname"><span class="paramname"><em>states</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="structsf_1_1Vertex.html" title="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" name="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="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em>vertexBuffer</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>firstVertex</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t</td> <td class="paramname"><span class="paramname"><em>vertexCount</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1RenderStates.html">RenderStates</a> &</td> <td class="paramname"><span class="paramname"><em>states</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="structsf_1_1RenderStates.html#ad29672df29f19ce50c3021d95f2bb062">RenderStates::Default</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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="structsf_1_1Vertex.html" title="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="a8ca34c8b7e00793c1d3ef4f9a834f8cc" name="a8ca34c8b7e00793c1d3ef4f9a834f8cc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ca34c8b7e00793c1d3ef4f9a834f8cc">◆ </a></span>generateMipmap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::RenderTexture::generateMipmap </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generate a mipmap using the current texture data. </p>
|
|
<p>This function is similar to <code><a class="el" href="classsf_1_1Texture.html#a7779a75c0324b5faff77602f871710a9" title="Generate a mipmap using the current texture data.">Texture::generateMipmap</a></code> and operates on the texture used as the target for drawing. Be aware that any draw operation may modify the base level image data. For this reason, calling this function only makes sense after all drawing is completed and display has been called. Not calling display after subsequent drawing will lead to undefined behavior if a mipmap had been previously generated.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if mipmap generation was successful, <code>false</code> if unsuccessful </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7741129e3ef7ab4f0a40024fca13480c" name="a7741129e3ef7ab4f0a40024fca13480c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7741129e3ef7ab4f0a40024fca13480c">◆ </a></span>getDefaultView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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><code><a class="el" href="classsf_1_1RenderTarget.html#a063db6dd0a14913504af30e50cb6d946" title="Change the current active view.">setView</a></code>, <code><a class="el" href="classsf_1_1RenderTarget.html#adbf8dc5a1f4abbe15a3fbb915844c7ea" title="Get the view currently in use in the render target.">getView</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8fead30a35e73a6b2c307de4f152792c" name="a8fead30a35e73a6b2c307de4f152792c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fead30a35e73a6b2c307de4f152792c">◆ </a></span>getMaximumAntiAliasingLevel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static unsigned int sf::RenderTexture::getMaximumAntiAliasingLevel </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the maximum anti-aliasing level supported by the system. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The maximum anti-aliasing level supported by the system </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28db5c204007c2ccc806462ed6712da6" name="a28db5c204007c2ccc806462ed6712da6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28db5c204007c2ccc806462ed6712da6">◆ </a></span>getScissor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> sf::RenderTarget::getScissor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1View.html">View</a> &</td> <td class="paramname"><span class="paramname"><em>view</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the scissor rectangle of a view, applied to this render target. </p>
|
|
<p>The scissor rectangle 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 scissor rectangle 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 scissor rectangle</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Scissor rectangle, expressed in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7acc31207ad749f94805cbf4fa2acf03" name="a7acc31207ad749f94805cbf4fa2acf03"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7acc31207ad749f94805cbf4fa2acf03">◆ </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"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> sf::RenderTexture::getSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the size of the rendering region of the texture. </p>
|
|
<p>The returned value is the size that you passed to the create function.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size in pixels </dd></dl>
|
|
|
|
<p>Implements <a class="el" href="classsf_1_1RenderTarget.html#a2e5ade2457d9fb4c4907ae5b3d9e94a5">sf::RenderTarget</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a61a6eba45d5c9e5c913aebeccb7b7eda" name="a61a6eba45d5c9e5c913aebeccb7b7eda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61a6eba45d5c9e5c913aebeccb7b7eda">◆ </a></span>getTexture()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Texture.html">Texture</a> & sf::RenderTexture::getTexture </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a read-only reference to the target texture. </p>
|
|
<p>After drawing to the render-texture and calling Display, you can retrieve the updated texture using this function, and draw it using a sprite (for example). The internal <code><a class="el" href="classsf_1_1Texture.html" title="Image living on the graphics card that can be used for drawing.">sf::Texture</a></code> of a render-texture is always the same instance, so that it is possible to call this function once and keep a reference to the texture even after it is modified.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Const reference to the texture </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adbf8dc5a1f4abbe15a3fbb915844c7ea" name="adbf8dc5a1f4abbe15a3fbb915844c7ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adbf8dc5a1f4abbe15a3fbb915844c7ea">◆ </a></span>getView()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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><code><a class="el" href="classsf_1_1RenderTarget.html#a063db6dd0a14913504af30e50cb6d946" title="Change the current active view.">setView</a></code>, <code><a class="el" href="classsf_1_1RenderTarget.html#a7741129e3ef7ab4f0a40024fca13480c" title="Get the default view of the render target.">getDefaultView</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a865d462915dc2a1fae2ebfb3300382ac" name="a865d462915dc2a1fae2ebfb3300382ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a865d462915dc2a1fae2ebfb3300382ac">◆ </a></span>getViewport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">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"><span class="paramname"><em>view</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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" name="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"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">inherited</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="a81c5a453a21c7e78299b062b97dc8c87" name="a81c5a453a21c7e78299b062b97dc8c87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a81c5a453a21c7e78299b062b97dc8c87">◆ </a></span>isRepeated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::RenderTexture::isRepeated </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tell whether the texture is repeated or not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if texture is repeated</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#af8f97b33512bf7d5b6be3da6f65f7365" title="Enable or disable texture repeating.">setRepeated</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b43c007ab6643accc5dae84b5bc8f61" name="a5b43c007ab6643accc5dae84b5bc8f61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b43c007ab6643accc5dae84b5bc8f61">◆ </a></span>isSmooth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::RenderTexture::isSmooth </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tell whether the smooth filtering is enabled or not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if texture smoothing is enabled</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#af08991e63c6020865dd07b20e27305b6" title="Enable or disable texture smoothing.">setSmooth</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9c9abcd802917012c50009f7b662c0c" name="ac9c9abcd802917012c50009f7b662c0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9c9abcd802917012c50009f7b662c0c">◆ </a></span>isSrgb()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::RenderTexture::isSrgb </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tell if the render-texture will use sRGB encoding when drawing on it. </p>
|
|
<p>You can request sRGB encoding for a render-texture by having the sRgbCapable flag set for the context parameter of <code>create()</code> method</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the render-texture use sRGB encoding, <code>false</code> otherwise </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classsf_1_1RenderTarget.html#aea6b58e5b2423c917e2664ecd4952687">sf::RenderTarget</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab473e0723ba16cf913deb03774c8458c" name="ab473e0723ba16cf913deb03774c8458c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab473e0723ba16cf913deb03774c8458c">◆ </a></span>mapCoordsToPixel() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> sf::RenderTarget::mapCoordsToPixel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a></td> <td class="paramname"><span class="paramname"><em>point</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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 <code>mapCoordsToPixel</code> function that implicitly uses the current view. It is equivalent to: </p><div class="fragment"><div class="line">target.mapCoordsToPixel(point, target.getView());</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><code><a class="el" href="classsf_1_1RenderTarget.html#a5ce02e4fd30e065c4dbeec239ae579b3" title="Convert a point from target coordinates to world coordinates, using the current view.">mapPixelToCoords</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a07a8da6e2a9e3ce5f36344e3d8e7c41a" name="a07a8da6e2a9e3ce5f36344e3d8e7c41a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a07a8da6e2a9e3ce5f36344e3d8e7c41a">◆ </a></span>mapCoordsToPixel() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a> sf::RenderTarget::mapCoordsToPixel </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a></td> <td class="paramname"><span class="paramname"><em>point</em></span>, </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"><span class="paramname"><em>view</em></span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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 <code>true</code> 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><code><a class="el" href="classsf_1_1RenderTarget.html#a5ce02e4fd30e065c4dbeec239ae579b3" title="Convert a point from target coordinates to world coordinates, using the current view.">mapPixelToCoords</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ce02e4fd30e065c4dbeec239ae579b3" name="a5ce02e4fd30e065c4dbeec239ae579b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ce02e4fd30e065c4dbeec239ae579b3">◆ </a></span>mapPixelToCoords() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> sf::RenderTarget::mapPixelToCoords </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a></td> <td class="paramname"><span class="paramname"><em>point</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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.mapPixelToCoords(point, target.getView());</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><code><a class="el" href="classsf_1_1RenderTarget.html#ab473e0723ba16cf913deb03774c8458c" title="Convert a point from world coordinates to target coordinates, using the current view.">mapCoordsToPixel</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7c5ec0787ffdcabfcee0f2b88dd4536" name="af7c5ec0787ffdcabfcee0f2b88dd4536"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7c5ec0787ffdcabfcee0f2b88dd4536">◆ </a></span>mapPixelToCoords() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacesf.html#af14b40e82368dd601a7ef8037214804d">Vector2f</a> sf::RenderTarget::mapPixelToCoords </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#af0ffe1b157a56931ee3a9a1a771a827a">Vector2i</a></td> <td class="paramname"><span class="paramname"><em>point</em></span>, </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"><span class="paramname"><em>view</em></span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">inherited</span></span> </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 <code>true</code> 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><code><a class="el" href="classsf_1_1RenderTarget.html#ab473e0723ba16cf913deb03774c8458c" title="Convert a point from world coordinates to target coordinates, using the current view.">mapCoordsToPixel</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3057db6c6cfacf0f7e73ad2dd3ce7fdc" name="a3057db6c6cfacf0f7e73ad2dd3ce7fdc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3057db6c6cfacf0f7e73ad2dd3ce7fdc">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> & sf::RenderTexture::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deleted copy assignment. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6eac4f331fafbcae9d4bca1fe3e705e5" name="a6eac4f331fafbcae9d4bca1fe3e705e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6eac4f331fafbcae9d4bca1fe3e705e5">◆ </a></span>operator=() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> & sf::RenderTexture::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a> &&</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move assignment operator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad5a98401113df931ddcd54c080f7aa8e" name="ad5a98401113df931ddcd54c080f7aa8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad5a98401113df931ddcd54c080f7aa8e">◆ </a></span>popGLStates()</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::popGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Restore the previously saved OpenGL render states and matrices. </p>
|
|
<p>See the description of <code>pushGLStates</code> to get a detailed description of these functions.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1RenderTarget.html#a8d1998464ccc54e789aaf990242b47f7" title="Save the current OpenGL render states and matrices.">pushGLStates</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d1998464ccc54e789aaf990242b47f7" name="a8d1998464ccc54e789aaf990242b47f7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d1998464ccc54e789aaf990242b47f7">◆ </a></span>pushGLStates()</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::pushGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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 <code>draw</code> 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><code><a class="el" href="classsf_1_1RenderTarget.html#ad5a98401113df931ddcd54c080f7aa8e" title="Restore the previously saved OpenGL render states and matrices.">popGLStates</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aac7504990d27dada4bfe3c7866920765" name="aac7504990d27dada4bfe3c7866920765"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aac7504990d27dada4bfe3c7866920765">◆ </a></span>resetGLStates()</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::resetGLStates </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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 <code>pushGLStates</code>/<code>popGLStates</code>. It makes sure that all OpenGL states needed by SFML are set, so that subsequent <code><a class="el" href="classsf_1_1RenderTarget.html#a12417a3bcc245c41d957b29583556f39" title="Draw a drawable object to the render target.">draw()</a></code> 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="acaa6b97ea84ce82289f6925d1d198035" name="acaa6b97ea84ce82289f6925d1d198035"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acaa6b97ea84ce82289f6925d1d198035">◆ </a></span>resize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::RenderTexture::resize </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structsf_1_1ContextSettings.html">ContextSettings</a> &</td> <td class="paramname"><span class="paramname"><em>settings</em></span><span class="paramdefsep"> = </span><span class="paramdefval">{}</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Resize the render-texture. </p>
|
|
<p>The last parameter, <code>settings</code>, is useful if you want to enable multi-sampling or use the render-texture for OpenGL rendering that requires a depth or stencil buffer. Otherwise it is unnecessary, and you should leave this parameter at its default value.</p>
|
|
<p>After resizing, the contents of the render-texture are undefined. Call <code><a class="el" href="classsf_1_1RenderTarget.html#aee353fc2cd35edf0747e710301af3e4c" title="Clear the entire target with a single color.">RenderTexture::clear</a></code> first to ensure a single color fill.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Width and height of the render-texture </td></tr>
|
|
<tr><td class="paramname">settings</td><td>Additional settings for the underlying OpenGL texture and context</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if resizing has been successful, <code>false</code> if it failed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a30eda291b7b7179e7a0d1506c953a424" name="a30eda291b7b7179e7a0d1506c953a424"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30eda291b7b7179e7a0d1506c953a424">◆ </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">bool sf::RenderTexture::setActive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>active</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">nodiscard</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Activate or deactivate the render-texture for rendering. </p>
|
|
<p>This function makes the render-texture's context current for future OpenGL rendering operations (so you shouldn't care about it if you're not doing direct OpenGL stuff). Only one context can be current in a thread, so if you want to draw OpenGL geometry to another render target (like a <a class="el" href="classsf_1_1RenderWindow.html" title="Window that can serve as a target for 2D drawing.">RenderWindow</a>) don't forget to activate it again.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">active</td><td><code>true</code> to activate, <code>false</code> to deactivate</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if operation was successful, <code>false</code> otherwise </dd></dl>
|
|
|
|
<p>Reimplemented from <a class="el" href="classsf_1_1RenderTarget.html#adc225ead22a70843ffa9b7eebefa0ce1">sf::RenderTarget</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8f97b33512bf7d5b6be3da6f65f7365" name="af8f97b33512bf7d5b6be3da6f65f7365"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8f97b33512bf7d5b6be3da6f65f7365">◆ </a></span>setRepeated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTexture::setRepeated </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>repeated</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable or disable texture repeating. </p>
|
|
<p>This function is similar to <code><a class="el" href="classsf_1_1Texture.html#aaa87d1eff053b9d4d34a24c784a28658" title="Enable or disable repeating.">Texture::setRepeated</a></code>. This parameter is disabled by default.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">repeated</td><td><code>true</code> to enable repeating, <code>false</code> to disable it</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a81c5a453a21c7e78299b062b97dc8c87" title="Tell whether the texture is repeated or not.">isRepeated</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af08991e63c6020865dd07b20e27305b6" name="af08991e63c6020865dd07b20e27305b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af08991e63c6020865dd07b20e27305b6">◆ </a></span>setSmooth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::RenderTexture::setSmooth </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>smooth</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enable or disable texture smoothing. </p>
|
|
<p>This function is similar to <code><a class="el" href="classsf_1_1Texture.html#a0c3bd6825b9a99714f10d44179d74324" title="Enable or disable the smooth filter.">Texture::setSmooth</a></code>. This parameter is disabled by default.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">smooth</td><td><code>true</code> to enable smoothing, <code>false</code> to disable it</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a5b43c007ab6643accc5dae84b5bc8f61" title="Tell whether the smooth filtering is enabled or not.">isSmooth</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a063db6dd0a14913504af30e50cb6d946" name="a063db6dd0a14913504af30e50cb6d946"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a063db6dd0a14913504af30e50cb6d946">◆ </a></span>setView()</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::setView </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1View.html">View</a> &</td> <td class="paramname"><span class="paramname"><em>view</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </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 <code><a class="el" href="classsf_1_1RenderTarget.html#a7741129e3ef7ab4f0a40024fca13480c" title="Get the default view of the render target.">getDefaultView()</a></code> 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><code><a class="el" href="classsf_1_1RenderTarget.html#adbf8dc5a1f4abbe15a3fbb915844c7ea" title="Get the view currently in use in the render target.">getView</a></code>, <code><a class="el" href="classsf_1_1RenderTarget.html#a7741129e3ef7ab4f0a40024fca13480c" title="Get the default view of the render target.">getDefaultView</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="RenderTexture_8hpp_source.html">RenderTexture.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>
|