Browse Source

Add brief documentation to figfont functions.

tags/v0.99.beta17
Sam Hocevar sam 15 years ago
parent
commit
4c23d2b5ed
1 changed files with 3 additions and 0 deletions
  1. +3
    -0
      caca/figfont.c

+ 3
- 0
caca/figfont.c View File

@@ -52,6 +52,7 @@ static uint32_t hsmush(uint32_t ch1, uint32_t ch2, int rule);
static caca_figfont_t * open_figfont(char const *); static caca_figfont_t * open_figfont(char const *);
static int free_figfont(caca_figfont_t *); static int free_figfont(caca_figfont_t *);


/** \brief load a figfont and attach it to a canvas */
int caca_canvas_set_figfont(caca_canvas_t *cv, char const *path) int caca_canvas_set_figfont(caca_canvas_t *cv, char const *path)
{ {
caca_figfont_t *ff = NULL; caca_figfont_t *ff = NULL;
@@ -127,6 +128,7 @@ int caca_canvas_set_figfont(caca_canvas_t *cv, char const *path)
return 0; return 0;
} }


/** \brief paste a character using the current figfont */
int caca_put_figchar(caca_canvas_t *cv, uint32_t ch) int caca_put_figchar(caca_canvas_t *cv, uint32_t ch)
{ {
caca_figfont_t *ff = cv->ff; caca_figfont_t *ff = cv->ff;
@@ -250,6 +252,7 @@ int caca_put_figchar(caca_canvas_t *cv, uint32_t ch)
return 0; return 0;
} }


/** \brief flush the figlet context */
int caca_flush_figlet(caca_canvas_t *cv) int caca_flush_figlet(caca_canvas_t *cv)
{ {
caca_figfont_t *ff = cv->ff; caca_figfont_t *ff = cv->ff;


Loading…
Cancel
Save