/* This file is part of GEGL.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see .
*
* Copyright 2006,2007 Øyvind Kolås
*/
#ifndef __GEGL_TILE_HANDLER_H__
#define __GEGL_TILE_HANDLER_H__
#include "gegl-tile-source.h"
/***
* GeglTileHandler define the chain pattern that allow to stack GeglTileSource classes on
* top of each others, each doing different task in response to command given (see GeglTileSource).
*
* A classical GeglBuffer is a stack of subclasses of GeglTileHandler with a GeglTileBackend on
* the bottom. This architecture is designed to be modular and flexible on purpose, even allowing
* to use a GeglBuffer as a source for another GeglBuffer.
*/
G_BEGIN_DECLS
#define GEGL_TYPE_TILE_HANDLER (gegl_tile_handler_get_type ())
#define GEGL_TILE_HANDLER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEGL_TYPE_TILE_HANDLER, GeglTileHandler))
#define GEGL_TILE_HANDLER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GEGL_TYPE_TILE_HANDLER, GeglTileHandlerClass))
#define GEGL_IS_TILE_HANDLER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEGL_TYPE_TILE_HANDLER))
#define GEGL_IS_TILE_HANDLER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GEGL_TYPE_TILE_HANDLER))
#define GEGL_TILE_HANDLER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GEGL_TYPE_TILE_HANDLER, GeglTileHandlerClass))
typedef struct _GeglTileHandlerClass GeglTileHandlerClass;
typedef struct _GeglTileHandlerPrivate GeglTileHandlerPrivate;
struct _GeglTileHandler
{
GeglTileSource parent_instance;
GeglTileSource *source; /* The source of the data, which we can rely
on if our command handler doesn't handle
a command, this is typically done with
gegl_tile_handler_source_command passing
ourself as the first parameter. */
GeglTileHandlerPrivate *priv;
};
struct _GeglTileHandlerClass
{
GeglTileSourceClass parent_class;
};
GType gegl_tile_handler_get_type (void) G_GNUC_CONST;
void gegl_tile_handler_set_source (GeglTileHandler *handler,
GeglTileSource *source);
#define gegl_tile_handler_get_source(handler) (((GeglTileHandler*)handler)->source)
#define gegl_tile_handler_source_command(handler,command,x,y,z,data) (gegl_tile_handler_get_source(handler)?gegl_tile_source_command(gegl_tile_handler_get_source(handler), command, x, y, z, data):NULL)
/**
* gegl_tile_handler_create_tile: (skip)
* @handler: a #GeglTileHandler
* @x: The tile space x coordinate for the tile
* @y: The tile space y coordinate for the tile
* @z: The tile space z coordinate for the tile
*
* Create a new tile associated with this tile handler.
*
* Return value: the new tile
*/
GeglTile * gegl_tile_handler_create_tile (GeglTileHandler *handler,
gint x,
gint y,
gint z);
/**
* gegl_tile_handler_get_tile: (skip)
* @handler: a #GeglTileHandler
* @x: The tile space x coordinate for the tile
* @y: The tile space y coordinate for the tile
* @z: The tile space z coordinate for the tile
* @preserve_data: whether existing tile data should be preserved
*
* Fetches the tile at the given coordinates from @handler. If the tile
* doesn't exist, creates a new tile associated with this tile handler.
*
* If @preserve_data is FALSE, the tile contents are unspecified.
*
* Return value: the tile
*/
GeglTile * gegl_tile_handler_get_tile (GeglTileHandler *handler,
gint x,
gint y,
gint z,
gboolean preserve_data);
/**
* gegl_tile_handler_get_source_tile: (skip)
* @handler: a #GeglTileHandler
* @x: The tile space x coordinate for the tile
* @y: The tile space y coordinate for the tile
* @z: The tile space z coordinate for the tile
* @preserve_data: whether existing tile data should be preserved
*
* Fetches the tile at the given coordinates from @handler source. If the tile
* doesn't exist, or if @handler doesn't have a source, creates a new tile
* associated with this tile handler.
*
* If @preserve_data is FALSE, the tile contents are unspecified.
*
* Return value: the tile
*/
GeglTile * gegl_tile_handler_get_source_tile (GeglTileHandler *handler,
gint x,
gint y,
gint z,
gboolean preserve_data);
/**
* gegl_tile_handler_dup_tile: (skip)
* @handler: a #GeglTileHandler
* @tile: the #GeglTile to copy
* @x: The tile space x coordinate for the tile
* @y: The tile space y coordinate for the tile
* @z: The tile space z coordinate for the tile
*
* Create a duplicate of @tile, associated with this tile handler.
*
* Return value: the new tile
*/
GeglTile * gegl_tile_handler_dup_tile (GeglTileHandler *handler,
GeglTile *tile,
gint x,
gint y,
gint z);
void gegl_tile_handler_damage_tile (GeglTileHandler *handler,
gint x,
gint y,
gint z,
guint64 damage);
void gegl_tile_handler_damage_rect (GeglTileHandler *handler,
const GeglRectangle *rect);
void gegl_tile_handler_lock (GeglTileHandler *handler);
void gegl_tile_handler_unlock (GeglTileHandler *handler);
G_END_DECLS
#endif