1558 lines
96 KiB
HTML
1558 lines
96 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<title>SFML - Simple and Fast Multimedia Library</title>
|
|
<meta http-equiv="Content-Type" content="text/html;"/>
|
|
<meta charset="utf-8"/>
|
|
<!--<link rel='stylesheet' type='text/css' href="https://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/>-->
|
|
<link rel="stylesheet" type="text/css" href="doxygen.css" title="default" media="screen,print" />
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="banner-container">
|
|
<div id="banner">
|
|
<span id="sfml">SFML 2.5.1</span>
|
|
</div>
|
|
</div>
|
|
<div id="content">
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>sf</b></li><li class="navelem"><a class="el" href="classsf_1_1Text.html">Text</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-types">Public Types</a> |
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classsf_1_1Text-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sf::Text Class Reference<div class="ingroups"><a class="el" href="group__graphics.html">Graphics module</a></div></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Graphical text that can be drawn to a render target.
|
|
<a href="classsf_1_1Text.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Text_8hpp_source.html">Text.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sf::Text:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsf_1_1Text.png" usemap="#sf::Text_map" alt=""/>
|
|
<map id="sf::Text_map" name="sf::Text_map">
|
|
<area href="classsf_1_1Drawable.html" title="Abstract base class for objects that can be drawn to a render target. " alt="sf::Drawable" shape="rect" coords="0,0,109,24"/>
|
|
<area href="classsf_1_1Transformable.html" title="Decomposed transform defined by a position, a rotation and a scale. " alt="sf::Transformable" shape="rect" coords="119,0,228,24"/>
|
|
</map>
|
|
</div></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Public Types</h2></td></tr>
|
|
<tr class="memitem:aa8add4aef484c6e6b20faff07452bd82"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82">Style</a> { <br />
|
|
  <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82a2af9ae5e1cda126570f744448e0caa32">Regular</a> = 0,
