浏览代码

* Minor documentation improvements.

tags/v0.99.beta14
Sam Hocevar sam 19 年前
父节点
当前提交
2353ad9215
共有 4 个文件被更改,包括 50 次插入50 次删除
  1. +1
    -1
      cucul/colour.c
  2. +26
    -26
      cucul/dither.c
  3. +10
    -10
      cucul/export.c
  4. +13
    -13
      cucul/font.c

+ 1
- 1
cucul/colour.c 查看文件

@@ -33,7 +33,7 @@ static const uint16_t ansitab[16] =
* caca_printf() and graphical primitive functions such as caca_draw_line() * caca_printf() and graphical primitive functions such as caca_draw_line()
* will use these colours. * will use these colours.
* *
* Color values are those defined in \e cucul.h, such as CUCUL_COLOR_RED * Color values are those defined in cucul.h, such as CUCUL_COLOR_RED
* or CUCUL_COLOR_TRANSPARENT. * or CUCUL_COLOR_TRANSPARENT.
* *
* \param cv A handle to the libcucul canvas. * \param cv A handle to the libcucul canvas.


+ 26
- 26
cucul/dither.c 查看文件

@@ -421,12 +421,12 @@ void cucul_set_dither_contrast(cucul_dither_t *d, float contrast)


/** \brief Set dither antialiasing /** \brief Set dither antialiasing
* *
* Tell the renderer whether to antialias the dither. Antialiasing smoothen * Tell the renderer whether to antialias the dither. Antialiasing smoothens
* the rendered image and avoids the commonly seen staircase effect. * the rendered image and avoids the commonly seen staircase effect.
* *
* \li \e "none": no antialiasing. * \li \c "none": no antialiasing.
* *
* \li \e "prefilter": simple prefilter antialiasing. This is the default * \li \c "prefilter": simple prefilter antialiasing. This is the default
* value. * value.
* *
* \param d Dither object. * \param d Dither object.
@@ -446,7 +446,7 @@ void cucul_set_dither_antialias(cucul_dither_t *d, char const *str)
* Return a list of available antialiasing methods for a given dither. The * Return a list of available antialiasing methods for a given dither. The
* list is a NULL-terminated array of strings, interleaving a string * list is a NULL-terminated array of strings, interleaving a string
* containing the internal value for the antialiasing method to be used with * containing the internal value for the antialiasing method to be used with
* \e cucul_set_dither_antialias(), and a string containing the natural * cucul_set_dither_antialias(), and a string containing the natural
* language description for that antialiasing method. * language description for that antialiasing method.
* *
* \param d Dither object. * \param d Dither object.
@@ -468,23 +468,23 @@ char const * const *
/** \brief Choose colours used for dithering /** \brief Choose colours used for dithering
* *
* Tell the renderer which colours should be used to render the * Tell the renderer which colours should be used to render the
* bitmap. Valid values for \e str are: * bitmap. Valid values for \c str are:
* *
* \li \e "mono": use light gray on a black background. * \li \c "mono": use light gray on a black background.
* *
* \li \e "gray": use white and two shades of gray on a black background. * \li \c "gray": use white and two shades of gray on a black background.
* *
* \li \e "8": use the 8 ANSI colours on a black background. * \li \c "8": use the 8 ANSI colours on a black background.
* *
* \li \e "16": use the 16 ANSI colours on a black background. * \li \c "16": use the 16 ANSI colours on a black background.
* *
* \li \e "fullgray": use black, white and two shades of gray for both the * \li \c "fullgray": use black, white and two shades of gray for both the
* characters and the background. * characters and the background.
* *
* \li \e "full8": use the 8 ANSI colours for both the characters and the * \li \c "full8": use the 8 ANSI colours for both the characters and the
* background. * background.
* *
* \li \e "full16": use the 16 ANSI colours for both the characters and the * \li \c "full16": use the 16 ANSI colours for both the characters and the
* background. This is the default value. * background. This is the default value.
* *
* \param d Dither object. * \param d Dither object.
@@ -514,7 +514,7 @@ void cucul_set_dither_color(cucul_dither_t *d, char const *str)
* Return a list of available colour modes for a given dither. The list * Return a list of available colour modes for a given dither. The list
* is a NULL-terminated array of strings, interleaving a string containing * is a NULL-terminated array of strings, interleaving a string containing
* the internal value for the colour mode, to be used with * the internal value for the colour mode, to be used with
* \e cucul_set_dither_color(), and a string containing the natural * cucul_set_dither_color(), and a string containing the natural
* language description for that colour mode. * language description for that colour mode.
* *
* \param d Dither object. * \param d Dither object.
@@ -541,15 +541,15 @@ char const * const *
/** \brief Choose characters used for dithering /** \brief Choose characters used for dithering
* *
* Tell the renderer which characters should be used to render the * Tell the renderer which characters should be used to render the
* dither. Valid values for \e str are: * dither. Valid values for \c str are:
* *
* \li \e "ascii": use only ASCII characters. This is the default value. * \li \c "ascii": use only ASCII characters. This is the default value.
* *
* \li \e "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592 * \li \c "shades": use Unicode characters "U+2591 LIGHT SHADE", "U+2592
* MEDIUM SHADE" and "U+2593 DARK SHADE". These characters are also * MEDIUM SHADE" and "U+2593 DARK SHADE". These characters are also
* present in the CP437 codepage available on DOS and VGA. * present in the CP437 codepage available on DOS and VGA.
* *
* \li \e "blocks": use Unicode quarter-cell block combinations. These * \li \c "blocks": use Unicode quarter-cell block combinations. These
* characters are only found in the Unicode set. * characters are only found in the Unicode set.
* *
* \param d Dither object. * \param d Dither object.
@@ -580,7 +580,7 @@ void cucul_set_dither_charset(cucul_dither_t *d, char const *str)
* Return a list of available character sets for a given dither. The list * Return a list of available character sets for a given dither. The list
* is a NULL-terminated array of strings, interleaving a string containing * is a NULL-terminated array of strings, interleaving a string containing
* the internal value for the character set, to be used with * the internal value for the character set, to be used with
* \e cucul_set_dither_charset(), and a string containing the natural * cucul_set_dither_charset(), and a string containing the natural
* language description for that character set. * language description for that character set.
* *
* \param d Dither object. * \param d Dither object.
@@ -603,19 +603,19 @@ char const * const * cucul_get_dither_charset_list(cucul_dither_t const *d)
* *
* Tell the renderer which dithering method should be used. Dithering is * Tell the renderer which dithering method should be used. Dithering is
* necessary because the picture being rendered has usually far more colours * necessary because the picture being rendered has usually far more colours
* than the available palette. Valid values for \e str are: * than the available palette. Valid values for \c str are:
* *
* \li \e "none": no dithering is used, the nearest matching colour is used. * \li \c "none": no dithering is used, the nearest matching colour is used.
* *
* \li \e "ordered2": use a 2x2 Bayer matrix for dithering. * \li \c "ordered2": use a 2x2 Bayer matrix for dithering.
* *
* \li \e "ordered4": use a 4x4 Bayer matrix for dithering. * \li \c "ordered4": use a 4x4 Bayer matrix for dithering.
* *
* \li \e "ordered8": use a 8x8 Bayer matrix for dithering. * \li \c "ordered8": use a 8x8 Bayer matrix for dithering.
* *
* \li \e "random": use random dithering. * \li \c "random": use random dithering.
* *
* \li \e "fstein": use Floyd-Steinberg dithering. This is the default value. * \li \c "fstein": use Floyd-Steinberg dithering. This is the default value.
* *
* \param d Dither object. * \param d Dither object.
* \param str A string describing the method that needs to be used * \param str A string describing the method that needs to be used
@@ -666,7 +666,7 @@ void cucul_set_dither_mode(cucul_dither_t *d, char const *str)
* Return a list of available dithering methods for a given dither. The list * Return a list of available dithering methods for a given dither. The list
* is a NULL-terminated array of strings, interleaving a string containing * is a NULL-terminated array of strings, interleaving a string containing
* the internal value for the dithering method, to be used with * the internal value for the dithering method, to be used with
* \e cucul_set_dither_dithering(), and a string containing the natural * cucul_set_dither_dithering(), and a string containing the natural
* language description for that dithering method. * language description for that dithering method.
* *
* \param d Dither object. * \param d Dither object.


+ 10
- 10
cucul/export.c 查看文件

@@ -43,24 +43,24 @@ static void export_tga(cucul_canvas_t *, cucul_buffer_t *);
* and cucul_get_buffer_size() to access the buffer contents. The allocated * and cucul_get_buffer_size() to access the buffer contents. The allocated
* data is valid until cucul_free_buffer() is called. * data is valid until cucul_free_buffer() is called.
* *
* Valid values for \e format are: * Valid values for \c format are:
* *
* \li \e "caca": export native libcaca files. * \li \c "caca": export native libcaca files.
* *
* \li \e "ansi": export ANSI art (CP437 charset with ANSI colour codes). * \li \c "ansi": export ANSI art (CP437 charset with ANSI colour codes).
* *
* \li \e "html": export an HTML page with CSS information. * \li \c "html": export an HTML page with CSS information.
* *
* \li \e "html3": export an HTML table that should be compatible with * \li \c "html3": export an HTML table that should be compatible with
* most navigators, including textmode ones. * most navigators, including textmode ones.
* *
* \li \e "irc": export UTF-8 text with mIRC colour codes. * \li \c "irc": export UTF-8 text with mIRC colour codes.
* *
* \li \e "ps": export a PostScript document. * \li \c "ps": export a PostScript document.
* *
* \li \e "svg": export an SVG vector image. * \li \c "svg": export an SVG vector image.
* *
* \li \e "tga": export a TGA image. * \li \c "tga": export a TGA image.
* *
* \param cv A libcucul canvas * \param cv A libcucul canvas
* \param format A string describing the requested output format. * \param format A string describing the requested output format.
@@ -103,7 +103,7 @@ cucul_buffer_t * cucul_create_export(cucul_canvas_t *cv, char const *format)
* *
* Return a list of available export formats. The list is a NULL-terminated * Return a list of available export formats. The list is a NULL-terminated
* array of strings, interleaving a string containing the internal value for * array of strings, interleaving a string containing the internal value for
* the export format, to be used with \e cucul_create_export(), and a string * the export format, to be used with cucul_create_export(), and a string
* containing the natural language description for that export format. * containing the natural language description for that export format.
* *
* \return An array of strings. * \return An array of strings.


+ 13
- 13
cucul/font.c 查看文件

@@ -92,15 +92,15 @@ DECLARE_UNPACKGLYPH(1)
/** \brief Load a font from memory for future use. /** \brief Load a font from memory for future use.
* *
* This function loads a font and returns a handle to its internal * This function loads a font and returns a handle to its internal
* structure. The handle can then be used with \e cucul_render_canvas() * structure. The handle can then be used with cucul_render_canvas()
* for bitmap output. * for bitmap output.
* *
* Internal fonts can also be loaded: if \e size is set to 0, \e data must * Internal fonts can also be loaded: if \c size is set to 0, \c data must
* be a string containing the internal font name. * be a string containing the internal font name.
* *
* If \e size is non-zero, the \e size bytes of memory at address \e data * If \c size is non-zero, the \c size bytes of memory at address \c data
* are loaded as a font. This memory are must not be freed by the calling * are loaded as a font. This memory are must not be freed by the calling
* program until the font handle has been freed with \e cucul_free_font(). * program until the font handle has been freed with cucul_free_font().
* *
* \param data The memory area containing the font or its name. * \param data The memory area containing the font or its name.
* \param size The size of the memory area, or 0 if the font name is given. * \param size The size of the memory area, or 0 if the font name is given.
@@ -218,7 +218,7 @@ char const * const * cucul_get_font_list(void)
* *
* This function returns the maximum value for the current font's glyphs * This function returns the maximum value for the current font's glyphs
* *
* \param f The font, as returned by \e cucul_load_font() * \param f The font, as returned by cucul_load_font()
* \return The maximum glyph width. * \return The maximum glyph width.
*/ */
unsigned int cucul_get_font_width(cucul_font_t *f) unsigned int cucul_get_font_width(cucul_font_t *f)
@@ -230,7 +230,7 @@ unsigned int cucul_get_font_width(cucul_font_t *f)
* *
* This function returns the maximum value for the current font's glyphs * This function returns the maximum value for the current font's glyphs
* *
* \param f The font, as returned by \e cucul_load_font() * \param f The font, as returned by cucul_load_font()
* \return The maximum glyph height. * \return The maximum glyph height.
*/ */
unsigned int cucul_get_font_height(cucul_font_t *f) unsigned int cucul_get_font_height(cucul_font_t *f)
@@ -240,12 +240,12 @@ unsigned int cucul_get_font_height(cucul_font_t *f)


