gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity

doxygen compatible (cleaned) but severe modif in graphics doc (init, draw, grid)

This commit is contained in:
Jean Sirmai 2024-10-22 23:58:04 +02:00
parent fd6efb1e25
commit 12e06f3aa4
Signed by: jean
GPG Key ID: FB3115C340E057E3
53 changed files with 469 additions and 1437 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/docbook/annotated.xml
View File

@ -4,9 +4,9 @@
Here are the classes, structs, unions and interfaces with brief descriptions:<link linkend="_structarrow__t">arrow_t</link>
<para>Defines an arrow address </para>
<link linkend="_structdblist">dblist</link>
<para>Phantom documentation used to test the functioning of doxygen </para>
<para>Required to init the empty list </para>
<link linkend="_structelem">elem</link>
<para>Phantom documentation used to test the functioning of doxygen </para>
<para>Simplest element of a double-chained list </para>
<link linkend="_structfsm__struct__journal">fsm_struct_journal</link>
<para>Required to initialise a double-chained list </para>
<link linkend="_structfsm__struct__journal__unit">fsm_struct_journal_unit</link>
@ -20,9 +20,9 @@ Here are the classes, structs, unions and interfaces with brief descriptions:<li
<link linkend="_structgraphics__stack__t">graphics_stack_t</link>
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas </para>
<link linkend="_structpile">pile</link>
<para>Phantom documentation used to test the functioning of doxygen </para>
<para>Phantom documentation </para>
<link linkend="_structpreferences">preferences</link><link linkend="_structslist">slist</link>
<para>Phantom documentation used to test the functioning of doxygen </para>
<para>Phantom documentation </para>
<link linkend="_structStack">Stack</link>
<para>Phantom documentation </para>
<link linkend="_structstack__index__t">stack_index_t</link>

4
doc/docbook/d0/d0b/structelem.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>elem</primary></indexterm>
<para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>simplest element of a double-chained list </para>
</para>
<para>
@ -30,7 +30,7 @@
<section>
<title>Detailed Description</title>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>simplest element of a double-chained list </para>
<para>
The documentation for this struct was generated from the following file:</para>
include/<link linkend="_util_8h">util.h</link></section>

4
doc/docbook/d1/d04/structdblist.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>dblist</primary></indexterm>
<para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>required to init the empty list </para>
</para>
<para>
@ -26,7 +26,7 @@
<section>
<title>Detailed Description</title>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>required to init the empty list </para>
<para>
The documentation for this struct was generated from the following file:</para>
include/<link linkend="_util_8h">util.h</link></section>

6
doc/docbook/d1/d0c/util_2tree_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/tree.c</primary></indexterm>
<para>
<para>Gem-graph-client. </para>
<para>tree functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/fsm.h&quot;<?linebreak?>#include &quot;../../include/signal.h&quot;<?linebreak?>#include &quot;../../include/widget.h&quot;<?linebreak?></programlisting><simplesect>
@ -30,9 +30,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client. </para>
<para>Widget tree functions.</para>
<para>tree functions </para>
<para>This file is part of Gem-graph. </para>
</section>

78
doc/docbook/d2/d02/grid_8c.xml
View File

