4 * Copyright (C) 2008 The Geeqie Team
8 * This software is released under the GNU General Public License (GNU GPL).
9 * Please read the included file COPYING for more information.
10 * This software comes with no warranty of any kind, use at your own risk!
13 #ifndef PIXBUF_RENDERER_H
14 #define PIXBUF_RENDERER_H
16 #include <gtk/gtkeventbox.h>
17 #include <gtk/gtkwindow.h>
20 #define TYPE_PIXBUF_RENDERER (pixbuf_renderer_get_type())
21 #define PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
22 #define PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
23 #define IS_PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_PIXBUF_RENDERER))
24 #define IS_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
25 #define PIXBUF_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
28 typedef struct _PixbufRenderer PixbufRenderer;
29 typedef struct _PixbufRendererClass PixbufRendererClass;
32 typedef gint (* PixbufRendererTileRequestFunc)(PixbufRenderer *pr, gint x, gint y,
33 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
34 typedef void (* PixbufRendererTileDisposeFunc)(PixbufRenderer *pr, gint x, gint y,
35 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
37 typedef void (* PixbufRendererPostProcessFunc)(PixbufRenderer *pr, GdkPixbuf **pixbuf, gint x, gint y,
38 gint width, gint height, gpointer user_data);
41 PR_SCROLL_RESET_TOPLEFT = 0,
42 PR_SCROLL_RESET_CENTER,
43 PR_SCROLL_RESET_NOCHANGE,
44 PR_SCROLL_RESET_COUNT,
45 } PixbufRendererScrollResetType;
47 struct _PixbufRenderer
51 gint image_width; /* image actual dimensions (pixels) */
56 gint window_width; /* allocated size of window (drawing area) */
59 gint x_offset; /* offset of image start (non-zero when image < window) */
62 gint vis_width; /* dimensions of visible part of image */
65 gint width; /* size of scaled image (result) */
68 gint x_scroll; /* scroll offset of image (into width, height to start drawing) */
71 gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
72 gdouble subpixel_y_scroll;
76 gdouble zoom; /* zoom we want (0 is auto) */
77 gdouble scale; /* zoom we got (should never be 0) */
79 GdkInterpType zoom_quality;
83 GdkRgbDither dither_quality;
85 PixbufRendererScrollResetType scroll_reset;
89 GtkWidget *parent_window; /* resize parent_window when image dimensions change */
92 gboolean window_limit;
93 gint window_limit_size;
95 gboolean autofit_limit;
96 gint autofit_limit_size;
99 gint tile_cache_max; /* max mb to use for offscreen buffer */
105 gint tile_cols; /* count of tile columns */
106 GList *tiles; /* list of buffer tiles */
107 gint tile_cache_size; /* allocated size of pixmaps/pixbufs */
108 GList *draw_queue; /* list of areas to redraw */
109 GList *draw_queue_2pass;/* list when 2 pass is enabled */
118 gboolean source_tiles_enabled;
119 gint source_tiles_cache_size;
121 GList *source_tiles; /* list of active source tiles */
122 gint source_tile_width;
123 gint source_tile_height;
125 PixbufRendererTileRequestFunc func_tile_request;
126 PixbufRendererTileDisposeFunc func_tile_dispose;
128 gpointer func_tile_data;
130 PixbufRendererPostProcessFunc func_post_process;
131 gpointer post_process_user_data;
132 gint post_process_slow;
137 gboolean debug_updated; /* debug only */
140 gint scroller_overlay;
149 GdkPixmap *overlay_buffer;
151 GdkPixbuf *spare_tile;
156 struct _PixbufRendererClass
158 GtkEventBoxClass parent_class;
160 void (*zoom)(PixbufRenderer *pr, gdouble zoom);
161 void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
162 void (*scroll_notify)(PixbufRenderer *pr);
164 void (*render_complete)(PixbufRenderer *pr);
165 void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
169 GType pixbuf_renderer_get_type (void);
171 PixbufRenderer *pixbuf_renderer_new(void);
173 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
174 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
176 /* display a pixbuf */
178 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
179 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
181 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
182 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
184 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gint slow);
186 /* display an on-request array of pixbuf tiles */
188 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
189 gint tile_width, gint tile_height, gint cache_size,
190 PixbufRendererTileRequestFunc func_request,
191 PixbufRendererTileDisposeFunc func_dispose,
194 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
195 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
197 /* move image data from source to pr, source is then set to NULL image */
199 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
201 /* update region of existing image */
203 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
207 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
208 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
209 gdouble x_align, gdouble y_align);
211 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
212 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
215 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
216 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
218 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
219 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
220 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
222 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
226 gint pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
227 gint pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
229 /* region of image in pixel coordinates */
230 gint pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
232 /* actual size of the PixbufRenderer window minus borders,
233 * x and y are the scroll offset and include zoom factor.
235 gint pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
237 /* background color */
238 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
243 OVL_RELATIVE = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
244 /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
245 } OverlayRendererFlags;
247 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
248 OverlayRendererFlags flags);
249 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
250 gint pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
251 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);