cscg22-gearboy

CSCG 2022 Challenge 'Gearboy'
git clone https://git.sinitax.com/sinitax/cscg22-gearboy
Log | Files | Refs | sfeed.txt

_s_d_l__visualtest__variators_8h.tex (6242B)


      1\hypertarget{_s_d_l__visualtest__variators_8h}{\section{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-variators.h File Reference}
      2\label{_s_d_l__visualtest__variators_8h}\index{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-variators.\-h@{C\-:/\-Users/\-D\-E\-L\-L/\-Work/sdlvisualtest/visualtest/include/\-S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}}
      3}
      4{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-exhaustive\-\_\-variator.\-h\char`\"{}}\\*
      5{\ttfamily \#include \char`\"{}S\-D\-L\-\_\-visualtest\-\_\-random\-\_\-variator.\-h\char`\"{}}\\*
      6\subsection*{Data Structures}
      7\begin{DoxyCompactItemize}
      8\item 
      9struct \hyperlink{struct_s_d_l_visual_test___variator}{S\-D\-L\-Visual\-Test\-\_\-\-Variator}
     10\end{DoxyCompactItemize}
     11\subsection*{Typedefs}
     12\begin{DoxyCompactItemize}
     13\item 
     14typedef struct \\*
     15\hyperlink{struct_s_d_l_visual_test___variator}{S\-D\-L\-Visual\-Test\-\_\-\-Variator} \hyperlink{_s_d_l__visualtest__variators_8h_a520a2479efbe9c4a9d617735f7314e0a}{S\-D\-L\-Visual\-Test\-\_\-\-Variator}
     16\end{DoxyCompactItemize}
     17\subsection*{Functions}
     18\begin{DoxyCompactItemize}
     19\item 
     20int \hyperlink{_s_d_l__visualtest__variators_8h_ac1d82ee387a19743e47a82c87d3fb7f4}{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator} (\hyperlink{struct_s_d_l_visual_test___variator}{S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$variator, \hyperlink{struct_s_d_l_visual_test___s_u_t_config}{S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$config, \hyperlink{_s_d_l__visualtest__variator__common_8h_a04bfc880abe6940d69a63c06a33acdbd}{S\-D\-L\-Visual\-Test\-\_\-\-Variator\-Type} type, Uint64 seed)
     21\item 
     22char $\ast$ \hyperlink{_s_d_l__visualtest__variators_8h_aebdd4c3c545b0063d16929fd56f1a79f}{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation} (\hyperlink{struct_s_d_l_visual_test___variator}{S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$variator)
     23\item 
     24void \hyperlink{_s_d_l__visualtest__variators_8h_a98727ef649135c3312056d7603cb70b5}{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator} (\hyperlink{struct_s_d_l_visual_test___variator}{S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$variator)
     25\end{DoxyCompactItemize}
     26
     27
     28\subsection{Detailed Description}
     29Header for all the variators that vary input parameters to a S\-U\-T application. 
     30
     31\subsection{Typedef Documentation}
     32\hypertarget{_s_d_l__visualtest__variators_8h_a520a2479efbe9c4a9d617735f7314e0a}{\index{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Variator}}
     33\index{S\-D\-L\-Visual\-Test\-\_\-\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Variator}!SDL_visualtest_variators.h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}}
     34\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator}  {\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator}}}\label{_s_d_l__visualtest__variators_8h_a520a2479efbe9c4a9d617735f7314e0a}
     35Struct that acts like a wrapper around the different types of variators available. 
     36
     37\subsection{Function Documentation}
     38\hypertarget{_s_d_l__visualtest__variators_8h_a98727ef649135c3312056d7603cb70b5}{\index{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator}}
     39\index{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator}!SDL_visualtest_variators.h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}}
     40\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}void S\-D\-L\-Visual\-Test\-\_\-\-Free\-Variator (
     41\begin{DoxyParamCaption}
     42\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$}]{variator}
     43\end{DoxyParamCaption}
     44)}}\label{_s_d_l__visualtest__variators_8h_a98727ef649135c3312056d7603cb70b5}
     45Frees any resources associated with the variator. \hypertarget{_s_d_l__visualtest__variators_8h_aebdd4c3c545b0063d16929fd56f1a79f}{\index{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation@{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation}}
     46\index{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation@{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation}!SDL_visualtest_variators.h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}}
     47\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation}]{\setlength{\rightskip}{0pt plus 5cm}char$\ast$ S\-D\-L\-Visual\-Test\-\_\-\-Get\-Next\-Variation (
     48\begin{DoxyParamCaption}
     49\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$}]{variator}
     50\end{DoxyParamCaption}
     51)}}\label{_s_d_l__visualtest__variators_8h_aebdd4c3c545b0063d16929fd56f1a79f}
     52Gets the next variation using the variator.
     53
     54\begin{DoxyReturn}{Returns}
     55The arguments string representing the variation on success, and N\-U\-L\-L on failure. The pointer returned should not be freed. 
     56\end{DoxyReturn}
     57\hypertarget{_s_d_l__visualtest__variators_8h_ac1d82ee387a19743e47a82c87d3fb7f4}{\index{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}!S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator}}
     58\index{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator@{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator}!SDL_visualtest_variators.h@{S\-D\-L\-\_\-visualtest\-\_\-variators.\-h}}
     59\subsubsection[{S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator}]{\setlength{\rightskip}{0pt plus 5cm}int S\-D\-L\-Visual\-Test\-\_\-\-Init\-Variator (
     60\begin{DoxyParamCaption}
     61\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator} $\ast$}]{variator, }
     62\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-S\-U\-T\-Config} $\ast$}]{config, }
     63\item[{{\bf S\-D\-L\-Visual\-Test\-\_\-\-Variator\-Type}}]{type, }
     64\item[{Uint64}]{seed}
     65\end{DoxyParamCaption}
     66)}}\label{_s_d_l__visualtest__variators_8h_ac1d82ee387a19743e47a82c87d3fb7f4}
     67Initializes the variator object pointed to by {\ttfamily variator} of type {\ttfamily type} with information from the config object pointed to by {\ttfamily config}.
     68
     69\begin{DoxyReturn}{Returns}
     701 on success, 0 on failure 
     71\end{DoxyReturn}