@ -10,21 +10,19 @@
<programlisting linenumbering="unnumbered">#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>int <link linkend="_grid_8c_1a89243f218fde8d99432870537d4855f7">graphics_draw_space_ridges_vertex</link> (const int stack_id, long offset_vertex, long x, long y, long z)</para>
<listitem><para>int <link linkend="_grid_8c_1a79778df22a59f6bdfb2ef1be40999988">graphics_draw_space_ridges_vertex</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>int <link linkend="_grid_8c_1ab2c36ba517ca17807179c1c0f872184b">graphics_draw_space_ridges_lines</link> (const int stack_id)</para>
<listitem><para><anchor xml:id="_grid_8c_1ae06bc782cdd144a15166e1a3087ca07c"/>int <emphasis role="strong">graphics_draw_space_ridges_lines</emphasis> (const int graphics_stack_id)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>long <link linkend="_grid_8c_1a736b2ae78fa856d5ea56a5db11b22007">graphics_draw_grids_on_space_faces_vertex</link> (const int stack_id, long x, long y, long z)</para>
<listitem><para>long <link linkend="_grid_8c_1aa0e0b868182a402d520d3443909bd40b">graphics_draw_grids_on_space_faces_vertex</link> (const int graphics_stack_id, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>Writes grid lines on space faces. </para>
</listitem>
<listitem><para>long <link linkend="_grid_8c_1a4d1ecae814bc87b330e285d9afa2462f">graphics_draw_grids_on_space_faces_lines</link> (const int stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
<listitem><para>long <link linkend="_grid_8c_1a4b522c9dc5b1ba15444956adb1c08cf5">graphics_draw_grids_on_space_faces_lines</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
</listitem>
</itemizedlist>
</simplesect>
@ -37,15 +35,11 @@
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_grid_8c_1a4d1ecae814bc87b330e285d9afa2462f"/><section>
<anchor xml:id="_grid_8c_1a4b522c9dc5b1ba15444956adb1c08cf5"/><section>
<title>graphics_draw_grids_on_space_faces_lines()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_lines</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_grids_on_space_faces_lines</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para><computeroutput>long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para>
<para>
<formalpara>
<title>
@ -90,33 +84,59 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_grid_8c_1a736b2ae78fa856d5ea56a5db11b22007"/><section>
<anchor xml:id="_grid_8c_1aa0e0b868182a402d520d3443909bd40b"/><section>
<title>graphics_draw_grids_on_space_faces_vertex()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_vertex</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_grids_on_space_faces_vertex</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)</computeroutput></para><para>
<para>Writes grid lines on space faces. </para>
</section>
<anchor xml:id="_grid_8c_1ab2c36ba517ca17807179c1c0f872184b"/><section>
<title>graphics_draw_space_ridges_lines()</title>
<indexterm><primary>graphics_draw_space_ridges_lines</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_space_ridges_lines</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_lines (const int stack_id)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para>draw_space_ridges_lines </para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>x</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>y</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>z</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>l </para>
</formalpara>
</para>
</section>
<anchor xml:id="_grid_8c_1a89243f218fde8d99432870537d4855f7"/><section>
<anchor xml:id="_grid_8c_1a79778df22a59f6bdfb2ef1be40999988"/><section>
<title>graphics_draw_space_ridges_vertex()</title>
<indexterm><primary>graphics_draw_space_ridges_vertex</primary><secondary>grid.c</secondary></indexterm>
<indexterm><primary>grid.c</primary><secondary>graphics_draw_space_ridges_vertex</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>

4
doc/docbook/d5/d0f/tests_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/tests.c</primary></indexterm>
<para>
<para>Gem-graph-client. </para>
<para>use to check utilities </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/util.h&quot;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?>#include &quot;../../include/fsm.h&quot;<?linebreak?></programlisting><simplesect>
@ -31,7 +31,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client. </para>
<para>use to check utilities </para>
<para>This file is part of Gem-graph. It only groups various tests. </para>
</section>

48
doc/docbook/d6/d09/draw_8c.xml
View File

@ -10,23 +10,23 @@
<programlisting linenumbering="unnumbered">#include &lt;cglm/cglm.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?>#include &quot;../../include/graphics.h&quot;<?linebreak?></programlisting><simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para>void <link linkend="_draw_8c_1aa0df09cf556373a65c4e0d9c52ea646b">graphics_draw_vertex</link> (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</para>
<listitem><para>void <link linkend="_draw_8c_1aa2c4ec98f5bf9942092ff385e9fac72f">graphics_draw_vertex</link> (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)</para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a3956486509d8f170b54c8d6831bb85af">graphics_draw_color</link> (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</para>
<listitem><para>void <link linkend="_draw_8c_1a2be40f60f1a100f87730178ea20a5b6f">graphics_draw_color</link> (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)</para>
<para>Writes values to describe a color (r,g,b) into the color buffer. </para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a658c61849cb025f4482be722c62d66e4">graphics_draw_line</link> (const int stack_id, GLuint a, GLuint b)</para>
<listitem><para>void <link linkend="_draw_8c_1aad0766ae2eda7ded12984d0061f1da89">graphics_draw_line</link> (const int graphics_stack_id, GLuint a, GLuint b)</para>
<para>Writes values to describe a line from a to b into the line buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a90e33f30b6c203c51f38279e42f74606">graphics_draw_plan</link> (const int stack_id, GLuint a, GLuint b, GLuint c)</para>
<listitem><para>void <link linkend="_draw_8c_1afb83b572ba51cecca0db17db6d046546">graphics_draw_plan</link> (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)</para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</listitem>
<listitem><para>void <link linkend="_draw_8c_1a7077e01357e203c1997c806abaee658a">graphics_draw</link> (const int stack_id)</para>
<listitem><para>void <link linkend="_draw_8c_1a66c9c80dbf46ac2168827bf8a0dfb7ee">graphics_draw</link> (const int graphics_stack_id)</para>
<para>Draws the current buffer to a gl_area. </para>
</listitem>
@ -41,11 +41,11 @@
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_draw_8c_1a7077e01357e203c1997c806abaee658a"/><section>
<anchor xml:id="_draw_8c_1a66c9c80dbf46ac2168827bf8a0dfb7ee"/><section>
<title>graphics_draw()</title>
<indexterm><primary>graphics_draw</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw</secondary></indexterm>
<para><computeroutput>void graphics_draw (const int stack_id)</computeroutput></para><para>
<para><computeroutput>void graphics_draw (const int graphics_stack_id)</computeroutput></para><para>
<para>Draws the current buffer to a gl_area. </para>
</para>
@ -61,7 +61,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para>gl_area, ptr to the gl_area widget </para>
</entry>
</row>
@ -72,16 +72,14 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a3956486509d8f170b54c8d6831bb85af"/><section>
<anchor xml:id="_draw_8c_1a2be40f60f1a100f87730178ea20a5b6f"/><section>
<title>graphics_draw_color()</title>
<indexterm><primary>graphics_draw_color</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_color</secondary></indexterm>
<para><computeroutput>void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para>Writes values to describe a color (r,g,b) into the color buffer. </para>
</para>
<para><computeroutput>void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</para>
<para>
<formalpara>
@ -94,7 +92,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
@ -120,11 +118,11 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a658c61849cb025f4482be722c62d66e4"/><section>
<anchor xml:id="_draw_8c_1aad0766ae2eda7ded12984d0061f1da89"/><section>
<title>graphics_draw_line()</title>
<indexterm><primary>graphics_draw_line</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_line</secondary></indexterm>
<para><computeroutput>void graphics_draw_line (const int stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para>Writes values to describe a line from a to b into the line buffer. </para>
</para>
@ -140,7 +138,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
@ -161,11 +159,11 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1a90e33f30b6c203c51f38279e42f74606"/><section>
<anchor xml:id="_draw_8c_1afb83b572ba51cecca0db17db6d046546"/><section>
<title>graphics_draw_plan()</title>
<indexterm><primary>graphics_draw_plan</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_plan</secondary></indexterm>
<para><computeroutput>void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</para>
@ -181,7 +179,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
@ -207,17 +205,15 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_draw_8c_1aa0df09cf556373a65c4e0d9c52ea646b"/><section>
<anchor xml:id="_draw_8c_1aa2c4ec98f5bf9942092ff385e9fac72f"/><section>
<title>graphics_draw_vertex()</title>
<indexterm><primary>graphics_draw_vertex</primary><secondary>draw.c</secondary></indexterm>
<indexterm><primary>draw.c</primary><secondary>graphics_draw_vertex</secondary></indexterm>
<para><computeroutput>void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console.</para>
<para>
<formalpara>
<title>
@ -229,7 +225,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>

441
doc/docbook/d7/d04/graphics_8h.xml
View File

@ -40,14 +40,6 @@
<simplesect>
<title>Functions </title>
<itemizedlist>
<listitem><para><anchor xml:id="_graphics_8h_1ada591592a6e751eed5810aed710edeb2"/>bool <emphasis role="strong">graphics_render_stack</emphasis> (GtkWidget *container_widget)</para>
<para>Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1aa186797d420d2d8b445613407dc33146"/>bool <emphasis role="strong">graphics_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para>
<para>phantom documentation </para>
</listitem>
<listitem><para>int <link linkend="_graphics_8h_1a5a4ed7438a755777b162fc37e84ba93a">graphics_init</link> (void *error_buffer)</para>
<para>Initializes a gl_area. </para>
@ -56,25 +48,13 @@
<para>Draws the current buffer to a gl_area. </para>
</listitem>
<listitem><para>bool <link linkend="_graphics_8h_1ae99e9cf190970a730fdb3d8df8682188">graphics_shutdown</link> (const int graphics_stack_id, void *error_buffer)</para>
<listitem><para>bool <link linkend="_graphics_8h_1aa4d80f7ee104aa414e7ed4b90e0eac88">graphics_shutdown</link> (const int id, void *error_buffer)</para>
<para>Shutdowns a gl_area. </para>
</listitem>
<listitem><para>bool <link linkend="_graphics_8h_1ac5ba153022c8589d2cd83442197e163e">graphics_init_shaders</link> (const int graphics_stack_id)</para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1ad207a8ab8be624215cdb332438f88dce"/>bool <emphasis role="strong">graphics_init_graphics_stack</emphasis> (void *container_widget, GError *error_buffer)</para>
<para>phantom documentation </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1a8e90af55bafb9b4c934eb7f60d888e73"/>bool <emphasis role="strong">graphics_shutdown_graphics_stack</emphasis> (void *container_widget, GError *error_buffer)</para>
<para>phantom documentation </para>
</listitem>
<listitem><para><anchor xml:id="_graphics_8h_1aa149b6ac65d1cdf5880ce6e1da303472"/>bool <emphasis role="strong">graphics_update_axis_stack</emphasis> (GtkWidget *container_widget, int axis, int value)</para>
<para>phantom documentation </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aa86924f99e2a17fcb4e33b22b8987a95">graphics_init_buffers</link> (const int graphics_stack_id)</para>
@ -82,7 +62,7 @@
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aa2c4ec98f5bf9942092ff385e9fac72f">graphics_draw_vertex</link> (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)</para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</listitem>
<listitem><para>void <link linkend="_graphics_8h_1aad0766ae2eda7ded12984d0061f1da89">graphics_draw_line</link> (const int graphics_stack_id, GLuint a, GLuint b)</para>
@ -112,21 +92,15 @@
<para>Writes grid ridges to vertex and color buffers. </para>
</listitem>
<listitem><para>int <link linkend="_graphics_8h_1ae06bc782cdd144a15166e1a3087ca07c">graphics_draw_space_ridges_lines</link> (const int graphics_stack_id)</para>
<listitem><para><anchor xml:id="_graphics_8h_1ae06bc782cdd144a15166e1a3087ca07c"/>int <emphasis role="strong">graphics_draw_space_ridges_lines</emphasis> (const int graphics_stack_id)</para>
<para>draw_space_ridges_lines </para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>long <link linkend="_graphics_8h_1aa0e0b868182a402d520d3443909bd40b">graphics_draw_grids_on_space_faces_vertex</link> (const int graphics_stack_id, long x, long y, long z)</para>
<para>Writes grid lines on space faces. </para>
</listitem>
<listitem><para>long <link linkend="_graphics_8h_1a4b522c9dc5b1ba15444956adb1c08cf5">graphics_draw_grids_on_space_faces_lines</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
<para>phantom documentation used to test the functioning of doxygen </para>
</listitem>
<listitem><para>int <link linkend="_graphics_8h_1a6a8069bea50642d8e4d582194cf7c014">graphics_set_arrow</link> (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)</para>
<para>set_arrow </para>
</listitem>
</itemizedlist>
</simplesect>
@ -152,7 +126,7 @@
<title>graphics_draw()</title>
<indexterm><primary>graphics_draw</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw</secondary></indexterm>
<para><computeroutput>void graphics_draw (const int stack_id)</computeroutput></para><para>
<para><computeroutput>void graphics_draw (const int graphics_stack_id)</computeroutput></para><para>
<para>Draws the current buffer to a gl_area. </para>
</para>
@ -168,10 +142,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry></entry>
</row>
<row>
<entry>stack_id</entry><entry>
<entry>graphics_stack_id</entry><entry>
<para>gl_area, ptr to the gl_area widget </para>
</entry>
</row>
@ -186,7 +157,7 @@ Parameters</title>
<title>graphics_draw_color()</title>
<indexterm><primary>graphics_draw_color</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_color</secondary></indexterm>
<para><computeroutput>void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)</computeroutput></para><para>
<para>Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </para>
</para>
@ -214,41 +185,6 @@ Parameters</title>
<row>
<entry>g</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>b</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>r</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>g</entry><entry>
<para></para>
</entry>
</row>
<row>
@ -267,11 +203,7 @@ Parameters</title>
<title>graphics_draw_grids_on_space_faces_lines()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_lines</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_grids_on_space_faces_lines</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>phantom documentation used to test the functioning of doxygen </para>
</para>
<para><computeroutput>long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para>
<para>
<formalpara>
<title>
@ -320,7 +252,7 @@ Parameters</title>
<title>graphics_draw_grids_on_space_faces_vertex()</title>
<indexterm><primary>graphics_draw_grids_on_space_faces_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_grids_on_space_faces_vertex</secondary></indexterm>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)</computeroutput></para><para>
<para><computeroutput>long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)</computeroutput></para><para>
<para>Writes grid lines on space faces. </para>
</para>
@ -362,19 +294,17 @@ Parameters</title>
<para>l </para>
</formalpara>
Writes grid lines on space faces. </para>
</para>
</section>
<anchor xml:id="_graphics_8h_1aad0766ae2eda7ded12984d0061f1da89"/><section>
<title>graphics_draw_line()</title>
<indexterm><primary>graphics_draw_line</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_line</secondary></indexterm>
<para><computeroutput>void graphics_draw_line (const int stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)</computeroutput></para><para>
<para>Writes values to describe a line from a to b into the line buffer. </para>
</para>
<para>@use liste de fonctions GTK</para>
<para>
<formalpara>
<title>
@ -386,11 +316,6 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b)</para>
</entry>
</row>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
@ -398,19 +323,6 @@ Parameters</title>
<row>
<entry>a</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>b</entry><entry></entry>
</row>
<row>
<entry>stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>a</entry><entry>
<para></para>
</entry>
</row>
<row>
@ -540,7 +452,7 @@ Parameters</title>
<title>graphics_draw_plan()</title>
<indexterm><primary>graphics_draw_plan</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_plan</secondary></indexterm>
<para><computeroutput>void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)</computeroutput></para><para>
<para>Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</para>
@ -556,11 +468,6 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>coords</entry><entry>
<para>GLuint (a,b,c)</para>
</entry>
</row>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
@ -573,24 +480,6 @@ Parameters</title>
<row>
<entry>b</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>c</entry><entry></entry>
</row>
<row>
<entry>stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>a</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>b</entry><entry>
<para></para>
</entry>
</row>
<row>
@ -605,44 +494,11 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1ae06bc782cdd144a15166e1a3087ca07c"/><section>
<title>graphics_draw_space_ridges_lines()</title>
<indexterm><primary>graphics_draw_space_ridges_lines</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_space_ridges_lines</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_lines (const int stack_id)</computeroutput></para><para>
<para>draw_space_ridges_lines </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>i</para>
</formalpara>
draw_space_ridges_lines </para>
</section>
<anchor xml:id="_graphics_8h_1a79778df22a59f6bdfb2ef1be40999988"/><section>
<title>graphics_draw_space_ridges_vertex()</title>
<indexterm><primary>graphics_draw_space_ridges_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_space_ridges_vertex</secondary></indexterm>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para><computeroutput>int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</computeroutput></para><para>
<para>Writes grid ridges to vertex and color buffers. </para>
</para>
@ -695,9 +551,9 @@ Writes grid ridges to vertex and color buffers. </para>
<title>graphics_draw_vertex()</title>
<indexterm><primary>graphics_draw_vertex</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_draw_vertex</secondary></indexterm>
<para><computeroutput>void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para><computeroutput>void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)</computeroutput></para><para>
<para>Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
<para>Writes values to describe a vertex at (x,y,z) intoq the vertex buffer. </para>
</para>
<para>
@ -711,11 +567,6 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>GLfloat</entry><entry>
<para>x, GLfloat y, GLfloat z</para>
</entry>
</row>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
@ -728,41 +579,6 @@ Parameters</title>
<row>
<entry>y</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>z</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console.</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>x</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>y</entry><entry>
<para></para>
</entry>
</row>
<row>
@ -810,25 +626,9 @@ Parameters</title>
<para>true if initialized</para>
</formalpara>
param *error_buffer &lt; DO NOT DOCUMENT (it&apos;s &apos;void&apos;)</para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*error_buffer</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para><formalpara><title>Returns</title>
<para>true if initialized </para>
</formalpara>
@ -838,7 +638,7 @@ Parameters</title>
<title>graphics_init_buffers()</title>
<indexterm><primary>graphics_init_buffers</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_init_buffers</secondary></indexterm>
<para><computeroutput>void graphics_init_buffers (const int stack_id)</computeroutput></para><para>
<para><computeroutput>void graphics_init_buffers (const int graphics_stack_id)</computeroutput></para><para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</para>
@ -854,17 +654,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
<row>
<entry>graphics_stack_id</entry><entry>
<para>gl_area, ptr to the gl_area widget</para>
</entry>
</row>
<row>
<entry>stack_id</entry><entry></entry>
<entry>graphics_stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
@ -877,7 +667,7 @@ Parameters</title>
<title>graphics_init_shaders()</title>
<indexterm><primary>graphics_init_shaders</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_init_shaders</secondary></indexterm>
<para><computeroutput>bool graphics_init_shaders (const int stack_id)</computeroutput></para><para>
<para><computeroutput>bool graphics_init_shaders (const int graphics_stack_id)</computeroutput></para><para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</para>
@ -893,9 +683,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry>
<para>gl_area, ptr to the gl_area widget</para>
</entry>
<entry>graphics_stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
@ -904,55 +692,7 @@ Parameters</title>
</formalpara>
<formalpara><title>Returns</title>
<para>true if initialized</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if initialized</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
gl_area, ptr to the gl_area widget</para>
<para><formalpara><title>Returns</title>
<para>true if initialized </para>
<para>initialized </para>
</formalpara>
</para>
</section>
@ -987,85 +727,7 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1a6a8069bea50642d8e4d582194cf7c014"/><section>
<title>graphics_set_arrow()</title>
<indexterm><primary>graphics_set_arrow</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_set_arrow</secondary></indexterm>
<para><computeroutput>int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)</computeroutput></para><para>
<para>set_arrow </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>arrows_nb</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>space_X</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>space_Y</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>space_Z</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>requested_weight</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>site</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>x</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>y</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>z</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>i </para>
</formalpara>
</para>
</section>
<anchor xml:id="_graphics_8h_1ae99e9cf190970a730fdb3d8df8682188"/><section>
<anchor xml:id="_graphics_8h_1aa4d80f7ee104aa414e7ed4b90e0eac88"/><section>
<title>graphics_shutdown()</title>
<indexterm><primary>graphics_shutdown</primary><secondary>graphics.h</secondary></indexterm>
<indexterm><primary>graphics.h</primary><secondary>graphics_shutdown</secondary></indexterm>
@ -1075,57 +737,6 @@ Parameters</title>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>graphics_stack_id</entry><entry>
<para></para>
</entry>
</row>
<row>
<entry>*error_buffer</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if success</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>gl_area, ptr</entry><entry>
<para>to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>true if success</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
@ -1148,11 +759,9 @@ Parameters</title>
</table>
</para>
</formalpara>
gl_area, ptr to the gl_area widget</para>
<formalpara><title>Returns</title>
<para><formalpara><title>Returns</title>
<para>true if success </para>
<para>success </para>
</formalpara>
</para>
</section>

