Changeset 824


Ignore:
Timestamp:
Apr 21, 2006, 8:03:22 PM (15 years ago)
Author:
Sam Hocevar
Message:
  • Documentation improvements. Wrote a small migration guide and added the skeleton of a tutorial for Jylam.
Location:
libcaca/trunk
Files:
2 added
5 edited

Legend:

Unmodified
Added
Removed
  • libcaca/trunk/TODO

    r823 r824  
    88     support, background colour support, thinking of a storage format,
    99     etc.)
    10 
    1110  - Or maybe, instead of doing shit with the sprites, just allow canvases
    1211     to have several buffers, allow to change the active buffer, and treat
    1312     sprites like that.
    14 
    1513  - ASCII/ANSI art loading functions (maybe load them as sprites)
    16 
    1714
    1815  \subsection indep API-independent stuff
    1916
    2017  - support for transparency (CUCUL_COLOR_TRANSPARENT)
    21 
    2218  - Brightness, contrast support for bitmaps (the functions are here, we
    2319     just need to fill them)
    24 
    2520  - Error distribution dithering
    26 
    2721  - Add a random factor to the random ditherer. No need to change the API
    2822     for that, we can just pass "random:10" instead of "random" to the
    2923     cucul_set_bitmap_dithering() function.
    30 
    3124  - Implement the colour modes set in cucul_set_bitmap_color(). For the
    3225     moment only "full16" and "16" are implemented.
    33 
    3426  - Fix the thin ellipse rendering (currently it's only |s and -s, we
    3527     could make them smoother by using ' ` , etc).
    36 
    3728  - support for double width glyphs (also needs some libcaca changes)
    38 
    3929  - better mask support in cucul_blit()
    40 
    4130  - factor internal Unicode character conversions, especially UCS4 -> UTF-8
    42 
    4331  - optimise exporters so that they do not allocate huge blocks of memory
    4432     when they only need half of it.
     
    5240     seems pretty difficult)
    5341
    54 
    5542  \subsection indep API-independent stuff
    5643
    5744  - Write a Linux console output
    58 
    5945  - Better keyboard driver in an X terminal, see
    6046     http://groups.yahoo.com/group/zepp/message/381
    61 
    6247  - Unicode support for X11 (maybe through Xft)
    63 
    6448  - fix Unicode support for ncurses
    65 
    6649  - Unicode support for GL
    67 
    6850  - and Jylam wants a framebuffer output
    6951
     
    7456
    7557  - Fix Python
    76 
    7758  - Fix Perl
    78 
    7959  - C# (it's the next big thing, believe me)
    80 
    8160  - PHP (together with the HTML output it would allow for nice web
    8261     applications)
    83 
    8462
    8563  \subsection notimp Not that important
    8664
    8765  - Ruby
    88 
    8966  - Java
    9067
     
    9370
    9471  - keyboard support
    95 
    9672  - printf/fprintf are missing
    97 
    9873  - Improve malloc/free so that we can reuse freed memory
    9974
     
    10277
    10378  - Write a tutorial.
    104 
    10579  - Draw a nicer logo
    10680
     
    11185
    11286  - File browser
    113 
    11487  - open ANSI files
    115 
    11688  - save in different formats
    117 
    11889
    11990  \section cacadraw cacadraw
     
    12293     do Unicode.
    12394
    124 
    12595  \section cuculet CUCUlet
    12696
    12797  - Does not exist yet, but I want it. A replacement for FIGlet that can
    12898     also do Unicode
    129 
    13099  - Colour support, of course: outputs to IRC, ANSI, HTML...
    131 
    132100  - Can open FIGlet fonts
    133101
  • libcaca/trunk/caca/caca.h

    r823 r824  
    144144};
    145145
    146 /** \defgroup caca Basic libcaca functions
     146/** \defgroup caca libcaca basic functions
    147147 *
    148148 *  These functions provide the basic \e libcaca routines for driver
     
    160160/*  @} */
    161161
    162 /** \defgroup event Event handling
     162/** \defgroup event libcaca event handling
    163163 *
    164164 *  These functions handle user events such as keyboard input and mouse
  • libcaca/trunk/cucul/cucul.h

    r814 r824  
    4343typedef struct cucul_font cucul_font_t;
    4444
    45 /** \defgroup colour Colour definitions
     45/** \defgroup colour libcucul colour definitions
    4646 *
    4747 *  Colours that can be used with cucul_set_color().
     
    6868/*  @} */
    6969
    70 /** \defgroup cucul Basic libcucul functions
     70/** \defgroup cucul libcucul basic functions
    7171 *
    7272 *  These functions provide the basic \e libcaca routines for library
     
    8383/*  @} */
    8484
    85 /** \defgroup buffer Buffer handling
     85/** \defgroup buffer libcucul buffer handling
    8686 *
    8787 *  These functions provide methods to handle libcucul buffers.
     
    9393/*  @} */
    9494
    95 /** \defgroup canvas Canvas drawing
     95/** \defgroup canvas libcucul canvas drawing
    9696 *
    9797 *  These functions provide low-level character printing routines and
     
    109109/*  @} */
    110110
    111 /** \defgroup transform Canvas transformation
     111/** \defgroup transform libcucul canvas transformation
    112112 *
    113113 *  These functions perform horizontal and vertical canvas flipping.
     
    120120/*  @} */
    121121
    122 /** \defgroup prim Primitives drawing
     122/** \defgroup prim libcucul primitives drawing
    123123 *
    124124 *  These functions provide routines for primitive drawing, such as lines,
     
    145145/*  @} */
    146146
    147 /** \defgroup sprite Sprite handling
     147/** \defgroup sprite libcucul sprite handling
    148148 *
    149149 *  These functions provide high level routines for sprite loading, animation
     
    161161/*  @} */
    162162
    163 /** \defgroup dither Bitmap dithering
     163/** \defgroup dither libcucul bitmap dithering
    164164 *
    165165 *  These functions provide high level routines for dither allocation and
     
    191191/*  @} */
    192192
    193 /** \defgroup font Font handling
     193/** \defgroup font libcucul font handling
    194194 *
    195195 *  These functions provide font handling routines and high quality
     
    206206/*  @} */
    207207
    208 /** \defgroup exporter Exporters to various formats
     208/** \defgroup exporter libcucul exporters to various formats
    209209 *
    210210 *  These functions export the current canvas to various text formats. It
  • libcaca/trunk/doc/Makefile.am

    r823 r824  
    11# $Id$
    22
    3 EXTRA_DIST = doxygen.cfg.in footer.html header.html libcaca.dox $(man_MANS)
     3EXTRA_DIST = doxygen.cfg.in footer.html header.html $(man_MANS) \
     4             libcaca.dox user.dox migrating.dox tutorial.dox
    45
    56man_MANS = caca-config.1 cacafire.1 cacaview.1
  • libcaca/trunk/doc/libcaca.dox

    r823 r824  
    2222 License, but that was not free enough.
    2323
    24  \section api The libcaca API
     24 \section devel Developer's documentation
    2525
    2626 \e libcaca relies on a low-level, device independent library, called
     
    3131 available from the cucul.h and caca.h headers.
    3232
    33  \section env Environment variables
     33 Some other topics are covered by specific sections:
    3434
    35  Some environment variables can be used to change the behaviour of
    36  \e libcaca without having to modify the program which uses them. These
    37  variables are:
     35 - \subpage tutorial
     36 - \subpage migrating
    3837
    39  \li \b CACA_DRIVER: set the backend video driver. In order of preference:
    40      - \c conio uses the DOS conio.h interface.
    41      - \c ncurses uses the ncurses library.
    42      - \c slang uses the S-Lang library.
    43      - \c x11 uses the native X11 driver.
    44      - \c gl uses freeglut and opengl libraries.
    45      - \c raw outputs to the standard output instead of rendering the
    46        canvas. This is can be used together with cacaserver.
     38 \section user User's documentation
    4739
    48  \li \b CACA_GEOMETRY: set the video display size. The format of this
    49      variable must be XxY, with X and Y being integer values. This option
    50      currently works with the network, X11 and GL drivers.
     40 - \subpage env
    5141
    52  \li \b CACA_FONT: set the rendered font. The format of this variable is
    53      implementation dependent, but since it currently only works with the
    54      X11 driver, an X11 font name such as "fixed" or "5x7" is expected.
    55 
    56  \section Misc
     42 \section misc Misc
    5743
    5844 - \subpage news
     
    6147 - \subpage todo
    6248
     49 \section license License
     50
     51 Permission is granted to copy, distribute and/or modify this document
     52 under the terms of the Do What The Fuck You Want To Public License, version
     53 2 as published by Sam Hocevar. For details see http://sam.zoy.org/wtfpl/ .
     54
    6355*/
Note: See TracChangeset for help on using the changeset viewer.