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

152 lines
2.9 KiB
Groff
Raw Normal View History

.TH "src/graphics/init.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/graphics/init.c \- initialization and graphic stack management
.SH SYNOPSIS
.br
.PP
\fC#include '\&.\&./\&.\&./include/graphics\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./include/parse\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./include/util\&.h'\fP
.br
.SS "Macros"
.in +1c
.ti -1c
.RI "#define \fBTEST\fP 0"
.br
.RI "phantom documentation "
.in -1c
.SS "Functions"
.in +1c
.ti -1c
.RI "int \fBgraphics_init\fP (void *error_buffer)"
.br
.RI "Initializes a gl_area\&. "
.ti -1c
.RI "bool \fBgraphics_shutdown\fP (const int id, void *error_buffer)"
.br
.RI "Shutdowns a gl_area\&. "
.ti -1c
.RI "void \fBgraphics_model_setup\fP (const int graphics_stack_id)"
.br
2024-10-20 01:05:12 +02:00
.RI "graphics_model_setup "
.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 "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
.SS "Variables"
.in +1c
.ti -1c
.RI "struct \fBgraphics_stack_t\fP * \fBgraphics_stack\fP = NULL"
.br
.RI "phantom documentation "
.ti -1c
.RI "size_t \fBgraphics_stack_size\fP = 0"
.br
.RI "phantom documentation "
.ti -1c
.RI "int * \fBfree_stack_slot\fP = NULL"
.br
.RI "phantom documentation "
.ti -1c
.RI "size_t \fBfree_stack_slot_size\fP = 0"
.br
.RI "phantom documentation "
.in -1c
.SH "Detailed Description"
.PP
initialization and graphic stack management
This file is part of Gem-graph\&.
.SH "Function Documentation"
.PP
.SS "int graphics_init (void * error_buffer)"
.PP
Initializes a gl_area\&. param *error_buffer < DO NOT DOCUMENT (it's 'void')
.PP
\fBReturns\fP
.RS 4
true if initialized
.RE
.PP
.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
\fIgraphics_stack_id\fP
.RE
.PP
gl_area, ptr to the gl_area widget
.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
.RE
.PP
\fBReturns\fP
.RS 4
initialized
.RE
.PP
2024-10-20 01:05:12 +02:00
.SS "void graphics_model_setup (const int graphics_stack_id)"
.PP
2024-10-20 01:05:12 +02:00
graphics_model_setup
.PP
2024-10-20 01:05:12 +02:00
\fBParameters\fP
.RS 4
\fIgraphics_stack_id\fP
.RE
.PP
2024-10-20 01:05:12 +02:00
.SS "bool graphics_shutdown (const int id, void * error_buffer)"
.PP
2024-10-20 01:05:12 +02:00
Shutdowns a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIid\fP
.br
\fI*error_buffer\fP
.RE
.PP
\fBReturns\fP
.RS 4
success
.RE
.PP
.SH "Variable Documentation"
.PP
.SS "struct \fBgraphics_stack_t\fP* graphics_stack = NULL"
.PP
phantom documentation Dynamic array of ptrs to dynamically allocated gl_area_entry\&.
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.