4
doc/docbook/d7/d09/list__2x2_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/list_2x2.c</primary></indexterm>
<para>
<para>Gem-graph-client util double_chained list. </para>
<para>double_chained list </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -47,7 +47,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client util double_chained list. </para>
<para>double_chained list </para>
<para>This file is part of Gem-graph. </para>
</section>

54
doc/docbook/d8/d00/init_8c.xml
View File

@ -27,15 +27,15 @@
<para>Shutdowns a gl_area. </para>
</listitem>
<listitem><para>void <link linkend="_init_8c_1a6b097df849779455e6f57d84a7037919">graphics_model_setup</link> (const int stack_id)</para>
<listitem><para>void <link linkend="_init_8c_1a76f5c593f1d55ebbc838437d9240ad8a">graphics_model_setup</link> (const int graphics_stack_id)</para>
<para>graphics_model_setup </para>
</listitem>
<listitem><para>void <link linkend="_init_8c_1a17560cb73e3b25c1e6fbeae088867d0f">graphics_init_buffers</link> (const int stack_id)</para>
<listitem><para>void <link linkend="_init_8c_1aa86924f99e2a17fcb4e33b22b8987a95">graphics_init_buffers</link> (const int graphics_stack_id)</para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</listitem>
<listitem><para>bool <link linkend="_init_8c_1a4ae8809ed73e91b6a20bcfdd94f4c23d">graphics_init_shaders</link> (const int stack_id)</para>
<listitem><para>bool <link linkend="_init_8c_1ac5ba153022c8589d2cd83442197e163e">graphics_init_shaders</link> (const int graphics_stack_id)</para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</listitem>
@ -80,35 +80,19 @@
<para>Initializes a gl_area. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*error_buffer</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>param *error_buffer &lt; DO NOT DOCUMENT (it&apos;s &apos;void&apos;)</para>
<para><formalpara><title>Returns</title>
<para>true if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_init_8c_1a17560cb73e3b25c1e6fbeae088867d0f"/><section>
<anchor xml:id="_init_8c_1aa86924f99e2a17fcb4e33b22b8987a95"/><section>
<title>graphics_init_buffers()</title>
<indexterm><primary>graphics_init_buffers</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_init_buffers</secondary></indexterm>
<para><computeroutput>void graphics_init_buffers (const int stack_id)</computeroutput></para><para>
<para><computeroutput>void graphics_init_buffers (const int graphics_stack_id)</computeroutput></para><para>
<para>Initializes the buffer of a gl_area Calls according to the user preferences. </para>
</para>
@ -124,7 +108,7 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry></entry>
<entry>graphics_stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
@ -133,11 +117,11 @@ Parameters</title>
</formalpara>
gl_area, ptr to the gl_area widget </para>
</section>
<anchor xml:id="_init_8c_1a4ae8809ed73e91b6a20bcfdd94f4c23d"/><section>
<anchor xml:id="_init_8c_1ac5ba153022c8589d2cd83442197e163e"/><section>
<title>graphics_init_shaders()</title>
<indexterm><primary>graphics_init_shaders</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_init_shaders</secondary></indexterm>
<para><computeroutput>bool graphics_init_shaders (const int stack_id)</computeroutput></para><para>
<para><computeroutput>bool graphics_init_shaders (const int graphics_stack_id)</computeroutput></para><para>
<para>Initializes the shaders of a gl_area and link them to a program. </para>
</para>
@ -153,22 +137,20 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>stack_id</entry><entry></entry>
<entry>graphics_stack_id</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
gl_area, ptr to the gl_area widget</para>
<formalpara><title>Returns</title>
<para><formalpara><title>Returns</title>
<para>true if initialized </para>
<para>initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id="_init_8c_1a6b097df849779455e6f57d84a7037919"/><section>
<anchor xml:id="_init_8c_1a76f5c593f1d55ebbc838437d9240ad8a"/><section>
<title>graphics_model_setup()</title>
<indexterm><primary>graphics_model_setup</primary><secondary>init.c</secondary></indexterm>
<indexterm><primary>init.c</primary><secondary>graphics_model_setup</secondary></indexterm>
@ -231,11 +213,9 @@ Parameters</title>
</table>
</para>
</formalpara>
gl_area, ptr to the gl_area widget</para>
<formalpara><title>Returns</title>
<para><formalpara><title>Returns</title>
<para>true if success </para>
<para>success </para>
</formalpara>
</para>
</section>

4
doc/docbook/d8/d01/strings__op_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/strings_op.c</primary></indexterm>
<para>
<para>Gem-graph-client. </para>
<para>concat </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;stdarg.h&gt;<?linebreak?>#include &lt;string.h&gt;<?linebreak?></programlisting><simplesect>
@ -19,7 +19,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client. </para>
<para>concat </para>
<para>This file is part of Gem-graph.</para>

175
doc/docbook/d8/d0c/util_8h.xml
View File

@ -12,19 +12,19 @@
<itemizedlist>
<listitem><para>struct <link linkend="_structpile">pile</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</listitem>
<listitem><para>struct <link linkend="_structelem">elem</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>simplest element of a double-chained list </para>
</listitem>
<listitem><para>struct <link linkend="_structdblist">dblist</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>required to init the empty list </para>
</listitem>
<listitem><para>struct <link linkend="_structslist">slist</link></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</listitem>
</itemizedlist>
</simplesect>
@ -33,15 +33,15 @@
<itemizedlist>
<listitem><para><anchor xml:id="_util_8h_1a8b1be516cd670e3808f29fa7576017db"/>typedef struct <link linkend="_structpile">pile</link> <emphasis role="strong">pile</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a03f28ef452dbb87c629a2b39da6fc63c"/>typedef struct <link linkend="_structelem">elem</link> <emphasis role="strong">elem</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>simplest element of a double-chained list </para>
</listitem>
<listitem><para><anchor xml:id="_util_8h_1a6f169a5dcb2ec0f7ab8120292cf14d9e"/>typedef struct <link linkend="_structslist">slist</link> <emphasis role="strong">slist</emphasis></para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</listitem>
</itemizedlist>
</simplesect>
@ -126,10 +126,6 @@
</listitem>
<listitem><para>long <link linkend="_util_8h_1adbe03a3d239b22390e9de809443c8df9">util_gl_get_stack</link> (void *container_widget)</para>
<para>Look for stack entry and returns stack_id. </para>
</listitem>
<listitem><para>long <link linkend="_util_8h_1a133e79c96135a44a4d4df48051aafbef">util_gl_is_util_ready</link> (void *container_widget)</para>
<para>Look for stack entry and returns stack_id. </para>
</listitem>
<listitem><para>bool <link linkend="_util_8h_1a28b44187c7ae713705874288323e10a6">util_gl_init_stack</link> (void *container_widget, GError *error_buffer)</para>
@ -203,28 +199,6 @@ Parameters</title>
<formalpara><title>Returns</title>
<para>GtkWidget* pointer to the new widget </para>
</formalpara>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>axis</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>GtkWidget * </para>
</formalpara>
</para>
</section>
@ -280,30 +254,6 @@ Parameters</title>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>stack_id</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
@ -337,30 +287,6 @@ Parameters</title>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool true if success</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
@ -387,41 +313,6 @@ Parameters</title>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1a133e79c96135a44a4d4df48051aafbef"/><section>
<title>util_gl_is_util_ready()</title>
<indexterm><primary>util_gl_is_util_ready</primary><secondary>util.h</secondary></indexterm>
<indexterm><primary>util.h</primary><secondary>util_gl_is_util_ready</secondary></indexterm>
<para><computeroutput>long util_gl_is_util_ready (void * container_widget)</computeroutput></para><para>
<para>Look for stack entry and returns stack_id. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>stack_id </para>
</formalpara>
</para>
</section>
<anchor xml:id="_util_8h_1a8132a1a797f4f12eaff04b4c3610f054"/><section>
<title>util_gl_render_stack()</title>
<indexterm><primary>util_gl_render_stack</primary><secondary>util.h</secondary></indexterm>
@ -432,30 +323,6 @@ Parameters</title>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>bool true if success</para>
</formalpara>
<formalpara>
<title>
Parameters</title>
@ -490,29 +357,9 @@ Parameters</title>
<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</para>
<para>
<formalpara>
<title>
Parameters</title>
<para>
<table frame="all">
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*"/>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>void</entry><entry></entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara><title>Returns</title>
<para>DO NOT DOCUMENT param void &lt; argument &apos;void&apos; of command @ param is not found</para>
<para>bool true if success</para>
</formalpara>
returns true if success ? TODO why not bool ? </para>
<para>DO NOT DOCUMENT returns bool true if success &lt; does not return anything </para>
</section>
<anchor xml:id="_util_8h_1a9d41985e1832e0a798e722d2341752f1"/><section>
<title>util_gl_shutdown_stack()</title>
@ -535,7 +382,7 @@ Parameters</title>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea </para>
<para></para>
</entry>
</row>
<row>
@ -548,7 +395,7 @@ Parameters</title>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
<para>success </para>
</formalpara>
</para>
</section>

4
doc/docbook/da/d03/structpile.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>pile</primary></indexterm>
<para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</para>
<para>
@ -26,7 +26,7 @@
<section>
<title>Detailed Description</title>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
<para>
The documentation for this struct was generated from the following file:</para>
include/<link linkend="_util_8h">util.h</link></section>

18
doc/docbook/da/d0c/gl_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/draw/gl.c</primary></indexterm>
<para>
<para>graphics - general drawing functions </para>
<para>general drawing functions </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../include/graphics.h&quot;<?linebreak?>#include &quot;../../../include/signal.h&quot;<?linebreak?></programlisting><simplesect>
@ -86,7 +86,7 @@
<section>
<title>Detailed Description</title>
<para>graphics - general drawing functions </para>
<para>general drawing functions </para>
<para>This file is part of Gem-graph.</para>
</section>
@ -112,7 +112,9 @@ Parameters</title>
<colspec colwidth="4*"/>
<tbody>
<row>
<entry>axis</entry><entry></entry>
<entry>axis</entry><entry>
<para>meaning which axis we&apos;re building (for label)</para>
</entry>
</row>
</tbody>
</tgroup>
@ -121,7 +123,7 @@ Parameters</title>
</formalpara>
<formalpara><title>Returns</title>
<para>GtkWidget * </para>
<para>GtkWidget* pointer to the new widget </para>
</formalpara>
</para>
</section>
@ -347,7 +349,9 @@ Parameters</title>
<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</para>
<para>returns true if success ? TODO why not bool ? </para>
<para>DO NOT DOCUMENT param void &lt; argument &apos;void&apos; of command @ param is not found</para>
<para>DO NOT DOCUMENT returns bool true if success &lt; does not return anything </para>
</section>
<anchor xml:id="_gl_8c_1a9d41985e1832e0a798e722d2341752f1"/><section>
<title>util_gl_shutdown_stack()</title>
@ -370,7 +374,7 @@ Parameters</title>
<tbody>
<row>
<entry>*container_widget</entry><entry>
<para>generally the GtkBox that contains the GLArea </para>
<para></para>
</entry>
</row>
<row>
@ -383,7 +387,7 @@ Parameters</title>
</formalpara>
<formalpara><title>Returns</title>
<para>bool: true if success </para>
<para>success </para>
</formalpara>
</para>
</section>

