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
2009-03-06 21:05:05 +00:00
parent b5a1fadbe0
commit 5f50f7bc22
310 changed files with 117783 additions and 2 deletions

View File

@@ -0,0 +1,143 @@
<!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: divers.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&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>
</ul>
</div>
<h1>divers.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Grafx2 - The Ultimate 256-color bitmap paint program</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Copyright 2007 Adrien Destugues</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright 1996-2001 Sunset Design (Guillaume Dorme &amp; Karl Maritaud)</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> Grafx2 is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> modify it under the terms of the GNU General Public License</span>
<a name="l00008"></a>00008 <span class="comment"> as published by the Free Software Foundation; version 2</span>
<a name="l00009"></a>00009 <span class="comment"> of the License.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment"> Grafx2 is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> along with Grafx2; if not, see &lt;http://www.gnu.org/licenses/&gt; or</span>
<a name="l00018"></a>00018 <span class="comment"> write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> 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="keywordtype">void</span> Effacer_ecran_courant(<span class="keywordtype">void</span>);
<a name="l00022"></a>00022 <span class="keywordtype">void</span> Copier_ecran_sur_brouillon(<span class="keywordtype">void</span>);
<a name="l00023"></a>00023 <span class="keywordtype">void</span> Copier_image_dans_brosse(<span class="keywordtype">short</span> Debut_X,<span class="keywordtype">short</span> Debut_Y,<span class="keywordtype">short</span> Brosse_Largeur,<span class="keywordtype">short</span> Brosse_Hauteur,word Largeur_image);
<a name="l00024"></a>00024 <span class="keywordtype">void</span> Permuter_dans_l_image_les_couleurs(byte Couleur_1,byte Couleur_2);
<a name="l00025"></a>00025 <span class="keywordtype">void</span> Remap_general_LOWLEVEL(byte * Table_conv,byte * Buffer,<span class="keywordtype">short</span> Largeur,<span class="keywordtype">short</span> Hauteur,<span class="keywordtype">short</span> Largeur_buffer);
<a name="l00026"></a>00026 <span class="keywordtype">void</span> Scroll_picture(<span class="keywordtype">short</span> Decalage_X,<span class="keywordtype">short</span> Decalage_Y);
<a name="l00027"></a>00027 <span class="keywordtype">void</span> Set_mouse_video_mode_number(<span class="keywordtype">void</span>);
<a name="l00028"></a>00028 <span class="keywordtype">void</span> Set_mouse_position(<span class="keywordtype">void</span>);
<a name="l00029"></a>00029 <span class="keywordtype">void</span> Attendre_fin_de_click(<span class="keywordtype">void</span>);
<a name="l00030"></a>00030 <span class="keywordtype">void</span> Sensibilite_souris(word X,word Y);
<a name="l00031"></a>00031 <span class="keywordtype">void</span> Set_color(byte Couleur, byte Rouge, byte Vert, byte Bleu);
<a name="l00032"></a>00032 <span class="keywordtype">void</span> Set_palette(T_Palette Palette);
<a name="l00033"></a>00033 <span class="keywordtype">void</span> Palette_256_to_64(T_Palette Palette);
<a name="l00034"></a>00034 <span class="keywordtype">void</span> Palette_64_to_256(T_Palette Palette);
<a name="l00035"></a>00035 <span class="keywordtype">void</span> Effacer_image_courante(byte Couleur);
<a name="l00036"></a>00036 <span class="keywordtype">void</span> Effacer_image_courante_Stencil(byte Couleur, byte * Pochoir);
<a name="l00037"></a>00037 <span class="keywordtype">void</span> Wait_VBL(<span class="keywordtype">void</span>);
<a name="l00038"></a>00038 <span class="keywordtype">void</span> Tempo_jauge(byte Vitesse);
<a name="l00039"></a>00039 dword Round_div(dword Numerateur,dword Diviseur);
<a name="l00040"></a>00040 word Palette_Compter_nb_couleurs_utilisees(dword * Tableau);
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keywordtype">void</span> Pixel_dans_ecran_courant (word X,word Y,byte Couleur);
<a name="l00043"></a>00043 <span class="keywordtype">void</span> Pixel_dans_brosse (word X,word Y,byte Couleur);
<a name="l00044"></a>00044 byte Lit_pixel_dans_ecran_courant (word X,word Y);
<a name="l00045"></a>00045 byte Lit_pixel_dans_ecran_brouillon(word X,word Y);
<a name="l00046"></a>00046 byte Lit_pixel_dans_ecran_backup (word X,word Y);
<a name="l00047"></a>00047 byte Lit_pixel_dans_ecran_feedback (word X,word Y);
<a name="l00048"></a>00048 byte Lit_pixel_dans_brosse (word X,word Y);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">void</span> Ellipse_Calculer_limites(<span class="keywordtype">short</span> Rayon_horizontal,<span class="keywordtype">short</span> Rayon_vertical);
<a name="l00051"></a>00051 <span class="comment">// Calcule les valeurs suivantes en fonction des deux paramètres:</span>
<a name="l00052"></a>00052 <span class="comment">//</span>
<a name="l00053"></a>00053 <span class="comment">// Ellipse_Rayon_vertical_au_carre</span>
<a name="l00054"></a>00054 <span class="comment">// Ellipse_Rayon_horizontal_au_carre</span>
<a name="l00055"></a>00055 <span class="comment">// Ellipse_Limite_High</span>
<a name="l00056"></a>00056 <span class="comment">// Ellipse_Limite_Low</span>
<a name="l00057"></a>00057
<a name="l00058"></a>00058
<a name="l00059"></a>00059 byte Pixel_dans_ellipse(<span class="keywordtype">void</span>);
<a name="l00060"></a>00060 <span class="comment">// Indique si le pixel se trouvant à Ellipse_Curseur_X pixels</span>
<a name="l00061"></a>00061 <span class="comment">// (Ellipse_Curseur_X&gt;0 = à droite, Ellipse_Curseur_X&lt;0 = à gauche) et à</span>
<a name="l00062"></a>00062 <span class="comment">// Ellipse_Curseur_Y pixels (Ellipse_Curseur_Y&gt;0 = en bas,</span>
<a name="l00063"></a>00063 <span class="comment">// Ellipse_Curseur_Y&lt;0 = en haut) du centre se trouve dans l'ellipse en</span>
<a name="l00064"></a>00064 <span class="comment">// cours.</span>
<a name="l00065"></a>00065
<a name="l00066"></a>00066 byte Pixel_dans_cercle(<span class="keywordtype">void</span>);
<a name="l00067"></a>00067 <span class="comment">// Indique si le pixel se trouvant à Cercle_Curseur_X pixels</span>
<a name="l00068"></a>00068 <span class="comment">// (Cercle_Curseur_X&gt;0 = à droite, Cercle_Curseur_X&lt;0 = à gauche) et à</span>
<a name="l00069"></a>00069 <span class="comment">// Cercle_Curseur_Y pixels (Cercle_Curseur_Y&gt;0 = en bas,</span>
<a name="l00070"></a>00070 <span class="comment">// Cercle_Curseur_Y&lt;0 = en haut) du centre se trouve dans le cercle en</span>
<a name="l00071"></a>00071 <span class="comment">// cours.</span>
<a name="l00072"></a>00072
<a name="l00073"></a>00073 byte Bit(byte Octet, byte Rang);
<a name="l00074"></a>00074 <span class="comment">// Extrait un bit d'un certain rang à partir d'un octet.</span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="comment">// Gestion du chrono dans les fileselects</span>
<a name="l00077"></a>00077 <span class="keywordtype">void</span> Initialiser_chrono(dword Delai);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> Tester_chrono(<span class="keywordtype">void</span>);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keywordtype">void</span> Remplacer_une_couleur(byte Ancienne_couleur, byte Nouvelle_couleur);
<a name="l00081"></a>00081 <span class="keywordtype">void</span> Remplacer_toutes_les_couleurs_dans_limites(byte * Table_de_remplacement);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 byte Effet_Colorize_interpole (word X,word Y,byte Couleur);
<a name="l00084"></a>00084 byte Effet_Colorize_additif (word X,word Y,byte Couleur);
<a name="l00085"></a>00085 byte Effet_Colorize_soustractif(word X,word Y,byte Couleur);
<a name="l00086"></a>00086 byte Effet_Trame(word X,word Y);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">void</span> Flip_Y_LOWLEVEL(<span class="keywordtype">void</span>);
<a name="l00089"></a>00089 <span class="keywordtype">void</span> Flip_X_LOWLEVEL(<span class="keywordtype">void</span>);
<a name="l00090"></a>00090 <span class="keywordtype">void</span> Rotate_90_deg_LOWLEVEL(byte * Source,byte * Destination);
<a name="l00091"></a>00091 <span class="keywordtype">void</span> Rotate_180_deg_LOWLEVEL(<span class="keywordtype">void</span>);
<a name="l00092"></a>00092 <span class="keywordtype">void</span> Zoomer_une_ligne(byte * Ligne_originale,byte * Ligne_zoomee,word Facteur,word Largeur);
<a name="l00093"></a>00093 <span class="keywordtype">void</span> Copier_une_partie_d_image_dans_une_autre(byte * Source,word S_Pos_X,word S_Pos_Y,word Largeur,word Hauteur,word Largeur_source,byte * Destination,word D_Pos_X,word D_Pos_Y,word Largeur_destination);
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">// -- Gestion du chrono --</span>
<a name="l00096"></a>00096 byte Etat_chrono; <span class="comment">// Etat du chrono: 0=Attente d'un Xème de seconde</span>
<a name="l00097"></a>00097 <span class="comment">// 1=Il faut afficher la preview</span>
<a name="l00098"></a>00098 <span class="comment">// 2=Plus de chrono à gerer pour l'instant</span>
<a name="l00099"></a>00099 dword Chrono_delay; <span class="comment">// Nombre de 18.2ème de secondes demandés</span>
<a name="l00100"></a>00100 dword Chrono_cmp; <span class="comment">// Heure de départ du chrono</span>
<a name="l00101"></a>00101 byte Nouvelle_preview; <span class="comment">// Booléen "Il faut relancer le chrono de preview"</span>
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> Memoire_libre(<span class="keywordtype">void</span>);
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="keywordtype">void</span> Num2str(dword Nombre,<span class="keywordtype">char</span> * Chaine,byte Taille);
<a name="l00107"></a>00107 <span class="keywordtype">int</span> Str2num(<span class="keywordtype">char</span> * Chaine);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="keywordtype">short</span> Round(<span class="keywordtype">float</span> Valeur);
<a name="l00110"></a>00110 <span class="keywordtype">short</span> Round_max(<span class="keywordtype">short</span> Numerateur,<span class="keywordtype">short</span> Diviseur);
<a name="l00111"></a>00111 <span class="keywordtype">short</span> Round_div_max(<span class="keywordtype">short</span> Numerateur,<span class="keywordtype">short</span> Diviseur);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">int</span> Min(<span class="keywordtype">int</span> A,<span class="keywordtype">int</span> B);
<a name="l00114"></a>00114 <span class="keywordtype">int</span> Max(<span class="keywordtype">int</span> A,<span class="keywordtype">int</span> B);
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keywordtype">char</span>* Libelle_mode(<span class="keywordtype">int</span> Mode);
<a name="l00117"></a>00117 <span class="keywordtype">int</span> Conversion_argument_mode(<span class="keyword">const</span> <span class="keywordtype">char</span> *Argument);
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Mar 6 16:29:54 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>