mirror of
https://github.com/nishiowo/nishbox
synced 2025-04-21 20:24:39 +00:00
add comments
This commit is contained in:
parent
6dd7152746
commit
a4aca87b12
@ -1,3 +1,10 @@
|
||||
/**
|
||||
* Core of the engine
|
||||
*
|
||||
* Including this should (will) be enough for usual case,
|
||||
* at least in the future.
|
||||
*/
|
||||
|
||||
#ifndef __GF_CORE_H__
|
||||
#define __GF_CORE_H__
|
||||
|
||||
|
@ -1,3 +1,9 @@
|
||||
/**
|
||||
* Drawing interface
|
||||
*
|
||||
* Handles rendering.
|
||||
*/
|
||||
|
||||
#ifndef __GF_DRAW_H__
|
||||
#define __GF_DRAW_H__
|
||||
|
||||
|
@ -1,3 +1,9 @@
|
||||
/**
|
||||
* Renderer driver (e.g. OpenGL)
|
||||
*
|
||||
* Handles driver-specific parts, like lighting.
|
||||
*/
|
||||
|
||||
#ifndef __GF_DRAW_DRIVER_H__
|
||||
#define __GF_DRAW_DRIVER_H__
|
||||
|
||||
|
@ -1,3 +1,9 @@
|
||||
/**
|
||||
* Renderer backend (e.g. GLX)
|
||||
*
|
||||
* Provides the lowest layer for graphics.
|
||||
*/
|
||||
|
||||
#ifndef __GF_DRAW_PLATFORM_H__
|
||||
#define __GF_DRAW_PLATFORM_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Font
|
||||
*/
|
||||
|
||||
#ifndef __GF_FONT_H__
|
||||
#define __GF_FONT_H__
|
||||
|
||||
@ -10,6 +14,6 @@
|
||||
|
||||
/* Standard */
|
||||
|
||||
extern unsigned char gf_font[128][8];
|
||||
GF_EXPORT unsigned char gf_font[128][8];
|
||||
|
||||
#endif
|
||||
|
@ -1,3 +1,10 @@
|
||||
/**
|
||||
* Graphic
|
||||
*
|
||||
* Provides the function to draw textures, text, and etc for
|
||||
* GUI and 3D rendering.
|
||||
*/
|
||||
|
||||
#ifndef __GF_GRAPHIC_H__
|
||||
#define __GF_GRAPHIC_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* GUI
|
||||
*/
|
||||
|
||||
#ifndef __GF_GUI_H__
|
||||
#define __GF_GUI_H__
|
||||
|
||||
|
@ -1,3 +1,10 @@
|
||||
/**
|
||||
* Log
|
||||
*
|
||||
* Provides useful function/macro for logging.
|
||||
* Uses the graphical console if possible.
|
||||
*/
|
||||
|
||||
#ifndef __GF_LOG_H__
|
||||
#define __GF_LOG_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Macro
|
||||
*/
|
||||
|
||||
#ifndef __GF_MACRO_H__
|
||||
#define __GF_MACRO_H__
|
||||
|
||||
|
@ -1,3 +1,10 @@
|
||||
/**
|
||||
* Math
|
||||
*
|
||||
* Provides the functions missing in C89, and ones useful
|
||||
* for 3D stuffs.
|
||||
*/
|
||||
|
||||
#ifndef __GF_MATH_H__
|
||||
#define __GF_MATH_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Mesh
|
||||
*/
|
||||
|
||||
#ifndef __GF_MESH_H__
|
||||
#define __GF_MESH_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Model
|
||||
*/
|
||||
|
||||
#ifndef __GF_MODEL_H__
|
||||
#define __GF_MODEL_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Physics
|
||||
*/
|
||||
|
||||
#ifndef __GF_PHYSICS_H__
|
||||
#define __GF_PHYSICS_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* File which should be included before anything
|
||||
*/
|
||||
|
||||
#ifndef __GF_PRE_H__
|
||||
#define __GF_PRE_H__
|
||||
|
||||
|
@ -1,3 +1,9 @@
|
||||
/**
|
||||
* Texture
|
||||
*
|
||||
* Provides a wrapper for drawing driver.
|
||||
*/
|
||||
|
||||
#ifndef __GF_TEXTURE_H__
|
||||
#define __GF_TEXTURE_H__
|
||||
|
||||
|
@ -1,3 +1,9 @@
|
||||
/**
|
||||
* Thread
|
||||
*
|
||||
* Wrapper for platform-dependent thread.
|
||||
*/
|
||||
|
||||
#ifndef __GF_THREAD_H__
|
||||
#define __GF_THREAD_H__
|
||||
|
||||
|
@ -1,3 +1,7 @@
|
||||
/**
|
||||
* Version
|
||||
*/
|
||||
|
||||
#ifndef __GF_VERSION_H__
|
||||
#define __GF_VERSION_H__
|
||||
|
||||
|
@ -2,6 +2,7 @@
|
||||
|
||||
/* Engine */
|
||||
#include <gf_core.h>
|
||||
#include <gf_draw.h>
|
||||
#include <gf_graphic.h>
|
||||
#include <gf_version.h>
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user