1 /* GdkPixbuf library - GdkPixbuf data structure
3 * Copyright (C) 2003 The Free Software Foundation
5 * Authors: Mark Crichton <crichton@gimp.org>
6 * Miguel de Icaza <miguel@gnu.org>
7 * Federico Mena-Quintero <federico@gimp.org>
8 * Havoc Pennington <hp@redhat.com>
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 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
26 #ifndef GDK_PIXBUF_CORE_H
27 #define GDK_PIXBUF_CORE_H
30 #include <glib-object.h>
34 /* Alpha compositing mode */
37 GDK_PIXBUF_ALPHA_BILEVEL,
41 /* Color spaces; right now only RGB is supported.
42 * Note that these values are encoded in inline pixbufs
43 * as ints, so don't reorder them
49 /* All of these are opaque structures */
50 typedef struct _GdkPixbuf GdkPixbuf;
52 #define GDK_TYPE_PIXBUF (gdk_pixbuf_get_type ())
53 #define GDK_PIXBUF(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), GDK_TYPE_PIXBUF, GdkPixbuf))
54 #define GDK_IS_PIXBUF(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), GDK_TYPE_PIXBUF))
57 /* Handler that must free the pixel array */
58 typedef void (* GdkPixbufDestroyNotify) (guchar *pixels, gpointer data);
60 #define GDK_PIXBUF_ERROR gdk_pixbuf_error_quark ()
63 /* image data hosed */
64 GDK_PIXBUF_ERROR_CORRUPT_IMAGE,
65 /* no mem to load image */
66 GDK_PIXBUF_ERROR_INSUFFICIENT_MEMORY,
67 /* bad option passed to save routine */
68 GDK_PIXBUF_ERROR_BAD_OPTION,
69 /* unsupported image type (sort of an ENOSYS) */
70 GDK_PIXBUF_ERROR_UNKNOWN_TYPE,
71 /* unsupported operation (load, save) for image type */
72 GDK_PIXBUF_ERROR_UNSUPPORTED_OPERATION,
73 GDK_PIXBUF_ERROR_FAILED
76 GQuark gdk_pixbuf_error_quark (void);
80 GType gdk_pixbuf_get_type (void) G_GNUC_CONST;
82 /* Reference counting */
84 #ifndef GDK_PIXBUF_DISABLE_DEPRECATED
85 GdkPixbuf *gdk_pixbuf_ref (GdkPixbuf *pixbuf);
86 void gdk_pixbuf_unref (GdkPixbuf *pixbuf);
89 /* GdkPixbuf accessors */
91 GdkColorspace gdk_pixbuf_get_colorspace (const GdkPixbuf *pixbuf);
92 int gdk_pixbuf_get_n_channels (const GdkPixbuf *pixbuf);
93 gboolean gdk_pixbuf_get_has_alpha (const GdkPixbuf *pixbuf);
94 int gdk_pixbuf_get_bits_per_sample (const GdkPixbuf *pixbuf);
95 guchar *gdk_pixbuf_get_pixels (const GdkPixbuf *pixbuf);
96 int gdk_pixbuf_get_width (const GdkPixbuf *pixbuf);
97 int gdk_pixbuf_get_height (const GdkPixbuf *pixbuf);
98 int gdk_pixbuf_get_rowstride (const GdkPixbuf *pixbuf);
102 /* Create a blank pixbuf with an optimal rowstride and a new buffer */
103 GdkPixbuf *gdk_pixbuf_new (GdkColorspace colorspace, gboolean has_alpha, int bits_per_sample,
104 int width, int height);
108 GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);
110 /* Create a pixbuf which points to the pixels of another pixbuf */
111 GdkPixbuf *gdk_pixbuf_new_subpixbuf (GdkPixbuf *src_pixbuf,
120 /* DLL ABI stability hack. */
121 #define gdk_pixbuf_new_from_file gdk_pixbuf_new_from_file_utf8
122 #define gdk_pixbuf_new_from_file_at_size gdk_pixbuf_new_from_file_at_size_utf8
123 #define gdk_pixbuf_new_from_file_at_scale gdk_pixbuf_new_from_file_at_scale_utf8
126 GdkPixbuf *gdk_pixbuf_new_from_file (const char *filename,
128 GdkPixbuf *gdk_pixbuf_new_from_file_at_size (const char *filename,
132 GdkPixbuf *gdk_pixbuf_new_from_file_at_scale (const char *filename,
135 gboolean preserve_aspect_ratio,
138 GdkPixbuf *gdk_pixbuf_new_from_data (const guchar *data,
139 GdkColorspace colorspace,
142 int width, int height,
144 GdkPixbufDestroyNotify destroy_fn,
145 gpointer destroy_fn_data);
147 GdkPixbuf *gdk_pixbuf_new_from_xpm_data (const char **data);
148 GdkPixbuf* gdk_pixbuf_new_from_inline (gint data_length,
150 gboolean copy_pixels,
154 void gdk_pixbuf_fill (GdkPixbuf *pixbuf,
160 /* DLL ABI stability hack. */
161 #define gdk_pixbuf_save gdk_pixbuf_save_utf8
162 #define gdk_pixbuf_savev gdk_pixbuf_savev_utf8
165 gboolean gdk_pixbuf_save (GdkPixbuf *pixbuf,
166 const char *filename,
169 ...) G_GNUC_NULL_TERMINATED;
171 gboolean gdk_pixbuf_savev (GdkPixbuf *pixbuf,
172 const char *filename,
175 char **option_values,
178 /* Saving to a callback function */
180 typedef gboolean (*GdkPixbufSaveFunc) (const gchar *buf,
185 gboolean gdk_pixbuf_save_to_callback (GdkPixbuf *pixbuf,
186 GdkPixbufSaveFunc save_func,
190 ...) G_GNUC_NULL_TERMINATED;
192 gboolean gdk_pixbuf_save_to_callbackv (GdkPixbuf *pixbuf,
193 GdkPixbufSaveFunc save_func,
197 char **option_values,
200 /* Saving into a newly allocated char array */
202 gboolean gdk_pixbuf_save_to_buffer (GdkPixbuf *pixbuf,
207 ...) G_GNUC_NULL_TERMINATED;
209 gboolean gdk_pixbuf_save_to_bufferv (GdkPixbuf *pixbuf,
214 char **option_values,
217 /* Adding an alpha channel */
218 GdkPixbuf *gdk_pixbuf_add_alpha (const GdkPixbuf *pixbuf, gboolean substitute_color,
219 guchar r, guchar g, guchar b);
221 /* Copy an area of a pixbuf onto another one */
222 void gdk_pixbuf_copy_area (const GdkPixbuf *src_pixbuf,
223 int src_x, int src_y,
224 int width, int height,
225 GdkPixbuf *dest_pixbuf,
226 int dest_x, int dest_y);
228 /* Brighten/darken and optionally make it pixelated-looking */
229 void gdk_pixbuf_saturate_and_pixelate (const GdkPixbuf *src,
235 G_CONST_RETURN gchar * gdk_pixbuf_get_option (GdkPixbuf *pixbuf,
242 #endif /* GDK_PIXBUF_CORE_H */