QRenderSurfaceSelector: complete doc

Change-Id: I66c6d7a2d6c171b34e63e1de5436ce299156734c
Task-number: QTBUG-55333
Reviewed-by: Kevin Ottens <kevin.ottens@kdab.com>

1 files changed, 14 insertions, 0 deletions

diff --git a/src/render/framegraph/qrendersurfaceselector.cpp b/src/render/framegraph/qrendersurfaceselector.cpp
index e76963e72..f3feb2fde 100644
--- a/src/render/framegraph/qrendersurfaceselector.cpp
+++ b/src/render/framegraph/qrendersurfaceselector.cpp
@@ -59,6 +59,13 @@ namespace Qt3DRender {
  *
  * \inherits Qt3DRender::QFrameGraphNode
  *
+ * Qt3DRender::QRenderSurfaceSelector specifies which window should be used for
+ * the rendering of a FrameGraph branch. In some cases you may also want to
+ * specify the size of what needs to be drawn when rendering with a frame
+ * buffer object. In such cases, the externalRenderTargetSize should be set and
+ * updated accordingly. If it is not set, the renderer will assume it should use
+ * the surface's size.
+ *
  */
 
 /*!
@@ -69,6 +76,13 @@ namespace Qt3DRender {
  * \instantiates Qt3DRender::QRenderSurfaceSelector
  * \brief Provides a way of specifying the render surface
  *
+ * RenderSurfaceSelector specifies which window should be used for
+ * the rendering of a FrameGraph branch. In some cases you may also want to
+ * specify the size of what needs to be drawn when rendering with a frame
+ * buffer object. In such cases, the externalRenderTargetSize should be set and
+ * updated accordingly. If it is not set, the renderer will assume it should use
+ * the surface's size.
+ *
  */
 
 /*! \qmlproperty QSurface Qt3D.Render::RenderSurfaceSelector::surface