gegl r2004 - trunk/docs
- From: ok svn gnome org
- To: svn-commits-list gnome org
- Subject: gegl r2004 - trunk/docs
- Date: Tue, 12 Feb 2008 01:09:07 +0000 (GMT)
Author: ok
Date: Tue Feb 12 01:09:06 2008
New Revision: 2004
URL: http://svn.gnome.org/viewvc/gegl?rev=2004&view=rev
Log:
* Makefile.am: made index.html depend on gegl.css (since asciidoc
embeds it).
* gegl.css: modified to work around some seemsing glitches in xhtml
generated by ascii doc.
* index-static.txt.in: some reordering and rewrites.
Modified:
trunk/docs/ChangeLog
trunk/docs/Makefile.am
trunk/docs/gegl.css
trunk/docs/index-static.txt.in
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Tue Feb 12 01:09:06 2008
@@ -73,6 +73,7 @@
index.html: index-static.txt \
$(top_srcdir)/AUTHORS \
+ gegl.css \
$(top_srcdir)/NEWS \
$(top_builddir)/bin/gegl \
Makefile.am \
Modified: trunk/docs/gegl.css
==============================================================================
--- trunk/docs/gegl.css (original)
+++ trunk/docs/gegl.css Tue Feb 12 01:09:06 2008
@@ -1,4 +1,6 @@
-
+ li>p {
+ display: inline;
+ }
body {
margin-left: 12.5em;
margin-right: 2em;
Modified: trunk/docs/index-static.txt.in
==============================================================================
--- trunk/docs/index-static.txt.in (original)
+++ trunk/docs/index-static.txt.in Tue Feb 12 01:09:06 2008
@@ -9,7 +9,6 @@
for a new compositing and processing core. This core is being designed to have
minimal dependencies. and a simple well defined API.
-http://svn.gnome.org/viewvc/gegl/trunk/ChangeLog?view=markup[changes]|http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO[bugs]|http://blog.gmane.org/gmane.comp.video.gegl.devel?set_blog_all=yes[mail]|http://svn.gnome.org/viewvc/gegl/trunk/[viewvc]
Features
@@ -41,59 +40,33 @@
* link:operations.html#cat_color[Color correction].
* Text rendering using cairo and http://pango.org/[pango].
+News
+~~~~
+This website is built at the time of the previous GEGL tarball release,
+for information about what might change on the way to the next release
+follow the following news sources:
+
+http://svn.gnome.org/viewvc/gegl/trunk/ChangeLog?view=markup[ChangeLog]::
+ For day to day fixes, contributions and changes.
+http://svn.gnome.org/viewvc/gegl/trunk/ChangeLog?view=markup[NEWS]::
+ The NEWS file for a list of major new features (also contains older NEWS).
+http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO[bugzilla]::
+ for known and tracked issues with GEGL and perhaps see the
+http://blog.gmane.org/gmane.comp.video.gegl.devel?set_blog_all=yes[mail]::
+ The mailinglist archives for some discussion and announcement.
+
Gallery
~~~~~~~
For examples of what GEGLs rendering engine currently can do look at the
link:gallery/index.html[gallery].
-Dependencies
-~~~~~~~~~~~~
-
-GEGL is currently building on linux, the build enviroment probably needs some
-fixes before all of it builds gracefully on many platforms.
-
- - Core
- * glib (including gobject, and gmodule) 2.10 or newer, which provides
- inheritance, dynamic modules, common algorithms and data structures for
- C programming.
- * http://gegl.org/babl/[babl] 0.0.14 or newer (for pixel-format agnostisism).
- * libpng (png load/export ops, and image magick fallback import)
- - GUI (sandbox for testing ops and the API)
- * GTK+
- - Optional dependencies for operations.
- * SDL (display op)
- * libjpeg (jpg loader op)
- * libopenexr (exr loader op)
- * cairo, pango (text source op)
- * librsvg
-
-Download
-~~~~~~~~
-The latest development snapshot, and eventually stable versions of GEGL are
-available at ftp://ftp.gimp.org/pub/gegl/[].
-
-The current code under development can be
-http://svn.gnome.org/viewvc/gegl/trunk/[browsed online] and checked out from
-GNOME Subversion using:
-
- $ svn co http://svn.gnome.org/svn/babl/trunk/ babl
-
- $ svn co http://svn.gnome.org/svn/gegl/trunk/ gegl
-
-Building
-~~~~~~~~
-To build GEGL type the following in the toplevel source directory:
-
- $ ./configure or: ./autogen.sh if building from svn
- $ make
- $ sudo make install
-
Bugzilla
~~~~~~~~
The GEGL project uses http://bugzilla.gnome.org/[GNOME Bugzilla], a
bug-tracking system that allows us to coordinate bug reports. Bugzilla is also
used for enhancement requests and the preferred way to submit patches for GEGL
-is to open a bug report and attach the patch to it.
+is to open a bug report and attach the patch to it. Bugzilla is also the
+closest you will find to a roadmap for GEGL.
Below is a list of links to get you started with Bugzilla:
@@ -102,6 +75,7 @@
- http://bugzilla.gnome.org/buglist.cgi?product=GEGL&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=UNCONFIRMED&bug_status=NEEDINFO&bug_severity=enhancement[List of Enhancement Proposals]
- http://bugzilla.gnome.org/reports/weekly-bug-summary.cgi[Bugzilla Weekly Summary]
+
Mailinglist
~~~~~~~~~~~
You can subscribe to gegl-developer and view the archives
@@ -110,7 +84,6 @@
more information about GEGL development in general. You can email this list at
mailto:gegldev%20at%20gegl.org[].
-
Copyright
~~~~~~~~~
GEGL is free software; you can redistribute it and/or modify it under the terms
@@ -125,51 +98,70 @@
include::../AUTHORS[]
+
+
+Building from source
+--------------------
+GEGL and it's dependencies are known to work on Linux based systems, windows with msys/mingw,
+and probably other platforms.
+
+Download
+~~~~~~~~
+The latest development snapshot, and eventually stable versions of GEGL are
+available at ftp://ftp.gimp.org/pub/gegl/[].
+
+The current code under development can be
+http://svn.gnome.org/viewvc/gegl/trunk/[browsed online] and checked out from
+GNOME Subversion using:
+
+ $ svn co http://svn.gnome.org/svn/babl/trunk/ babl
+ $ svn co http://svn.gnome.org/svn/gegl/trunk/ gegl
+
+Dependencies
+~~~~~~~~~~~~
+
+GEGL is currently building on linux, the build enviroment probably needs some
+fixes before all of it builds gracefully on many platforms. If building from
+a subversion checkout you need to have ruby installed.
+
+ - Core
+ * glib (including gobject, and gmodule) 2.10 or newer, which provides
+ inheritance, dynamic modules, common algorithms and data structures for
+ C programming.
+ * http://gegl.org/babl/[babl] 0.0.14 or newer (for pixel-format agnostisism).
+ * libpng (png load/export ops, and image magick fallback import)
+ - GUI (sandbox for testing ops and the API)
+ * GTK+
+ - Optional dependencies for operations.
+ * SDL (display op)
+ * libjpeg (jpg loader op)
+ * libopenexr (exr loader op)
+ * cairo, pango (text source op)
+ * avcodec, avformat (ff-load and experimental ff-save)
+ * librsvg (svg loader)
+ - Documentation
+ * asciidoc
+
+Compiling
+~~~~~~~~
+To build GEGL type the following in the toplevel source directory:
+
+ $ ./configure or: ./autogen.sh if building from svn
+ $ make
+ $ sudo make install
+
+
Documentation
-------------
+With GEGL you chain together image processing operations represented by nodes
+into a graph. GEGL provides such operations for loading and storing images,
+adjusting colors, filtering images in different ways, translating images and
+
GEGLs programmer/user interface is a Directed Acyclic Graph of nodes. The DAG
expresses a processing chain of operations. A DAG, or any node in it, expresses
a composited and processed image. It is possible to request rectangular regions
in a wide range of pixel formats from any node.
-Glossary
-~~~~~~~~
-connection::
- A link/pipe routing image flow between operations within the graph goes
- from an output pad to an input pad, in graph glossary this might also be
- reffered to as an edge. footnote:[Maybe footnotes can be made to easily work?]
-DAG::
- Directed Acyclic Graph, see graph.
-graph::
- A composition of nodes, the graph is a DAG.
-node::
- The nodes are connected in the graph. A node has an associated operation or
- can be constructed graph.
-operation::
- The processing primitive of GEGL, is where the actual image processing
- takes place. Operations are plug-ins and provide the actual functionality
- of GEGL
-pad::
- The part of a node that exchanges image content. The place where image
- "pipes" are used to connect the various operations in the composition.
-input pad::
- consumes image data, might also be seen as an image parameter to the
- operation.
-output pad::
- a place where data can be requested, multiple input pads can reference
- the same output pad.
-property::
- Properties are what control the behavior of operations, through the use of
- GParamSpecs properties are self documenting through introspection.
-
-Operations
-~~~~~~~~~~
-
-The main source of documentation as GEGL grows is the
-link:operations.html[operations reference]. Plug-ins themselves register
-information about the categories they belong to, what they do, and
-documentation of the available parameters.
-
Public API
~~~~~~~~~~
@@ -179,9 +171,16 @@
#include <link:gegl.h.html[gegl.h]>, compile and link with the flags provided
by pkg-config and you should be all set.
+Bindings
+^^^^^^^^
+The bindings for use of GEGL in other programming languages than C are
+co-hosted with GEGL in GNOME subversion but are not part of the regular GEGL
+distribution. The following language bindings are currently available:
+link:rgegl/index.html[ruby], link:pygegl/idex.html[python]:: and
+link:gegl-sharp/index.html[C#/Mono].
+
Hello world
^^^^^^^^^^^
-
This is a small sample GEGL application that animates a zoom on a mandelbrot
fractal
@@ -191,14 +190,6 @@
$ gcc hello-world.c `pkg-config --libs --cflags gegl` -o hello-world
-Bindings
-^^^^^^^^
-The bindings for use of GEGL in other programming languages than C are
-co-hosted with GEGL in GNOME subversion but are not part of the regular GEGL
-distribution. The following language bindings are currently available:
-link:rgegl/index.html[ruby], link:pygegl/idex.html[python]:: and
-link:gegl-sharp/index.html[C#/Mono].
-
Operation API
~~~~~~~~~~~~~
@@ -207,38 +198,45 @@
Each GEGL operation is defined in a .c file that gets turned into a single
shared object that is loaded. Each operation is a subclass of one of the
-provided baseclasses:
+provided base classes:
-GeglOperation::
+link:gegl-operation.h.html[GeglOperation]::
The base operation class, which all the other base classes are derived
from, deriving from this is often quite a bit of work and is encouraged
only when your operation doesn't fit into any of the other categories
GeglOperationFilter::
The filter base class sets up GeglBuffers for input and output pads
- GeglOperationAreaFilter::
+
+ 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.
- GeglOperationPointFilter::
+
+ 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
+
GeglOperationComposer::
Composer operations are operations that take two inputs named 'input' and
'aux' and writes their output to the output pad 'output'
- GeglOperationPointComposer::
+
+ GeglOperationPointComposer::
A baseclass for composer functions where the output pixels values depends
only on the values of the single corresponding input and aux pixels.
+
GeglOperationSource::
Operations used as render sources or file loaders, the process method
receives a GeglBuffer to write it's output into
+
GeglOperationSink::
An operation that consumes a GeglBuffer, used for filewriters, display (for
the sdl display node)
+
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
@@ -255,26 +253,20 @@
Take a look at link:brightness-contrast.c.html[the brightness contrast operation] for
a simple point operation well sprinkled with comments.
-core
-~~~~
-The core implements the graph of nodes accessed in the public API as well as
-orchestrates the processing of the graph filling caches with rendered results.
-
-
-XML data model
-~~~~~~~~~~~~~~
-The tree allows clones, making it possible to express any acyclic graph where
-the nodes are all of the types: source, filter and composer.
-
-GEGL can write and reads its data model to and from XML. The XML is chains of
-image processing commands, where some chains allow a child chain (the 'over'
-operator to implement layers for instance).
-
-The type of operation associated with a node can be specified either with a
-class attribute or by using the operation name as the tag name for the node.
-
-For documentation on how this XML works, take a look at the sources in the
-gallery. And browse the documentation for operations.
+//XML data model
+//~~~~~~~~~~~~~~
+//The tree allows clones, making it possible to express any acyclic graph where
+//the nodes are all of the types: source, filter and composer.
+//
+//GEGL can write and reads its data model to and from XML. The XML is chains of
+//image processing commands, where some chains allow a child chain (the 'over'
+//operator to implement layers for instance).
+//
+//The type of operation associated with a node can be specified either with a
+//class attribute or by using the operation name as the tag name for the node.
+//
+//or documentation on how this XML works, take a look at the sources in the
+//gallery. And browse the documentation for operations.
Environment
~~~~~~~~~~~
@@ -328,7 +320,7 @@
Subversion.
gegl usage
-~~~~~~~~~~
+^^^^^^^^^^
The following is the usage information of the gegl binary, this documentation
might not be complete.
@@ -337,11 +329,51 @@
-------
+Appendixes
+----------
-Code overview
--------------
+Operations
+~~~~~~~~~~
+
+The main source of documentation as GEGL grows is the
+link:operations.html[operations reference]. Plug-ins themselves register
+information about the categories they belong to, what they do, and
+documentation of the available parameters.
+
+Glossary
+~~~~~~~~
+connection::
+ A link/pipe routing image flow between operations within the graph goes
+ from an output pad to an input pad, in graph glossary this might also be
+ reffered to as an edge.
+DAG::
+ Directed Acyclic Graph, see graph.
+graph::
+ A composition of nodes, the graph is a DAG.
+node::
+ The nodes are connected in the graph. A node has an associated operation or
+ can be constructed graph.
+operation::
+ The processing primitive of GEGL, is where the actual image processing
+ takes place. Operations are plug-ins and provide the actual functionality
+ of GEGL
+pad::
+ The part of a node that exchanges image content. The place where image
+ "pipes" are used to connect the various operations in the composition.
+input pad::
+ consumes image data, might also be seen as an image parameter to the
+ operation.
+output pad::
+ a place where data can be requested, multiple input pads can reference
+ the same output pad.
+property::
+ Properties are what control the behavior of operations, through the use of
+ GParamSpecs properties are self documenting through introspection.
+
+Directory overview
+~~~~~~~~~~~~~~~~~~
GEGL dirs
-~~~~~~~~~
+^^^^^^^^^
gegl-dist-root
â
@@ -392,7 +424,6 @@
â âââdata Image data used by the sample compositions.
â
âââbin gegl binary, for processing XML compositions to png files.
- âââgraph-editor a graph editor.
â
âââbindings bindings for using GEGL from other programming languages
â not included in the tarball distribution but exist in
@@ -401,7 +432,7 @@
âââtools some small utilities to help the build.
babl dirs
-~~~~~~~~~
+^^^^^^^^^
babl-dist-root
â
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