10
doc/docbook/db/d02/designer_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/widget/main_window/designer.c</primary></indexterm>
<para>
<para>main window </para>
<para>builds ans present </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../../include/widget.h&quot;<?linebreak?>#include &quot;../../../include/fsm.h&quot;<?linebreak?>#include &quot;../../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -17,11 +17,15 @@
<section>
<title>Detailed Description</title>
<para>main window </para>
<para>builds ans present </para>
<para>This file is part of Gem-graph.</para>
<para>Six pages can be displayed in the main window:<itemizedlist>
<para>ensure the titlebar and the pages are available and init them</para>
<para>triggers assembly of the topbar and the default page</para>
<para>six pages can be displayed in the main window:<itemizedlist>
<listitem>
<para>synth: an overview that presents the main elements of interest simultaneously</para>
</listitem><listitem>

4
doc/docbook/db/d07/parse_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/parse.c</primary></indexterm>
<para>
<para>Gem-graph-client parsing functions. </para>
<para>parsing XML </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;libxml/parser.h&gt;<?linebreak?>#include &lt;libxml/xmlreader.h&gt;<?linebreak?>#include &quot;../../include/base.h&quot;<?linebreak?></programlisting><simplesect>
@ -84,7 +84,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client parsing functions. </para>
<para>parsing XML </para>
<para>This file is part of Gem-graph. </para>
</section>

4
doc/docbook/db/d08/pile_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/pile.c</primary></indexterm>
<para>
<para>Gem-graph-client. </para>
<para>simple pile </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -25,7 +25,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client. </para>
<para>simple pile </para>
<para>This file is part of Gem-graph. It implements a simple pile functions. </para>
</section>

4
doc/docbook/dc/d0e/sorted__list_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/sorted_list.c</primary></indexterm>
<para>
<para>Gem-graph-client. </para>
<para>simple sorted list </para>
</para>
<programlisting linenumbering="unnumbered">#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -25,7 +25,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client. </para>
<para>simple sorted list </para>
<para>This file is part of Gem-graph. It implements a simple sorted list functions. </para>
</section>

4
doc/docbook/df/d05/structslist.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>slist</primary></indexterm>
<para>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
</para>
<para>
@ -26,7 +26,7 @@
<section>
<title>Detailed Description</title>
<para>phantom documentation used to test the functioning of doxygen </para>
<para>phantom documentation </para>
<para>
The documentation for this struct was generated from the following file:</para>
include/<link linkend="_util_8h">util.h</link></section>

4
doc/docbook/df/d0a/io_8c.xml
View File

@ -4,7 +4,7 @@
<indexterm><primary>src/util/io.c</primary></indexterm>
<para>
<para>Gem-graph-client util input output. </para>
<para>input output </para>
</para>
<programlisting linenumbering="unnumbered">#include &lt;assert.h&gt;<?linebreak?>#include &lt;errno.h&gt;<?linebreak?>#include &lt;fcntl.h&gt;<?linebreak?>#include &lt;math.h&gt;<?linebreak?>#include &lt;stdio.h&gt;<?linebreak?>#include &lt;stdlib.h&gt;<?linebreak?>#include &lt;stddef.h&gt;<?linebreak?>#include &lt;stdbool.h&gt;<?linebreak?>#include &lt;sys/types.h&gt;<?linebreak?>#include &lt;sys/stat.h&gt;<?linebreak?>#include &lt;unistd.h&gt;<?linebreak?>#include &lt;time.h&gt;<?linebreak?>#include &quot;../../include/util.h&quot;<?linebreak?></programlisting><simplesect>
@ -19,7 +19,7 @@
<section>
<title>Detailed Description</title>
<para>Gem-graph-client util input output. </para>
<para>input output </para>
<para>This file is part of Gem-graph. </para>
</section>

4
doc/rtfm/man3/dblist.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
dblist \- phantom documentation used to test the functioning of doxygen
dblist \- required to init the empty list
.SH SYNOPSIS
.br
@ -23,7 +23,7 @@ dblist \- phantom documentation used to test the functioning of doxygen
.in -1c
.SH "Detailed Description"
.PP
phantom documentation used to test the functioning of doxygen
required to init the empty list
.SH "Author"
.PP

10
doc/rtfm/man3/designer.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/widget/main_window/designer.c \- main window
src/widget/main_window/designer.c \- builds ans present
.SH SYNOPSIS
.br
@ -23,11 +23,15 @@ src/widget/main_window/designer.c \- main window
.in -1c
.SH "Detailed Description"
.PP
main window
builds ans present
This file is part of Gem-graph\&.
.PP
Six pages can be displayed in the main window:
ensure the titlebar and the pages are available and init them
.PP
triggers assembly of the topbar and the default page
.PP
six pages can be displayed in the main window:
.IP "\(bu" 2
synth: an overview that presents the main elements of interest simultaneously
.IP "\(bu" 2

36
doc/rtfm/man3/draw.c.3
View File

@ -18,23 +18,23 @@ src/graphics/draw.c \- graphics - general drawing functions
.in +1c
.ti -1c
.RI "void \fBgraphics_draw_vertex\fP (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.RI "void \fBgraphics_draw_vertex\fP (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)"
.br
.RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_color\fP (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.RI "void \fBgraphics_draw_color\fP (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)"
.br
.RI "Writes values to describe a color (r,g,b) into the color buffer\&. "
.RI "Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&. "
.ti -1c
.RI "void \fBgraphics_draw_line\fP (const int stack_id, GLuint a, GLuint b)"
.RI "void \fBgraphics_draw_line\fP (const int graphics_stack_id, GLuint a, GLuint b)"
.br
.RI "Writes values to describe a line from a to b into the line buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_plan\fP (const int stack_id, GLuint a, GLuint b, GLuint c)"
.RI "void \fBgraphics_draw_plan\fP (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)"
.br
.RI "Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw\fP (const int stack_id)"
.RI "void \fBgraphics_draw\fP (const int graphics_stack_id)"
.br
.RI "Draws the current buffer to a gl_area\&. "
.in -1c
@ -45,25 +45,25 @@ graphics - general drawing functions
This file is part of Gem-graph\&.
.SH "Function Documentation"
.PP
.SS "void graphics_draw (const int stack_id)"
.SS "void graphics_draw (const int graphics_stack_id)"
.PP
Draws the current buffer to a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP gl_area, ptr to the gl_area widget
\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget
.RE
.PP
.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.SS "void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)"
.PP
Writes values to describe a color (r,g,b) into the color buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.br
\fIr\fP
.br
@ -73,14 +73,14 @@ Writes values to describe a color (r,g,b) into the color buffer\&. Draws the col
.RE
.PP
.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)"
.SS "void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)"
.PP
Writes values to describe a line from a to b into the line buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.br
\fIa\fP
.br
@ -88,14 +88,14 @@ Writes values to describe a line from a to b into the line buffer\&.
.RE
.PP
.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)"
.SS "void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)"
.PP
Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.br
\fIa\fP
.br
@ -105,14 +105,14 @@ Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
.RE
.PP
.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.SS "void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)"
.PP
Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.br
\fIx\fP
.br

4
doc/rtfm/man3/elem.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
elem \- phantom documentation used to test the functioning of doxygen
elem \- simplest element of a double-chained list
.SH SYNOPSIS
.br
@ -27,7 +27,7 @@ elem \- phantom documentation used to test the functioning of doxygen
.in -1c
.SH "Detailed Description"
.PP
phantom documentation used to test the functioning of doxygen
simplest element of a double-chained list
.SH "Author"
.PP

16
doc/rtfm/man3/gl.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/draw/gl.c \- graphics - general drawing functions
src/util/draw/gl.c \- general drawing functions
.SH SYNOPSIS
.br
@ -86,7 +86,7 @@ src/util/draw/gl.c \- graphics - general drawing functions
.in -1c
.SH "Detailed Description"
.PP
graphics - general drawing functions
general drawing functions
This file is part of Gem-graph\&.
.SH "Function Documentation"
@ -98,12 +98,12 @@ Creates a slider widget\&.
.PP
\fBParameters\fP
.RS 4
\fIaxis\fP
\fIaxis\fP meaning which axis we're building (for label)
.RE
.PP
\fBReturns\fP
.RS 4
GtkWidget *
GtkWidget* pointer to the new widget
.RE
.PP
@ -205,7 +205,9 @@ returns int
.SS "void util_gl_shutdown_all_stacks (void)"
.PP
Look for every stack entry and shutdowns OpenGL for it\&. returns true if success ? TODO why not bool ?
Look for every stack entry and shutdowns OpenGL for it\&. DO NOT DOCUMENT param void < argument 'void' of command @ param is not found
.PP
DO NOT DOCUMENT returns bool true if success < does not return anything
.SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)"
.PP
@ -213,14 +215,14 @@ Look for stack entry and shutdowns OpenGL for it\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
\fI*container_widget\fP
.br
\fI*error_buffer\fP
.RE
.PP
\fBReturns\fP
.RS 4
bool: true if success
success
.RE
.PP

220
doc/rtfm/man3/graphics.h.3
View File

