gdk-pixbuf.h 10.2 KB
Newer Older
1
/* GdkPixbuf library - Main header file
2 3 4 5 6 7
 *
 * Copyright (C) 1999 The Free Software Foundation
 *
 * Authors: Mark Crichton <crichton@gimp.org>
 *          Miguel de Icaza <miguel@gnu.org>
 *          Federico Mena-Quintero <federico@gimp.org>
8
 *          Havoc Pennington <hp@redhat.com>
9 10
 *
 * This library is free software; you can redistribute it and/or
11
 * modify it under the terms of the GNU Lesser General Public
12 13 14 15 16 17
 * License as published by the Free Software Foundation; either
 * version 2 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
18
 * Lesser General Public License for more details.
19
 *
20
 * You should have received a copy of the GNU Lesser General Public
21 22 23 24 25 26 27
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef GDK_PIXBUF_H
#define GDK_PIXBUF_H
Arturo Espinosa's avatar
Arturo Espinosa committed
28

Owen Taylor's avatar
Owen Taylor committed
29
#include <glib.h>
30
#include <gdk-pixbuf/gdk-pixbuf-features.h>
31
#include <glib-object.h>
Michael Meeks's avatar
Michael Meeks committed
32

33 34 35 36
#ifdef __cplusplus
extern "C" {
#endif

37

Arturo Espinosa's avatar
Arturo Espinosa committed
38

Havoc Pennington's avatar
Havoc Pennington committed
39 40 41
/* Alpha compositing mode */
typedef enum
{
Havoc Pennington's avatar
Havoc Pennington committed
42 43
        GDK_PIXBUF_ALPHA_BILEVEL,
        GDK_PIXBUF_ALPHA_FULL
Havoc Pennington's avatar
Havoc Pennington committed
44 45
} GdkPixbufAlphaMode;

46 47 48 49
/* Color spaces; right now only RGB is supported.
 * Note that these values are encoded in inline pixbufs
 * as ints, so don't reorder them
 */
50
typedef enum {
51 52
	GDK_COLORSPACE_RGB
} GdkColorspace;
Jonathan Blandford's avatar
Jonathan Blandford committed
53

54 55 56
/* All of these are opaque structures */
typedef struct _GdkPixbuf GdkPixbuf;
typedef struct _GdkPixbufAnimation GdkPixbufAnimation;
57 58 59 60 61 62 63 64 65 66
typedef struct _GdkPixbufFrame GdkPixbufFrame;

#define GDK_TYPE_PIXBUF              (gdk_pixbuf_get_type ())
#define GDK_PIXBUF(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_PIXBUF, GdkPixbuf))
#define GDK_IS_PIXBUF(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_PIXBUF))

#define GDK_TYPE_PIXBUF_ANIMATION              (gdk_pixbuf_animation_get_type ())
#define GDK_PIXBUF_ANIMATION(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_PIXBUF_ANIMATION, GdkPixbufAnimation))
#define GDK_IS_PIXBUF_ANIMATION(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_PIXBUF_ANIMATION))

Radek Doulik's avatar
Radek Doulik committed
67

68
/* Handler that must free the pixel array */
69
typedef void (* GdkPixbufDestroyNotify) (guchar *pixels, gpointer data);
Jonathan Blandford's avatar
Jonathan Blandford committed
70

71 72 73
#define GDK_PIXBUF_ERROR gdk_pixbuf_error_quark ()

typedef enum {
Havoc Pennington's avatar
Havoc Pennington committed
74 75 76 77
        /* image data hosed */
        GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
        /* no mem to load image */
        GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY,
78 79
        /* bad option value passed to save routine */
        GDK_PIXBUF_ERROR_BAD_OPTION_VALUE,
80 81
        /* unsupported image type (sort of an ENOSYS) */
        GDK_PIXBUF_ERROR_UNKNOWN_TYPE,
Havoc Pennington's avatar
Havoc Pennington committed
82 83
        /* unsupported operation (load, save) for image type */
        GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION,
84
        GDK_PIXBUF_ERROR_FAILED
Havoc Pennington's avatar
Havoc Pennington committed
85
} GdkPixbufError;
86 87 88

GQuark gdk_pixbuf_error_quark () G_GNUC_CONST;

89 90


Elliot Lee's avatar
Elliot Lee committed
91
GType gdk_pixbuf_get_type (void) G_GNUC_CONST;
92

93
/* Reference counting */
94

95 96 97
GdkPixbuf *gdk_pixbuf_ref      (GdkPixbuf *pixbuf);
void       gdk_pixbuf_unref    (GdkPixbuf *pixbuf);

