src/pixbuf-renderer.h

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