← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/kde4libs/gutsy

« back to all changes in this revision

Viewing changes to phonon/videoeffect.h

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2007-02-21 11:00:12 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070221110012-6kw8khr9knv6lmg1
Tags: 3.80.3-0ubuntu1
New upstream unstable release

Show diffs side-by-side

added added

removed removed

Lines of Context:
phonon/videoeffect.h
31
31
{
32
32
        class VideoEffectPrivate;
33
33
 
 
34
        /**
 
35
         * \short Video effects that can be inserted into a VideoPath.
 
36
         * A video effect is a special object which can perform
 
37
         * transformations on the specified VideoPath. Examples may include simple
 
38
         * modifiers such as brightness or colour controls, or more complex mathematical
 
39
         * transformations.
 
40
         *
 
41
         * In order to use an effect, insert it into the path as follows:
 
42
         * \code
 
43
         * VideoPath* path = new VideoPath( this );
 
44
         * VideoEffect *effect = new VideoEffect( this );
 
45
         * path->insertEffect( effect );
 
46
         * \endcode
 
47
         *
 
48
         * The VideoEffect will immediately begin applying it's transformations on
 
49
         * the VideoPath. To stop it, remove the Effect from the VideoPath.
 
50
         *
 
51
         * \warning This class is not finished.
 
52
         *
 
53
         * \author Matthias Kretz <kretz@kde.org>
 
54
         */
34
55
        class PHONONCORE_EXPORT VideoEffect : public QObject, public Effect, public Base
35
56
        {
36
57
                friend class VideoPath;
79
100
        };
80
101
} //namespace Phonon
81
102
 
82
 
// vim: sw=4 ts=4 tw=80 noet
 
103
// vim: sw=4 ts=4 tw=80
83
104
#endif // Phonon_VIDEOEFFECT_H