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