/** \brief Free a font structure. /** \brief Free a font structure.
* *
* This function frees all data allocated by \e cucul_load_font(). The * This function frees all data allocated by cucul_load_font(). The
* font structure is no longer usable by other libcucul functions. Once * font structure is no longer usable by other libcucul functions. Once
* this function has returned, the memory area that was given to * this function has returned, the memory area that was given to
* \e cucul_load_font() can be freed. * cucul_load_font() can be freed.
* *
* \param f The font, as returned by \e cucul_load_font() * \param f The font, as returned by cucul_load_font()
*/ */
void cucul_free_font(cucul_font_t *f) void cucul_free_font(cucul_font_t *f)
{ {
@@ -260,15 +260,15 @@ void cucul_free_font(cucul_font_t *f)
* font. The pixel format is fixed (32-bit ARGB, 8 bits for each component). * font. The pixel format is fixed (32-bit ARGB, 8 bits for each component).
* *
* The required image width can be computed using * The required image width can be computed using
* \e cucul_get_canvas_width(cv) and \e cucul_get_font_width(f). The required * cucul_get_canvas_width() and cucul_get_font_width(). The required
* height can be computed using \e cucul_get_canvas_height(cv) and * height can be computed using cucul_get_canvas_height() and
* \e cucul_get_font_height(f). * cucul_get_font_height().
* *
* Glyphs that do not fit in the image buffer are currently not rendered at * Glyphs that do not fit in the image buffer are currently not rendered at
* all. They may be cropped instead in future versions. * all. They may be cropped instead in future versions.
* *
* \param cv The canvas to render * \param cv The canvas to render
* \param f The font, as returned by \e cucul_load_font() * \param f The font, as returned by cucul_load_font()
* \param buf The image buffer * \param buf The image buffer
* \param width The width (in pixels) of the image buffer * \param width The width (in pixels) of the image buffer
* \param height The height (in pixels) of the image buffer * \param height The height (in pixels) of the image buffer


||||||
x
 
000:0
正在加载...
取消
保存