gdk-pixbuf.h 7.59 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 <gobject/gobject.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

39
/* Color spaces; right now only RGB is supported */
40
typedef enum {
41 42
	GDK_COLORSPACE_RGB
} GdkColorspace;
Jonathan Blandford's avatar
Jonathan Blandford committed
43

44 45 46
/* All of these are opaque structures */
typedef struct _GdkPixbuf GdkPixbuf;
typedef struct _GdkPixbufAnimation GdkPixbufAnimation;
47 48 49 50 51 52 53 54 55 56
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
57

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

61 62


63 64
GType gdk_pixbuf_get_type (void);

65
/* Reference counting */
66

67 68 69
GdkPixbuf *gdk_pixbuf_ref      (GdkPixbuf *pixbuf);
void       gdk_pixbuf_unref    (GdkPixbuf *pixbuf);

70 71 72 73 74 75 76 77 78 79 80 81
/* 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);


82

83
/* Create a blank pixbuf with an optimal rowstride and a new buffer */
84
GdkPixbuf *gdk_pixbuf_new (GdkColorspace colorspace, gboolean has_alpha, int bits_per_sample,
85
			   int width, int height);
86

87 88 89 90
/* Copy a pixbuf */

GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);

91 92
/* Simple loading */

93 94
GdkPixbuf *gdk_pixbuf_new_from_file (const char *filename);

Elliot Lee's avatar
Elliot Lee committed
95
GdkPixbuf *gdk_pixbuf_new_from_data (const guchar *data,
96
				     GdkColorspace colorspace,
97
				     gboolean has_alpha,
98
				     int bits_per_sample,
99 100
				     int width, int height,
				     int rowstride,
101 102
				     GdkPixbufDestroyNotify destroy_fn,
				     gpointer destroy_fn_data);
103

104
GdkPixbuf *gdk_pixbuf_new_from_xpm_data (const char **data);
105

106
/* Adding an alpha channel */
107
GdkPixbuf *gdk_pixbuf_add_alpha (const GdkPixbuf *pixbuf, gboolean substitute_color,
108 109
				 guchar r, guchar g, guchar b);

110 111 112 113 114 115 116 117 118
/* 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);



119
/* Rendering to a drawable */
120

121

122 123
/* Scaling */

124 125 126 127 128 129 130 131
/* Interpolation modes */
typedef enum {
	GDK_INTERP_NEAREST,
	GDK_INTERP_TILES,
	GDK_INTERP_BILINEAR,
	GDK_INTERP_HYPER
} GdkInterpType;

132 133 134 135 136 137 138 139 140 141
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,
142
				 GdkInterpType    interp_type);
143 144 145 146 147 148 149 150 151 152
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,
153
				 GdkInterpType    interp_type,
154 155 156 157 158 159 160 161 162 163 164
				 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,
165
				 GdkInterpType    interp_type,
166 167 168 169
				 int              overall_alpha,
				 int              check_x,
				 int              check_y,
				 int              check_size,
170 171
				 guint32          color1,
				 guint32          color2);
172 173 174 175

GdkPixbuf *gdk_pixbuf_scale_simple           (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
176 177
					      GdkInterpType    interp_type);

178 179 180
GdkPixbuf *gdk_pixbuf_composite_color_simple (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
181
					      GdkInterpType    interp_type,
182 183
					      int              overall_alpha,
					      int              check_size,
184 185 186 187
					      guint32          color1,
					      guint32          color2);


188

189
/* Animation support */
Jonathan Blandford's avatar
Jonathan Blandford committed
190

191 192 193 194 195 196 197
/* GIF-like animation overlay modes for frames */
typedef enum {
	GDK_PIXBUF_FRAME_RETAIN,
	GDK_PIXBUF_FRAME_DISPOSE,
	GDK_PIXBUF_FRAME_REVERT
} GdkPixbufFrameAction;

198 199
GType               gdk_pixbuf_animation_get_type        (void);

Ettore Perazzoli's avatar
Ettore Perazzoli committed
200
GdkPixbufAnimation *gdk_pixbuf_animation_new_from_file   (const char         *filename);
Jonathan Blandford's avatar
Jonathan Blandford committed
201

Ettore Perazzoli's avatar
Ettore Perazzoli committed
202 203 204 205 206 207 208
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);
209

210 211 212 213 214 215 216 217 218
/* 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);


219
/* General (presently empty) initialization hooks, primarily for gnome-libs */
220 221
void gdk_pixbuf_preinit  (gpointer app, gpointer modinfo);
void gdk_pixbuf_postinit (gpointer app, gpointer modinfo);
222 223
/* A more user-friendly init function */
void gdk_pixbuf_init     (void);
224

225

226

227 228 229
#ifdef __cplusplus
}
#endif
230

231
#endif