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

131 lines
2.8 KiB
Groff

.TH "src/graphics/draw.c" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/graphics/draw.c \- graphics - general drawing functions
.SH SYNOPSIS
.br
.PP
\fC#include <cglm/cglm\&.h>\fP
.br
\fC#include '\&.\&./\&.\&./include/base\&.h'\fP
.br
\fC#include '\&.\&./\&.\&./include/graphics\&.h'\fP
.br
.SS "Functions"
.in +1c
.ti -1c
.RI "void \fBgraphics_draw_vertex\fP (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.br
.RI "Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_color\fP (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.br
.RI "Writes values to describe a color (r,g,b) into the color buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_line\fP (const int stack_id, GLuint a, GLuint b)"
.br
.RI "Writes values to describe a line from a to b into the line buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw_plan\fP (const int stack_id, GLuint a, GLuint b, GLuint c)"
.br
.RI "Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&. "
.ti -1c
.RI "void \fBgraphics_draw\fP (const int stack_id)"
.br
.RI "Draws the current buffer to a gl_area\&. "
.in -1c
.SH "Detailed Description"
.PP
graphics - general drawing functions
This file is part of Gem-graph\&.
.SH "Function Documentation"
.PP
.SS "void graphics_draw (const int stack_id)"
.PP
Draws the current buffer to a gl_area\&.
.PP
\fBParameters\fP
.RS 4
\fIgl_area,ptr\fP to the gl_area widget
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_color (const int stack_id, GLfloat r, GLfloat g, GLfloat b)"
.PP
Writes values to describe a color (r,g,b) into the color buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcolor\fP GLfloat(r,g,b)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_line (const int stack_id, GLuint a, GLuint b)"
.PP
Writes values to describe a line from a to b into the line buffer\&. Draws the color (r, g, b) associated to a vertex if (console) prints (r, g, b) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_plan (const int stack_id, GLuint a, GLuint b, GLuint c)"
.PP
Writes values to describe an (a,b,c) plan (triangle) into the plan buffer\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLuint (a,b,c)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SS "void graphics_draw_vertex (const int stack_id, GLfloat x, GLfloat y, GLfloat z)"
.PP
Writes values to describe a vertex at (x,y,z) intoq the vertex buffer\&. Draws a vertex (x, y, z) if (console) prints (x, y, z) values to console\&.
.PP
\fBParameters\fP
.RS 4
\fIcoords\fP GLfloat(x,y,z)
.RE
.PP
\fBReturns\fP
.RS 4
void
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Gem-graph from the source code\&.