diff options
author | Benjamin Otte <otte@gnome.org> | 2009-10-22 09:46:33 +0100 |
---|---|---|
committer | Benjamin Otte <otte@gnome.org> | 2009-10-22 09:46:33 +0100 |
commit | 6517dff4593275766211c5fc88f28122c8c51315 (patch) | |
tree | 1aa990572b23cfdf915c9f4506362f214efb109e | |
parent | c38d0f8bb2f3c93f0562a915e7c52d54004e3a61 (diff) |
Restructure docs and add introduction
-rw-r--r-- | docs/libs/gst-plugins-cairo-libs-docs.sgml | 57 | ||||
-rw-r--r-- | docs/libs/gst-plugins-cairo-libs-sections.txt | 5 |
2 files changed, 57 insertions, 5 deletions
diff --git a/docs/libs/gst-plugins-cairo-libs-docs.sgml b/docs/libs/gst-plugins-cairo-libs-docs.sgml new file mode 100644 index 0000000..b95672e --- /dev/null +++ b/docs/libs/gst-plugins-cairo-libs-docs.sgml @@ -0,0 +1,57 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ +<!ENTITY % version-entities SYSTEM "version.entities"> +%version-entities; +<!ENTITY GstCairoBuffer SYSTEM "xml/gstcairobuffer.xml"> +<!ENTITY GstCairoCaps SYSTEM "xml/gstcairocaps.xml"> + +<!-- generated by gtkdoc-mkdb --> +<!ENTITY gst-plugin-libs-tree-index SYSTEM "xml/tree_index.sgml"> + +]> +<book id="index"> + <bookinfo> + <title>GStreamer Cairo Plugins &GST_MAJORMINOR; Library Reference Manual</title> + <releaseinfo> + for GStreamer Cairo Library &GST_MAJORMINOR; (&GST_VERSION;) + <ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-cairo-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-cairo-libs/html/</ulink>. + </releaseinfo> + </bookinfo> + + <part id="gstreamer-plugins-cairo"> + <title>GStreamer Cairo Plugins Library</title> + <para> + This manual describes the GStreamer Cairo library that is the preferred + way to handle raw video in GStreamer. It supercedes previous functionality, + but stays 100% backwards compatible with old elements. The most notable + addition is the seamless and automatic integration of hardware + acceleration when available. + </para> + <para> + A second goal of this library is to simplify writing of video handling + elements. It contains many convenience functions that ease writing video + handling elements. + </para> + <para> + A third goal of this library is forward compatibility. This should allow + elements to automatically support new features when they are added, so + that your element continues working and taking advantages of hardware + acceleration when this library gets ported to Android phones or the next + DirectX version. Achieving this requires careful coding of the elements. + This library provides functions taking care of these issues, so be sure + to read the documentation so that you know when to use the functions. + </para> + &GstCairoCaps; + &GstCairoBuffer; + </part> + + <part id="gstreamer-libs-hierarchy"> + <title>Object Hierarchy</title> + &gst-plugin-libs-tree-index; + </part> + + <index id="api-index"> + <title>Index</title> + </index> +</book> diff --git a/docs/libs/gst-plugins-cairo-libs-sections.txt b/docs/libs/gst-plugins-cairo-libs-sections.txt index 478845d..638f40b 100644 --- a/docs/libs/gst-plugins-cairo-libs-sections.txt +++ b/docs/libs/gst-plugins-cairo-libs-sections.txt @@ -1,9 +1,4 @@ <SECTION> -<FILE>gstcairointro</FILE> -<TITLE>introduction</TITLE> -</SECTION> - -<SECTION> <FILE>gstcairocaps</FILE> <TITLE>caps negotiation and format handling</TITLE> GstCairoFormatOption |