@ -46,14 +46,6 @@ include/graphics.h \- graphics header
.in +1c
.ti -1c
.RI "bool \fBgraphics_render_stack\fP (GtkWidget *container_widget)"
.br
.RI "Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas\&. "
.ti -1c
.RI "bool \fBgraphics_setup_glarea\fP (int target_mode, GtkWidget *target_widget)"
.br
.RI "phantom documentation "
.ti -1c
.RI "int \fBgraphics_init\fP (void *error_buffer)"
.br
.RI "Initializes a gl_area\&. "
@ -62,7 +54,7 @@ include/graphics.h \- graphics header
.br
.RI "Draws the current buffer to a gl_area\&. "
.ti -1c
.RI "bool \fBgraphics_shutdown\fP (const int graphics_stack_id, void *error_buffer)"
.RI "bool \fBgraphics_shutdown\fP (const int id, void *error_buffer)"
.br
.RI "Shutdowns a gl_area\&. "
.ti -1c
@ -70,25 +62,13 @@ include/graphics.h \- graphics header
.br
.RI "Initializes the shaders of a gl_area and link them to a program\&. "
.ti -1c
.RI "bool \fBgraphics_init_graphics_stack\fP (void *container_widget, GError *error_buffer)"
.br
.RI "phantom documentation "
.ti -1c
.RI "bool \fBgraphics_shutdown_graphics_stack\fP (void *container_widget, GError *error_buffer)"
.br
.RI "phantom documentation "
.ti -1c
.RI "bool \fBgraphics_update_axis_stack\fP (GtkWidget *container_widget, int axis, int value)"
.br
.RI "phantom documentation "
.ti -1c
.RI "void \fBgraphics_init_buffers\fP (const int graphics_stack_id)"
.br
.RI "Initializes the buffer of a gl_area Calls according to the user preferences\&. "
.ti -1c
.RI "void \fBgraphics_draw_vertex\fP (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)"
.br
.RI "Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&. "
.RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_line\fP (const int graphics_stack_id, GLuint a, GLuint b)"
.br
@ -120,7 +100,7 @@ include/graphics.h \- graphics header
.ti -1c
.RI "int \fBgraphics_draw_space_ridges_lines\fP (const int graphics_stack_id)"
.br
.RI "draw_space_ridges_lines "
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int graphics_stack_id, long x, long y, long z)"
.br
@ -128,11 +108,6 @@ include/graphics.h \- graphics header
.ti -1c
.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "int \fBgraphics_set_arrow\fP (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)"
.br
.RI "set_arrow "
.in -1c
.SS "Variables"
@ -149,20 +124,18 @@ graphics header
This file is part of Gem-graph\&.
.SH "Function Documentation"
.PP
.SS "void graphics_draw (const int stack_id)"
.SS "void graphics_draw (const int graphics_stack_id)"
.PP
Draws the current buffer to a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.br
\fIstack_id\fP gl_area, ptr to the gl_area widget
\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget
.RE
.PP
.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.SS "void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)"
.PP
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
@ -178,24 +151,9 @@ Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) v
\fIb\fP
.RE
.PP
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
.br
\fIr\fP
.br
\fIg\fP
.br
\fIb\fP
.RE
.PP
.SS "long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.PP
phantom documentation used to test the functioning of doxygen
.PP
\fBParameters\fP
.RS 4
@ -216,7 +174,7 @@ l
.RE
.PP
.SS "long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)"
.SS "long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)"
.PP
Writes grid lines on space faces\&.
@ -237,27 +195,19 @@ Writes grid lines on space faces\&.
l
.RE
.PP
Writes grid lines on space faces\&.
.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)"
.SS "void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b)"
.PP
Writes values to describe a line from a to b into the line buffer\&. @use liste de fonctions GTK
Writes values to describe a line from a to b into the line buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b)
.br
\fIgraphics_stack_id\fP
.br
\fIa\fP
.br
\fIb\fP
.br
\fIstack_id\fP
.br
\fIa\fP
.br
\fIb\fP
.RE
.PP
@ -311,15 +261,13 @@ i
.RE
.PP
.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)"
.SS "void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c)"
.PP
Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b,c)
.br
\fIgraphics_stack_id\fP
.br
\fIa\fP
@ -327,34 +275,10 @@ Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
\fIb\fP
.br
\fIc\fP
.br
\fIstack_id\fP
.br
\fIa\fP
.br
\fIb\fP
.br
\fIc\fP
.RE
.PP
.SS "int graphics_draw_space_ridges_lines (const int stack_id)"
.PP
draw_space_ridges_lines
.PP
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.RE
.PP
\fBReturns\fP
.RS 4
i
.RE
.PP
draw_space_ridges_lines
.SS "int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)"
.SS "int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.PP
Writes grid ridges to vertex and color buffers\&.
@ -378,15 +302,13 @@ i
.RE
.PP
Writes grid ridges to vertex and color buffers\&.
.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.SS "void graphics_draw_vertex (const int graphics_stack_id, GLfloat x, GLfloat y, GLfloat z)"
.PP
Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIGLfloat\fP x, GLfloat y, GLfloat z
.br
\fIgraphics_stack_id\fP
.br
\fIx\fP
@ -396,19 +318,6 @@ Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
\fIz\fP
.RE
.PP
Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
.br
\fIx\fP
.br
\fIy\fP
.br
\fIz\fP
.RE
.PP
.SS "int graphics_init (void * error_buffer)"
@ -425,10 +334,7 @@ Initializes a gl_area\&.
true if initialized
.RE
.PP
\fBParameters\fP
.RS 4
\fI*error_buffer\fP
.RE
param *error_buffer < DO NOT DOCUMENT (it's 'void')
.PP
\fBReturns\fP
.RS 4
@ -436,56 +342,30 @@ true if initialized
.RE
.PP
.SS "void graphics_init_buffers (const int stack_id)"
.SS "void graphics_init_buffers (const int graphics_stack_id)"
.PP
Initializes the buffer of a gl_area Calls according to the user preferences\&.
.PP
\fBParameters\fP
.RS 4
\fIgl_area,ptr\fP to the gl_area widget
.br
\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget
.br
\fIstack_id\fP
\fIgraphics_stack_id\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.SS "bool graphics_init_shaders (const int stack_id)"
.SS "bool graphics_init_shaders (const int graphics_stack_id)"
.PP
Initializes the shaders of a gl_area and link them to a program\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP gl_area, ptr to the gl_area widget
\fIgraphics_stack_id\fP
.RE
.PP
\fBReturns\fP
.RS 4
true if initialized
.RE
.PP
\fBParameters\fP
.RS 4
\fIgl_area,ptr\fP to the gl_area widget
.RE
.PP
\fBReturns\fP
.RS 4
true if initialized
.RE
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.PP
\fBReturns\fP
.RS 4
true if initialized
initialized
.RE
.PP
@ -500,40 +380,6 @@ graphics_model_setup
.RE
.PP
.SS "int graphics_set_arrow (int graphics_stack_id, int arrows_nb, int space_X, int space_Y, int space_Z, int requested_weight, int site, int arrow_x, int arrow_y, int arrow_z)"
.PP
set_arrow
.PP
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.br
\fIarrows_nb\fP
.br
\fIspace_X\fP
.br
\fIspace_Y\fP
.br
\fIspace_Z\fP
.br
\fIrequested_weight\fP
.br
\fIsite\fP
.br
\fIx\fP
.br
\fIy\fP
.br
\fIz\fP
.RE
.PP
\fBReturns\fP
.RS 4
i
.RE
.PP
.SS "bool graphics_shutdown (const int id, void * error_buffer)"
.PP
@ -541,38 +387,14 @@ Shutdowns a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.br
\fI*error_buffer\fP
.RE
.PP
\fBReturns\fP
.RS 4
true if success
.RE
.PP
\fBParameters\fP
.RS 4
\fIgl_area,ptr\fP to the gl_area widget
.RE
.PP
\fBReturns\fP
.RS 4
true if success
.RE
.PP
\fBParameters\fP
.RS 4
\fIid\fP
.br
\fI*error_buffer\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.PP
\fBReturns\fP
.RS 4
true if success
success
.RE
.PP

39
doc/rtfm/man3/grid.c.3
View File

@ -14,21 +14,20 @@ src/graphics/grid.c \- graphics - grid/empty space drawing functions
.in +1c
.ti -1c
.RI "int \fBgraphics_draw_space_ridges_vertex\fP (const int stack_id, long offset_vertex, long x, long y, long z)"
.RI "int \fBgraphics_draw_space_ridges_vertex\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "int \fBgraphics_draw_space_ridges_lines\fP (const int stack_id)"
.RI "int \fBgraphics_draw_space_ridges_lines\fP (const int graphics_stack_id)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.ti -1c
.RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int stack_id, long x, long y, long z)"
.RI "long \fBgraphics_draw_grids_on_space_faces_vertex\fP (const int graphics_stack_id, long x, long y, long z)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "Writes grid lines on space faces\&. "
.ti -1c
.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int stack_id, long offset_vertex, long x, long y, long z)"
.RI "long \fBgraphics_draw_grids_on_space_faces_lines\fP (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SH "Detailed Description"
.PP
@ -39,8 +38,6 @@ This file is part of Gem-graph\&.
.PP
.SS "long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.PP
phantom documentation used to test the functioning of doxygen
.PP
\fBParameters\fP
.RS 4
@ -61,15 +58,29 @@ l
.RE
.PP
.SS "long graphics_draw_grids_on_space_faces_vertex (const int stack_id, long x, long y, long z)"
.SS "long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id, long x, long y, long z)"
.PP
phantom documentation used to test the functioning of doxygen Writes grid lines on space faces\&.
.SS "int graphics_draw_space_ridges_lines (const int stack_id)"
Writes grid lines on space faces\&.
.PP
phantom documentation used to test the functioning of doxygen draw_space_ridges_lines
.SS "int graphics_draw_space_ridges_vertex (const int stack_id, long offset_vertex, long x, long y, long z)"
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.br
\fIx\fP
.br
\fIy\fP
.br
\fIz\fP
.RE
.PP
\fBReturns\fP
.RS 4
l
.RE
.PP
.SS "int graphics_draw_space_ridges_vertex (const int graphics_stack_id, long offset_vertex, long x, long y, long z)"
.PP
phantom documentation used to test the functioning of doxygen Writes grid ridges to vertex and color buffers\&.

29
doc/rtfm/man3/init.c.3
View File

