ponytracker/documentation/latex/samples_8h.tex

169 lines
8.3 KiB
TeX
Raw Normal View History

\hypertarget{samples_8h}{\section{Référence du fichier sources/samples/samples.h}
\label{samples_8h}\index{sources/samples/samples.\-h@{sources/samples/samples.\-h}}
}
{\ttfamily \#include $<$stdlib.\-h$>$}\\*
{\ttfamily \#include $<$stdio.\-h$>$}\\*
2014-05-20 13:17:26 +02:00
{\ttfamily \#include $<$string.\-h$>$}\\*
{\ttfamily \#include \char`\"{}../fmod/include/fmod.\-h\char`\"{}}\\*
Graphe des dépendances par inclusion de samples.\-h\-:
Ce graphe montre quels fichiers incluent directement ou indirectement ce fichier \-:
\subsection*{Structures de données}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{struct__sample}{\-\_\-sample}
2014-05-20 13:17:26 +02:00
\item
struct \hyperlink{struct__poubelle}{\-\_\-poubelle}
\end{DoxyCompactItemize}
\subsection*{Définitions de type}
\begin{DoxyCompactItemize}
\item
2014-05-20 13:17:26 +02:00
typedef struct \hyperlink{struct__sample}{\-\_\-sample} \hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample}
\item
2014-05-20 13:17:26 +02:00
typedef struct \hyperlink{struct__poubelle}{\-\_\-poubelle} \hyperlink{samples_8h_af75b81f3c071fe183fbffe115d43a22a}{Poubelle}
\end{DoxyCompactItemize}
\subsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
2014-05-20 13:17:26 +02:00
int \hyperlink{samples_8h_a4133b353534c6767dc6e58ba19410d83}{doit\-Etre\-Sauvegarde} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$tab\mbox{[}$\,$\mbox{]}, int i)
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{samples_8h_a3829e0358f85979b2d9e1ccc53ee0311}{set\-Sauvegarde} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$tab\mbox{[}$\,$\mbox{]}, int i)
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{samples_8h_a7ff33b007a5c904aaf993d747879cdfa}{ajouter\-Sample} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$tab\mbox{[}$\,$\mbox{]}, int i, char $\ast$chemin)
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{samples_8h_a3508dbac9b8370605a1e1d6b6d0b00a5}{supprimer\-Sample} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$tab\mbox{[}$\,$\mbox{]}, int i, \hyperlink{samples_8h_af75b81f3c071fe183fbffe115d43a22a}{Poubelle} $\ast$$\ast$poub)
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{samples_8h_a3e652dc39891e23a37e4bcad22e1977d}{set\-Nom} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$sample, char nom\mbox{[}$\,$\mbox{]})
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{samples_8h_a1f9efeffb63bd507521749a80f7a63ae}{set\-Hauteur} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$sample, \hyperlink{fmod_8h_aeb841aa4b4b5f444b5d739d865b420af}{float} hauteur)
\item
2014-05-20 13:17:26 +02:00
char $\ast$ \hyperlink{samples_8h_a8c9ea6b79c132397eae4fed664a351ce}{get\-Nom} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$sample)
\item
2014-05-20 13:17:26 +02:00
\hyperlink{fmod_8h_aeb841aa4b4b5f444b5d739d865b420af}{float} \hyperlink{samples_8h_abcdecc1e86108d125d248b640491d705}{get\-Hauteur} (\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$sample)
\end{DoxyCompactItemize}
\subsection{Description détaillée}
Gestion des samples
\begin{DoxyVersion}{Version}
1
\end{DoxyVersion}
\begin{DoxyAuthor}{Auteur}
Guy
\end{DoxyAuthor}
\begin{DoxyDate}{Date}
Mai 2014
\end{DoxyDate}
2014-05-20 13:17:26 +02:00
Définition dans le fichier \hyperlink{samples_8h_source}{samples.\-h}.
\subsection{Documentation des définitions de type}
\hypertarget{samples_8h_af75b81f3c071fe183fbffe115d43a22a}{\index{samples.\-h@{samples.\-h}!Poubelle@{Poubelle}}
\index{Poubelle@{Poubelle}!samples.h@{samples.\-h}}
\subsubsection[{Poubelle}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf \-\_\-poubelle} {\bf Poubelle}}}\label{samples_8h_af75b81f3c071fe183fbffe115d43a22a}
Il s'agit de définir une liste des samples à supprimer lors de la prochaine sauvegarde. \hypertarget{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{\index{samples.\-h@{samples.\-h}!Sample@{Sample}}
\index{Sample@{Sample}!samples.h@{samples.\-h}}
\subsubsection[{Sample}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf \-\_\-sample} {\bf Sample}}}\label{samples_8h_ad0ca612b35eebe718a131db33f4fa089}
\subsection{Documentation des fonctions}
\hypertarget{samples_8h_a7ff33b007a5c904aaf993d747879cdfa}{\index{samples.\-h@{samples.\-h}!ajouter\-Sample@{ajouter\-Sample}}
\index{ajouter\-Sample@{ajouter\-Sample}!samples.h@{samples.\-h}}
\subsubsection[{ajouter\-Sample}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} ajouter\-Sample (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i, }
\item[{char $\ast$}]{chemin}
\end{DoxyParamCaption}
)}}\label{samples_8h_a7ff33b007a5c904aaf993d747879cdfa}
Définition à la ligne 21 du fichier samples.\-c.
\hypertarget{samples_8h_a4133b353534c6767dc6e58ba19410d83}{\index{samples.\-h@{samples.\-h}!doit\-Etre\-Sauvegarde@{doit\-Etre\-Sauvegarde}}
\index{doit\-Etre\-Sauvegarde@{doit\-Etre\-Sauvegarde}!samples.h@{samples.\-h}}
\subsubsection[{doit\-Etre\-Sauvegarde}]{\setlength{\rightskip}{0pt plus 5cm}int doit\-Etre\-Sauvegarde (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i}
\end{DoxyParamCaption}
)}}\label{samples_8h_a4133b353534c6767dc6e58ba19410d83}
Cette fonction à valeur booléenne détermine si le fichier doit être copié dans le dossier de sauvegarde.
Définition à la ligne 13 du fichier samples.\-c.
\hypertarget{samples_8h_abcdecc1e86108d125d248b640491d705}{\index{samples.\-h@{samples.\-h}!get\-Hauteur@{get\-Hauteur}}
\index{get\-Hauteur@{get\-Hauteur}!samples.h@{samples.\-h}}
\subsubsection[{get\-Hauteur}]{\setlength{\rightskip}{0pt plus 5cm}{\bf float} get\-Hauteur (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{sample}
\end{DoxyParamCaption}
)}}\label{samples_8h_abcdecc1e86108d125d248b640491d705}
Définition à la ligne 48 du fichier samples.\-c.
\hypertarget{samples_8h_a8c9ea6b79c132397eae4fed664a351ce}{\index{samples.\-h@{samples.\-h}!get\-Nom@{get\-Nom}}
\index{get\-Nom@{get\-Nom}!samples.h@{samples.\-h}}
\subsubsection[{get\-Nom}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ get\-Nom (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{sample}
\end{DoxyParamCaption}
)}}\label{samples_8h_a8c9ea6b79c132397eae4fed664a351ce}
Définition à la ligne 44 du fichier samples.\-c.
\hypertarget{samples_8h_a1f9efeffb63bd507521749a80f7a63ae}{\index{samples.\-h@{samples.\-h}!set\-Hauteur@{set\-Hauteur}}
\index{set\-Hauteur@{set\-Hauteur}!samples.h@{samples.\-h}}
\subsubsection[{set\-Hauteur}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Hauteur (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{sample, }
\item[{{\bf float}}]{hauteur}
\end{DoxyParamCaption}
)}}\label{samples_8h_a1f9efeffb63bd507521749a80f7a63ae}
Définition à la ligne 40 du fichier samples.\-c.
\hypertarget{samples_8h_a3e652dc39891e23a37e4bcad22e1977d}{\index{samples.\-h@{samples.\-h}!set\-Nom@{set\-Nom}}
\index{set\-Nom@{set\-Nom}!samples.h@{samples.\-h}}
\subsubsection[{set\-Nom}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Nom (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{sample, }
\item[{char}]{nom\mbox{[}$\,$\mbox{]}}
\end{DoxyParamCaption}
)}}\label{samples_8h_a3e652dc39891e23a37e4bcad22e1977d}
Définition à la ligne 36 du fichier samples.\-c.
\hypertarget{samples_8h_a3829e0358f85979b2d9e1ccc53ee0311}{\index{samples.\-h@{samples.\-h}!set\-Sauvegarde@{set\-Sauvegarde}}
\index{set\-Sauvegarde@{set\-Sauvegarde}!samples.h@{samples.\-h}}
\subsubsection[{set\-Sauvegarde}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Sauvegarde (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i}
\end{DoxyParamCaption}
)}}\label{samples_8h_a3829e0358f85979b2d9e1ccc53ee0311}
Cette procédure définit le statut du fichier comme déjà copié dans la sauvegarde.
Définition à la ligne 17 du fichier samples.\-c.
\hypertarget{samples_8h_a3508dbac9b8370605a1e1d6b6d0b00a5}{\index{samples.\-h@{samples.\-h}!supprimer\-Sample@{supprimer\-Sample}}
\index{supprimer\-Sample@{supprimer\-Sample}!samples.h@{samples.\-h}}
\subsubsection[{supprimer\-Sample}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} supprimer\-Sample (
\begin{DoxyParamCaption}
\item[{{\bf Sample} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i, }
\item[{{\bf Poubelle} $\ast$$\ast$}]{poub}
\end{DoxyParamCaption}
)}}\label{samples_8h_a3508dbac9b8370605a1e1d6b6d0b00a5}
Définition à la ligne 26 du fichier samples.\-c.