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 subpixel_x_scroll; /* subpixel scroll alignment, used to prevent acumulation of rounding errors */
  72         gdouble subpixel_y_scroll;
  73
  74         gdouble zoom_min;
  75         gdouble zoom_max;
  76         gdouble zoom;           /* zoom we want (0 is auto) */
  77         gdouble scale;          /* zoom we got (should never be 0) */
  78
  79         GdkInterpType zoom_quality;
  80         gboolean zoom_2pass;
  81         gboolean zoom_expand;
  82
  83         GdkRgbDither dither_quality;
  84
  85         PixbufRendererScrollResetType scroll_reset;
  86
  87         gboolean has_frame;
  88
  89         GtkWidget *parent_window;       /* resize parent_window when image dimensions change */
  90
  91         gboolean window_fit;
  92         gboolean window_limit;
  93         gint window_limit_size;
  94
  95         gboolean autofit_limit;
  96         gint autofit_limit_size;
  97
  98
  99         gint tile_cache_max;            /* max mb to use for offscreen buffer */
 100
 101         /*< private >*/
 102
 103         gint tile_width;
 104         gint tile_height;
 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 */
 110
 111         gint draw_idle_id;
 112         gint draw_idle_high;    /* current idle_id has high priority */
 113
 114         gboolean in_drag;
 115         gint drag_last_x;
 116         gint drag_last_y;
 117         gint drag_moved;
 118
 119         gboolean source_tiles_enabled;
 120         gint source_tiles_cache_size;
 121
 122         GList *source_tiles;    /* list of active source tiles */
 123         gint source_tile_width;
 124         gint source_tile_height;
 125
 126         PixbufRendererTileRequestFunc func_tile_request;
 127         PixbufRendererTileDisposeFunc func_tile_dispose;
 128
 129         gpointer func_tile_data;
 130
 131         PixbufRendererPostProcessFunc func_post_process;
 132         gpointer post_process_user_data;
 133         gint post_process_slow;
 134
 135         gboolean delay_flip;
 136         gboolean loading;
 137         gboolean complete;
 138         gboolean debug_updated; /* debug only */
 139
 140         gint scroller_id;
 141         gint scroller_overlay;
 142         gint scroller_x;
 143         gint scroller_y;
 144         gint scroller_xpos;
 145         gint scroller_ypos;
 146         gint scroller_xinc;
 147         gint scroller_yinc;
 148
 149         GList *overlay_list;
 150         GdkPixmap *overlay_buffer;
 151
 152         GdkPixbuf *spare_tile;
 153
 154         gint orientation;
 155 };
 156
 157 struct _PixbufRendererClass
 158 {
 159         GtkEventBoxClass parent_class;
 160
 161         void (*zoom)(PixbufRenderer *pr, gdouble zoom);
 162         void (*clicked)(PixbufRenderer *pr, GdkEventButton *event);
 163         void (*scroll_notify)(PixbufRenderer *pr);
 164
 165         void (*render_complete)(PixbufRenderer *pr);
 166         void (*drag)(PixbufRenderer *pr, GdkEventButton *event);
 167 };
 168
 169
 170 GType pixbuf_renderer_get_type (void);
 171
 172 PixbufRenderer *pixbuf_renderer_new(void);
 173
 174 void pixbuf_renderer_set_parent(PixbufRenderer *pr, GtkWindow *window);
 175 GtkWindow *pixbuf_renderer_get_parent(PixbufRenderer *pr);
 176
 177 /* display a pixbuf */
 178
 179 void pixbuf_renderer_set_pixbuf(PixbufRenderer *pr, GdkPixbuf *pixbuf, gdouble zoom);
 180 GdkPixbuf *pixbuf_renderer_get_pixbuf(PixbufRenderer *pr);
 181
 182 void pixbuf_renderer_set_orientation(PixbufRenderer *pr, gint orientation);
 183 gint pixbuf_renderer_get_orientation(PixbufRenderer *pr);
 184
 185 void pixbuf_renderer_set_post_process_func(PixbufRenderer *pr, PixbufRendererPostProcessFunc func, gpointer user_data, gint slow);
 186
 187 /* display an on-request array of pixbuf tiles */
 188
 189 void pixbuf_renderer_set_tiles(PixbufRenderer *pr, gint width, gint height,
 190                                gint tile_width, gint tile_height, gint cache_size,
 191                                PixbufRendererTileRequestFunc func_request,
 192                                PixbufRendererTileDisposeFunc func_dispose,
 193                                gpointer user_data,
 194                                gdouble zoom);
 195 void pixbuf_renderer_set_tiles_size(PixbufRenderer *pr, gint width, gint height);
 196 gint pixbuf_renderer_get_tiles(PixbufRenderer *pr);
 197
 198 /* move image data from source to pr, source is then set to NULL image */
 199
 200 void pixbuf_renderer_move(PixbufRenderer *pr, PixbufRenderer *source);
 201
 202 /* update region of existing image */
 203
 204 void pixbuf_renderer_area_changed(PixbufRenderer *pr, gint x, gint y, gint width, gint height);
 205
 206 /* scrolling */
 207
 208 void pixbuf_renderer_scroll(PixbufRenderer *pr, gint x, gint y);
 209 void pixbuf_renderer_scroll_to_point(PixbufRenderer *pr, gint x, gint y,
 210                                      gdouble x_align, gdouble y_align);
 211
 212 void pixbuf_renderer_get_scroll_center(PixbufRenderer *pr, gdouble *x, gdouble *y);
 213 void pixbuf_renderer_set_scroll_center(PixbufRenderer *pr, gdouble x, gdouble y);
 214 /* zoom */
 215
 216 void pixbuf_renderer_zoom_adjust(PixbufRenderer *pr, gdouble increment);
 217 void pixbuf_renderer_zoom_adjust_at_point(PixbufRenderer *pr, gdouble increment, gint x, gint y);
 218
 219 void pixbuf_renderer_zoom_set(PixbufRenderer *pr, gdouble zoom);
 220 gdouble pixbuf_renderer_zoom_get(PixbufRenderer *pr);
 221 gdouble pixbuf_renderer_zoom_get_scale(PixbufRenderer *pr);
 222
 223 void pixbuf_renderer_zoom_set_limits(PixbufRenderer *pr, gdouble min, gdouble max);
 224
 225 /* sizes */
 226
 227 gint pixbuf_renderer_get_image_size(PixbufRenderer *pr, gint *width, gint *height);
 228 gint pixbuf_renderer_get_scaled_size(PixbufRenderer *pr, gint *width, gint *height);
 229
 230 /* region of image in pixel coordinates */
 231 gint pixbuf_renderer_get_visible_rect(PixbufRenderer *pr, GdkRectangle *rect);
 232
 233 /* actual size of the PixbufRenderer window minus borders,
 234  * x and y are the scroll offset and include zoom factor.
 235  */
 236 gint pixbuf_renderer_get_virtual_rect(PixbufRenderer *pr, GdkRectangle *rect);
 237
 238 /* background color */
 239 void pixbuf_renderer_set_color(PixbufRenderer *pr, GdkColor *color);
 240
 241 /* overlay */
 242 typedef enum {
 243         OVL_NORMAL      = 0,
 244         OVL_RELATIVE    = 1 << 0, /* x,y coordinates are relative, negative values start bottom right */
 245         /* OVL_HIDE_ON_SCROLL = 1 << 1*/ /* hide temporarily when scrolling (not yet implemented) */
 246 } OverlayRendererFlags;
 247
 248 gint pixbuf_renderer_overlay_add(PixbufRenderer *pr, GdkPixbuf *pixbuf, gint x, gint y,
 249                                  OverlayRendererFlags flags);
 250 void pixbuf_renderer_overlay_set(PixbufRenderer *pr, gint id, GdkPixbuf *pixbuf, gint x, gint y);
 251 gint pixbuf_renderer_overlay_get(PixbufRenderer *pr, gint id, GdkPixbuf **pixbuf, gint *x, gint *y);
 252 void pixbuf_renderer_overlay_remove(PixbufRenderer *pr, gint id);
 253
 254
 255 #endif