dukantic/Sokoban
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix doxy comment

Browse Source
This commit is contained in:
Dukantic
2025-01-05 18:29:43 +01:00
parent 4cd165867e
commit e7480472a3
82 changed files with 1310 additions and 470 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
rapport/latex/display_8c.tex.tmp Normal file
View File

@@ -0,0 +1,177 @@
\doxysection{Référence du fichier display.\+c}
\label{display_8c}\index{display.c@{display.c}}
{\ttfamily \#include "{}../include/display.\+h"{}}\newline
{\ttfamily \#include "{}../include/function.\+h"{}}\newline
{\ttfamily \#include $<$SDL2/\+SDL.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+image.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+mutex.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+rect.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+render.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+surface.\+h$>$}\newline
{\ttfamily \#include $<$SDL2/\+SDL\+\_\+ttf.\+h$>$}\newline
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
Graphe des dépendances par inclusion de display.\+c\+:\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{display_8c__incl}
\end{center}
\end{figure}
\doxysubsubsection*{Fonctions}
\begin{DoxyCompactItemize}
\item
void \textbf{ screen\+Display} (char $\ast$$\ast$tab, int x, int y)
\begin{DoxyCompactList}\small\item\em La fonction permet d\textquotesingle{}afficher simplement le plateau de jeu dans le terminal. \end{DoxyCompactList}\item
void \textbf{ screen\+Display\+Game\+SDL} (char $\ast$$\ast$tab, \textbf{ vect} dim\+\_\+tab, \textbf{ dis} $\ast$display\+\_\+user, \textbf{ vect} $\ast$player\+\_\+pos, int fov)
\begin{DoxyCompactList}\small\item\em La fonction affiche a l\textquotesingle{}aide de SDL la zone de jeu. \end{DoxyCompactList}\item
int \textbf{ get\+Max\+Size} (\textbf{ dis} display\+\_\+user)
\begin{DoxyCompactList}\small\item\em Taille de l\textquotesingle{}ecrant carre en fonction de l\textquotesingle{}ecrant du joueur avec une marge. \end{DoxyCompactList}\item
void \textbf{ init\+SDL} (\textbf{ dis} $\ast$display\+\_\+user)
\begin{DoxyCompactList}\small\item\em Initialise SDL. \end{DoxyCompactList}\item
void \textbf{ display\+Image} (SDL\+\_\+\+Renderer $\ast$renderer, SDL\+\_\+\+Texture $\ast$texture, \textbf{ vect} pos, int size)
\begin{DoxyCompactList}\small\item\em Cette fonction affiche l\textquotesingle{}image dans la fenetre de l\textquotesingle{}utilisateur. \end{DoxyCompactList}\item
void \textbf{ display\+Text\+SDL} (\textbf{ dis} $\ast$display\+\_\+user, char $\ast$text, \textbf{ vect} coor, \textbf{ vect} size, int font\+\_\+size)
\begin{DoxyCompactList}\small\item\em Cette fonction affiche du texte dans la fenetre de l\textquotesingle{}utilisateur. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Description détaillée}
Fichier contient tout les fonctions pour l\textquotesingle{}affichage.
\doxysubsection{Documentation des fonctions}
\index{display.c@{display.c}!displayImage@{displayImage}}
\index{displayImage@{displayImage}!display.c@{display.c}}
\doxysubsubsection{displayImage()}
{\footnotesize\ttfamily \label{display_8c_a81a2b2da875550c614a407ec735ff9d9}
void display\+Image (\begin{DoxyParamCaption}\item[{SDL\+\_\+\+Renderer $\ast$}]{renderer}{, }\item[{SDL\+\_\+\+Texture $\ast$}]{texture}{, }\item[{\textbf{ vect}}]{pos}{, }\item[{int}]{size}{}\end{DoxyParamCaption})}
Cette fonction affiche l\textquotesingle{}image dans la fenetre de l\textquotesingle{}utilisateur.
\begin{DoxyParams}{Paramètres}
{\em renderer} & Le renderer de l\textquotesingle{}utilisateur. \\
\hline
{\em texture} & La texture de l\textquotesingle{}image à appliquer. \\
\hline
{\em pos} & La position de l\textquotesingle{}image à afficher. \\
\hline
{\em size} & La taile de l\textquotesingle{}image. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
Voici le graphe des appelants de cette fonction \+:
% FIG 0
\index{display.c@{display.c}!displayTextSDL@{displayTextSDL}}
\index{displayTextSDL@{displayTextSDL}!display.c@{display.c}}
\doxysubsubsection{displayTextSDL()}
{\footnotesize\ttfamily \label{display_8c_af8c0265ee608800f8daba2540c65c5b0}
void display\+Text\+SDL (\begin{DoxyParamCaption}\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{, }\item[{char $\ast$}]{text}{, }\item[{\textbf{ vect}}]{coor}{, }\item[{\textbf{ vect}}]{size}{, }\item[{int}]{font\+\_\+size}{}\end{DoxyParamCaption})}
Cette fonction affiche du texte dans la fenetre de l\textquotesingle{}utilisateur.
\begin{DoxyParams}{Paramètres}
{\em display\+\_\+user} & Tous les éléments SDL de l\textquotesingle{}utilisateur. \\
\hline
{\em text} & Le string à afficher. \\
\hline
{\em coor} & Les coordonnée du texte. \\
\hline
{\em size} & La taille du texte. \\
\hline
{\em font\+\_\+size} & La taille de la font. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
\index{display.c@{display.c}!getMaxSize@{getMaxSize}}
\index{getMaxSize@{getMaxSize}!display.c@{display.c}}
\doxysubsubsection{getMaxSize()}
{\footnotesize\ttfamily \label{display_8c_ab9c0348d4cff3f20344d763945c96b40}
int get\+Max\+Size (\begin{DoxyParamCaption}\item[{\textbf{ dis}}]{display\+\_\+user}{}\end{DoxyParamCaption})}
Taille de l\textquotesingle{}ecrant carre en fonction de l\textquotesingle{}ecrant du joueur avec une marge.
\begin{DoxyParams}{Paramètres}
{\em display\+\_\+user} & Qui serra modifier pour stoquer les information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
La taille max pour la fenetre de l\textquotesingle{}utilisateur.
\end{DoxyReturn}
\index{display.c@{display.c}!initSDL@{initSDL}}
\index{initSDL@{initSDL}!display.c@{display.c}}
\doxysubsubsection{initSDL()}
{\footnotesize\ttfamily \label{display_8c_a46638b64faa8239921eab8c3817847f4}
void init\+SDL (\begin{DoxyParamCaption}\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{}\end{DoxyParamCaption})}
Initialise SDL.
\begin{DoxyParams}{Paramètres}
{\em display\+\_\+user} & Stockage d\textquotesingle{}éléments SDL. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
\index{display.c@{display.c}!screenDisplay@{screenDisplay}}
\index{screenDisplay@{screenDisplay}!display.c@{display.c}}
\doxysubsubsection{screenDisplay()}
{\footnotesize\ttfamily \label{display_8c_affba8627c7c6c768268f64fa670207e5}
void screen\+Display (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab}{, }\item[{int}]{x}{, }\item[{int}]{y}{}\end{DoxyParamCaption})}
La fonction permet d\textquotesingle{}afficher simplement le plateau de jeu dans le terminal.
\begin{DoxyParams}{Paramètres}
{\em tab} & Le tableau 2d du plateau. \\
\hline
{\em x} & Le mombre de ligne. \\
\hline
{\em y} & Le nombre de colonnes. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
\index{display.c@{display.c}!screenDisplayGameSDL@{screenDisplayGameSDL}}
\index{screenDisplayGameSDL@{screenDisplayGameSDL}!display.c@{display.c}}
\doxysubsubsection{screenDisplayGameSDL()}
{\footnotesize\ttfamily \label{display_8c_a9ed2db696b902038cc72feee1d0c30f3}
void screen\+Display\+Game\+SDL (\begin{DoxyParamCaption}\item[{char $\ast$$\ast$}]{tab}{, }\item[{\textbf{ vect}}]{dim\+\_\+tab}{, }\item[{\textbf{ dis} $\ast$}]{display\+\_\+user}{, }\item[{\textbf{ vect} $\ast$}]{player\+\_\+pos}{, }\item[{int}]{fov}{}\end{DoxyParamCaption})}
La fonction affiche a l\textquotesingle{}aide de SDL la zone de jeu.
\begin{DoxyParams}{Paramètres}
{\em tab} & Le tableau 2d de la zone de jeu. \\
\hline
{\em display\+\_\+user} & La structure qui possede tous ce qu\textquotesingle{}il faut pour l\textquotesingle{}affichage SDL \\
\hline
{\em player\+\_\+pos} & la position du joueur \\
\hline
{\em fov} & Le fov de la vision du joueur, -\/1 si desactiver. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Renvoie}
Void
\end{DoxyReturn}
Voici le graphe d\textquotesingle{}appel pour cette fonction \+:
% FIG 1