m/grafX2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: svn://pulkomandy.tk/GrafX2/trunk@665 416bcca6-2ee7-4201-b75f-2eb2f807beb1
This commit is contained in:
Adrien Destugues
2009-03-06 21:05:05 +00:00
parent b5a1fadbe0
commit 5f50f7bc22
310 changed files with 117783 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

330
doxydoc/html/SFont_8c.html Normal file
View File

@@ -0,0 +1,330 @@
<!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.c File Reference</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 -->
<script type="text/javascript">
<!--
function changeDisplayState (e){
var num=this.id.replace(/[^[0-9]/g,'');
var button=this.firstChild;
var sectionDiv=document.getElementById('dynsection'+num);
if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
sectionDiv.style.display='block';
button.src='open.gif';
}else{
sectionDiv.style.display='none';
button.src='closed.gif';
}
}
function initDynSections(){
var divs=document.getElementsByTagName('div');
var sectionCounter=1;
for(var i=0;i<divs.length-1;i++){
if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
var header=divs[i];
var section=divs[i+1];
var button=header.firstChild;
if (button!='IMG'){
divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
button=document.createElement('img');
divs[i].insertBefore(button,divs[i].firstChild);
}
header.style.cursor='pointer';
header.onclick=changeDisplayState;
header.id='dynheader'+sectionCounter;
button.src='closed.gif';
section.id='dynsection'+sectionCounter;
section.style.display='none';
section.style.marginLeft='14px';
sectionCounter++;
}
}
}
window.onload = initDynSections;
-->
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>SFont.c File Reference</h1><code>#include &lt;SDL.h&gt;</code><br>
<code>#include &lt;SDL_video.h&gt;</code><br>
<code>#include &lt;assert.h&gt;</code><br>
<code>#include &lt;stdlib.h&gt;</code><br>
<code>#include &quot;<a class="el" href="SFont_8h.html">SFont.h</a>&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static Uint32&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#15bb2738193a3dd9dc83a06d8d2f3b68">GetPixel</a> (SDL_Surface *Surface, Sint32 X, Sint32 Y)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#fca0afa0e3fb01038193c3a72eb98001">SFont_InitFont</a> (SDL_Surface *Surface)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#d761bb03b392911bb15473e0a229d662">SFont_FreeFont</a> (<a class="el" href="structSFont__Font.html">SFont_Font</a> *FontInfo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#cf51fc8004b7c33bb87cd5c32e031bd4">SFont_Write</a> (SDL_Surface *Surface, const <a class="el" href="structSFont__Font.html">SFont_Font</a> *Font, int x, int y, const char *text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#50411934422feeb8ca28a8d69b66bf85">SFont_TextWidth</a> (const <a class="el" href="structSFont__Font.html">SFont_Font</a> *Font, const char *text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#8294a63e456328d491ab01e5ae905884">SFont_TextHeight</a> (const <a class="el" href="structSFont__Font.html">SFont_Font</a> *Font)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="SFont_8c.html#7c51512a71d5ee897571ec958bec7785">SFont_WriteCenter</a> (SDL_Surface *Surface, const <a class="el" href="structSFont__Font.html">SFont_Font</a> *Font, int y, const char *text)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="15bb2738193a3dd9dc83a06d8d2f3b68"></a><!-- doxytag: member="SFont.c::GetPixel" ref="15bb2738193a3dd9dc83a06d8d2f3b68" args="(SDL_Surface *Surface, Sint32 X, Sint32 Y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static Uint32 GetPixel </td>
<td>(</td>
<td class="paramtype">SDL_Surface *&nbsp;</td>
<td class="paramname"> <em>Surface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Sint32&nbsp;</td>
<td class="paramname"> <em>X</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Sint32&nbsp;</td>
<td class="paramname"> <em>Y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Referenced by <a class="el" href="SFont_8h.html#b4812905e8d1c7cf98257d55c74b1a34">SFont_InitFont()</a>.</p>
</div>
</div><p>
<a class="anchor" name="fca0afa0e3fb01038193c3a72eb98001"></a><!-- doxytag: member="SFont.c::SFont_InitFont" ref="fca0afa0e3fb01038193c3a72eb98001" args="(SDL_Surface *Surface)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSFont__Font.html">SFont_Font</a>* SFont_InitFont </td>
<td>(</td>
<td class="paramtype">SDL_Surface *&nbsp;</td>
<td class="paramname"> <em>Surface</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="structSFont__Font.html#d05fea05d81d966a6c348ad402d33838">SFont_Font::CharPos</a>, <a class="el" href="SFont_8c.html#15bb2738193a3dd9dc83a06d8d2f3b68">GetPixel()</a>, <a class="el" href="structSFont__Font.html#5790b0f45b79591f92f31cbe9e8b80f2">SFont_Font::MaxPos</a>, and <a class="el" href="structSFont__Font.html#bc8097ea87278ce195a7fcebf7664187">SFont_Font::Surface</a>.</p>
<p>Referenced by <a class="el" href="gfxcfg_8c.html#5c274fba0a05c8c8ec7a73ba47e85e4c">main()</a>, and <a class="el" href="texte_8c.html#e1763c92860bcecd15a88a8a7f2010d4">Rendu_Texte_SFont()</a>.</p>
</div>
</div><p>
<a class="anchor" name="d761bb03b392911bb15473e0a229d662"></a><!-- doxytag: member="SFont.c::SFont_FreeFont" ref="d761bb03b392911bb15473e0a229d662" args="(SFont_Font *FontInfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SFont_FreeFont </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td>
<td class="paramname"> <em>FontInfo</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="structSFont__Font.html#bc8097ea87278ce195a7fcebf7664187">SFont_Font::Surface</a>.</p>
<p>Referenced by <a class="el" href="gfxcfg_8c.html#5c274fba0a05c8c8ec7a73ba47e85e4c">main()</a>, and <a class="el" href="texte_8c.html#e1763c92860bcecd15a88a8a7f2010d4">Rendu_Texte_SFont()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cf51fc8004b7c33bb87cd5c32e031bd4"></a><!-- doxytag: member="SFont.c::SFont_Write" ref="cf51fc8004b7c33bb87cd5c32e031bd4" args="(SDL_Surface *Surface, const SFont_Font *Font, int x, int y, const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SFont_Write </td>
<td>(</td>
<td class="paramtype">SDL_Surface *&nbsp;</td>
<td class="paramname"> <em>Surface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td>
<td class="paramname"> <em>Font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>text</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="structSFont__Font.html#d05fea05d81d966a6c348ad402d33838">SFont_Font::CharPos</a>, <a class="el" href="structSFont__Font.html#5790b0f45b79591f92f31cbe9e8b80f2">SFont_Font::MaxPos</a>, and <a class="el" href="structSFont__Font.html#bc8097ea87278ce195a7fcebf7664187">SFont_Font::Surface</a>.</p>
<p>Referenced by <a class="el" href="gfxcfg_8c.html#f0b1e31c62d65ce0a0137cb3ebd7a206">Dessiner_ecran_principal()</a>, <a class="el" href="gfxcfg_8c.html#b386c1bd4845868dcd5b4eaddabedb3f">Ecrire()</a>, <a class="el" href="gfxcfg_8c.html#624bc3d37a1f4921750e3e7dcfec9b5f">Ecrire_commentaire()</a>, <a class="el" href="gfxcfg_8c.html#40ebb43d85a6da6a1db217a660039b76">Fenetre_choix()</a>, <a class="el" href="texte_8c.html#e1763c92860bcecd15a88a8a7f2010d4">Rendu_Texte_SFont()</a>, <a class="el" href="gfxcfg_8c.html#ae6b677d47187a8187e734714222240b">Select()</a>, and <a class="el" href="SFont_8h.html#7c51512a71d5ee897571ec958bec7785">SFont_WriteCenter()</a>.</p>
</div>
</div><p>
<a class="anchor" name="50411934422feeb8ca28a8d69b66bf85"></a><!-- doxytag: member="SFont.c::SFont_TextWidth" ref="50411934422feeb8ca28a8d69b66bf85" args="(const SFont_Font *Font, const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SFont_TextWidth </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td>
<td class="paramname"> <em>Font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>text</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="structSFont__Font.html#d05fea05d81d966a6c348ad402d33838">SFont_Font::CharPos</a>, and <a class="el" href="structSFont__Font.html#5790b0f45b79591f92f31cbe9e8b80f2">SFont_Font::MaxPos</a>.</p>
<p>Referenced by <a class="el" href="texte_8c.html#e1763c92860bcecd15a88a8a7f2010d4">Rendu_Texte_SFont()</a>, and <a class="el" href="SFont_8h.html#7c51512a71d5ee897571ec958bec7785">SFont_WriteCenter()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8294a63e456328d491ab01e5ae905884"></a><!-- doxytag: member="SFont.c::SFont_TextHeight" ref="8294a63e456328d491ab01e5ae905884" args="(const SFont_Font *Font)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SFont_TextHeight </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td>
<td class="paramname"> <em>Font</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="structSFont__Font.html#bc8097ea87278ce195a7fcebf7664187">SFont_Font::Surface</a>.</p>
<p>Referenced by <a class="el" href="texte_8c.html#e1763c92860bcecd15a88a8a7f2010d4">Rendu_Texte_SFont()</a>.</p>
</div>
</div><p>
<a class="anchor" name="7c51512a71d5ee897571ec958bec7785"></a><!-- doxytag: member="SFont.c::SFont_WriteCenter" ref="7c51512a71d5ee897571ec958bec7785" args="(SDL_Surface *Surface, const SFont_Font *Font, int y, const char *text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SFont_WriteCenter </td>
<td>(</td>
<td class="paramtype">SDL_Surface *&nbsp;</td>
<td class="paramname"> <em>Surface</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structSFont__Font.html">SFont_Font</a> *&nbsp;</td>
<td class="paramname"> <em>Font</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>text</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>References <a class="el" href="SFont_8c.html#50411934422feeb8ca28a8d69b66bf85">SFont_TextWidth()</a>, and <a class="el" href="SFont_8c.html#cf51fc8004b7c33bb87cd5c32e031bd4">SFont_Write()</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:43:57 2009 for GrafX2 by&nbsp;
<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>