src/pixbuf-renderer.h

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