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