You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
274 lines
17 KiB
HTML
274 lines
17 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>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
|
<title>Otter: Otter.BitmapFont Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Otter
|
|
 <span id="projectnumber">0.9.8.91</span>
|
|
</div>
|
|
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="namespaces.html"><span>Packages</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
$(document).ready(function(){initNavTree('class_otter_1_1_bitmap_font.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="class_otter_1_1_bitmap_font-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Otter.BitmapFont Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><a class="el" href="class_otter_1_1_font.html">Font</a> used for loading premade textures of characters, usually arcade fonts and stuff like that. Currently supports fonts created with BMFont, Littera, and CBFG.
|
|
<a href="class_otter_1_1_bitmap_font.html#details">More...</a></p>
|
|
|
|
<p>Inherits <a class="el" href="class_otter_1_1_base_font.html">Otter.BaseFont</a>.</p>
|
|
<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:aa5eb3dc743492c99823238a685eb9e70"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5eb3dc743492c99823238a685eb9e70"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BitmapFont</b> (<a class="el" href="class_otter_1_1_texture.html">Texture</a> texture)</td></tr>
|
|
<tr class="separator:aa5eb3dc743492c99823238a685eb9e70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad675ca4a30a28d70f42fb2f200c623de"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad675ca4a30a28d70f42fb2f200c623de"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BitmapFont</b> (<a class="el" href="class_otter_1_1_texture.html">Texture</a> texture, int charWidth, int charHeight, int charOffset=32)</td></tr>
|
|
<tr class="separator:ad675ca4a30a28d70f42fb2f200c623de"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a72dd1eb5719ead6e6b322ddff4246cdc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72dd1eb5719ead6e6b322ddff4246cdc"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BitmapFont</b> (<a class="el" href="class_otter_1_1_bitmap_font_config.html">BitmapFontConfig</a> config)</td></tr>
|
|
<tr class="separator:a72dd1eb5719ead6e6b322ddff4246cdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb37dc3f2994908ae8d336c95615eed2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb37dc3f2994908ae8d336c95615eed2"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>BitmapFont</b> (string source)</td></tr>
|
|
<tr class="separator:adb37dc3f2994908ae8d336c95615eed2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b1a6f2f92b0a7c954710309cfff0fdd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_bitmap_font.html">BitmapFont</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_bitmap_font.html#a0b1a6f2f92b0a7c954710309cfff0fdd">LoadDataFile</a> (string path, BitmapFontDataType dataType)</td></tr>
|
|
<tr class="memdesc:a0b1a6f2f92b0a7c954710309cfff0fdd"><td class="mdescLeft"> </td><td class="mdescRight">Loads the data to render the bitmap text with from a file. <a href="#a0b1a6f2f92b0a7c954710309cfff0fdd">More...</a><br/></td></tr>
|
|
<tr class="separator:a0b1a6f2f92b0a7c954710309cfff0fdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8cd8dcd584de6633651e1056ea6adaf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_bitmap_font.html">BitmapFont</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_bitmap_font.html#a8cd8dcd584de6633651e1056ea6adaf1">LoadData</a> (string data, BitmapFontDataType dataType)</td></tr>
|
|
<tr class="memdesc:a8cd8dcd584de6633651e1056ea6adaf1"><td class="mdescLeft"> </td><td class="mdescRight">Loads the data to render the bitmap text with. <a href="#a8cd8dcd584de6633651e1056ea6adaf1">More...</a><br/></td></tr>
|
|
<tr class="separator:a8cd8dcd584de6633651e1056ea6adaf1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae751ccdc6327242cdf4c8c9d3fe603ee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae751ccdc6327242cdf4c8c9d3fe603ee"></a>
|
|
override float </td><td class="memItemRight" valign="bottom"><b>GetKerning</b> (char first, char second, int characterSize)</td></tr>
|
|
<tr class="separator:ae751ccdc6327242cdf4c8c9d3fe603ee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a741e112e55c2b45c28ddaa8f1489657e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a741e112e55c2b45c28ddaa8f1489657e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>CharCodeOffset</b> = 32</td></tr>
|
|
<tr class="separator:a741e112e55c2b45c28ddaa8f1489657e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a042cc54013f9aaa16892048e22192f82"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a042cc54013f9aaa16892048e22192f82"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>CharacterWidth</b> = 8</td></tr>
|
|
<tr class="separator:a042cc54013f9aaa16892048e22192f82"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0fcbe453c4b26082ac8c0a169333930a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0fcbe453c4b26082ac8c0a169333930a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>CharacterHeight</b> = 8</td></tr>
|
|
<tr class="separator:a0fcbe453c4b26082ac8c0a169333930a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7d8adc6639caa5e67dd1f8f14abdc23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad7d8adc6639caa5e67dd1f8f14abdc23"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>LineSpacing</b></td></tr>
|
|
<tr class="separator:ad7d8adc6639caa5e67dd1f8f14abdc23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec4715e3ac14e1236c918c55925fab8f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec4715e3ac14e1236c918c55925fab8f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>EnableKerning</b> = true</td></tr>
|
|
<tr class="separator:aec4715e3ac14e1236c918c55925fab8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08f9d5ee949bcdfda73f700985a4706e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08f9d5ee949bcdfda73f700985a4706e"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>CharacterOffsetX</b> = 0</td></tr>
|
|
<tr class="separator:a08f9d5ee949bcdfda73f700985a4706e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2818cd74c0be35eba4f93c39b440fdb2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2818cd74c0be35eba4f93c39b440fdb2"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>CharacterOffsetY</b> = 0</td></tr>
|
|
<tr class="separator:a2818cd74c0be35eba4f93c39b440fdb2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
|
|
Properties</h2></td></tr>
|
|
<tr class="memitem:a754e6fc3678c85e6a853cd7691ce5a78"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a754e6fc3678c85e6a853cd7691ce5a78"></a>
|
|
<a class="el" href="class_otter_1_1_texture.html">Texture</a> </td><td class="memItemRight" valign="bottom"><b>Texture</b><code> [get, set]</code></td></tr>
|
|
<tr class="separator:a754e6fc3678c85e6a853cd7691ce5a78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a1704ca1683ec87eda60646b1bb3260"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5a1704ca1683ec87eda60646b1bb3260"></a>
|
|
string </td><td class="memItemRight" valign="bottom"><b>FontData</b><code> [get, set]</code></td></tr>
|
|
<tr class="separator:a5a1704ca1683ec87eda60646b1bb3260"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeccd4bfa1ed2a42825398a9555794880"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeccd4bfa1ed2a42825398a9555794880"></a>
|
|
BitmapFontDataType </td><td class="memItemRight" valign="bottom"><b>DataType</b><code> [get, set]</code></td></tr>
|
|
<tr class="separator:aeccd4bfa1ed2a42825398a9555794880"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p><a class="el" href="class_otter_1_1_font.html">Font</a> used for loading premade textures of characters, usually arcade fonts and stuff like that. Currently supports fonts created with BMFont, Littera, and CBFG. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a8cd8dcd584de6633651e1056ea6adaf1"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_bitmap_font.html">BitmapFont</a> Otter.BitmapFont.LoadData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>data</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">BitmapFontDataType </td>
|
|
<td class="paramname"><em>dataType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the data to render the bitmap text with. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>The data.</td></tr>
|
|
<tr><td class="paramname">dataType</td><td>Type of the data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_bitmap_font.html" title="Font used for loading premade textures of characters, usually arcade fonts and stuff like that...">BitmapFont</a></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0b1a6f2f92b0a7c954710309cfff0fdd"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_otter_1_1_bitmap_font.html">BitmapFont</a> Otter.BitmapFont.LoadDataFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>path</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">BitmapFontDataType </td>
|
|
<td class="paramname"><em>dataType</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the data to render the bitmap text with from a file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>The path to the file that contains the data.</td></tr>
|
|
<tr><td class="paramname">dataType</td><td>The type of data.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_bitmap_font.html" title="Font used for loading premade textures of characters, usually arcade fonts and stuff like that...">BitmapFont</a></dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>Otter/Graphics/Text/BitmapFont.cs</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_bitmap_font.html">BitmapFont</a></li>
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:52 for Otter by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|