98 99 100 101 102 103 104 105 106 107 108 109
/* GdkPixbuf accessors */

GdkColorspace gdk_pixbuf_get_colorspace      (const GdkPixbuf *pixbuf);
int           gdk_pixbuf_get_n_channels      (const GdkPixbuf *pixbuf);
gboolean      gdk_pixbuf_get_has_alpha       (const GdkPixbuf *pixbuf);
int           gdk_pixbuf_get_bits_per_sample (const GdkPixbuf *pixbuf);
guchar       *gdk_pixbuf_get_pixels          (const GdkPixbuf *pixbuf);
int           gdk_pixbuf_get_width           (const GdkPixbuf *pixbuf);
int           gdk_pixbuf_get_height          (const GdkPixbuf *pixbuf);
int           gdk_pixbuf_get_rowstride       (const GdkPixbuf *pixbuf);


110

111
/* Create a blank pixbuf with an optimal rowstride and a new buffer */
112
GdkPixbuf *gdk_pixbuf_new (GdkColorspace colorspace, gboolean has_alpha, int bits_per_sample,
113
			   int width, int height);
114

115 116 117 118
/* Copy a pixbuf */

GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);

119 120 121 122 123 124 125
/* Create a pixbuf which points to the pixels of another pixbuf */
GdkPixbuf *gdk_pixbuf_new_subpixbuf (GdkPixbuf *src_pixbuf,
                                     int        src_x,
                                     int        src_y,
                                     int        width,
                                     int        height);

126 127
/* Simple loading */

Havoc Pennington's avatar
Havoc Pennington committed
128 129
GdkPixbuf *gdk_pixbuf_new_from_file (const char *filename,
                                     GError    **error);
130

Elliot Lee's avatar
Elliot Lee committed
131
GdkPixbuf *gdk_pixbuf_new_from_data (const guchar *data,
132
				     GdkColorspace colorspace,
133
				     gboolean has_alpha,
134
				     int bits_per_sample,
135 136
				     int width, int height,
				     int rowstride,
137 138
				     GdkPixbufDestroyNotify destroy_fn,
				     gpointer destroy_fn_data);
139

140
GdkPixbuf *gdk_pixbuf_new_from_xpm_data (const char **data);
141

142 143 144
/* Read an inline pixbuf */
GdkPixbuf *gdk_pixbuf_new_from_inline   (const guchar *inline_pixbuf,
                                         gboolean      copy_pixels,
Havoc Pennington's avatar
Havoc Pennington committed
145 146
                                         int           length,
                                         GError      **error);
147

148 149 150 151 152

/* Saving */

gboolean gdk_pixbuf_save           (GdkPixbuf  *pixbuf, 
                                    const char *filename, 
Havoc Pennington's avatar
Havoc Pennington committed
153 154
                                    const char *type, 
                                    GError    **error,
155 156 157 158
                                    ...);

gboolean gdk_pixbuf_savev          (GdkPixbuf  *pixbuf, 
                                    const char *filename, 
Havoc Pennington's avatar
Havoc Pennington committed
159
                                    const char *type,
160 161
                                    char      **option_keys,
                                    char      **option_values,
Havoc Pennington's avatar
Havoc Pennington committed
162
                                    GError    **error);
163

164
/* Adding an alpha channel */
165
GdkPixbuf *gdk_pixbuf_add_alpha (const GdkPixbuf *pixbuf, gboolean substitute_color,
166 167
				 guchar r, guchar g, guchar b);

168 169 170 171 172 173 174
/* Copy an area of a pixbuf onto another one */
void gdk_pixbuf_copy_area (const GdkPixbuf *src_pixbuf,
			   int src_x, int src_y,
			   int width, int height,
			   GdkPixbuf *dest_pixbuf,
			   int dest_x, int dest_y);

175 176 177 178 179 180
/* Brighten/darken and optionally make it pixelated-looking */
void gdk_pixbuf_saturate_and_pixelate (const GdkPixbuf *src,
                                       GdkPixbuf       *dest,
                                       gfloat           saturation,
                                       gboolean         pixelate);

181 182


183
/* Rendering to a drawable */
184

185

186 187
/* Scaling */

188 189 190 191 192 193 194 195
/* Interpolation modes */
typedef enum {
	GDK_INTERP_NEAREST,
	GDK_INTERP_TILES,
	GDK_INTERP_BILINEAR,
	GDK_INTERP_HYPER
} GdkInterpType;

