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 #include <gdk-pixbuf/gdk-pixbuf.h>
27 #include <glib-object.h>
33 struct PixbufRenderer;
35 #define TYPE_PIXBUF_RENDERER (pixbuf_renderer_get_type())
36 #define PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), TYPE_PIXBUF_RENDERER, PixbufRenderer))
37 #define PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
38 #define IS_PIXBUF_RENDERER(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), TYPE_PIXBUF_RENDERER))
39 #define IS_PIXBUF_RENDERER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), TYPE_PIXBUF_RENDERER))
40 #define PIXBUF_RENDERER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), TYPE_PIXBUF_RENDERER, PixbufRendererClass))
43 * @def PR_ALPHA_CHECK_SIZE
44 * alpha channel checkerboard (same as gimp)
46 #define PR_ALPHA_CHECK_SIZE 16
49 * @def PR_MIN_SCALE_SIZE
50 * when scaling image to below this size, use nearest pixel for scaling
51 * (below about 4, the other scale types become slow generating their conversion tables)
53 #define PR_MIN_SCALE_SIZE 8
56 * @def PR_CACHE_SIZE_DEFAULT
57 * default size of tile cache (MiB)
59 #define PR_CACHE_SIZE_DEFAULT 8
63 * round A up to integer count of B
65 #define ROUND_UP(A,B) ((gint)(((A)+(B)-1)/(B))*(B))
69 * round A down to integer count of B
71 #define ROUND_DOWN(A,B) ((gint)(((A))/(B))*(B))
74 using PixbufRendererTileRequestFunc = gint (*)(PixbufRenderer *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
75 using PixbufRendererTileDisposeFunc = void (*)(PixbufRenderer *, gint, gint, gint, gint, GdkPixbuf *, gpointer);
77 using PixbufRendererPostProcessFunc = void (*)(PixbufRenderer *, GdkPixbuf **, gint, gint, gint, gint, gpointer);
79 enum ImageRenderType {
80 TILE_RENDER_NONE = 0, /**< do nothing */
81 TILE_RENDER_AREA, /**< render an area of the tile */
82 TILE_RENDER_ALL /**< render the whole tile */
85 enum OverlayRendererFlags {
87 OVL_RELATIVE = 1 << 0, /**< x,y coordinates are relative, negative values start bottom right */
88 /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /**< hide temporarily when scrolling (not yet implemented) */
93 void (*area_changed)(void *renderer, gint src_x, gint src_y, gint src_w, gint src_h); /**< pixbuf area changed */
94 void (*invalidate_region)(void *renderer, gint x, gint y, gint w, gint h);
95 void (*scroll)(void *renderer, gint x_off, gint y_off); /**< scroll */
96 void (*update_viewport)(void *renderer); /**< window / wiewport / border color has changed */
97 void (*update_pixbuf)(void *renderer, gboolean lazy); /**< pixbuf has changed */
98 void (*update_zoom)(void *renderer, gboolean lazy); /**< zoom has changed */
100 gint (*overlay_add)(void *renderer, GdkPixbuf *pixbuf, gint x, gint y, OverlayRendererFlags flags);
101 void (*overlay_set)(void *renderer, gint id, GdkPixbuf *pixbuf, gint x, gint y);
102 gboolean (*overlay_get)(void *renderer, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
104 void (*stereo_set)(void *renderer, gint stereo_mode); /**< set stereo mode */
106 void (*free)(void *renderer);
109 struct PixbufRenderer
111 GtkEventBox eventbox;
113 gint image_width; /**< image actual dimensions (pixels) */
115 gint stereo_pixbuf_offset_right; /**< offset of the right part of the stereo image in pixbuf */
116 gint stereo_pixbuf_offset_left; /**< offset of the left part of the stereo image in pixbuf */
120 gint window_width; /**< allocated size of window (drawing area) */
123 gint viewport_width; /**< allocated size of viewport (same as window for normal mode, half of window for SBS mode) */
124 gint viewport_height;
126 gint x_offset; /**< offset of image start (non-zero when viewport < window) */
129 gint x_mouse; /**< coordinates of the mouse taken from GtkEvent */
132 gint vis_width; /**< dimensions of visible part of image */
135 gint width; /**< size of scaled image (result) */
138 gint x_scroll; /**< scroll offset of image (into width, height to start drawing) */
141 gdouble norm_center_x; /**< coordinates of viewport center in the image, in range 0.0 - 1.0 */
142 gdouble norm_center_y; /**< these coordinates are used for ScrollReset::NOCHANGE and should be preserved over periods with NULL pixbuf */
144 gdouble subpixel_x_scroll; /**< subpixel scroll alignment, used to prevent accumulation of rounding errors */
145 gdouble subpixel_y_scroll;
149 gdouble zoom; /**< zoom we want (0 is auto) */
150 gdouble scale; /**< zoom we got (should never be 0) */
152 gdouble aspect_ratio; /**< screen pixel aspect ratio (2.0 for 3DTV SBS mode) */
154 GdkInterpType zoom_quality;
156 gboolean zoom_expand;
158 ScrollReset scroll_reset;
162 GtkWidget *parent_window; /**< resize parent_window when image dimensions change */
165 gboolean window_limit;
166 gint window_limit_size;
168 gboolean autofit_limit;
169 gint autofit_limit_size;
170 gint enlargement_limit_size;
180 gboolean source_tiles_enabled;
181 gint source_tiles_cache_size;
183 GList *source_tiles; /**< list of active source tiles */
184 gint source_tile_width;
185 gint source_tile_height;
187 PixbufRendererTileRequestFunc func_tile_request;
188 PixbufRendererTileDisposeFunc func_tile_dispose;
190 gpointer func_tile_data;
192 PixbufRendererPostProcessFunc func_post_process;
193 gpointer post_process_user_data;
194 gint post_process_slow;
199 gboolean debug_updated; /**< debug only */
201 guint scroller_id; /**< event source id */
202 gint scroller_overlay;
214 StereoPixbufData stereo_data;
215 gboolean stereo_temp_disable;
216 gint stereo_fixed_width;
217 gint stereo_fixed_height;
218 gint stereo_fixed_x_left;
219 gint stereo_fixed_y_left;
220 gint stereo_fixed_x_right;
221 gint stereo_fixed_y_right;
223 RendererFuncs *renderer;
224 RendererFuncs *renderer2;
226 gboolean ignore_alpha;
229 struct PixbufRendererClass
231 GtkEventBoxClass parent_class;
233 void (*zoom)(PixbufRenderer *pr, gdouble zoom);
234 void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
235 void (*scroll_notify)(PixbufRenderer *pr);
236 void (*update_pixel)(PixbufRenderer *pr);
238 void (*render_complete)(PixbufRenderer *pr);
239 void (*drag)(PixbufRenderer *pr, GdkEventMotion *event);
245 GType pixbuf_renderer_get_type();
247 PixbufRenderer *pixbuf_renderer_new();
249 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
252 * @headerfile pixbuf_renderer_set_pixbuf
255 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
258 * @headerfile pixbuf_renderer_set_pixbuf_lazy
259 * same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
260 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation, StereoPixbufData stereo_data);
263 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
265 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
268 * @headerfile pixbuf_renderer_set_stereo_data
269 * sets the format of stereo data in the input pixbuf
271 void pixbuf_renderer_set_stereo_data(PixbufRenderer *pr, StereoPixbufData stereo_data);
273 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gboolean slow);
276 * @headerfile pixbuf_renderer_set_tiles
277 * display an on-request array of pixbuf tiles
279 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
280 gint tile_width, gint tile_height, gint cache_size,
281 PixbufRendererTileRequestFunc func_request,
282 PixbufRendererTileDisposeFunc func_dispose,
285 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
286 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
289 * @headerfile pixbuf_renderer_move
290 * move image data from source to pr, source is then set to NULL image
292 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
293 void pixbuf_renderer_copy(PixbufRenderer *pr, PixbufRenderer *source);
296 * @headerfile pixbuf_renderer_area_changed
297 * update region of existing image
299 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
303 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
304 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
305 gdouble x_align, gdouble y_align);
307 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
308 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
311 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
312 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
314 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
315 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
316 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
318 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
322 gboolean pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
323 gboolean pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
326 * @headerfile pixbuf_renderer_get_visible_rect
327 * region of image in pixel coordinates
329 gboolean pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
332 * @headerfile pixbuf_renderer_set_color
335 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkRGBA *color);
339 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
340 OverlayRendererFlags flags);
341 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
342 gboolean pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
343 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
345 gboolean pixbuf_renderer_get_mouse_position(PixbufRenderer *pr, gint *x_pixel, gint *y_pixel);
348 * @headerfile pixbuf_renderer_get_pixel_colors
349 * x_pixel and y_pixel are the pixel coordinates see #pixbuf_renderer_get_mouse_position
351 gboolean pixbuf_renderer_get_pixel_colors(PixbufRenderer *pr, gint x_pixel, gint y_pixel,
352 gint *r_mouse, gint *g_mouse, gint *b_mouse);
354 void pixbuf_renderer_set_size_early(PixbufRenderer *pr, guint width, guint height);
357 void pixbuf_renderer_stereo_set(PixbufRenderer *pr, gint stereo_mode);
358 gint pixbuf_renderer_stereo_get(PixbufRenderer *pr);
359 void pixbuf_renderer_stereo_fixed_set(PixbufRenderer *pr, gint width, gint height, gint x1, gint y1, gint x2, gint y2);
363 * protected - for renderer use only
374 gboolean pr_clip_region(gint x, gint y, gint w, gint h,
375 gint clip_x, gint clip_y, gint clip_w, gint clip_h,
376 gint *rx, gint *ry, gint *rw, gint *rh);
377 void pr_render_complete_signal(PixbufRenderer *pr);
379 void pr_tile_coords_map_orientation(gint orientation,
380 gdouble tile_x, gdouble tile_y, /**< coordinates of the tile */
381 gdouble image_w, gdouble image_h,
382 gdouble tile_w, gdouble tile_h,
383 gdouble *res_x, gdouble *res_y);
384 void pr_tile_region_map_orientation(gint orientation,
385 gint area_x, gint area_y, /**< coordinates of the area inside tile */
386 gint tile_w, gint tile_h,
387 gint area_w, gint area_h,
388 gint *res_x, gint *res_y,
389 gint *res_w, gint *res_h);
390 void pr_coords_map_orientation_reverse(gint orientation,
391 gint area_x, gint area_y,
392 gint tile_w, gint tile_h,
393 gint area_w, gint area_h,
394 gint *res_x, gint *res_y,
395 gint *res_w, gint *res_h);
397 GList *pr_source_tile_compute_region(PixbufRenderer *pr, gint x, gint y, gint w, gint h, gboolean request);
399 void pr_create_anaglyph(guint mode, GdkPixbuf *pixbuf, GdkPixbuf *right, gint x, gint y, gint w, gint h);
401 void pixbuf_renderer_set_ignore_alpha(PixbufRenderer *pr, gint ignore_alpha);
403 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */