284 lines
6.1 KiB
Groff
284 lines
6.1 KiB
Groff
|
.TH "include/util.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
||
|
|
.ad l
|
||
|
|
.nh
|
||
|
|
.SH NAME
|
||
|
|
include/util.h \- utilities header
|
||
|
|
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.br
|
||
|
|
.PP
|
||
|
|
\fC#include <stdbool\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <stddef\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
|
||
|
|
.br
|
||
|
|
\fC#include '\&.\&./include/fsm\&.h'\fP
|
||
|
|
.br
|
||
|
|
|
||
|
|
.SS "Classes"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBpile\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBelem\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBdblist\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "struct \fBslist\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.in -1c
|
||
|
|
.SS "Typedefs"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "typedef struct \fBpile\fP \fBpile\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "typedef struct \fBelem\fP \fBelem\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "typedef struct \fBslist\fP \fBslist\fP"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.in -1c
|
||
|
|
.SS "Functions"
|
||
|
|
|
||
|
|
.in +1c
|
||
|
|
.ti -1c
|
||
|
|
.RI "char * \fButil_read_file\fP (char *filename)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "char * \fButil_concat\fP (const char *str,\&.\&.\&.)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_pile_clear\fP (\fBpile\fP **)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_pile_view\fP (\fBpile\fP *)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_pile_push\fP (\fBpile\fP **, int)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_pile_pop\fP (\fBpile\fP **)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_pile_length\fP (\fBpile\fP *p)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_list_2x2_init\fP (\fBdblist\fP *l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_list_2x2_clear\fP (\fBdblist\fP *l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_list_2x2_view\fP (\fBdblist\fP l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_list_2x2_push_back\fP (\fBdblist\fP *l, int val)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_list_2x2_push_front\fP (\fBdblist\fP *l, int val)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_list_2x2_pop_back\fP (\fBdblist\fP *l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_list_2x2_pop_front\fP (\fBdblist\fP *l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_list_2x2_length\fP (\fBdblist\fP l)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_sorted_list_clear\fP (\fBslist\fP **sl)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_sorted_list_view\fP (\fBslist\fP *sl)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_sorted_list_insert\fP (\fBslist\fP **sl, int val)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_sorted_list_pop\fP (\fBslist\fP **sl)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "int \fButil_sorted_list_length\fP (\fBslist\fP *sl)"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_trigger_test\fP ()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_test_pile\fP ()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_test_double_list\fP ()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_test_sorted_list\fP ()"
|
||
|
|
.br
|
||
|
|
.ti -1c
|
||
|
|
.RI "long \fButil_gl_get_stack\fP (void *container_widget)"
|
||
|
|
.br
|
||
|
|
.RI "Look for stack entry and returns stack_id\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "long \fButil_gl_is_util_ready\fP (void *container_widget)"
|
||
|
|
.br
|
||
|
|
.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\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fButil_gl_shutdown_stack\fP (void *container_widget, GError *error_buffer)"
|
||
|
|
.br
|
||
|
|
.RI "Look for stack entry and shutdowns OpenGL for it\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_gl_clean_stack_index\fP (void)"
|
||
|
|
.br
|
||
|
|
.RI "phantom documentation used to test the functioning of doxygen "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fButil_gl_render_stack\fP (GtkWidget *container_widget)"
|
||
|
|
.br
|
||
|
|
.RI "Look for stack entry and triggers OpenGL for drawing\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "bool \fButil_gl_update_axis\fP (GtkWidget *container_widget, int axis, int value)"
|
||
|
|
.br
|
||
|
|
.RI "Look for stack entry and triggers OpenGL for drawing\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "void \fButil_gl_shutdown_all_stacks\fP (void)"
|
||
|
|
.br
|
||
|
|
.RI "Look for every stack entry and shutdowns OpenGL for it\&. "
|
||
|
|
.ti -1c
|
||
|
|
.RI "GtkWidget * \fBcreate_axis_slider\fP (int axis)"
|
||
|
|
.br
|
||
|
|
.RI "Creates a slider widget\&. "
|
||
|
|
.in -1c
|
||
|
|
.SH "Detailed Description"
|
||
|
|
.PP
|
||
|
|
utilities header
|
||
|
|
|
||
|
|
This file is part of Gem-graph\&.
|
||
|
|
.SH "Function Documentation"
|
||
|
|
.PP
|
||
|
|
.SS "GtkWidget * create_axis_slider (int axis)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Creates a slider widget\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIaxis\fP the axis we're building a label for
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
GtkWidget*: pointer to the new widget
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "long util_gl_get_stack (void * container_widget)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Look for stack entry and returns stack_id\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
stack_id
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool util_gl_init_stack (void * container_widget, GError * error_buffer)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Look for stack entry and initializes OpenGL for it\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
|
||
|
|
.br
|
||
|
|
\fIerror_buffer\fP phantom documentation used to test the functioning of doxygen
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool: true if success
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool util_gl_render_stack (GtkWidget * container_widget)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Look for stack entry and triggers OpenGL for drawing\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool: true if success
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.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 ?
|
||
|
|
.SS "bool util_gl_shutdown_stack (void * container_widget, GError * error_buffer)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Look for stack entry and shutdowns OpenGL for it\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
|
||
|
|
.br
|
||
|
|
\fIerror_buffer\fP phantom documentation used to test the functioning of doxygen
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool: true if success
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SS "bool util_gl_update_axis (GtkWidget * container_widget, int axis, int value)"
|
||
|
|
|
||
|
|
.PP
|
||
|
|
Look for stack entry and triggers OpenGL for drawing\&.
|
||
|
|
.PP
|
||
|
|
\fBParameters\fP
|
||
|
|
.RS 4
|
||
|
|
\fIcontainer_widget\fP generally the GtkBox that contains the GLArea
|
||
|
|
.br
|
||
|
|
\fIaxis\fP phantom documentation used to test the functioning of doxygen
|
||
|
|
.br
|
||
|
|
\fIvalue\fP phantom documentation used to test the functioning of doxygen
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
\fBReturns\fP
|
||
|
|
.RS 4
|
||
|
|
bool: true if success
|
||
|
|
.RE
|
||
|
|
.PP
|
||
|
|
|
||
|
|
.SH "Author"
|
||
|
|
.PP
|
||
|
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|