gdk-pixbuf.h 7.98 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
typedef void (* GdkPixbufDestroyNotify) (guchar *pixels, gpointer data);
Jonathan Blandford's avatar
Jonathan Blandford committed
50

51 52


53
/* Reference counting */
54

55 56
GdkPixbuf *gdk_pixbuf_ref   (GdkPixbuf *pixbuf);
void       gdk_pixbuf_unref (GdkPixbuf *pixbuf);
57

58 59 60 61 62 63 64 65 66 67 68 69
/* 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);


70

71
/* Create a blank pixbuf with an optimal rowstride and a new buffer */
72
GdkPixbuf *gdk_pixbuf_new (GdkColorspace colorspace, gboolean has_alpha, int bits_per_sample,
73
			   int width, int height);
74

75 76 77 78
/* Copy a pixbuf */

GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);

79 80
/* Simple loading */

81 82
GdkPixbuf *gdk_pixbuf_new_from_file (const char *filename);

Elliot Lee's avatar
Elliot Lee committed
83
GdkPixbuf *gdk_pixbuf_new_from_data (const guchar *data,
84
				     GdkColorspace colorspace,
85
				     gboolean has_alpha,
86
				     int bits_per_sample,
87 88
				     int width, int height,
				     int rowstride,
89 90
				     GdkPixbufDestroyNotify destroy_fn,
				     gpointer destroy_fn_data);
91

92
GdkPixbuf *gdk_pixbuf_new_from_xpm_data (const char **data);
93

94
/* Adding an alpha channel */
95
GdkPixbuf *gdk_pixbuf_add_alpha (const GdkPixbuf *pixbuf, gboolean substitute_color,
96 97
				 guchar r, guchar g, guchar b);

98 99 100 101 102 103 104 105 106
/* 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);



107 108
/* Rendering to a drawable */

109
/* Alpha compositing mode */
110 111 112 113 114 115 116 117 118 119 120
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);

121 122
void gdk_pixbuf_render_to_drawable (GdkPixbuf *pixbuf,
				    GdkDrawable *drawable, GdkGC *gc,
123 124 125 126 127 128
				    int src_x, int src_y,
				    int dest_x, int dest_y,
				    int width, int height,
				    GdkRgbDither dither,
				    int x_dither, int y_dither);

129 130 131 132 133 134 135 136 137
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);

138 139 140
void gdk_pixbuf_render_pixmap_and_mask (GdkPixbuf *pixbuf,
					GdkPixmap **pixmap_return, GdkBitmap **mask_return,
					int alpha_threshold);
141

142
/* Fetching a region from a drawable */
143 144 145 146 147
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
148

149

150

151 152
/* Scaling */

153 154 155 156 157 158 159 160
/* Interpolation modes */
typedef enum {
	GDK_INTERP_NEAREST,
	GDK_INTERP_TILES,
	GDK_INTERP_BILINEAR,
	GDK_INTERP_HYPER
} GdkInterpType;

161 162 163 164 165 166 167 168 169 170
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,
171
				 GdkInterpType    interp_type);
172 173 174 175 176 177 178 179 180 181
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,
182
				 GdkInterpType    interp_type,
183 184 185 186 187 188 189 190 191 192 193
				 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,
194
				 GdkInterpType    interp_type,
195 196 197 198
				 int              overall_alpha,
				 int              check_x,
				 int              check_y,
				 int              check_size,
199 200
				 guint32          color1,
				 guint32          color2);
201 202 203 204

GdkPixbuf *gdk_pixbuf_scale_simple           (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
205 206
					      GdkInterpType    interp_type);

207 208 209
GdkPixbuf *gdk_pixbuf_composite_color_simple (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
210
					      GdkInterpType    interp_type,
211 212
					      int              overall_alpha,
					      int              check_size,
213 214 215 216
					      guint32          color1,
					      guint32          color2);


217

218
/* Animation support */
Jonathan Blandford's avatar
Jonathan Blandford committed
219

220 221 222 223 224 225 226
/* 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
227
GdkPixbufAnimation *gdk_pixbuf_animation_new_from_file   (const char         *filename);
Jonathan Blandford's avatar
Jonathan Blandford committed
228

Ettore Perazzoli's avatar
Ettore Perazzoli committed
229 230 231 232 233 234 235
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);
236

237 238 239 240 241 242 243 244 245
/* 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);


246
/* General (presently empty) initialization hooks, primarily for gnome-libs */
247 248
void gdk_pixbuf_preinit  (gpointer app, gpointer modinfo);
void gdk_pixbuf_postinit (gpointer app, gpointer modinfo);
249

250

251

252 253 254
#ifdef __cplusplus
}
#endif
255

256
#endif