2024-10-19 16:05:49 +02:00
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns= "http://docbook.org/ns/docbook" version= "5.0" xmlns:xlink= "http://www.w3.org/1999/xlink" xml:id= "_graphics_8h" xml:lang= "en-US" >
<title > include/graphics.h File Reference</title>
<indexterm > <primary > include/graphics.h</primary> </indexterm>
<para >
<para > graphics header </para>
</para>
<programlisting linenumbering= "unnumbered" > #include " base.h" <?linebreak?> #include < epoxy/gl.h> <?linebreak?> #include < GL/glu.h> <?linebreak?> </programlisting> <simplesect >
<title > Classes </title>
<itemizedlist >
<listitem > <para > struct <link linkend= "_structgraphics__stack__t" > graphics_stack_t</link> </para>
<para > Structure describing a gl_area and its parameters, used to create a table of Gem-graph client current gl_areas. </para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect >
<title > Macros </title>
<itemizedlist >
<listitem > <para > <anchor xml:id= "_graphics_8h_1a80757f1a53908b5582a9ba77c133c079" /> #define <emphasis role= "strong" > VERTEX_SHADER_FILE</emphasis>       " src/shader.vert" </para>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_graphics_8h_1ad1be094b2f34d6c013cc36d0c0e9a2bb" /> #define <emphasis role= "strong" > FRAG_SHADER_FILE</emphasis>       " src/shader.frag" </para>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_graphics_8h_1a60413e8e518bdcc170ed34d8cfb6b018" /> #define <emphasis role= "strong" > GL_TARGET_MAJOR_VERSION</emphasis>       0</para>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > <anchor xml:id= "_graphics_8h_1aacde4e0c52ad0f34009b753d288e385c" /> #define <emphasis role= "strong" > GL_TARGET_MINOR_VERSION</emphasis>       4</para>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
</itemizedlist>
</simplesect>
<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>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > int <link linkend= "_graphics_8h_1a5a4ed7438a755777b162fc37e84ba93a" > graphics_init</link> (void *error_buffer)</para>
<para > Initializes a gl_area. </para>
</listitem>
<listitem > <para > void <link linkend= "_graphics_8h_1a66c9c80dbf46ac2168827bf8a0dfb7ee" > graphics_draw</link> (const int graphics_stack_id)</para>
<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>
2024-10-20 01:05:12 +02:00
<para > Shutdowns a gl_area. </para>
2024-10-19 16:05:49 +02:00
</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>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</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>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</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>
2024-10-20 01:05:12 +02:00
<para > phantom documentation </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > void <link linkend= "_graphics_8h_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 > 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>
</listitem>
<listitem > <para > void <link linkend= "_graphics_8h_1aad0766ae2eda7ded12984d0061f1da89" > graphics_draw_line</link> (const int graphics_stack_id, GLuint a, GLuint b)</para>
2024-10-20 01:05:12 +02:00
<para > Writes values to describe a line from a to b into the line buffer. </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > void <link linkend= "_graphics_8h_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= "_graphics_8h_1a2be40f60f1a100f87730178ea20a5b6f" > graphics_draw_color</link> (const int graphics_stack_id, GLfloat r, GLfloat g, GLfloat b)</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= "_graphics_8h_1a76f5c593f1d55ebbc838437d9240ad8a" > graphics_model_setup</link> (const int graphics_stack_id)</para>
2024-10-20 01:05:12 +02:00
<para > graphics_model_setup </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_graphics_8h_1a9f1525659a25e5f22f6f864f77df0394" > graphics_draw_one_arrow_vertex</link> (const int graphics_stack_id, int space_X, int space_Y, int space_Z, int weight, int site, int x, int y, int z)</para>
<para > Draws one arrow vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
2024-10-19 16:05:49 +02:00
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_graphics_8h_1ac5b64ca813b8230a386db3f197773839" > graphics_draw_one_arrow_line</link> (const int graphics_stack_id, int offset_vertex)</para>
<para > Draws one arrow vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
2024-10-19 16:05:49 +02:00
</listitem>
<listitem > <para > int <link linkend= "_graphics_8h_1a79778df22a59f6bdfb2ef1be40999988" > graphics_draw_space_ridges_vertex</link> (const int graphics_stack_id, long offset_vertex, long x, long y, long z)</para>
<para > Writes grid ridges to vertex and color buffers. </para>
</listitem>
2024-10-20 01:05:12 +02:00
<listitem > <para > int <link linkend= "_graphics_8h_1ae06bc782cdd144a15166e1a3087ca07c" > graphics_draw_space_ridges_lines</link> (const int graphics_stack_id)</para>
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > draw_space_ridges_lines </para>
2024-10-19 16:05:49 +02:00
</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>
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
<para > phantom documentation used to test the functioning of doxygen </para>
</listitem>
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
</listitem>
</itemizedlist>
</simplesect>
<simplesect >
<title > Variables </title>
<itemizedlist >
<listitem > <para > struct <link linkend= "_structgraphics__stack__t" > graphics_stack_t</link> * <link linkend= "_graphics_8h_1ad2cd7fe4849c259e9dedcc6e7e795aaf" > graphics_stack</link> </para>
<para > Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</listitem>
</itemizedlist>
</simplesect>
<section >
<title > Detailed Description</title>
<para > graphics header </para>
<para > This file is part of Gem-graph. </para>
</section>
<section >
<title > Function Documentation</title>
<anchor xml:id= "_graphics_8h_1a66c9c80dbf46ac2168827bf8a0dfb7ee" /> <section >
<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 > Draws the current buffer to 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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry > </entry>
</row>
<row >
<entry > stack_id</entry> <entry >
<para > gl_area, ptr to the gl_area widget </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
2024-10-19 16:05:49 +02:00
</section>
<anchor xml:id= "_graphics_8h_1a2be40f60f1a100f87730178ea20a5b6f" /> <section >
<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 > Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console. </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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > r</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > g</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<row >
<entry > b</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console.</para>
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 23:03:17 +02:00
<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 >
<entry > b</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
</section>
<anchor xml:id= "_graphics_8h_1a4b522c9dc5b1ba15444956adb1c08cf5" /> <section >
<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 >
<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 > offset_vertex</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>
2024-10-19 16:05:49 +02:00
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > l </para>
2024-10-19 16:05:49 +02:00
</formalpara>
</para>
</section>
<anchor xml:id= "_graphics_8h_1aa0e0b868182a402d520d3443909bd40b" /> <section >
<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 > Writes grid lines on space faces. </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 >
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<row >
<entry > z</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > l</para>
2024-10-19 16:05:49 +02:00
</formalpara>
Writes grid lines on space faces. </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 >
2024-10-20 01:05:12 +02:00
<para > Writes values to describe a line from a to b into the line buffer. </para>
2024-10-19 16:05:49 +02:00
</para>
2024-10-20 01:05:12 +02:00
<para > @use liste de fonctions GTK</para>
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 01:05:12 +02:00
<entry > coords</entry> <entry >
<para > GLuint (a,b)</para>
</entry>
</row>
<row >
<entry > graphics_stack_id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > a</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > b</entry> <entry > </entry>
</row>
<row >
2024-10-20 23:03:17 +02:00
<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>
2024-10-19 16:05:49 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
</section>
<anchor xml:id= "_graphics_8h_1ac5b64ca813b8230a386db3f197773839" /> <section >
<title > graphics_draw_one_arrow_line()</title>
<indexterm > <primary > graphics_draw_one_arrow_line</primary> <secondary > graphics.h</secondary> </indexterm>
<indexterm > <primary > graphics.h</primary> <secondary > graphics_draw_one_arrow_line</secondary> </indexterm>
<para > <computeroutput > int graphics_draw_one_arrow_line (const int graphics_stack_id, int offset_vertex)</computeroutput> </para> <para >
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > Draws one arrow vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
</para>
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<row >
<entry > offset_vertex</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > i </para>
2024-10-19 16:05:49 +02:00
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
</section>
<anchor xml:id= "_graphics_8h_1a9f1525659a25e5f22f6f864f77df0394" /> <section >
<title > graphics_draw_one_arrow_vertex()</title>
<indexterm > <primary > graphics_draw_one_arrow_vertex</primary> <secondary > graphics.h</secondary> </indexterm>
<indexterm > <primary > graphics.h</primary> <secondary > graphics_draw_one_arrow_vertex</secondary> </indexterm>
<para > <computeroutput > int graphics_draw_one_arrow_vertex (const int graphics_stack_id, int space_X, int space_Y, int space_Z, int weight, int site, int x, int y, int z)</computeroutput> </para> <para >
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > Draws one arrow vertex (x, y, z) if (console) prints (x, y, z) values to console. </para>
</para>
<para >
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</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 > weight</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > site</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > i </para>
2024-10-19 16:05:49 +02:00
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
</section>
<anchor xml:id= "_graphics_8h_1afb83b572ba51cecca0db17db6d046546" /> <section >
<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 > Writes values to describe an (a,b,c) plan (triangle) into the plan buffer. </para>
</para>
2024-10-19 16:05:49 +02:00
<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 > coords</entry> <entry >
2024-10-20 01:05:12 +02:00
<para > GLuint (a,b,c)</para>
</entry>
</row>
<row >
<entry > graphics_stack_id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > a</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > b</entry> <entry >
<para > </para>
2024-10-20 23:03:17 +02:00
</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>
2024-10-20 01:05:12 +02:00
</entry>
</row>
<row >
<entry > c</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
2024-10-19 16:05:49 +02:00
</section>
2024-10-20 01:05:12 +02:00
<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 >
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > draw_space_ridges_lines </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry > </entry>
2024-10-19 16:05:49 +02:00
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > i</para>
2024-10-19 16:05:49 +02:00
</formalpara>
2024-10-20 01:05:12 +02:00
draw_space_ridges_lines </para>
2024-10-19 16:05:49 +02:00
</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 > Writes grid ridges to vertex and color buffers. </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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > offset_vertex</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > x</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > y</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<row >
<entry > z</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > i</para>
2024-10-19 16:05:49 +02:00
</formalpara>
Writes grid ridges to vertex and color buffers. </para>
</section>
<anchor xml:id= "_graphics_8h_1aa2c4ec98f5bf9942092ff385e9fac72f" /> <section >
<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 > Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console. </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 > GLfloat</entry> <entry >
<para > x, GLfloat y, GLfloat z</para>
</entry>
</row>
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console.</para>
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 23:03:17 +02:00
<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 >
<entry > z</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
2024-10-19 16:05:49 +02:00
</section>
<anchor xml:id= "_graphics_8h_1a5a4ed7438a755777b162fc37e84ba93a" /> <section >
<title > graphics_init()</title>
<indexterm > <primary > graphics_init</primary> <secondary > graphics.h</secondary> </indexterm>
<indexterm > <primary > graphics.h</primary> <secondary > graphics_init</secondary> </indexterm>
<para > <computeroutput > int graphics_init (void * error_buffer)</computeroutput> </para> <para >
<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 >
2024-10-20 01:05:12 +02:00
<entry > *error_buffer</entry> <entry >
<para > gl_area, ptr to the gl_area widget</para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 23:03:17 +02:00
<entry > *error_buffer</entry> <entry > </entry>
2024-10-19 16:05:49 +02:00
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 23:03:17 +02:00
<para > true if initialized </para>
2024-10-19 16:05:49 +02:00
</formalpara>
</para>
</section>
<anchor xml:id= "_graphics_8h_1aa86924f99e2a17fcb4e33b22b8987a95" /> <section >
<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 > Initializes the buffer of a gl_area Calls according to the user preferences. </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 > gl_area, ptr</entry> <entry >
2024-10-20 01:05:12 +02:00
<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 >
2024-10-20 23:03:17 +02:00
<entry > stack_id</entry> <entry > </entry>
2024-10-19 16:05:49 +02:00
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
2024-10-20 23:03:17 +02:00
gl_area, ptr to the gl_area widget </para>
2024-10-19 16:05:49 +02:00
</section>
<anchor xml:id= "_graphics_8h_1ac5ba153022c8589d2cd83442197e163e" /> <section >
<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 > Initializes the shaders of a gl_area and link them to a program. </para>
</para>
<para >
2024-10-20 01:05:12 +02:00
<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 > gl_area, ptr to the gl_area widget</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
<para > true if initialized</para>
</formalpara>
2024-10-19 16:05:49 +02:00
<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>
2024-10-20 23:03:17 +02:00
<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>
2024-10-19 16:05:49 +02:00
<para > true if initialized </para>
</formalpara>
</para>
</section>
<anchor xml:id= "_graphics_8h_1a76f5c593f1d55ebbc838437d9240ad8a" /> <section >
<title > graphics_model_setup()</title>
<indexterm > <primary > graphics_model_setup</primary> <secondary > graphics.h</secondary> </indexterm>
<indexterm > <primary > graphics.h</primary> <secondary > graphics_model_setup</secondary> </indexterm>
2024-10-20 01:05:12 +02:00
<para > <computeroutput > void graphics_model_setup (const int graphics_stack_id)</computeroutput> </para> <para >
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > graphics_model_setup </para>
2024-10-19 16:05:49 +02:00
</para>
2024-10-20 01:05:12 +02:00
<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>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
</para>
2024-10-19 16:05:49 +02:00
</section>
2024-10-20 01:05:12 +02:00
<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 >
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para > set_arrow </para>
2024-10-19 16:05:49 +02:00
</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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > arrows_nb</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<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>
2024-10-19 16:05:49 +02:00
</tbody>
</tgroup>
</table>
</para>
</formalpara>
<formalpara > <title > Returns</title>
2024-10-20 01:05:12 +02:00
<para > i </para>
2024-10-19 16:05:49 +02:00
</formalpara>
2024-10-20 01:05:12 +02:00
</para>
</section>
<anchor xml:id= "_graphics_8h_1ae99e9cf190970a730fdb3d8df8682188" /> <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>
<para > <computeroutput > bool graphics_shutdown (const int id, void * error_buffer)</computeroutput> </para> <para >
<para > Shutdowns a gl_area. </para>
</para>
2024-10-19 16:05:49 +02:00
2024-10-20 01:05:12 +02:00
<para >
2024-10-19 16:05:49 +02:00
<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 >
2024-10-20 01:05:12 +02:00
<entry > graphics_stack_id</entry> <entry >
<para > </para>
2024-10-19 16:05:49 +02:00
</entry>
</row>
2024-10-20 01:05:12 +02:00
<row >
<entry > *error_buffer</entry> <entry > </entry>
</row>
2024-10-19 16:05:49 +02:00
</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>
2024-10-20 23:03:17 +02:00
<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 > id</entry> <entry >
<para > </para>
</entry>
</row>
<row >
<entry > *error_buffer</entry> <entry > </entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</formalpara>
gl_area, ptr to the gl_area widget</para>
<para > <formalpara > <title > Returns</title>
2024-10-19 16:05:49 +02:00
<para > true if success </para>
</formalpara>
</para>
</section>
</section>
<section >
<title > Variable Documentation</title>
<anchor xml:id= "_graphics_8h_1ad2cd7fe4849c259e9dedcc6e7e795aaf" /> <section >
<title > graphics_stack</title>
<indexterm > <primary > graphics_stack</primary> <secondary > graphics.h</secondary> </indexterm>
<indexterm > <primary > graphics.h</primary> <secondary > graphics_stack</secondary> </indexterm>
<para > <computeroutput > struct <link linkend= "_structgraphics__stack__t" > graphics_stack_t</link> * graphics_stack<computeroutput > [extern]</computeroutput> </computeroutput> </para> <para >
<para > Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</para>
<para > Dynamic array of ptrs to dynamically allocated gl_area_entry. </para>
</section>
</section>
</section>
