diff options
author | Venugopal Shivashankar <venugopal.shivashankar@digia.com> | 2012-12-12 16:35:15 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-12-12 17:44:36 +0100 |
commit | 0241b0e39c4ac259c2336d074f1fa488d0e0ebcc (patch) | |
tree | ac08771a6287a68349a4bd4a9e15dfa5362133de /examples/multimedia/video/doc/src/qmlvideofx.qdoc | |
parent | 5cd23af26c6c627ac10b418043690c1deb17627d (diff) |
Doc: Updated the \example and \snippet pathsv5.0.0-rc2
Also:
- Grouped the example docs under one group. i.e. multimedia-examples
- Moved the \group page here from the qtdoc repo
- Moved the snippets directory under doc from doc/src
Change-Id: I28fb81cf910e58101cd601fb4c440b59b0b0366d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'examples/multimedia/video/doc/src/qmlvideofx.qdoc')
-rw-r--r-- | examples/multimedia/video/doc/src/qmlvideofx.qdoc | 29 |
1 files changed, 14 insertions, 15 deletions
diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc index f9b324087..b6535a952 100644 --- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc +++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc @@ -26,10 +26,9 @@ ****************************************************************************/ /*! -\example video/qmlvideofx +\example multimedia/video/qmlvideofx \title QML Video Shader Effects Example -\ingroup video_examples_qml -\ingroup camera_examples_qml +\ingroup multimedia_examples \brief The QML Video Shader Effects Example shows how \l {ShaderEffect} can be used to apply postprocessing effects, expressed in \c GLSL, to video @@ -135,10 +134,10 @@ types is a bit more complicated, for the following reasons: \endlist The abstraction of source item type is achieved by the -\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a \l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image}: -\quotefromfile video/qmlvideofx/qml/qmlvideofx/Content.qml +\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml \skipto import \printuntil { \dots @@ -165,10 +164,10 @@ The abstraction of source item type is achieved by the \printuntil } Each effect is implemented as a QML item which is based on the -\l{video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn is based on the \l{ShaderEffect}: -\quotefromfile video/qmlvideofx/qml/qmlvideofx/Effect.qml +\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml \skipto import \printuntil /^\}/ @@ -180,20 +179,20 @@ implementation of the pixelation effect. As you can see, the pixelation effect supports one parameter (which controls the pixelation granularity), and states that the divider should be displayed. -\quotefromfile video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml +\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml \skipto import \printuntil /^\}/ The main.qml file shows a -\l{video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows the user to select the input source and an -\l{video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel} +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel} item, which lists each of the available shader effects. As described above, a -\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the appropriate input and effect type. A -\l{video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the vertical dividing line, which can be dragged left / right by the user. Finally, -a \l{video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item +a \l{multimedia/video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item renders the sliders corresponding to each effect parameter. Here is the source selection menu: @@ -204,12 +203,12 @@ And here is the effect selection menu: \section1 Calculating and displaying QML painting rate -\input examples/video-qml-paint-rate.qdocinc +\input video-qml-paint-rate.qdocinc All that remains is to connect the afterRendering() signal of the QQuickView object to a JavaScript function, which will eventually call frequencyItem.notify(): -\quotefromfile video/qmlvideofx/main.cpp +\quotefromfile multimedia/video/qmlvideofx/main.cpp \skipto QmlApplicationViewer \printuntil ; \dots |