Fix typo in Readme file
[geeqie.git] / src / pixbuf-util.h
1 /*
2  * Copyright (C) 2004 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #ifndef PIXBUF_UTIL_H
23 #define PIXBUF_UTIL_H
24
25
26 gboolean pixbuf_to_file_as_png (GdkPixbuf *pixbuf, const gchar *filename);
27 gboolean pixbuf_to_file_as_jpg(GdkPixbuf *pixbuf, const gchar *filename, gint quality);
28
29 void pixbuf_inline_register_stock_icons(void);
30 gboolean register_theme_icon_as_stock(const gchar *key, const gchar *icon);
31
32 GdkPixbuf *pixbuf_inline(const gchar *key);
33 GdkPixbuf *pixbuf_fallback(FileData *fd, gint requested_width, gint requested_height);
34
35 gboolean pixbuf_scale_aspect(gint req_w, gint req_h, gint old_w, gint old_h, gint *new_w, gint *new_h);
36
37 #define PIXBUF_INLINE_ARCHIVE           "gq-archive-file"
38 #define PIXBUF_INLINE_BROKEN            "gq-sheet-broken"
39 #define PIXBUF_INLINE_COLLECTION        "gq-collection"
40 #define PIXBUF_INLINE_ICON              "gqview-icon"
41 #define PIXBUF_INLINE_ICON_180  "gq-icon-rotate-180"
42 #define PIXBUF_INLINE_ICON_BOOK         "gq-icon-book"
43 #define PIXBUF_INLINE_ICON_CCW  "gq-icon-rotate-counter-clockwise"
44 #define PIXBUF_INLINE_ICON_CONFIG       "gq-icon-config"
45 #define PIXBUF_INLINE_ICON_CW   "gq-icon-rotate-clockwise"
46 #define PIXBUF_INLINE_ICON_DRAW_RECTANGLE       "gq-icon-draw-rectangle"
47 #define PIXBUF_INLINE_ICON_EXIF         "gq-icon-exif"
48 #define PIXBUF_INLINE_ICON_EXPOSURE             "gq-icon-exposure"
49 #define PIXBUF_INLINE_ICON_FILE_FILTER  "gq-icon-file-filter"
50 #define PIXBUF_INLINE_ICON_FLIP         "gq-icon-flip"
51 #define PIXBUF_INLINE_ICON_FLOAT        "gq-icon-float"
52 #define PIXBUF_INLINE_ICON_GRAYSCALE    "gq-icon-grayscale"
53 #define PIXBUF_INLINE_ICON_HEIF         "gq-icon-heic"
54 #define PIXBUF_INLINE_ICON_HIDETOOLS    "gq-icon-hidetools"
55 #define PIXBUF_INLINE_ICON_INFO         "gq-icon-info"
56 #define PIXBUF_INLINE_ICON_MAINTENANCE  "gq-icon-maintenance"
57 #define PIXBUF_INLINE_ICON_MARKS        "gq-icon-marks"
58 #define PIXBUF_INLINE_ICON_MIRROR       "gq-icon-mirror"
59 #define PIXBUF_INLINE_ICON_MOVE         "gq-icon-move"
60 #define PIXBUF_INLINE_ICON_ORIGINAL     "gq-icon-original"
61 #define PIXBUF_INLINE_ICON_PANORAMA             "gq-icon-panorama"
62 #define PIXBUF_INLINE_ICON_PDF          "gq-icon-pdf"
63 #define PIXBUF_INLINE_ICON_RENAME       "gq-icon-rename"
64 #define PIXBUF_INLINE_ICON_SELECT_ALL   "gq-icon-select-all"
65 #define PIXBUF_INLINE_ICON_SELECT_INVERT        "gq-icon-select-invert"
66 #define PIXBUF_INLINE_ICON_SELECT_NONE  "gq-icon-select-none"
67 #define PIXBUF_INLINE_ICON_SELECT_RECTANGLE     "gq-icon-select-rectangle"
68 #define PIXBUF_INLINE_ICON_SORT         "gq-icon-sort"
69 #define PIXBUF_INLINE_ICON_THUMB        "gq-icon-thumb"
70 #define PIXBUF_INLINE_ICON_TOOLS        "gq-icon-tools"
71 #define PIXBUF_INLINE_ICON_TRASH        "gq-icon-trash"
72 #define PIXBUF_INLINE_ICON_VIEW         "gq-icon-view"
73 #define PIXBUF_INLINE_ICON_ZOOMFILLHOR  "gq-icon-zoomfillhor"
74 #define PIXBUF_INLINE_ICON_ZOOMFILLVERT "gq-icon-zoomfillvert"
75 #define PIXBUF_INLINE_LOGO              "geeqie-logo"
76 #define PIXBUF_INLINE_METADATA          "gq-sheet-metadata"
77 #define PIXBUF_INLINE_SCROLLER          "gq-scroller"
78 #define PIXBUF_INLINE_SPLIT_PANE_SYNC   "gq-icon-split-pane-sync"
79 #define PIXBUF_INLINE_UNKNOWN           "gq-sheet-unknown"
80 #define PIXBUF_INLINE_VIDEO                     "gq-sheet-video"
81
82 GdkPixbuf *pixbuf_copy_rotate_90(GdkPixbuf *src, gboolean counter_clockwise);
83 GdkPixbuf *pixbuf_copy_mirror(GdkPixbuf *src, gboolean mirror, gboolean flip);
84 GdkPixbuf* pixbuf_apply_orientation(GdkPixbuf *pixbuf, gint orientation);
85
86 void pixbuf_draw_rect_fill(GdkPixbuf *pb,
87                            gint x, gint y, gint w, gint h,
88                            gint r, gint g, gint b, gint a);
89
90 void pixbuf_draw_rect(GdkPixbuf *pb,
91                       gint x, gint y, gint w, gint h,
92                       gint r, gint g, gint b, gint a,
93                       gint left, gint right, gint top, gint bottom);
94
95 void pixbuf_set_rect_fill(GdkPixbuf *pb,
96                           gint x, gint y, gint w, gint h,
97                           gint r, gint g, gint b, gint a);
98
99 void pixbuf_set_rect(GdkPixbuf *pb,
100                      gint x, gint y, gint w, gint h,
101                      gint r, gint g, gint b, gint a,
102                      gint left, gint right, gint top, gint bottom);
103
104 void pixbuf_pixel_set(GdkPixbuf *pb, gint x, gint y, gint r, gint g, gint b, gint a);
105
106
107 void pixbuf_draw_layout(GdkPixbuf *pixbuf, PangoLayout *layout, GtkWidget *widget,
108                         gint x, gint y,
109                         guint8 r, guint8 g, guint8 b, guint8 a);
110
111
112 void pixbuf_draw_triangle(GdkPixbuf *pb,
113                           gint clip_x, gint clip_y, gint clip_w, gint clip_h,
114                           gint x1, gint y1, gint x2, gint y2, gint x3, gint y3,
115                           guint8 r, guint8 g, guint8 b, guint8 a);
116
117 void pixbuf_draw_line(GdkPixbuf *pb,
118                       gint clip_x, gint clip_y, gint clip_w, gint clip_h,
119                       gint x1, gint y1, gint x2, gint y2,
120                       guint8 r, guint8 g, guint8 b, guint8 a);
121
122 void pixbuf_draw_shadow(GdkPixbuf *pb,
123                         gint clip_x, gint clip_y, gint clip_w, gint clip_h,
124                         gint x, gint y, gint w, gint h, gint border,
125                         guint8 r, guint8 g, guint8 b, guint8 a);
126
127 void pixbuf_desaturate_rect(GdkPixbuf *pb,
128                             gint x, gint y, gint w, gint h);
129 void pixbuf_highlight_overunderexposed(GdkPixbuf *pb,
130                             gint x, gint y, gint w, gint h);
131 void pixbuf_ignore_alpha_rect(GdkPixbuf *pb,
132                  gint x, gint y, gint w, gint h);
133
134 /* clipping utils */
135
136 gboolean util_clip_region(gint x, gint y, gint w, gint h,
137                           gint clip_x, gint clip_y, gint clip_w, gint clip_h,
138                           gint *rx, gint *ry, gint *rw, gint *rh);
139 void util_clip_triangle(gint x1, gint y1, gint x2, gint y2, gint x3, gint y3,
140                         gint *rx, gint *ry, gint *rw, gint *rh);
141
142
143 #endif
144 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */