summaryrefslogtreecommitdiff
path: root/src/multimedia/doc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <venugopal.shivashankar@digia.com>2012-12-19 14:36:55 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-01-02 15:28:47 +0100
commit85faa55780a1057b4d1929a07c253847bfdc93fd (patch)
tree7b365889ee0fb890497c6a79eb443d6a069bb275 /src/multimedia/doc
parent3df5999a07cfa8e23734cb939373cd4fe46fac74 (diff)
downloadqtmultimedia-85faa55780a1057b4d1929a07c253847bfdc93fd.tar.gz
Doc: Moved the qdocinc and image to the sourcedirs
QDoc parses the \input command relative to the sourcedirs and not exampledirs. So I had to move the qdocinc file and the corresponding image to the sourcedirs. Task-number: QTBUG-28727 Change-Id: Ie064f0b79ab8ffcb0587b43ff4508f5865a321a9 Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com> Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
Diffstat (limited to 'src/multimedia/doc')
-rw-r--r--src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc43
-rw-r--r--src/multimedia/doc/src/images/video-qml-paint-rate.pngbin0 -> 6350 bytes
2 files changed, 43 insertions, 0 deletions
diff --git a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
new file mode 100644
index 000000000..860f14270
--- /dev/null
+++ b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc
@@ -0,0 +1,43 @@
+The QML painting rate is calculated by the FrequencyMonitor class, which
+turns a stream of events (received via the notify() slot), into an
+instantaneous and an averaged frequency:
+
+\quotefromfile multimedia/video/snippets/frequencymonitor/frequencymonitor.h
+\skipto class FrequencyMonitor : public QObject
+\printuntil Q_OBJECT
+\skipto Q_PROPERTY(qreal instantaneousFrequency
+\printuntil averageFrequencyChanged)
+\skipto public
+\printuntil :
+\dots
+\skipto static void qmlRegisterType
+\printuntil ;
+\skipto public slots
+\printuntil notify();
+\skipto };
+\printline };
+
+The FrequencyMonitor class is exposed to QML like this
+
+\quotefromfile multimedia/video/snippets/frequencymonitor/frequencymonitordeclarative.cpp
+\skipto FrequencyMonitor::qmlRegisterType
+\printuntil }
+
+and its data is displayed by defining a QML item called FrequencyItem, like this:
+
+\quotefromfile multimedia/video/snippets/frequencymonitor/qml/frequencymonitor/FrequencyItem.qml
+\skipto import FrequencyMonitor
+\printuntil id: root
+\dots
+\skipto function notify
+\printuntil id: monitor
+\skipto onAverageFrequencyChanged
+\printuntil {
+\skipto averageFrequencyText
+\printuntil /^\}/
+
+The result looks like this:
+
+\image video-qml-paint-rate.png
+
+
diff --git a/src/multimedia/doc/src/images/video-qml-paint-rate.png b/src/multimedia/doc/src/images/video-qml-paint-rate.png
new file mode 100644
index 000000000..1519ff64e
--- /dev/null
+++ b/src/multimedia/doc/src/images/video-qml-paint-rate.png
Binary files differ