QtGstreamerUi: Improve docs that are mentioning qt(gl)videosink.

2 files changed, 14 insertions, 10 deletions

diff --git a/src/QGst/Ui/graphicsvideosurface.h b/src/QGst/Ui/graphicsvideosurface.h
index 93a9e48..bd17749 100644
--- a/src/QGst/Ui/graphicsvideosurface.h
+++ b/src/QGst/Ui/graphicsvideosurface.h
@@ -47,15 +47,17 @@ class GraphicsVideoSurfacePrivate;
  * view->addItem(widget);
  * \endcode
  *
- * This class internally creates and uses a "qtvideosink" element. This element
- * is created the first time it is requested and a reference is kept internally.
+ * This class internally creates and uses either a "qtglvideosink" or a "qtvideosink"
+ * element. This element is created the first time it is requested and a reference is
+ * kept internally.
  *
- * To make use of OpenGL hardware acceleration in qtvideosink, it is recommended
- * that you set a QGLWidget as the viewport of the QGraphicsView. Note that you must
- * do this before the qtvideosink element is requested for the first time using the
- * videoSink() method, as it needs to find a GL context at construction time to
- * query the hardware about supported features. If you don't use OpenGL acceleration,
- * painting will be done in software with QImage and QPainter.
+ * To make use of OpenGL hardware acceleration (using qtglvideosink), you need to set
+ * a QGLWidget as the viewport of the QGraphicsView. Note that you must do this before
+ * the video sink element is requested for the first time using the videoSink() method,
+ * as this method needs to find a GL context to be able to construct qtglvideosink and
+ * query the hardware about supported features. Using OpenGL acceleration is recommended.
+ * If you don't use it, painting will be done in software with QImage and QPainter
+ * (using qtvideosink).
  *
  * This class can also be used to paint video on QML.
  *
diff --git a/src/QGst/Ui/videowidget.h b/src/QGst/Ui/videowidget.h
index 8faf982..19c148a 100644
--- a/src/QGst/Ui/videowidget.h
+++ b/src/QGst/Ui/videowidget.h
@@ -36,7 +36,8 @@ class AbstractRenderer;
  * There are two ways of using this widget:
  * \li Create a video sink yourself and set it with the setVideoSink() method.
  * This will work for all sinks that implement the XOverlay interface, plus
- * the "qwidgetvideosink", which paints directly on the widget.
+ * "qtvideosink", "qtglvideosink" and "qwidgetvideosink", which paint directly
+ * on the widget.
  * \li Create a pipeline and let the widget watch the pipeline using the
  * watchPipeline() method. This will cause the widget to watch the bus for
  * the "prepare-xwindow-id" that all XOverlay sinks send right before
@@ -73,7 +74,8 @@ public:
     ElementPtr videoSink() const;
 
     /*! Sets the video sink element that is going to be embedded.
-     * Any sink that implements the XOverlay interface will work, as well as "qwidgetvideosink".
+     * Any sink that implements the XOverlay interface will work, as well as
+     * "qtvideosink", "qtglvideosink" and "qwidgetvideosink".
      * \note
      * \li This method \em must be called from Qt's GUI thread.
      * \li Passing a null ElementPtr has the same effect as calling releaseVideoSink().