cacalabs
/
libcaca
kopia lustrzana https://github.com/cacalabs/libcaca.git
1
0
Forkuj 0
Kod Zgłoszenia 0 Wydania 7 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
548 Commity
1 Gałąź
15 MiB
 
 
 
 
 
 
Drzewo: ea780d5321
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z 'ea780d5321'
${ noResults }
libcaca/cucul/cucul.h

218 wiersze
8.1 KiB
Czysty Wina Historia 

  1. /*

  2.  *  libcucul      Canvas for ultrafast compositing of Unicode letters

  3.  *  Copyright (c) 2002-2006 Sam Hocevar <sam@zoy.org>

  4.  *                All Rights Reserved

  5.  *

  6.  *  This library is free software; you can redistribute it and/or

  7.  *  modify it under the terms of the Do What The Fuck You Want To

  8.  *  Public License, Version 2, as published by Sam Hocevar. See

  9.  *  http://sam.zoy.org/wtfpl/COPYING for more details.

  10.  */

  11. 

  12. /** \file cucul.h

  13.  *  \version \$Id$

  14.  *  \author Sam Hocevar <sam@zoy.org>

  15.  *  \brief The \e libcucul public header.

  16.  *

  17.  *  This header contains the public types and functions that applications

  18.  *  using \e libcucul may use.

  19.  */

  20. 

  21. #ifndef __CUCUL_H__

  22. #define __CUCUL_H__

  23. 

  24. #define CUCUL_API_VERSION_1

  25. 

  26. #ifdef __cplusplus

  27. extern "C"

  28. {

  29. #endif

  30. 

  31. typedef struct cucul_context cucul_t;

  32. 

  33. struct cucul_buffer

  34. {

  35.     unsigned int size;

  36.     char *data;

  37. };

  38. 

  39. /** \defgroup colour Colour definitions

  40.  *

  41.  *  Colours that can be used with cucul_set_color().

  42.  *

  43.  *  @{ */

  44. #define CUCUL_COLOR_BLACK 0x00 /**< The colour index for black. */

  45. #define CUCUL_COLOR_BLUE 0x01 /**< The colour index for blue. */

  46. #define CUCUL_COLOR_GREEN 0x02 /**< The colour index for green. */

  47. #define CUCUL_COLOR_CYAN 0x03 /**< The colour index for cyan. */

  48. #define CUCUL_COLOR_RED 0x04 /**< The colour index for red. */

  49. #define CUCUL_COLOR_MAGENTA 0x05 /**< The colour index for magenta. */

  50. #define CUCUL_COLOR_BROWN 0x06 /**< The colour index for brown. */

  51. #define CUCUL_COLOR_LIGHTGRAY 0x07 /**< The colour index for light gray. */

  52. #define CUCUL_COLOR_DARKGRAY 0x08 /**< The colour index for dark gray. */

  53. #define CUCUL_COLOR_LIGHTBLUE 0x09 /**< The colour index for blue. */

  54. #define CUCUL_COLOR_LIGHTGREEN 0x0a /**< The colour index for light green. */

  55. #define CUCUL_COLOR_LIGHTCYAN 0x0b /**< The colour index for light cyan. */

  56. #define CUCUL_COLOR_LIGHTRED 0x0c /**< The colour index for light red. */

  57. #define CUCUL_COLOR_LIGHTMAGENTA 0x0d /**< The colour index for light magenta. */

  58. #define CUCUL_COLOR_YELLOW 0x0e /**< The colour index for yellow. */

  59. #define CUCUL_COLOR_WHITE 0x0f /**< The colour index for white. */

  60. #define CUCUL_COLOR_DEFAULT 0x10 /**< The output driver's default colour. */

  61. #define CUCUL_COLOR_TRANSPARENT 0x20 /**< The transparent colour. */

  62. /*  @} */

  63. 

  64. /** \defgroup basic Basic functions

  65.  *

  66.  *  These functions provide the basic \e libcaca routines for library

  67.  *  initialisation, system information retrieval and configuration.

  68.  *

  69.  *  @{ */

  70. cucul_t * cucul_create(unsigned int, unsigned int);

  71. cucul_t * cucul_load(void *, unsigned int);

  72. void cucul_set_size(cucul_t *, unsigned int, unsigned int);

  73. unsigned int cucul_get_width(cucul_t *);

  74. unsigned int cucul_get_height(cucul_t *);

  75. void cucul_free(cucul_t *);

  76. /*  @} */

  77. 

  78. /** \defgroup canvas Canvas drawing

  79.  *

  80.  *  These functions provide low-level character printing routines and

  81.  *  higher level graphics functions.

  82.  *

  83.  *  @{ */

  84. void cucul_set_color(cucul_t *, unsigned int, unsigned int);

  85. char const *cucul_get_color_name(unsigned int);

  86. void cucul_putchar(cucul_t *, int, int, char);

  87. void cucul_putstr(cucul_t *, int, int, char const *);

  88. void cucul_printf(cucul_t *, int, int, char const *, ...);

  89. void cucul_clear(cucul_t *);

  90. void cucul_blit(cucul_t *, int, int, cucul_t const *, cucul_t const *);

  91. /*  @} */

  92. 

  93. /** \defgroup transform Canvas transformation

  94.  *

  95.  *  These functions perform horizontal and vertical canvas flipping.

  96.  *

  97.  *  @{ */

  98. void cucul_invert(cucul_t *);

  99. void cucul_flip(cucul_t *);

  100. void cucul_flop(cucul_t *);

  101. void cucul_rotate(cucul_t *);

  102. /*  @} */

  103. 

  104. /** \defgroup prim Primitives drawing

  105.  *

  106.  *  These functions provide routines for primitive drawing, such as lines,

  107.  *  boxes, triangles and ellipses.

  108.  *

  109.  *  @{ */

  110. void cucul_draw_line(cucul_t *, int, int, int, int, char const *);

  111. void cucul_draw_polyline(cucul_t *, int const x[], int const y[], int, char const *);

  112. void cucul_draw_thin_line(cucul_t *, int, int, int, int);

  113. void cucul_draw_thin_polyline(cucul_t *, int const x[], int const y[], int);

  114. 

  115. void cucul_draw_circle(cucul_t *, int, int, int, char const *);

  116. void cucul_draw_ellipse(cucul_t *, int, int, int, int, char const *);

  117. void cucul_draw_thin_ellipse(cucul_t *, int, int, int, int);

  118. void cucul_fill_ellipse(cucul_t *, int, int, int, int, char const *);

  119. 

  120. void cucul_draw_box(cucul_t *, int, int, int, int, char const *);

  121. void cucul_draw_thin_box(cucul_t *, int, int, int, int);

  122. void cucul_fill_box(cucul_t *, int, int, int, int, char const *);

  123. 

  124. void cucul_draw_triangle(cucul_t *, int, int, int, int, int, int, char const *);

  125. void cucul_draw_thin_triangle(cucul_t *, int, int, int, int, int, int);

  126. void cucul_fill_triangle(cucul_t *, int, int, int, int, int, int, char const *);

  127. /*  @} */

  128. 

  129. /** \defgroup math Mathematical functions

  130.  *

  131.  *  These functions provide a few useful math-related routines.

  132.  *

  133.  *  @{ */

  134. int cucul_rand(int, int);

  135. unsigned int cucul_sqrt(unsigned int);

  136. /*  @} */

  137. 

  138. /** \defgroup sprite Sprite handling

  139.  *

  140.  *  These functions provide high level routines for sprite loading, animation

  141.  *  and rendering.

  142.  *

  143.  *  @{ */

  144. struct cucul_sprite;

  145. struct cucul_sprite * cucul_load_sprite(cucul_t *, char const *);

  146. int cucul_get_sprite_frames(cucul_t *, struct cucul_sprite const *);

  147. int cucul_get_sprite_width(cucul_t *, struct cucul_sprite const *, int);

  148. int cucul_get_sprite_height(cucul_t *, struct cucul_sprite const *, int);

  149. int cucul_get_sprite_dx(cucul_t *, struct cucul_sprite const *, int);

  150. int cucul_get_sprite_dy(cucul_t *, struct cucul_sprite const *, int);

  151. void cucul_draw_sprite(cucul_t *, int, int, struct cucul_sprite const *, int);

  152. void cucul_free_sprite(struct cucul_sprite *);

  153. /*  @} */

  154. 

  155. /** \defgroup dither Bitmap dithering

  156.  *

  157.  *  These functions provide high level routines for dither allocation and

  158.  *  rendering.

  159.  *

  160.  *  @{ */

  161. struct cucul_dither;

  162. struct cucul_dither *cucul_create_dither(unsigned int, unsigned int,

  163.                                          unsigned int, unsigned int,

  164.                                          unsigned int, unsigned int,

  165.                                          unsigned int, unsigned int);

  166. void cucul_set_dither_palette(struct cucul_dither *,

  167.                               unsigned int r[], unsigned int g[],

  168.                               unsigned int b[], unsigned int a[]);

  169. void cucul_set_dither_brightness(struct cucul_dither *, float);

  170. void cucul_set_dither_gamma(struct cucul_dither *, float);

  171. void cucul_set_dither_contrast(struct cucul_dither *, float);

  172. void cucul_set_dither_invert(struct cucul_dither *, int);

  173. void cucul_set_dither_antialias(struct cucul_dither *, char const *);

  174. char const * const * cucul_get_dither_antialias_list(struct cucul_dither const *);

  175. void cucul_set_dither_color(struct cucul_dither *, char const *);

  176. char const * const * cucul_get_dither_color_list(struct cucul_dither const *);

  177. void cucul_set_dither_charset(struct cucul_dither *, char const *);

  178. char const * const * cucul_get_dither_charset_list(struct cucul_dither const *);

  179. void cucul_set_dither_mode(struct cucul_dither *, char const *);

  180. char const * const * cucul_get_dither_mode_list(struct cucul_dither const *);

  181. void cucul_dither_bitmap(cucul_t *, int, int, int, int,

  182.                          struct cucul_dither const *, void *);

  183. void cucul_free_dither(struct cucul_dither *);

  184. /*  @} */

  185. 

  186. /** \defgroup font Font handling

  187.  *

  188.  *  These functions provide font handling routines and high quality

  189.  *  canvas to bitmap rendering.

  190.  *

  191.  *  @{ */

  192. struct cucul_font;

  193. struct cucul_font *cucul_load_font(void const *, unsigned int);

  194. char const * const * cucul_get_font_list(void);

  195. unsigned int cucul_get_font_width(struct cucul_font *);

  196. unsigned int cucul_get_font_height(struct cucul_font *);

  197. void cucul_render_canvas(cucul_t *, struct cucul_font *, unsigned char *,

  198.                          unsigned int, unsigned int, unsigned int);

  199. void cucul_free_font(struct cucul_font *);

  200. /*  @} */

  201. 

  202. /** \defgroup exporter Exporters to various formats

  203.  *

  204.  *  These functions export the current canvas to various text formats. It

  205.  *  is necessary to call cucul_free_export() to dispose of the data.

  206.  *

  207.  *  @{ */

  208. struct cucul_buffer * cucul_create_export(cucul_t *, char const *);

  209. char const * const * cucul_get_export_list(void);

  210. void cucul_free_export(struct cucul_buffer *);

  211. /*  @} */

  212. 

  213. #ifdef __cplusplus

  214. }

  215. #endif

  216. 

  217. #endif /* __CUCUL_H__ */