gimp/app/base/temp-buf.h

/* The GIMP -- an image manipulation program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef __TEMP_BUF_H__
#define __TEMP_BUF_H__


struct _TempBuf
{
  guint    width;
  guint    height;
  gint     x, y;        /*  origin of data source                          */

  guint    bytes : 4;   /*  the necessary info                             */
  guint    swapped : 1; /*  flag indicating whether buf is cached to disk  */
  gchar   *filename;    /*  filename of cached information                 */

  guchar  *data;        /*  The data buffer. Do never access this field
                            directly, use temp_buf_data() instead !!       */
};


/*  The temp buffer functions  */

TempBuf * temp_buf_new        (guint          width,
			       guint          height,
			       guint          bytes,
			       gint           x,
			       gint           y,
			       guchar        *col);
TempBuf * temp_buf_new_check  (guint          width,
			       guint          height,
			       GimpCheckType  check_type,
			       GimpCheckSize  check_size);
TempBuf * temp_buf_copy       (TempBuf       *src,
			       TempBuf       *dest);
TempBuf * temp_buf_resize     (TempBuf       *buf,
			       guint          bytes,
			       gint           x,
			       gint           y,
			       guint          width,
			       guint          height);
TempBuf * temp_buf_scale      (TempBuf       *buf,
			       guint          width,
			       guint          height);
TempBuf * temp_buf_copy_area  (TempBuf       *src,
			       TempBuf       *dest,
			       gint           x,
			       gint           y,
			       guint          width,
			       guint          height,
			       gint           dest_x,
			       gint           dest_y);
void      temp_buf_free       (TempBuf       *buf);
guchar  * temp_buf_data       (TempBuf       *buf);
guchar  * temp_buf_data_clear (TempBuf       *buf);

/* The mask buffer functions  */

MaskBuf * mask_buf_new        (guint          width,
			       guint          height);
void      mask_buf_free       (MaskBuf       *mask_buf);
guchar  * mask_buf_data       (MaskBuf       *mask_buf);
guchar  * mask_buf_data_clear (MaskBuf       *mask_buf);

/*  The disk caching functions  */

void      temp_buf_swap       (TempBuf       *buf);
void      temp_buf_unswap     (TempBuf       *buf);
void      temp_buf_swap_free  (TempBuf       *buf);


/*  Called by app_procs:exit() to free up the cached undo buffer  */

void      swapping_free       (void);


#endif  /*  __TEMP_BUF_H__  */