Added doxygen documentation. Now we have to update the comments in all the files. See aide.h and button.h for some examples. Documentation is regenerated by "doxygen Doxyfile" in the root directory
git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@665 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Adrien Destugues
109
doxydoc/html/SFont_8h-source.html
Normal file
109
doxydoc/html/SFont_8h-source.html
Normal file
@@ -0,0 +1,109 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
||||
<title>GrafX2: SFont.h Source File</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||||
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
||||
</head><body>
|
||||
<!-- Generated by Doxygen 1.5.8 -->
|
||||
<div class="navigation" id="top">
|
||||
<div class="tabs">
|
||||
<ul>
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="tabs">
|
||||
<ul>
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h1>SFont.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* SFont: a simple font-library that uses special bitmaps as fonts</span>
|
||||
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 Karl Bartel</span>
|
||||
<a name="l00003"></a>00003 <span class="comment"></span>
|
||||
<a name="l00004"></a>00004 <span class="comment"> License: GPL or LGPL (at your choice)</span>
|
||||
<a name="l00005"></a>00005 <span class="comment"> WWW: http://www.linux-games.com/sfont/</span>
|
||||
<a name="l00006"></a>00006 <span class="comment"></span>
|
||||
<a name="l00007"></a>00007 <span class="comment"> This program is free software; you can redistribute it and/or modify </span>
|
||||
<a name="l00008"></a>00008 <span class="comment"> it under the terms of the GNU General Public License as published by </span>
|
||||
<a name="l00009"></a>00009 <span class="comment"> the Free Software Foundation; either version 2 of the License, or </span>
|
||||
<a name="l00010"></a>00010 <span class="comment"> (at your option) any later version. </span>
|
||||
<a name="l00011"></a>00011 <span class="comment"> </span>
|
||||
<a name="l00012"></a>00012 <span class="comment"> This program is distributed in the hope that it will be useful, </span>
|
||||
<a name="l00013"></a>00013 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of </span>
|
||||
<a name="l00014"></a>00014 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the </span>
|
||||
<a name="l00015"></a>00015 <span class="comment"> GNU General Public License for more details. </span>
|
||||
<a name="l00016"></a>00016 <span class="comment"> </span>
|
||||
<a name="l00017"></a>00017 <span class="comment"> You should have received a copy of the GNU General Public License </span>
|
||||
<a name="l00018"></a>00018 <span class="comment"> along with this program; if not, write to the Free Software </span>
|
||||
<a name="l00019"></a>00019 <span class="comment"> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA </span>
|
||||
<a name="l00020"></a>00020 <span class="comment"> </span>
|
||||
<a name="l00021"></a>00021 <span class="comment"> Karl Bartel</span>
|
||||
<a name="l00022"></a>00022 <span class="comment"> Cecilienstr. 14 </span>
|
||||
<a name="l00023"></a>00023 <span class="comment"> 12307 Berlin</span>
|
||||
<a name="l00024"></a>00024 <span class="comment"> GERMANY</span>
|
||||
<a name="l00025"></a>00025 <span class="comment"> karlb@gmx.net </span>
|
||||
<a name="l00026"></a>00026 <span class="comment">*/</span>
|
||||
<a name="l00027"></a>00027
|
||||
<a name="l00028"></a>00028 <span class="comment">/************************************************************************ </span>
|
||||
<a name="l00029"></a>00029 <span class="comment">* SFONT - SDL Font Library by Karl Bartel <karlb@gmx.net> *</span>
|
||||
<a name="l00030"></a>00030 <span class="comment">* *</span>
|
||||
<a name="l00031"></a>00031 <span class="comment">* All functions are explained below. For further information, take a *</span>
|
||||
<a name="l00032"></a>00032 <span class="comment">* look at the example files, the links at the SFont web site, or *</span>
|
||||
<a name="l00033"></a>00033 <span class="comment">* contact me, if you problem isn' addressed anywhere. *</span>
|
||||
<a name="l00034"></a>00034 <span class="comment">* *</span>
|
||||
<a name="l00035"></a>00035 <span class="comment">************************************************************************/</span>
|
||||
<a name="l00036"></a>00036 <span class="preprocessor">#ifndef _SFONT_H_</span>
|
||||
<a name="l00037"></a>00037 <span class="preprocessor"></span><span class="preprocessor">#define _SFONT_H_</span>
|
||||
<a name="l00038"></a>00038 <span class="preprocessor"></span>
|
||||
<a name="l00039"></a>00039 <span class="preprocessor">#include <SDL.h></span>
|
||||
<a name="l00040"></a>00040
|
||||
<a name="l00041"></a>00041 <span class="preprocessor">#ifdef __cplusplus </span>
|
||||
<a name="l00042"></a>00042 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
||||
<a name="l00043"></a>00043 <span class="preprocessor">#endif</span>
|
||||
<a name="l00044"></a>00044 <span class="preprocessor"></span>
|
||||
<a name="l00045"></a>00045 <span class="comment">// Delcare one variable of this type for each font you are using.</span>
|
||||
<a name="l00046"></a>00046 <span class="comment">// To load the fonts, load the font image into YourFont->Surface</span>
|
||||
<a name="l00047"></a>00047 <span class="comment">// and call InitFont( YourFont );</span>
|
||||
<a name="l00048"></a><a class="code" href="structSFont__Font.html">00048</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
||||
<a name="l00049"></a><a class="code" href="structSFont__Font.html#bc8097ea87278ce195a7fcebf7664187">00049</a> SDL_Surface *Surface;
|
||||
<a name="l00050"></a><a class="code" href="structSFont__Font.html#d05fea05d81d966a6c348ad402d33838">00050</a> <span class="keywordtype">int</span> CharPos[512];
|
||||
<a name="l00051"></a><a class="code" href="structSFont__Font.html#5790b0f45b79591f92f31cbe9e8b80f2">00051</a> <span class="keywordtype">int</span> MaxPos;
|
||||
<a name="l00052"></a>00052 } <a class="code" href="structSFont__Font.html">SFont_Font</a>;
|
||||
<a name="l00053"></a>00053
|
||||
<a name="l00054"></a>00054 <span class="comment">// Initializes the font</span>
|
||||
<a name="l00055"></a>00055 <span class="comment">// Font: this contains the suface with the font.</span>
|
||||
<a name="l00056"></a>00056 <span class="comment">// The Surface must be loaded before calling this function</span>
|
||||
<a name="l00057"></a>00057 <a class="code" href="structSFont__Font.html">SFont_Font</a>* SFont_InitFont (SDL_Surface *Font);
|
||||
<a name="l00058"></a>00058
|
||||
<a name="l00059"></a>00059 <span class="comment">// Frees the font</span>
|
||||
<a name="l00060"></a>00060 <span class="comment">// Font: The font to free</span>
|
||||
<a name="l00061"></a>00061 <span class="comment">// The font must be loaded before using this function.</span>
|
||||
<a name="l00062"></a>00062 <span class="keywordtype">void</span> SFont_FreeFont(<a class="code" href="structSFont__Font.html">SFont_Font</a>* Font);
|
||||
<a name="l00063"></a>00063
|
||||
<a name="l00064"></a>00064 <span class="comment">// Blits a string to a surface</span>
|
||||
<a name="l00065"></a>00065 <span class="comment">// Destination: the suface you want to blit to</span>
|
||||
<a name="l00066"></a>00066 <span class="comment">// text: a string containing the text you want to blit.</span>
|
||||
<a name="l00067"></a>00067 <span class="keywordtype">void</span> SFont_Write(SDL_Surface *Surface, <span class="keyword">const</span> <a class="code" href="structSFont__Font.html">SFont_Font</a> *Font, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y,
|
||||
<a name="l00068"></a>00068 <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
|
||||
<a name="l00069"></a>00069
|
||||
<a name="l00070"></a>00070 <span class="comment">// Returns the width of "text" in pixels</span>
|
||||
<a name="l00071"></a>00071 <span class="keywordtype">int</span> SFont_TextWidth(<span class="keyword">const</span> <a class="code" href="structSFont__Font.html">SFont_Font</a>* Font, <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
|
||||
<a name="l00072"></a>00072 <span class="comment">// Returns the height of "text" in pixels (which is always equal to Font->Surface->h)</span>
|
||||
<a name="l00073"></a>00073 <span class="keywordtype">int</span> SFont_TextHeight(<span class="keyword">const</span> <a class="code" href="structSFont__Font.html">SFont_Font</a>* Font);
|
||||
<a name="l00074"></a>00074
|
||||
<a name="l00075"></a>00075 <span class="comment">// Blits a string to Surface with centered x position</span>
|
||||
<a name="l00076"></a>00076 <span class="keywordtype">void</span> SFont_WriteCenter(SDL_Surface *Surface, <span class="keyword">const</span> <a class="code" href="structSFont__Font.html">SFont_Font</a>* Font, <span class="keywordtype">int</span> y,
|
||||
<a name="l00077"></a>00077 <span class="keyword">const</span> <span class="keywordtype">char</span> *text);
|
||||
<a name="l00078"></a>00078
|
||||
<a name="l00079"></a>00079 <span class="preprocessor">#ifdef __cplusplus</span>
|
||||
<a name="l00080"></a>00080 <span class="preprocessor"></span>}
|
||||
<a name="l00081"></a>00081 <span class="preprocessor">#endif</span>
|
||||
<a name="l00082"></a>00082 <span class="preprocessor"></span>
|
||||
<a name="l00083"></a>00083 <span class="preprocessor">#endif </span><span class="comment">/* SFONT_H */</span>
|
||||
</pre></div></div>
|
||||
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:29:55 2009 for GrafX2 by
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user