ponytracker/documentation/latex/instruments_8h.tex

210 lines
12 KiB
TeX
Raw Permalink Normal View History

2014-05-20 13:17:26 +02:00
\hypertarget{instruments_8h}{\section{Référence du fichier sources/instruments/instruments.h}
\label{instruments_8h}\index{sources/instruments/instruments.\-h@{sources/instruments/instruments.\-h}}
}
{\ttfamily \#include $<$stdio.\-h$>$}\\*
{\ttfamily \#include $<$stdlib.\-h$>$}\\*
{\ttfamily \#include $<$string.\-h$>$}\\*
{\ttfamily \#include $<$math.\-h$>$}\\*
{\ttfamily \#include \char`\"{}../samples/samples.\-h\char`\"{}}\\*
Graphe des dépendances par inclusion de instruments.\-h\-:
Ce graphe montre quels fichiers incluent directement ou indirectement ce fichier \-:
\subsection*{Structures de données}
\begin{DoxyCompactItemize}
\item
struct \hyperlink{struct__enveloppe}{\-\_\-enveloppe}
\item
struct \hyperlink{struct__intrument}{\-\_\-intrument}
\end{DoxyCompactItemize}
\subsection*{Définitions de type}
\begin{DoxyCompactItemize}
\item
typedef struct \hyperlink{struct__enveloppe}{\-\_\-enveloppe} \hyperlink{instruments_8h_a936213c201d6c5cf8f5b9f47336efbb0}{Enveloppe}
\item
typedef struct \hyperlink{struct__intrument}{\-\_\-intrument} \hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument}
\end{DoxyCompactItemize}
\subsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_a5bf07257c1018526706f17f5dd2e453d}{ajouter\-Instrument} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$tab\mbox{[}$\,$\mbox{]}, int i)
\item
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_a1b4d0adf7a9012b51b6cf75146ce8e87}{supprimer\-Instrument} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$tab\mbox{[}$\,$\mbox{]}, int i)
\item
2014-05-22 00:12:25 +02:00
char $\ast$ \hyperlink{instruments_8h_ab41cad77f4a94310dc211a28dfb21043}{get\-Chemin} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst})
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
int \hyperlink{instruments_8h_a16666d90b8a5f1814bf5508b081a5850}{get\-Volume\-Inst} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst})
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
int \hyperlink{instruments_8h_a0a3961ade7c43ac98e1fa6e1f6d8dc26}{get\-Balance\-Inst} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst})
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
char $\ast$ \hyperlink{instruments_8h_aa4f31c49f61e26b4b93aef01d63e5ec7}{get\-Nom\-Inst} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst})
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
\hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$ \hyperlink{instruments_8h_a65858268b21c66c9aa10adb6bf00dfa9}{get\-Sample} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst})
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_abd1a070026808669fdf4b452da81d0f6}{set\-Volume} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst}, int volume)
2014-05-20 13:17:26 +02:00
\item
2014-05-22 00:12:25 +02:00
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_ae1988f980b621165d938c5ac6b541d25}{set\-Balance} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst}, int balance)
\item
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_a1f6ed72cbc1a2aa4dae0863269e728e2}{set\-Nom\-Inst} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst}, char $\ast$nom)
\item
\hyperlink{fmod_8h_a5e6281045c500b317fa3b60838542994}{void} \hyperlink{instruments_8h_ae2da904100b4105b21814f7d40e370bb}{set\-Sample} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst}, \hyperlink{samples_8h_ad0ca612b35eebe718a131db33f4fa089}{Sample} $\ast$\hyperlink{main_8c_a1b2c31d071735c5a50db9f93c1ad53d1}{smpl})
\item
\hyperlink{fmod_8h_aeb841aa4b4b5f444b5d739d865b420af}{float} \hyperlink{instruments_8h_a23b2d1a486a42541c8d094bacbf4c1b8}{rapport\-Pitch} (\hyperlink{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{Instrument} $\ast$\hyperlink{main_8c_a51daa158cc3ad050d5aed7b500f18886}{inst}, int note, int octave)
2014-05-20 13:17:26 +02:00
\end{DoxyCompactItemize}
\subsection{Description détaillée}
Gestion des instruments
\begin{DoxyVersion}{Version}
1
\end{DoxyVersion}
\begin{DoxyAuthor}{Auteur}
Guy
\end{DoxyAuthor}
\begin{DoxyDate}{Date}
Mai 2014
\end{DoxyDate}
Définition dans le fichier \hyperlink{instruments_8h_source}{instruments.\-h}.
\subsection{Documentation des définitions de type}
\hypertarget{instruments_8h_a936213c201d6c5cf8f5b9f47336efbb0}{\index{instruments.\-h@{instruments.\-h}!Enveloppe@{Enveloppe}}
\index{Enveloppe@{Enveloppe}!instruments.h@{instruments.\-h}}
\subsubsection[{Enveloppe}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf \-\_\-enveloppe} {\bf Enveloppe}}}\label{instruments_8h_a936213c201d6c5cf8f5b9f47336efbb0}
\hypertarget{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}{\index{instruments.\-h@{instruments.\-h}!Instrument@{Instrument}}
\index{Instrument@{Instrument}!instruments.h@{instruments.\-h}}
\subsubsection[{Instrument}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf \-\_\-intrument} {\bf Instrument}}}\label{instruments_8h_a3ea24ed3c5f97006fe85fb5e0d168ebf}
\subsection{Documentation des fonctions}
\hypertarget{instruments_8h_a5bf07257c1018526706f17f5dd2e453d}{\index{instruments.\-h@{instruments.\-h}!ajouter\-Instrument@{ajouter\-Instrument}}
\index{ajouter\-Instrument@{ajouter\-Instrument}!instruments.h@{instruments.\-h}}
\subsubsection[{ajouter\-Instrument}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} ajouter\-Instrument (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i}
\end{DoxyParamCaption}
)}}\label{instruments_8h_a5bf07257c1018526706f17f5dd2e453d}
Définition à la ligne 13 du fichier instruments.\-c.
2014-05-22 00:12:25 +02:00
\hypertarget{instruments_8h_a0a3961ade7c43ac98e1fa6e1f6d8dc26}{\index{instruments.\-h@{instruments.\-h}!get\-Balance\-Inst@{get\-Balance\-Inst}}
\index{get\-Balance\-Inst@{get\-Balance\-Inst}!instruments.h@{instruments.\-h}}
\subsubsection[{get\-Balance\-Inst}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Balance\-Inst (
2014-05-20 13:17:26 +02:00
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst}
\end{DoxyParamCaption}
2014-05-22 00:12:25 +02:00
)}}\label{instruments_8h_a0a3961ade7c43ac98e1fa6e1f6d8dc26}
\hypertarget{instruments_8h_ab41cad77f4a94310dc211a28dfb21043}{\index{instruments.\-h@{instruments.\-h}!get\-Chemin@{get\-Chemin}}
\index{get\-Chemin@{get\-Chemin}!instruments.h@{instruments.\-h}}
\subsubsection[{get\-Chemin}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ get\-Chemin (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst}
\end{DoxyParamCaption}
)}}\label{instruments_8h_ab41cad77f4a94310dc211a28dfb21043}
2014-05-20 13:17:26 +02:00
2014-05-22 00:12:25 +02:00
Définition à la ligne 22 du fichier instruments.\-c.
2014-05-20 13:17:26 +02:00
\hypertarget{instruments_8h_aa4f31c49f61e26b4b93aef01d63e5ec7}{\index{instruments.\-h@{instruments.\-h}!get\-Nom\-Inst@{get\-Nom\-Inst}}
\index{get\-Nom\-Inst@{get\-Nom\-Inst}!instruments.h@{instruments.\-h}}
\subsubsection[{get\-Nom\-Inst}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ get\-Nom\-Inst (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst}
\end{DoxyParamCaption}
)}}\label{instruments_8h_aa4f31c49f61e26b4b93aef01d63e5ec7}
2014-05-22 00:12:25 +02:00
Définition à la ligne 34 du fichier instruments.\-c.
2014-05-20 13:17:26 +02:00
2014-05-22 00:12:25 +02:00
\hypertarget{instruments_8h_a65858268b21c66c9aa10adb6bf00dfa9}{\index{instruments.\-h@{instruments.\-h}!get\-Sample@{get\-Sample}}
\index{get\-Sample@{get\-Sample}!instruments.h@{instruments.\-h}}
\subsubsection[{get\-Sample}]{\setlength{\rightskip}{0pt plus 5cm}{\bf Sample}$\ast$ get\-Sample (
2014-05-20 13:17:26 +02:00
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst}
\end{DoxyParamCaption}
2014-05-22 00:12:25 +02:00
)}}\label{instruments_8h_a65858268b21c66c9aa10adb6bf00dfa9}
2014-05-20 13:17:26 +02:00
2014-05-22 00:12:25 +02:00
Définition à la ligne 38 du fichier instruments.\-c.
\hypertarget{instruments_8h_a16666d90b8a5f1814bf5508b081a5850}{\index{instruments.\-h@{instruments.\-h}!get\-Volume\-Inst@{get\-Volume\-Inst}}
\index{get\-Volume\-Inst@{get\-Volume\-Inst}!instruments.h@{instruments.\-h}}
\subsubsection[{get\-Volume\-Inst}]{\setlength{\rightskip}{0pt plus 5cm}int get\-Volume\-Inst (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst}
\end{DoxyParamCaption}
)}}\label{instruments_8h_a16666d90b8a5f1814bf5508b081a5850}
Définition à la ligne 26 du fichier instruments.\-c.
2014-05-20 13:17:26 +02:00
\hypertarget{instruments_8h_a23b2d1a486a42541c8d094bacbf4c1b8}{\index{instruments.\-h@{instruments.\-h}!rapport\-Pitch@{rapport\-Pitch}}
\index{rapport\-Pitch@{rapport\-Pitch}!instruments.h@{instruments.\-h}}
\subsubsection[{rapport\-Pitch}]{\setlength{\rightskip}{0pt plus 5cm}{\bf float} rapport\-Pitch (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst, }
\item[{int}]{note, }
\item[{int}]{octave}
\end{DoxyParamCaption}
)}}\label{instruments_8h_a23b2d1a486a42541c8d094bacbf4c1b8}
2014-05-22 00:12:25 +02:00
Définition à la ligne 58 du fichier instruments.\-c.
2014-05-20 13:17:26 +02:00
\hypertarget{instruments_8h_ae1988f980b621165d938c5ac6b541d25}{\index{instruments.\-h@{instruments.\-h}!set\-Balance@{set\-Balance}}
\index{set\-Balance@{set\-Balance}!instruments.h@{instruments.\-h}}
\subsubsection[{set\-Balance}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Balance (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst, }
\item[{int}]{balance}
\end{DoxyParamCaption}
)}}\label{instruments_8h_ae1988f980b621165d938c5ac6b541d25}
\hypertarget{instruments_8h_a1f6ed72cbc1a2aa4dae0863269e728e2}{\index{instruments.\-h@{instruments.\-h}!set\-Nom\-Inst@{set\-Nom\-Inst}}
\index{set\-Nom\-Inst@{set\-Nom\-Inst}!instruments.h@{instruments.\-h}}
\subsubsection[{set\-Nom\-Inst}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Nom\-Inst (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst, }
\item[{char $\ast$}]{nom}
\end{DoxyParamCaption}
)}}\label{instruments_8h_a1f6ed72cbc1a2aa4dae0863269e728e2}
2014-05-22 00:12:25 +02:00
Définition à la ligne 50 du fichier instruments.\-c.
\hypertarget{instruments_8h_ae2da904100b4105b21814f7d40e370bb}{\index{instruments.\-h@{instruments.\-h}!set\-Sample@{set\-Sample}}
\index{set\-Sample@{set\-Sample}!instruments.h@{instruments.\-h}}
\subsubsection[{set\-Sample}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Sample (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst, }
\item[{{\bf Sample} $\ast$}]{smpl}
\end{DoxyParamCaption}
)}}\label{instruments_8h_ae2da904100b4105b21814f7d40e370bb}
Définition à la ligne 54 du fichier instruments.\-c.
2014-05-20 13:17:26 +02:00
\hypertarget{instruments_8h_abd1a070026808669fdf4b452da81d0f6}{\index{instruments.\-h@{instruments.\-h}!set\-Volume@{set\-Volume}}
\index{set\-Volume@{set\-Volume}!instruments.h@{instruments.\-h}}
\subsubsection[{set\-Volume}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} set\-Volume (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{inst, }
\item[{int}]{volume}
\end{DoxyParamCaption}
)}}\label{instruments_8h_abd1a070026808669fdf4b452da81d0f6}
\hypertarget{instruments_8h_a1b4d0adf7a9012b51b6cf75146ce8e87}{\index{instruments.\-h@{instruments.\-h}!supprimer\-Instrument@{supprimer\-Instrument}}
\index{supprimer\-Instrument@{supprimer\-Instrument}!instruments.h@{instruments.\-h}}
\subsubsection[{supprimer\-Instrument}]{\setlength{\rightskip}{0pt plus 5cm}{\bf void} supprimer\-Instrument (
\begin{DoxyParamCaption}
\item[{{\bf Instrument} $\ast$}]{tab\mbox{[}$\,$\mbox{]}, }
\item[{int}]{i}
\end{DoxyParamCaption}
)}}\label{instruments_8h_a1b4d0adf7a9012b51b6cf75146ce8e87}
Définition à la ligne 18 du fichier instruments.\-c.