gegl-tile-backend.h 5.63 KB
Newer Older
1
2
3
4
5
/* 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
6
 * version 3 of the License, or (at your option) any later version.
7
8
9
10
11
12
13
 *
 * 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
14
 * License along with GEGL; if not, see <https://www.gnu.org/licenses/>.
15
 *
16
 * Copyright 2006, 2007 Øyvind Kolås <pippin@gimp.org>
17
18
 */

19
20
21
#ifndef __GEGL_TILE_BACKEND_H__
#define __GEGL_TILE_BACKEND_H__

22
#include "gegl-tile-source.h"
23

24
25
26
27
28
/***
 * GeglTileBackend is a simple basic GeglTileSource that provide and store tiles. This classe is
 * generic and is specialized in subclasses for different kind of storage.
 */

29
30
31
32
33
34
35
G_BEGIN_DECLS

#define GEGL_TYPE_TILE_BACKEND            (gegl_tile_backend_get_type ())
#define GEGL_TILE_BACKEND(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GEGL_TYPE_TILE_BACKEND, GeglTileBackend))
#define GEGL_TILE_BACKEND_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass),  GEGL_TYPE_TILE_BACKEND, GeglTileBackendClass))
#define GEGL_IS_TILE_BACKEND(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GEGL_TYPE_TILE_BACKEND))
#define GEGL_IS_TILE_BACKEND_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass),  GEGL_TYPE_TILE_BACKEND))
36
#define GEGL_TILE_BACKEND_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),  GEGL_TYPE_TILE_BACKEND, GeglTileBackendClass))
37

38
39
40
typedef struct _GeglTileBackendClass   GeglTileBackendClass;
typedef struct _GeglTileBackendPrivate GeglTileBackendPrivate;

41
42
struct _GeglTileBackend
{
43
44
  GeglTileSource          parent_instance;
  GeglTileBackendPrivate *priv;
45
46
47
48
};

struct _GeglTileBackendClass
{
49
  GeglTileSourceClass parent_class;
50
  gpointer            padding[4];
51
52
};

53
54
55
56
57
58
/**
 * gegl_tile_backend_get_tile_size:
 * @tile_backend: a #GeglTileBackend
 *
 * Return value: the size in bytes for a tile from this backend
 */
59
gint        gegl_tile_backend_get_tile_size (GeglTileBackend *tile_backend);
60

61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/**
 * gegl_tile_backend_get_tile_width:
 * @tile_backend: a #GeglTileBackend
 *
 * Return value: the width of tile from this backend
 */
gint        gegl_tile_backend_get_tile_width (GeglTileBackend *tile_backend);

/**
 * gegl_tile_backend_get_tile_height:
 * @tile_backend: a #GeglTileBackend
 *
 * Return value: the height of tile from this backend
 */
gint        gegl_tile_backend_get_tile_height (GeglTileBackend *tile_backend);

77
/**
78
 * gegl_tile_backend_get_format: (skip)
79
80
81
82
83
84
 * @tile_backend: a #GeglTileBackend
 *
 * Gets pixel format of @tile_backend
 *
 * Return value: (transfer none): the #Babl format
 */
85
const Babl *gegl_tile_backend_get_format    (GeglTileBackend *tile_backend);
86

87
88
89
90
91
92
93
94
95
/**
 * gegl_tile_backend_peek_storage:
 * @tile_backend: a #GeglTileBackend
 *
 * Gets a pointer to the GeglTileStorage that uses the backend
 *
 * Return value: (transfer none): the #GeglTileStorage
 */
GeglTileSource *gegl_tile_backend_peek_storage  (GeglTileBackend *tile_backend);
96

97
98
99
100
101
102
103
104
/**
 * gegl_tile_backend_set_extent:
 * @tile_backend: a #GeglTileBackend
 * @rectangle: the new extent
 *
 * Specify the extent of the backend, can be used to pre-prime the
 * backend with the width/height information when constructing proxy
 * GeglBuffers to interact with other systems
105
 */
106
107
108
void  gegl_tile_backend_set_extent    (GeglTileBackend     *tile_backend,
                                       const GeglRectangle *rectangle);

109

110
111
112
113
/**
 * gegl_tile_backend_get_extent: (skip)
 * @tile_backend: a #GeglTileBackend
 */
114
GeglRectangle gegl_tile_backend_get_extent (GeglTileBackend *tile_backend);
115

116
117
118
119
120
121
122
123
124
125
126
127
128
/**
 * gegl_tile_backend_set_flush_on_destroy:
 * @tile_backend: a #GeglTileBackend
 * @flush_on_destroy: true if the backend needs to be flushed
 *
 * Control whether cached data will be written to the backend before it
 * is destroyed. If false unwritten data will be discarded.
 */
void gegl_tile_backend_set_flush_on_destroy (GeglTileBackend *tile_backend,
                                             gboolean         flush_on_destroy);

gboolean gegl_tile_backend_get_flush_on_destroy (GeglTileBackend *tile_backend);

129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/**
 * gegl_tile_backend_command:
 * @backend: a #GeglTileBackend
 * @command: the tile command
 * @x: x coordinate
 * @y: y coordinate
 * @z: tile zoom level
 * @data: user data
 *
 * The default tile-backend command handler.  Tile backends should forward
 * commands they don't handle themselves to this function.
 *
 * Returns: Command result.
 */
gpointer gegl_tile_backend_command (GeglTileBackend *backend,
                                    GeglTileCommand  command,
                                    gint             x,
                                    gint             y,
                                    gint             z,
                                    gpointer         data);

150
151
GType gegl_tile_backend_get_type (void) G_GNUC_CONST;

152
153
154
155
156
157
158
159
160
/**
 * gegl_tile_backend_unlink_swap:
 * @path: the path where the gegl tile backend has swapped.
 *
 * Delete a swap file from disk. This must be used by tile backends which may
 * swap to disk under certain circonstances.
 *
 * For safety, this function will check that the swap file is in the swap
 * directory before deletion but it won't perform any other check.
161
162
163
 *
 * Deprecated: 0.4.14: This function is not compatible with a dynamically-
 * changing swap path. Use gegl_buffer_swap_remove_file() instead.
164
 */
165
G_DEPRECATED_FOR (gegl_buffer_swap_remove_file)
166
167
void gegl_tile_backend_unlink_swap (gchar *path);

168
169
170
G_END_DECLS

#endif