7 * This software is released under the GNU General Public License (GNU GPL).
8 * Please read the included file COPYING for more information.
9 * This software comes with no warranty of any kind, use at your own risk!
12 #ifndef PIXBUF_RENDERER_H
13 #define PIXBUF_RENDERER_H
15 #include <gtk/gtkeventbox.h>
16 #include <gtk/gtkwindow.h>
19 #define TYPE_PIXBUF_RENDERER (pixbuf_renderer_get_type())
20 #define PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
21 #define PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
22 #define IS_PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_PIXBUF_RENDERER))
23 #define IS_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
24 #define PIXBUF_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
27 typedef struct _PixbufRenderer PixbufRenderer;
28 typedef struct _PixbufRendererClass PixbufRendererClass;
31 typedef gint (* PixbufRendererTileRequestFunc)(PixbufRenderer *pr, gint x, gint y,
32 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
33 typedef void (* PixbufRendererTileDisposeFunc)(PixbufRenderer *pr, gint x, gint y,
34 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
36 PR_SCROLL_RESET_TOPLEFT = 0,
37 PR_SCROLL_RESET_CENTER,
38 PR_SCROLL_RESET_NOCHANGE
39 } PixbufRendererScrollResetType;
41 struct _PixbufRenderer
45 gint image_width; /* image actual dimensions (pixels) */
50 gint window_width; /* allocated size of window (drawing area) */
53 gint x_offset; /* offset of image start (non-zero when image < window) */
56 gint vis_width; /* dimensions of visible part of image */
59 gint width; /* size of scaled image (result) */
62 gint x_scroll; /* scroll offset of image (into width, height to start drawing) */
67 gdouble zoom; /* zoom we want (0 is auto) */
68 gdouble scale; /* zoom we got (should never be 0) */
70 GdkInterpType zoom_quality;
74 GdkRgbDither dither_quality;
76 PixbufRendererScrollResetType scroll_reset;
80 GtkWidget *parent_window; /* resize parent_window when image dimensions change */
83 gboolean window_limit;
84 gint window_limit_size;
86 gint tile_cache_max; /* max mb to use for offscreen buffer */
92 gint tile_cols; /* count of tile columns */
93 GList *tiles; /* list of buffer tiles */
94 gint tile_cache_size; /* allocated size of pixmaps/pixbufs */
95 GList *draw_queue; /* list of areas to redraw */
96 GList *draw_queue_2pass;/* list when 2 pass is enabled */
99 gint draw_idle_high; /* current idle_id has high priority */
106 gboolean source_tiles_enabled;
107 gint source_tiles_cache_size;
109 GList *source_tiles; /* list of active source tiles */
110 gint source_tile_width;
111 gint source_tile_height;
113 PixbufRendererTileRequestFunc func_tile_request;
114 PixbufRendererTileDisposeFunc func_tile_dispose;
116 gpointer func_tile_data;
123 gint scroller_overlay;
134 struct _PixbufRendererClass
136 GtkEventBoxClass parent_class;
138 void (* zoom) (PixbufRenderer *pr, gdouble zoom);
139 void (* clicked) (PixbufRenderer *pr, GdkEventButton *event);
140 void (* scroll_notify) (PixbufRenderer *pr);
142 void (* render_complete)(PixbufRenderer *pr);
146 GType pixbuf_renderer_get_type (void);
148 PixbufRenderer *pixbuf_renderer_new(void);
150 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
151 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
153 /* display a pixbuf */
155 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
156 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
158 /* display an on-request array of pixbuf tiles */
160 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
161 gint tile_width, gint tile_height, gint cache_size,
162 PixbufRendererTileRequestFunc func_request,
163 PixbufRendererTileDisposeFunc func_dispose,
166 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
168 /* move image data from source to pr, source is then set to NULL image */
170 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
172 /* update region of existing image */
174 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
178 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
179 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
180 gdouble x_align, gdouble y_align);
184 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
185 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
187 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
188 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
189 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
191 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
195 gint pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
196 gint pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
198 /* region of image in pixel coordinates */
199 gint pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
201 /* actual size of the PixbufRenderer window minus borders,
202 * x and y are the scroll offset and include zoom factor.
204 gint pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
206 /* background color */
208 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
209 void pixbuf_renderer_set_black(PixbufRenderer *pr, gint black);
213 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
214 gint relative, gint always);
215 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
216 gint pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
217 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);