@ -34,15 +34,15 @@ src/graphics/init.c \- graphics - initialization and graphic stack management
.br
.RI "Shutdowns a gl_area\&. "
.ti -1c
.RI "void \fBgraphics_model_setup\fP (const int stack_id)"
.RI "void \fBgraphics_model_setup\fP (const int graphics_stack_id)"
.br
.RI "graphics_model_setup "
.ti -1c
.RI "void \fBgraphics_init_buffers\fP (const int stack_id)"
.RI "void \fBgraphics_init_buffers\fP (const int graphics_stack_id)"
.br
.RI "Initializes the buffer of a gl_area Calls according to the user preferences\&. "
.ti -1c
.RI "bool \fBgraphics_init_shaders\fP (const int stack_id)"
.RI "bool \fBgraphics_init_shaders\fP (const int graphics_stack_id)"
.br
.RI "Initializes the shaders of a gl_area and link them to a program\&. "
.in -1c
@ -76,12 +76,7 @@ This file is part of Gem-graph\&.
.SS "int graphics_init (void * error_buffer)"
.PP
Initializes a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fI*error_buffer\fP
.RE
Initializes a gl_area\&. param *error_buffer < DO NOT DOCUMENT (it's 'void')
.PP
\fBReturns\fP
.RS 4
@ -89,32 +84,30 @@ true if initialized
.RE
.PP
.SS "void graphics_init_buffers (const int stack_id)"
.SS "void graphics_init_buffers (const int graphics_stack_id)"
.PP
Initializes the buffer of a gl_area Calls according to the user preferences\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.SS "bool graphics_init_shaders (const int stack_id)"
.SS "bool graphics_init_shaders (const int graphics_stack_id)"
.PP
Initializes the shaders of a gl_area and link them to a program\&.
.PP
\fBParameters\fP
.RS 4
\fIstack_id\fP
\fIgraphics_stack_id\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.PP
\fBReturns\fP
.RS 4
true if initialized
initialized
.RE
.PP
@ -141,11 +134,9 @@ Shutdowns a gl_area\&.
\fI*error_buffer\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.PP
\fBReturns\fP
.RS 4
true if success
success
.RE
.PP

4
doc/rtfm/man3/io.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/io.c \- Gem-graph-client util input output\&.
src/util/io.c \- input output
.SH SYNOPSIS
.br
@ -44,7 +44,7 @@ src/util/io.c \- Gem-graph-client util input output\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client util input output\&.
input output
This file is part of Gem-graph\&.
.SH "Function Documentation"

4
doc/rtfm/man3/list_2x2.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/list_2x2.c \- Gem-graph-client util double_chained list\&.
src/util/list_2x2.c \- double_chained list
.SH SYNOPSIS
.br
@ -48,7 +48,7 @@ src/util/list_2x2.c \- Gem-graph-client util double_chained list\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client util double_chained list\&.
double_chained list
This file is part of Gem-graph\&.
.SH "Function Documentation"

4
doc/rtfm/man3/parse.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/parse.c \- Gem-graph-client parsing functions\&.
src/util/parse.c \- parsing XML
.SH SYNOPSIS
.br
@ -88,7 +88,7 @@ src/util/parse.c \- Gem-graph-client parsing functions\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client parsing functions\&.
parsing XML
This file is part of Gem-graph\&.
.SH "Function Documentation"

4
doc/rtfm/man3/pile.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
pile \- phantom documentation used to test the functioning of doxygen
pile \- phantom documentation
.SH SYNOPSIS
.br
@ -23,7 +23,7 @@ pile \- phantom documentation used to test the functioning of doxygen
.in -1c
.SH "Detailed Description"
.PP
phantom documentation used to test the functioning of doxygen
phantom documentation
.SH "Author"
.PP

4
doc/rtfm/man3/pile.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/pile.c \- Gem-graph-client\&.
src/util/pile.c \- simple pile
.SH SYNOPSIS
.br
@ -31,7 +31,7 @@ src/util/pile.c \- Gem-graph-client\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client\&.
simple pile
This file is part of Gem-graph\&. It implements a simple pile functions\&.
.SH "Function Documentation"

4
doc/rtfm/man3/slist.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
slist \- phantom documentation used to test the functioning of doxygen
slist \- phantom documentation
.SH SYNOPSIS
.br
@ -23,7 +23,7 @@ slist \- phantom documentation used to test the functioning of doxygen
.in -1c
.SH "Detailed Description"
.PP
phantom documentation used to test the functioning of doxygen
phantom documentation
.SH "Author"
.PP

4
doc/rtfm/man3/sorted_list.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/sorted_list.c \- Gem-graph-client\&.
src/util/sorted_list.c \- simple sorted list
.SH SYNOPSIS
.br
@ -31,7 +31,7 @@ src/util/sorted_list.c \- Gem-graph-client\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client\&.
simple sorted list
This file is part of Gem-graph\&. It implements a simple sorted list functions\&.
.SH "Function Documentation"

4
doc/rtfm/man3/strings_op.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/strings_op.c \- Gem-graph-client\&.
src/util/strings_op.c \- concat
.SH SYNOPSIS
.br
@ -24,7 +24,7 @@ src/util/strings_op.c \- Gem-graph-client\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client\&.
concat
This file is part of Gem-graph\&.
.PP

4
doc/rtfm/man3/tests.c.3
View File

@ -2,7 +2,7 @@
.ad l
.nh
.SH NAME
src/util/tests.c \- Gem-graph-client\&.
src/util/tests.c \- use to check utilities
.SH SYNOPSIS
.br
@ -36,7 +36,7 @@ src/util/tests.c \- Gem-graph-client\&.
.in -1c
.SH "Detailed Description"
.PP
Gem-graph-client\&.
use to check utilities
This file is part of Gem-graph\&. It only groups various tests\&.
.SH "Author"

92
doc/rtfm/man3/util.h.3
View File

@ -22,19 +22,19 @@ include/util.h \- utilities header
.ti -1c
.RI "struct \fBpile\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "phantom documentation "
.ti -1c
.RI "struct \fBelem\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "simplest element of a double-chained list "
.ti -1c
.RI "struct \fBdblist\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "required to init the empty list "
.ti -1c
.RI "struct \fBslist\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "phantom documentation "
.in -1c
.SS "Typedefs"
@ -42,15 +42,15 @@ include/util.h \- utilities header
.ti -1c
.RI "typedef struct \fBpile\fP \fBpile\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "phantom documentation "
.ti -1c
.RI "typedef struct \fBelem\fP \fBelem\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "simplest element of a double-chained list "
.ti -1c
.RI "typedef struct \fBslist\fP \fBslist\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.RI "phantom documentation "
.in -1c
.SS "Functions"
@ -146,10 +146,6 @@ include/util.h \- utilities header
.br
.RI "Look for stack entry and returns stack_id\&. "
.ti -1c
.RI "long \fButil_gl_is_util_ready\fP (void *container_widget)"
.br
.RI "Look for stack entry and returns stack_id\&. "
.ti -1c
.RI "bool \fButil_gl_init_stack\fP (void *container_widget, GError *error_buffer)"
.br
.RI "Look for stack entry and initializes OpenGL for it\&. "
@ -200,16 +196,6 @@ Creates a slider widget\&.
GtkWidget* pointer to the new widget
.RE
.PP
\fBParameters\fP
.RS 4
\fIaxis\fP
.RE
.PP
\fBReturns\fP
.RS 4
GtkWidget *
.RE
.PP
.SS "char * util_concat (const char * str, \&.\&.\&.)"
@ -241,16 +227,6 @@ Look for stack entry and returns stack_id\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
\fBReturns\fP
.RS 4
stack_id
.RE
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP
.RE
.PP
@ -267,16 +243,6 @@ Look for stack entry and initializes OpenGL for it\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
\fBReturns\fP
.RS 4
bool true if success
.RE
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP
.br
\fI*error_buffer\fP
@ -288,22 +254,6 @@ success
.RE
.PP
.SS "long util_gl_is_util_ready (void * container_widget)"
.PP
Look for stack entry and returns stack_id\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
\fBReturns\fP
.RS 4
stack_id
.RE
.PP
.SS "bool util_gl_render_stack (GtkWidget * container_widget)"
.PP
@ -311,16 +261,6 @@ Look for stack entry and triggers OpenGL for drawing\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
\fBReturns\fP
.RS 4
bool true if success
.RE
.PP
\fBParameters\fP
.RS 4
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
.RE
.PP
@ -333,19 +273,9 @@ bool: true if success
.SS "void util_gl_shutdown_all_stacks (void)"
.PP
Look for every stack entry and shutdowns OpenGL for it\&.
Look for every stack entry and shutdowns OpenGL for it\&. DO NOT DOCUMENT param void < argument 'void' of command @ param is not found
.PP
\fBParameters\fP
.RS 4
\fIvoid\fP
.RE
.PP
\fBReturns\fP
.RS 4
bool true if success
.RE
.PP
returns true if success ? TODO why not bool ?
DO NOT DOCUMENT returns bool true if success < does not return anything
.SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)"
.PP
@ -353,14 +283,14 @@ Look for stack entry and shutdowns OpenGL for it\&.
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP generally the GtkBox that contains the GLArea
\fI*container_widget\fP
.br
\fI*error_buffer\fP
.RE
.PP
\fBReturns\fP
.RS 4
bool: true if success
success
.RE
.PP

188
include/graphics.h
View File

