fries/GRRLIB
1
0
Fork 0
mirror of https://github.com/GRRLIB/GRRLIB.git synced 2024-11-22 15:02:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

[CHG] Documentation improvement

Browse source
This commit is contained in:
Crayon2000 2009-02-25 19:37:42 +00:00
parent 46c91a7703
commit 82532896e5
2 changed files with 29 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
GRRLIB/GRRLIB/GRRLIB.c
View file

@ -87,7 +87,7 @@ inline void GRRLIB_Rectangle(f32 x, f32 y, f32 width, f32 height, u32 color, u8
} }
/** /**
* * Draw a polygon.
* @param v * @param v
* @param color * @param color
* @param n * @param n
@ -97,7 +97,7 @@ void GRRLIB_NGone(Vector v[], u32 color, long n) {
} }
/** /**
* * Draw a filled polygon.
* @param v * @param v
* @param color * @param color
* @param n * @param n
@ -107,7 +107,7 @@ void GRRLIB_NGoneFilled(Vector v[], u32 color, long n) {
} }
/** /**
* * Initialize a tile set.
* @param tex * @param tex
* @param tilew * @param tilew
* @param tileh * @param tileh
@ -245,8 +245,7 @@ GRRLIB_texImg GRRLIB_LoadTextureJPG(const unsigned char my_jpg[]) {
* Print formatted output. * Print formatted output.
* @param xpos * @param xpos
* @param ypos * @param ypos
* @param tex * @param bmf
* @param color
* @param zoom * @param zoom
* @param text * @param text
* @param ... Optional arguments. * @param ... Optional arguments.
@ -520,12 +519,12 @@ inline void GRRLIB_DrawTile(f32 xpos, f32 ypos, GRRLIB_texImg tex, float degrees
/** /**
* Print formatted output. * Print formatted output.
* @param xpos * @param xpos specifies the x-coordinate of the upper-left corner of the text.
* @param ypos * @param ypos specifies the y-coordinate of the upper-left corner of the text.
* @param tex * @param tex texture containing the character set.
* @param color * @param color text color in RGBA format. The alpha channel is used to change the opacity of the text.
* @param zoom * @param zoom this is a factor by which the text size will be increase or decrease.
* @param text * @param text text to draw.
* @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, ...) {
@ -559,14 +558,14 @@ bool GRRLIB_PtInRect(int hotx, int hoty, int hotw, int hoth, int wpadx, int wpad
/** /**
* Determines whether a specified rectangle lies within another rectangle. * Determines whether a specified rectangle lies within another rectangle.
* @param rect1x * @param rect1x specifies the x-coordinate of the upper-left corner of the rectangle.
* @param rect1y * @param rect1y specifies the y-coordinate of the upper-left corner of the rectangle.
* @param rect1w * @param rect1w specifies the width of the rectangle.
* @param rect1h * @param rect1h specifies the height of the rectangle.
* @param rect2x * @param rect2x specifies the x-coordinate of the upper-left corner of the rectangle.
* @param rect2y * @param rect2y specifies the y-coordinate of the upper-left corner of the rectangle.
* @param rect2w * @param rect2w specifies the width of the rectangle.
* @param rect2h * @param rect2h specifies the height of the rectangle.
* @return If the specified rectangle lies within the other rectangle, the return value is true otherwise it's false. * @return If the specified rectangle lies within the other rectangle, the return value is true otherwise it's false.
*/ */
bool GRRLIB_RectInRect(int rect1x, int rect1y, int rect1w, int rect1h, int rect2x, int rect2y, int rect2w, int rect2h) { bool GRRLIB_RectInRect(int rect1x, int rect1y, int rect1w, int rect1h, int rect2x, int rect2y, int rect2w, int rect2h) {
@ -576,14 +575,14 @@ bool GRRLIB_RectInRect(int rect1x, int rect1y, int rect1w, int rect1h, int rect2
/** /**
* Determines whether a part of a specified rectangle lies on another rectangle. * Determines whether a part of a specified rectangle lies on another rectangle.
* @param rect1x * @param rect1x specifies the x-coordinate of the upper-left corner of the first rectangle.
* @param rect1y * @param rect1y specifies the y-coordinate of the upper-left corner of the first rectangle.
* @param rect1w * @param rect1w specifies the width of the first rectangle.
* @param rect1h * @param rect1h specifies the height of the first rectangle.
* @param rect2x * @param rect2x specifies the x-coordinate of the upper-left corner of the second rectangle.
* @param rect2y * @param rect2y specifies the y-coordinate of the upper-left corner of the second rectangle.
* @param rect2w * @param rect2w specifies the width of the second rectangle.
* @param rect2h * @param rect2h specifies the height of the second rectangle.
* @return If the specified rectangle lies on the other rectangle, the return value is true otherwise it's false. * @return If the specified rectangle lies on the other rectangle, the return value is true otherwise it's false.
*/ */
bool GRRLIB_RectOnRect(int rect1x, int rect1y, int rect1w, int rect1h, int rect2x, int rect2y, int rect2w, int rect2h) { bool GRRLIB_RectOnRect(int rect1x, int rect1y, int rect1w, int rect1h, int rect2x, int rect2y, int rect2w, int rect2h) {

6
GRRLIB/GRRLIB/GRRLIB.h
View file

@ -40,8 +40,8 @@ typedef struct GRRLIB_bytemapChar{
u8 character; /**< Which character. */ u8 character; /**< Which character. */
u8 width; /**< Character width. */ u8 width; /**< Character width. */
u8 height; /**< Character height. */ u8 height; /**< Character height. */
s8 relx; /**< Horizontal offset according to cursor (-128..127). */ s8 relx; /**< Horizontal offset according to cursor (-128 to 127). */
s8 rely; /**< Vertical offset according to cursor (-128..127). */ s8 rely; /**< Vertical offset according to cursor (-128 to 127). */
u8 shift; /**< Horizontal cursor shift after drawing the character. */ u8 shift; /**< Horizontal cursor shift after drawing the character. */
u8 *data; /**< Character data itself (uncompressed, 8 bits per pixel). */ u8 *data; /**< Character data itself (uncompressed, 8 bits per pixel). */
} GRRLIB_bytemapChar; } GRRLIB_bytemapChar;
@ -51,7 +51,7 @@ typedef struct GRRLIB_bytemapChar{
*/ */
typedef struct GRRLIB_bytemapFont{ typedef struct GRRLIB_bytemapFont{
u8 version; /**< Version. */ u8 version; /**< Version. */
s8 addSpace; /**< Add-space after each char (-128..127). */ s8 addSpace; /**< Add-space after each char (-128 to 127). */
u32 *palette; /**< Font palette. */ u32 *palette; /**< Font palette. */
char *name; /**< Font name. */ char *name; /**< Font name. */
u16 nbChar; /**< Number of characters in font. */ u16 nbChar; /**< Number of characters in font. */