130 lines
2.0 KiB
Groff
130 lines
2.0 KiB
Groff
.TH "include/base.h" 3 "Version 0.1.0" "Gem-graph" \" -*- nroff -*-
|
|
.ad l
|
|
.nh
|
|
.SH NAME
|
|
include/base.h \- base header
|
|
|
|
.SH SYNOPSIS
|
|
.br
|
|
.PP
|
|
\fC#include <assert\&.h>\fP
|
|
.br
|
|
\fC#include <errno\&.h>\fP
|
|
.br
|
|
\fC#include <fcntl\&.h>\fP
|
|
.br
|
|
\fC#include <math\&.h>\fP
|
|
.br
|
|
\fC#include <stdio\&.h>\fP
|
|
.br
|
|
\fC#include <stdlib\&.h>\fP
|
|
.br
|
|
\fC#include <stddef\&.h>\fP
|
|
.br
|
|
\fC#include <stdbool\&.h>\fP
|
|
.br
|
|
\fC#include <sys/types\&.h>\fP
|
|
.br
|
|
\fC#include <sys/stat\&.h>\fP
|
|
.br
|
|
\fC#include <unistd\&.h>\fP
|
|
.br
|
|
\fC#include <time\&.h>\fP
|
|
.br
|
|
\fC#include <string\&.h>\fP
|
|
.br
|
|
\fC#include <glib\-2\&.0/glib\&.h>\fP
|
|
.br
|
|
\fC#include <gtk\-4\&.0/gtk/gtk\&.h>\fP
|
|
.br
|
|
|
|
.SS "Classes"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "struct \fBarrow_t\fP"
|
|
.br
|
|
.RI "defines an arrow address "
|
|
.in -1c
|
|
.SS "Macros"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "#define \fBEAST\fP 0"
|
|
.br
|
|
.RI "If I'm standing on Earth (or any spinning spheroid), looking towards its North pole\&. "
|
|
.ti -1c
|
|
.RI "#define \fBWEST\fP 1"
|
|
.br
|
|
.ti -1c
|
|
.RI "#define \fBZENITH\fP 2"
|
|
.br
|
|
.ti -1c
|
|
.RI "#define \fBNADIR\fP 3"
|
|
.br
|
|
.ti -1c
|
|
.RI "#define \fBSOUTH\fP 4"
|
|
.br
|
|
.ti -1c
|
|
.RI "#define \fBNORTH\fP 5"
|
|
.br
|
|
.in -1c
|
|
.SS "Enumerations"
|
|
|
|
.in +1c
|
|
.ti -1c
|
|
.RI "enum { \fBX_AXIS\fP, \fBY_AXIS\fP, \fBZ_AXIS\fP, \fBN_AXIS\fP }"
|
|
.br
|
|
.RI "used by \fBgraphics\&.h\fP "
|
|
.in -1c
|
|
.SH "Detailed Description"
|
|
.PP
|
|
base header
|
|
|
|
This file is part of Gem-graph\&.
|
|
.SH "Macro Definition Documentation"
|
|
.PP
|
|
.SS "#define EAST 0"
|
|
|
|
.PP
|
|
If I'm standing on Earth (or any spinning spheroid), looking towards its North pole\&. Then :
|
|
.PP
|
|
X - X = EAST - WEST = red - cyan Y - Y = ZENITH - NADIR = green - magenta (fuschia) Z - Z = NORTH - SOUTH = blue - yellow
|
|
.IP "\(bu" 2
|
|
x red
|
|
.PP
|
|
|
|
.SS "#define NADIR 3"
|
|
|
|
.IP "\(bu" 2
|
|
y magenta
|
|
.PP
|
|
|
|
.SS "#define NORTH 5"
|
|
|
|
.IP "\(bu" 2
|
|
z yellow
|
|
.PP
|
|
|
|
.SS "#define SOUTH 4"
|
|
|
|
.IP "\(bu" 2
|
|
z blue
|
|
.PP
|
|
|
|
.SS "#define WEST 1"
|
|
|
|
.IP "\(bu" 2
|
|
x cyan
|
|
.PP
|
|
|
|
.SS "#define ZENITH 2"
|
|
|
|
.IP "\(bu" 2
|
|
y green
|
|
.PP
|
|
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Gem-graph from the source code\&.
|