|
|
<a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82af1b47f98fb1e10509ba930a596987171">Bold</a> = 1 << 0,
|
|
<a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82aee249eb803848723c542c2062ebe69d8">Italic</a> = 1 << 1,
|
|
<a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82a664bd143f92b6e8c709d7f788e8b20df">Underlined</a> = 1 << 2,
|
|
<br />
|
|
  <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82a9ed1f5bb154c21269e1190c5aa97d479">StrikeThrough</a> = 1 << 3
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:aa8add4aef484c6e6b20faff07452bd82"><td class="mdescLeft"> </td><td class="mdescRight">Enumeration of the string drawing styles. <a href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82">More...</a><br /></td></tr>
|
|
<tr class="separator:aa8add4aef484c6e6b20faff07452bd82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:aff7cab6a92e5948c9d1481cb2d87eb84"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#aff7cab6a92e5948c9d1481cb2d87eb84">Text</a> ()</td></tr>
|
|
<tr class="memdesc:aff7cab6a92e5948c9d1481cb2d87eb84"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#aff7cab6a92e5948c9d1481cb2d87eb84">More...</a><br /></td></tr>
|
|
<tr class="separator:aff7cab6a92e5948c9d1481cb2d87eb84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a614019e0b5c0ed39a99d32483a51f2c5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a614019e0b5c0ed39a99d32483a51f2c5">Text</a> (const <a class="el" href="classsf_1_1String.html">String</a> &string, const <a class="el" href="classsf_1_1Font.html">Font</a> &font, unsigned int characterSize=30)</td></tr>
|
|
<tr class="memdesc:a614019e0b5c0ed39a99d32483a51f2c5"><td class="mdescLeft"> </td><td class="mdescRight">Construct the text from a string, font and size. <a href="#a614019e0b5c0ed39a99d32483a51f2c5">More...</a><br /></td></tr>
|
|
<tr class="separator:a614019e0b5c0ed39a99d32483a51f2c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7d3b3359f286fd9503d1ced25b7b6c33"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33">setString</a> (const <a class="el" href="classsf_1_1String.html">String</a> &string)</td></tr>
|
|
<tr class="memdesc:a7d3b3359f286fd9503d1ced25b7b6c33"><td class="mdescLeft"> </td><td class="mdescRight">Set the text's string. <a href="#a7d3b3359f286fd9503d1ced25b7b6c33">More...</a><br /></td></tr>
|
|
<tr class="separator:a7d3b3359f286fd9503d1ced25b7b6c33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2927805d1ae92d57f15034ea34756b81"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a2927805d1ae92d57f15034ea34756b81">setFont</a> (const <a class="el" href="classsf_1_1Font.html">Font</a> &font)</td></tr>
|
|
<tr class="memdesc:a2927805d1ae92d57f15034ea34756b81"><td class="mdescLeft"> </td><td class="mdescRight">Set the text's font. <a href="#a2927805d1ae92d57f15034ea34756b81">More...</a><br /></td></tr>
|
|
<tr class="separator:a2927805d1ae92d57f15034ea34756b81"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae96f835fc1bff858f8a23c5b01eaaf7e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ae96f835fc1bff858f8a23c5b01eaaf7e">setCharacterSize</a> (unsigned int size)</td></tr>
|
|
<tr class="memdesc:ae96f835fc1bff858f8a23c5b01eaaf7e"><td class="mdescLeft"> </td><td class="mdescRight">Set the character size. <a href="#ae96f835fc1bff858f8a23c5b01eaaf7e">More...</a><br /></td></tr>
|
|
<tr class="separator:ae96f835fc1bff858f8a23c5b01eaaf7e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6505688f79e2e2d90bd68f4d767e965"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#af6505688f79e2e2d90bd68f4d767e965">setLineSpacing</a> (float spacingFactor)</td></tr>
|
|
<tr class="memdesc:af6505688f79e2e2d90bd68f4d767e965"><td class="mdescLeft"> </td><td class="mdescRight">Set the line spacing factor. <a href="#af6505688f79e2e2d90bd68f4d767e965">More...</a><br /></td></tr>
|
|
<tr class="separator:af6505688f79e2e2d90bd68f4d767e965"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab516110605edb0191a7873138ac42af2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ab516110605edb0191a7873138ac42af2">setLetterSpacing</a> (float spacingFactor)</td></tr>
|
|
<tr class="memdesc:ab516110605edb0191a7873138ac42af2"><td class="mdescLeft"> </td><td class="mdescRight">Set the letter spacing factor. <a href="#ab516110605edb0191a7873138ac42af2">More...</a><br /></td></tr>
|
|
<tr class="separator:ab516110605edb0191a7873138ac42af2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad791702bc2d1b6590a1719aa60635edf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ad791702bc2d1b6590a1719aa60635edf">setStyle</a> (Uint32 style)</td></tr>
|
|
<tr class="memdesc:ad791702bc2d1b6590a1719aa60635edf"><td class="mdescLeft"> </td><td class="mdescRight">Set the text's style. <a href="#ad791702bc2d1b6590a1719aa60635edf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad791702bc2d1b6590a1719aa60635edf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd1742fca1adb6b0ea98357250ffb634"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#afd1742fca1adb6b0ea98357250ffb634">setColor</a> (const <a class="el" href="classsf_1_1Color.html">Color</a> &color)</td></tr>
|
|
<tr class="memdesc:afd1742fca1adb6b0ea98357250ffb634"><td class="mdescLeft"> </td><td class="mdescRight">Set the fill color of the text. <a href="#afd1742fca1adb6b0ea98357250ffb634">More...</a><br /></td></tr>
|
|
<tr class="separator:afd1742fca1adb6b0ea98357250ffb634"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab7bb3babac5a6da1802b2c3e1a3e6dcc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ab7bb3babac5a6da1802b2c3e1a3e6dcc">setFillColor</a> (const <a class="el" href="classsf_1_1Color.html">Color</a> &color)</td></tr>
|
|
<tr class="memdesc:ab7bb3babac5a6da1802b2c3e1a3e6dcc"><td class="mdescLeft"> </td><td class="mdescRight">Set the fill color of the text. <a href="#ab7bb3babac5a6da1802b2c3e1a3e6dcc">More...</a><br /></td></tr>
|
|
<tr class="separator:ab7bb3babac5a6da1802b2c3e1a3e6dcc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa19ec69c3b894e963602a6804ca68fe4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#aa19ec69c3b894e963602a6804ca68fe4">setOutlineColor</a> (const <a class="el" href="classsf_1_1Color.html">Color</a> &color)</td></tr>
|
|
<tr class="memdesc:aa19ec69c3b894e963602a6804ca68fe4"><td class="mdescLeft"> </td><td class="mdescRight">Set the outline color of the text. <a href="#aa19ec69c3b894e963602a6804ca68fe4">More...</a><br /></td></tr>
|
|
<tr class="separator:aa19ec69c3b894e963602a6804ca68fe4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0e6be3b40124557bf53737fe6a6ce77"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ab0e6be3b40124557bf53737fe6a6ce77">setOutlineThickness</a> (float thickness)</td></tr>
|
|
<tr class="memdesc:ab0e6be3b40124557bf53737fe6a6ce77"><td class="mdescLeft"> </td><td class="mdescRight">Set the thickness of the text's outline. <a href="#ab0e6be3b40124557bf53737fe6a6ce77">More...</a><br /></td></tr>
|
|
<tr class="separator:ab0e6be3b40124557bf53737fe6a6ce77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a084c275eb4bca835696af5f8f9c80ab3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1String.html">String</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a084c275eb4bca835696af5f8f9c80ab3">getString</a> () const</td></tr>
|
|
<tr class="memdesc:a084c275eb4bca835696af5f8f9c80ab3"><td class="mdescLeft"> </td><td class="mdescRight">Get the text's string. <a href="#a084c275eb4bca835696af5f8f9c80ab3">More...</a><br /></td></tr>
|
|
<tr class="separator:a084c275eb4bca835696af5f8f9c80ab3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a47cd96d7b2c37b2f820e4d6e1bb83f96"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Font.html">Font</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a47cd96d7b2c37b2f820e4d6e1bb83f96">getFont</a> () const</td></tr>
|
|
<tr class="memdesc:a47cd96d7b2c37b2f820e4d6e1bb83f96"><td class="mdescLeft"> </td><td class="mdescRight">Get the text's font. <a href="#a47cd96d7b2c37b2f820e4d6e1bb83f96">More...</a><br /></td></tr>
|
|
<tr class="separator:a47cd96d7b2c37b2f820e4d6e1bb83f96"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46d1d7f1d513bb8d434e985a93ea5224"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a46d1d7f1d513bb8d434e985a93ea5224">getCharacterSize</a> () const</td></tr>
|
|
<tr class="memdesc:a46d1d7f1d513bb8d434e985a93ea5224"><td class="mdescLeft"> </td><td class="mdescRight">Get the character size. <a href="#a46d1d7f1d513bb8d434e985a93ea5224">More...</a><br /></td></tr>
|
|
<tr class="separator:a46d1d7f1d513bb8d434e985a93ea5224"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a028fc6e561bd9a0671254419b498b889"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a028fc6e561bd9a0671254419b498b889">getLetterSpacing</a> () const</td></tr>
|
|
<tr class="memdesc:a028fc6e561bd9a0671254419b498b889"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the letter spacing factor. <a href="#a028fc6e561bd9a0671254419b498b889">More...</a><br /></td></tr>
|
|
<tr class="separator:a028fc6e561bd9a0671254419b498b889"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a670622e1c299dfd6518afe289c7cd248"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a670622e1c299dfd6518afe289c7cd248">getLineSpacing</a> () const</td></tr>
|
|
<tr class="memdesc:a670622e1c299dfd6518afe289c7cd248"><td class="mdescLeft"> </td><td class="mdescRight">Get the size of the line spacing factor. <a href="#a670622e1c299dfd6518afe289c7cd248">More...</a><br /></td></tr>
|
|
<tr class="separator:a670622e1c299dfd6518afe289c7cd248"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0da79b0c057f4bb51592465a205c35d7"><td class="memItemLeft" align="right" valign="top">Uint32 </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a0da79b0c057f4bb51592465a205c35d7">getStyle</a> () const</td></tr>
|
|
<tr class="memdesc:a0da79b0c057f4bb51592465a205c35d7"><td class="mdescLeft"> </td><td class="mdescRight">Get the text's style. <a href="#a0da79b0c057f4bb51592465a205c35d7">More...</a><br /></td></tr>
|
|
<tr class="separator:a0da79b0c057f4bb51592465a205c35d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4ca753f719c54692fd4d9284573a2c7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ae4ca753f719c54692fd4d9284573a2c7">getColor</a> () const</td></tr>
|
|
<tr class="memdesc:ae4ca753f719c54692fd4d9284573a2c7"><td class="mdescLeft"> </td><td class="mdescRight">Get the fill color of the text. <a href="#ae4ca753f719c54692fd4d9284573a2c7">More...</a><br /></td></tr>
|
|
<tr class="separator:ae4ca753f719c54692fd4d9284573a2c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b4ba8c435b59e1e05f831e6230dc537"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a6b4ba8c435b59e1e05f831e6230dc537">getFillColor</a> () const</td></tr>
|
|
<tr class="memdesc:a6b4ba8c435b59e1e05f831e6230dc537"><td class="mdescLeft"> </td><td class="mdescRight">Get the fill color of the text. <a href="#a6b4ba8c435b59e1e05f831e6230dc537">More...</a><br /></td></tr>
|
|
<tr class="separator:a6b4ba8c435b59e1e05f831e6230dc537"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53559d563461089f1172571b375442dc"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a53559d563461089f1172571b375442dc">getOutlineColor</a> () const</td></tr>
|
|
<tr class="memdesc:a53559d563461089f1172571b375442dc"><td class="mdescLeft"> </td><td class="mdescRight">Get the outline color of the text. <a href="#a53559d563461089f1172571b375442dc">More...</a><br /></td></tr>
|
|
<tr class="separator:a53559d563461089f1172571b375442dc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6bf01c23189edf52c8b38708db6f3f6"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#af6bf01c23189edf52c8b38708db6f3f6">getOutlineThickness</a> () const</td></tr>
|
|
<tr class="memdesc:af6bf01c23189edf52c8b38708db6f3f6"><td class="mdescLeft"> </td><td class="mdescRight">Get the outline thickness of the text. <a href="#af6bf01c23189edf52c8b38708db6f3f6">More...</a><br /></td></tr>
|
|
<tr class="separator:af6bf01c23189edf52c8b38708db6f3f6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e252d8dcae3eb61c6c962c0bc674b12"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a2e252d8dcae3eb61c6c962c0bc674b12">findCharacterPos</a> (std::size_t index) const</td></tr>
|
|
<tr class="memdesc:a2e252d8dcae3eb61c6c962c0bc674b12"><td class="mdescLeft"> </td><td class="mdescRight">Return the position of the <em>index-th</em> character. <a href="#a2e252d8dcae3eb61c6c962c0bc674b12">More...</a><br /></td></tr>
|
|
<tr class="separator:a2e252d8dcae3eb61c6c962c0bc674b12"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3e6b3b298827f853b41165eee2cbbc66"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Rect.html">FloatRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#a3e6b3b298827f853b41165eee2cbbc66">getLocalBounds</a> () const</td></tr>
|
|
<tr class="memdesc:a3e6b3b298827f853b41165eee2cbbc66"><td class="mdescLeft"> </td><td class="mdescRight">Get the local bounding rectangle of the entity. <a href="#a3e6b3b298827f853b41165eee2cbbc66">More...</a><br /></td></tr>
|
|
<tr class="separator:a3e6b3b298827f853b41165eee2cbbc66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad33ed96ce9fbe99610f7f8b6874a16b4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsf_1_1Rect.html">FloatRect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Text.html#ad33ed96ce9fbe99610f7f8b6874a16b4">getGlobalBounds</a> () const</td></tr>
|
|
<tr class="memdesc:ad33ed96ce9fbe99610f7f8b6874a16b4"><td class="mdescLeft"> </td><td class="mdescRight">Get the global bounding rectangle of the entity. <a href="#ad33ed96ce9fbe99610f7f8b6874a16b4">More...</a><br /></td></tr>
|
|
<tr class="separator:ad33ed96ce9fbe99610f7f8b6874a16b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4dbfb1a7c80688b0b4c477d706550208"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a4dbfb1a7c80688b0b4c477d706550208">setPosition</a> (float x, float y)</td></tr>
|
|
<tr class="memdesc:a4dbfb1a7c80688b0b4c477d706550208"><td class="mdescLeft"> </td><td class="mdescRight">set the position of the object <a href="#a4dbfb1a7c80688b0b4c477d706550208">More...</a><br /></td></tr>
|
|
<tr class="separator:a4dbfb1a7c80688b0b4c477d706550208"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af1a42209ce2b5d3f07b00f917bcd8015"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#af1a42209ce2b5d3f07b00f917bcd8015">setPosition</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &position)</td></tr>
|
|
<tr class="memdesc:af1a42209ce2b5d3f07b00f917bcd8015"><td class="mdescLeft"> </td><td class="mdescRight">set the position of the object <a href="#af1a42209ce2b5d3f07b00f917bcd8015">More...</a><br /></td></tr>
|
|
<tr class="separator:af1a42209ce2b5d3f07b00f917bcd8015"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a32baf2bf1a74699b03bf8c95030a38ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a32baf2bf1a74699b03bf8c95030a38ed">setRotation</a> (float angle)</td></tr>
|
|
<tr class="memdesc:a32baf2bf1a74699b03bf8c95030a38ed"><td class="mdescLeft"> </td><td class="mdescRight">set the orientation of the object <a href="#a32baf2bf1a74699b03bf8c95030a38ed">More...</a><br /></td></tr>
|
|
<tr class="separator:a32baf2bf1a74699b03bf8c95030a38ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaec50b46b3f41b054763304d1e727471"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#aaec50b46b3f41b054763304d1e727471">setScale</a> (float factorX, float factorY)</td></tr>
|
|
<tr class="memdesc:aaec50b46b3f41b054763304d1e727471"><td class="mdescLeft"> </td><td class="mdescRight">set the scale factors of the object <a href="#aaec50b46b3f41b054763304d1e727471">More...</a><br /></td></tr>
|
|
<tr class="separator:aaec50b46b3f41b054763304d1e727471"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c48a87f1626047e448f9c1a68ff167e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a4c48a87f1626047e448f9c1a68ff167e">setScale</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &factors)</td></tr>
|
|
<tr class="memdesc:a4c48a87f1626047e448f9c1a68ff167e"><td class="mdescLeft"> </td><td class="mdescRight">set the scale factors of the object <a href="#a4c48a87f1626047e448f9c1a68ff167e">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c48a87f1626047e448f9c1a68ff167e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56c67bd80aae8418d13fb96c034d25ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a56c67bd80aae8418d13fb96c034d25ec">setOrigin</a> (float x, float y)</td></tr>
|
|
<tr class="memdesc:a56c67bd80aae8418d13fb96c034d25ec"><td class="mdescLeft"> </td><td class="mdescRight">set the local origin of the object <a href="#a56c67bd80aae8418d13fb96c034d25ec">More...</a><br /></td></tr>
|
|
<tr class="separator:a56c67bd80aae8418d13fb96c034d25ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa93a835ffbf3bee2098dfbbc695a7f05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#aa93a835ffbf3bee2098dfbbc695a7f05">setOrigin</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &origin)</td></tr>
|
|
<tr class="memdesc:aa93a835ffbf3bee2098dfbbc695a7f05"><td class="mdescLeft"> </td><td class="mdescRight">set the local origin of the object <a href="#aa93a835ffbf3bee2098dfbbc695a7f05">More...</a><br /></td></tr>
|
|
<tr class="separator:aa93a835ffbf3bee2098dfbbc695a7f05"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73f9739bc6e74db2cea154bc8e94ec46"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a73f9739bc6e74db2cea154bc8e94ec46">getPosition</a> () const</td></tr>
|
|
<tr class="memdesc:a73f9739bc6e74db2cea154bc8e94ec46"><td class="mdescLeft"> </td><td class="mdescRight">get the position of the object <a href="#a73f9739bc6e74db2cea154bc8e94ec46">More...</a><br /></td></tr>
|
|
<tr class="separator:a73f9739bc6e74db2cea154bc8e94ec46"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa00b5c5d4a06ac24a94dd72c56931d3a"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#aa00b5c5d4a06ac24a94dd72c56931d3a">getRotation</a> () const</td></tr>
|
|
<tr class="memdesc:aa00b5c5d4a06ac24a94dd72c56931d3a"><td class="mdescLeft"> </td><td class="mdescRight">get the orientation of the object <a href="#aa00b5c5d4a06ac24a94dd72c56931d3a">More...</a><br /></td></tr>
|
|
<tr class="separator:aa00b5c5d4a06ac24a94dd72c56931d3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73819fdea80ca8a06fad8a0067b4588c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a73819fdea80ca8a06fad8a0067b4588c">getScale</a> () const</td></tr>
|
|
<tr class="memdesc:a73819fdea80ca8a06fad8a0067b4588c"><td class="mdescLeft"> </td><td class="mdescRight">get the current scale of the object <a href="#a73819fdea80ca8a06fad8a0067b4588c">More...</a><br /></td></tr>
|
|
<tr class="separator:a73819fdea80ca8a06fad8a0067b4588c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37ea3500afac234814a43ce809ef264e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a37ea3500afac234814a43ce809ef264e">getOrigin</a> () const</td></tr>
|
|
<tr class="memdesc:a37ea3500afac234814a43ce809ef264e"><td class="mdescLeft"> </td><td class="mdescRight">get the local origin of the object <a href="#a37ea3500afac234814a43ce809ef264e">More...</a><br /></td></tr>
|
|
<tr class="separator:a37ea3500afac234814a43ce809ef264e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86b461d6a941ad390c2ad8b6a4a20391"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a86b461d6a941ad390c2ad8b6a4a20391">move</a> (float offsetX, float offsetY)</td></tr>
|
|
<tr class="memdesc:a86b461d6a941ad390c2ad8b6a4a20391"><td class="mdescLeft"> </td><td class="mdescRight">Move the object by a given offset. <a href="#a86b461d6a941ad390c2ad8b6a4a20391">More...</a><br /></td></tr>
|
|
<tr class="separator:a86b461d6a941ad390c2ad8b6a4a20391"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9ca691522f6ddc1a40406849b87c469"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#ab9ca691522f6ddc1a40406849b87c469">move</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &offset)</td></tr>
|
|
<tr class="memdesc:ab9ca691522f6ddc1a40406849b87c469"><td class="mdescLeft"> </td><td class="mdescRight">Move the object by a given offset. <a href="#ab9ca691522f6ddc1a40406849b87c469">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9ca691522f6ddc1a40406849b87c469"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8a5ffddc0d93f238fee3bf8efe1ebda"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#af8a5ffddc0d93f238fee3bf8efe1ebda">rotate</a> (float angle)</td></tr>
|
|
<tr class="memdesc:af8a5ffddc0d93f238fee3bf8efe1ebda"><td class="mdescLeft"> </td><td class="mdescRight">Rotate the object. <a href="#af8a5ffddc0d93f238fee3bf8efe1ebda">More...</a><br /></td></tr>
|
|
<tr class="separator:af8a5ffddc0d93f238fee3bf8efe1ebda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3de0c6d8957f3cf318092f3f60656391"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a> (float factorX, float factorY)</td></tr>
|
|
<tr class="memdesc:a3de0c6d8957f3cf318092f3f60656391"><td class="mdescLeft"> </td><td class="mdescRight">Scale the object. <a href="#a3de0c6d8957f3cf318092f3f60656391">More...</a><br /></td></tr>
|
|
<tr class="separator:a3de0c6d8957f3cf318092f3f60656391"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adecaa6c69b1f27dd5194b067d96bb694"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#adecaa6c69b1f27dd5194b067d96bb694">scale</a> (const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> &factor)</td></tr>
|
|
<tr class="memdesc:adecaa6c69b1f27dd5194b067d96bb694"><td class="mdescLeft"> </td><td class="mdescRight">Scale the object. <a href="#adecaa6c69b1f27dd5194b067d96bb694">More...</a><br /></td></tr>
|
|
<tr class="separator:adecaa6c69b1f27dd5194b067d96bb694"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f7c3f0bab3f162b13613904fbdbb9ad"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Transform.html">Transform</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#a7f7c3f0bab3f162b13613904fbdbb9ad">getTransform</a> () const</td></tr>
|
|
<tr class="memdesc:a7f7c3f0bab3f162b13613904fbdbb9ad"><td class="mdescLeft"> </td><td class="mdescRight">get the combined transform of the object <a href="#a7f7c3f0bab3f162b13613904fbdbb9ad">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f7c3f0bab3f162b13613904fbdbb9ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab18b25f51263252ff3811465eb7e9fb1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsf_1_1Transform.html">Transform</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Transformable.html#ab18b25f51263252ff3811465eb7e9fb1">getInverseTransform</a> () const</td></tr>
|
|
<tr class="memdesc:ab18b25f51263252ff3811465eb7e9fb1"><td class="mdescLeft"> </td><td class="mdescRight">get the inverse of the combined transform of the object <a href="#ab18b25f51263252ff3811465eb7e9fb1">More...</a><br /></td></tr>
|
|
<tr class="separator:ab18b25f51263252ff3811465eb7e9fb1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Graphical text that can be drawn to a render target. </p>
|
|
<p><a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> is a drawable class that allows to easily display some text with custom style and color on a render target.</p>
|
|
<p>It inherits all the functions from <a class="el" href="classsf_1_1Transformable.html" title="Decomposed transform defined by a position, a rotation and a scale. ">sf::Transformable</a>: position, rotation, scale, origin. It also adds text-specific properties such as the font to use, the character size, the font style (bold, italic, underlined and strike through), the text color, the outline thickness, the outline color, the character spacing, the line spacing and the text to display of course. It also provides convenience functions to calculate the graphical size of the text, or to get the global position of a given character.</p>
|
|
<p><a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> works in combination with the <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> class, which loads and provides the glyphs (visual characters) of a given font.</p>
|
|
<p>The separation of <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> and <a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> allows more flexibility and better performances: indeed a <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> is a heavy resource, and any operation on it is slow (often too slow for real-time applications). On the other side, a <a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> is a lightweight object which can combine the glyphs data and metrics of a <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> to display any text on a render target.</p>
|
|
<p>It is important to note that the <a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> instance doesn't copy the font that it uses, it only keeps a reference to it. Thus, a <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> must not be destructed while it is used by a <a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">sf::Text</a> (i.e. never write a function that uses a local <a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a> instance for creating a text).</p>
|
|
<p>See also the note on coordinates and undistorted rendering in <a class="el" href="classsf_1_1Transformable.html" title="Decomposed transform defined by a position, a rotation and a scale. ">sf::Transformable</a>.</p>
|
|
<p>Usage example: </p><div class="fragment"><div class="line"><span class="comment">// Declare and load a font</span></div><div class="line"><a class="code" href="classsf_1_1Font.html">sf::Font</a> font;</div><div class="line">font.<a class="code" href="classsf_1_1Font.html#ab020052ef4e01f6c749a85571c0f3fd1">loadFromFile</a>(<span class="stringliteral">"arial.ttf"</span>);</div><div class="line"></div><div class="line"><span class="comment">// Create a text</span></div><div class="line"><a class="code" href="classsf_1_1Text.html">sf::Text</a> text(<span class="stringliteral">"hello"</span>, font);</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#ae96f835fc1bff858f8a23c5b01eaaf7e">setCharacterSize</a>(30);</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#ad791702bc2d1b6590a1719aa60635edf">setStyle</a>(<a class="code" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82af1b47f98fb1e10509ba930a596987171">sf::Text::Bold</a>);</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#ab7bb3babac5a6da1802b2c3e1a3e6dcc">setFillColor</a>(<a class="code" href="classsf_1_1Color.html#a127dbf55db9c07d0fa8f4bfcbb97594a">sf::Color::Red</a>);</div><div class="line"></div><div class="line"><span class="comment">// Draw it</span></div><div class="line">window.draw(text);</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">sf::Font</a>, <a class="el" href="classsf_1_1Transformable.html" title="Decomposed transform defined by a position, a rotation and a scale. ">sf::Transformable</a> </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Text_8hpp_source.html#l00048">48</a> of file <a class="el" href="Text_8hpp_source.html">Text.hpp</a>.</p>
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
|
<a id="aa8add4aef484c6e6b20faff07452bd82"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa8add4aef484c6e6b20faff07452bd82">◆ </a></span>Style</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82">sf::Text::Style</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enumeration of the string drawing styles. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa8add4aef484c6e6b20faff07452bd82a2af9ae5e1cda126570f744448e0caa32"></a>Regular </td><td class="fielddoc"><p>Regular characters, no style. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa8add4aef484c6e6b20faff07452bd82af1b47f98fb1e10509ba930a596987171"></a>Bold </td><td class="fielddoc"><p>Bold characters. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa8add4aef484c6e6b20faff07452bd82aee249eb803848723c542c2062ebe69d8"></a>Italic </td><td class="fielddoc"><p>Italic characters. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa8add4aef484c6e6b20faff07452bd82a664bd143f92b6e8c709d7f788e8b20df"></a>Underlined </td><td class="fielddoc"><p>Underlined characters. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="aa8add4aef484c6e6b20faff07452bd82a9ed1f5bb154c21269e1190c5aa97d479"></a>StrikeThrough </td><td class="fielddoc"><p>Strike through characters. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Text_8hpp_source.html#l00056">56</a> of file <a class="el" href="Text_8hpp_source.html">Text.hpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="aff7cab6a92e5948c9d1481cb2d87eb84"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff7cab6a92e5948c9d1481cb2d87eb84">◆ </a></span>Text() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Text::Text </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<p>Creates an empty text. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a614019e0b5c0ed39a99d32483a51f2c5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a614019e0b5c0ed39a99d32483a51f2c5">◆ </a></span>Text() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">sf::Text::Text </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> & </td>
|
|
<td class="paramname"><em>string</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Font.html">Font</a> & </td>
|
|
<td class="paramname"><em>font</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>characterSize</em> = <code>30</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Construct the text from a string, font and size. </p>
|
|
<p>Note that if the used font is a bitmap font, it is not scalable, thus not all requested sizes will be available to use. This needs to be taken into consideration when setting the character size. If you need to display text of a certain size, make sure the corresponding bitmap font that supports that size is used.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">string</td><td><a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">Text</a> assigned to the string </td></tr>
|
|
<tr><td class="paramname">font</td><td><a class="el" href="classsf_1_1Font.html" title="Class for loading and manipulating character fonts. ">Font</a> used to draw the string </td></tr>
|
|
<tr><td class="paramname">characterSize</td><td>Base size of characters, in pixels </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2e252d8dcae3eb61c6c962c0bc674b12"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e252d8dcae3eb61c6c962c0bc674b12">◆ </a></span>findCharacterPos()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Vector2.html">Vector2f</a> sf::Text::findCharacterPos </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>index</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Return the position of the <em>index-th</em> character. </p>
|
|
<p>This function computes the visual position of a character from its index in the string. The returned position is in global coordinates (translation, rotation, scale and origin are applied). If <em>index</em> is out of range, the position of the end of the string is returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">index</td><td>Index of the character</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Position of the character </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a46d1d7f1d513bb8d434e985a93ea5224"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a46d1d7f1d513bb8d434e985a93ea5224">◆ </a></span>getCharacterSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int sf::Text::getCharacterSize </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the character size. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size of the characters, in pixels</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ae96f835fc1bff858f8a23c5b01eaaf7e" title="Set the character size. ">setCharacterSize</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae4ca753f719c54692fd4d9284573a2c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae4ca753f719c54692fd4d9284573a2c7">◆ </a></span>getColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Color.html">Color</a>& sf::Text::getColor </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the fill color of the text. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Fill color of the text</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ab7bb3babac5a6da1802b2c3e1a3e6dcc" title="Set the fill color of the text. ">setFillColor</a></dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>There is now fill and outline colors instead of a single global color. Use <a class="el" href="classsf_1_1Text.html#a6b4ba8c435b59e1e05f831e6230dc537" title="Get the fill color of the text. ">getFillColor()</a> or <a class="el" href="classsf_1_1Text.html#a53559d563461089f1172571b375442dc" title="Get the outline color of the text. ">getOutlineColor()</a> instead.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b4ba8c435b59e1e05f831e6230dc537"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b4ba8c435b59e1e05f831e6230dc537">◆ </a></span>getFillColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Color.html">Color</a>& sf::Text::getFillColor </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the fill color of the text. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Fill color of the text</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ab7bb3babac5a6da1802b2c3e1a3e6dcc" title="Set the fill color of the text. ">setFillColor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a47cd96d7b2c37b2f820e4d6e1bb83f96"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a47cd96d7b2c37b2f820e4d6e1bb83f96">◆ </a></span>getFont()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Font.html">Font</a>* sf::Text::getFont </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the text's font. </p>
|
|
<p>If the text has no font attached, a NULL pointer is returned. The returned pointer is const, which means that you cannot modify the font when you get it from this function.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the text's font</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a2927805d1ae92d57f15034ea34756b81" title="Set the text's font. ">setFont</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad33ed96ce9fbe99610f7f8b6874a16b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad33ed96ce9fbe99610f7f8b6874a16b4">◆ </a></span>getGlobalBounds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Rect.html">FloatRect</a> sf::Text::getGlobalBounds </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the global bounding rectangle of the entity. </p>
|
|
<p>The returned rectangle is in global coordinates, which means that it takes into account the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the text in the global 2D world's coordinate system.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Global bounding rectangle of the entity </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab18b25f51263252ff3811465eb7e9fb1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab18b25f51263252ff3811465eb7e9fb1">◆ </a></span>getInverseTransform()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Transform.html">Transform</a>& sf::Transformable::getInverseTransform </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the inverse of the combined transform of the object </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Inverse of the combined transformations applied to the object</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a7f7c3f0bab3f162b13613904fbdbb9ad" title="get the combined transform of the object ">getTransform</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a028fc6e561bd9a0671254419b498b889"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a028fc6e561bd9a0671254419b498b889">◆ </a></span>getLetterSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float sf::Text::getLetterSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the size of the letter spacing factor. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size of the letter spacing factor</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ab516110605edb0191a7873138ac42af2" title="Set the letter spacing factor. ">setLetterSpacing</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a670622e1c299dfd6518afe289c7cd248"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a670622e1c299dfd6518afe289c7cd248">◆ </a></span>getLineSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float sf::Text::getLineSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the size of the line spacing factor. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Size of the line spacing factor</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#af6505688f79e2e2d90bd68f4d767e965" title="Set the line spacing factor. ">setLineSpacing</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e6b3b298827f853b41165eee2cbbc66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e6b3b298827f853b41165eee2cbbc66">◆ </a></span>getLocalBounds()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classsf_1_1Rect.html">FloatRect</a> sf::Text::getLocalBounds </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the local bounding rectangle of the entity. </p>
|
|
<p>The returned rectangle is in local coordinates, which means that it ignores the transformations (translation, rotation, scale, ...) that are applied to the entity. In other words, this function returns the bounds of the entity in the entity's coordinate system.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Local bounding rectangle of the entity </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37ea3500afac234814a43ce809ef264e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37ea3500afac234814a43ce809ef264e">◆ </a></span>getOrigin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a>& sf::Transformable::getOrigin </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the local origin of the object </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current origin</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a56c67bd80aae8418d13fb96c034d25ec" title="set the local origin of the object ">setOrigin</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53559d563461089f1172571b375442dc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53559d563461089f1172571b375442dc">◆ </a></span>getOutlineColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Color.html">Color</a>& sf::Text::getOutlineColor </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the outline color of the text. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Outline color of the text</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#aa19ec69c3b894e963602a6804ca68fe4" title="Set the outline color of the text. ">setOutlineColor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6bf01c23189edf52c8b38708db6f3f6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6bf01c23189edf52c8b38708db6f3f6">◆ </a></span>getOutlineThickness()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float sf::Text::getOutlineThickness </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the outline thickness of the text. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Outline thickness of the text, in pixels</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ab0e6be3b40124557bf53737fe6a6ce77" title="Set the thickness of the text's outline. ">setOutlineThickness</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73f9739bc6e74db2cea154bc8e94ec46"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73f9739bc6e74db2cea154bc8e94ec46">◆ </a></span>getPosition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a>& sf::Transformable::getPosition </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the position of the object </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current position</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a4dbfb1a7c80688b0b4c477d706550208" title="set the position of the object ">setPosition</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa00b5c5d4a06ac24a94dd72c56931d3a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa00b5c5d4a06ac24a94dd72c56931d3a">◆ </a></span>getRotation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float sf::Transformable::getRotation </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the orientation of the object </p>
|
|
<p>The rotation is always in the range [0, 360].</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current rotation, in degrees</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a32baf2bf1a74699b03bf8c95030a38ed" title="set the orientation of the object ">setRotation</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73819fdea80ca8a06fad8a0067b4588c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73819fdea80ca8a06fad8a0067b4588c">◆ </a></span>getScale()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a>& sf::Transformable::getScale </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the current scale of the object </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current scale factors</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#aaec50b46b3f41b054763304d1e727471" title="set the scale factors of the object ">setScale</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a084c275eb4bca835696af5f8f9c80ab3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a084c275eb4bca835696af5f8f9c80ab3">◆ </a></span>getString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1String.html">String</a>& sf::Text::getString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the text's string. </p>
|
|
<p>The returned string is a <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings. ">sf::String</a>, which can automatically be converted to standard string types. So, the following lines of code are all valid: </p><div class="fragment"><div class="line"><a class="code" href="classsf_1_1String.html">sf::String</a> s1 = text.<a class="code" href="classsf_1_1Text.html#a084c275eb4bca835696af5f8f9c80ab3">getString</a>();</div><div class="line">std::string s2 = text.<a class="code" href="classsf_1_1Text.html#a084c275eb4bca835696af5f8f9c80ab3">getString</a>();</div><div class="line">std::wstring s3 = text.<a class="code" href="classsf_1_1Text.html#a084c275eb4bca835696af5f8f9c80ab3">getString</a>();</div></div><!-- fragment --><dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">Text</a>'s string</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33" title="Set the text's string. ">setString</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0da79b0c057f4bb51592465a205c35d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0da79b0c057f4bb51592465a205c35d7">◆ </a></span>getStyle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Uint32 sf::Text::getStyle </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the text's style. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Text.html" title="Graphical text that can be drawn to a render target. ">Text</a>'s style</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#ad791702bc2d1b6590a1719aa60635edf" title="Set the text's style. ">setStyle</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f7c3f0bab3f162b13613904fbdbb9ad"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f7c3f0bab3f162b13613904fbdbb9ad">◆ </a></span>getTransform()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const <a class="el" href="classsf_1_1Transform.html">Transform</a>& sf::Transformable::getTransform </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>get the combined transform of the object </p>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classsf_1_1Transform.html" title="Define a 3x3 transform matrix. ">Transform</a> combining the position/rotation/scale/origin of the object</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#ab18b25f51263252ff3811465eb7e9fb1" title="get the inverse of the combined transform of the object ">getInverseTransform</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86b461d6a941ad390c2ad8b6a4a20391"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86b461d6a941ad390c2ad8b6a4a20391">◆ </a></span>move() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::move </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>offsetX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>offsetY</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move the object by a given offset. </p>
|
|
<p>This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code: </p><div class="fragment"><div class="line"><a class="code" href="classsf_1_1Vector2.html">sf::Vector2f</a> pos = <span class="keywordtype">object</span>.getPosition();</div><div class="line"><span class="keywordtype">object</span>.setPosition(pos.<a class="code" href="classsf_1_1Vector2.html#a1e6ad77fa155f3753bfb92699bd28141">x</a> + offsetX, pos.<a class="code" href="classsf_1_1Vector2.html#a420f2481b015f4eb929c75f2af564299">y</a> + offsetY);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">offsetX</td><td>X offset </td></tr>
|
|
<tr><td class="paramname">offsetY</td><td>Y offset</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a4dbfb1a7c80688b0b4c477d706550208" title="set the position of the object ">setPosition</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab9ca691522f6ddc1a40406849b87c469"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab9ca691522f6ddc1a40406849b87c469">◆ </a></span>move() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::move </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>offset</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Move the object by a given offset. </p>
|
|
<p>This function adds to the current position of the object, unlike setPosition which overwrites it. Thus, it is equivalent to the following code: </p><div class="fragment"><div class="line"><span class="keywordtype">object</span>.setPosition(<span class="keywordtype">object</span>.<a class="code" href="classsf_1_1Transformable.html#a73f9739bc6e74db2cea154bc8e94ec46">getPosition</a>() + offset);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">offset</td><td>Offset</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a4dbfb1a7c80688b0b4c477d706550208" title="set the position of the object ">setPosition</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af8a5ffddc0d93f238fee3bf8efe1ebda"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af8a5ffddc0d93f238fee3bf8efe1ebda">◆ </a></span>rotate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::rotate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>angle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Rotate the object. </p>
|
|
<p>This function adds to the current rotation of the object, unlike setRotation which overwrites it. Thus, it is equivalent to the following code: </p><div class="fragment"><div class="line"><span class="keywordtype">object</span>.setRotation(<span class="keywordtype">object</span>.<a class="code" href="classsf_1_1Transformable.html#aa00b5c5d4a06ac24a94dd72c56931d3a">getRotation</a>() + angle);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">angle</td><td>Angle of rotation, in degrees </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3de0c6d8957f3cf318092f3f60656391"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3de0c6d8957f3cf318092f3f60656391">◆ </a></span>scale() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::scale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>factorX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>factorY</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Scale the object. </p>
|
|
<p>This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code: </p><div class="fragment"><div class="line"><a class="code" href="classsf_1_1Vector2.html">sf::Vector2f</a> <a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a> = <span class="keywordtype">object</span>.getScale();</div><div class="line"><span class="keywordtype">object</span>.setScale(<a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a>.x * factorX, <a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a>.y * factorY);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">factorX</td><td>Horizontal scale factor </td></tr>
|
|
<tr><td class="paramname">factorY</td><td>Vertical scale factor</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#aaec50b46b3f41b054763304d1e727471" title="set the scale factors of the object ">setScale</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adecaa6c69b1f27dd5194b067d96bb694"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adecaa6c69b1f27dd5194b067d96bb694">◆ </a></span>scale() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::scale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>factor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Scale the object. </p>
|
|
<p>This function multiplies the current scale of the object, unlike setScale which overwrites it. Thus, it is equivalent to the following code: </p><div class="fragment"><div class="line"><a class="code" href="classsf_1_1Vector2.html">sf::Vector2f</a> <a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a> = <span class="keywordtype">object</span>.getScale();</div><div class="line"><span class="keywordtype">object</span>.setScale(<a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a>.x * factor.x, <a class="code" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391">scale</a>.y * factor.y);</div></div><!-- fragment --><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">factor</td><td>Scale factors</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#aaec50b46b3f41b054763304d1e727471" title="set the scale factors of the object ">setScale</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae96f835fc1bff858f8a23c5b01eaaf7e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae96f835fc1bff858f8a23c5b01eaaf7e">◆ </a></span>setCharacterSize()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setCharacterSize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>size</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the character size. </p>
|
|
<p>The default size is 30.</p>
|
|
<p>Note that if the used font is a bitmap font, it is not scalable, thus not all requested sizes will be available to use. This needs to be taken into consideration when setting the character size. If you need to display text of a certain size, make sure the corresponding bitmap font that supports that size is used.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">size</td><td>New character size, in pixels</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a46d1d7f1d513bb8d434e985a93ea5224" title="Get the character size. ">getCharacterSize</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afd1742fca1adb6b0ea98357250ffb634"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afd1742fca1adb6b0ea98357250ffb634">◆ </a></span>setColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td>
|
|
<td class="paramname"><em>color</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the fill color of the text. </p>
|
|
<p>By default, the text's fill color is opaque white. Setting the fill color to a transparent color with an outline will cause the outline to be displayed in the fill area of the text.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">color</td><td>New fill color of the text</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a6b4ba8c435b59e1e05f831e6230dc537" title="Get the fill color of the text. ">getFillColor</a></dd></dl>
|
|
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>There is now fill and outline colors instead of a single global color. Use <a class="el" href="classsf_1_1Text.html#ab7bb3babac5a6da1802b2c3e1a3e6dcc" title="Set the fill color of the text. ">setFillColor()</a> or <a class="el" href="classsf_1_1Text.html#aa19ec69c3b894e963602a6804ca68fe4" title="Set the outline color of the text. ">setOutlineColor()</a> instead.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab7bb3babac5a6da1802b2c3e1a3e6dcc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab7bb3babac5a6da1802b2c3e1a3e6dcc">◆ </a></span>setFillColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setFillColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td>
|
|
<td class="paramname"><em>color</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the fill color of the text. </p>
|
|
<p>By default, the text's fill color is opaque white. Setting the fill color to a transparent color with an outline will cause the outline to be displayed in the fill area of the text.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">color</td><td>New fill color of the text</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a6b4ba8c435b59e1e05f831e6230dc537" title="Get the fill color of the text. ">getFillColor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2927805d1ae92d57f15034ea34756b81"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2927805d1ae92d57f15034ea34756b81">◆ </a></span>setFont()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Font.html">Font</a> & </td>
|
|
<td class="paramname"><em>font</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the text's font. </p>
|
|
<p>The <em>font</em> argument refers to a font that must exist as long as the text uses it. Indeed, the text doesn't store its own copy of the font, but rather keeps a pointer to the one that you passed to this function. If the font is destroyed and the text tries to use it, the behavior is undefined.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">font</td><td>New font</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a47cd96d7b2c37b2f820e4d6e1bb83f96" title="Get the text's font. ">getFont</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab516110605edb0191a7873138ac42af2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab516110605edb0191a7873138ac42af2">◆ </a></span>setLetterSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setLetterSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>spacingFactor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the letter spacing factor. </p>
|
|
<p>The default spacing between letters is defined by the font. This factor doesn't directly apply to the existing spacing between each character, it rather adds a fixed space between them which is calculated from the font metrics and the character size. Note that factors below 1 (including negative numbers) bring characters closer to each other. By default the letter spacing factor is 1.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">spacingFactor</td><td>New letter spacing factor</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a028fc6e561bd9a0671254419b498b889" title="Get the size of the letter spacing factor. ">getLetterSpacing</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6505688f79e2e2d90bd68f4d767e965"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6505688f79e2e2d90bd68f4d767e965">◆ </a></span>setLineSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setLineSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>spacingFactor</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the line spacing factor. </p>
|
|
<p>The default spacing between lines is defined by the font. This method enables you to set a factor for the spacing between lines. By default the line spacing factor is 1.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">spacingFactor</td><td>New line spacing factor</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a670622e1c299dfd6518afe289c7cd248" title="Get the size of the line spacing factor. ">getLineSpacing</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a56c67bd80aae8418d13fb96c034d25ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a56c67bd80aae8418d13fb96c034d25ec">◆ </a></span>setOrigin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setOrigin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the local origin of the object </p>
|
|
<p>The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>X coordinate of the new origin </td></tr>
|
|
<tr><td class="paramname">y</td><td>Y coordinate of the new origin</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a37ea3500afac234814a43ce809ef264e" title="get the local origin of the object ">getOrigin</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa93a835ffbf3bee2098dfbbc695a7f05"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa93a835ffbf3bee2098dfbbc695a7f05">◆ </a></span>setOrigin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setOrigin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>origin</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the local origin of the object </p>
|
|
<p>The origin of an object defines the center point for all transformations (position, scale, rotation). The coordinates of this point must be relative to the top-left corner of the object, and ignore all transformations (position, scale, rotation). The default origin of a transformable object is (0, 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">origin</td><td>New origin</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a37ea3500afac234814a43ce809ef264e" title="get the local origin of the object ">getOrigin</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa19ec69c3b894e963602a6804ca68fe4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa19ec69c3b894e963602a6804ca68fe4">◆ </a></span>setOutlineColor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setOutlineColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Color.html">Color</a> & </td>
|
|
<td class="paramname"><em>color</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the outline color of the text. </p>
|
|
<p>By default, the text's outline color is opaque black.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">color</td><td>New outline color of the text</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a53559d563461089f1172571b375442dc" title="Get the outline color of the text. ">getOutlineColor</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab0e6be3b40124557bf53737fe6a6ce77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab0e6be3b40124557bf53737fe6a6ce77">◆ </a></span>setOutlineThickness()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setOutlineThickness </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>thickness</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the thickness of the text's outline. </p>
|
|
<p>By default, the outline thickness is 0.</p>
|
|
<p>Be aware that using a negative value for the outline thickness will cause distorted rendering.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">thickness</td><td>New outline thickness, in pixels</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#af6bf01c23189edf52c8b38708db6f3f6" title="Get the outline thickness of the text. ">getOutlineThickness</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4dbfb1a7c80688b0b4c477d706550208"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4dbfb1a7c80688b0b4c477d706550208">◆ </a></span>setPosition() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>y</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the position of the object </p>
|
|
<p>This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">x</td><td>X coordinate of the new position </td></tr>
|
|
<tr><td class="paramname">y</td><td>Y coordinate of the new position</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a86b461d6a941ad390c2ad8b6a4a20391" title="Move the object by a given offset. ">move</a>, <a class="el" href="classsf_1_1Transformable.html#a73f9739bc6e74db2cea154bc8e94ec46" title="get the position of the object ">getPosition</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af1a42209ce2b5d3f07b00f917bcd8015"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af1a42209ce2b5d3f07b00f917bcd8015">◆ </a></span>setPosition() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>position</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the position of the object </p>
|
|
<p>This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable object is (0, 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">position</td><td>New position</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a86b461d6a941ad390c2ad8b6a4a20391" title="Move the object by a given offset. ">move</a>, <a class="el" href="classsf_1_1Transformable.html#a73f9739bc6e74db2cea154bc8e94ec46" title="get the position of the object ">getPosition</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a32baf2bf1a74699b03bf8c95030a38ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a32baf2bf1a74699b03bf8c95030a38ed">◆ </a></span>setRotation()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setRotation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>angle</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the orientation of the object </p>
|
|
<p>This function completely overwrites the previous rotation. See the rotate function to add an angle based on the previous rotation instead. The default rotation of a transformable object is 0.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">angle</td><td>New rotation, in degrees</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#af8a5ffddc0d93f238fee3bf8efe1ebda" title="Rotate the object. ">rotate</a>, <a class="el" href="classsf_1_1Transformable.html#aa00b5c5d4a06ac24a94dd72c56931d3a" title="get the orientation of the object ">getRotation</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaec50b46b3f41b054763304d1e727471"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaec50b46b3f41b054763304d1e727471">◆ </a></span>setScale() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setScale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>factorX</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>factorY</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the scale factors of the object </p>
|
|
<p>This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">factorX</td><td>New horizontal scale factor </td></tr>
|
|
<tr><td class="paramname">factorY</td><td>New vertical scale factor</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391" title="Scale the object. ">scale</a>, <a class="el" href="classsf_1_1Transformable.html#a73819fdea80ca8a06fad8a0067b4588c" title="get the current scale of the object ">getScale</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4c48a87f1626047e448f9c1a68ff167e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4c48a87f1626047e448f9c1a68ff167e">◆ </a></span>setScale() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Transformable::setScale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1Vector2.html">Vector2f</a> & </td>
|
|
<td class="paramname"><em>factors</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inherited</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>set the scale factors of the object </p>
|
|
<p>This function completely overwrites the previous scale. See the scale function to add a factor based on the previous scale instead. The default scale of a transformable object is (1, 1).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">factors</td><td>New scale factors</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Transformable.html#a3de0c6d8957f3cf318092f3f60656391" title="Scale the object. ">scale</a>, <a class="el" href="classsf_1_1Transformable.html#a73819fdea80ca8a06fad8a0067b4588c" title="get the current scale of the object ">getScale</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7d3b3359f286fd9503d1ced25b7b6c33"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7d3b3359f286fd9503d1ced25b7b6c33">◆ </a></span>setString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classsf_1_1String.html">String</a> & </td>
|
|
<td class="paramname"><em>string</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the text's string. </p>
|
|
<p>The <em>string</em> argument is a <a class="el" href="classsf_1_1String.html" title="Utility string class that automatically handles conversions between types and encodings. ">sf::String</a>, which can automatically be constructed from standard string types. So, the following calls are all valid: </p><div class="fragment"><div class="line">text.<a class="code" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33">setString</a>(<span class="stringliteral">"hello"</span>);</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33">setString</a>(L<span class="stringliteral">"hello"</span>);</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33">setString</a>(std::string(<span class="stringliteral">"hello"</span>));</div><div class="line">text.<a class="code" href="classsf_1_1Text.html#a7d3b3359f286fd9503d1ced25b7b6c33">setString</a>(std::wstring(L<span class="stringliteral">"hello"</span>));</div></div><!-- fragment --><p> A text's string is empty by default.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">string</td><td>New string</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a084c275eb4bca835696af5f8f9c80ab3" title="Get the text's string. ">getString</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad791702bc2d1b6590a1719aa60635edf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad791702bc2d1b6590a1719aa60635edf">◆ </a></span>setStyle()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void sf::Text::setStyle </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Uint32 </td>
|
|
<td class="paramname"><em>style</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the text's style. </p>
|
|
<p>You can pass a combination of one or more styles, for example <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82af1b47f98fb1e10509ba930a596987171" title="Bold characters. ">sf::Text::Bold</a> | <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82aee249eb803848723c542c2062ebe69d8" title="Italic characters. ">sf::Text::Italic</a>. The default style is <a class="el" href="classsf_1_1Text.html#aa8add4aef484c6e6b20faff07452bd82a2af9ae5e1cda126570f744448e0caa32" title="Regular characters, no style. ">sf::Text::Regular</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">style</td><td>New style</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classsf_1_1Text.html#a0da79b0c057f4bb51592465a205c35d7" title="Get the text's style. ">getStyle</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Text_8hpp_source.html">Text.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>
|