/* GIMP - The GNU 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 3 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef __PIXEL_SURROUND_H__
#define __PIXEL_SURROUND_H__


/* PixelSurround describes a (read-only)
 *  region around a pixel in a tile manager
 */

typedef enum
{
  PIXEL_SURROUND_SMEAR,
  PIXEL_SURROUND_BACKGROUND
} PixelSurroundMode;


PixelSurround * pixel_surround_new      (TileManager       *tiles,
                                         gint               width,
                                         gint               height,
                                         PixelSurroundMode  mode);
void            pixel_surround_set_bg   (PixelSurround     *surround,
                                         const guchar      *bg);

/* return a pointer to a buffer which contains all the surrounding pixels
 * strategy: if we are in the middle of a tile, use the tile storage
 * otherwise just copy into our own malloced buffer and return that
 */
const guchar  * pixel_surround_lock     (PixelSurround     *surround,
                                         gint               x,
                                         gint               y,
                                         gint              *rowstride);

void            pixel_surround_release  (PixelSurround     *surround);
void            pixel_surround_destroy  (PixelSurround     *surround);


#endif /* __PIXEL_SURROUND_H__ */