Ignore:
Timestamp:
Nov 22, 2003, 1:45:25 PM (19 years ago)
Author:
Sam Hocevar
Message:
  • src/: + Doxygenated a few things.
File:
1 edited

Legend:

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

    r204 r205  
    33 *   Copyright (c) 2002, 2003 Sam Hocevar <sam@zoy.org>
    44 *                 All Rights Reserved
    5  *
    6  *   $Id$
    75 *
    86 *   This library is free software; you can redistribute it and/or
     
    2220 */
    2321
     22/**  \file caca.h
     23 *   \version \$Id$
     24 *   \author Sam Hocevar <sam@zoy.org>
     25 *   \brief The \e libcaca public header.
     26 *
     27 *   This header contains the public types and functions that applications
     28 *   using \e libcaca may use.
     29 */
     30
     31/**  \mainpage libcaca developer documentation
     32 *
     33 *   \section intro Introduction
     34 *
     35 *   \e libcaca is a graphics library that outputs text instead of pixels,
     36 *   so that it can work on older video cards or text terminals. It is not
     37 *   unlike the famous AAlib library. libcaca needs a terminal to work,
     38 *   thus it should work on all Unix systems (including Mac OS X) using
     39 *   either the slang library or the ncurses library, on DOS using the conio
     40 *   library, and on Windows systems using either slang or ncurses (through
     41 *   Cygwin emulation) or conio.
     42 *
     43 *   \e libcaca is free software, released under the GNU Lesser General
     44 *   Public License. This ensures that \e libcaca will always remain free
     45 *   software.
     46 *
     47 *   \section api The libcaca API
     48 *
     49 *   The complete \e libcaca programming interface is available from the
     50 *   caca.h file.
     51 */
     52
    2453#ifndef __CACA_H__
    2554#define __CACA_H__
     
    3059#endif
    3160
    32 /*
    33  * Colors
     61/**
     62 * The colour definitions to be used with caca_set_color().
    3463 */
    3564enum caca_color
     
    5382};
    5483
    55 /*
    56  * Dithering modes
     84/**
     85 * The dithering modes to be used with caca_set_dithering().
    5786 */
    5887enum caca_dithering
     
    6392};
    6493
    65 /*
    66  * Events
     94/**
     95 * The event types returned by caca_get_event().
    6796 */
    6897enum caca_event
     
    74103};
    75104
    76 /*
    77  * Keys
     105/**
     106 * The special key values returned by caca_get_event().
    78107 */
    79108enum caca_key
     
    102131
    103132/*
    104  * Internal types
    105  */
    106 struct caca_sprite;
    107 struct caca_bitmap;
    108 
    109 /*
    110133 * Basic functions
    111134 */
     
    165188 * Sprite handling
    166189 */
     190struct caca_sprite;
    167191struct caca_sprite * caca_load_sprite(const char *);
    168192int caca_get_sprite_frames(struct caca_sprite *);
     
    177201 * Bitmap handling
    178202 */
     203struct caca_bitmap;
    179204struct caca_bitmap *caca_create_bitmap(int, int, int, int, int, int, int);
    180205void caca_draw_bitmap(int, int, int, int, struct caca_bitmap *, char *);
Note: See TracChangeset for help on using the changeset viewer.