Commit b5740179 authored by Michael Muré's avatar Michael Muré

add documentation on the header of each subclasses of GeglOperation

parent 465fe425
......@@ -16,6 +16,12 @@
* Copyright 2007 Øyvind Kolås
*/
/* GeglOperationAreaFilter
* The AreaFilter base class allows defining operations where the output data depends on a neighbourhood
* with an input window that extends beyond the output window, the information about needed extra pixels
* in different directions should be set up in the prepare callback for the operation.
*/
#ifndef __GEGL_OPERATION_AREA_FILTER_H__
#define __GEGL_OPERATION_AREA_FILTER_H__
......
......@@ -16,6 +16,11 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationComposer
* Composer operations are operations that take two inputs named input and aux and write
* their output to the output pad output
*/
#ifndef __GEGL_OPERATION_COMPOSER_H__
#define __GEGL_OPERATION_COMPOSER_H__
......
......@@ -16,6 +16,10 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationFilter:
* The filter base class sets up GeglBuffers for input and output pads
*/
#ifndef __GEGL_OPERATION_FILTER_H__
#define __GEGL_OPERATION_FILTER_H__
......
......@@ -16,6 +16,12 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationMeta
* Used for GEGL operations that are implemented as a sub-graph, at the moment
* these are defined as C files but should in the future be possible to declare
* as XML instead.
*/
#ifndef __GEGL_OPERATION_META_H__
#define __GEGL_OPERATION_META_H__
......
......@@ -16,6 +16,11 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationPointComposer
* A baseclass for composer functions where the output pixels' values depends only on
* the values of the single corresponding input and aux pixels.
*/
#ifndef __GEGL_OPERATION_POINT_COMPOSER_H__
#define __GEGL_OPERATION_POINT_COMPOSER_H__
......
......@@ -16,6 +16,13 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationPointFilter
* The point-filter base class is for filters where an output pixel only depends on the color and alpha values
* of the corresponding input pixel. This allows you to do the processing on linear buffers, in the future
* versions of GEGL operations implemented using the point-filter will get speed increases due to more
* intelligent processing possible in the point filter class
*/
#ifndef __GEGL_OPERATION_POINT_FILTER_H__
#define __GEGL_OPERATION_POINT_FILTER_H__
......
......@@ -16,6 +16,11 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationSink
* An operation that consumes a GeglBuffer, used for filewriters, display
* (for the sdl display node)
*/
#ifndef __GEGL_OPERATION_SINK_H__
#define __GEGL_OPERATION_SINK_H__
......
......@@ -16,6 +16,11 @@
* Copyright 2006 Øyvind Kolås
*/
/* GeglOperationSource
* Operations used as render sources or file loaders, the process method receives a
* GeglBuffer to write it’s output into
*/
#ifndef __GEGL_OPERATION_SOURCE_H__
#define __GEGL_OPERATION_SOURCE_H__
......
......@@ -16,6 +16,12 @@
* Copyright 2008 Øyvind Kolås
*/
/* GeglOperationTemporal
* Base class for operations that want access to previous frames in a video sequence,
* it contains API to configure the amounts of frames to store as well as getting a
* GeglBuffer pointing to any of the previously stored frames.
*/
#ifndef __GEGL_OPERATION_TEMPORAL_H__
#define __GEGL_OPERATION_TEMPORAL_H__
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment