/usr/include/caca.h is in libcaca-dev 0.99.beta17-2.1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 | /*
* libcaca Colour ASCII-Art library
* Copyright (c) 2002-2010 Sam Hocevar <sam@hocevar.net>
* All Rights Reserved
*
* This library is free software. It comes without any warranty, to
* the extent permitted by applicable law. You can redistribute it
* and/or modify it under the terms of the Do What The Fuck You Want
* To Public License, Version 2, as published by Sam Hocevar. See
* http://sam.zoy.org/wtfpl/COPYING for more details.
*/
/** \file caca.h
* \author Sam Hocevar <sam@hocevar.net>
* \brief The \e libcaca public header.
*
* This header contains the public types and functions that applications
* using \e libcaca may use.
*/
#ifndef __CACA_H__
#define __CACA_H__
#include <caca_types.h>
#if !defined(__KERNEL__)
# include <stdarg.h>
#endif
#undef __extern
#if defined _DOXYGEN_SKIP_ME
#elif defined _WIN32 && defined __LIBCACA__ && defined DLL_EXPORT
# define __extern extern __declspec(dllexport)
#elif defined _WIN32 && !defined __LIBCACA__
# define __extern extern __declspec(dllimport)
#else
# define __extern extern
#endif
/** libcaca API version */
#define CACA_API_VERSION_1
#ifdef __cplusplus
extern "C"
{
#endif
/** \e libcaca canvas */
typedef struct caca_canvas caca_canvas_t;
/** dither structure */
typedef struct caca_dither caca_dither_t;
/** font structure */
typedef struct caca_font caca_font_t;
/** file handle structure */
typedef struct caca_file caca_file_t;
/** \e libcaca display context */
typedef struct caca_display caca_display_t;
/** \e libcaca event structure */
typedef struct caca_event caca_event_t;
/** \defgroup caca_attr libcaca attribute definitions
*
* Colours and styles that can be used with caca_set_attr().
*
* @{ */
/** \e libcaca colour keyword */
enum caca_color
{
CACA_BLACK = 0x00, /**< The colour index for black. */
CACA_BLUE = 0x01, /**< The colour index for blue. */
CACA_GREEN = 0x02, /**< The colour index for green. */
CACA_CYAN = 0x03, /**< The colour index for cyan. */
CACA_RED = 0x04, /**< The colour index for red. */
CACA_MAGENTA = 0x05, /**< The colour index for magenta. */
CACA_BROWN = 0x06, /**< The colour index for brown. */
CACA_LIGHTGRAY = 0x07, /**< The colour index for light gray. */
CACA_DARKGRAY = 0x08, /**< The colour index for dark gray. */
CACA_LIGHTBLUE = 0x09, /**< The colour index for blue. */
CACA_LIGHTGREEN = 0x0a, /**< The colour index for light green. */
CACA_LIGHTCYAN = 0x0b, /**< The colour index for light cyan. */
CACA_LIGHTRED = 0x0c, /**< The colour index for light red. */
CACA_LIGHTMAGENTA = 0x0d, /**< The colour index for light magenta. */
CACA_YELLOW = 0x0e, /**< The colour index for yellow. */
CACA_WHITE = 0x0f, /**< The colour index for white. */
CACA_DEFAULT = 0x10, /**< The output driver's default colour. */
CACA_TRANSPARENT = 0x20, /**< The transparent colour. */
};
/** \e libcaca style keyword */
enum caca_style
{
CACA_BOLD = 0x01, /**< The style mask for bold. */
CACA_ITALICS = 0x02, /**< The style mask for italics. */
CACA_UNDERLINE = 0x04, /**< The style mask for underline. */
CACA_BLINK = 0x08, /**< The style mask for blink. */
};
/* @} */
/** \brief User event type enumeration.
*
* This enum serves two purposes:
* - Build listening masks for caca_get_event().
* - Define the type of a \e caca_event_t.
*/
enum caca_event_type
{
CACA_EVENT_NONE = 0x0000, /**< No event. */
CACA_EVENT_KEY_PRESS = 0x0001, /**< A key was pressed. */
CACA_EVENT_KEY_RELEASE = 0x0002, /**< A key was released. */
CACA_EVENT_MOUSE_PRESS = 0x0004, /**< A mouse button was pressed. */
CACA_EVENT_MOUSE_RELEASE = 0x0008, /**< A mouse button was released. */
CACA_EVENT_MOUSE_MOTION = 0x0010, /**< The mouse was moved. */
CACA_EVENT_RESIZE = 0x0020, /**< The window was resized. */
CACA_EVENT_QUIT = 0x0040, /**< The user requested to quit. */
CACA_EVENT_ANY = 0xffff /**< Bitmask for any event. */
};
/** \brief Handling of user events.
*
* This structure is filled by caca_get_event() when an event is received.
* It is an opaque structure that should only be accessed through
* caca_event_get_type() and similar functions. The struct members may no
* longer be directly accessible in future versions.
*/
struct caca_event
{
enum caca_event_type type; /**< The event type. */
union
{
struct { int x, y, button; } mouse;
struct { int w, h; } resize;
struct { int ch; uint32_t utf32; char utf8[8]; } key;
} data; /**< The event information data */
#if !defined(_DOXYGEN_SKIP_ME)
uint8_t padding[16];
#endif
};
/** \brief Special key values.
*
* Special key values returned by caca_get_event() for which there is no
* printable ASCII equivalent.
*/
enum caca_key
{
CACA_KEY_UNKNOWN = 0x00, /**< Unknown key. */
/* The following keys have ASCII equivalents */
CACA_KEY_CTRL_A = 0x01, /**< The Ctrl-A key. */
CACA_KEY_CTRL_B = 0x02, /**< The Ctrl-B key. */
CACA_KEY_CTRL_C = 0x03, /**< The Ctrl-C key. */
CACA_KEY_CTRL_D = 0x04, /**< The Ctrl-D key. */
CACA_KEY_CTRL_E = 0x05, /**< The Ctrl-E key. */
CACA_KEY_CTRL_F = 0x06, /**< The Ctrl-F key. */
CACA_KEY_CTRL_G = 0x07, /**< The Ctrl-G key. */
CACA_KEY_BACKSPACE = 0x08, /**< The backspace key. */
CACA_KEY_TAB = 0x09, /**< The tabulation key. */
CACA_KEY_CTRL_J = 0x0a, /**< The Ctrl-J key. */
CACA_KEY_CTRL_K = 0x0b, /**< The Ctrl-K key. */
CACA_KEY_CTRL_L = 0x0c, /**< The Ctrl-L key. */
CACA_KEY_RETURN = 0x0d, /**< The return key. */
CACA_KEY_CTRL_N = 0x0e, /**< The Ctrl-N key. */
CACA_KEY_CTRL_O = 0x0f, /**< The Ctrl-O key. */
CACA_KEY_CTRL_P = 0x10, /**< The Ctrl-P key. */
CACA_KEY_CTRL_Q = 0x11, /**< The Ctrl-Q key. */
CACA_KEY_CTRL_R = 0x12, /**< The Ctrl-R key. */
CACA_KEY_PAUSE = 0x13, /**< The pause key. */
CACA_KEY_CTRL_T = 0x14, /**< The Ctrl-T key. */
CACA_KEY_CTRL_U = 0x15, /**< The Ctrl-U key. */
CACA_KEY_CTRL_V = 0x16, /**< The Ctrl-V key. */
CACA_KEY_CTRL_W = 0x17, /**< The Ctrl-W key. */
CACA_KEY_CTRL_X = 0x18, /**< The Ctrl-X key. */
CACA_KEY_CTRL_Y = 0x19, /**< The Ctrl-Y key. */
CACA_KEY_CTRL_Z = 0x1a, /**< The Ctrl-Z key. */
CACA_KEY_ESCAPE = 0x1b, /**< The escape key. */
CACA_KEY_DELETE = 0x7f, /**< The delete key. */
/* The following keys do not have ASCII equivalents but have been
* chosen to match the SDL equivalents */
CACA_KEY_UP = 0x111, /**< The up arrow key. */
CACA_KEY_DOWN = 0x112, /**< The down arrow key. */
CACA_KEY_LEFT = 0x113, /**< The left arrow key. */
CACA_KEY_RIGHT = 0x114, /**< The right arrow key. */
CACA_KEY_INSERT = 0x115, /**< The insert key. */
CACA_KEY_HOME = 0x116, /**< The home key. */
CACA_KEY_END = 0x117, /**< The end key. */
CACA_KEY_PAGEUP = 0x118, /**< The page up key. */
CACA_KEY_PAGEDOWN = 0x119, /**< The page down key. */
CACA_KEY_F1 = 0x11a, /**< The F1 key. */
CACA_KEY_F2 = 0x11b, /**< The F2 key. */
CACA_KEY_F3 = 0x11c, /**< The F3 key. */
CACA_KEY_F4 = 0x11d, /**< The F4 key. */
CACA_KEY_F5 = 0x11e, /**< The F5 key. */
CACA_KEY_F6 = 0x11f, /**< The F6 key. */
CACA_KEY_F7 = 0x120, /**< The F7 key. */
CACA_KEY_F8 = 0x121, /**< The F8 key. */
CACA_KEY_F9 = 0x122, /**< The F9 key. */
CACA_KEY_F10 = 0x123, /**< The F10 key. */
CACA_KEY_F11 = 0x124, /**< The F11 key. */
CACA_KEY_F12 = 0x125, /**< The F12 key. */
CACA_KEY_F13 = 0x126, /**< The F13 key. */
CACA_KEY_F14 = 0x127, /**< The F14 key. */
CACA_KEY_F15 = 0x128 /**< The F15 key. */
};
/** \defgroup libcaca libcaca basic functions
*
* These functions provide the basic \e libcaca routines for library
* initialisation, system information retrieval and configuration.
*
* @{ */
__extern caca_canvas_t * caca_create_canvas(int, int);
__extern int caca_manage_canvas(caca_canvas_t *, int (*)(void *), void *);
__extern int caca_unmanage_canvas(caca_canvas_t *, int (*)(void *), void *);
__extern int caca_set_canvas_size(caca_canvas_t *, int, int);
__extern int caca_get_canvas_width(caca_canvas_t const *);
__extern int caca_get_canvas_height(caca_canvas_t const *);
__extern uint32_t const * caca_get_canvas_chars(caca_canvas_t const *);
__extern uint32_t const * caca_get_canvas_attrs(caca_canvas_t const *);
__extern int caca_free_canvas(caca_canvas_t *);
__extern int caca_rand(int, int);
__extern char const * caca_get_version(void);
/* @} */
/** \defgroup caca_canvas libcaca canvas drawing
*
* These functions provide low-level character printing routines and
* higher level graphics functions.
*
* @{ */
#define CACA_MAGIC_FULLWIDTH 0x000ffffe /**< Used to indicate that the previous character was a fullwidth glyph. */
__extern int caca_gotoxy(caca_canvas_t *, int, int);
__extern int caca_wherex(caca_canvas_t const *);
__extern int caca_wherey(caca_canvas_t const *);
__extern int caca_put_char(caca_canvas_t *, int, int, uint32_t);
__extern uint32_t caca_get_char(caca_canvas_t const *, int, int);
__extern int caca_put_str(caca_canvas_t *, int, int, char const *);
__extern int caca_printf(caca_canvas_t *, int, int, char const *, ...);
__extern int caca_vprintf(caca_canvas_t *, int, int, char const *, va_list);
__extern int caca_clear_canvas(caca_canvas_t *);
__extern int caca_set_canvas_handle(caca_canvas_t *, int, int);
__extern int caca_get_canvas_handle_x(caca_canvas_t const *);
__extern int caca_get_canvas_handle_y(caca_canvas_t const *);
__extern int caca_blit(caca_canvas_t *, int, int, caca_canvas_t const *,
caca_canvas_t const *);
__extern int caca_set_canvas_boundaries(caca_canvas_t *, int, int, int, int);
/* @} */
/** \defgroup caca_dirty libcaca dirty rectangle manipulation
*
* These functions manipulate dirty rectangles for optimised blitting.
* @{ */
__extern int caca_disable_dirty_rect(caca_canvas_t *);
__extern int caca_enable_dirty_rect(caca_canvas_t *);
__extern int caca_get_dirty_rect_count(caca_canvas_t *);
__extern int caca_get_dirty_rect(caca_canvas_t *, int, int *, int *,
int *, int *);
__extern int caca_add_dirty_rect(caca_canvas_t *, int, int, int, int);
__extern int caca_remove_dirty_rect(caca_canvas_t *, int, int, int, int);
__extern int caca_clear_dirty_rect_list(caca_canvas_t *);
/* @} */
/** \defgroup caca_transform libcaca canvas transformation
*
* These functions perform horizontal and vertical canvas flipping.
*
* @{ */
__extern int caca_invert(caca_canvas_t *);
__extern int caca_flip(caca_canvas_t *);
__extern int caca_flop(caca_canvas_t *);
__extern int caca_rotate_180(caca_canvas_t *);
__extern int caca_rotate_left(caca_canvas_t *);
__extern int caca_rotate_right(caca_canvas_t *);
__extern int caca_stretch_left(caca_canvas_t *);
__extern int caca_stretch_right(caca_canvas_t *);
/* @} */
/** \defgroup caca_attributes libcaca attribute conversions
*
* These functions perform conversions between attribute values.
*
* @{ */
__extern uint32_t caca_get_attr(caca_canvas_t const *, int, int);
__extern int caca_set_attr(caca_canvas_t *, uint32_t);
__extern int caca_unset_attr(caca_canvas_t *, uint32_t);
__extern int caca_toggle_attr(caca_canvas_t *, uint32_t);
__extern int caca_put_attr(caca_canvas_t *, int, int, uint32_t);
__extern int caca_set_color_ansi(caca_canvas_t *, uint8_t, uint8_t);
__extern int caca_set_color_argb(caca_canvas_t *, uint16_t, uint16_t);
__extern uint8_t caca_attr_to_ansi(uint32_t);
__extern uint8_t caca_attr_to_ansi_fg(uint32_t);
__extern uint8_t caca_attr_to_ansi_bg(uint32_t);
__extern uint16_t caca_attr_to_rgb12_fg(uint32_t);
__extern uint16_t caca_attr_to_rgb12_bg(uint32_t);
__extern void caca_attr_to_argb64(uint32_t, uint8_t[8]);
/* @} */
/** \defgroup caca_charset libcaca character set conversions
*
* These functions perform conversions between usual character sets.
*
* @{ */
__extern uint32_t caca_utf8_to_utf32(char const *, size_t *);
__extern size_t caca_utf32_to_utf8(char *, uint32_t);
__extern uint8_t caca_utf32_to_cp437(uint32_t);
__extern uint32_t caca_cp437_to_utf32(uint8_t);
__extern char caca_utf32_to_ascii(uint32_t);
__extern int caca_utf32_is_fullwidth(uint32_t);
/* @} */
/** \defgroup caca_primitives libcaca primitives drawing
*
* These functions provide routines for primitive drawing, such as lines,
* boxes, triangles and ellipses.
*
* @{ */
__extern int caca_draw_line(caca_canvas_t *, int, int, int, int, uint32_t);
__extern int caca_draw_polyline(caca_canvas_t *, int const x[],
int const y[], int, uint32_t);
__extern int caca_draw_thin_line(caca_canvas_t *, int, int, int, int);
__extern int caca_draw_thin_polyline(caca_canvas_t *, int const x[],
int const y[], int);
__extern int caca_draw_circle(caca_canvas_t *, int, int, int, uint32_t);
__extern int caca_draw_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
__extern int caca_draw_thin_ellipse(caca_canvas_t *, int, int, int, int);
__extern int caca_fill_ellipse(caca_canvas_t *, int, int, int, int, uint32_t);
__extern int caca_draw_box(caca_canvas_t *, int, int, int, int, uint32_t);
__extern int caca_draw_thin_box(caca_canvas_t *, int, int, int, int);
__extern int caca_draw_cp437_box(caca_canvas_t *, int, int, int, int);
__extern int caca_fill_box(caca_canvas_t *, int, int, int, int, uint32_t);
__extern int caca_draw_triangle(caca_canvas_t *, int, int, int, int, int,
int, uint32_t);
__extern int caca_draw_thin_triangle(caca_canvas_t *, int, int, int, int,
int, int);
__extern int caca_fill_triangle(caca_canvas_t *, int, int, int, int, int,
int, uint32_t);
__extern int caca_fill_triangle_textured(caca_canvas_t *cv,
int coords[6],
caca_canvas_t *tex,
float uv[6]);
/* @} */
/** \defgroup caca_frame libcaca canvas frame handling
*
* These functions provide high level routines for canvas frame insertion,
* removal, copying etc.
*
* @{ */
__extern int caca_get_frame_count(caca_canvas_t const *);
__extern int caca_set_frame(caca_canvas_t *, int);
__extern char const *caca_get_frame_name(caca_canvas_t const *);
__extern int caca_set_frame_name(caca_canvas_t *, char const *);
__extern int caca_create_frame(caca_canvas_t *, int);
__extern int caca_free_frame(caca_canvas_t *, int);
/* @} */
/** \defgroup caca_dither libcaca bitmap dithering
*
* These functions provide high level routines for dither allocation and
* rendering.
*
* @{ */
__extern caca_dither_t *caca_create_dither(int, int, int, int,
uint32_t, uint32_t,
uint32_t, uint32_t);
__extern int caca_set_dither_palette(caca_dither_t *,
uint32_t r[], uint32_t g[],
uint32_t b[], uint32_t a[]);
__extern int caca_set_dither_brightness(caca_dither_t *, float);
__extern float caca_get_dither_brightness(caca_dither_t const *);
__extern int caca_set_dither_gamma(caca_dither_t *, float);
__extern float caca_get_dither_gamma(caca_dither_t const *);
__extern int caca_set_dither_contrast(caca_dither_t *, float);
__extern float caca_get_dither_contrast(caca_dither_t const *);
__extern int caca_set_dither_antialias(caca_dither_t *, char const *);
__extern char const * const * caca_get_dither_antialias_list(caca_dither_t
const *);
__extern char const * caca_get_dither_antialias(caca_dither_t const *);
__extern int caca_set_dither_color(caca_dither_t *, char const *);
__extern char const * const * caca_get_dither_color_list(caca_dither_t
const *);
__extern char const * caca_get_dither_color(caca_dither_t const *);
__extern int caca_set_dither_charset(caca_dither_t *, char const *);
__extern char const * const * caca_get_dither_charset_list(caca_dither_t
const *);
__extern char const * caca_get_dither_charset(caca_dither_t const *);
__extern int caca_set_dither_algorithm(caca_dither_t *, char const *);
__extern char const * const * caca_get_dither_algorithm_list(caca_dither_t
const *);
__extern char const * caca_get_dither_algorithm(caca_dither_t const *);
__extern int caca_dither_bitmap(caca_canvas_t *, int, int, int, int,
caca_dither_t const *, void const *);
__extern int caca_free_dither(caca_dither_t *);
/* @} */
/** \defgroup caca_font libcaca font handling
*
* These functions provide font handling routines and high quality
* canvas to bitmap rendering.
*
* @{ */
__extern caca_font_t *caca_load_font(void const *, size_t);
__extern char const * const * caca_get_font_list(void);
__extern int caca_get_font_width(caca_font_t const *);
__extern int caca_get_font_height(caca_font_t const *);
__extern uint32_t const *caca_get_font_blocks(caca_font_t const *);
__extern int caca_render_canvas(caca_canvas_t const *, caca_font_t const *,
void *, int, int, int);
__extern int caca_free_font(caca_font_t *);
/* @} */
/** \defgroup caca_figfont libcaca FIGfont handling
*
* These functions provide FIGlet and TOIlet font handling routines.
*
* @{ */
__extern int caca_canvas_set_figfont(caca_canvas_t *, char const *);
__extern int caca_put_figchar(caca_canvas_t *, uint32_t);
__extern int caca_flush_figlet(caca_canvas_t *);
/* @} */
/** \defgroup caca_file libcaca file IO
*
* These functions allow to read and write files in a platform-independent
* way.
* @{ */
__extern caca_file_t *caca_file_open(char const *, const char *);
__extern int caca_file_close(caca_file_t *);
__extern uint64_t caca_file_tell(caca_file_t *);
__extern size_t caca_file_read(caca_file_t *, void *, size_t);
__extern size_t caca_file_write(caca_file_t *, const void *, size_t);
__extern char * caca_file_gets(caca_file_t *, char *, int);
__extern int caca_file_eof(caca_file_t *);
/* @} */
/** \defgroup caca_importexport libcaca importers/exporters from/to various
* formats
*
* These functions import various file formats into a new canvas, or export
* the current canvas to various text formats.
*
* @{ */
__extern ssize_t caca_import_canvas_from_memory(caca_canvas_t *, void const *,
size_t, char const *);
__extern ssize_t caca_import_canvas_from_file(caca_canvas_t *, char const *,
char const *);
__extern ssize_t caca_import_area_from_memory(caca_canvas_t *, int, int,
void const *, size_t,
char const *);
__extern ssize_t caca_import_area_from_file(caca_canvas_t *, int, int,
char const *, char const *);
__extern char const * const * caca_get_import_list(void);
__extern void *caca_export_canvas_to_memory(caca_canvas_t const *,
char const *, size_t *);
__extern void *caca_export_area_to_memory(caca_canvas_t const *, int, int,
int, int, char const *, size_t *);
__extern char const * const * caca_get_export_list(void);
/* @} */
/** \defgroup caca_display libcaca display functions
*
* These functions provide the basic \e libcaca routines for display
* initialisation, system information retrieval and configuration.
*
* @{ */
__extern caca_display_t * caca_create_display(caca_canvas_t *);
__extern caca_display_t * caca_create_display_with_driver(caca_canvas_t *,
char const *);
__extern char const * const * caca_get_display_driver_list(void);
__extern char const * caca_get_display_driver(caca_display_t *);
__extern int caca_set_display_driver(caca_display_t *, char const *);
__extern int caca_free_display(caca_display_t *);
__extern caca_canvas_t * caca_get_canvas(caca_display_t *);
__extern int caca_refresh_display(caca_display_t *);
__extern int caca_set_display_time(caca_display_t *, int);
__extern int caca_get_display_time(caca_display_t const *);
__extern int caca_get_display_width(caca_display_t const *);
__extern int caca_get_display_height(caca_display_t const *);
__extern int caca_set_display_title(caca_display_t *, char const *);
__extern int caca_set_mouse(caca_display_t *, int);
__extern int caca_set_cursor(caca_display_t *, int);
/* @} */
/** \defgroup caca_event libcaca event handling
*
* These functions handle user events such as keyboard input and mouse
* clicks.
*
* @{ */
__extern int caca_get_event(caca_display_t *, int, caca_event_t *, int);
__extern int caca_get_mouse_x(caca_display_t const *);
__extern int caca_get_mouse_y(caca_display_t const *);
__extern enum caca_event_type caca_get_event_type(caca_event_t const *);
__extern int caca_get_event_key_ch(caca_event_t const *);
__extern uint32_t caca_get_event_key_utf32(caca_event_t const *);
__extern int caca_get_event_key_utf8(caca_event_t const *, char *);
__extern int caca_get_event_mouse_button(caca_event_t const *);
__extern int caca_get_event_mouse_x(caca_event_t const *);
__extern int caca_get_event_mouse_y(caca_event_t const *);
__extern int caca_get_event_resize_width(caca_event_t const *);
__extern int caca_get_event_resize_height(caca_event_t const *);
/* @} */
/** \brief DOS colours
*
* This enum lists the colour values for the DOS conio.h compatibility
* layer.
*/
enum CACA_CONIO_COLORS
{
CACA_CONIO_BLINK = 128,
CACA_CONIO_BLACK = 0,
CACA_CONIO_BLUE = 1,
CACA_CONIO_GREEN = 2,
CACA_CONIO_CYAN = 3,
CACA_CONIO_RED = 4,
CACA_CONIO_MAGENTA = 5,
CACA_CONIO_BROWN = 6,
CACA_CONIO_LIGHTGRAY = 7,
CACA_CONIO_DARKGRAY = 8,
CACA_CONIO_LIGHTBLUE = 9,
CACA_CONIO_LIGHTGREEN = 10,
CACA_CONIO_LIGHTCYAN = 11,
CACA_CONIO_LIGHTRED = 12,
CACA_CONIO_LIGHTMAGENTA = 13,
CACA_CONIO_YELLOW = 14,
CACA_CONIO_WHITE = 15,
};
/** \brief DOS cursor modes
*
* This enum lists the cursor mode values for the DOS conio.h compatibility
* layer.
*/
enum CACA_CONIO_CURSOR
{
CACA_CONIO__NOCURSOR = 0,
CACA_CONIO__SOLIDCURSOR = 1,
CACA_CONIO__NORMALCURSOR = 2,
};
/** \brief DOS video modes
*
* This enum lists the video mode values for the DOS conio.h compatibility
* layer.
*/
enum CACA_CONIO_MODE
{
CACA_CONIO_LASTMODE = -1,
CACA_CONIO_BW40 = 0,
CACA_CONIO_C40 = 1,
CACA_CONIO_BW80 = 2,
CACA_CONIO_C80 = 3,
CACA_CONIO_MONO = 7,
CACA_CONIO_C4350 = 64,
};
/** \brief DOS text area information
*
* This structure stores text area information for the DOS conio.h
* compatibility layer.
*/
struct caca_conio_text_info
{
unsigned char winleft; /**< left window coordinate */
unsigned char wintop; /**< top window coordinate */
unsigned char winright; /**< right window coordinate */
unsigned char winbottom; /**< bottom window coordinate */
unsigned char attribute; /**< text attribute */
unsigned char normattr; /**< normal attribute */
unsigned char currmode; /**< current video mode:
BW40, BW80, C40, C80, or C4350 */
unsigned char screenheight; /**< text screen's height */
unsigned char screenwidth; /**< text screen's width */
unsigned char curx; /**< x-coordinate in current window */
unsigned char cury; /**< y-coordinate in current window */
};
/** \brief DOS direct video control */
__extern int caca_conio_directvideo;
/** \brief DOS scrolling control */
__extern int caca_conio__wscroll;
/** \defgroup conio libcaca DOS conio.h compatibility layer
*
* These functions implement DOS-like functions for high-level text
* operations.
*
* @{ */
__extern char * caca_conio_cgets(char *str);
__extern void caca_conio_clreol(void);
__extern void caca_conio_clrscr(void);
__extern int caca_conio_cprintf(const char *format, ...);
__extern int caca_conio_cputs(const char *str);
__extern int caca_conio_cscanf(char *format, ...);
__extern void caca_conio_delay(unsigned int);
__extern void caca_conio_delline(void);
__extern int caca_conio_getch(void);
__extern int caca_conio_getche(void);
__extern char * caca_conio_getpass(const char *prompt);
__extern int caca_conio_gettext(int left, int top, int right, int bottom,
void *destin);
__extern void caca_conio_gettextinfo(struct caca_conio_text_info *r);
__extern void caca_conio_gotoxy(int x, int y);
__extern void caca_conio_highvideo(void);
__extern void caca_conio_insline(void);
__extern int caca_conio_kbhit(void);
__extern void caca_conio_lowvideo(void);
__extern int caca_conio_movetext(int left, int top, int right, int bottom,
int destleft, int desttop);
__extern void caca_conio_normvideo(void);
__extern void caca_conio_nosound(void);
__extern int caca_conio_printf(const char *format, ...);
__extern int caca_conio_putch(int ch);
__extern int caca_conio_puttext(int left, int top, int right, int bottom,
void *destin);
__extern void caca_conio__setcursortype(int cur_t);
__extern void caca_conio_sleep(unsigned int);
__extern void caca_conio_sound(unsigned int);
__extern void caca_conio_textattr(int newattr);
__extern void caca_conio_textbackground(int newcolor);
__extern void caca_conio_textcolor(int newcolor);
__extern void caca_conio_textmode(int newmode);
__extern int caca_conio_ungetch(int ch);
__extern int caca_conio_wherex(void);
__extern int caca_conio_wherey(void);
__extern void caca_conio_window(int left, int top, int right, int bottom);
/* @} */
#if !defined(_DOXYGEN_SKIP_ME)
/* Legacy stuff from beta versions, will probably disappear in 1.0 */
typedef struct cucul_buffer cucul_buffer_t;
# if defined __GNUC__ && __GNUC__ >= 3
# define CACA_DEPRECATED __attribute__ ((__deprecated__))
# else
# define CACA_DEPRECATED
# endif
# if defined __GNUC__ && __GNUC__ > 3
# define CACA_ALIAS(x) __attribute__ ((weak, alias(#x)))
# else
# define CACA_ALIAS(x)
# endif
/* Aliases from old libcaca and libcucul functions */
__extern int cucul_putchar(caca_canvas_t *, int, int,
unsigned long int) CACA_DEPRECATED;
__extern unsigned long int cucul_getchar(caca_canvas_t *,
int, int) CACA_DEPRECATED;
__extern int cucul_putstr(caca_canvas_t *, int, int,
char const *) CACA_DEPRECATED;
__extern int cucul_set_color(caca_canvas_t *, unsigned char,
unsigned char) CACA_DEPRECATED;
__extern int cucul_set_truecolor(caca_canvas_t *, unsigned int,
unsigned int) CACA_DEPRECATED;
__extern unsigned int cucul_get_canvas_frame_count(caca_canvas_t *)
CACA_DEPRECATED;
__extern int cucul_set_canvas_frame(caca_canvas_t *,
unsigned int) CACA_DEPRECATED;
__extern int cucul_create_canvas_frame(caca_canvas_t *,
unsigned int) CACA_DEPRECATED;
__extern int cucul_free_canvas_frame(caca_canvas_t *,
unsigned int) CACA_DEPRECATED;
__extern cucul_buffer_t *cucul_load_memory(void *,
unsigned long int) CACA_DEPRECATED;
__extern cucul_buffer_t *cucul_load_file(char const *) CACA_DEPRECATED;
__extern unsigned long int cucul_get_buffer_size(cucul_buffer_t *)
CACA_DEPRECATED;
__extern void * cucul_get_buffer_data(cucul_buffer_t *) CACA_DEPRECATED;
__extern int cucul_free_buffer(cucul_buffer_t *) CACA_DEPRECATED;
__extern cucul_buffer_t * cucul_export_canvas(caca_canvas_t *,
char const *) CACA_DEPRECATED;
__extern caca_canvas_t * cucul_import_canvas(cucul_buffer_t *,
char const *) CACA_DEPRECATED;
__extern ssize_t caca_import_memory(caca_canvas_t *, void const *, size_t,
char const *) CACA_DEPRECATED;
__extern ssize_t caca_import_file(caca_canvas_t *, char const *,
char const *) CACA_DEPRECATED;
__extern void *caca_export_memory(caca_canvas_t const *, char const *,
size_t *) CACA_DEPRECATED;
__extern int cucul_rotate(caca_canvas_t *) CACA_DEPRECATED;
__extern int cucul_set_dither_invert(caca_dither_t *, int) CACA_DEPRECATED;
__extern int cucul_set_dither_mode(caca_dither_t *,
char const *) CACA_DEPRECATED;
__extern char const * const * cucul_get_dither_mode_list(caca_dither_t const *)
CACA_DEPRECATED;
# define CUCUL_COLOR_BLACK CACA_BLACK
# define CUCUL_COLOR_BLUE CACA_BLUE
# define CUCUL_COLOR_GREEN CACA_GREEN
# define CUCUL_COLOR_CYAN CACA_CYAN
# define CUCUL_COLOR_RED CACA_RED
# define CUCUL_COLOR_MAGENTA CACA_MAGENTA
# define CUCUL_COLOR_BROWN CACA_BROWN
# define CUCUL_COLOR_LIGHTGRAY CACA_LIGHTGRAY
# define CUCUL_COLOR_DARKGRAY CACA_DARKGRAY
# define CUCUL_COLOR_LIGHTBLUE CACA_LIGHTBLUE
# define CUCUL_COLOR_LIGHTGREEN CACA_LIGHTGREEN
# define CUCUL_COLOR_LIGHTCYAN CACA_LIGHTCYAN
# define CUCUL_COLOR_LIGHTRED CACA_LIGHTRED
# define CUCUL_COLOR_LIGHTMAGENTA CACA_LIGHTMAGENTA
# define CUCUL_COLOR_YELLOW CACA_YELLOW
# define CUCUL_COLOR_WHITE CACA_YELLOW
# define CUCUL_COLOR_DEFAULT CACA_DEFAULT
# define CUCUL_COLOR_TRANSPARENT CACA_TRANSPARENT
/* Aliases from the libcucul/libcaca merge */
# define cucul_canvas_t caca_canvas_t
# define cucul_dither_t caca_dither_t
# define cucul_font_t caca_font_t
# define cucul_file_t caca_file_t
# define cucul_display_t caca_display_t
# define cucul_event_t caca_event_t
# define CUCUL_BLACK CACA_BLACK
# define CUCUL_BLUE CACA_BLUE
# define CUCUL_GREEN CACA_GREEN
# define CUCUL_CYAN CACA_CYAN
# define CUCUL_RED CACA_RED
# define CUCUL_MAGENTA CACA_MAGENTA
# define CUCUL_BROWN CACA_BROWN
# define CUCUL_LIGHTGRAY CACA_LIGHTGRAY
# define CUCUL_DARKGRAY CACA_DARKGRAY
# define CUCUL_LIGHTBLUE CACA_LIGHTBLUE
# define CUCUL_LIGHTGREEN CACA_LIGHTGREEN
# define CUCUL_LIGHTCYAN CACA_LIGHTCYAN
# define CUCUL_LIGHTRED CACA_LIGHTRED
# define CUCUL_LIGHTMAGENTA CACA_LIGHTMAGENTA
# define CUCUL_YELLOW CACA_YELLOW
# define CUCUL_WHITE CACA_YELLOW
# define CUCUL_DEFAULT CACA_DEFAULT
# define CUCUL_TRANSPARENT CACA_TRANSPARENT
# define CUCUL_BOLD CACA_BOLD
# define CUCUL_ITALICS CACA_ITALICS
# define CUCUL_UNDERLINE CACA_UNDERLINE
# define CUCUL_BLINK CACA_BLINK
# if !defined __LIBCACA__
# define caca_get_cursor_x caca_wherex
# define caca_get_cursor_y caca_wherey
# define cucul_draw_triangle caca_draw_triangle
# define cucul_draw_thin_triangle caca_draw_thin_triangle
# define cucul_fill_triangle caca_fill_triangle
# define cucul_load_font caca_load_font
# define cucul_get_font_list caca_get_font_list
# define cucul_get_font_width caca_get_font_width
# define cucul_get_font_height caca_get_font_height
# define cucul_get_font_blocks caca_get_font_blocks
# define cucul_render_canvas caca_render_canvas
# define cucul_free_font caca_free_font
# define cucul_gotoxy caca_gotoxy
# define cucul_get_cursor_x caca_wherex
# define cucul_get_cursor_y caca_wherey
# define cucul_put_char caca_put_char
# define cucul_get_char caca_get_char
# define cucul_put_str caca_put_str
# define cucul_printf caca_printf
# define cucul_clear_canvas caca_clear_canvas
# define cucul_set_canvas_handle caca_set_canvas_handle
# define cucul_get_canvas_handle_x caca_get_canvas_handle_x
# define cucul_get_canvas_handle_y caca_get_canvas_handle_y
# define cucul_blit caca_blit
# define cucul_set_canvas_boundaries caca_set_canvas_boundaries
# define cucul_import_memory caca_import_memory
# define cucul_import_file caca_import_file
# define cucul_get_import_list caca_get_import_list
# define cucul_create_canvas caca_create_canvas
# define cucul_manage_canvas caca_manage_canvas
# define cucul_unmanage_canvas caca_unmanage_canvas
# define cucul_set_canvas_size caca_set_canvas_size
# define cucul_get_canvas_width caca_get_canvas_width
# define cucul_get_canvas_height caca_get_canvas_height
# define cucul_get_canvas_chars caca_get_canvas_chars
# define cucul_get_canvas_attrs caca_get_canvas_attrs
# define cucul_free_canvas caca_free_canvas
# define cucul_rand caca_rand
# define cucul_export_memory caca_export_memory
# define cucul_get_export_list caca_get_export_list
# define cucul_get_version caca_get_version
# define cucul_utf8_to_utf32 caca_utf8_to_utf32
# define cucul_utf32_to_utf8 caca_utf32_to_utf8
# define cucul_utf32_to_cp437 caca_utf32_to_cp437
# define cucul_cp437_to_utf32 caca_cp437_to_utf32
# define cucul_utf32_to_ascii caca_utf32_to_ascii
# define cucul_utf32_is_fullwidth caca_utf32_is_fullwidth
# define cucul_draw_circle caca_draw_circle
# define cucul_draw_ellipse caca_draw_ellipse
# define cucul_draw_thin_ellipse caca_draw_thin_ellipse
# define cucul_fill_ellipse caca_fill_ellipse
# define cucul_canvas_set_figfont caca_canvas_set_figfont
# define cucul_put_figchar caca_put_figchar
# define cucul_flush_figlet caca_flush_figlet
# define cucul_putchar caca_putchar
# define cucul_getchar caca_getchar
# define cucul_get_attr caca_get_attr
# define cucul_set_attr caca_set_attr
# define cucul_put_attr caca_put_attr
# define cucul_set_color_ansi caca_set_color_ansi
# define cucul_set_color_argb caca_set_color_argb
# define cucul_attr_to_ansi caca_attr_to_ansi
# define cucul_attr_to_ansi_fg caca_attr_to_ansi_fg
# define cucul_attr_to_ansi_bg caca_attr_to_ansi_bg
# define cucul_attr_to_rgb12_fg caca_attr_to_rgb12_fg
# define cucul_attr_to_rgb12_bg caca_attr_to_rgb12_bg
# define cucul_attr_to_argb64 caca_attr_to_argb64
# define cucul_invert caca_invert
# define cucul_flip caca_flip
# define cucul_flop caca_flop
# define cucul_rotate_180 caca_rotate_180
# define cucul_rotate_left caca_rotate_left
# define cucul_rotate_right caca_rotate_right
# define cucul_stretch_left caca_stretch_left
# define cucul_stretch_right caca_stretch_right
# define cucul_file_open caca_file_open
# define cucul_file_close caca_file_close
# define cucul_file_tell caca_file_tell
# define cucul_file_read caca_file_read
# define cucul_file_write caca_file_write
# define cucul_file_gets caca_file_gets
# define cucul_file_eof caca_file_eof
# define cucul_create_dither caca_create_dither
# define cucul_set_dither_palette caca_set_dither_palette
# define cucul_set_dither_brightness caca_set_dither_brightness
# define cucul_get_dither_brightness caca_get_dither_brightness
# define cucul_set_dither_gamma caca_set_dither_gamma
# define cucul_get_dither_gamma caca_get_dither_gamma
# define cucul_set_dither_contrast caca_set_dither_contrast
# define cucul_get_dither_contrast caca_get_dither_contrast
# define cucul_set_dither_antialias caca_set_dither_antialias
# define cucul_get_dither_antialias_list caca_get_dither_antialias_list
# define cucul_get_dither_antialias caca_get_dither_antialias
# define cucul_set_dither_color caca_set_dither_color
# define cucul_get_dither_color_list caca_get_dither_color_list
# define cucul_get_dither_color caca_get_dither_color
# define cucul_set_dither_charset caca_set_dither_charset
# define cucul_get_dither_charset_list caca_get_dither_charset_list
# define cucul_get_dither_charset caca_get_dither_charset
# define cucul_set_dither_algorithm caca_set_dither_algorithm
# define cucul_get_dither_algorithm_list caca_get_dither_algorithm_list
# define cucul_get_dither_algorithm caca_get_dither_algorithm
# define cucul_dither_bitmap caca_dither_bitmap
# define cucul_free_dither caca_free_dither
# define cucul_draw_line caca_draw_line
# define cucul_draw_polyline caca_draw_polyline
# define cucul_draw_thin_line caca_draw_thin_line
# define cucul_draw_thin_polyline caca_draw_thin_polyline
# define cucul_draw_box caca_draw_box
# define cucul_draw_thin_box caca_draw_thin_box
# define cucul_draw_cp437_box caca_draw_cp437_box
# define cucul_fill_box caca_fill_box
# define cucul_get_frame_count caca_get_frame_count
# define cucul_set_frame caca_set_frame
# define cucul_get_frame_name caca_get_frame_name
# define cucul_set_frame_name caca_set_frame_name
# define cucul_create_frame caca_create_frame
# define cucul_free_frame caca_free_frame
# endif
#endif
#ifdef __cplusplus
}
#endif
#undef __extern
#endif /* __CACA_H__ */
|