Ignore:
Timestamp:
Apr 16, 2006, 8:28:47 PM (14 years ago)
Author:
Sam Hocevar
Message:
  • Replaced "struct cucul_*" and "struct caca_*" types with opaque typedefs such as cucul_dither_t instead of struct cucul_dither.
  • Made cucul_buffer_t an opaque structure and implemented the two getters cucul_get_buffer_data() and cucul_get_buffer_size().
  • Documented all missing functions and function parameters.
File:
1 edited

Legend:

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

    r773 r777  
    8888#endif
    8989
    90 /** \brief User event types.
    91  *
    92  *  Event types returned by caca_get_event().
    93  */
    94 enum caca_event_type
    95 {
    96     CACA_EVENT_NONE =          0x0000, /**< No event. */
    97 
    98     CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */
    99     CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */
    100     CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */
    101     CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
    102     CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */
    103     CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */
    104 
    105     CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */
    106 };
     90/** \e libcaca context */
     91typedef struct caca caca_t;
     92/** event structure */
     93typedef struct caca_event caca_event_t;
    10794
    10895/** \brief User events.
     
    139126struct caca_event
    140127{
    141     enum caca_event_type type;
     128    enum caca_event_type
     129    {
     130        CACA_EVENT_NONE =          0x0000, /**< No event. */
     131
     132        CACA_EVENT_KEY_PRESS =     0x0001, /**< A key was pressed. */
     133        CACA_EVENT_KEY_RELEASE =   0x0002, /**< A key was released. */
     134        CACA_EVENT_MOUSE_PRESS =   0x0004, /**< A mouse button was pressed. */
     135        CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
     136        CACA_EVENT_MOUSE_MOTION =  0x0010, /**< The mouse was moved. */
     137        CACA_EVENT_RESIZE =        0x0020, /**< The window was resized. */
     138
     139        CACA_EVENT_ANY =           0xffff  /**< Bitmask for any event. */
     140    } type;
     141
    142142    union
    143143    {
     
    195195};
    196196
    197 typedef struct caca_context caca_t;
    198 
    199 /** \defgroup basic Basic functions
     197/** \defgroup caca Basic libcaca functions
    200198 *
    201199 *  These functions provide the basic \e libcaca routines for driver
     
    219217 *
    220218 *  @{ */
    221 int caca_get_event(caca_t *kk, unsigned int, struct caca_event *, int);
     219int caca_get_event(caca_t *kk, unsigned int, caca_event_t *, int);
    222220unsigned int caca_get_mouse_x(caca_t *kk);
    223221unsigned int caca_get_mouse_y(caca_t *kk);
Note: See TracChangeset for help on using the changeset viewer.