the doc need more work

master
tth 3 years ago
parent 7db2ed28f3
commit a0c06f0ec4
  1. 38
      doc/the_floatimg_hack.tex

@ -1,4 +1,4 @@
\documentclass[a4paper,10pt]{article}
\documentclass[a4paper,11pt]{article}
% \listfiles % pour le debug
@ -43,7 +43,7 @@ chaque pixel en virgule flottante sur 32bits, le type
% -------------------------------------------------------------------
\section{Example}
Pour commencer,
Pour commencer par quelques chose de simple,
nous allons créer une image RGB\index{RGB} complètement noire,
puis l'enregistrer dans un fichier \texttt{.fimg}\index{.fimg},
un format complètement inconnu, puisque je viens de l'inventer
@ -95,8 +95,12 @@ mean values:
max value 0.000000
\end{verbatim}
Vous trouverez dans le répertoire \texttt{tools/}\index{tools/}
d'autres exemples de mise en œuvre des fonctions disponibles
sous formes d'outils en ligne de commande, décrits page \pageref{outils}.
% -------------------------------------------------------------------
\section{Mise en œuvre}
\section{Installation}
Pour le moment, la procédure d'installation est un peu rude,
pour ne pas dire clairement sommaire.
@ -110,7 +114,33 @@ approprié, par exemple
\texttt{/usr/local/include} et \texttt{/usr/local/lib}.
% -------------------------------------------------------------------
\section{Les outils}
\section{Utilisation}
Classiquement, il y a un fichier à inclure, \texttt{floatimg.h},
contenant un certain nombre de
définition de structures, de macros,
de constantes\footnote{À l'ancienne, via le pré-processur}
et les prototypes des fonctions utilisables.
Au niveau du code source, ces fonctions sont approximativement
classées en deux catégories : \texttt{lib/} et \texttt{funcs/}.
La première contient les choses qui sont relativement figées,
et la seconde celles qui risquent de bouger. Cette classification
est en fait arbitraire.
\subsection{lib/}\index{lib/}
\begin{verbatim}
int fimg_create(FloatImg *fimg, int w, int h, int t);
int fimg_destroy(FloatImg *fimg);
\end{verbatim}
\subsection{funcs/}\index{funcs/}
% -------------------------------------------------------------------
\section{Les outils}\label{outils}
\textsl{3615mavie} : sur des projets comme celui-ci, qui travaillent
in-fine sur des objets que l'on peut considérer comme « physiques »,

Loading…
Cancel
Save