/usr/share/doc/libgegl-dev/gegl-operation.h.html is in libgegl-doc 0.3.30-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | <!DOCTYPE html PUBLIC "-//IETF//DTD HTML 2.0//EN">
<HTML>
<HEAD>
<TITLE>Enscript Output</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#1F00FF" ALINK="#FF0000" VLINK="#9900DD">
<A NAME="top">
<A NAME="file1">
<H1>../gegl/operation/gegl-operation.h</H1>
<PRE>
<I><FONT COLOR="#B22222">/* This file is part of GEGL
*
* GEGL 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.
*
* GEGL 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 GEGL; if not, see <http://www.gnu.org/licenses/>.
*
* Copyright 2003 Calvin Williamson
* 2005-2008 Øyvind Kolås
*/</FONT></I>
#<B><FONT COLOR="#5F9EA0">ifndef</FONT></B> <FONT COLOR="#B8860B">__GEGL_OPERATION_H__</FONT>
#<B><FONT COLOR="#5F9EA0">define</FONT></B> <FONT COLOR="#B8860B">__GEGL_OPERATION_H__</FONT>
#<B><FONT COLOR="#5F9EA0">include</FONT></B> <B><FONT COLOR="#BC8F8F"><glib-object.h></FONT></B>
#<B><FONT COLOR="#5F9EA0">include</FONT></B> <B><FONT COLOR="#BC8F8F"><babl/babl.h></FONT></B>
#<B><FONT COLOR="#5F9EA0">include</FONT></B> <B><FONT COLOR="#BC8F8F">"gegl-buffer.h"</FONT></B>
#<B><FONT COLOR="#5F9EA0">include</FONT></B> <B><FONT COLOR="#BC8F8F">"opencl/gegl-cl.h"</FONT></B>
G_BEGIN_DECLS
#<B><FONT COLOR="#5F9EA0">define</FONT></B> <B><FONT COLOR="#0000FF">GEGL_OPERATION_CLASS</FONT></B>(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GEGL_TYPE_OPERATION, GeglOperationClass))
#<B><FONT COLOR="#5F9EA0">define</FONT></B> <B><FONT COLOR="#0000FF">GEGL_IS_OPERATION_CLASS</FONT></B>(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GEGL_TYPE_OPERATION))
#<B><FONT COLOR="#5F9EA0">define</FONT></B> <B><FONT COLOR="#0000FF">GEGL_OPERATION_GET_CLASS</FONT></B>(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GEGL_TYPE_OPERATION, GeglOperationClass))
<I><FONT COLOR="#B22222">/* The rest is in gegl-types.h */</FONT></I>
<B><FONT COLOR="#228B22">typedef</FONT></B> <B><FONT COLOR="#228B22">struct</FONT></B> _GeglOperationClass GeglOperationClass;
<B><FONT COLOR="#228B22">struct</FONT></B> _GeglOperation
{
GObject parent_instance;
<I><FONT COLOR="#B22222">/*< private >*/</FONT></I>
GeglNode *node; <I><FONT COLOR="#B22222">/* the node that this operation object is communicated
with through */</FONT></I>
};
<I><FONT COLOR="#B22222">/***
* GeglOperation:
*
* All the image processing code in GEGL is implemented as GeglOperations,
* GEGL operations are implemented as GObject with a convenience API called
* chanting that abstracts away the boiler plater needed to generate introspectable
* named properties of different types.
*
* Most types of operations like: filters, composers, sources, sinks, point
* operations, compositing operations, and spatial operations with fixed
* neighbourhoods. These base classes build on top of the GeglOperationsClass:
*
* See <a href='gegl-plugin.h.html'>gegl-plugin.h</a> for details.
*/</FONT></I>
<I><FONT COLOR="#B22222">/* the level at which is being operated is stored in the context,
*/</FONT></I>
<B><FONT COLOR="#228B22">struct</FONT></B> _GeglOperationClass
{
GObjectClass parent_class;
<B><FONT COLOR="#228B22">const</FONT></B> gchar *name; <I><FONT COLOR="#B22222">/* name(string) used to create/identify
this type of operation in GEGL, must be
set through gegl_operation_class_set_key(s) */</FONT></I>
<B><FONT COLOR="#228B22">const</FONT></B> gchar *compat_name; <I><FONT COLOR="#B22222">/* allows specifying an alias that the op is
also known as, must be set through
gegl_operation_class_set_key(s) */</FONT></I>
GHashTable *keys; <I><FONT COLOR="#B22222">/* hashtable used for storing meta-data about an op */</FONT></I>
guint no_cache :1; <I><FONT COLOR="#B22222">/* do not create a cache for this operation */</FONT></I>
guint opencl_support:1;
guint want_in_place:1; <I><FONT COLOR="#B22222">/* if possible to use for in-place
processing, making output buffer =
input buffer.
*/</FONT></I>
guint threaded:1; <I><FONT COLOR="#B22222">/* do threaded processing if possible,
some base classes have special logic
to accelerate rendering; this allows opting in/out
in the sub-classes of these.
*/</FONT></I>
guint64 bit_pad:60;
<I><FONT COLOR="#B22222">/* attach this operation with a GeglNode, override this if you are creating a
* GeglGraph, it is already defined for Filters/Sources/Composers.
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> (*attach) (GeglOperation *operation);
<I><FONT COLOR="#B22222">/* Initialize the operation, prepare is called when all properties are
* known but before processing will begin. Prepare will be invoked one
* or multiple times prior to processing.
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> (*prepare) (GeglOperation *operation);
<I><FONT COLOR="#B22222">/* The bounding rectangle for the data that is defined by this op.
*/</FONT></I>
GeglRectangle (*get_bounding_box) (GeglOperation *operation);
<I><FONT COLOR="#B22222">/* The output region that is made invalid by a change in the input_roi
* rectangle of the buffer passed in on the pad input_pad. Defaults to
* returning the input_roi.
*/</FONT></I>
GeglRectangle (*get_invalidated_by_change) (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *input_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *input_roi);
<I><FONT COLOR="#B22222">/* The rectangle needed to be correctly computed in a buffer on the named
* input_pad, for a given region of interest. Defaults to return the
* output_roi.
*/</FONT></I>
GeglRectangle (*get_required_for_output) (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *input_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *output_roi);
<I><FONT COLOR="#B22222">/* The rectangular area that should be processed in one go, by default if not
* defined the output roi would be returned. This is useful for file loaders
* and operations like contrast stretching which is a point operation but we
* need the parameters as the minimum/maximum values in the entire input buffer.
*/</FONT></I>
GeglRectangle (*get_cached_region) (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *output_roi);
<I><FONT COLOR="#B22222">/* Compute the rectangular region output roi for the specified output_pad.
* For operations that are sinks (have no output pads), roi is the rectangle
* to consume and the output_pad argument is to be ignored.
*/</FONT></I>
gboolean (*process) (GeglOperation *operation,
GeglOperationContext *context,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *output_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi,
gint level);
<I><FONT COLOR="#B22222">/* The node providing data for a specific location within the operations
* output. The node is responsible for delegating blame to one of it's
* inputs taking into account opacity and similar issues.
*
* XXX: What is GeglNode doing in this part of the API?,
* perhaps we should only point out which pad the data is coming from?
*/</FONT></I>
GeglNode* (*detect) (GeglOperation *operation,
gint x,
gint y);
GeglClRunData *cl_data;
gpointer pad[9];
};
GeglRectangle gegl_operation_get_invalidated_by_change
(GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *input_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi);
GeglRectangle <B><FONT COLOR="#0000FF">gegl_operation_get_bounding_box</FONT></B> (GeglOperation *operation);
<I><FONT COLOR="#B22222">/* retrieves the bounding box of an input pad */</FONT></I>
GeglRectangle * gegl_operation_source_get_bounding_box
(GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *pad_name);
GeglRectangle gegl_operation_get_cached_region
(GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi);
GeglRectangle gegl_operation_get_required_for_output
(GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *input_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi);
GeglNode *<B><FONT COLOR="#0000FF">gegl_operation_detect</FONT></B> (GeglOperation *operation,
gint x,
gint y);
<I><FONT COLOR="#B22222">/* virtual method invokers that change behavior based on the roi being computed,
* needs a context_id being based that is used for storing context data.
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_attach</FONT></B> (GeglOperation *operation,
GeglNode *node);
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_prepare</FONT></B> (GeglOperation *operation);
gboolean <B><FONT COLOR="#0000FF">gegl_operation_process</FONT></B> (GeglOperation *operation,
GeglOperationContext *context,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *output_pad,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi,
gint level);
<I><FONT COLOR="#B22222">/* create a pad for a specified property for this operation, this method is
* to be called from the attach method of operations, most operations do not
* have to care about this since a super class like filter, sink, source or
* composer already does so.
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_create_pad</FONT></B> (GeglOperation *operation,
GParamSpec *param_spec);
<I><FONT COLOR="#B22222">/* specify the bablformat for a pad on this operation (XXX: document when
* this is legal, at the moment, only used internally in some ops,. but might
* turn into a global mechanism) */</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_set_format</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *pad_name,
<B><FONT COLOR="#228B22">const</FONT></B> Babl *format);
<B><FONT COLOR="#228B22">const</FONT></B> Babl * <B><FONT COLOR="#0000FF">gegl_operation_get_format</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *pad_name);
<B><FONT COLOR="#228B22">const</FONT></B> gchar * <B><FONT COLOR="#0000FF">gegl_operation_get_name</FONT></B> (GeglOperation *operation);
<I><FONT COLOR="#B22222">/* checks the incoming Babl format on a given pad, can be used in the prepare
* stage to make format dependent decisions
*/</FONT></I>
<B><FONT COLOR="#228B22">const</FONT></B> Babl * <B><FONT COLOR="#0000FF">gegl_operation_get_source_format</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *padname);
<I><FONT COLOR="#B22222">/* retrieves the node providing data to a named input pad */</FONT></I>
GeglNode * <B><FONT COLOR="#0000FF">gegl_operation_get_source_node</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *pad_name);
<I><FONT COLOR="#B22222">/* API to change */</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_class_set_key</FONT></B> (GeglOperationClass *klass,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_name,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_value);
<B><FONT COLOR="#228B22">const</FONT></B> gchar * <B><FONT COLOR="#0000FF">gegl_operation_class_get_key</FONT></B> (GeglOperationClass *operation_class,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_name);
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_class_set_keys</FONT></B> (GeglOperationClass *klass,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_name,
...);
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_set_key</FONT></B> (<B><FONT COLOR="#228B22">const</FONT></B> gchar *operation_type,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_name,
<B><FONT COLOR="#228B22">const</FONT></B> gchar *key_value);
gboolean <B><FONT COLOR="#0000FF">gegl_operation_use_opencl</FONT></B> (<B><FONT COLOR="#228B22">const</FONT></B> GeglOperation *operation);
gboolean
<B><FONT COLOR="#0000FF">gegl_operation_use_threading</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi);
<I><FONT COLOR="#B22222">/* Invalidate a specific rectangle, indicating the any computation depending
* on this roi is now invalid.
*
* @roi : the region to blank or NULL for the nodes current have_rect
* @clear_cache: whether any present caches should be zeroed out
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_invalidate</FONT></B> (GeglOperation *operation,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *roi,
gboolean clear_cache);
gboolean <B><FONT COLOR="#0000FF">gegl_operation_cl_set_kernel_args</FONT></B> (GeglOperation *operation,
cl_kernel kernel,
gint *p,
cl_int *err);
<I><FONT COLOR="#B22222">/* internal utility functions used by gegl, these should not be used
* externally */</FONT></I>
gboolean <B><FONT COLOR="#0000FF">gegl_can_do_inplace_processing</FONT></B> (GeglOperation *operation,
GeglBuffer *input,
<B><FONT COLOR="#228B22">const</FONT></B> GeglRectangle *result);
<I><FONT COLOR="#B22222">/**
* gegl_object_set_has_forked: (skip)
* @object: Object to mark
*
* Mark an object as "forked", indicating that it should not be modified
* in place by gegl operations. This should only be used inside of the
* process method of a GeglOperation subclass.
*/</FONT></I>
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_object_set_has_forked</FONT></B> (GObject *object);
<I><FONT COLOR="#B22222">/**
* gegl_object_get_has_forked: (skip)
* @object: Object to check
*
* Returns TRUE if the object has been marked as "forked".
*/</FONT></I>
gboolean <B><FONT COLOR="#0000FF">gegl_object_get_has_forked</FONT></B> (GObject *object);
<I><FONT COLOR="#B22222">/**
* gegl_temp_buffer:
*
* Returns a singleton scratch buffer for use with multi-threaded processing
* dispatch.
*/</FONT></I>
guchar *<B><FONT COLOR="#0000FF">gegl_temp_buffer</FONT></B> (<B><FONT COLOR="#228B22">int</FONT></B> no, <B><FONT COLOR="#228B22">int</FONT></B> min_size);
<B><FONT COLOR="#228B22">void</FONT></B> <B><FONT COLOR="#0000FF">gegl_operation_progress</FONT></B> (GeglOperation *operation, gdouble progress, gchar *message);
G_END_DECLS
<I><FONT COLOR="#B22222">/***
*/</FONT></I>
#<B><FONT COLOR="#5F9EA0">endif</FONT></B> <I><FONT COLOR="#B22222">/* __GEGL_OPERATION_H__ */</FONT></I>
</PRE>
<HR>
<ADDRESS>Generated by <A HREF="http://www.iki.fi/~mtr/genscript/">GNU Enscript 1.6.5.90</A>.</ADDRESS>
</BODY>
</HTML>
|