diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2015-02-06 14:17:50 +0100 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@digia.com> | 2015-03-11 13:52:10 +0000 |
commit | 462dd4fa9dc03a65f5c680f6eae2db623d2fe19e (patch) | |
tree | 7817ca7391dffcd3011579973d2ae9b0abfc7cef /src/render/defaults/qforwardrenderer.cpp | |
parent | cb7753f3ffa85eed0fbd98cb2e4f0e453c595d6d (diff) |
Doc: link and qdoc errors Qt3D
Task-number: QTBUG-44180
Change-Id: Ic798dee5d33dbf18dbc9d978a0f07217895a30ee
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/render/defaults/qforwardrenderer.cpp')
-rw-r--r-- | src/render/defaults/qforwardrenderer.cpp | 31 |
1 files changed, 13 insertions, 18 deletions
diff --git a/src/render/defaults/qforwardrenderer.cpp b/src/render/defaults/qforwardrenderer.cpp index c8bf9e8d7..feb8af0ad 100644 --- a/src/render/defaults/qforwardrenderer.cpp +++ b/src/render/defaults/qforwardrenderer.cpp @@ -74,7 +74,7 @@ void QForwardRendererPrivate::init() /*! \class Qt3D::QForwardRenderer - \brief The Qt3D::QForwardRenderer provides a default FrameGraph implementation of a forward renderer. + \brief The Qt3D::QForwardRenderer provides a default \l {QFrameGraph}{FrameGraph} implementation of a forward renderer. \inmodule Qt3DRender \since 5.5 @@ -85,7 +85,7 @@ void QForwardRendererPrivate::init() This a is a single leaf Framegraph tree which contains a Qt3D::QViewport, a Qt3D::QCameraSelector and a Qt3D::QClearBuffer. The Qt3D::QForwardRenderer has a default requirement annotation whose name is "renderingStyle" and value "forward". - If you need to filter out your techniques, you should do so based on that annocation. + If you need to filter out your techniques, you should do so based on that annotation. By default the viewport occupies the whole screen and the clear color is white. */ @@ -108,20 +108,12 @@ QForwardRenderer::~QForwardRenderer() { } -/*! - \fn Qt3D::QForwardRenderer::setViewportRect(const QRectF &viewportRect) - Sets the current viewport rect to \a viewportRect. - */ void QForwardRenderer::setViewportRect(const QRectF &viewportRect) { Q_D(QForwardRenderer); d->m_viewport->setRect(viewportRect); } -/*! - \fn Qt3D::QForwardRenderer::setClearColor(const QColor &clearColor) - Sets the clearColor to \a clearColor. - */ void QForwardRenderer::setClearColor(const QColor &clearColor) { Q_D(QForwardRenderer); @@ -129,9 +121,9 @@ void QForwardRenderer::setClearColor(const QColor &clearColor) } /*! - \fn Qt3D::QForwardRenderer::setCamera(QEntity *camera) Sets the camera which should be used to render the scene to \a camera. - \b {Note:} A camera is a QEntity having a QCameraLens has one of its components + + \note A camera is a QEntity having a QCameraLens as one of its components. */ void QForwardRenderer::setCamera(QEntity *camera) { @@ -140,8 +132,9 @@ void QForwardRenderer::setCamera(QEntity *camera) } /*! - \fn Qt3D::QForwardRenderer::viewportRect() const - \return the current viewport rect. + \property Qt3D::QForwardRenderer::viewportRect + + Holds the current viewport rect. */ QRectF QForwardRenderer::viewportRect() const { @@ -150,8 +143,9 @@ QRectF QForwardRenderer::viewportRect() const } /*! - \fn Qt3D::QForwardRenderer::clearColor() const - \return the current clearColor. + \property Qt3D::QForwardRenderer::clearColor + + Holds the current clearColor. */ QColor QForwardRenderer::clearColor() const { @@ -160,8 +154,9 @@ QColor QForwardRenderer::clearColor() const } /*! - \fn Qt3D::QForwardRenderer::camera() const - \return the current QEntity camera used to render the scene. + \property Qt3D::QForwardRenderer::camera + + Holds the current QEntity camera used to render the scene. */ QEntity *QForwardRenderer::camera() const { |