gdk-pixbuf.h 7.14 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 30 31 32
#ifdef __cplusplus
extern "C" {
#endif

Owen Taylor's avatar
Owen Taylor committed
33
#include <glib.h>
34
#include <gdk-pixbuf/gdk-pixbuf-features.h>
Michael Meeks's avatar
Michael Meeks committed
35

36

Arturo Espinosa's avatar
Arturo Espinosa committed
37

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

43 44 45 46
/* 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
47

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

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

54 55


56
/* Reference counting */
57

58 59 60 61 62 63 64 65
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);
66

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


79

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

84 85 86 87
/* Copy a pixbuf */

GdkPixbuf *gdk_pixbuf_copy (const GdkPixbuf *pixbuf);

88 89
/* Simple loading */

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

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

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

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

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



116
/* Rendering to a drawable */
117

118

119 120
/* Scaling */

121 122 123 124 125 126 127 128
/* Interpolation modes */
typedef enum {
	GDK_INTERP_NEAREST,
	GDK_INTERP_TILES,
	GDK_INTERP_BILINEAR,
	GDK_INTERP_HYPER
} GdkInterpType;

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

GdkPixbuf *gdk_pixbuf_scale_simple           (const GdkPixbuf *src,
					      int              dest_width,
					      int              dest_height,
173 174
					      GdkInterpType    interp_type);

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


185

186
/* Animation support */
Jonathan Blandford's avatar
Jonathan Blandford committed
187

188 189 190 191 192 193 194
/* 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
195
GdkPixbufAnimation *gdk_pixbuf_animation_new_from_file   (const char         *filename);
Jonathan Blandford's avatar
Jonathan Blandford committed
196

Ettore Perazzoli's avatar
Ettore Perazzoli committed
197 198 199 200 201 202 203
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);
204

205 206 207 208 209 210 211 212 213
/* 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);


214
/* General (presently empty) initialization hooks, primarily for gnome-libs */
215 216
void gdk_pixbuf_preinit  (gpointer app, gpointer modinfo);
void gdk_pixbuf_postinit (gpointer app, gpointer modinfo);
217

218

219

220 221 222
#ifdef __cplusplus
}
#endif
223

224
#endif