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
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2014-2016 Richard Hughes <richard@hughsie.com>
*
* Licensed under the GNU Lesser General Public License Version 2.1
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#if !defined (__APPSTREAM_GLIB_H) && !defined (AS_COMPILATION)
#error "Only <appstream-glib.h> can be included directly."
#endif
#ifndef __AS_IMAGE_H
#define __AS_IMAGE_H
#include <glib-object.h>
#include <gdk-pixbuf/gdk-pixbuf.h>
G_BEGIN_DECLS
#define AS_TYPE_IMAGE (as_image_get_type ())
G_DECLARE_DERIVABLE_TYPE (AsImage, as_image, AS, IMAGE, GObject)
struct _AsImageClass
{
GObjectClass parent_class;
/*< private >*/
void (*_as_reserved1) (void);
void (*_as_reserved2) (void);
void (*_as_reserved3) (void);
void (*_as_reserved4) (void);
void (*_as_reserved5) (void);
void (*_as_reserved6) (void);
void (*_as_reserved7) (void);
void (*_as_reserved8) (void);
};
/**
* AsImageKind:
* @AS_IMAGE_KIND_UNKNOWN: Type invalid or not known
* @AS_IMAGE_KIND_SOURCE: The source image at full resolution
* @AS_IMAGE_KIND_THUMBNAIL: A thumbnail at reduced resolution
*
* The image type.
**/
typedef enum {
AS_IMAGE_KIND_UNKNOWN,
AS_IMAGE_KIND_SOURCE,
AS_IMAGE_KIND_THUMBNAIL,
/*< private >*/
AS_IMAGE_KIND_LAST
} AsImageKind;
/**
* AsImageSaveFlags:
* @AS_IMAGE_SAVE_FLAG_NONE: No special flags set
* @AS_IMAGE_SAVE_FLAG_PAD_16_9: Pad with alpha to 16:9 aspect
* @AS_IMAGE_SAVE_FLAG_SHARPEN: Sharpen the image to clarify detail
* @AS_IMAGE_SAVE_FLAG_BLUR: Blur the image to clear detail
*
* The flags used for saving images.
**/
typedef enum {
AS_IMAGE_SAVE_FLAG_NONE = 0, /* Since: 0.1.6 */
AS_IMAGE_SAVE_FLAG_PAD_16_9 = 1, /* Since: 0.1.6 */
AS_IMAGE_SAVE_FLAG_SHARPEN = 2, /* Since: 0.3.2 */
AS_IMAGE_SAVE_FLAG_BLUR = 4, /* Since: 0.3.2 */
/*< private >*/
AS_IMAGE_SAVE_FLAG_LAST
} AsImageSaveFlags;
/**
* AsImageLoadFlags:
* @AS_IMAGE_LOAD_FLAG_NONE: No special flags set
* @AS_IMAGE_LOAD_FLAG_SHARPEN: Sharpen the resulting image
* @AS_IMAGE_LOAD_FLAG_SET_BASENAME: Set the image basename
* @AS_IMAGE_LOAD_FLAG_SET_CHECKSUM: Set the image checksum
* @AS_IMAGE_LOAD_FLAG_ONLY_SUPPORTED: Only load supported formats like PNG and JPG
* @AS_IMAGE_LOAD_FLAG_ALWAYS_RESIZE: Always resize the source icon to the perfect size
*
* The flags used for loading images.
**/
typedef enum {
AS_IMAGE_LOAD_FLAG_NONE = 0, /* Since: 0.5.6 */
AS_IMAGE_LOAD_FLAG_SHARPEN = 1, /* Since: 0.5.6 */
AS_IMAGE_LOAD_FLAG_SET_BASENAME = 2, /* Since: 0.5.6 */
AS_IMAGE_LOAD_FLAG_SET_CHECKSUM = 4, /* Since: 0.5.6 */
AS_IMAGE_LOAD_FLAG_ONLY_SUPPORTED = 8, /* Since: 0.5.6 */
AS_IMAGE_LOAD_FLAG_ALWAYS_RESIZE = 16, /* Since: 0.7.7 */
/*< private >*/
AS_IMAGE_LOAD_FLAG_LAST
} AsImageLoadFlags;
/**
* AsImageAlphaFlags:
* @AS_IMAGE_ALPHA_FLAG_NONE: No padding detected
* @AS_IMAGE_ALPHA_FLAG_TOP: Padding detected at the image top
* @AS_IMAGE_ALPHA_FLAG_BOTTOM: Padding detected at the image bottom
* @AS_IMAGE_ALPHA_FLAG_LEFT: Padding detected at the image left side
* @AS_IMAGE_ALPHA_FLAG_RIGHT: Padding detected at the image right side
* @AS_IMAGE_ALPHA_FLAG_INTERNAL: Internal alpha cut out areas detected
*
* The flags used for reporting the alpha cutouts in the image.
**/
#define AS_IMAGE_ALPHA_FLAG_NONE (0u) /* Since: 0.2.2 */
#define AS_IMAGE_ALPHA_FLAG_TOP (1u << 0) /* Since: 0.2.2 */
#define AS_IMAGE_ALPHA_FLAG_BOTTOM (1u << 1) /* Since: 0.2.2 */
#define AS_IMAGE_ALPHA_FLAG_LEFT (1u << 2) /* Since: 0.2.2 */
#define AS_IMAGE_ALPHA_FLAG_RIGHT (1u << 3) /* Since: 0.2.2 */
#define AS_IMAGE_ALPHA_FLAG_INTERNAL (1u << 4) /* Since: 0.2.2 */
typedef guint AsImageAlphaFlags;
/* some useful constants */
#define AS_IMAGE_LARGE_HEIGHT 423 /* Since: 0.2.2 */
#define AS_IMAGE_LARGE_WIDTH 752 /* Since: 0.2.2 */
#define AS_IMAGE_NORMAL_HEIGHT 351 /* Since: 0.2.2 */
#define AS_IMAGE_NORMAL_WIDTH 624 /* Since: 0.2.2 */
#define AS_IMAGE_THUMBNAIL_HEIGHT 63 /* Since: 0.2.2 */
#define AS_IMAGE_THUMBNAIL_WIDTH 112 /* Since: 0.2.2 */
AsImage *as_image_new (void);
/* helpers */
AsImageKind as_image_kind_from_string (const gchar *kind);
const gchar *as_image_kind_to_string (AsImageKind kind);
/* getters */
const gchar *as_image_get_url (AsImage *image);
const gchar *as_image_get_md5 (AsImage *image);
const gchar *as_image_get_basename (AsImage *image);
const gchar *as_image_get_locale (AsImage *image);
guint as_image_get_width (AsImage *image);
guint as_image_get_height (AsImage *image);
AsImageKind as_image_get_kind (AsImage *image);
GdkPixbuf *as_image_get_pixbuf (AsImage *image);
/* setters */
void as_image_set_url (AsImage *image,
const gchar *url);
void as_image_set_basename (AsImage *image,
const gchar *basename);
void as_image_set_locale (AsImage *image,
const gchar *locale);
void as_image_set_width (AsImage *image,
guint width);
void as_image_set_height (AsImage *image,
guint height);
void as_image_set_kind (AsImage *image,
AsImageKind kind);
void as_image_set_pixbuf (AsImage *image,
GdkPixbuf *pixbuf);
/* object methods */
AsImageAlphaFlags as_image_get_alpha_flags (AsImage *image);
gboolean as_image_load_filename (AsImage *image,
const gchar *filename,
GError **error);
gboolean as_image_load_filename_full (AsImage *image,
const gchar *filename,
guint dest_size,
guint src_size_min,
AsImageLoadFlags flags,
GError **error);
GdkPixbuf *as_image_save_pixbuf (AsImage *image,
guint width,
guint height,
AsImageSaveFlags flags);
gboolean as_image_save_filename (AsImage *image,
const gchar *filename,
guint width,
guint height,
AsImageSaveFlags flags,
GError **error);
gboolean as_image_equal (AsImage *image1,
AsImage *image2);
G_END_DECLS
#endif /* __AS_IMAGE_H */
|