@ -83,66 +83,16 @@ struct graphics_stack_t {
*/
extern struct graphics_stack_t *graphics_stack;
/**
* Structure describing a gl_area and its parameters, used to create a table
* of Gem-graph client current gl_areas
*/
bool graphics_render_stack(GtkWidget *container_widget);
/** phantom documentation */
bool graphics_setup_glarea(int target_mode, GtkWidget *target_widget);
//bool graphics_render_stack(GtkWidget *container_widget);
//bool graphics_setup_glarea(int target_mode, GtkWidget *target_widget);
int graphics_init(void *error_buffer);
/**
* Draws the current buffer to a gl_area
*
* @param graphics_stack_id
*/
void graphics_draw(const int graphics_stack_id);
/**
* Shutdowns a gl_area
*
* @param graphics_stack_id
* @param *error_buffer
*
* @return true if success
*/
bool graphics_shutdown(const int graphics_stack_id, void *error_buffer);
/**
* Initializes the shaders of a gl_area and link them to a program
*
* @param graphics_stack_id
* gl_area, ptr to the gl_area widget
*
* @return true if initialized
*/
bool graphics_shutdown(const int id, void *error_buffer);
bool graphics_init_shaders(const int graphics_stack_id);
/** phantom documentation */
bool graphics_init_graphics_stack(void *container_widget, GError *error_buffer);
/** phantom documentation */
bool graphics_shutdown_graphics_stack(void *container_widget, GError *error_buffer);
/** phantom documentation */
bool graphics_update_axis_stack(GtkWidget *container_widget, int axis, int value);
/**
* Initializes the buffer of a gl_area
* Calls according to the user preferences
* @param gl_area, ptr to the gl_area widget
*/
//bool graphics_init_graphics_stack(void *container_widget, GError *error_buffer);
//bool graphics_shutdown_graphics_stack(void *container_widget, GError *error_buffer);
//bool graphics_update_axis_stack(GtkWidget *container_widget, int axis, int value);
void graphics_init_buffers(const int graphics_stack_id);
/**
* Draws a vertex (x, y, z)
* if (console) prints (x, y, z) values to console
*
* @param GLfloat x, GLfloat y, GLfloat z
*/
void graphics_draw_vertex (const int graphics_stack_id,
GLfloat x,
GLfloat y,
@ -155,22 +105,11 @@ void graphics_draw_vertex (const int graphics_stack_id,
* @param GLfloat r, GLfloat g, GLfloat b
*
*/
//void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b);
/**
* Writes values to describe a line from a to b into the line buffer
*
* @use liste de fonctions GTK
*
* @param coords GLuint (a,b)
*/
void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b);
/**
* Writes values to describe an (a,b,c) plan (triangle) into the plan buffer
*
* @param coords GLuint (a,b,c)
*/
void graphics_draw_plan (const int graphics_stack_id, GLuint a, GLuint b, GLuint c);
/**
@ -273,70 +212,16 @@ static inline void graphics_print_stack(int graphics_stack_id)
*/
int graphics_init(void *error_buffer);
/*
* Draws the current buffer to a gl_area
*
* @param gl_area, ptr to the gl_area widget
*/
//void graphics_draw(const int graphics_stack_id);
/**
* Shutdowns a gl_area
*
* @param gl_area, ptr to the gl_area widget
*
* @return true if success
*/
bool graphics_shutdown(const int graphics_stack_id, void *error_buffer);
/**
* Initializes the shaders of a gl_area and link them to a program
*
* @param gl_area, ptr to the gl_area widget
*
* @return true if initialized
*/
bool graphics_init_shaders(const int graphics_stack_id);
/**
* Initializes the buffer of a gl_area
* Calls according to the user preferences
* @param graphics_stack_id gl_area, ptr to the gl_area widget
*/
void graphics_init_buffers(const int graphics_stack_id);
/**
* Draws a vertex (x, y, z)
* if (console) prints (x, y, z) values to console
*
* @param graphics_stack_id
* @param x
* @param y
* @param z
*/
void graphics_draw_vertex (const int graphics_stack_id,
GLfloat x,
GLfloat y,
GLfloat z);
/**
* Draws the color (r, g, b) associated to a vertex
* if (console) prints (r, g, b) values to console
*
* @param graphics_stack_id
* @param r
* @param g
* @param b
*/
void graphics_draw_color (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b);
void graphics_draw_color (const int graphics_stack_id,
GLfloat r,
GLfloat g,
GLfloat b);
/**
* Writes values to describe a line from a to b into the line buffer
*
* @param graphics_stack_id
* @param a
* @param b
*/
void graphics_draw_line (const int graphics_stack_id, GLuint a, GLuint b);
/**
@ -411,62 +296,22 @@ int graphics_draw_space_ridges_vertex (const int graphics_stack_id,
long y,
long z);
/**
* draw_space_ridges_lines
*
* @param graphics_stack_id
*
* @returns i
*/
int graphics_draw_space_ridges_lines (const int graphics_stack_id);
/**
* Writes grid lines on space faces
*
* @param graphics_stack_id
* @param x
* @param y
* @param z
*
* @returns l
*/
long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id,
long x,
long y,
long z);
/**
* @param graphics_stack_id
* @param offset_vertex
* @param x
* @param y
* @param z
*
* @returns l
*/
long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id,
long offset_vertex,
long x,
long y,
long z);
/**
* set_arrow
*
* @param graphics_stack_id
* @param arrows_nb
* @param space_X
* @param space_Y
* @param space_Z
* @param requested_weight
* @param site
* @param x
* @param y
* @param z
*
* @returns i
*/
int graphics_set_arrow (int graphics_stack_id,
/*
int graphics_set_arrow (
int graphics_stack_id,
int arrows_nb,
int space_X,
int space_Y,
@ -475,5 +320,6 @@ int graphics_set_arrow (int graphics_stack_id,
int site,
int arrow_x,
int arrow_y,
int arrow_z);
int arrow_z
);
*/

67
include/util.h
View File

@ -38,7 +38,7 @@ char *util_read_file (char *filename);
char *util_concat (const char *str, ...);
/** phantom documentation used to test the functioning of doxygen */
/** phantom documentation */
typedef struct pile {
int value; /**< value phantom documentation */
@ -54,8 +54,7 @@ int util_pile_length (pile *p); // renvoie le nombre d'éléments de la
//------------------------------------------------------------------------------
/** phantom documentation used to test the functioning of doxygen */
/** simplest element of a double-chained list */
typedef struct elem {
int value; /**< *value phantom documentation */
struct elem *prev; /**< *prev phantom documentation */
@ -63,13 +62,12 @@ typedef struct elem {
} elem;
/** phantom documentation used to test the functioning of doxygen */
/** required to init the empty list */
typedef struct {
elem *first; /**< *first phantom documentation */
elem *last; /**< *last phantom documentation */
} dblist; // structure d'accès à la liste
//
} dblist;
void util_list_2x2_init (dblist *l); // initialisation
void util_list_2x2_clear (dblist *l); // vide toute la liste
void util_list_2x2_view (dblist l); // affiche les valeurs de toute la liste
@ -82,8 +80,7 @@ int util_list_2x2_length (dblist l); // renvoie le nombre d'él
//------------------------------------------------------------------------------
/** phantom documentation used to test the functioning of doxygen */
/** phantom documentation */
typedef struct slist {
int value; /**< value phantom documentation */
struct slist *suiv; /**< *suiv phantom documentation */
@ -104,63 +101,13 @@ void util_test_sorted_list(); // " "
//------------------------------------------------------------------------------
/**
* Look for stack entry and returns stack_id
*
* @param *container_widget generally the GtkBox that contains the GLArea
*
* @returns stack_id
*/
long util_gl_get_stack(void *container_widget);
/**
* Look for stack entry and returns stack_id
*
* @param *container_widget generally the GtkBox that contains the GLArea
*
* @returns stack_id
*/
long util_gl_is_util_ready(void *container_widget);
/**
* Look for stack entry and initializes OpenGL for it
*
* @param *container_widget generally the GtkBox that contains the GLArea
*
* @returns bool true if success
*/
bool util_gl_init_stack(void *container_widget, GError *error_buffer);
bool util_gl_shutdown_stack(void *container_widget, GError *error_buffer);
void util_gl_clean_stack_index(void);
/**
* Look for stack entry and triggers OpenGL for drawing
*
* @param *container_widget generally the GtkBox that contains the GLArea
*
* @returns bool true if success
*/
bool util_gl_render_stack(GtkWidget *container_widget);
bool util_gl_update_axis(GtkWidget *container_widget, int axis, int value);
/**
* Look for every stack entry and shutdowns OpenGL for it
*
* @param void
*
* @returns bool true if success
*/
void util_gl_shutdown_all_stacks(void);
/**
* Creates a slider widget
*
* @param axis meaning which axis we're building (for label)
*
* @returns GtkWidget* pointer to the new widget
*/
GtkWidget *create_axis_slider(int axis);
// long util_gl_is_util_ready(void *container_widget);

43
src/graphics/draw.c
View File

@ -33,21 +33,21 @@
/**
* Writes values to describe a vertex at (x,y,z) intoq the vertex buffer
*
* @param stack_id
* @param graphics_stack_id
* @param x
* @param y
* @param z
*/
void graphics_draw_vertex (const int stack_id,
void graphics_draw_vertex (const int graphics_stack_id,
GLfloat x,
GLfloat y,
GLfloat z)
{
//g_printerr("stack_id is %d\n", stack_id);
//g_printerr("stack_id is %d\n", stack_id);
//g_printerr("graphics_stack_id is %d\n", graphics_stack_id);
//g_printerr("graphics_stack_id is %d\n", graphics_stack_id);
//g_printerr("graphic_stack is at %p\n", graphic_stack);
//g_printerr("graphic_stack[stack_id] is at %p\n", graphic_stack + stack_id);
volatile struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
//g_printerr("graphic_stack[graphics_stack_id] is at %p\n", graphic_stack + graphics_stack_id);
volatile struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
//g_printerr("Currently stack->buffer_vertex_origin @ %p\n", stack->buffer_vertex_origin);
@ -56,7 +56,7 @@ void graphics_draw_vertex (const int stack_id,
graphics_stack->buffer_vertex_origin =
g_realloc (graphics_stack->buffer_vertex_origin,
(graphics_stack->buffer_vertex_size + 3) * sizeof(GLfloat));
//print_stack(stack_id);
//print_stack(graphics_stack_id);
graphics_stack->buffer_vertex_origin[graphics_stack->buffer_vertex_size + 0] = x;
graphics_stack->buffer_vertex_origin[graphics_stack->buffer_vertex_size + 1] = y;
@ -66,19 +66,20 @@ void graphics_draw_vertex (const int stack_id,
}
/**
* Writes values to describe a color (r,g,b) into the color buffer
* Draws the color (r, g, b) associated to a vertex
* if (console) prints (r, g, b) values to console
*
* @param stack_id
* @param graphics_stack_id
* @param r
* @param g
* @param b
*/
void graphics_draw_color (const int stack_id,
void graphics_draw_color (const int graphics_stack_id,
GLfloat r,
GLfloat g,
GLfloat b)
{
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
graphics_stack->buffer_colors_origin = g_realloc (graphics_stack->buffer_colors_origin,
(graphics_stack->buffer_colors_size + 3) * sizeof(GLfloat));
@ -95,15 +96,15 @@ void graphics_draw_color (const int stack_id,
/**
* Writes values to describe a line from a to b into the line buffer
*
* @param stack_id
* @param graphics_stack_id
* @param a
* @param b
*/
void graphics_draw_line (const int stack_id,
void graphics_draw_line (const int graphics_stack_id,
GLuint a,
GLuint b)
{
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
graphics_stack->buffer_lines_origin = g_realloc (graphics_stack->buffer_lines_origin,
(graphics_stack->buffer_lines_size + 2) * sizeof(GLuint));
@ -119,17 +120,17 @@ void graphics_draw_line (const int stack_id,
/**
* Writes values to describe an (a,b,c) plan (triangle) into the plan buffer
*
* @param stack_id
* @param graphics_stack_id
* @param a
* @param b
* @param c
*/
void graphics_draw_plan (const int stack_id,
void graphics_draw_plan (const int graphics_stack_id,
GLuint a,
GLuint b,
GLuint c)
{
struct graphics_stack_t *stack = &graphics_stack[stack_id];
struct graphics_stack_t *stack = &graphics_stack[graphics_stack_id];
graphics_stack->buffer_plans_origin = g_realloc (graphics_stack->buffer_plans_origin,
(graphics_stack->buffer_plans_size + 3) * sizeof(GLuint));
@ -146,16 +147,16 @@ void graphics_draw_plan (const int stack_id,
/**
* Draws the current buffer to a gl_area
*
* @param stack_id
* @param graphics_stack_id
* gl_area, ptr to the gl_area widget
*/
void graphics_draw(const int stack_id)
void graphics_draw(const int graphics_stack_id)
{
struct graphics_stack_t *stack = &graphics_stack[stack_id];
struct graphics_stack_t *stack = &graphics_stack[graphics_stack_id];
g_printerr("[debug] graphics_draw() started\n");
graphics_print_stack(stack_id);
graphics_print_stack(graphics_stack_id);
GLint cur_viewport[4];
glGetIntegerv(GL_VIEWPORT, cur_viewport);

135
src/graphics/grid.c
View File

@ -28,7 +28,7 @@
#include "../../include/graphics.h"
/** phantom documentation used to test the functioning of doxygen */
int graphics_draw_space_ridges_vertex (const int stack_id,
int graphics_draw_space_ridges_vertex (const int graphics_stack_id,
long offset_vertex,
long x,
long y,
@ -36,46 +36,56 @@ int graphics_draw_space_ridges_vertex (const int stack_id,
{
GLfloat max = fmax(x, y); max = fmax(max, z);
graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex - y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex - y / max, - z / max);
graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex - y / max, - z / max);
graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex + y / max, - z / max);
graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex - y / max, + z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex - y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex + y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex - y / max, + z / max);
graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex + y / max, - z / max);
graphics_draw_vertex (stack_id, offset_vertex + x / max, offset_vertex - y / max, + z / max);
graphics_draw_vertex (stack_id, offset_vertex - x / max, offset_vertex + y / max, + z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex + y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, offset_vertex - y / max, + z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex - x / max, offset_vertex + y / max, + z / max);
graphics_draw_vertex (stack_id, offset_vertex + x / max, + y / max, + z / max);
graphics_draw_vertex (graphics_stack_id, offset_vertex + x / max, + y / max, + z / max);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
graphics_draw_color (graphics_stack_id, 0.8f, 0.6f, 0.5f);
return 8;
}
/** phantom documentation used to test the functioning of doxygen */
int graphics_draw_space_ridges_lines (const int stack_id)
int graphics_draw_space_ridges_lines (const int graphics_stack_id)
{
graphics_draw_line (stack_id, 0, 1); graphics_draw_line (stack_id, 7, 4);
graphics_draw_line (stack_id, 0, 2); graphics_draw_line (stack_id, 7, 5);
graphics_draw_line (stack_id, 0, 3); graphics_draw_line (stack_id, 7, 6);
graphics_draw_line (graphics_stack_id, 0, 1); graphics_draw_line (graphics_stack_id, 7, 4);
graphics_draw_line (graphics_stack_id, 0, 2); graphics_draw_line (graphics_stack_id, 7, 5);
graphics_draw_line (graphics_stack_id, 0, 3); graphics_draw_line (graphics_stack_id, 7, 6);
graphics_draw_line (stack_id, 1, 4); graphics_draw_line (stack_id, 2, 4);
graphics_draw_line (stack_id, 1, 5); graphics_draw_line (stack_id, 3, 5);
graphics_draw_line (stack_id, 2, 6); graphics_draw_line (stack_id, 3, 6);
graphics_draw_line (graphics_stack_id, 1, 4); graphics_draw_line (graphics_stack_id, 2, 4);
graphics_draw_line (graphics_stack_id, 1, 5); graphics_draw_line (graphics_stack_id, 3, 5);
graphics_draw_line (graphics_stack_id, 2, 6); graphics_draw_line (graphics_stack_id, 3, 6);
return 12;
}
/** phantom documentation used to test the functioning of doxygen */
long graphics_draw_grids_on_space_faces_vertex (const int stack_id,
/**
* Writes grid lines on space faces
*
* @param graphics_stack_id
* @param x
* @param y
* @param z
*
* @returns l
*/
long graphics_draw_grids_on_space_faces_vertex (const int graphics_stack_id,
long x,
long y,
long z)
@ -84,53 +94,62 @@ long graphics_draw_grids_on_space_faces_vertex (const int stack_id,
for (i = 1; i < x; i++) {
graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, - y / max, - z / max);
graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, - y / max, z / max);
graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, y / max, z / max);
graphics_draw_vertex (stack_id, (2 * i / x - 1) * x / max, y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, - y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, - y / max, z / max);
graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, y / max, z / max);
graphics_draw_vertex (graphics_stack_id, (2 * i / x - 1) * x / max, y / max, - z / max);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
}
/* offset_vertex += (x - 1) * 4; */ /* offset_colors += (x - 1) * 4; */
for (i = 1; i < y; i++) {
graphics_draw_vertex (stack_id, - x / max, (2 * i / y - 1) * y / max, - z / max);
graphics_draw_vertex (stack_id, - x / max, (2 * i / y - 1) * y / max, z / max);
graphics_draw_vertex (stack_id, x / max, (2 * i / y - 1) * y / max, z / max);
graphics_draw_vertex (stack_id, x / max, (2 * i / y - 1) * y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, - x / max, (2 * i / y - 1) * y / max, - z / max);
graphics_draw_vertex (graphics_stack_id, - x / max, (2 * i / y - 1) * y / max, z / max);
graphics_draw_vertex (graphics_stack_id, x / max, (2 * i / y - 1) * y / max, z / max);
graphics_draw_vertex (graphics_stack_id, x / max, (2 * i / y - 1) * y / max, - z / max);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
}
/* offset_vertex += (y - 1) * 4; */ /* offset_colors += (y - 1) * 4; */
for (i = 1; i < z; i++) {
graphics_draw_vertex (stack_id, - x / max, - y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (stack_id, - x / max, y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (stack_id, x / max, y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (stack_id, x / max, - y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (graphics_stack_id, - x / max, - y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (graphics_stack_id, - x / max, y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (graphics_stack_id, x / max, y / max, (2 * i / z - 1) * z / max);
graphics_draw_vertex (graphics_stack_id, x / max, - y / max, (2 * i / z - 1) * z / max);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
graphics_draw_color (graphics_stack_id, 0.55f, 0.55f, 0.55f);
}
return (x + y + z - 3) * 3;
}
/** phantom documentation used to test the functioning of doxygen */
long graphics_draw_grids_on_space_faces_lines (const int stack_id,
/**
* @param graphics_stack_id
* @param offset_vertex
* @param x
* @param y
* @param z
*
* @returns l
*/
long graphics_draw_grids_on_space_faces_lines (const int graphics_stack_id,
long offset_vertex,
long x,
long y,
@ -140,24 +159,24 @@ long graphics_draw_grids_on_space_faces_lines (const int stack_id,
for (int i = 0; i < x - 1; i ++) {
graphics_draw_line (stack_id, offset_vertex + i * 4 + 1, offset_vertex + i * 4 + 2);
graphics_draw_line (stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 1, offset_vertex + i * 4 + 2);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3);
}
offset_vertex += (x - 1) * 4;
for (int i = 0; i < y - 1; i ++) {
graphics_draw_line (stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3);
graphics_draw_line (stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 2, offset_vertex + i * 4 + 3);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0);
}
offset_vertex += (y - 1) * 4;
for (int i = 0; i < z - 1; i ++) {
graphics_draw_line (stack_id, offset_vertex + i * 4 + 0, offset_vertex + i * 4 + 1);
graphics_draw_line (stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 0, offset_vertex + i * 4 + 1);
graphics_draw_line (graphics_stack_id, offset_vertex + i * 4 + 3, offset_vertex + i * 4 + 0);
}
return (x + y + z - 3) * 4;

46
src/graphics/init.c
View File

@ -103,7 +103,7 @@ static void graphics_debug_callback(GLenum source, GLenum type, GLuint id,
/**
* Initializes a gl_area
*
* @param *error_buffer
* param *error_buffer < DO NOT DOCUMENT (it's 'void')
*
* @returns true if initialized
*/
@ -167,13 +167,11 @@ int graphics_init(void *error_buffer)
* @param id
* @param *error_buffer
*
* gl_area, ptr to the gl_area widget
*
* @return true if success
* @return success
*/
bool graphics_shutdown(const int id, void *error_buffer)
{
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
if (id >= graphics_stack_size ||
graphics_stack_size == 0 ||
@ -230,13 +228,13 @@ bool graphics_shutdown(const int id, void *error_buffer)
* Attention, les vertex centraux de chaque unité d'espace (cube)
* peuvent être redondants (max 6)
*
* @param stack_id
* @param graphics_stack_id
*/
void graphics_model_setup (const int stack_id)
void graphics_model_setup (const int graphics_stack_id)
{
/* I N I T I A L D A T A S P E C I F I C A T I O N */
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
char dimension;
long space_X;
long space_Y;
@ -284,10 +282,10 @@ void graphics_model_setup (const int stack_id)
/* S P A C E D R A W I N G */
graphics_draw_space_ridges_vertex (stack_id, graphics_stack->buffer_vertex_size, space_X, space_Y, space_Z);
graphics_draw_space_ridges_lines (stack_id);
graphics_draw_grids_on_space_faces_vertex (stack_id, space_X, space_Y, space_Z);
graphics_draw_grids_on_space_faces_lines (stack_id, graphics_stack->buffer_lines_size, space_X, space_Y, space_Z);
graphics_draw_space_ridges_vertex (graphics_stack_id, graphics_stack->buffer_vertex_size, space_X, space_Y, space_Z);
graphics_draw_space_ridges_lines (graphics_stack_id);
graphics_draw_grids_on_space_faces_vertex (graphics_stack_id, space_X, space_Y, space_Z);
graphics_draw_grids_on_space_faces_lines (graphics_stack_id, graphics_stack->buffer_lines_size, space_X, space_Y, space_Z);
graphics_stack->buffer_vertex_0_arrow = graphics_stack->buffer_vertex_size;
graphics_stack->buffer_colors_0_arrow = graphics_stack->buffer_colors_size;
@ -308,7 +306,7 @@ void graphics_model_setup (const int stack_id)
while (parse_model_get_next_arrow(&arrow, (char *)&state_id, dimension)) {
g_print("[GRAPH DEBUG] cur arrow has x = %d\n", arrow.x);
graphics_stack->arrows_nb = graphics_set_arrow (stack_id,
graphics_stack->arrows_nb = graphics_set_arrow (graphics_stack_id,
graphics_stack->arrows_nb,
space_X,
space_Y,
@ -328,16 +326,16 @@ void graphics_model_setup (const int stack_id)
/** Initializes the buffer of a gl_area
* Calls according to the user preferences
*
* @param stack_id
* @param graphics_stack_id
*
* gl_area, ptr to the gl_area widget
*/
void graphics_init_buffers(const int stack_id)
void graphics_init_buffers(const int graphics_stack_id)
{
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
//XXX
graphics_model_setup(stack_id);
graphics_model_setup(graphics_stack_id);
GLuint vao, vertex_buffer, color_buffer;
@ -372,15 +370,13 @@ void graphics_init_buffers(const int stack_id)
/**
* Initializes the shaders of a gl_area and link them to a program
*
* @param stack_id
* @param graphics_stack_id
*
* gl_area, ptr to the gl_area widget
*
* @return true if initialized
* @return initialized
*/
bool graphics_init_shaders(const int stack_id)
bool graphics_init_shaders(const int graphics_stack_id)
{
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[stack_id]; TODO
struct graphics_stack_t *graphics_stack = NULL; // *graphics_stack = &graphics_stack[graphics_stack_id]; TODO
char *vertex_shader;
char *fragment_shader;
int status;
@ -394,7 +390,7 @@ bool graphics_init_shaders(const int stack_id)
vertex_shader = util_read_file(VERTEX_SHADER_FILE);
if (vertex_shader == NULL)
return false;
vertex = graphics_create_shader(stack_id, GL_VERTEX_SHADER, vertex_shader);
vertex = graphics_create_shader(graphics_stack_id, GL_VERTEX_SHADER, vertex_shader);
if(vertex == 0) {
graphics_stack->program = 0;
@ -406,7 +402,7 @@ bool graphics_init_shaders(const int stack_id)
fragment_shader = util_read_file(FRAG_SHADER_FILE);
if (fragment_shader == NULL)
return false;
fragment = graphics_create_shader(stack_id, GL_FRAGMENT_SHADER, fragment_shader);
fragment = graphics_create_shader(graphics_stack_id, GL_FRAGMENT_SHADER, fragment_shader);
if(fragment == 0) {
glDeleteShader(vertex);

15
src/util/draw/gl.c
View File

@ -1,6 +1,6 @@
/**
* @file
* graphics - general drawing functions
* general drawing functions
*
* This file is part of Gem-graph.
*
@ -157,10 +157,10 @@ bool util_gl_init_stack (void *container_widget, GError *error_buffer)
/**
* Look for stack entry and shutdowns OpenGL for it
*
* @param *container_widget: generally the GtkBox that contains the GLArea
* @param *container_widget
* @param *error_buffer
*
* @returns bool: true if success
* @returns success
*/
bool util_gl_shutdown_stack(void *container_widget, GError *error_buffer)
{
@ -236,8 +236,9 @@ bool util_gl_update_axis(GtkWidget *container_widget, int axis, int value)
/**
* Look for every stack entry and shutdowns OpenGL for it
*
* @details returns true if success ?
* TODO why not bool ?
* DO NOT DOCUMENT param void < argument 'void' of command @ param is not found
*
* DO NOT DOCUMENT returns bool true if success < does not return anything
*/
void util_gl_shutdown_all_stacks(void)
{
@ -251,9 +252,9 @@ void util_gl_shutdown_all_stacks(void)
/**
* Creates a slider widget
*
* @param axis
* @param axis meaning which axis we're building (for label)
*
* @returns GtkWidget *
* @returns GtkWidget* pointer to the new widget
*/
GtkWidget *create_axis_slider(int axis)
{

2
src/util/io.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client util input output
* input output
*
* This file is part of Gem-graph.
*

2
src/util/list_2x2.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client util double_chained list
* double_chained list
*
* This file is part of Gem-graph.
*

2
src/util/parse.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client parsing functions.
* parsing XML
*
* This file is part of Gem-graph.
*

2
src/util/pile.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client.
* simple pile
*
* This file is part of Gem-graph. It implements a simple pile functions.
*

2
src/util/sorted_list.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client.
* simple sorted list
*
* This file is part of Gem-graph. It implements a simple sorted list functions.
*

2
src/util/strings_op.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client.
* concat
*
* This file is part of Gem-graph.
*

2
src/util/tests.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client.
* use to check utilities
*
* This file is part of Gem-graph. It only groups various tests.
*

2
src/util/tree.c
View File

@ -1,6 +1,6 @@
/**
* @file
* Gem-graph-client. Widget tree functions.
* tree functions
*
* This file is part of Gem-graph.
*

8
src/widget/main_window/designer.c
View File

@ -1,10 +1,14 @@
/**
* @file
* main window
* builds ans present
*
* This file is part of Gem-graph.
*
* Six pages can be displayed in the main window:
* ensure the titlebar and the pages are available and init them
*
* triggers assembly of the topbar and the default page
*
* six pages can be displayed in the main window:
* - synth: an overview that presents the main elements of interest simultaneously
* - state: a detailed view of the space, enabling it to be explored or modified
* - measures presents all the measures available and those in progress