4 * Copyright (C) 2008 - 2010 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))
27 /* alpha channel checkerboard background (same as gimp) */
28 #define PR_ALPHA_CHECK1 0x00999999
29 #define PR_ALPHA_CHECK2 0x00666666
30 #define PR_ALPHA_CHECK_SIZE 16
31 /* when scaling image to below this size, use nearest pixel for scaling
32 * (below about 4, the other scale types become slow generating their conversion tables)
34 #define PR_MIN_SCALE_SIZE 8
36 /* default size of tile cache (mb) */
37 #define PR_CACHE_SIZE_DEFAULT 8
39 /* round A up/down to integer count of B */
40 #define ROUND_UP(A,B) ((gint)(((A)+(B)-1)/(B))*(B))
41 #define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
44 typedef struct _RendererFuncs RendererFuncs;
46 typedef struct _PixbufRenderer PixbufRenderer;
47 typedef struct _PixbufRendererClass PixbufRendererClass;
50 typedef gint (* PixbufRendererTileRequestFunc)(PixbufRenderer *pr, gint x, gint y,
51 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
52 typedef void (* PixbufRendererTileDisposeFunc)(PixbufRenderer *pr, gint x, gint y,
53 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
55 typedef void (* PixbufRendererPostProcessFunc)(PixbufRenderer *pr, GdkPixbuf **pixbuf, gint x, gint y,
56 gint width, gint height, gpointer user_data);
59 PR_SCROLL_RESET_TOPLEFT = 0,
60 PR_SCROLL_RESET_CENTER,
61 PR_SCROLL_RESET_NOCHANGE,
62 PR_SCROLL_RESET_COUNT,
63 } PixbufRendererScrollResetType;
66 TILE_RENDER_NONE = 0, /* do nothing */
67 TILE_RENDER_AREA, /* render an area of the tile */
68 TILE_RENDER_ALL /* render the whole tile */
73 OVL_RELATIVE = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
74 /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
75 } OverlayRendererFlags;
78 PR_STEREO_NONE = 0, /* do nothing */
79 PR_STEREO_DUAL = 1 << 0, /* independent stereo buffers, for example nvidia opengl */
80 PR_STEREO_HORIZ = 1 << 2, /* side by side */
81 PR_STEREO_VERT = 1 << 3, /* above below */
82 /* flags for renderer: */
83 PR_STEREO_RIGHT = 1 << 4, /* above below */
84 PR_STEREO_ANAGLYPH = 1 << 5 /* anaglyph */
86 } PixbufRendererStereoMode;
90 void (*queue)(void *renderer, gint x, gint y, gint w, gint h,
91 gint clamp, ImageRenderType render, gboolean new_data, gboolean only_existing);
92 void (*queue_clear)(void *renderer);
93 void (*border_draw)(void *renderer, gint x, gint y, gint w, gint h);
94 void (*invalidate_all)(void *renderer);
95 void (*invalidate_region)(void *renderer, gint x, gint y, gint w, gint h);
96 void (*scroll)(void *renderer, gint x_off, gint y_off);
97 void (*update_sizes)(void *renderer);
99 gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
100 void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
101 gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
102 void (*overlay_draw)(void *renderer, gint x, gint y, gint w, gint h);
104 void (*free)(void *renderer);
107 struct _PixbufRenderer
109 GtkEventBox eventbox;
111 gint image_width; /* image actual dimensions (pixels) */
113 gint stereo_pixbuf_off; /* offset of the right part of the stereo image in pixbuf */
117 gint window_width; /* allocated size of window (drawing area) */
120 gint viewport_width; /* allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
121 gint viewport_height;
123 gint x_offset; /* offset of image start (non-zero when viewport < window) */
126 gint x_mouse; /* coordinates of the mouse taken from GtkEvent */
129 gint vis_width; /* dimensions of visible part of image */
132 gint width; /* size of scaled image (result) */
135 gint x_scroll; /* scroll offset of image (into width, height to start drawing) */
138 gdouble norm_center_x; /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
139 gdouble norm_center_y; /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
141 gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
142 gdouble subpixel_y_scroll;
146 gdouble zoom; /* zoom we want (0 is auto) */
147 gdouble scale; /* zoom we got (should never be 0) */
149 GdkInterpType zoom_quality;
151 gboolean zoom_expand;
153 GdkRgbDither dither_quality;
155 PixbufRendererScrollResetType scroll_reset;
159 GtkWidget *parent_window; /* resize parent_window when image dimensions change */
162 gboolean window_limit;
163 gint window_limit_size;
165 gboolean autofit_limit;
166 gint autofit_limit_size;
176 gboolean source_tiles_enabled;
177 gint source_tiles_cache_size;
179 GList *source_tiles; /* list of active source tiles */
180 gint source_tile_width;
181 gint source_tile_height;
183 PixbufRendererTileRequestFunc func_tile_request;
184 PixbufRendererTileDisposeFunc func_tile_dispose;
186 gpointer func_tile_data;
188 PixbufRendererPostProcessFunc func_post_process;
189 gpointer post_process_user_data;
190 gint post_process_slow;
195 gboolean debug_updated; /* debug only */
197 guint scroller_id; /* event source id */
198 gint scroller_overlay;
210 RendererFuncs *renderer;
211 RendererFuncs *renderer2;
214 struct _PixbufRendererClass
216 GtkEventBoxClass parent_class;
218 void (*zoom)(PixbufRenderer *pr, gdouble zoom);
219 void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
220 void (*scroll_notify)(PixbufRenderer *pr);
221 void (*update_pixel)(PixbufRenderer *pr);
223 void (*render_complete)(PixbufRenderer *pr);
224 void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
230 GType pixbuf_renderer_get_type(void);
232 PixbufRenderer *pixbuf_renderer_new(void);
234 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
235 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
237 /* display a pixbuf */
239 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
241 /* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
242 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation);
245 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
247 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
248 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
250 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
252 /* display an on-request array of pixbuf tiles */
254 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
255 gint tile_width, gint tile_height, gint cache_size,
256 PixbufRendererTileRequestFunc func_request,
257 PixbufRendererTileDisposeFunc func_dispose,
260 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
261 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
263 /* move image data from source to pr, source is then set to NULL image */
265 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
267 /* update region of existing image */
269 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
273 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
274 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
275 gdouble x_align, gdouble y_align);
277 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
278 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
281 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
282 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
284 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
285 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
286 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
288 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
292 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
293 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
295 /* region of image in pixel coordinates */
296 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
298 /* actual size of the PixbufRenderer window minus borders,
299 * x and y are the scroll offset and include zoom factor.
301 gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
303 /* background color */
304 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
308 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
309 OverlayRendererFlags flags);
310 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
311 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
312 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
314 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
315 /* x_pixel and y_pixel are the pixel coordinates \see pixbuf_renderer_get_mouse_position */
316 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
317 gint *r_mouse, gint *g_mouse, gint *b_mouse);
319 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
321 /* protected - for renderer use only*/
323 typedef struct _SourceTile SourceTile;
333 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
334 gint clip_x, gint clip_y, gint clip_w, gint clip_h,
335 gint *rx, gint *ry, gint *rw, gint *rh);
336 void pr_render_complete_signal(PixbufRenderer *pr);
338 void pr_tile_coords_map_orientation(gint orientation,
339 gdouble tile_x, gdouble tile_y, /* coordinates of the tile */
340 gdouble image_w, gdouble image_h,
341 gdouble tile_w, gdouble tile_h,
342 gdouble *res_x, gdouble *res_y);
343 void pr_tile_region_map_orientation(gint orientation,
344 gint area_x, gint area_y, /* coordinates of the area inside tile */
345 gint tile_w, gint tile_h,
346 gint area_w, gint area_h,
347 gint *res_x, gint *res_y,
348 gint *res_w, gint *res_h);
349 void pr_coords_map_orientation_reverse(gint orientation,
350 gint area_x, gint area_y,
351 gint tile_w, gint tile_h,
352 gint area_w, gint area_h,
353 gint *res_x, gint *res_y,
354 gint *res_w, gint *res_h);
356 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
358 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */