gem-graph-client/doc/rtfm/man3/gl.c.3

.TH "src/util/draw/gl.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/util/draw/gl.c \- general drawing functions  

.SH SYNOPSIS
.br
.PP
\fC#include '\&.\&./\&.\&./\&.\&./include/graphics\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./\&.\&./include/signal\&.h'\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "struct \fBstack_index_t\fP"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBGL_AREA_SIZE\fP   400"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "int \fButil_gl_set_arrow\fP (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)"
.br
.RI "phantom documentation "
.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_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\&. "
.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\&. "
.ti -1c
.RI "bool \fButil_gl_setup_glarea\fP (int target_mode, GtkWidget *target_widget)"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "size_t \fBstack_index_size\fP = 0"
.br
.RI "phantom documentation used to test the functioning of doxygen "
.in -1c
.SH "Detailed Description"
.PP 
general drawing functions 

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 meaning which axis we're building (for label)
.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
\fI*container_widget\fP 
.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
\fI*container_widget\fP 
.br
\fI*error_buffer\fP 
.RE
.PP
\fBReturns\fP
.RS 4
success 
.RE
.PP

.SS "long util_gl_is_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
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 "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)"

.PP
phantom documentation 
.PP
\fBParameters\fP
.RS 4
\fIstack_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
\fIarrow_x\fP 
.br
\fIarrow_y\fP 
.br
\fIarrow_z\fP 
.RE
.PP
returns int 
.SS "void util_gl_shutdown_all_stacks (void)"

.PP
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
Look for stack entry and shutdowns OpenGL for it\&. 
.PP
\fBParameters\fP
.RS 4
\fI*container_widget\fP 
.br
\fI*error_buffer\fP 
.RE
.PP
\fBReturns\fP
.RS 4
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
\fI*container_widget\fP 
.br
\fIaxis\fP 
.br
\fIvalue\fP 
.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\&.