Changeset 825


Ignore:
Timestamp:
Apr 21, 2006, 8:09:30 PM (16 years ago)
Author:
Sam Hocevar
Message:
  • Minor documentation improvements.
Location:
libcaca/trunk/cucul
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/cucul/colour.c

    r811 r825  
    3434 *  will use these colours.
    3535 *
    36  *  Color values are those defined in \e cucul.h, such as CUCUL_COLOR_RED
     36 *  Color values are those defined in cucul.h, such as CUCUL_COLOR_RED
    3737 *  or CUCUL_COLOR_TRANSPARENT.
    3838 *
  • libcaca/trunk/cucul/dither.c

    r816 r825  
    422422/** \brief Set dither antialiasing
    423423 *
    424  *  Tell the renderer whether to antialias the dither. Antialiasing smoothen
     424 *  Tell the renderer whether to antialias the dither. Antialiasing smoothens
    425425 *  the rendered image and avoids the commonly seen staircase effect.
    426426 *
    427  *  \li \e "none": no antialiasing.
    428  *
    429  *  \li \e "prefilter": simple prefilter antialiasing. This is the default
     427 *  \li \c "none": no antialiasing.
     428 *
     429 *  \li \c "prefilter": simple prefilter antialiasing. This is the default
    430430 *      value.
    431431 *
     
    447447 *  list is a NULL-terminated array of strings, interleaving a string
    448448 *  containing the internal value for the antialiasing method to be used with
    449  *  \e cucul_set_dither_antialias(), and a string containing the natural
     449 *  cucul_set_dither_antialias(), and a string containing the natural
    450450 *  language description for that antialiasing method.
    451451 *
     
    469469 *
    470470 *  Tell the renderer which colours should be used to render the
    471  *  bitmap. Valid values for \e str are:
    472  *
    473  *  \li \e "mono": use light gray on a black background.
    474  *
    475  *  \li \e "gray": use white and two shades of gray on a black background.
    476  *
    477  *  \li \e "8": use the 8 ANSI colours on a black background.
    478  *
    479  *  \li \e "16": use the 16 ANSI colours on a black background.
    480  *
    481  *  \li \e "fullgray": use black, white and two shades of gray for both the
     471 *  bitmap. Valid values for \c str are:
     472 *
     473 *  \li \c "mono": use light gray on a black background.
     474 *
     475 *  \li \c "gray": use white and two shades of gray on a black background.
     476 *
     477 *  \li \c "8": use the 8 ANSI colours on a black background.
     478 *
     479 *  \li \c "16": use the 16 ANSI colours on a black background.
     480 *
     481 *  \li \c "fullgray": use black, white and two shades of gray for both the
    482482 *      characters and the background.
    483483 *
    484  *  \li \e "full8": use the 8 ANSI colours for both the characters and the
     484 *  \li \c "full8": use the 8 ANSI colours for both the characters and the
    485485 *      background.
    486486 *
    487  *  \li \e "full16": use the 16 ANSI colours for both the characters and the
     487 *  \li \c "full16": use the 16 ANSI colours for both the characters and the
    488488 *      background. This is the default value.
    489489 *
     
    515515 *  is a NULL-terminated array of strings, interleaving a string containing
    516516 *  the internal value for the colour mode, to be used with
    517  *  \e cucul_set_dither_color(), and a string containing the natural
     517 *  cucul_set_dither_color(), and a string containing the natural
    518518 *  language description for that colour mode.
    519519 *
     
    542542 *
    543543 *  Tell the renderer which characters should be used to render the
    544  *  dither. Valid values for \e str are:
    545  *
    546  *  \li \e "ascii": use only ASCII characters. This is the default value.
    547  *
    548  *  \li \e "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592
     544 *  dither. Valid values for \c str are:
     545 *
     546 *  \li \c "ascii": use only ASCII characters. This is the default value.
     547 *
     548 *  \li \c "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592
    549549 *      MEDIUM SHADE" and "U+2593 DARK SHADE". These characters are also
    550550 *      present in the CP437 codepage available on DOS and VGA.
    551551 *
    552  *  \li \e "blocks": use Unicode quarter-cell block combinations. These
     552 *  \li \c "blocks": use Unicode quarter-cell block combinations. These
    553553 *      characters are only found in the Unicode set.
    554554 *
     
    581581 *  is a NULL-terminated array of strings, interleaving a string containing
    582582 *  the internal value for the character set, to be used with
    583  *  \e cucul_set_dither_charset(), and a string containing the natural
     583 *  cucul_set_dither_charset(), and a string containing the natural
    584584 *  language description for that character set.
    585585 *
     
    604604 *  Tell the renderer which dithering method should be used. Dithering is
    605605 *  necessary because the picture being rendered has usually far more colours
    606  *  than the available palette. Valid values for \e str are:
    607  *
    608  *  \li \e "none": no dithering is used, the nearest matching colour is used.
    609  *
    610  *  \li \e "ordered2": use a 2x2 Bayer matrix for dithering.
    611  *
    612  *  \li \e "ordered4": use a 4x4 Bayer matrix for dithering.
    613  *
    614  *  \li \e "ordered8": use a 8x8 Bayer matrix for dithering.
    615  *
    616  *  \li \e "random": use random dithering.
    617  *
    618  *  \li \e "fstein": use Floyd-Steinberg dithering. This is the default value.
     606 *  than the available palette. Valid values for \c str are:
     607 *
     608 *  \li \c "none": no dithering is used, the nearest matching colour is used.
     609 *
     610 *  \li \c "ordered2": use a 2x2 Bayer matrix for dithering.
     611 *
     612 *  \li \c "ordered4": use a 4x4 Bayer matrix for dithering.
     613 *
     614 *  \li \c "ordered8": use a 8x8 Bayer matrix for dithering.
     615 *
     616 *  \li \c "random": use random dithering.
     617 *
     618 *  \li \c "fstein": use Floyd-Steinberg dithering. This is the default value.
    619619 *
    620620 *  \param d Dither object.
     
    667667 *  is a NULL-terminated array of strings, interleaving a string containing
    668668 *  the internal value for the dithering method, to be used with
    669  *  \e cucul_set_dither_dithering(), and a string containing the natural
     669 *  cucul_set_dither_dithering(), and a string containing the natural
    670670 *  language description for that dithering method.
    671671 *
  • libcaca/trunk/cucul/export.c

    r818 r825  
    4444 *  data is valid until cucul_free_buffer() is called.
    4545 *
    46  *  Valid values for \e format are:
    47  *
    48  *  \li \e "caca": export native libcaca files.
    49  *
    50  *  \li \e "ansi": export ANSI art (CP437 charset with ANSI colour codes).
    51  *
    52  *  \li \e "html": export an HTML page with CSS information.
    53  *
    54  *  \li \e "html3": export an HTML table that should be compatible with
     46 *  Valid values for \c format are:
     47 *
     48 *  \li \c "caca": export native libcaca files.
     49 *
     50 *  \li \c "ansi": export ANSI art (CP437 charset with ANSI colour codes).
     51 *
     52 *  \li \c "html": export an HTML page with CSS information.
     53 *
     54 *  \li \c "html3": export an HTML table that should be compatible with
    5555 *      most navigators, including textmode ones.
    5656 *
    57  *  \li \e "irc": export UTF-8 text with mIRC colour codes.
    58  *
    59  *  \li \e "ps": export a PostScript document.
    60  *
    61  *  \li \e "svg": export an SVG vector image.
    62  *
    63  *  \li \e "tga": export a TGA image.
     57 *  \li \c "irc": export UTF-8 text with mIRC colour codes.
     58 *
     59 *  \li \c "ps": export a PostScript document.
     60 *
     61 *  \li \c "svg": export an SVG vector image.
     62 *
     63 *  \li \c "tga": export a TGA image.
    6464 *
    6565 *  \param cv A libcucul canvas
     
    104104 *  Return a list of available export formats. The list is a NULL-terminated
    105105 *  array of strings, interleaving a string containing the internal value for
    106  *  the export format, to be used with \e cucul_create_export(), and a string
     106 *  the export format, to be used with cucul_create_export(), and a string
    107107 *  containing the natural language description for that export format.
    108108 *
  • libcaca/trunk/cucul/font.c

    r813 r825  
    9393 *
    9494 *  This function loads a font and returns a handle to its internal
    95  *  structure. The handle can then be used with \e cucul_render_canvas()
     95 *  structure. The handle can then be used with cucul_render_canvas()
    9696 *  for bitmap output.
    9797 *
    98  *  Internal fonts can also be loaded: if \e size is set to 0, \e data must
     98 *  Internal fonts can also be loaded: if \c size is set to 0, \c data must
    9999 *  be a string containing the internal font name.
    100100 *
    101  *  If \e size is non-zero, the \e size bytes of memory at address \e data
     101 *  If \c size is non-zero, the \c size bytes of memory at address \c data
    102102 *  are loaded as a font. This memory are must not be freed by the calling
    103  *  program until the font handle has been freed with \e cucul_free_font().
     103 *  program until the font handle has been freed with cucul_free_font().
    104104 *
    105105 *  \param data The memory area containing the font or its name.
     
    219219 *  This function returns the maximum value for the current font's glyphs
    220220 *
    221  *  \param f The font, as returned by \e cucul_load_font()
     221 *  \param f The font, as returned by cucul_load_font()
    222222 *  \return The maximum glyph width.
    223223 */
     
    231231 *  This function returns the maximum value for the current font's glyphs
    232232 *
    233  *  \param f The font, as returned by \e cucul_load_font()
     233 *  \param f The font, as returned by cucul_load_font()
    234234 *  \return The maximum glyph height.
    235235 */
     
    241241/** \brief Free a font structure.
    242242 *
    243  *  This function frees all data allocated by \e cucul_load_font(). The
     243 *  This function frees all data allocated by cucul_load_font(). The
    244244 *  font structure is no longer usable by other libcucul functions. Once
    245245 *  this function has returned, the memory area that was given to
    246  *  \e cucul_load_font() can be freed.
    247  *
    248  *  \param f The font, as returned by \e cucul_load_font()
     246 *  cucul_load_font() can be freed.
     247 *
     248 *  \param f The font, as returned by cucul_load_font()
    249249 */
    250250void cucul_free_font(cucul_font_t *f)
     
    261261 *
    262262 *  The required image width can be computed using
    263  *  \e cucul_get_canvas_width(cv) and \e cucul_get_font_width(f). The required
    264  *  height can be computed using \e cucul_get_canvas_height(cv) and
    265  *  \e cucul_get_font_height(f).
     263 *  cucul_get_canvas_width() and cucul_get_font_width(). The required
     264 *  height can be computed using cucul_get_canvas_height() and
     265 *  cucul_get_font_height().
    266266 *
    267267 *  Glyphs that do not fit in the image buffer are currently not rendered at
     
    269269 *
    270270 *  \param cv The canvas to render
    271  *  \param f The font, as returned by \e cucul_load_font()
     271 *  \param f The font, as returned by cucul_load_font()
    272272 *  \param buf The image buffer
    273273 *  \param width The width (in pixels) of the image buffer
Note: See TracChangeset for help on using the changeset viewer.