atria-soft/ewol
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
ewol/class_ewol__resource__TexturedFont.html

198 lines
13 KiB
HTML
Raw Blame History

<!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/">&nbsp;&nbsp;&nbsp;[ 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__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 class="sousmenu"><a href="namespace_ewol__audio.html">audio</a>
<ul class="niveau3">
<li><a href="namespace_ewol__audio__wav.html">wav</a>
</li>
<li><a href="namespace_ewol__audio__music.html">music</a>
</li>
<li><a href="namespace_ewol__audio__effects.html">effects</a>
</li>
</ul>
</li>
<li><a href="namespace_ewol__portAudio.html">portAudio</a>
</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>
</ul>
</div>
<h3>Documentation:</h3><div id="menu">
<ul class="niveau1"><li><a href="001_bases.html">bases</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">HelloWord</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::resource::TexturedFont</h1><hr/><h2>Description:</h2>
<br/><br/>
<h2>Constructor and Destructor:</h2>
<pre>
# <a class="code-function" href="#5327">TexturedFont</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/># <a class="code-function" href="#5329">~TexturedFont</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<h2>Synopsis:</h2>
<pre>
+ <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;GlyphProperty&gt; <a class="code-member" href="#5324">m_listElement</a>;<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#5331">getHeight</a> (<span class="code-storage-keyword">const</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">_displayMode</span>);<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#5333">getFontSize</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-type" >int32_t</span> <a class="code-function" href="#5335">getIndex</a> (<span class="code-type" >char32_t</span> <span class="code-argument">_charcode</span>,<br/> <span class="code-storage-keyword">const</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">_displayMode</span>);<br/>+ <a class="code-type" href="class_ewol__GlyphProperty.html">ewol::GlyphProperty</a>* <a class="code-function" href="#5338">getGlyphPointer</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">const</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">_displayMode</span>);<br/>+ <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__font__mode.html">ewol::font::mode</a> <a class="code-function" href="#5341">getWrappingMode</a> (<span class="code-storage-keyword">const</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">_source</span>);<br/>+ <a class="code-type" href="class_ewol__resource__TexturedFont.html">ewol::resource::TexturedFont</a>* <a class="code-function" href="#5343">keep</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">_filename</span>);<br/>+ <span class="code-type" >void</span> <a class="code-function" href="#5345">release</a> (<a class="code-type" href="class_ewol__resource__TexturedFont.html">ewol::resource::TexturedFont</a>* & <span class="code-argument">_object</span>);<br/></pre>
<br/>
<h2>Object Hierarchy:<h2>
<pre>
+<a href="class_ewol__Object.html">ewol::Object</a><br/> +--> +<a href="class_ewol__Resource.html">ewol::Resource</a><br/> +--> +<a href="class_ewol__resource__Texture.html">ewol::resource::Texture</a><br/> +--> ewol::resource::TexturedFont<br/></pre>
<h2>Detail:</h2>
<a id="5324"/><a id="5327"/><h3>m_listElement</h3><pre>
+ <a class="code-type" href="http://www.cplusplus.com/reference/vector/vector/">std::vector</a>&lt;GlyphProperty&gt; <span class="code-member">m_listElement</span>;<br/></pre>
<br/>
<br/>
<hr/>
<a id="5329"/><h3>TexturedFont</h3><pre>
# <span class="code-function">TexturedFont</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>
<br/>
<br/>
<hr/>
<a id="5331"/><h3>~TexturedFont</h3><pre>
# <span class="code-function">~TexturedFont</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
<br/>
<br/>
<hr/>
<a id="5333"/><h3>getHeight</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getHeight</span> (<span class="code-storage-keyword">const</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">_displayMode</span>);<br/></pre>
get the display height of this font<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displayMode</span> </td><td> Mode to display the currrent font</td></tr>
<tr><td><b>Return: </b></td><td></td><td>Dimention of the font need between 2 lines</td></tr></table>
</ul>
<br/>
<hr/>
<a id="5335"/><h3>getFontSize</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getFontSize</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
get the font height (user friendly)<br/><ul>
<table class="parameter-list">
<tr><td><b>Return: </b></td><td></td><td>Dimention of the font the user requested</td></tr></table>
</ul>
<br/>
<hr/>
<a id="5338"/><h3>getIndex</h3><pre>
+ <span class="code-type" >int32_t</span> <span class="code-function">getIndex</span> (<span class="code-type" >char32_t</span> <span class="code-argument">_charcode</span>,<br/> <span class="code-storage-keyword">const</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">_displayMode</span>);<br/></pre>
get the ID of a unicode charcode<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_charcode</span> </td><td> The unicodeValue</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displayMode</span> </td><td> Mode to display the currrent font</td></tr>
<tr><td><b>Return: </b></td><td></td><td>The ID in the table (if it does not exist : return 0)</td></tr></table>
</ul>
<br/>
<hr/>
<a id="5341"/><h3>getGlyphPointer</h3><pre>
+ <a class="code-type" href="class_ewol__GlyphProperty.html">ewol::GlyphProperty</a>* <span class="code-function">getGlyphPointer</span> (<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">const</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">_displayMode</span>);<br/></pre>
get the pointer on the coresponding glyph<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_charcode</span> </td><td> The unicodeValue</td></tr>
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_displayMode</span> </td><td> Mode to display the currrent font</td></tr>
<tr><td><b>Return: </b></td><td></td><td>The pointer on the glyph == &gt; never NULL</td></tr></table>
</ul>
<br/>
<hr/>
<a id="5343"/><h3>getWrappingMode</h3><pre>
+ <span class="code-storage-keyword">enum</span> <a class="code-type" href="enum_ewol__font__mode.html">ewol::font::mode</a> <span class="code-function">getWrappingMode</span> (<span class="code-storage-keyword">const</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">_source</span>);<br/></pre>
The wrapping mode is used to prevent the non existance of a specific mode.
For exemple when a blod mode does not exist, this resend a regular mode.<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_source</span> </td><td> The requested mode.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>the best mode we have in stock.</td></tr></table>
</ul>
<br/>
<hr/>
<a id="5345"/><h3>keep</h3><pre>
+ <a class="code-type" href="class_ewol__resource__TexturedFont.html">ewol::resource::TexturedFont</a>* <span class="code-function">keep</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">_filename</span>);<br/></pre>
keep the resource pointer.<br/><b>Note:</b> Never free this pointer by your own...<br/> <ul>
<table class="parameter-list">
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_filename</span> </td><td> Name of the texture font.</td></tr>
<tr><td><b>Return: </b></td><td></td><td>pointer on the resource or NULL if an error occured.</td></tr></table>
</ul>
<br/>
<hr/>
<h3>release</h3><pre>
+ <span class="code-type" >void</span> <span class="code-function">release</span> (<a class="code-type" href="class_ewol__resource__TexturedFont.html">ewol::resource::TexturedFont</a>* & <span class="code-argument">_object</span>);<br/></pre>
release the keeped resources<br/><ul>
<table class="parameter-list">
<td><b>Parameter [input] [output]:</b></td><td><span class="code-argument">reference</span> </td><td> on the object pointer</td></tr>
</table>
</ul>
<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>
Reference in New Issue View Git Blame Copy Permalink