gdk-pixbuf.h 8.36 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 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * 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

29
#include <gdk/gdk.h>
Arturo Espinosa's avatar
Arturo Espinosa committed
30

31 32 33 34
#ifdef __cplusplus
extern "C" {
#endif

35
#include <gdk-pixbuf/gdk-pixbuf-features.h>
Michael Meeks's avatar
Michael Meeks committed
36

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 47
/* All of these are opaque structures */
typedef struct _GdkPixbuf GdkPixbuf;
typedef struct _GdkPixbufFrame GdkPixbufFrame;
typedef struct _GdkPixbufAnimation GdkPixbufAnimation;
Radek Doulik's avatar
Radek Doulik committed
48

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

52 53 54
/* Handler for the last unref operation */
typedef void (* GdkPixbufLastUnref) (GdkPixbuf *pixbuf, gpointer data);

55 56


57
/* Reference counting */
58

59 60 61 62 63 64 65 66
GdkPixbuf *gdk_pixbuf_ref      (GdkPixbuf *pixbuf);
void       gdk_pixbuf_unref    (GdkPixbuf *pixbuf);

void       gdk_pixbuf_set_last_unref_handler (GdkPixbuf          *pixbuf,
					      GdkPixbufLastUnref  last_unref_fn,
					      gpointer            last_unref_fn_data);

void       gdk_pixbuf_finalize (GdkPixbuf *pixbuf);
67

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


80

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

85 86 87 88
/* Copy a pixbuf */

GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);

89 90
/* Simple loading */

91 92
GdkPixbuf *gdk_pixbuf_new_from_file (const char *filename);

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

102
GdkPixbuf *gdk_pixbuf_new_from_xpm_data (const char **data);
103

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

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



117 118
/* Rendering to a drawable */

119
/* Alpha compositing mode */
120 121 122 123 124 125 126 127 128 129 130
typedef enum {
	GDK_PIXBUF_ALPHA_BILEVEL,
	GDK_PIXBUF_ALPHA_FULL
} GdkPixbufAlphaMode;

void gdk_pixbuf_render_threshold_alpha (GdkPixbuf *pixbuf, GdkBitmap *bitmap,
					int src_x, int src_y,
					int dest_x, int dest_y,
					int width, int height,
					int alpha_threshold);

131 132
void gdk_pixbuf_render_to_drawable (GdkPixbuf *pixbuf,
				    GdkDrawable *drawable, GdkGC *gc,
133 134 135 136 137 138
				    int src_x, int src_y,
				    int dest_x, int dest_y,
				    int width, int height,
				    GdkRgbDither dither,
				    int x_dither, int y_dither);

139 140 141 142 143 144 145 146 147
void gdk_pixbuf_render_to_drawable_alpha (GdkPixbuf *pixbuf, GdkDrawable *drawable,
					  int src_x, int src_y,
					  int dest_x, int dest_y,
					  int width, int height,
					  GdkPixbufAlphaMode alpha_mode,
					  int alpha_threshold,
					  GdkRgbDither dither,
					  int x_dither, int y_dither);

148 149 150
void gdk_pixbuf_render_pixmap_and_mask (GdkPixbuf *pixbuf,
					GdkPixmap **pixmap_return, GdkBitmap **mask_return,
					int alpha_threshold);
151

152
/* Fetching a region from a drawable */
153 154 155 156 157
GdkPixbuf *gdk_pixbuf_get_from_drawable (GdkPixbuf *dest,
					 GdkDrawable *src, GdkColormap *cmap,
					 int src_x, int src_y,
					 int dest_x, int dest_y,
					 int width, int height);
Jonathan Blandford's avatar
Jonathan Blandford committed
158

159

160

161 162
/* Scaling */

163 164 165 166 167 168 169 170
/* Interpolation modes */
typedef enum {
	GDK_INTERP_NEAREST,
	GDK_INTERP_TILES,
	GDK_INTERP_BILINEAR,
	GDK_INTERP_HYPER
} GdkInterpType;

171 172 173 174 175 176 177 178 179 180
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,
181
				 GdkInterpType    interp_type);
182 183 184 185 186 187 188 189 190 191
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,
192
				 GdkInterpType    interp_type,
193 194 195 196 197 198 199 200 201 202 203
				 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,
204
				 GdkInterpType    interp_type,
205 206 207 208
				 int              overall_alpha,
				 int              check_x,
				 int              check_y,
				 int              check_size,
209 210
				 guint32          color1,
				 guint32          color2);
211 212 213 214

GdkPixbuf *gdk_pixbuf_scale_simple           (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
215 216
					      GdkInterpType    interp_type);

217 218 219
GdkPixbuf *gdk_pixbuf_composite_color_simple (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
220
					      GdkInterpType    interp_type,
221 222
					      int              overall_alpha,
					      int              check_size,
223 224 225 226
					      guint32          color1,
					      guint32          color2);


227

228
/* Animation support */
Jonathan Blandford's avatar
Jonathan Blandford committed
229

230 231 232 233 234 235 236
/* GIF-like animation overlay modes for frames */
typedef enum {
	GDK_PIXBUF_FRAME_RETAIN,
	GDK_PIXBUF_FRAME_DISPOSE,
	GDK_PIXBUF_FRAME_REVERT
} GdkPixbufFrameAction;

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

Ettore Perazzoli's avatar
Ettore Perazzoli committed
239 240 241 242 243 244 245
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);
246

247 248 249 250 251 252 253 254 255
/* 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);


256
/* General (presently empty) initialization hooks, primarily for gnome-libs */
257 258
void gdk_pixbuf_preinit  (gpointer app, gpointer modinfo);
void gdk_pixbuf_postinit (gpointer app, gpointer modinfo);
259

260

261

262 263 264
#ifdef __cplusplus
}
#endif
265

266
#endif