259 lines
18 KiB
HTML
259 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ewol Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ewol library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ewol/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a href="namespace_ewol.html">ewol</a>
|
|
<ul class="niveau2">
|
|
<li><a href="namespace_ewol__translate.html">translate</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__key.html">key</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__widget.html">widget</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__openGL.html">openGL</a>
|
|
</li>
|
|
<li class="sousmenu"><a href="namespace_ewol__context.html">context</a>
|
|
<ul class="niveau3">
|
|
<li><a href="namespace_ewol__context__clipBoard.html">clipBoard</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_ewol__compositing.html">compositing</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__object.html">object</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__resource.html">resource</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__font.html">font</a>
|
|
</li>
|
|
<li><a href="namespace_ewol__event.html">event</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="namespace_MacOs.html">MacOs</a>
|
|
</li>
|
|
<li><a href="namespace_IOs.html">IOs</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<h3>Documentation:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="001_bases.html">Bases</a></li>
|
|
</ul><ul class="niveau1"><li><a href="faq.html">Faq</a></li>
|
|
</ul></div>
|
|
<h3>Tutorials:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="tutorial_000_Build.html">Build</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_001_HelloWord.html">Hello word</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_010_ObjectModel.html">Object model</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_011_ObjectConfig.html">Object config</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_012_ObjectMessage.html">Object message</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_020_FileAccess.html">File access</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_021_Resources.html">Resources</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_030_ConplexeXmlGui.html">Conplexe xml gui</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_050_CreateCustomWidget.html">Create custom widget</a></li>
|
|
</ul><ul class="niveau1"><li><a href="tutorial_051_AddWidgetCustumInXML.html">Add widget custum in x m l</a></li>
|
|
</ul></div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ege/index.html">ege</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: ewol::compositing::TextDF</h1><hr/><h2>Description:</h2>
|
|
|
|
<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#2453">TextDF</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_fontName</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#2456">~TextDF</a> ();<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
# <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::resource::DistanceFieldFont> <a class="code-member" href="#2450">m_fontDF</a>;<br/># <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><float> <a class="code-member" href="#2451">m_glyphLevel</a>;<br/># <span class="code-type" >int32_t</span> <a class="code-member" href="#2452">m_GLglyphLevel</a>;<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#2457">updateSizeToRender</a> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2459">clear</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2460">drawD</a> (<span class="code-type" >bool</span> <span class="code-argument">_disableDepthTest</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2462">drawMT</a> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_transformationMatrix</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_enableDepthTest</span>);<br/># <span class="code-type" >float</span> <a class="code-member" href="#2465">m_size</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <a class="code-function" href="#2466">getHeight</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <a class="code-function" href="#2467">getSize</a> ();<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2468">setSize</a> (<span class="code-type" >float</span> <span class="code-argument">_size</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__GlyphProperty.html">ewol::GlyphProperty</a>* <a class="code-function" href="#2470">getGlyphPointer</a> (<span class="code-type" >char32_t</span> <span class="code-argument">_charcode</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2472">loadProgram</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_shaderName</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2474">setFontSize</a> (<span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2476">setFontName</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_fontName</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2478">setFont</a> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_fontName</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2481">setFontMode</a> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__font__mode.html">ewol::font::mode</a> <span class="code-argument">_mode</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#2483">printChar</a> (<span class="code-storage-keyword">const</span> <span class="code-type" >char32_t</span> & <span class="code-argument">_charcode</span>);<br/>+ <span class="code-storage-keyword">virtual</span> vec3 <a class="code-function" href="#2485">calculateSizeChar</a> (<span class="code-storage-keyword">const</span> <span class="code-type" >char32_t</span> & <span class="code-argument">_charcode</span>);<br/></pre>
|
|
<br/>
|
|
<h2>Object Hierarchy:<h2>
|
|
<pre>
|
|
+<a href="class_ewol__Compositing.html">ewol::Compositing</a><br/> +--> +<a href="class_ewol__compositing__TextBase.html">ewol::compositing::TextBase</a><br/> +--> ewol::compositing::TextDF<br/></pre>
|
|
<h2>Detail:</h2>
|
|
<a id="2450"/><a id="2451"/><h3>m_fontDF</h3><pre>
|
|
# <a class="code-type" href="http://www.cplusplus.com/reference/memory/shared_ptr/">std::shared_ptr</a><ewol::resource::DistanceFieldFont> <span class="code-member">m_fontDF</span>;<br/></pre>
|
|
|
|
Font resources<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2452"/><h3>m_glyphLevel</h3><pre>
|
|
# <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a><float> <span class="code-member">m_glyphLevel</span>;<br/></pre>
|
|
|
|
Level of display of the glyph (notmal : 0.50, bold : 0.40, super bold : 0.30 ...)<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2453"/><h3>m_GLglyphLevel</h3><pre>
|
|
# <span class="code-type" >int32_t</span> <span class="code-member">m_GLglyphLevel</span>;<br/></pre>
|
|
|
|
openGL Id on the glyph level display<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2456"/><h3>TextDF</h3><pre>
|
|
+ <span class="code-function">TextDF</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_fontName</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/></pre>
|
|
generic constructor<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_fontName</span> </td><td> Name of the font that might be loaded</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_fontSize</span> </td><td> size of the font that might be loaded</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2457"/><h3>~TextDF</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~TextDF</span> ();<br/></pre>
|
|
generic destructor<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2459"/><h3>updateSizeToRender</h3><pre>
|
|
+ <span class="code-type" >void</span> <span class="code-function">updateSizeToRender</span> (<span class="code-storage-keyword">const</span> vec2 & <span class="code-argument">_size</span>);<br/></pre>
|
|
Calculate size to be at the best size for a render in this special size.<br/><b>Note:</b> special for Distance field mode.<br/> <ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_size</span> </td><td> request dimention.</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2460"/><h3>clear</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">clear</span> ();<br/></pre>
|
|
clear all the registered element in the current element<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2462"/><h3>drawD</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">drawD</span> (<span class="code-type" >bool</span> <span class="code-argument">_disableDepthTest</span>);<br/></pre>
|
|
draw All the refistered text in the current element on openGL<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2465"/><h3>drawMT</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">drawMT</span> (<span class="code-storage-keyword">const</span> mat4 & <span class="code-argument">_transformationMatrix</span>,<br/> <span class="code-type" >bool</span> <span class="code-argument">_enableDepthTest</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2466"/><h3>m_size</h3><pre>
|
|
# <span class="code-type" >float</span> <span class="code-member">m_size</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2467"/><h3>getHeight</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <span class="code-function">getHeight</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2468"/><h3>getSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >float</span> <span class="code-function">getSize</span> ();<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2470"/><h3>setSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setSize</span> (<span class="code-type" >float</span> <span class="code-argument">_size</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2472"/><h3>getGlyphPointer</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <a class="code-type" href="class_ewol__GlyphProperty.html">ewol::GlyphProperty</a>* <span class="code-function">getGlyphPointer</span> (<span class="code-type" >char32_t</span> <span class="code-argument">_charcode</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2474"/><h3>loadProgram</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">loadProgram</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_shaderName</span>);<br/></pre>
|
|
load the openGL program and get all the ID needed<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="2476"/><h3>setFontSize</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setFontSize</span> (<span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/></pre>
|
|
Specify the font size (this reset the internal element of the current text (system requirement)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_fontSize</span> </td><td> New font size</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2478"/><h3>setFontName</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setFontName</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> & <span class="code-argument">_fontName</span>);<br/></pre>
|
|
Specify the font name (this reset the internal element of the current text (system requirement)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_fontName</span> </td><td> Current name of the selected font</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2481"/><h3>setFont</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setFont</span> (<a class="code-type" href="http://www.cplusplus.com/reference/string/string/">std::string</a> <span class="code-argument">_fontName</span>,<br/> <span class="code-type" >int32_t</span> <span class="code-argument">_fontSize</span>);<br/></pre>
|
|
Specify the font property (this reset the internal element of the current text (system requirement)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">fontName</span> </td><td> Current name of the selected font</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">fontSize</span> </td><td> New font size</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2483"/><h3>setFontMode</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">setFontMode</span> (<span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__font__mode.html">ewol::font::mode</a> <span class="code-argument">_mode</span>);<br/></pre>
|
|
Specify the font mode for the next @ref print<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">mode</span> </td><td> The font mode requested</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="2485"/><h3>printChar</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">printChar</span> (<span class="code-storage-keyword">const</span> <span class="code-type" >char32_t</span> & <span class="code-argument">_charcode</span>);<br/></pre>
|
|
display the current char in the current element (note that the kerning is availlable if the position is not changed)<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_charcode</span> </td><td> Char that might be dispalyed</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>calculateSizeChar</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> vec3 <span class="code-function">calculateSizeChar</span> (<span class="code-storage-keyword">const</span> <span class="code-type" >char32_t</span> & <span class="code-argument">_charcode</span>);<br/></pre>
|
|
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|