diff options
author | Stefan Sauer <ensonic@users.sf.net> | 2013-02-01 21:59:41 +0100 |
---|---|---|
committer | Stefan Sauer <ensonic@users.sf.net> | 2013-02-01 22:00:18 +0100 |
commit | fba696eb057e1fb89f381326588fe1fd19c918c1 (patch) | |
tree | 44bf9eb57331698e87d44c66c2875a1b3fbd30ff | |
parent | bbf77402f084ee59561e902843ce3420425fdafe (diff) |
docs: update the controller docs
Add the control bindings to the docs. Add a little more detail.
-rw-r--r-- | docs/libs/gstreamer-libs-docs.sgml | 3 | ||||
-rw-r--r-- | docs/libs/gstreamer-libs-sections.txt | 38 | ||||
-rw-r--r-- | docs/libs/gstreamer-libs.types | 4 | ||||
-rw-r--r-- | gst/gstcontrolbinding.c | 2 | ||||
-rw-r--r-- | libs/gst/controller/gstargbcontrolbinding.c | 5 | ||||
-rw-r--r-- | libs/gst/controller/gstdirectcontrolbinding.c | 5 |
6 files changed, 52 insertions, 5 deletions
diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index f8dfc6b95..92d25fb08 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -56,6 +56,9 @@ element properties over time. </para> + <xi:include href="xml/gstargbcontrolbinding.xml" /> + <xi:include href="xml/gstdirectcontrolbinding.xml" /> + <xi:include href="xml/gsttimedvaluecontrolsource.xml" /> <xi:include href="xml/gstinterpolationcontrolsource.xml" /> <xi:include href="xml/gstlfocontrolsource.xml" /> diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index 1dd957c12..5c683ac0e 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -13,6 +13,44 @@ # <SUBSECTION Private> # </SECTION> +# control binding classes + +<SECTION> +<FILE>gstargbcontrolbinding</FILE> +<TITLE>GstARGBControlBinding</TITLE> +<INCLUDE>libs/controller/gstargbcontrolbinding.h</INCLUDE> +gst_argb_control_binding_new +<SUBSECTION Standard> +GstARGBControlBinding +GstARGBControlBindingClass +GST_ARGB_CONTROL_BINDING +GST_ARGB_CONTROL_BINDING_CLASS +GST_ARGB_CONTROL_BINDING_GET_CLASS +GST_IS_ARGB_CONTROL_BINDING +GST_IS_ARGB_CONTROL_BINDING_CLASS +GST_TYPE_ARGB_CONTROL_BINDING +gst_argb_control_binding_get_type +</SECTION> + +<SECTION> +<FILE>gstdirectcontrolbinding</FILE> +<TITLE>GstDirectControlBinding</TITLE> +<INCLUDE>libs/controller/gstdirectcontrolbinding.h</INCLUDE> +gst_direct_control_binding_new +<SUBSECTION Standard> +GstDirectControlBindingConvertValue +GstDirectControlBindingConvertGValue +GstDirectControlBinding +GstDirectControlBindingClass +GST_DIRECT_CONTROL_BINDING +GST_DIRECT_CONTROL_BINDING_CLASS +GST_DIRECT_CONTROL_BINDING_GET_CLASS +GST_IS_DIRECT_CONTROL_BINDING +GST_IS_DIRECT_CONTROL_BINDING_CLASS +GST_TYPE_DIRECT_CONTROL_BINDING +gst_direct_control_binding_get_type +</SECTION> + # control source classes <SECTION> diff --git a/docs/libs/gstreamer-libs.types b/docs/libs/gstreamer-libs.types index 498019110..8681c4cdd 100644 --- a/docs/libs/gstreamer-libs.types +++ b/docs/libs/gstreamer-libs.types @@ -18,11 +18,15 @@ gst_push_src_get_type % controller +#include <gst/controller/gstargbcontrolbinding.h> +#include <gst/controller/gstdirectcontrolbinding.h> #include <gst/controller/gsttimedvaluecontrolsource.h> #include <gst/controller/gstinterpolationcontrolsource.h> #include <gst/controller/gstlfocontrolsource.h> #include <gst/controller/gsttriggercontrolsource.h> +gst_argb_control_binding_get_type +gst_direct_control_binding_get_type gst_timed_value_control_source_get_type gst_interpolation_control_source_get_type gst_lfo_control_source_get_type diff --git a/gst/gstcontrolbinding.c b/gst/gstcontrolbinding.c index 67a7f7d61..3868dc774 100644 --- a/gst/gstcontrolbinding.c +++ b/gst/gstcontrolbinding.c @@ -294,7 +294,7 @@ gst_control_binding_get_value (GstControlBinding * binding, * * The values are unboxed and ready to be used. The similar function * gst_control_binding_get_g_value_array() returns the array as #GValues and is - * better suites for bindings. + * more suitable for bindings. * * Returns: %TRUE if the given array could be filled, %FALSE otherwise */ diff --git a/libs/gst/controller/gstargbcontrolbinding.c b/libs/gst/controller/gstargbcontrolbinding.c index 61cf44261..3bb04c170 100644 --- a/libs/gst/controller/gstargbcontrolbinding.c +++ b/libs/gst/controller/gstargbcontrolbinding.c @@ -22,10 +22,11 @@ */ /** * SECTION:gstargbcontrolbinding - * @short_description: attachment for control source sources to argb properties + * @short_description: attachment for control sources to argb properties * * A value mapping object that attaches multiple control sources to a guint - * gobject properties representing a color. + * gobject properties representing a color. A control value of 0.0 will turn the + * color component off and a value of 1.0 will be the color level. */ #include <glib-object.h> diff --git a/libs/gst/controller/gstdirectcontrolbinding.c b/libs/gst/controller/gstdirectcontrolbinding.c index ae9fe9741..7daaed321 100644 --- a/libs/gst/controller/gstdirectcontrolbinding.c +++ b/libs/gst/controller/gstdirectcontrolbinding.c @@ -21,9 +21,10 @@ */ /** * SECTION:gstdirectcontrolbinding - * @short_description: direct attachment for control source sources + * @short_description: direct attachment for control sources * - * A value mapping object that attaches control sources to gobject properties. + * A value mapping object that attaches control sources to gobject properties. It + * will map the control values [0.0 ... 1.0] to the target property range. */ |