Imlib2 1.12.2
Imlib2.h
Go to the documentation of this file.
1#ifndef __IMLIB_API_H
2#define __IMLIB_API_H 1
6#define IMLIB2_VERSION_MAJOR 1
7#define IMLIB2_VERSION_MINOR 12
8#define IMLIB2_VERSION_MICRO 2
9
10#define IMLIB2_VERSION_(maj, min, mic) (10000 * (maj) + 100 * (min) + (mic))
11#define IMLIB2_VERSION IMLIB2_VERSION_(IMLIB2_VERSION_MAJOR, IMLIB2_VERSION_MINOR, IMLIB2_VERSION_MICRO)
12
13#ifdef EAPI
14#undef EAPI
15#endif
16#ifdef WIN32
17#ifdef BUILDING_DLL
18#define EAPI __declspec(dllexport)
19#else
20#define EAPI __declspec(dllimport)
21#endif
22#else
23#ifdef __GNUC__
24#if __GNUC__ >= 4
25#define EAPI __attribute__ ((visibility("default")))
26#else
27#define EAPI
28#endif
29#else
30#define EAPI
31#endif
32#endif
33
34#ifndef IMLIB2_DEPRECATED
35#ifdef __GNUC__
36#define IMLIB2_DEPRECATED __attribute__((deprecated))
37#else
38#define IMLIB2_DEPRECATED
39#endif
40#endif
41
42#include <stddef.h>
43#include <stdint.h>
44#ifndef X_DISPLAY_MISSING
45#include <X11/Xlib.h>
46#endif
47
48/* opaque data types */
49typedef void *Imlib_Context;
50typedef void *Imlib_Image;
51typedef void *Imlib_Color_Modifier;
52typedef void *Imlib_Updates;
53typedef void *Imlib_Font;
54typedef void *Imlib_Color_Range;
55typedef void *Imlib_Filter;
56typedef void *ImlibPolygon;
57
58/* blending operations */
59typedef enum {
60 IMLIB_OP_COPY,
61 IMLIB_OP_ADD,
62 IMLIB_OP_SUBTRACT,
63 IMLIB_OP_RESHADE
64} Imlib_Operation;
65
66typedef enum {
67 IMLIB_TEXT_TO_RIGHT = 0,
68 IMLIB_TEXT_TO_LEFT = 1,
69 IMLIB_TEXT_TO_DOWN = 2,
70 IMLIB_TEXT_TO_UP = 3,
71 IMLIB_TEXT_TO_ANGLE = 4
72} Imlib_Text_Direction;
73
74#define IMLIB_ERR_INTERNAL -1 /* Internal error (should not happen) */
75#define IMLIB_ERR_NO_LOADER -2 /* No loader for file format */
76#define IMLIB_ERR_NO_SAVER -3 /* No saver for file format */
77#define IMLIB_ERR_BAD_IMAGE -4 /* Invalid image file */
78#define IMLIB_ERR_BAD_FRAME -5 /* Requested frame not in image */
79
80typedef struct {
81 int left, right, top, bottom;
82} Imlib_Border;
83
84typedef struct {
85 int alpha, red, green, blue;
86} Imlib_Color;
87
88/* Progressive loading callback */
89typedef int (*Imlib_Progress_Function)(Imlib_Image im, char percent,
90 int update_x, int update_y,
91 int update_w, int update_h);
92
93/* Custom attached data destructor callback */
94typedef void (*Imlib_Data_Destructor_Function)(Imlib_Image im, void *data);
95
96/* Custom image data memory management function */
97typedef void *(*Imlib_Image_Data_Memory_Function)(void *, size_t size);
98
99/* *INDENT-OFF* */
100#ifdef __cplusplus
101extern "C" {
102#endif
103/* *INDENT-ON* */
104
106EAPI int imlib_version(void);
107
108/*--------------------------------
109 * Context handling
110 */
111
113EAPI Imlib_Context imlib_context_new(void);
114
116EAPI void imlib_context_free(Imlib_Context context);
117
119EAPI void imlib_context_push(Imlib_Context context);
120
122EAPI void imlib_context_pop(void);
123
125EAPI Imlib_Context imlib_context_get(void);
126
127/*--------------------------------
128 * Context operations
129 */
130
131#ifndef X_DISPLAY_MISSING
145EAPI void imlib_context_set_display(Display * display);
146
152EAPI Display *imlib_context_get_display(void);
153
161
170EAPI void imlib_context_set_visual(Visual * visual);
171
177EAPI Visual *imlib_context_get_visual(void);
178
188EAPI void imlib_context_set_colormap(Colormap colormap);
189
195EAPI Colormap imlib_context_get_colormap(void);
196
204EAPI void imlib_context_set_drawable(Drawable drawable);
205
211EAPI Drawable imlib_context_get_drawable(void);
212
221EAPI void imlib_context_set_mask(Pixmap mask);
222
228EAPI Pixmap imlib_context_get_mask(void);
229
240EAPI void imlib_context_set_dither_mask(char dither_mask);
241
248
260 mask_alpha_threshold);
261
268
269#endif /* X_DISPLAY_MISSING */
270
282EAPI void imlib_context_set_anti_alias(char anti_alias);
283
290
305EAPI void imlib_context_set_dither(char dither);
306
313
322EAPI void imlib_context_set_blend(char blend);
323
330
346EAPI void imlib_context_set_color_modifier(Imlib_Color_Modifier
347 color_modifier);
348
354EAPI Imlib_Color_Modifier imlib_context_get_color_modifier(void);
355
374EAPI void imlib_context_set_operation(Imlib_Operation operation);
375
381EAPI Imlib_Operation imlib_context_get_operation(void);
382
390EAPI void imlib_context_set_font(Imlib_Font font);
391
397EAPI Imlib_Font imlib_context_get_font(void);
398
411EAPI void imlib_context_set_direction(Imlib_Text_Direction direction);
412
418EAPI Imlib_Text_Direction imlib_context_get_direction(void);
419
429EAPI void imlib_context_set_angle(double angle);
430
438EAPI double imlib_context_get_angle(void);
439
453EAPI void imlib_context_set_color(int red, int green, int blue,
454 int alpha);
455
464EAPI void imlib_context_get_color(int *red, int *green, int *blue,
465 int *alpha);
466
479EAPI void imlib_context_set_color_hsva(float hue, float saturation,
480 float value, int alpha);
481
490EAPI void imlib_context_get_color_hsva(float *hue, float *saturation,
491 float *value, int *alpha);
492
505EAPI void imlib_context_set_color_hlsa(float hue, float lightness,
506 float saturation, int alpha);
507
516EAPI void imlib_context_get_color_hlsa(float *hue, float *lightness,
517 float *saturation, int *alpha);
518
530EAPI void imlib_context_set_color_cmya(int cyan, int magenta,
531 int yellow, int alpha);
532
541EAPI void imlib_context_get_color_cmya(int *cyan, int *magenta,
542 int *yellow, int *alpha);
543
551EAPI Imlib_Color *imlib_context_get_imlib_color(void);
552
558EAPI void imlib_context_set_color_range(Imlib_Color_Range color_range);
559
565EAPI Imlib_Color_Range imlib_context_get_color_range(void);
566
573 (Imlib_Image_Data_Memory_Function memory_function);
574
580EAPI Imlib_Image_Data_Memory_Function
582
591EAPI void imlib_context_set_progress_function(Imlib_Progress_Function
592 progress_function);
593
599EAPI Imlib_Progress_Function imlib_context_get_progress_function(void);
600
613 progress_granularity);
614
621
627EAPI void imlib_context_set_image(Imlib_Image image);
628
634EAPI Imlib_Image imlib_context_get_image(void);
635
644EAPI void imlib_context_set_cliprect(int x, int y, int w, int h);
645
654EAPI void imlib_context_get_cliprect(int *x, int *y, int *w, int *h);
655
663EAPI int imlib_get_cache_used(void);
664
672EAPI int imlib_get_cache_size(void);
673
685EAPI void imlib_set_cache_size(int bytes);
686
687#ifndef X_DISPLAY_MISSING
696
704EAPI void imlib_set_color_usage(int max);
705
712EAPI int imlib_get_visual_depth(Display * display, Visual * visual);
713
725EAPI Visual *imlib_get_best_visual(Display * display, int screen,
726 int *depth_return);
727#endif /* X_DISPLAY_MISSING */
728
737EAPI void imlib_flush_loaders(void);
738
750EAPI int imlib_get_error(void);
751
761EAPI Imlib_Image imlib_load_image(const char *file);
762
773EAPI Imlib_Image imlib_load_image_immediately(const char *file);
774
782EAPI Imlib_Image imlib_load_image_without_cache(const char *file);
783
792 *file);
793
810EAPI Imlib_Image imlib_load_image_with_errno_return(const char *file,
811 int *error_return);
812
828EAPI Imlib_Image imlib_load_image_fd(int fd, const char *file);
829
843EAPI Imlib_Image imlib_load_image_mem(const char *file,
844 const void *data, size_t size);
845
849EAPI void imlib_free_image(void);
850
855
863EAPI int imlib_image_decache_file(const char *file);
864
865/*--------------------------------
866 * Query/modify image parameters
867 */
868
873
878
891EAPI const char *imlib_image_get_filename(void);
892
911EAPI uint32_t *imlib_image_get_data(void);
912
925
933EAPI void imlib_image_put_back_data(uint32_t * data);
934
943EAPI char imlib_image_has_alpha(void);
944
957
968EAPI void imlib_image_get_border(Imlib_Border * border);
969
975EAPI void imlib_image_set_border(Imlib_Border * border);
976
986EAPI void imlib_image_set_format(const char *format);
987
997EAPI void imlib_image_set_irrelevant_format(char irrelevant);
998
1006EAPI char *imlib_image_format(void);
1007
1015EAPI void imlib_image_set_has_alpha(char has_alpha);
1016
1027EAPI void imlib_image_query_pixel(int x, int y,
1028 Imlib_Color * color_return);
1029
1040EAPI void imlib_image_query_pixel_hsva(int x, int y,
1041 float *hue, float *saturation,
1042 float *value, int *alpha);
1043
1054EAPI void imlib_image_query_pixel_hlsa(int x, int y,
1055 float *hue, float *lightness,
1056 float *saturation, int *alpha);
1057
1068EAPI void imlib_image_query_pixel_cmya(int x, int y,
1069 int *cyan, int *magenta,
1070 int *yellow, int *alpha);
1071
1072/*--------------------------------
1073 * Rendering functions
1074 */
1075
1076#ifndef X_DISPLAY_MISSING
1087EAPI void imlib_render_pixmaps_for_whole_image(Pixmap * pixmap_return,
1088 Pixmap * mask_return);
1089
1105 pixmap_return,
1106 Pixmap *
1107 mask_return,
1108 int width,
1109 int height);
1110
1119EAPI void imlib_free_pixmap_and_mask(Pixmap pixmap);
1120
1130EAPI void imlib_render_image_on_drawable(int x, int y);
1131
1145 int width, int height);
1146
1165 int src_y,
1166 int src_width,
1167 int src_height,
1168 int dst_x,
1169 int dst_y,
1170 int dst_width,
1171 int dst_height);
1172
1177
1178#endif /* X_DISPLAY_MISSING */
1179
1200EAPI void imlib_blend_image_onto_image(Imlib_Image src_image,
1201 char merge_alpha,
1202 int src_x, int src_y,
1203 int src_width, int src_height,
1204 int dst_x, int dst_y,
1205 int dst_width, int dst_height);
1206
1207/*--------------------------------
1208 * Image creation functions
1209 */
1210
1224EAPI Imlib_Image imlib_create_image(int width, int height);
1225
1233EAPI Imlib_Image imlib_clone_image(void);
1234
1248EAPI Imlib_Image imlib_create_cropped_image(int x, int y, int width,
1249 int height);
1250
1267EAPI Imlib_Image imlib_create_cropped_scaled_image(int src_x, int src_y,
1268 int src_width,
1269 int src_height,
1270 int dst_width,
1271 int dst_height);
1272
1293EAPI Imlib_Image imlib_create_image_using_data(int width, int height,
1294 uint32_t * data);
1295
1314 (int width, int height, uint32_t * data,
1315 Imlib_Image_Data_Memory_Function func);
1316
1331EAPI Imlib_Image imlib_create_image_using_copied_data(int width, int height,
1332 uint32_t * data);
1333
1334#ifndef X_DISPLAY_MISSING
1357EAPI Imlib_Image imlib_create_image_from_drawable(Pixmap mask,
1358 int x, int y,
1359 int width, int height,
1360 char need_to_grab_x);
1361
1375EAPI Imlib_Image imlib_create_image_from_ximage(XImage * image,
1376 XImage * mask,
1377 int x, int y,
1378 int width, int height,
1379 char need_to_grab_x);
1380
1408EAPI Imlib_Image imlib_create_scaled_image_from_drawable(Pixmap mask,
1409 int src_x,
1410 int src_y,
1411 int src_width,
1412 int src_height,
1413 int dst_width,
1414 int dst_height,
1415 char need_to_grab_x,
1416 char
1417 get_mask_from_shape);
1418
1443EAPI char imlib_copy_drawable_to_image(Pixmap mask,
1444 int src_x, int src_y,
1445 int src_width, int src_height,
1446 int dst_x, int dst_y,
1447 char need_to_grab_x);
1448
1455
1462
1475
1482
1489
1502
1503#endif /* X_DISPLAY_MISSING */
1504
1505/*--------------------------------
1506 * Updates - lists of rectangles for storing required update draws
1507 */
1508
1518EAPI Imlib_Updates imlib_updates_clone(Imlib_Updates updates);
1519
1536EAPI Imlib_Updates imlib_update_append_rect(Imlib_Updates updates,
1537 int x, int y, int w, int h);
1538
1554EAPI Imlib_Updates imlib_updates_merge(Imlib_Updates updates, int w, int h);
1555
1569EAPI Imlib_Updates imlib_updates_merge_for_rendering(Imlib_Updates updates,
1570 int w, int h);
1571
1577EAPI void imlib_updates_free(Imlib_Updates updates);
1578
1586EAPI Imlib_Updates imlib_updates_get_next(Imlib_Updates updates);
1587
1597EAPI void imlib_updates_get_coordinates(Imlib_Updates updates,
1598 int *x_return,
1599 int *y_return,
1600 int *width_return,
1601 int *height_return);
1602
1612EAPI void imlib_updates_set_coordinates(Imlib_Updates updates,
1613 int x, int y,
1614 int width, int height);
1615
1616#ifdef BUILD_X11
1628EAPI void imlib_render_image_updates_on_drawable(Imlib_Updates
1629 updates, int x, int y);
1630#endif
1631
1640EAPI Imlib_Updates imlib_updates_init(void);
1641
1653EAPI Imlib_Updates imlib_updates_append_updates(Imlib_Updates updates,
1654 Imlib_Updates appended_updates);
1655
1656/*--------------------------------
1657 * Image modification
1658 */
1659
1664
1669
1677
1688EAPI void imlib_image_orientate(int orientation);
1689
1698EAPI void imlib_image_blur(int radius);
1699
1707EAPI void imlib_image_sharpen(int radius);
1708
1716
1724
1732EAPI void imlib_image_tile(void);
1733
1745EAPI void imlib_image_copy_alpha_to_image(Imlib_Image image_source,
1746 int x, int y);
1747
1765 image_source,
1766 int src_x,
1767 int src_y,
1768 int src_width,
1769 int src_height,
1770 int dst_x, int dst_y);
1771
1785EAPI void imlib_image_scroll_rect(int x, int y, int width, int height,
1786 int delta_x, int delta_y);
1787
1802EAPI void imlib_image_copy_rect(int x, int y, int width, int height,
1803 int new_x, int new_y);
1804
1805/*--------------------------------
1806 * Fonts and text
1807 */
1808
1822EAPI Imlib_Font imlib_load_font(const char *font_name);
1823
1827EAPI void imlib_free_font(void);
1828
1847 Imlib_Font fallback_font);
1848
1856EAPI void imlib_remove_font_from_fallback_chain(Imlib_Font fallback_font);
1857
1859EAPI Imlib_Font imlib_get_prev_font_in_fallback_chain(Imlib_Font fn);
1860
1862EAPI Imlib_Font imlib_get_next_font_in_fallback_chain(Imlib_Font fn);
1863
1875EAPI void imlib_text_draw(int x, int y, const char *text);
1876
1896 const char *text,
1897 int *width_return,
1898 int *height_return,
1899 int *horizontal_advance_return,
1900 int *vertical_advance_return);
1901
1912EAPI void imlib_get_text_size(const char *text,
1913 int *width_return, int *height_return);
1914
1928EAPI void imlib_get_text_advance(const char *text,
1929 int *horizontal_advance_return,
1930 int *vertical_advance_return);
1931
1942EAPI int imlib_get_text_inset(const char *text);
1943
1952EAPI void imlib_add_path_to_font_path(const char *path);
1953
1961EAPI void imlib_remove_path_from_font_path(const char *path);
1962
1977EAPI char **imlib_list_font_path(int *number_return);
1978
1999EAPI int imlib_text_get_index_and_location(const char *text,
2000 int x, int y,
2001 int *char_x_return,
2002 int *char_y_return,
2003 int *char_width_return,
2004 int *char_height_return);
2005
2019EAPI void imlib_text_get_location_at_index(const char *text,
2020 int index,
2021 int *char_x_return,
2022 int *char_y_return,
2023 int *char_width_return,
2024 int *char_height_return);
2025
2033EAPI char **imlib_list_fonts(int *number_return);
2034
2041EAPI void imlib_free_font_list(char **font_list, int number);
2042
2049
2060EAPI void imlib_set_font_cache_size(int bytes);
2061
2066
2073
2080
2087
2094
2095/*--------------------------------
2096 * Color modifiers
2097 */
2098
2107EAPI Imlib_Color_Modifier imlib_create_color_modifier(void);
2108
2113
2125EAPI void imlib_modify_color_modifier_gamma(double gamma_value);
2126
2140 brightness_value);
2141
2153 contrast_value);
2154
2169EAPI void imlib_set_color_modifier_tables(uint8_t * red_table,
2170 uint8_t * green_table,
2171 uint8_t * blue_table,
2172 uint8_t * alpha_table);
2173
2186EAPI void imlib_get_color_modifier_tables(uint8_t * red_table,
2187 uint8_t * green_table,
2188 uint8_t * blue_table,
2189 uint8_t * alpha_table);
2190
2197
2204
2217 int width, int height);
2218
2219/*--------------------------------
2220 * Drawing on images
2221 */
2222
2237EAPI Imlib_Updates imlib_image_draw_pixel(int x, int y, char make_updates);
2238
2255EAPI Imlib_Updates imlib_image_draw_line(int x1, int y1, int x2, int y2,
2256 char make_updates);
2257
2271EAPI void imlib_image_draw_rectangle(int x, int y, int width, int height);
2272
2285EAPI void imlib_image_fill_rectangle(int x, int y, int width, int height);
2286
2287/*--------------------------------
2288 * Polygons
2289 */
2290
2296EAPI ImlibPolygon imlib_polygon_new(void);
2297
2303EAPI void imlib_polygon_free(ImlibPolygon poly);
2304
2316EAPI void imlib_polygon_add_point(ImlibPolygon poly, int x, int y);
2317
2329EAPI void imlib_image_draw_polygon(ImlibPolygon poly,
2330 unsigned char closed);
2331
2340EAPI void imlib_image_fill_polygon(ImlibPolygon poly);
2341
2355EAPI void imlib_polygon_get_bounds(ImlibPolygon poly,
2356 int *px1, int *py1,
2357 int *px2, int *py2);
2358
2371EAPI unsigned char imlib_polygon_contains_point(ImlibPolygon poly,
2372 int x, int y);
2373
2374/*--------------------------------
2375 * Ellipses
2376 */
2377
2392EAPI void imlib_image_draw_ellipse(int xc, int yc, int a, int b);
2393
2409EAPI void imlib_image_fill_ellipse(int xc, int yc, int a, int b);
2410
2411/*--------------------------------
2412 * Color ranges
2413 */
2414
2420EAPI Imlib_Color_Range imlib_create_color_range(void);
2421
2426
2436EAPI void imlib_add_color_to_color_range(int distance_away);
2437
2453 int width,
2454 int height,
2455 double angle);
2456
2474 int width,
2475 int height, double
2476 angle);
2477
2478/*--------------------------------
2479 * Image data attachment
2480 */
2481
2495EAPI void imlib_image_attach_data_value(const char *key,
2496 void *data, int value,
2497 Imlib_Data_Destructor_Function
2498 destructor_function);
2499
2510EAPI void *imlib_image_get_attached_data(const char *key);
2511
2522EAPI int imlib_image_get_attached_value(const char *key);
2523
2533
2544 *key);
2545
2546/*--------------------------------
2547 * Image saving
2548 */
2549
2559EAPI void imlib_save_image(const char *file);
2560
2574EAPI void imlib_save_image_with_errno_return(const char *file,
2575 int *error_return);
2576
2590EAPI void imlib_save_image_fd(int fd, const char *file);
2591
2592/*--------------------------------
2593 * Image rotation/skewing
2594 */
2595
2605EAPI Imlib_Image imlib_create_rotated_image(double angle);
2606
2615EAPI void imlib_rotate_image_from_buffer(double angle,
2616 Imlib_Image src_image);
2617
2636 src_image,
2637 char merge_alpha,
2638 int src_x,
2639 int src_y,
2640 int src_width,
2641 int src_height,
2642 int dst_x,
2643 int dst_y,
2644 int angle_x, int angle_y);
2645
2700 src_image,
2701 char merge_alpha,
2702 int src_x,
2703 int src_y,
2704 int src_width,
2705 int src_height,
2706 int dst_x,
2707 int dst_y,
2708 int h_angle_x,
2709 int h_angle_y,
2710 int v_angle_x,
2711 int v_angle_y);
2712
2713#ifndef X_DISPLAY_MISSING
2733 int src_y,
2734 int src_width,
2735 int src_height,
2736 int dst_x,
2737 int dst_y,
2738 int h_angle_x,
2739 int h_angle_y,
2740 int v_angle_x,
2741 int v_angle_y);
2742
2759 int src_y,
2760 int src_width,
2761 int src_height,
2762 int dst_x,
2763 int dst_y,
2764 int angle_x,
2765 int angle_y);
2766
2767#endif /* X_DISPLAY_MISSING */
2768
2769/*--------------------------------
2770 * Image filters
2771 */
2772
2776EAPI void imlib_image_filter(void);
2777
2781EAPI Imlib_Filter imlib_create_filter(int initsize);
2782
2790EAPI void imlib_context_set_filter(Imlib_Filter filter);
2791
2797EAPI Imlib_Filter imlib_context_get_filter(void);
2798
2802EAPI void imlib_free_filter(void);
2803
2804EAPI void imlib_filter_set(int xoff, int yoff,
2805 int a, int r, int g, int b);
2806EAPI void imlib_filter_set_alpha(int xoff, int yoff,
2807 int a, int r, int g, int b);
2808EAPI void imlib_filter_set_red(int xoff, int yoff,
2809 int a, int r, int g, int b);
2810EAPI void imlib_filter_set_green(int xoff, int yoff,
2811 int a, int r, int g, int b);
2812EAPI void imlib_filter_set_blue(int xoff, int yoff,
2813 int a, int r, int g, int b);
2814EAPI void imlib_filter_constants(int a, int r, int g, int b);
2815EAPI void imlib_filter_divisors(int a, int r, int g, int b);
2816
2817EAPI void imlib_apply_filter(const char *script, ...);
2818
2824EAPI void imlib_image_clear(void);
2825
2829EAPI void imlib_image_clear_color(int r, int g, int b, int a);
2830
2831/*--------------------------------
2832 * Multiframe image loading
2833 */
2834
2835typedef struct {
2836 int frame_count; /* Number of frames in image */
2837 int frame_num; /* Current frame (1..frame_count) */
2838 int canvas_w, canvas_h; /* Canvas size */
2839 int frame_x, frame_y; /* Frame origin */
2840 int frame_w, frame_h; /* Frame size */
2841 int frame_flags; /* Frame info flags */
2842 int frame_delay; /* Frame delay (ms) */
2843 int loop_count; /* Number of animation loops */
2844} Imlib_Frame_Info;
2845
2846/* frame info flags */
2847#define IMLIB_IMAGE_ANIMATED (1 << 0) /* Frames are an animated sequence */
2848#define IMLIB_FRAME_BLEND (1 << 1) /* Blend current onto previous frame */
2849#define IMLIB_FRAME_DISPOSE_CLEAR (1 << 2) /* Clear before rendering next frame */
2850#define IMLIB_FRAME_DISPOSE_PREV (1 << 3) /* Revert before rendering next frame */
2851
2865EAPI Imlib_Image imlib_load_image_frame(const char *file, int frame);
2866
2883EAPI Imlib_Image imlib_load_image_frame_mem(const char *file, int frame,
2884 const void *data, size_t size);
2885
2891EAPI void imlib_image_get_frame_info(Imlib_Frame_Info * info);
2892
2903EAPI const char *imlib_strerror(int err);
2904
2905/*--------------------------------
2906 * Deprecated functionality
2907 */
2908
2909/* Old data types, no longer used by imlib2, likely to be removed */
2910#ifndef DATA64
2911#define DATA64 uint64_t
2912#define DATA32 uint32_t
2913#define DATA16 uint16_t
2914#define DATA8 uint8_t
2915#endif
2916
2917/* *INDENT-OFF* */
2918
2919typedef enum {
2920 IMLIB_LOAD_ERROR_NONE,
2921 IMLIB_LOAD_ERROR_FILE_DOES_NOT_EXIST,
2922 IMLIB_LOAD_ERROR_FILE_IS_DIRECTORY,
2923 IMLIB_LOAD_ERROR_PERMISSION_DENIED_TO_READ,
2924 IMLIB_LOAD_ERROR_NO_LOADER_FOR_FILE_FORMAT,
2925 IMLIB_LOAD_ERROR_PATH_TOO_LONG,
2926 IMLIB_LOAD_ERROR_PATH_COMPONENT_NON_EXISTANT,
2927 IMLIB_LOAD_ERROR_PATH_COMPONENT_NOT_DIRECTORY,
2928 IMLIB_LOAD_ERROR_PATH_POINTS_OUTSIDE_ADDRESS_SPACE,
2929 IMLIB_LOAD_ERROR_TOO_MANY_SYMBOLIC_LINKS,
2930 IMLIB_LOAD_ERROR_OUT_OF_MEMORY,
2931 IMLIB_LOAD_ERROR_OUT_OF_FILE_DESCRIPTORS,
2932 IMLIB_LOAD_ERROR_PERMISSION_DENIED_TO_WRITE,
2933 IMLIB_LOAD_ERROR_OUT_OF_DISK_SPACE,
2934 IMLIB_LOAD_ERROR_UNKNOWN,
2935 IMLIB_LOAD_ERROR_IMAGE_READ,
2936 IMLIB_LOAD_ERROR_IMAGE_FRAME
2937} Imlib_Load_Error;
2938
2953/* IMLIB2_DEPRECATED */
2954EAPI Imlib_Image imlib_load_image_with_error_return(const char *file,
2955 Imlib_Load_Error *
2956 error_return);
2957
2969/* IMLIB2_DEPRECATED */
2970EAPI void imlib_save_image_with_error_return(const char *file,
2971 Imlib_Load_Error *
2972 error_return);
2973
2976IMLIB2_DEPRECATED
2977EAPI void imlib_image_set_irrelevant_border(char irrelevant);
2978
2981IMLIB2_DEPRECATED
2982EAPI void imlib_image_set_irrelevant_alpha(char irrelevant);
2983
2984/* Encodings known to Imlib2 (so far) */
2985typedef enum {
2986 IMLIB_TTF_ENCODING_ISO_8859_1,
2987 IMLIB_TTF_ENCODING_ISO_8859_2,
2988 IMLIB_TTF_ENCODING_ISO_8859_3,
2989 IMLIB_TTF_ENCODING_ISO_8859_4,
2990 IMLIB_TTF_ENCODING_ISO_8859_5
2991} Imlib_TTF_Encoding;
2992
2995IMLIB2_DEPRECATED
2996EAPI void imlib_context_set_TTF_encoding(Imlib_TTF_Encoding encoding);
2997
3000IMLIB2_DEPRECATED
3001EAPI Imlib_TTF_Encoding imlib_context_get_TTF_encoding(void);
3002
3003#ifdef __cplusplus
3004}
3005#endif
3006/* *INDENT-ON* */
3007#endif
EAPI void imlib_image_query_pixel(int x, int y, Imlib_Color *color_return)
EAPI Imlib_Color_Modifier imlib_create_color_modifier(void)
EAPI void imlib_image_copy_alpha_to_image(Imlib_Image image_source, int x, int y)
IMLIB2_DEPRECATED EAPI Imlib_TTF_Encoding imlib_context_get_TTF_encoding(void)
EAPI void imlib_add_color_to_color_range(int distance_away)
EAPI void imlib_image_put_back_data(uint32_t *data)
EAPI void imlib_image_query_pixel_hlsa(int x, int y, float *hue, float *lightness, float *saturation, int *alpha)
EAPI void imlib_updates_get_coordinates(Imlib_Updates updates, int *x_return, int *y_return, int *width_return, int *height_return)
EAPI void imlib_image_tile(void)
EAPI Imlib_Image imlib_create_cropped_scaled_image(int src_x, int src_y, int src_width, int src_height, int dst_width, int dst_height)
EAPI void imlib_context_push(Imlib_Context context)
EAPI void imlib_image_query_pixel_hsva(int x, int y, float *hue, float *saturation, float *value, int *alpha)
EAPI void imlib_updates_set_coordinates(Imlib_Updates updates, int x, int y, int width, int height)
EAPI ImlibPolygon imlib_polygon_new(void)
EAPI int imlib_get_ximage_cache_count_used(void)
EAPI void imlib_context_set_cliprect(int x, int y, int w, int h)
EAPI Visual * imlib_get_best_visual(Display *display, int screen, int *depth_return)
EAPI Imlib_Operation imlib_context_get_operation(void)
EAPI void imlib_render_image_on_drawable(int x, int y)
EAPI Imlib_Updates imlib_updates_merge_for_rendering(Imlib_Updates updates, int w, int h)
EAPI void imlib_image_flip_horizontal(void)
EAPI void imlib_free_font(void)
EAPI void imlib_text_draw_with_return_metrics(int x, int y, const char *text, int *width_return, int *height_return, int *horizontal_advance_return, int *vertical_advance_return)
EAPI char * imlib_image_format(void)
EAPI Imlib_Image imlib_load_image(const char *file)
EAPI void imlib_context_set_mask_alpha_threshold(int mask_alpha_threshold)
EAPI int imlib_get_maximum_font_descent(void)
EAPI void imlib_free_pixmap_and_mask(Pixmap pixmap)
EAPI void imlib_image_set_border(Imlib_Border *border)
EAPI void imlib_context_set_color(int red, int green, int blue, int alpha)
EAPI void imlib_image_scroll_rect(int x, int y, int width, int height, int delta_x, int delta_y)
EAPI int imlib_get_error(void)
EAPI double imlib_context_get_angle(void)
EAPI Imlib_Updates imlib_update_append_rect(Imlib_Updates updates, int x, int y, int w, int h)
EAPI int imlib_get_color_usage(void)
EAPI Imlib_Image imlib_load_image_immediately(const char *file)
EAPI char imlib_image_has_alpha(void)
EAPI void imlib_context_set_mask(Pixmap mask)
EAPI void imlib_context_free(Imlib_Context context)
EAPI void imlib_image_flip_vertical(void)
EAPI void imlib_apply_color_modifier_to_rectangle(int x, int y, int width, int height)
EAPI void imlib_context_set_dither_mask(char dither_mask)
EAPI void imlib_image_draw_ellipse(int xc, int yc, int a, int b)
EAPI int imlib_get_ximage_cache_count_max(void)
EAPI Imlib_Image imlib_create_image_from_ximage(XImage *image, XImage *mask, int x, int y, int width, int height, char need_to_grab_x)
EAPI void imlib_flush_font_cache(void)
EAPI void imlib_modify_color_modifier_brightness(double brightness_value)
EAPI void imlib_save_image_with_error_return(const char *file, Imlib_Load_Error *error_return)
EAPI int imlib_get_font_cache_size(void)
EAPI void imlib_context_set_color_cmya(int cyan, int magenta, int yellow, int alpha)
EAPI Imlib_Color_Modifier imlib_context_get_color_modifier(void)
EAPI void imlib_image_clear_color(int r, int g, int b, int a)
EAPI void imlib_polygon_get_bounds(ImlibPolygon poly, int *px1, int *py1, int *px2, int *py2)
EAPI unsigned char imlib_polygon_contains_point(ImlibPolygon poly, int x, int y)
EAPI Imlib_Image imlib_create_image_using_data(int width, int height, uint32_t *data)
EAPI void imlib_free_image_and_decache(void)
EAPI uint32_t imlib_render_get_pixel_color(void)
EAPI const char * imlib_strerror(int err)
EAPI char imlib_context_get_dither(void)
EAPI void imlib_image_fill_polygon(ImlibPolygon poly)
EAPI int imlib_get_ximage_cache_size_max(void)
EAPI Imlib_Image imlib_load_image_frame_mem(const char *file, int frame, const void *data, size_t size)
EAPI int imlib_image_get_attached_value(const char *key)
EAPI int imlib_image_decache_file(const char *file)
EAPI void imlib_context_get_color_hlsa(float *hue, float *lightness, float *saturation, int *alpha)
EAPI char imlib_context_get_blend(void)
EAPI void imlib_set_cache_size(int bytes)
EAPI void imlib_get_color_modifier_tables(uint8_t *red_table, uint8_t *green_table, uint8_t *blue_table, uint8_t *alpha_table)
EAPI void imlib_context_set_color_range(Imlib_Color_Range color_range)
EAPI Imlib_Context imlib_context_get(void)
EAPI void imlib_context_set_drawable(Drawable drawable)
EAPI int imlib_context_get_mask_alpha_threshold(void)
EAPI Imlib_Image imlib_create_image_using_data_and_memory_function(int width, int height, uint32_t *data, Imlib_Image_Data_Memory_Function func)
EAPI int imlib_get_ximage_cache_size_used(void)
EAPI int imlib_text_get_index_and_location(const char *text, int x, int y, int *char_x_return, int *char_y_return, int *char_width_return, int *char_height_return)
EAPI Imlib_Image imlib_create_image_from_drawable(Pixmap mask, int x, int y, int width, int height, char need_to_grab_x)
EAPI void imlib_image_blur(int radius)
EAPI Imlib_Image imlib_load_image_mem(const char *file, const void *data, size_t size)
EAPI Imlib_Image imlib_load_image_immediately_without_cache(const char *file)
EAPI Imlib_Color_Range imlib_create_color_range(void)
EAPI Imlib_Progress_Function imlib_context_get_progress_function(void)
EAPI void imlib_apply_color_modifier(void)
EAPI uint32_t * imlib_image_get_data_for_reading_only(void)
EAPI Imlib_Updates imlib_image_draw_line(int x1, int y1, int x2, int y2, char make_updates)
EAPI void imlib_context_disconnect_display(void)
EAPI Imlib_Updates imlib_updates_append_updates(Imlib_Updates updates, Imlib_Updates appended_updates)
EAPI void imlib_remove_path_from_font_path(const char *path)
EAPI void imlib_render_image_part_on_drawable_at_size(int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int dst_width, int dst_height)
EAPI Imlib_Font imlib_get_prev_font_in_fallback_chain(Imlib_Font fn)
EAPI int imlib_get_text_inset(const char *text)
EAPI void imlib_context_set_progress_granularity(char progress_granularity)
EAPI Imlib_Updates imlib_updates_merge(Imlib_Updates updates, int w, int h)
EAPI Imlib_Image imlib_create_image_using_copied_data(int width, int height, uint32_t *data)
EAPI void imlib_image_draw_rectangle(int x, int y, int width, int height)
EAPI void imlib_context_set_operation(Imlib_Operation operation)
EAPI void imlib_get_text_size(const char *text, int *width_return, int *height_return)
EAPI void imlib_context_set_color_modifier(Imlib_Color_Modifier color_modifier)
EAPI void imlib_image_set_changes_on_disk(void)
EAPI void imlib_render_pixmaps_for_whole_image(Pixmap *pixmap_return, Pixmap *mask_return)
EAPI Imlib_Context imlib_context_new(void)
EAPI void imlib_context_get_color_cmya(int *cyan, int *magenta, int *yellow, int *alpha)
EAPI char imlib_context_get_anti_alias(void)
EAPI Imlib_Updates imlib_updates_clone(Imlib_Updates updates)
EAPI Imlib_Image imlib_load_image_without_cache(const char *file)
IMLIB2_DEPRECATED EAPI void imlib_context_set_TTF_encoding(Imlib_TTF_Encoding encoding)
EAPI Imlib_Color * imlib_context_get_imlib_color(void)
EAPI Imlib_Updates imlib_updates_init(void)
EAPI Imlib_Filter imlib_context_get_filter(void)
EAPI void imlib_image_get_frame_info(Imlib_Frame_Info *info)
EAPI void imlib_flush_loaders(void)
EAPI void imlib_image_fill_color_range_rectangle(int x, int y, int width, int height, double angle)
EAPI int imlib_image_get_height(void)
EAPI void imlib_image_set_has_alpha(char has_alpha)
EAPI char ** imlib_list_fonts(int *number_return)
EAPI Imlib_Image imlib_create_rotated_image(double angle)
IMLIB2_DEPRECATED EAPI void imlib_image_set_irrelevant_border(char irrelevant)
EAPI Pixmap imlib_context_get_mask(void)
EAPI Drawable imlib_context_get_drawable(void)
EAPI void imlib_context_set_angle(double angle)
EAPI Imlib_Font imlib_context_get_font(void)
EAPI void imlib_context_set_blend(char blend)
EAPI void imlib_image_filter(void)
EAPI Imlib_Color_Range imlib_context_get_color_range(void)
EAPI void imlib_context_set_dither(char dither)
EAPI void imlib_set_ximage_cache_size_max(int bytes)
EAPI void imlib_context_get_cliprect(int *x, int *y, int *w, int *h)
EAPI void imlib_image_remove_attached_data_value(const char *key)
EAPI void imlib_image_tile_horizontal(void)
EAPI void imlib_free_image(void)
EAPI void imlib_context_set_progress_function(Imlib_Progress_Function progress_function)
EAPI Imlib_Font imlib_load_font(const char *font_name)
EAPI void imlib_image_copy_alpha_rectangle_to_image(Imlib_Image image_source, int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y)
EAPI Imlib_Image imlib_create_cropped_image(int x, int y, int width, int height)
EAPI void imlib_text_get_location_at_index(const char *text, int index, int *char_x_return, int *char_y_return, int *char_width_return, int *char_height_return)
EAPI Imlib_Image imlib_create_scaled_image_from_drawable(Pixmap mask, int src_x, int src_y, int src_width, int src_height, int dst_width, int dst_height, char need_to_grab_x, char get_mask_from_shape)
EAPI void imlib_context_pop(void)
EAPI void imlib_save_image_with_errno_return(const char *file, int *error_return)
EAPI void imlib_image_fill_ellipse(int xc, int yc, int a, int b)
EAPI void imlib_context_set_visual(Visual *visual)
EAPI void imlib_render_image_on_drawable_at_angle(int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int angle_x, int angle_y)
EAPI void imlib_free_font_list(char **font_list, int number)
EAPI void imlib_image_get_border(Imlib_Border *border)
EAPI void imlib_image_draw_polygon(ImlibPolygon poly, unsigned char closed)
EAPI Imlib_Image imlib_create_image(int width, int height)
EAPI int imlib_get_font_descent(void)
EAPI char imlib_context_get_dither_mask(void)
EAPI Imlib_Filter imlib_create_filter(int initsize)
EAPI void imlib_context_set_display(Display *display)
EAPI void imlib_context_set_color_hlsa(float hue, float lightness, float saturation, int alpha)
EAPI Imlib_Font imlib_get_next_font_in_fallback_chain(Imlib_Font fn)
EAPI void imlib_context_set_anti_alias(char anti_alias)
EAPI void imlib_context_set_filter(Imlib_Filter filter)
EAPI void imlib_image_tile_vertical(void)
EAPI Colormap imlib_context_get_colormap(void)
EAPI int imlib_get_visual_depth(Display *display, Visual *visual)
EAPI void imlib_image_fill_hsva_color_range_rectangle(int x, int y, int width, int height, double angle)
EAPI Imlib_Updates imlib_updates_get_next(Imlib_Updates updates)
EAPI Imlib_Image imlib_load_image_with_errno_return(const char *file, int *error_return)
EAPI Imlib_Image imlib_context_get_image(void)
EAPI char imlib_copy_drawable_to_image(Pixmap mask, int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, char need_to_grab_x)
EAPI uint32_t * imlib_image_get_data(void)
EAPI void imlib_image_set_irrelevant_format(char irrelevant)
EAPI void imlib_context_set_colormap(Colormap colormap)
EAPI void imlib_image_flip_diagonal(void)
EAPI void imlib_set_font_cache_size(int bytes)
EAPI Imlib_Image imlib_clone_image(void)
EAPI void imlib_add_path_to_font_path(const char *path)
EAPI void imlib_image_orientate(int orientation)
EAPI void imlib_updates_free(Imlib_Updates updates)
EAPI void imlib_set_color_usage(int max)
EAPI void imlib_image_copy_rect(int x, int y, int width, int height, int new_x, int new_y)
EAPI void imlib_reset_color_modifier(void)
EAPI void imlib_render_image_on_drawable_at_size(int x, int y, int width, int height)
EAPI void imlib_polygon_add_point(ImlibPolygon poly, int x, int y)
EAPI Imlib_Image imlib_load_image_fd(int fd, const char *file)
EAPI void imlib_text_draw(int x, int y, const char *text)
EAPI Imlib_Updates imlib_image_draw_pixel(int x, int y, char make_updates)
EAPI void imlib_rotate_image_from_buffer(double angle, Imlib_Image src_image)
EAPI int imlib_get_font_ascent(void)
EAPI int imlib_insert_font_into_fallback_chain(Imlib_Font font, Imlib_Font fallback_font)
EAPI void imlib_context_set_direction(Imlib_Text_Direction direction)
EAPI void imlib_remove_font_from_fallback_chain(Imlib_Font fallback_font)
IMLIB2_DEPRECATED EAPI void imlib_image_set_irrelevant_alpha(char irrelevant)
EAPI void imlib_free_color_modifier(void)
EAPI char ** imlib_list_font_path(int *number_return)
EAPI void imlib_context_get_color_hsva(float *hue, float *saturation, float *value, int *alpha)
EAPI Display * imlib_context_get_display(void)
EAPI void imlib_image_clear(void)
EAPI const char * imlib_image_get_filename(void)
EAPI char imlib_context_get_progress_granularity(void)
EAPI Imlib_Image imlib_load_image_frame(const char *file, int frame)
EAPI int imlib_get_cache_used(void)
EAPI void imlib_get_text_advance(const char *text, int *horizontal_advance_return, int *vertical_advance_return)
EAPI void imlib_free_filter(void)
EAPI int imlib_version(void)
EAPI void imlib_context_set_image_data_memory_function(Imlib_Image_Data_Memory_Function memory_function)
EAPI void imlib_save_image_fd(int fd, const char *file)
EAPI Imlib_Text_Direction imlib_context_get_direction(void)
EAPI void imlib_context_set_color_hsva(float hue, float saturation, float value, int alpha)
EAPI Imlib_Image_Data_Memory_Function imlib_context_get_image_data_memory_function(void)
EAPI void imlib_modify_color_modifier_gamma(double gamma_value)
EAPI void imlib_image_fill_rectangle(int x, int y, int width, int height)
EAPI void imlib_polygon_free(ImlibPolygon poly)
EAPI void imlib_context_set_font(Imlib_Font font)
EAPI void imlib_set_ximage_cache_count_max(int count)
EAPI void imlib_blend_image_onto_image_at_angle(Imlib_Image src_image, char merge_alpha, int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int angle_x, int angle_y)
EAPI int imlib_get_maximum_font_ascent(void)
EAPI void imlib_image_attach_data_value(const char *key, void *data, int value, Imlib_Data_Destructor_Function destructor_function)
EAPI void imlib_render_pixmaps_for_whole_image_at_size(Pixmap *pixmap_return, Pixmap *mask_return, int width, int height)
EAPI int imlib_get_cache_size(void)
EAPI void imlib_context_set_image(Imlib_Image image)
EAPI void imlib_modify_color_modifier_contrast(double contrast_value)
EAPI void imlib_set_color_modifier_tables(uint8_t *red_table, uint8_t *green_table, uint8_t *blue_table, uint8_t *alpha_table)
EAPI void imlib_save_image(const char *file)
EAPI void imlib_image_set_format(const char *format)
EAPI void imlib_free_color_range(void)
EAPI Visual * imlib_context_get_visual(void)
EAPI void imlib_render_image_on_drawable_skewed(int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int h_angle_x, int h_angle_y, int v_angle_x, int v_angle_y)
EAPI void imlib_image_sharpen(int radius)
EAPI void imlib_context_get_color(int *red, int *green, int *blue, int *alpha)
EAPI void imlib_blend_image_onto_image(Imlib_Image src_image, char merge_alpha, int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int dst_width, int dst_height)
EAPI Imlib_Image imlib_load_image_with_error_return(const char *file, Imlib_Load_Error *error_return)
EAPI void imlib_blend_image_onto_image_skewed(Imlib_Image src_image, char merge_alpha, int src_x, int src_y, int src_width, int src_height, int dst_x, int dst_y, int h_angle_x, int h_angle_y, int v_angle_x, int v_angle_y)
EAPI int imlib_image_get_width(void)
EAPI void * imlib_image_get_attached_data(const char *key)
EAPI void imlib_image_query_pixel_cmya(int x, int y, int *cyan, int *magenta, int *yellow, int *alpha)
EAPI void imlib_image_remove_and_free_attached_data_value(const char *key)