caca.h | caca.h | |||
---|---|---|---|---|
skipping to change at line 23 | skipping to change at line 23 | |||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |||
* Lesser General Public License for more details. | * Lesser General Public License for more details. | |||
* | * | |||
* You should have received a copy of the GNU Lesser General Public | * You should have received a copy of the GNU Lesser General Public | |||
* License along with this library; if not, write to the Free Software | * License along with this library; if not, write to the Free Software | |||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA | |||
* 02111-1307 USA | * 02111-1307 USA | |||
*/ | */ | |||
/** \file caca.h | /** \file caca.h | |||
* \version \$Id: caca.h 202 2004-01-02 16:52:10Z sam $ | * \version \$Id: caca.h 219 2004-01-07 12:45:02Z sam $ | |||
* \author Sam Hocevar <sam@zoy.org> | * \author Sam Hocevar <sam@zoy.org> | |||
* \brief The \e libcaca public header. | * \brief The \e libcaca public header. | |||
* | * | |||
* This header contains the public types and functions that applications | * This header contains the public types and functions that applications | |||
* using \e libcaca may use. | * using \e libcaca may use. | |||
*/ | */ | |||
/** \mainpage libcaca developer documentation | /** \mainpage libcaca developer documentation | |||
* | * | |||
* \section intro Introduction | * \section intro Introduction | |||
skipping to change at line 157 | skipping to change at line 157 | |||
CACA_DITHERING = 0x30, /**< Dithering methods */ | CACA_DITHERING = 0x30, /**< Dithering methods */ | |||
CACA_DITHERING_NONE = 0x31, /**< No dithering. */ | CACA_DITHERING_NONE = 0x31, /**< No dithering. */ | |||
CACA_DITHERING_ORDERED2 = 0x32, /**< Ordered 2x2 Bayer dithering. */ | CACA_DITHERING_ORDERED2 = 0x32, /**< Ordered 2x2 Bayer dithering. */ | |||
CACA_DITHERING_ORDERED4 = 0x33, /**< Ordered 4x4 Bayer dithering. */ | CACA_DITHERING_ORDERED4 = 0x33, /**< Ordered 4x4 Bayer dithering. */ | |||
CACA_DITHERING_ORDERED8 = 0x34, /**< Ordered 8x8 Bayer dithering. */ | CACA_DITHERING_ORDERED8 = 0x34, /**< Ordered 8x8 Bayer dithering. */ | |||
CACA_DITHERING_RANDOM = 0x35, /**< Random dithering. */ | CACA_DITHERING_RANDOM = 0x35, /**< Random dithering. */ | |||
#define CACA_DITHERING_MIN 0x31 /**< First dithering feature. */ | #define CACA_DITHERING_MIN 0x31 /**< First dithering feature. */ | |||
#define CACA_DITHERING_MAX 0x35 /**< Last dithering feature. */ | #define CACA_DITHERING_MAX 0x35 /**< Last dithering feature. */ | |||
CACA_UNKNOWN_FEATURE = 0xffff /**< Unknown feature. */ | CACA_FEATURE_UNKNOWN = 0xffff /**< Unknown feature. */ | |||
}; | }; | |||
/* | /* | |||
* Backwards compatibility macros | * Backwards compatibility macros | |||
*/ | */ | |||
#ifndef _DOXYGEN_SKIP_ME | #if !defined(_DOXYGEN_SKIP_ME) | |||
#define caca_dithering caca_feature | #define caca_dithering caca_feature | |||
#define caca_set_dithering caca_set_feature | #define caca_set_dithering caca_set_feature | |||
#define caca_get_dithering_name caca_get_feature_name | #define caca_get_dithering_name caca_get_feature_name | |||
#define CACA_DITHER_NONE CACA_DITHERING_NONE | #define CACA_DITHER_NONE CACA_DITHERING_NONE | |||
#define CACA_DITHER_ORDERED CACA_DITHERING_ORDERED8 | #define CACA_DITHER_ORDERED CACA_DITHERING_ORDERED8 | |||
#define CACA_DITHER_RANDOM CACA_DITHERING_RANDOM | #define CACA_DITHER_RANDOM CACA_DITHERING_RANDOM | |||
#endif | #endif | |||
/** \brief User events. | /** \brief User events. | |||
* | * | |||
* Event types returned by caca_get_event(). | * Event types returned by caca_get_event(). | |||
*/ | */ | |||
enum caca_event | enum caca_event | |||
{ | { | |||
CACA_EVENT_NONE = 0x00000000, /**< No event. */ | CACA_EVENT_NONE = 0x00000000, /**< No event. */ | |||
CACA_EVENT_KEY_PRESS = 0x01000000, /**< A key was pressed. */ | CACA_EVENT_KEY_PRESS = 0x01000000, /**< A key was pressed. */ | |||
CACA_EVENT_KEY_RELEASE = 0x02000000, /**< A key was released. */ | CACA_EVENT_KEY_RELEASE = 0x02000000, /**< A key was released. */ | |||
CACA_EVENT_MOUSE_PRESS = 0x04000000, /**< A mouse button was pressed. */ | CACA_EVENT_MOUSE_PRESS = 0x04000000, /**< A mouse button was pressed. */ | |||
CACA_EVENT_MOUSE_RELEASE = 0x08000000, /**< A mouse button was released . */ | CACA_EVENT_MOUSE_RELEASE = 0x08000000, /**< A mouse button was released . */ | |||
CACA_EVENT_MOUSE_MOTION = 0x10000000 /**< The mouse was moved. */ | CACA_EVENT_MOUSE_MOTION = 0x10000000, /**< The mouse was moved. */ | |||
CACA_EVENT_ANY = 0xff000000 /**< Bitmask for any event. */ | ||||
}; | }; | |||
/** \brief Special key values. | /** \brief Special key values. | |||
* | * | |||
* Special key values returned by caca_get_event() for which there is no | * Special key values returned by caca_get_event() for which there is no | |||
* ASCII equivalent. | * ASCII equivalent. | |||
*/ | */ | |||
enum caca_key | enum caca_key | |||
{ | { | |||
CACA_KEY_UP = 273, /**< The up arrow key. */ | CACA_KEY_UP = 273, /**< The up arrow key. */ | |||
skipping to change at line 239 | skipping to change at line 240 | |||
void caca_refresh(void); | void caca_refresh(void); | |||
void caca_end(void); | void caca_end(void); | |||
/* @} */ | /* @} */ | |||
/** \defgroup event Event handling | /** \defgroup event Event handling | |||
* | * | |||
* These functions handle user events such as keyboard input and mouse | * These functions handle user events such as keyboard input and mouse | |||
* clicks. | * clicks. | |||
* | * | |||
* @{ */ | * @{ */ | |||
unsigned int caca_get_event(void); | unsigned int caca_get_event(unsigned int); | |||
unsigned int caca_wait_event(void); | unsigned int caca_wait_event(unsigned int); | |||
/* @} */ | /* @} */ | |||
/** \defgroup char Character printing | /** \defgroup char Character printing | |||
* | * | |||
* These functions provide low-level character printing routines. | * These functions provide low-level character printing routines. | |||
* | * | |||
* @{ */ | * @{ */ | |||
void caca_set_color(enum caca_color, enum caca_color); | void caca_set_color(enum caca_color, enum caca_color); | |||
enum caca_color caca_get_fg_color(void); | enum caca_color caca_get_fg_color(void); | |||
enum caca_color caca_get_bg_color(void); | enum caca_color caca_get_bg_color(void); | |||
End of changes. 5 change blocks. | ||||
6 lines changed or deleted | 7 lines changed or added | |||