mirror of
https://github.com/GRRLIB/GRRLIB.git
synced 2024-11-21 22:42:20 +00:00
[CHG] Improve documentation a bit
This commit is contained in:
parent
607a2e1966
commit
a932d3ad7c
4 changed files with 10 additions and 8 deletions
|
@ -40,7 +40,7 @@ static void *gp_fifo = NULL;
|
|||
static bool is_setup = false; // To control entry and exit
|
||||
|
||||
/**
|
||||
* Initialize GRRLIB. Call this at the beginning your code.
|
||||
* Initialize GRRLIB. Call this once at the beginning your code.
|
||||
* @return int 0=OK; -1=NoMemory; -2=NoFilingSystem
|
||||
* @see GRRLIB_Exit
|
||||
*/
|
||||
|
|
|
@ -101,16 +101,16 @@ typedef struct GRRLIB_drawSettings {
|
|||
* Structure to hold the texture information.
|
||||
*/
|
||||
typedef struct GRRLIB_texImg {
|
||||
uint w; /**< Texture width. */
|
||||
uint h; /**< Texture height. */
|
||||
uint w; /**< The width of the texture in pixels. */
|
||||
uint h; /**< The height of the texture in pixels. */
|
||||
int handlex; /**< Texture handle x. */
|
||||
int handley; /**< Texture handle y. */
|
||||
int offsetx; /**< Texture offset x. */
|
||||
int offsety; /**< Texture offset y. */
|
||||
|
||||
bool tiledtex; /**< Texture is tiled if set to true. */
|
||||
uint tilew; /**< Width of one tile. */
|
||||
uint tileh; /**< Height of one tile. */
|
||||
uint tilew; /**< The width of one tile in pixels. */
|
||||
uint tileh; /**< The height of one tile in pixels. */
|
||||
uint nbtilew; /**< Number of tiles for the x axis. */
|
||||
uint nbtileh; /**< Number of tiles for the y axis. */
|
||||
uint tilestart; /**< Offset to tile starting position. */
|
||||
|
|
|
@ -26,7 +26,8 @@ THE SOFTWARE.
|
|||
*/
|
||||
|
||||
/**
|
||||
* Set a texture's X and Y handles. e.g. for rotation.
|
||||
* Set a texture's X and Y handles.
|
||||
* For example, it could be used for the rotation of a texture.
|
||||
* @param tex The texture to set the handle on.
|
||||
* @param x The x-coordinate of the handle.
|
||||
* @param y The y-coordinate of the handle.
|
||||
|
@ -43,7 +44,8 @@ void GRRLIB_SetHandle (GRRLIB_texImg *tex, const int x, const int y) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Center a texture's handles. e.g. for rotation.
|
||||
* Center a texture's handles.
|
||||
* For example, it could be used for the rotation of a texture.
|
||||
* @param tex The texture to center.
|
||||
* @param enabled
|
||||
*/
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
# Doxyfile 1.6.2
|
||||
# Doxyfile 1.6.3
|
||||
|
||||
# This file describes the settings to be used by the documentation system
|
||||
# doxygen (www.doxygen.org) for a project
|
||||
|
|
Loading…
Reference in a new issue