2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #ifndef PIXBUF_RENDERER_H
23 #define PIXBUF_RENDERER_H
25 #define TYPE_PIXBUF_RENDERER (pixbuf_renderer_get_type())
26 #define PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
27 #define PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
28 #define IS_PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_PIXBUF_RENDERER))
29 #define IS_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
30 #define PIXBUF_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
32 /* alpha channel checkerboard (same as gimp) */
33 #define PR_ALPHA_CHECK_SIZE 16
34 /* when scaling image to below this size, use nearest pixel for scaling
35 * (below about 4, the other scale types become slow generating their conversion tables)
37 #define PR_MIN_SCALE_SIZE 8
39 /* default size of tile cache (mb) */
40 #define PR_CACHE_SIZE_DEFAULT 8
42 /* round A up/down to integer count of B */
43 #define ROUND_UP(A,B) ((gint)(((A)+(B)-1)/(B))*(B))
44 #define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
47 typedef struct _RendererFuncs RendererFuncs;
49 typedef struct _PixbufRenderer PixbufRenderer;
50 typedef struct _PixbufRendererClass PixbufRendererClass;
53 typedef gint (* PixbufRendererTileRequestFunc)(PixbufRenderer *pr, gint x, gint y,
54 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
55 typedef void (* PixbufRendererTileDisposeFunc)(PixbufRenderer *pr, gint x, gint y,
56 gint width, gint height, GdkPixbuf *pixbuf, gpointer user_data);
58 typedef void (* PixbufRendererPostProcessFunc)(PixbufRenderer *pr, GdkPixbuf **pixbuf, gint x, gint y,
59 gint width, gint height, gpointer user_data);
62 PR_SCROLL_RESET_TOPLEFT = 0,
63 PR_SCROLL_RESET_CENTER,
64 PR_SCROLL_RESET_NOCHANGE,
65 PR_SCROLL_RESET_COUNT,
66 } PixbufRendererScrollResetType;
69 TILE_RENDER_NONE = 0, /* do nothing */
70 TILE_RENDER_AREA, /* render an area of the tile */
71 TILE_RENDER_ALL /* render the whole tile */
76 OVL_RELATIVE = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
77 /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
78 } OverlayRendererFlags;
82 // void (*redraw)(void *renderer, gint x, gint y, gint w, gint h,
83 // gint clamp, ImageRenderType render, gboolean new_data, gboolean only_existing);
84 void (*area_changed)(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h); /* pixbuf area changed */
85 void (*invalidate_region)(void *renderer, gint x, gint y, gint w, gint h);
86 void (*scroll)(void *renderer, gint x_off, gint y_off); /* scroll */
87 void (*update_viewport)(void *renderer); /* window / wiewport / border color has changed */
88 void (*update_pixbuf)(void *renderer, gboolean lazy); /* pixbuf has changed */
89 void (*update_zoom)(void *renderer, gboolean lazy); /* zoom has changed */
91 gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
92 void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
93 gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
95 void (*stereo_set)(void *renderer, gint stereo_mode); /* set stereo mode */
97 void (*free)(void *renderer);
100 struct _PixbufRenderer
102 GtkEventBox eventbox;
104 gint image_width; /* image actual dimensions (pixels) */
106 gint stereo_pixbuf_offset_right; /* offset of the right part of the stereo image in pixbuf */
107 gint stereo_pixbuf_offset_left; /* offset of the left part of the stereo image in pixbuf */
111 gint window_width; /* allocated size of window (drawing area) */
114 gint viewport_width; /* allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
115 gint viewport_height;
117 gint x_offset; /* offset of image start (non-zero when viewport < window) */
120 gint x_mouse; /* coordinates of the mouse taken from GtkEvent */
123 gint vis_width; /* dimensions of visible part of image */
126 gint width; /* size of scaled image (result) */
129 gint x_scroll; /* scroll offset of image (into width, height to start drawing) */
132 gdouble norm_center_x; /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
133 gdouble norm_center_y; /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
135 gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent accumulation of rounding errors */
136 gdouble subpixel_y_scroll;
140 gdouble zoom; /* zoom we want (0 is auto) */
141 gdouble scale; /* zoom we got (should never be 0) */
143 gdouble aspect_ratio; /* screen pixel aspect ratio (2.0 for 3DTV SBS mode) */
145 GdkInterpType zoom_quality;
147 gboolean zoom_expand;
149 PixbufRendererScrollResetType scroll_reset;
153 GtkWidget *parent_window; /* resize parent_window when image dimensions change */
156 gboolean window_limit;
157 gint window_limit_size;
159 gboolean autofit_limit;
160 gint autofit_limit_size;
161 gint enlargement_limit_size;
171 gboolean source_tiles_enabled;
172 gint source_tiles_cache_size;
174 GList *source_tiles; /* list of active source tiles */
175 gint source_tile_width;
176 gint source_tile_height;
178 PixbufRendererTileRequestFunc func_tile_request;
179 PixbufRendererTileDisposeFunc func_tile_dispose;
181 gpointer func_tile_data;
183 PixbufRendererPostProcessFunc func_post_process;
184 gpointer post_process_user_data;
185 gint post_process_slow;
190 gboolean debug_updated; /* debug only */
192 guint scroller_id; /* event source id */
193 gint scroller_overlay;
205 StereoPixbufData stereo_data;
206 gboolean stereo_temp_disable;
207 gint stereo_fixed_width;
208 gint stereo_fixed_height;
209 gint stereo_fixed_x_left;
210 gint stereo_fixed_y_left;
211 gint stereo_fixed_x_right;
212 gint stereo_fixed_y_right;
214 RendererFuncs *renderer;
215 RendererFuncs *renderer2;
217 gboolean ignore_alpha;
220 struct _PixbufRendererClass
222 GtkEventBoxClass parent_class;
224 void (*zoom)(PixbufRenderer *pr, gdouble zoom);
225 void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
226 void (*scroll_notify)(PixbufRenderer *pr);
227 void (*update_pixel)(PixbufRenderer *pr);
229 void (*render_complete)(PixbufRenderer *pr);
230 void (*drag)(PixbufRenderer *pr, GdkEventMotion *event);
236 GType pixbuf_renderer_get_type(void);
238 PixbufRenderer *pixbuf_renderer_new(void);
240 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
241 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
243 /* display a pixbuf */
245 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
247 /* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
248 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation, StereoPixbufData stereo_data);
251 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
253 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
254 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
256 /* sets the format of stereo data in the input pixbuf */
257 void pixbuf_renderer_set_stereo_data(PixbufRenderer *pr, StereoPixbufData stereo_data);
259 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
261 /* display an on-request array of pixbuf tiles */
263 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
264 gint tile_width, gint tile_height, gint cache_size,
265 PixbufRendererTileRequestFunc func_request,
266 PixbufRendererTileDisposeFunc func_dispose,
269 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
270 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
272 /* move image data from source to pr, source is then set to NULL image */
274 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
275 void pixbuf_renderer_copy(PixbufRenderer *pr, PixbufRenderer *source);
277 /* update region of existing image */
279 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
283 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
284 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
285 gdouble x_align, gdouble y_align);
287 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
288 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
291 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
292 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
294 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
295 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
296 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
298 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
302 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
303 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
305 /* region of image in pixel coordinates */
306 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
308 /* actual size of the PixbufRenderer window minus borders,
309 * x and y are the scroll offset and include zoom factor.
311 gboolean pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
313 /* background color */
314 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
318 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
319 OverlayRendererFlags flags);
320 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
321 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
322 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
324 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
325 /* x_pixel and y_pixel are the pixel coordinates \see pixbuf_renderer_get_mouse_position */
326 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
327 gint *r_mouse, gint *g_mouse, gint *b_mouse);
329 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
332 void pixbuf_renderer_stereo_set(PixbufRenderer *pr, gint stereo_mode);
333 gint pixbuf_renderer_stereo_get(PixbufRenderer *pr);
334 void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
336 /* protected - for renderer use only*/
338 typedef struct _SourceTile SourceTile;
348 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
349 gint clip_x, gint clip_y, gint clip_w, gint clip_h,
350 gint *rx, gint *ry, gint *rw, gint *rh);
351 void pr_render_complete_signal(PixbufRenderer *pr);
353 void pr_tile_coords_map_orientation(gint orientation,
354 gdouble tile_x, gdouble tile_y, /* coordinates of the tile */
355 gdouble image_w, gdouble image_h,
356 gdouble tile_w, gdouble tile_h,
357 gdouble *res_x, gdouble *res_y);
358 void pr_tile_region_map_orientation(gint orientation,
359 gint area_x, gint area_y, /* coordinates of the area inside tile */
360 gint tile_w, gint tile_h,
361 gint area_w, gint area_h,
362 gint *res_x, gint *res_y,
363 gint *res_w, gint *res_h);
364 void pr_coords_map_orientation_reverse(gint orientation,
365 gint area_x, gint area_y,
366 gint tile_w, gint tile_h,
367 gint area_w, gint area_h,
368 gint *res_x, gint *res_y,
369 gint *res_w, gint *res_h);
371 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
373 void pr_create_anaglyph(guint mode, GdkPixbuf *pixbuf, GdkPixbuf *right, gint x, gint y, gint w, gint h);
375 void pixbuf_renderer_set_ignore_alpha(PixbufRenderer *pr, gint ignore_alpha);
377 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */