src/pixbuf-renderer.h

   1 /*
   2  * Geeqie
   3  * (C) 2006 John Ellis
   4  * Copyright (C) 2008 The Geeqie Team
   5  *
   6  * Author: John Ellis
   7  *
   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!
  11  */
  12
  13 #ifndef PIXBUF_RENDERER_H
  14 #define PIXBUF_RENDERER_H
  15
  16 #include <gtk/gtkeventbox.h>
  17 #include <gtk/gtkwindow.h>
  18
  19
  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))
  26
  27
  28 typedef struct _PixbufRenderer PixbufRenderer;
  29 typedef struct _PixbufRendererClass PixbufRendererClass;
  30
  31
  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);
  36
  37 typedef void (* PixbufRendererPostProcessFunc)(PixbufRenderer *pr, GdkPixbuf **pixbuf, gint x, gint y,
  38                                                gint width, gint height, gpointer user_data);
  39
  40 typedef enum {
  41         PR_SCROLL_RESET_TOPLEFT = 0,
  42         PR_SCROLL_RESET_CENTER,
  43         PR_SCROLL_RESET_NOCHANGE,
  44         PR_SCROLL_RESET_COUNT,
  45 } PixbufRendererScrollResetType;
  46
  47 struct _PixbufRenderer
  48 {
  49         GtkEventBox eventbox;
  50
  51         gint image_width;       /* image actual dimensions (pixels) */
  52         gint image_height;
  53
  54         GdkPixbuf *pixbuf;
  55
  56         gint window_width;      /* allocated size of window (drawing area) */
  57         gint window_height;
  58
  59         gint x_offset;          /* offset of image start (non-zero when image < window) */
  60         gint y_offset;
  61
  62         gint vis_width;         /* dimensions of visible part of image */
  63         gint vis_height;
  64
  65         gint width;             /* size of scaled image (result) */
  66         gint height;
  67
  68         gint x_scroll;          /* scroll offset of image (into width, height to start drawing) */
  69         gint y_scroll;
  70
  71         gdouble norm_center_x;  /* coordinates of viewport center in the image, in range 0.0 - 1.0 */
  72         gdouble norm_center_y;  /* these coordinates are used for PR_SCROLL_RESET_NOCHANGE and should be preserved over periods with NULL pixbuf */
  73
  74         gdouble subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
  75         gdouble subpixel_y_scroll;
  76
  77         gdouble zoom_min;
  78         gdouble zoom_max;
  79         gdouble zoom;           /* zoom we want (0 is auto) */
  80         gdouble scale;          /* zoom we got (should never be 0) */
  81
  82         GdkInterpType zoom_quality;
  83         gboolean zoom_2pass;
  84         gboolean zoom_expand;
  85
  86         GdkRgbDither dither_quality;
  87
  88         PixbufRendererScrollResetType scroll_reset;
  89
  90         gboolean has_frame;
  91
  92         GtkWidget *parent_window;       /* resize parent_window when image dimensions change */
  93
  94         gboolean window_fit;
  95         gboolean window_limit;
  96         gint window_limit_size;
  97
  98         gboolean autofit_limit;
  99         gint autofit_limit_size;
 100
 101
 102         gint tile_cache_max;            /* max mb to use for offscreen buffer */
 103
 104         /*< private >*/
 105
 106         gint tile_width;
 107         gint tile_height;
 108         gint tile_cols;         /* count of tile columns */
 109         GList *tiles;           /* list of buffer tiles */
 110         gint tile_cache_size;   /* allocated size of pixmaps/pixbufs */
 111         GList *draw_queue;      /* list of areas to redraw */
 112         GList *draw_queue_2pass;/* list when 2 pass is enabled */
 113
 114         gint draw_idle_id;
 115
 116         gboolean in_drag;
 117         gint drag_last_x;
 118         gint drag_last_y;
 119         gint drag_moved;
 120
 121         gboolean source_tiles_enabled;
 122         gint source_tiles_cache_size;
 123
 124         GList *source_tiles;    /* list of active source tiles */
 125         gint source_tile_width;
 126         gint source_tile_height;
 127
 128         PixbufRendererTileRequestFunc func_tile_request;
 129         PixbufRendererTileDisposeFunc func_tile_dispose;
 130
 131         gpointer func_tile_data;
 132
 133         PixbufRendererPostProcessFunc func_post_process;
 134         gpointer post_process_user_data;
 135         gint post_process_slow;
 136
 137         gboolean delay_flip;
 138         gboolean loading;
 139         gboolean complete;
 140         gboolean debug_updated; /* debug only */
 141
 142         gint scroller_id;
 143         gint scroller_overlay;
 144         gint scroller_x;
 145         gint scroller_y;
 146         gint scroller_xpos;
 147         gint scroller_ypos;
 148         gint scroller_xinc;
 149         gint scroller_yinc;
 150
 151         GList *overlay_list;
 152         GdkPixmap *overlay_buffer;
 153
 154         GdkPixbuf *spare_tile;
 155
 156         gint orientation;
 157 };
 158
 159 struct _PixbufRendererClass
 160 {
 161         GtkEventBoxClass parent_class;
 162
 163         void (*zoom)(PixbufRenderer *pr, gdouble zoom);
 164         void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
 165         void (*scroll_notify)(PixbufRenderer *pr);
 166
 167         void (*render_complete)(PixbufRenderer *pr);
 168         void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
 169 };
 170
 171
 172 GType pixbuf_renderer_get_type (void);
 173
 174 PixbufRenderer *pixbuf_renderer_new(void);
 175
 176 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
 177 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
 178
 179 /* display a pixbuf */
 180
 181 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
 182
 183 /* same as pixbuf_renderer_set_pixbuf but waits with redrawing for pixbuf_renderer_area_changed */
 184 void pixbuf_renderer_set_pixbuf_lazy(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom, gint orientation);
 185
 186
 187 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
 188
 189 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
 190 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
 191
 192 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gint slow);
 193
 194 /* display an on-request array of pixbuf tiles */
 195
 196 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
 197                                gint tile_width, gint tile_height, gint cache_size,
 198                                PixbufRendererTileRequestFunc func_request,
 199                                PixbufRendererTileDisposeFunc func_dispose,
 200                                gpointer user_data,
 201                                gdouble zoom);
 202 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
 203 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
 204
 205 /* move image data from source to pr, source is then set to NULL image */
 206
 207 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
 208
 209 /* update region of existing image */
 210
 211 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
 212
 213 /* scrolling */
 214
 215 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 216 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
 217                                      gdouble x_align, gdouble y_align);
 218
 219 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
 220 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 221 /* zoom */
 222
 223 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
 224 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
 225
 226 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
 227 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
 228 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
 229
 230 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
 231
 232 /* sizes */
 233
 234 gint pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
 235 gint pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 236
 237 /* region of image in pixel coordinates */
 238 gint pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 239
 240 /* actual size of the PixbufRenderer window minus borders,
 241  * x and y are the scroll offset and include zoom factor.
 242  */
 243 gint pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
 244
 245 /* background color */
 246 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
 247
 248 /* overlay */
 249 typedef enum {
 250         OVL_NORMAL      = 0,
 251         OVL_RELATIVE    = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
 252         /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
 253 } OverlayRendererFlags;
 254
 255 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
 256                                  OverlayRendererFlags flags);
 257 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 258 gint pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 259 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 260
 261
 262 #endif
 263 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */