fries/GRRLIB
1
0
Fork 0
mirror of https://github.com/GRRLIB/GRRLIB.git synced 2024-09-20 12:45:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

[CHG] Documentation improvement

Browse source
This commit is contained in:
Crayon2000 2009-02-09 23:27:39 +00:00
parent 67ab9e9829
commit 108103ea2c
3 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
template/source/GRRLIB/GRRLIB.c
View file

@ -406,6 +406,7 @@ inline void GRRLIB_DrawTile(f32 xpos, f32 ypos, GRRLIB_texImg tex, float degrees
* @param tex * @param tex
* @param color * @param color
* @param zoom * @param zoom
* @param text
* @param ... Optional arguments. * @param ... Optional arguments.
*/ */
void GRRLIB_Printf(f32 xpos, f32 ypos, GRRLIB_texImg tex, u32 color, f32 zoom, const char *text, ...) { void GRRLIB_Printf(f32 xpos, f32 ypos, GRRLIB_texImg tex, u32 color, f32 zoom, const char *text, ...) {
@ -511,7 +512,7 @@ void GRRLIB_FlushTex(GRRLIB_texImg tex)
* Change a texture to gray scale. * Change a texture to gray scale.
* @see GRRLIB_FlushTex * @see GRRLIB_FlushTex
* @param texsrc the texture source. * @param texsrc the texture source.
* @param texdst the texture grayscaled destination. * @param texdest the texture grayscaled destination.
*/ */
void GRRLIB_BMFX_GrayScale(GRRLIB_texImg texsrc, GRRLIB_texImg texdest) { void GRRLIB_BMFX_GrayScale(GRRLIB_texImg texsrc, GRRLIB_texImg texdest) {
unsigned int x, y; unsigned int x, y;
@ -534,7 +535,7 @@ void GRRLIB_BMFX_GrayScale(GRRLIB_texImg texsrc, GRRLIB_texImg texdest) {
* A texture effect. * A texture effect.
* @see GRRLIB_FlushTex * @see GRRLIB_FlushTex
* @param texsrc the texture source. * @param texsrc the texture source.
* @param texdst the texture grayscaled destination. * @param texdest the texture grayscaled destination.
* @param factor The factor level of the effect. * @param factor The factor level of the effect.
*/ */
void GRRLIB_BMFX_Scatter(GRRLIB_texImg texsrc, GRRLIB_texImg texdest, int factor) { void GRRLIB_BMFX_Scatter(GRRLIB_texImg texsrc, GRRLIB_texImg texdest, int factor) {
@ -563,6 +564,7 @@ void GRRLIB_BMFX_Scatter(GRRLIB_texImg texsrc, GRRLIB_texImg texdest, int factor
* *
* @param v * @param v
* @param color * @param color
* @param n
* @param fmt * @param fmt
*/ */
void GRRLIB_GXEngine(Vector v[], u32 color, long n, u8 fmt) { void GRRLIB_GXEngine(Vector v[], u32 color, long n, u8 fmt) {

10
template/source/GRRLIB/GRRLIB.h
View file

@ -25,11 +25,11 @@
typedef struct GRRLIB_texImg{ typedef struct GRRLIB_texImg{
unsigned int w; /**< width of the texture. */ unsigned int w; /**< width of the texture. */
unsigned int h; /**< height of the texture. */ unsigned int h; /**< height of the texture. */
unsigned int tilew; /**< tilew widht of a tile. */ unsigned int tilew; /**< widht of a tile. */
unsigned int tileh; /**< tileh height of a tile. */ unsigned int tileh; /**< height of a tile. */
unsigned int nbtilew; /**< nbtilew number of tiles for the x axis. */ unsigned int nbtilew; /**< number of tiles for the x axis. */
unsigned int nbtileh; /**< nbtileh number of tiles for the y axis. */ unsigned int nbtileh; /**< number of tiles for the y axis. */
unsigned int tilestart; /**< */ unsigned int tilestart; /**< offset for starting position. */
void *data; /**< pointer to the texture data. */ void *data; /**< pointer to the texture data. */
} GRRLIB_texImg; } GRRLIB_texImg;

1
template/source/main.c
View file

@ -226,6 +226,7 @@ int main() {
/** /**
* This function calculates the number of frames we render each second. * This function calculates the number of frames we render each second.
* It must be called right after GRRLIB_Render.
* @return The number of frames per second. * @return The number of frames per second.
*/ */
static u8 CalculateFrameRate() { static u8 CalculateFrameRate() {