1810 lines
117 KiB
HTML
1810 lines
117 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_1Texture.html">Texture</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="#friends">Friends</a> |
|
|
<a href="classsf_1_1Texture-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">sf::Texture Class Reference<div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> living on the graphics card that can be used for drawing.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Texture_8hpp_source.html">SFML/Graphics/Texture.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sf::Texture:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsf_1_1Texture.png" usemap="#sf::Texture_map" alt=""/>
|
|
<map id="sf::Texture_map" name="sf::Texture_map">
|
|
<area href="classsf_1_1GlResource.html" title="Base class for classes that require an OpenGL context." alt="sf::GlResource" shape="rect" coords="0,0,94,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:a3e04674853b8533bf981db3173e3a4a7" id="r_a3e04674853b8533bf981db3173e3a4a7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3e04674853b8533bf981db3173e3a4a7">Texture</a> ()</td></tr>
|
|
<tr class="memdesc:a3e04674853b8533bf981db3173e3a4a7"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a3e04674853b8533bf981db3173e3a4a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c5354ad40eb1c5aeeeb21f57ccd7e6c" id="r_a9c5354ad40eb1c5aeeeb21f57ccd7e6c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9c5354ad40eb1c5aeeeb21f57ccd7e6c">~Texture</a> ()</td></tr>
|
|
<tr class="memdesc:a9c5354ad40eb1c5aeeeb21f57ccd7e6c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
|
|
<tr class="separator:a9c5354ad40eb1c5aeeeb21f57ccd7e6c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a524855cbf89de3b74be84d385fd229de" id="r_a524855cbf89de3b74be84d385fd229de"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a524855cbf89de3b74be84d385fd229de">Texture</a> (const <a class="el" href="classsf_1_1Texture.html">Texture</a> &copy)</td></tr>
|
|
<tr class="memdesc:a524855cbf89de3b74be84d385fd229de"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
|
|
<tr class="separator:a524855cbf89de3b74be84d385fd229de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c367f5b523126270ddc92f3775e275f" id="r_a5c367f5b523126270ddc92f3775e275f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c367f5b523126270ddc92f3775e275f">operator=</a> (const <a class="el" href="classsf_1_1Texture.html">Texture</a> &)</td></tr>
|
|
<tr class="memdesc:a5c367f5b523126270ddc92f3775e275f"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator. <br /></td></tr>
|
|
<tr class="separator:a5c367f5b523126270ddc92f3775e275f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82114d6745e2c7a72bb5628e9e2cf5c1" id="r_a82114d6745e2c7a72bb5628e9e2cf5c1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a82114d6745e2c7a72bb5628e9e2cf5c1">Texture</a> (<a class="el" href="classsf_1_1Texture.html">Texture</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:a82114d6745e2c7a72bb5628e9e2cf5c1"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
|
|
<tr class="separator:a82114d6745e2c7a72bb5628e9e2cf5c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac516add37466f0644fe4fd2ee2ec02c5" id="r_ac516add37466f0644fe4fd2ee2ec02c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Texture.html">Texture</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac516add37466f0644fe4fd2ee2ec02c5">operator=</a> (<a class="el" href="classsf_1_1Texture.html">Texture</a> &&) noexcept</td></tr>
|
|
<tr class="memdesc:ac516add37466f0644fe4fd2ee2ec02c5"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
|
|
<tr class="separator:ac516add37466f0644fe4fd2ee2ec02c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c8e0c560808589b7c0baa7edcb0afc8" id="r_a7c8e0c560808589b7c0baa7edcb0afc8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c8e0c560808589b7c0baa7edcb0afc8">Texture</a> (const std::filesystem::path &filename, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:a7c8e0c560808589b7c0baa7edcb0afc8"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a file on disk. <br /></td></tr>
|
|
<tr class="separator:a7c8e0c560808589b7c0baa7edcb0afc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ecabd6ee1ff50fbb3845e0824eee2c9" id="r_a9ecabd6ee1ff50fbb3845e0824eee2c9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9ecabd6ee1ff50fbb3845e0824eee2c9">Texture</a> (const std::filesystem::path &filename, bool sRgb, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area)</td></tr>
|
|
<tr class="memdesc:a9ecabd6ee1ff50fbb3845e0824eee2c9"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a sub-rectangle of a file on disk. <br /></td></tr>
|
|
<tr class="separator:a9ecabd6ee1ff50fbb3845e0824eee2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7638970bd080015e0982eae7212c703" id="r_ac7638970bd080015e0982eae7212c703"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7638970bd080015e0982eae7212c703">Texture</a> (const void *data, std::size_t size, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:ac7638970bd080015e0982eae7212c703"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a file in memory. <br /></td></tr>
|
|
<tr class="separator:ac7638970bd080015e0982eae7212c703"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4898788e648ed7507818d49d32d613d3" id="r_a4898788e648ed7507818d49d32d613d3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4898788e648ed7507818d49d32d613d3">Texture</a> (const void *data, std::size_t size, bool sRgb, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area)</td></tr>
|
|
<tr class="memdesc:a4898788e648ed7507818d49d32d613d3"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a sub-rectangle of a file in memory. <br /></td></tr>
|
|
<tr class="separator:a4898788e648ed7507818d49d32d613d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a378029d730e45eb3218c193f6ed0a024" id="r_a378029d730e45eb3218c193f6ed0a024"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a378029d730e45eb3218c193f6ed0a024">Texture</a> (<a class="el" href="classsf_1_1InputStream.html">InputStream</a> &stream, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:a378029d730e45eb3218c193f6ed0a024"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a custom stream. <br /></td></tr>
|
|
<tr class="separator:a378029d730e45eb3218c193f6ed0a024"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4a2400f27a2960774ecbf960a5928b8" id="r_aa4a2400f27a2960774ecbf960a5928b8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa4a2400f27a2960774ecbf960a5928b8">Texture</a> (<a class="el" href="classsf_1_1InputStream.html">InputStream</a> &stream, bool sRgb, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area)</td></tr>
|
|
<tr class="memdesc:aa4a2400f27a2960774ecbf960a5928b8"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a sub-rectangle of a custom stream. <br /></td></tr>
|
|
<tr class="separator:aa4a2400f27a2960774ecbf960a5928b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae07054c598ad20535665d8d41ff00fc9" id="r_ae07054c598ad20535665d8d41ff00fc9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae07054c598ad20535665d8d41ff00fc9">Texture</a> (const <a class="el" href="classsf_1_1Image.html">Image</a> &image, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:ae07054c598ad20535665d8d41ff00fc9"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from an image. <br /></td></tr>
|
|
<tr class="separator:ae07054c598ad20535665d8d41ff00fc9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af30fe609e89b5b2465f7907bee46a7d5" id="r_af30fe609e89b5b2465f7907bee46a7d5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af30fe609e89b5b2465f7907bee46a7d5">Texture</a> (const <a class="el" href="classsf_1_1Image.html">Image</a> &image, bool sRgb, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area)</td></tr>
|
|
<tr class="memdesc:af30fe609e89b5b2465f7907bee46a7d5"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture from a sub-rectangle of an image. <br /></td></tr>
|
|
<tr class="separator:af30fe609e89b5b2465f7907bee46a7d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5fd40286ce5bcec2e25519ea8e5d5b99" id="r_a5fd40286ce5bcec2e25519ea8e5d5b99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5fd40286ce5bcec2e25519ea8e5d5b99">Texture</a> (<a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:a5fd40286ce5bcec2e25519ea8e5d5b99"><td class="mdescLeft"> </td><td class="mdescRight">Construct the texture with a given size. <br /></td></tr>
|
|
<tr class="separator:a5fd40286ce5bcec2e25519ea8e5d5b99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afdb3948ab1e12217ba8e8d88c2c17da2" id="r_afdb3948ab1e12217ba8e8d88c2c17da2"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#afdb3948ab1e12217ba8e8d88c2c17da2">resize</a> (<a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size, bool sRgb=false)</td></tr>
|
|
<tr class="memdesc:afdb3948ab1e12217ba8e8d88c2c17da2"><td class="mdescLeft"> </td><td class="mdescRight">Resize the texture. <br /></td></tr>
|
|
<tr class="separator:afdb3948ab1e12217ba8e8d88c2c17da2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d6d90f015446eecb9a1e4cef8dc17b1" id="r_a9d6d90f015446eecb9a1e4cef8dc17b1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1">loadFromFile</a> (const std::filesystem::path &filename, bool sRgb=false, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area={})</td></tr>
|
|
<tr class="memdesc:a9d6d90f015446eecb9a1e4cef8dc17b1"><td class="mdescLeft"> </td><td class="mdescRight">Load the texture from a file on disk. <br /></td></tr>
|
|
<tr class="separator:a9d6d90f015446eecb9a1e4cef8dc17b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa368fb192f16a9e5d91e3c3221c02730" id="r_aa368fb192f16a9e5d91e3c3221c02730"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730">loadFromMemory</a> (const void *data, std::size_t size, bool sRgb=false, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area={})</td></tr>
|
|
<tr class="memdesc:aa368fb192f16a9e5d91e3c3221c02730"><td class="mdescLeft"> </td><td class="mdescRight">Load the texture from a file in memory. <br /></td></tr>
|
|
<tr class="separator:aa368fb192f16a9e5d91e3c3221c02730"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a69b245af8060fc7765b7eed4a6b1467d" id="r_a69b245af8060fc7765b7eed4a6b1467d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d">loadFromStream</a> (<a class="el" href="classsf_1_1InputStream.html">InputStream</a> &stream, bool sRgb=false, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area={})</td></tr>
|
|
<tr class="memdesc:a69b245af8060fc7765b7eed4a6b1467d"><td class="mdescLeft"> </td><td class="mdescRight">Load the texture from a custom stream. <br /></td></tr>
|
|
<tr class="separator:a69b245af8060fc7765b7eed4a6b1467d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee0c1bcf723e19e2a2c5bdeee61dbfc3" id="r_aee0c1bcf723e19e2a2c5bdeee61dbfc3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3">loadFromImage</a> (const <a class="el" href="classsf_1_1Image.html">Image</a> &image, bool sRgb=false, const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &area={})</td></tr>
|
|
<tr class="memdesc:aee0c1bcf723e19e2a2c5bdeee61dbfc3"><td class="mdescLeft"> </td><td class="mdescRight">Load the texture from an image. <br /></td></tr>
|
|
<tr class="separator:aee0c1bcf723e19e2a2c5bdeee61dbfc3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f86b8cc670c6399c539d4ce07ae5c8a" id="r_a9f86b8cc670c6399c539d4ce07ae5c8a"><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="#a9f86b8cc670c6399c539d4ce07ae5c8a">getSize</a> () const</td></tr>
|
|
<tr class="memdesc:a9f86b8cc670c6399c539d4ce07ae5c8a"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of the texture. <br /></td></tr>
|
|
<tr class="separator:a9f86b8cc670c6399c539d4ce07ae5c8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77e18a70de2e525ac5e4a7cd95f614b9" id="r_a77e18a70de2e525ac5e4a7cd95f614b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a77e18a70de2e525ac5e4a7cd95f614b9">copyToImage</a> () const</td></tr>
|
|
<tr class="memdesc:a77e18a70de2e525ac5e4a7cd95f614b9"><td class="mdescLeft"> </td><td class="mdescRight">Copy the texture pixels to an image. <br /></td></tr>
|
|
<tr class="separator:a77e18a70de2e525ac5e4a7cd95f614b9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeaf40495f5860120b95d190def4f8bbc" id="r_aeaf40495f5860120b95d190def4f8bbc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aeaf40495f5860120b95d190def4f8bbc">update</a> (const std::uint8_t *pixels)</td></tr>
|
|
<tr class="memdesc:aeaf40495f5860120b95d190def4f8bbc"><td class="mdescLeft"> </td><td class="mdescRight">Update the whole texture from an array of pixels. <br /></td></tr>
|
|
<tr class="separator:aeaf40495f5860120b95d190def4f8bbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a441454e2ab99b4da7201970e4ef14b76" id="r_a441454e2ab99b4da7201970e4ef14b76"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a441454e2ab99b4da7201970e4ef14b76">update</a> (const std::uint8_t *pixels, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> size, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> dest)</td></tr>
|
|
<tr class="memdesc:a441454e2ab99b4da7201970e4ef14b76"><td class="mdescLeft"> </td><td class="mdescRight">Update a part of the texture from an array of pixels. <br /></td></tr>
|
|
<tr class="separator:a441454e2ab99b4da7201970e4ef14b76"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9885ca00b74950d60feea28132d9691" id="r_af9885ca00b74950d60feea28132d9691"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#af9885ca00b74950d60feea28132d9691">update</a> (const <a class="el" href="classsf_1_1Texture.html">Texture</a> &texture)</td></tr>
|
|
<tr class="memdesc:af9885ca00b74950d60feea28132d9691"><td class="mdescLeft"> </td><td class="mdescRight">Update a part of this texture from another texture. <br /></td></tr>
|
|
<tr class="separator:af9885ca00b74950d60feea28132d9691"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52160e5c928f05f31adf5700908067c6" id="r_a52160e5c928f05f31adf5700908067c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a52160e5c928f05f31adf5700908067c6">update</a> (const <a class="el" href="classsf_1_1Texture.html">Texture</a> &texture, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> dest)</td></tr>
|
|
<tr class="memdesc:a52160e5c928f05f31adf5700908067c6"><td class="mdescLeft"> </td><td class="mdescRight">Update a part of this texture from another texture. <br /></td></tr>
|
|
<tr class="separator:a52160e5c928f05f31adf5700908067c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a037cdf171af0fb392d07626a44a4ea17" id="r_a037cdf171af0fb392d07626a44a4ea17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a037cdf171af0fb392d07626a44a4ea17">update</a> (const <a class="el" href="classsf_1_1Image.html">Image</a> &image)</td></tr>
|
|
<tr class="memdesc:a037cdf171af0fb392d07626a44a4ea17"><td class="mdescLeft"> </td><td class="mdescRight">Update the texture from an image. <br /></td></tr>
|
|
<tr class="separator:a037cdf171af0fb392d07626a44a4ea17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abe76f6c20c15483253a60c463846f502" id="r_abe76f6c20c15483253a60c463846f502"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#abe76f6c20c15483253a60c463846f502">update</a> (const <a class="el" href="classsf_1_1Image.html">Image</a> &image, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> dest)</td></tr>
|
|
<tr class="memdesc:abe76f6c20c15483253a60c463846f502"><td class="mdescLeft"> </td><td class="mdescRight">Update a part of the texture from an image. <br /></td></tr>
|
|
<tr class="separator:abe76f6c20c15483253a60c463846f502"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3cceef238f7d5d2108a98dd38c17fc5" id="r_ad3cceef238f7d5d2108a98dd38c17fc5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3cceef238f7d5d2108a98dd38c17fc5">update</a> (const <a class="el" href="classsf_1_1Window.html">Window</a> &window)</td></tr>
|
|
<tr class="memdesc:ad3cceef238f7d5d2108a98dd38c17fc5"><td class="mdescLeft"> </td><td class="mdescRight">Update the texture from the contents of a window. <br /></td></tr>
|
|
<tr class="separator:ad3cceef238f7d5d2108a98dd38c17fc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbdd185b65785a2b5ef5c7dc8114feae" id="r_abbdd185b65785a2b5ef5c7dc8114feae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#abbdd185b65785a2b5ef5c7dc8114feae">update</a> (const <a class="el" href="classsf_1_1Window.html">Window</a> &window, <a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a> dest)</td></tr>
|
|
<tr class="memdesc:abbdd185b65785a2b5ef5c7dc8114feae"><td class="mdescLeft"> </td><td class="mdescRight">Update a part of the texture from the contents of a window. <br /></td></tr>
|
|
<tr class="separator:abbdd185b65785a2b5ef5c7dc8114feae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c3bd6825b9a99714f10d44179d74324" id="r_a0c3bd6825b9a99714f10d44179d74324"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c3bd6825b9a99714f10d44179d74324">setSmooth</a> (bool smooth)</td></tr>
|
|
<tr class="memdesc:a0c3bd6825b9a99714f10d44179d74324"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable the smooth filter. <br /></td></tr>
|
|
<tr class="separator:a0c3bd6825b9a99714f10d44179d74324"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3ebb050b5a71e1d40ba66eb1a060e103" id="r_a3ebb050b5a71e1d40ba66eb1a060e103"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a3ebb050b5a71e1d40ba66eb1a060e103">isSmooth</a> () const</td></tr>
|
|
<tr class="memdesc:a3ebb050b5a71e1d40ba66eb1a060e103"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the smooth filter is enabled or not. <br /></td></tr>
|
|
<tr class="separator:a3ebb050b5a71e1d40ba66eb1a060e103"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d77ce4f8124abfda96900a6bd53bfe9" id="r_a9d77ce4f8124abfda96900a6bd53bfe9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d77ce4f8124abfda96900a6bd53bfe9">isSrgb</a> () const</td></tr>
|
|
<tr class="memdesc:a9d77ce4f8124abfda96900a6bd53bfe9"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the texture source is converted from sRGB or not. <br /></td></tr>
|
|
<tr class="separator:a9d77ce4f8124abfda96900a6bd53bfe9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa87d1eff053b9d4d34a24c784a28658" id="r_aaa87d1eff053b9d4d34a24c784a28658"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa87d1eff053b9d4d34a24c784a28658">setRepeated</a> (bool repeated)</td></tr>
|
|
<tr class="memdesc:aaa87d1eff053b9d4d34a24c784a28658"><td class="mdescLeft"> </td><td class="mdescRight">Enable or disable repeating. <br /></td></tr>
|
|
<tr class="separator:aaa87d1eff053b9d4d34a24c784a28658"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1a1a32ca5c799204b2bea4040df7647" id="r_af1a1a32ca5c799204b2bea4040df7647"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#af1a1a32ca5c799204b2bea4040df7647">isRepeated</a> () const</td></tr>
|
|
<tr class="memdesc:af1a1a32ca5c799204b2bea4040df7647"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether the texture is repeated or not. <br /></td></tr>
|
|
<tr class="separator:af1a1a32ca5c799204b2bea4040df7647"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7779a75c0324b5faff77602f871710a9" id="r_a7779a75c0324b5faff77602f871710a9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7779a75c0324b5faff77602f871710a9">generateMipmap</a> ()</td></tr>
|
|
<tr class="memdesc:a7779a75c0324b5faff77602f871710a9"><td class="mdescLeft"> </td><td class="mdescRight">Generate a mipmap using the current texture data. <br /></td></tr>
|
|
<tr class="separator:a7779a75c0324b5faff77602f871710a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa34ea4d761ca4d1bb4a9a9e3d581fa51" id="r_aa34ea4d761ca4d1bb4a9a9e3d581fa51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa34ea4d761ca4d1bb4a9a9e3d581fa51">swap</a> (<a class="el" href="classsf_1_1Texture.html">Texture</a> &right) noexcept</td></tr>
|
|
<tr class="memdesc:aa34ea4d761ca4d1bb4a9a9e3d581fa51"><td class="mdescLeft"> </td><td class="mdescRight">Swap the contents of this texture with those of another. <br /></td></tr>
|
|
<tr class="separator:aa34ea4d761ca4d1bb4a9a9e3d581fa51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a674b632608747bfc27b53a4935c835b0" id="r_a674b632608747bfc27b53a4935c835b0"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a674b632608747bfc27b53a4935c835b0">getNativeHandle</a> () const</td></tr>
|
|
<tr class="memdesc:a674b632608747bfc27b53a4935c835b0"><td class="mdescLeft"> </td><td class="mdescRight">Get the underlying OpenGL handle of the texture. <br /></td></tr>
|
|
<tr class="separator:a674b632608747bfc27b53a4935c835b0"><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:a2f78031f82912436804d9b76290b3534" id="r_a2f78031f82912436804d9b76290b3534"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f78031f82912436804d9b76290b3534">bind</a> (const <a class="el" href="classsf_1_1Texture.html">Texture</a> *texture, <a class="el" href="group__graphics.html#ga3279cc83ec99c60693c4fe6d0d3fb98b">CoordinateType</a> coordinateType=<a class="el" href="group__graphics.html#gga3279cc83ec99c60693c4fe6d0d3fb98ba66b28fcf83c9f24cd5b4d7bdc8f8ba0e">CoordinateType::Normalized</a>)</td></tr>
|
|
<tr class="memdesc:a2f78031f82912436804d9b76290b3534"><td class="mdescLeft"> </td><td class="mdescRight">Bind a texture for rendering. <br /></td></tr>
|
|
<tr class="separator:a2f78031f82912436804d9b76290b3534"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0bf905d487b104b758549c2e9e20a3fb" id="r_a0bf905d487b104b758549c2e9e20a3fb"><td class="memItemLeft" align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bf905d487b104b758549c2e9e20a3fb">getMaximumSize</a> ()</td></tr>
|
|
<tr class="memdesc:a0bf905d487b104b758549c2e9e20a3fb"><td class="mdescLeft"> </td><td class="mdescRight">Get the maximum texture size allowed. <br /></td></tr>
|
|
<tr class="separator:a0bf905d487b104b758549c2e9e20a3fb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:aee0ad1dafe471596e6d25530d9fbaf0c" id="r_aee0ad1dafe471596e6d25530d9fbaf0c"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#aee0ad1dafe471596e6d25530d9fbaf0c">Text</a></td></tr>
|
|
<tr class="separator:aee0ad1dafe471596e6d25530d9fbaf0c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2548fc9744f5e43e0276d5627ca178de" id="r_a2548fc9744f5e43e0276d5627ca178de"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2548fc9744f5e43e0276d5627ca178de">RenderTexture</a></td></tr>
|
|
<tr class="separator:a2548fc9744f5e43e0276d5627ca178de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa5afc6f82b7b587ed5ada4d227ce32aa" id="r_aa5afc6f82b7b587ed5ada4d227ce32aa"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa5afc6f82b7b587ed5ada4d227ce32aa">RenderTarget</a></td></tr>
|
|
<tr class="separator:aa5afc6f82b7b587ed5ada4d227ce32aa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> living on the graphics card that can be used for drawing. </p>
|
|
<p><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> stores pixels that can be drawn, with a sprite for example.</p>
|
|
<p>A texture lives in the graphics card memory, therefore it is very fast to draw a texture to a render target, or copy a render target to a texture (the graphics card can access both directly).</p>
|
|
<p>Being stored in the graphics card memory has some drawbacks. A texture cannot be manipulated as freely as a <code><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">sf::Image</a></code>, you need to prepare the pixels first and then upload them to the texture in a single operation (see <code><a class="el" href="#aeaf40495f5860120b95d190def4f8bbc" title="Update the whole texture from an array of pixels.">Texture::update</a></code>).</p>
|
|
<p><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> makes it easy to convert from/to <code><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">sf::Image</a></code>, but keep in mind that these calls require transfers between the graphics card and the central memory, therefore they are slow operations.</p>
|
|
<p>A texture can be loaded from an image, but also directly from a file/memory/stream. The necessary shortcuts are defined so that you don't need an image first for the most common cases. However, if you want to perform some modifications on the pixels before creating the final texture, you can load your file to a <code><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">sf::Image</a></code>, do whatever you need with the pixels, and then call <code><a class="el" href="classsf_1_1Texture.html" title="Image living on the graphics card that can be used for drawing.">Texture</a>(const <a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a>&)</code>.</p>
|
|
<p>Since they live in the graphics card memory, the pixels of a texture cannot be accessed without a slow copy first. And they cannot be accessed individually. Therefore, if you need to read the texture's pixels (like for pixel-perfect collisions), it is recommended to store the collision information separately, for example in an array of booleans.</p>
|
|
<p>Like <code><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">sf::Image</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> can handle a unique internal representation of pixels, which is RGBA 32 bits. This means that a pixel must be composed of 8 bit red, green, blue and alpha channels – just like a <code><a class="el" href="classsf_1_1Color.html" title="Utility class for manipulating RGBA colors.">sf::Color</a></code>.</p>
|
|
<p>When providing texture data from an image file or memory, it can either be stored in a linear color space or an sRGB color space. Most digital images account for gamma correction already, so they would need to be "uncorrected" back to linear color space before being processed by the hardware. The hardware can automatically convert it from the sRGB color space to a linear color space when it gets sampled. When the rendered image gets output to the final framebuffer, it gets converted back to sRGB.</p>
|
|
<p>This option is only useful in conjunction with an sRGB capable framebuffer. This can be requested during window creation.</p>
|
|
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// This example shows the most common use of sf::Texture:</span></div>
|
|
<div class="line"><span class="comment">// drawing a sprite</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Load a texture from a file</span></div>
|
|
<div class="line"><span class="keyword">const</span> <a class="code hl_class" href="classsf_1_1Texture.html">sf::Texture</a> texture(<span class="stringliteral">"texture.png"</span>);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Assign it to a sprite</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Sprite.html">sf::Sprite</a> sprite(texture);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Draw the textured sprite</span></div>
|
|
<div class="line">window.draw(sprite);</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_1Texture_html"><div class="ttname"><a href="classsf_1_1Texture.html">sf::Texture</a></div><div class="ttdoc">Image living on the graphics card that can be used for drawing.</div><div class="ttdef"><b>Definition</b> <a href="Texture_8hpp_source.html#l00055">Texture.hpp:56</a></div></div>
|
|
</div><!-- fragment --><div class="fragment"><div class="line"><span class="comment">// This example shows another common use of sf::Texture:</span></div>
|
|
<div class="line"><span class="comment">// streaming real-time data, like video frames</span></div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Create an empty texture</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Texture.html">sf::Texture</a> texture({640, 480});</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="comment">// Create a sprite that will display the texture</span></div>
|
|
<div class="line"><a class="code hl_class" href="classsf_1_1Sprite.html">sf::Sprite</a> sprite(texture);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"><span class="keywordflow">while</span> (...) <span class="comment">// the main loop</span></div>
|
|
<div class="line">{</div>
|
|
<div class="line"> ...</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// update the texture</span></div>
|
|
<div class="line"> std::uint8_t* pixels = ...; <span class="comment">// get a fresh chunk of pixels (the next frame of a movie, for example)</span></div>
|
|
<div class="line"> texture.update(pixels);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> <span class="comment">// draw it</span></div>
|
|
<div class="line"> window.draw(sprite);</div>
|
|
<div class="line"> </div>
|
|
<div class="line"> ...</div>
|
|
<div class="line">}</div>
|
|
</div><!-- fragment --><p>Like <code><a class="el" href="classsf_1_1Shader.html" title="Shader class (vertex, geometry and fragment)">sf::Shader</a></code> that can be used as a raw OpenGL shader, <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> can also be used directly as a raw texture for custom OpenGL geometry. </p><div class="fragment"><div class="line"><a class="code hl_function" href="#a2f78031f82912436804d9b76290b3534">sf::Texture::bind</a>(&texture);</div>
|
|
<div class="line">... render OpenGL geometry ...</div>
|
|
<div class="line">sf::Texture::bind(<span class="keyword">nullptr</span>);</div>
|
|
<div class="ttc" id="aclasssf_1_1Texture_html_a2f78031f82912436804d9b76290b3534"><div class="ttname"><a href="#a2f78031f82912436804d9b76290b3534">sf::Texture::bind</a></div><div class="ttdeci">static void bind(const Texture *texture, CoordinateType coordinateType=CoordinateType::Normalized)</div><div class="ttdoc">Bind a texture for rendering.</div></div>
|
|
</div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><code><a class="el" href="classsf_1_1Sprite.html" title="Drawable representation of a texture, with its own transformations, color, etc.">sf::Sprite</a></code>, <code><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">sf::Image</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> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Texture_8hpp_source.html#l00055">55</a> of file <a class="el" href="Texture_8hpp_source.html">Texture.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a3e04674853b8533bf981db3173e3a4a7" name="a3e04674853b8533bf981db3173e3a4a7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e04674853b8533bf981db3173e3a4a7">◆ </a></span>Texture() <span class="overload">[1/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </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>Creates a texture with width 0 and height 0.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#afdb3948ab1e12217ba8e8d88c2c17da2" title="Resize the texture.">resize</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c5354ad40eb1c5aeeeb21f57ccd7e6c" name="a9c5354ad40eb1c5aeeeb21f57ccd7e6c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c5354ad40eb1c5aeeeb21f57ccd7e6c">◆ </a></span>~Texture()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::~Texture </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a524855cbf89de3b74be84d385fd229de" name="a524855cbf89de3b74be84d385fd229de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a524855cbf89de3b74be84d385fd229de">◆ </a></span>Texture() <span class="overload">[2/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Texture.html">Texture</a> &</td> <td class="paramname"><span class="paramname"><em>copy</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">copy</td><td>instance to copy </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a82114d6745e2c7a72bb5628e9e2cf5c1" name="a82114d6745e2c7a72bb5628e9e2cf5c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a82114d6745e2c7a72bb5628e9e2cf5c1">◆ </a></span>Texture() <span class="overload">[3/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Texture.html">Texture</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>
|
|
<a id="a7c8e0c560808589b7c0baa7edcb0afc8" name="a7c8e0c560808589b7c0baa7edcb0afc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c8e0c560808589b7c0baa7edcb0afc8">◆ </a></span>Texture() <span class="overload">[4/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::filesystem::path &</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a file on disk. </p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the getMaximumSize function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path of the image file to load </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9ecabd6ee1ff50fbb3845e0824eee2c9" name="a9ecabd6ee1ff50fbb3845e0824eee2c9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9ecabd6ee1ff50fbb3845e0824eee2c9">◆ </a></span>Texture() <span class="overload">[5/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::filesystem::path &</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a sub-rectangle of a file on disk. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path of the image file to load </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac7638970bd080015e0982eae7212c703" name="ac7638970bd080015e0982eae7212c703"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac7638970bd080015e0982eae7212c703">◆ </a></span>Texture() <span class="overload">[6/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</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>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a file in memory. </p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the file data in memory </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the data to load, in bytes </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4898788e648ed7507818d49d32d613d3" name="a4898788e648ed7507818d49d32d613d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4898788e648ed7507818d49d32d613d3">◆ </a></span>Texture() <span class="overload">[7/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</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>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a sub-rectangle of a file in memory. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the file data in memory </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the data to load, in bytes </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a378029d730e45eb3218c193f6ed0a024" name="a378029d730e45eb3218c193f6ed0a024"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a378029d730e45eb3218c193f6ed0a024">◆ </a></span>Texture() <span class="overload">[8/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1InputStream.html">InputStream</a> &</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a custom stream. </p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>Source stream to read from </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa4a2400f27a2960774ecbf960a5928b8" name="aa4a2400f27a2960774ecbf960a5928b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa4a2400f27a2960774ecbf960a5928b8">◆ </a></span>Texture() <span class="overload">[9/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1InputStream.html">InputStream</a> &</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a sub-rectangle of a custom stream. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>Source stream to read from </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae07054c598ad20535665d8d41ff00fc9" name="ae07054c598ad20535665d8d41ff00fc9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae07054c598ad20535665d8d41ff00fc9">◆ </a></span>Texture() <span class="overload">[10/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Image.html">Image</a> &</td> <td class="paramname"><span class="paramname"><em>image</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from an image. </p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> to load into the texture </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af30fe609e89b5b2465f7907bee46a7d5" name="af30fe609e89b5b2465f7907bee46a7d5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af30fe609e89b5b2465f7907bee46a7d5">◆ </a></span>Texture() <span class="overload">[11/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Image.html">Image</a> &</td> <td class="paramname"><span class="paramname"><em>image</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture from a sub-rectangle of an image. </p>
|
|
<p>The <code>area</code> argument is used to load only a sub-rectangle of the whole image. If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> to load into the texture </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</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 loading was unsuccessful</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5fd40286ce5bcec2e25519ea8e5d5b99" name="a5fd40286ce5bcec2e25519ea8e5d5b99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5fd40286ce5bcec2e25519ea8e5d5b99">◆ </a></span>Texture() <span class="overload">[12/12]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Texture::Texture </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">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the texture with a given size. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Width and height of the texture </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</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 construction was unsuccessful </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2f78031f82912436804d9b76290b3534" name="a2f78031f82912436804d9b76290b3534"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2f78031f82912436804d9b76290b3534">◆ </a></span>bind()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void sf::Texture::bind </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Texture.html">Texture</a> *</td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="group__graphics.html#ga3279cc83ec99c60693c4fe6d0d3fb98b">CoordinateType</a></td> <td class="paramname"><span class="paramname"><em>coordinateType</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="group__graphics.html#gga3279cc83ec99c60693c4fe6d0d3fb98ba66b28fcf83c9f24cd5b4d7bdc8f8ba0e">CoordinateType::Normalized</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Bind a texture for rendering. </p>
|
|
<p>This function is not part of the graphics API, it mustn't be used when drawing SFML entities. It must be used only if you mix <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> with OpenGL code.</p>
|
|
<div class="fragment"><div class="line"><a class="code hl_class" href="classsf_1_1Texture.html">sf::Texture</a> t1, t2;</div>
|
|
<div class="line">...</div>
|
|
<div class="line">sf::Texture::bind(&t1);</div>
|
|
<div class="line"><span class="comment">// draw OpenGL stuff that use t1...</span></div>
|
|
<div class="line"><a class="code hl_function" href="#a2f78031f82912436804d9b76290b3534">sf::Texture::bind</a>(&t2);</div>
|
|
<div class="line"><span class="comment">// draw OpenGL stuff that use t2...</span></div>
|
|
<div class="line"><a class="code hl_function" href="#a2f78031f82912436804d9b76290b3534">sf::Texture::bind</a>(<span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><span class="comment">// draw OpenGL stuff that use no texture...</span></div>
|
|
</div><!-- fragment --><p>The <code>coordinateType</code> argument controls how texture coordinates will be interpreted. If Normalized (the default), they must be in range [0 .. 1], which is the default way of handling texture coordinates with OpenGL. If Pixels, they must be given in pixels (range [0 .. size]). This mode is used internally by the graphics classes of SFML, it makes the definition of texture coordinates more intuitive for the high-level API, users don't need to compute normalized values.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">texture</td><td>Pointer to the texture to bind, can be null to use no texture </td></tr>
|
|
<tr><td class="paramname">coordinateType</td><td>Type of texture coordinates to use </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77e18a70de2e525ac5e4a7cd95f614b9" name="a77e18a70de2e525ac5e4a7cd95f614b9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77e18a70de2e525ac5e4a7cd95f614b9">◆ </a></span>copyToImage()</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_1Image.html">Image</a> sf::Texture::copyToImage </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>Copy the texture pixels to an image. </p>
|
|
<p>This function performs a slow operation that downloads the texture's pixels from the graphics card and copies them to a new image, potentially applying transformations to pixels if necessary (texture may be padded or flipped).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> containing the texture's pixels</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7779a75c0324b5faff77602f871710a9" name="a7779a75c0324b5faff77602f871710a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7779a75c0324b5faff77602f871710a9">◆ </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::Texture::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>Mipmaps are pre-computed chains of optimized textures. Each level of texture in a mipmap is generated by halving each of the previous level's dimensions. This is done until the final level has the size of 1x1. The textures generated in this process may make use of more advanced filters which might improve the visual quality of textures when they are applied to objects much smaller than they are. This is known as minification. Because fewer texels (texture elements) have to be sampled from when heavily minified, usage of mipmaps can also improve rendering performance in certain scenarios.</p>
|
|
<p>Mipmap generation relies on the necessary OpenGL extension being available. If it is unavailable or generation fails due to another reason, this function will return <code>false</code>. Mipmap data is only valid from the time it is generated until the next time the base level image is modified, at which point this function will have to be called again to regenerate it.</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="a0bf905d487b104b758549c2e9e20a3fb" name="a0bf905d487b104b758549c2e9e20a3fb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0bf905d487b104b758549c2e9e20a3fb">◆ </a></span>getMaximumSize()</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::Texture::getMaximumSize </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 texture size allowed. </p>
|
|
<p>This maximum size is defined by the graphics driver. You can expect a value of 512 pixels for low-end graphics card, and up to 8192 pixels or more for newer hardware.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Maximum size allowed for textures, in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a674b632608747bfc27b53a4935c835b0" name="a674b632608747bfc27b53a4935c835b0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a674b632608747bfc27b53a4935c835b0">◆ </a></span>getNativeHandle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int sf::Texture::getNativeHandle </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 the underlying OpenGL handle of the texture. </p>
|
|
<p>You shouldn't need to use this function, unless you have very specific stuff to implement that SFML doesn't support, or implement a temporary workaround until a bug is fixed.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>OpenGL handle of the texture or 0 if not yet created </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f86b8cc670c6399c539d4ce07ae5c8a" name="a9f86b8cc670c6399c539d4ce07ae5c8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f86b8cc670c6399c539d4ce07ae5c8a">◆ </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::Texture::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the size of the texture. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size in pixels </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1a1a32ca5c799204b2bea4040df7647" name="af1a1a32ca5c799204b2bea4040df7647"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1a1a32ca5c799204b2bea4040df7647">◆ </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::Texture::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 repeat mode is enabled, <code>false</code> if it is disabled</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#aaa87d1eff053b9d4d34a24c784a28658" title="Enable or disable repeating.">setRepeated</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3ebb050b5a71e1d40ba66eb1a060e103" name="a3ebb050b5a71e1d40ba66eb1a060e103"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3ebb050b5a71e1d40ba66eb1a060e103">◆ </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::Texture::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 filter is enabled or not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if smoothing is enabled, <code>false</code> if it is disabled</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a0c3bd6825b9a99714f10d44179d74324" title="Enable or disable the smooth filter.">setSmooth</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d77ce4f8124abfda96900a6bd53bfe9" name="a9d77ce4f8124abfda96900a6bd53bfe9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d77ce4f8124abfda96900a6bd53bfe9">◆ </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::Texture::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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Tell whether the texture source is converted from sRGB or not. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the texture source is converted from sRGB, <code>false</code> if not</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code>setSrgb</code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d6d90f015446eecb9a1e4cef8dc17b1" name="a9d6d90f015446eecb9a1e4cef8dc17b1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d6d90f015446eecb9a1e4cef8dc17b1">◆ </a></span>loadFromFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::Texture::loadFromFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::filesystem::path &</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</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>Load the texture from a file on disk. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<p>If this function fails, the texture is left unchanged.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path of the image file to load </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if loading was successful, <code>false</code> if it failed</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee0c1bcf723e19e2a2c5bdeee61dbfc3" name="aee0c1bcf723e19e2a2c5bdeee61dbfc3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3">◆ </a></span>loadFromImage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::Texture::loadFromImage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Image.html">Image</a> &</td> <td class="paramname"><span class="paramname"><em>image</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</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>Load the texture from an image. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<p>If this function fails, the texture is left unchanged.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> to load into the texture </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if loading was successful, <code>false</code> if it failed</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa368fb192f16a9e5d91e3c3221c02730" name="aa368fb192f16a9e5d91e3c3221c02730"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa368fb192f16a9e5d91e3c3221c02730">◆ </a></span>loadFromMemory()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::Texture::loadFromMemory </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>data</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>size</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</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>Load the texture from a file in memory. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<p>If this function fails, the texture is left unchanged.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Pointer to the file data in memory </td></tr>
|
|
<tr><td class="paramname">size</td><td>Size of the data to load, in bytes </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if loading was successful, <code>false</code> if it failed</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#a69b245af8060fc7765b7eed4a6b1467d" title="Load the texture from a custom stream.">loadFromStream</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a69b245af8060fc7765b7eed4a6b1467d" name="a69b245af8060fc7765b7eed4a6b1467d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a69b245af8060fc7765b7eed4a6b1467d">◆ </a></span>loadFromStream()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sf::Texture::loadFromStream </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1InputStream.html">InputStream</a> &</td> <td class="paramname"><span class="paramname"><em>stream</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacesf.html#add1cf75a734c8414680b0424145c30b1">IntRect</a> &</td> <td class="paramname"><span class="paramname"><em>area</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>Load the texture from a custom stream. </p>
|
|
<p>The <code>area</code> argument can be used to load only a sub-rectangle of the whole image. If you want the entire image then leave the default value (which is an empty <code>IntRect</code>). If the <code>area</code> rectangle crosses the bounds of the image, it is adjusted to fit the image size.</p>
|
|
<p>The maximum size for a texture depends on the graphics driver and can be retrieved with the <code>getMaximumSize</code> function.</p>
|
|
<p>If this function fails, the texture is left unchanged.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">stream</td><td>Source stream to read from </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it </td></tr>
|
|
<tr><td class="paramname">area</td><td>Area of the image to load</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if loading was successful, <code>false</code> if it failed</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#a9d6d90f015446eecb9a1e4cef8dc17b1" title="Load the texture from a file on disk.">loadFromFile</a></code>, <code><a class="el" href="#aa368fb192f16a9e5d91e3c3221c02730" title="Load the texture from a file in memory.">loadFromMemory</a></code>, <code><a class="el" href="#aee0c1bcf723e19e2a2c5bdeee61dbfc3" title="Load the texture from an image.">loadFromImage</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c367f5b523126270ddc92f3775e275f" name="a5c367f5b523126270ddc92f3775e275f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c367f5b523126270ddc92f3775e275f">◆ </a></span>operator=() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Texture.html">Texture</a> & sf::Texture::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Texture.html">Texture</a> &</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy assignment operator. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac516add37466f0644fe4fd2ee2ec02c5" name="ac516add37466f0644fe4fd2ee2ec02c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac516add37466f0644fe4fd2ee2ec02c5">◆ </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_1Texture.html">Texture</a> & sf::Texture::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Texture.html">Texture</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="afdb3948ab1e12217ba8e8d88c2c17da2" name="afdb3948ab1e12217ba8e8d88c2c17da2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afdb3948ab1e12217ba8e8d88c2c17da2">◆ </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::Texture::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">bool</td> <td class="paramname"><span class="paramname"><em>sRgb</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</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 texture. </p>
|
|
<p>If this function fails, the texture is left unchanged.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>Width and height of the texture </td></tr>
|
|
<tr><td class="paramname">sRgb</td><td><code>true</code> to enable sRGB conversion, <code>false</code> to disable it</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if resizing was successful, <code>false</code> if it failed </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa87d1eff053b9d4d34a24c784a28658" name="aaa87d1eff053b9d4d34a24c784a28658"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa87d1eff053b9d4d34a24c784a28658">◆ </a></span>setRepeated()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::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 repeating. </p>
|
|
<p>Repeating is involved when using texture coordinates outside the texture rectangle [0, 0, width, height]. In this case, if repeat mode is enabled, the whole texture will be repeated as many times as needed to reach the coordinate (for example, if the X texture coordinate is 3 * width, the texture will be repeated 3 times). If repeat mode is disabled, the "extra space" will instead be filled with border pixels. Warning: on very old graphics cards, white pixels may appear when the texture is repeated. With such cards, repeat mode can be used reliably only if the texture has power-of-two dimensions (such as 256x128). Repeating 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 repeat the texture, <code>false</code> to disable repeating</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><code><a class="el" href="#af1a1a32ca5c799204b2bea4040df7647" title="Tell whether the texture is repeated or not.">isRepeated</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0c3bd6825b9a99714f10d44179d74324" name="a0c3bd6825b9a99714f10d44179d74324"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0c3bd6825b9a99714f10d44179d74324">◆ </a></span>setSmooth()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::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 the smooth filter. </p>
|
|
<p>When the filter is activated, the texture appears smoother so that pixels are less noticeable. However if you want the texture to look exactly the same as its source file, you should leave it disabled. The smooth filter 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="#a3ebb050b5a71e1d40ba66eb1a060e103" title="Tell whether the smooth filter is enabled or not.">isSmooth</a></code> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa34ea4d761ca4d1bb4a9a9e3d581fa51" name="aa34ea4d761ca4d1bb4a9a9e3d581fa51"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa34ea4d761ca4d1bb4a9a9e3d581fa51">◆ </a></span>swap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::swap </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classsf_1_1Texture.html">Texture</a> &</td> <td class="paramname"><span class="paramname"><em>right</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>Swap the contents of this texture with those of another. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">right</td><td>Instance to swap with </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a037cdf171af0fb392d07626a44a4ea17" name="a037cdf171af0fb392d07626a44a4ea17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a037cdf171af0fb392d07626a44a4ea17">◆ </a></span>update() <span class="overload">[1/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Image.html">Image</a> &</td> <td class="paramname"><span class="paramname"><em>image</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the texture from an image. </p>
|
|
<p>Although the source image can be smaller than the texture, this function is usually used for updating the whole texture. The other overload, which has an additional destination argument, is more convenient for updating a sub-area of the texture.</p>
|
|
<p>No additional check is performed on the size of the image. Passing an image bigger than the texture will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if the texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> to copy to the texture </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abe76f6c20c15483253a60c463846f502" name="abe76f6c20c15483253a60c463846f502"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abe76f6c20c15483253a60c463846f502">◆ </a></span>update() <span class="overload">[2/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Image.html">Image</a> &</td> <td class="paramname"><span class="paramname"><em>image</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>dest</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update a part of the texture from an image. </p>
|
|
<p>No additional check is performed on the size of the image. Passing an invalid combination of image size and destination will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if the texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">image</td><td><a class="el" href="classsf_1_1Image.html" title="Class for loading, manipulating and saving images.">Image</a> to copy to the texture </td></tr>
|
|
<tr><td class="paramname">dest</td><td>Coordinates of the destination position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aeaf40495f5860120b95d190def4f8bbc" name="aeaf40495f5860120b95d190def4f8bbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aeaf40495f5860120b95d190def4f8bbc">◆ </a></span>update() <span class="overload">[3/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::uint8_t *</td> <td class="paramname"><span class="paramname"><em>pixels</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the whole texture from an array of pixels. </p>
|
|
<p>The pixel array is assumed to have the same size as the <code>area</code> rectangle, and to contain 32-bits RGBA pixels.</p>
|
|
<p>No additional check is performed on the size of the pixel array. Passing invalid arguments will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if <code>pixels</code> is <code>nullptr</code> or if the texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pixels</td><td>Array of pixels to copy to the texture </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a441454e2ab99b4da7201970e4ef14b76" name="a441454e2ab99b4da7201970e4ef14b76"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a441454e2ab99b4da7201970e4ef14b76">◆ </a></span>update() <span class="overload">[4/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::uint8_t *</td> <td class="paramname"><span class="paramname"><em>pixels</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></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"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>dest</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update a part of the texture from an array of pixels. </p>
|
|
<p>The size of the pixel array must match the <code>size</code> argument, and it must contain 32-bits RGBA pixels.</p>
|
|
<p>No additional check is performed on the size of the pixel array or the bounds of the area to update. Passing invalid arguments will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if <code>pixels</code> is null or if the texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pixels</td><td>Array of pixels to copy to the texture </td></tr>
|
|
<tr><td class="paramname">size</td><td>Width and height of the pixel region contained in <code>pixels</code> </td></tr>
|
|
<tr><td class="paramname">dest</td><td>Coordinates of the destination position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9885ca00b74950d60feea28132d9691" name="af9885ca00b74950d60feea28132d9691"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9885ca00b74950d60feea28132d9691">◆ </a></span>update() <span class="overload">[5/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Texture.html">Texture</a> &</td> <td class="paramname"><span class="paramname"><em>texture</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update a part of this texture from another texture. </p>
|
|
<p>Although the source texture can be smaller than this texture, this function is usually used for updating the whole texture. The other overload, which has an additional destination argument, is more convenient for updating a sub-area of this texture.</p>
|
|
<p>No additional check is performed on the size of the passed texture. Passing a texture bigger than this texture will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if either texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">texture</td><td>Source texture to copy to this texture </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a52160e5c928f05f31adf5700908067c6" name="a52160e5c928f05f31adf5700908067c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52160e5c928f05f31adf5700908067c6">◆ </a></span>update() <span class="overload">[6/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Texture.html">Texture</a> &</td> <td class="paramname"><span class="paramname"><em>texture</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>dest</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update a part of this texture from another texture. </p>
|
|
<p>No additional check is performed on the size of the texture. Passing an invalid combination of texture size and destination will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if either texture was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">texture</td><td>Source texture to copy to this texture </td></tr>
|
|
<tr><td class="paramname">dest</td><td>Coordinates of the destination position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3cceef238f7d5d2108a98dd38c17fc5" name="ad3cceef238f7d5d2108a98dd38c17fc5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3cceef238f7d5d2108a98dd38c17fc5">◆ </a></span>update() <span class="overload">[7/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Window.html">Window</a> &</td> <td class="paramname"><span class="paramname"><em>window</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the texture from the contents of a window. </p>
|
|
<p>Although the source window can be smaller than the texture, this function is usually used for updating the whole texture. The other overload, which has an additional destination argument, is more convenient for updating a sub-area of the texture.</p>
|
|
<p>No additional check is performed on the size of the window. Passing a window bigger than the texture will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if either the texture or the window was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">window</td><td><a class="el" href="classsf_1_1Window.html" title="Window that serves as a target for OpenGL rendering.">Window</a> to copy to the texture </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abbdd185b65785a2b5ef5c7dc8114feae" name="abbdd185b65785a2b5ef5c7dc8114feae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbdd185b65785a2b5ef5c7dc8114feae">◆ </a></span>update() <span class="overload">[8/8]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Texture::update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Window.html">Window</a> &</td> <td class="paramname"><span class="paramname"><em>window</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="namespacesf.html#adc674b5f5c13a6734954a18e01a73b42">Vector2u</a></td> <td class="paramname"><span class="paramname"><em>dest</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update a part of the texture from the contents of a window. </p>
|
|
<p>No additional check is performed on the size of the window. Passing an invalid combination of window size and destination will lead to an undefined behavior.</p>
|
|
<p>This function does nothing if either the texture or the window was not previously created.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">window</td><td><a class="el" href="classsf_1_1Window.html" title="Window that serves as a target for OpenGL rendering.">Window</a> to copy to the texture </td></tr>
|
|
<tr><td class="paramname">dest</td><td>Coordinates of the destination position </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
|
<a id="aa5afc6f82b7b587ed5ada4d227ce32aa" name="aa5afc6f82b7b587ed5ada4d227ce32aa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa5afc6f82b7b587ed5ada4d227ce32aa">◆ </a></span>RenderTarget</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classsf_1_1RenderTarget.html">RenderTarget</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Texture_8hpp_source.html#l00717">717</a> of file <a class="el" href="Texture_8hpp_source.html">Texture.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2548fc9744f5e43e0276d5627ca178de" name="a2548fc9744f5e43e0276d5627ca178de"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2548fc9744f5e43e0276d5627ca178de">◆ </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">friend class <a class="el" href="classsf_1_1RenderTexture.html">RenderTexture</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Texture_8hpp_source.html#l00716">716</a> of file <a class="el" href="Texture_8hpp_source.html">Texture.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee0ad1dafe471596e6d25530d9fbaf0c" name="aee0ad1dafe471596e6d25530d9fbaf0c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee0ad1dafe471596e6d25530d9fbaf0c">◆ </a></span>Text</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">friend class <a class="el" href="classsf_1_1Text.html">Text</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Texture_8hpp_source.html#l00715">715</a> of file <a class="el" href="Texture_8hpp_source.html">Texture.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Texture_8hpp_source.html">Texture.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>
|