gem-graph-client/doc/docbook/da/d0c/gl_8c.xml

<?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="_gl_8c" xml:lang="en-US">
<title>src/util/draw/gl.c File Reference</title>
<indexterm><primary>src/util/draw/gl.c</primary></indexterm>
<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>
    <title>Classes    </title>
        <itemizedlist>
            <listitem><para>struct <link linkend="_structstack__index__t">stack_index_t</link></para>

<para>phantom documentation </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Macros    </title>
        <itemizedlist>
            <listitem><para><anchor xml:id="_gl_8c_1a2737fdf992bd5a9d008f620ddaf50107"/>#define <emphasis role="strong">GL_AREA_SIZE</emphasis>&#160;&#160;&#160;400</para>

<para>phantom documentation </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para>int <link linkend="_gl_8c_1a289cfe9a70bcb690eeff2639dd8a98cd">util_gl_set_arrow</link> (int 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>phantom documentation </para>
</listitem>
            <listitem><para>long <link linkend="_gl_8c_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="_gl_8c_1a5a691fdca6e3088ea9c1927096541624">util_gl_is_ready</link> (void *container_widget)</para>

<para>Look for stack entry and returns stack_id. </para>
</listitem>
            <listitem><para>bool <link linkend="_gl_8c_1a28b44187c7ae713705874288323e10a6">util_gl_init_stack</link> (void *container_widget, GError *error_buffer)</para>

<para>Look for stack entry and initializes OpenGL for it. </para>
</listitem>
            <listitem><para>bool <link linkend="_gl_8c_1a9d41985e1832e0a798e722d2341752f1">util_gl_shutdown_stack</link> (void *container_widget, GError *error_buffer)</para>

<para>Look for stack entry and shutdowns OpenGL for it. </para>
</listitem>
            <listitem><para><anchor xml:id="_gl_8c_1ab0a523986944f809fac9acc1693f3029"/>void <emphasis role="strong">util_gl_clean_stack_index</emphasis> (void)</para>

<para>phantom documentation </para>
</listitem>
            <listitem><para>bool <link linkend="_gl_8c_1a8132a1a797f4f12eaff04b4c3610f054">util_gl_render_stack</link> (GtkWidget *container_widget)</para>

<para>Look for stack entry and triggers OpenGL for drawing. </para>
</listitem>
            <listitem><para>bool <link linkend="_gl_8c_1ad830e66002a24806e3617946dc988e95">util_gl_update_axis</link> (GtkWidget *container_widget, int axis, int value)</para>

<para>Look for stack entry and triggers OpenGL for drawing. </para>
</listitem>
            <listitem><para>void <link linkend="_gl_8c_1ae2198c050662c486c8e66c6e6b5a7e0b">util_gl_shutdown_all_stacks</link> (void)</para>

<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</listitem>
            <listitem><para>GtkWidget * <link linkend="_gl_8c_1a2cb205bd6556250d019b4de59eee3894">create_axis_slider</link> (int axis)</para>

<para>Creates a slider widget. </para>
</listitem>
            <listitem><para><anchor xml:id="_gl_8c_1ac90dc30613c94fdefedb76cf6d2c4ac8"/>bool <emphasis role="strong">util_gl_setup_glarea</emphasis> (int target_mode, GtkWidget *target_widget)</para>

<para>phantom documentation </para>
</listitem>
        </itemizedlist>
</simplesect>
<simplesect>
    <title>Variables    </title>
        <itemizedlist>
            <listitem><para><anchor xml:id="_gl_8c_1a176a1af12ef0fb33a5de5cd36ef7145a"/>size_t <emphasis role="strong">stack_index_size</emphasis> = 0</para>

<para>phantom documentation </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>general drawing functions </para>

<para>This file is part of Gem-graph.</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_gl_8c_1a2cb205bd6556250d019b4de59eee3894"/><section>
    <title>create_axis_slider()</title>
<indexterm><primary>create_axis_slider</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>create_axis_slider</secondary></indexterm>
<para><computeroutput>GtkWidget * create_axis_slider (int axis)</computeroutput></para><para>

<para>Creates a slider widget. </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>axis</entry><entry>
<para>meaning which axis we&apos;re building (for label)</para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>GtkWidget* pointer to the new widget </para>
</formalpara>
</para>
</section>
<anchor xml:id="_gl_8c_1adbe03a3d239b22390e9de809443c8df9"/><section>
    <title>util_gl_get_stack()</title>
<indexterm><primary>util_gl_get_stack</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_get_stack</secondary></indexterm>
<para><computeroutput>long util_gl_get_stack (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></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>stack_id </para>
</formalpara>
</para>
</section>
<anchor xml:id="_gl_8c_1a28b44187c7ae713705874288323e10a6"/><section>
    <title>util_gl_init_stack()</title>
<indexterm><primary>util_gl_init_stack</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_init_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_init_stack (void * container_widget, GError * error_buffer)</computeroutput></para><para>

<para>Look for stack entry and initializes 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>*container_widget</entry><entry></entry>
                            </row>
                            <row>
<entry>*error_buffer</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_gl_8c_1a5a691fdca6e3088ea9c1927096541624"/><section>
    <title>util_gl_is_ready()</title>
<indexterm><primary>util_gl_is_ready</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_is_ready</secondary></indexterm>
<para><computeroutput>long util_gl_is_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="_gl_8c_1a8132a1a797f4f12eaff04b4c3610f054"/><section>
    <title>util_gl_render_stack()</title>
<indexterm><primary>util_gl_render_stack</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_render_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_render_stack (GtkWidget * container_widget)</computeroutput></para><para>

<para>Look for stack entry and triggers OpenGL for drawing. </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>bool: true if success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_gl_8c_1a289cfe9a70bcb690eeff2639dd8a98cd"/><section>
    <title>util_gl_set_arrow()</title>
<indexterm><primary>util_gl_set_arrow</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_set_arrow</secondary></indexterm>
<para><computeroutput>int util_gl_set_arrow (int 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>phantom documentation </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>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>arrow_x</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>arrow_y</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>arrow_z</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                returns int </para>
</section>
<anchor xml:id="_gl_8c_1ae2198c050662c486c8e66c6e6b5a7e0b"/><section>
    <title>util_gl_shutdown_all_stacks()</title>
<indexterm><primary>util_gl_shutdown_all_stacks</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_shutdown_all_stacks</secondary></indexterm>
<para><computeroutput>void util_gl_shutdown_all_stacks (void )</computeroutput></para><para>

<para>Look for every stack entry and shutdowns OpenGL for it. </para>
</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>
<indexterm><primary>util_gl_shutdown_stack</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_shutdown_stack</secondary></indexterm>
<para><computeroutput>bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)</computeroutput></para><para>

<para>Look for 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>*container_widget</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>*error_buffer</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>success </para>
</formalpara>
</para>
</section>
<anchor xml:id="_gl_8c_1ad830e66002a24806e3617946dc988e95"/><section>
    <title>util_gl_update_axis()</title>
<indexterm><primary>util_gl_update_axis</primary><secondary>gl.c</secondary></indexterm>
<indexterm><primary>gl.c</primary><secondary>util_gl_update_axis</secondary></indexterm>
<para><computeroutput>bool util_gl_update_axis (GtkWidget * container_widget, int axis, int value)</computeroutput></para><para>

<para>Look for stack entry and triggers OpenGL for drawing. </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></para>
</entry>
                            </row>
                            <row>
<entry>axis</entry><entry>
<para></para>
</entry>
                            </row>
                            <row>
<entry>value</entry><entry></entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                <formalpara><title>Returns</title>

<para>bool: true if success </para>
</formalpara>
</para>
</section>
</section>
</section>