196 197 198 199 200 201 202 203 204 205
void gdk_pixbuf_scale           (const GdkPixbuf *src,
				 GdkPixbuf       *dest,
				 int              dest_x,
				 int              dest_y,
				 int              dest_width,
				 int              dest_height,
				 double           offset_x,
				 double           offset_y,
				 double           scale_x,
				 double           scale_y,
206
				 GdkInterpType    interp_type);
207 208 209 210 211 212 213 214 215 216
void gdk_pixbuf_composite       (const GdkPixbuf *src,
				 GdkPixbuf       *dest,
				 int              dest_x,
				 int              dest_y,
				 int              dest_width,
				 int              dest_height,
				 double           offset_x,
				 double           offset_y,
				 double           scale_x,
				 double           scale_y,
217
				 GdkInterpType    interp_type,
218 219 220 221 222 223 224 225 226 227 228
				 int              overall_alpha);
void gdk_pixbuf_composite_color (const GdkPixbuf *src,
				 GdkPixbuf       *dest,
				 int              dest_x,
				 int              dest_y,
				 int              dest_width,
				 int              dest_height,
				 double           offset_x,
				 double           offset_y,
				 double           scale_x,
				 double           scale_y,
229
				 GdkInterpType    interp_type,
230 231 232 233
				 int              overall_alpha,
				 int              check_x,
				 int              check_y,
				 int              check_size,
234 235
				 guint32          color1,
				 guint32          color2);
236 237 238 239

GdkPixbuf *gdk_pixbuf_scale_simple           (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
240 241
					      GdkInterpType    interp_type);

242 243 244
GdkPixbuf *gdk_pixbuf_composite_color_simple (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
245
					      GdkInterpType    interp_type,
246 247
					      int              overall_alpha,
					      int              check_size,
248 249 250 251
					      guint32          color1,
					      guint32          color2);


252

253
/* Animation support */
Jonathan Blandford's avatar
Jonathan Blandford committed
254

255 256 257 258 259 260 261
/* GIF-like animation overlay modes for frames */
typedef enum {
	GDK_PIXBUF_FRAME_RETAIN,
	GDK_PIXBUF_FRAME_DISPOSE,
	GDK_PIXBUF_FRAME_REVERT
} GdkPixbufFrameAction;

Elliot Lee's avatar
Elliot Lee committed
262
GType               gdk_pixbuf_animation_get_type        (void) G_GNUC_CONST;
263

Havoc Pennington's avatar
Havoc Pennington committed
264 265
GdkPixbufAnimation *gdk_pixbuf_animation_new_from_file   (const char         *filename,
                                                          GError            **error);
Jonathan Blandford's avatar
Jonathan Blandford committed
266

Ettore Perazzoli's avatar
Ettore Perazzoli committed
267 268 269 270 271 272 273
GdkPixbufAnimation *gdk_pixbuf_animation_ref             (GdkPixbufAnimation *animation);
void                gdk_pixbuf_animation_unref           (GdkPixbufAnimation *animation);

int                 gdk_pixbuf_animation_get_width       (GdkPixbufAnimation *animation);
int                 gdk_pixbuf_animation_get_height      (GdkPixbufAnimation *animation);
GList              *gdk_pixbuf_animation_get_frames      (GdkPixbufAnimation *animation);
int                 gdk_pixbuf_animation_get_num_frames  (GdkPixbufAnimation *animation);
274

275 276 277 278 279 280 281
/* Frame accessors */

GdkPixbuf           *gdk_pixbuf_frame_get_pixbuf     (GdkPixbufFrame *frame);
int                  gdk_pixbuf_frame_get_x_offset   (GdkPixbufFrame *frame);
int                  gdk_pixbuf_frame_get_y_offset   (GdkPixbufFrame *frame);
int                  gdk_pixbuf_frame_get_delay_time (GdkPixbufFrame *frame);
GdkPixbufFrameAction gdk_pixbuf_frame_get_action     (GdkPixbufFrame *frame);
Owen Taylor's avatar
Owen Taylor committed
282
GdkPixbufFrame      *gdk_pixbuf_frame_copy           (GdkPixbufFrame *src);
283 284 285
void                 gdk_pixbuf_frame_free           (GdkPixbufFrame *frame);
GType                gdk_pixbuf_frame_get_type       (void) G_GNUC_CONST;
#define              GDK_TYPE_PIXBUF_FRAME gdk_pixbuf_frame_get_type ()
286

287
#include <gdk-pixbuf/gdk-pixbuf-loader.h>
288

289

290

291 292 293
#ifdef __cplusplus
}
#endif
294

295
#endif