Changeset 256


Ignore:
Timestamp:
Dec 17, 2003, 4:03:05 PM (17 years ago)
Author:
Sam Hocevar
Message:
  • src/caca.h: + Documented environment variables.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/src/caca.h

    r249 r256  
    4949 *   The complete \e libcaca programming interface is available from the
    5050 *   caca.h file.
     51 *
     52 *   \section env Environment variables
     53 *
     54 *   Some environment variables can be used to change the behaviour of
     55 *   \e libcaca without having to modify the program which uses it. These
     56 *   variables are:
     57 *
     58 *   \li \b CACA_BACKGROUND: set the background type.
     59 *       - \c solid uses solid coloured backgrounds for all characters. This
     60 *         feature does not work with all terminal emulators. This is the
     61 *         default choice.
     62 *       - \c black uses only black backgrounds to render characters.
     63 *
     64 *   \li \b CACA_ANTIALIASING: set the antialiasing mode. Antialiasing
     65 *       smoothens the rendered image and avoids the commonly seen staircase
     66 *       effect.
     67 *       - \c none disables antialiasing.
     68 *       - \c prefilter uses a simple prefilter antialiasing method. This is
     69 *         the default choice.
     70 *
     71 *   \li \b CACA_DITHERING: set the dithering mode. Dithering is necessary
     72 *       when rendering a picture that has more colours than the usually
     73 *       available palette.
     74 *       - \c none disables dithering.
     75 *       - \c ordered2 uses a 2x2 bayer matrix for dithering.
     76 *       - \c ordered4 uses a 4x4 bayer matrix for dithering. This is the
     77 *         default choice.
     78 *       - \c ordered8 uses a 8x8 bayer matrix for dithering.
     79 *       - \c random uses random dithering.
    5180 */
    5281
Note: See TracChangeset for help on using the changeset viewer.