From ae29b1452d6d02cb882bb5d5974922673087316e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Antti=20M=C3=A4=C3=A4tt=C3=A4?= Date: Thu, 8 Sep 2016 15:59:28 +0300 Subject: Fix some framegraph docs issues MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change-Id: I09f3ef3c2681dbaacf0a37acda3a3831e0a6a667 Reviewed-by: Tomi Korpipää Reviewed-by: Topi Reiniö Reviewed-by: Sean Harmer --- src/render/framegraph/qframegraphnode.cpp | 8 +++- src/render/framegraph/qrenderpassfilter.cpp | 49 ++++++++++++++++++--- src/render/framegraph/qrenderstateset.cpp | 67 +++++++++++++++++++---------- src/render/framegraph/qsortpolicy.cpp | 1 + src/render/framegraph/qviewport.cpp | 2 +- 5 files changed, 95 insertions(+), 32 deletions(-) diff --git a/src/render/framegraph/qframegraphnode.cpp b/src/render/framegraph/qframegraphnode.cpp index a480acf3d..92f07ad06 100644 --- a/src/render/framegraph/qframegraphnode.cpp +++ b/src/render/framegraph/qframegraphnode.cpp @@ -94,6 +94,9 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate() \row \li Qt3DRender::QRenderSurfaceSelector \li Select which surface to draw to + \row + \li Qt3DRender::QRenderTargetSelector + \li Select which QRenderTarget to draw to \row \li Qt3DRender::QSortPolicy \li Specify how entities are sorted to determine draw order @@ -133,7 +136,7 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate() \li Specify which buffers to clear and to what values \row \li DispatchCompute - \li Specify Compute operation kernels + \li Specify compute operation kernels \row \li FrustumCulling \li Enable frustum culling @@ -152,6 +155,9 @@ QFrameGraphNodePrivate::QFrameGraphNodePrivate() \row \li RenderSurfaceSelector \li Select which surface to draw to + \row + \li RenderTargetSelector + \li Select which RenderTarget to draw to \row \li SortPolicy \li Specify how entities are sorted to determine draw order diff --git a/src/render/framegraph/qrenderpassfilter.cpp b/src/render/framegraph/qrenderpassfilter.cpp index 2e9326b1f..1654b284e 100644 --- a/src/render/framegraph/qrenderpassfilter.cpp +++ b/src/render/framegraph/qrenderpassfilter.cpp @@ -58,10 +58,45 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.7 \brief Provides storage for vectors of Filter Keys and Parameters + + A Qt3DRender::QRenderPassFilter FrameGraph node is used to select which + Qt3DRender::QRenderPass objects are selected for drawing. QRenderPassFilter + specifies a list of Qt3DRender::QFilterKey objects and Qt3DRender::QParameter objects. + When QRenderPassFilter is present in the FrameGraph, only the QRenderPass objects, + whose Qt3DRender::QFilterKey objects match the keys in QRenderPassFilter are + selected for rendering. If no QRenderPassFilter is present, then all QRenderPass + objects are selected for rendering. The parameters in the list can be used + to set values for shader parameters. The parameters in QRenderPassFilter are + overridden by parameters in QTechniqueFilter, QTechnique and QRenderPass. +*/ + +/*! + \qmltype RenderPassFilter + \inmodule Qt3D.Render + \since 5.7 + \instantiates Qt3DRender::QRenderPassFilter + \inherits FrameGraphNode + \brief Provides storage for vectors of Filter Keys and Parameters + + A RenderPassFilter FrameGraph node is used to select which RenderPass + objects are selected for drawing. When RenderPassFilter is present in the FrameGraph, + only the RenderPass objects, whose FilterKey objects match the keys + in RenderPassFilter are selected for rendering. If no RenderPassFilter is present, + then all RenderPass objects are selected for rendering. */ /*! - The constructor creates an instance with the specified \a parent. + \qmlproperty list RenderPassFilter::matchAny + Holds the list of filterkeys used by the RenderPassFilter +*/ +/*! + \qmlproperty list RenderPassFilter::parameters + Holds the list of parameters used by the RenderPassFilter +*/ + + +/*! + The constructor creates an instance with the specified \a parent. */ QRenderPassFilter::QRenderPassFilter(QNode *parent) : QFrameGraphNode(*new QRenderPassFilterPrivate, parent) @@ -79,7 +114,7 @@ QRenderPassFilter::QRenderPassFilter(QRenderPassFilterPrivate &dd, QNode *parent } /*! - Returns a vector of the current keys for the filter. + Returns a vector of the current keys for the filter. */ QVector QRenderPassFilter::matchAny() const { @@ -88,7 +123,7 @@ QVector QRenderPassFilter::matchAny() const } /*! - Add the filter key \a filterKey to the match vector. + Add the \a filterKey to the match vector. */ void QRenderPassFilter::addMatch(QFilterKey *filterKey) { @@ -116,7 +151,7 @@ void QRenderPassFilter::addMatch(QFilterKey *filterKey) } /*! - Remove the filter key \a filterKey from the match vector. + Remove the \a filterKey from the match vector. */ void QRenderPassFilter::removeMatch(QFilterKey *filterKey) { @@ -134,7 +169,7 @@ void QRenderPassFilter::removeMatch(QFilterKey *filterKey) } /*! - Add the parameter \a parameter to the parameter vector. + Add the given \a parameter to the parameter vector. */ void QRenderPassFilter::addParameter(QParameter *parameter) { @@ -162,7 +197,7 @@ void QRenderPassFilter::addParameter(QParameter *parameter) } /*! - Remove the parameter \a parameter from the parameter vector. + Remove the given \a parameter from the parameter vector. */ void QRenderPassFilter::removeParameter(QParameter *parameter) { @@ -180,7 +215,7 @@ void QRenderPassFilter::removeParameter(QParameter *parameter) } /*! - Returns the current vector of parameters. + Returns the current vector of parameters. */ QVector QRenderPassFilter::parameters() const { diff --git a/src/render/framegraph/qrenderstateset.cpp b/src/render/framegraph/qrenderstateset.cpp index a644afdd6..4e3e4ab0b 100644 --- a/src/render/framegraph/qrenderstateset.cpp +++ b/src/render/framegraph/qrenderstateset.cpp @@ -58,25 +58,46 @@ QRenderStateSetPrivate::QRenderStateSetPrivate() } /*! - * \class Qt3DRender::QRenderStateSet - * \inheaderfile Qt3DRender/QRenderStateSet - * \inmodule Qt3DRender - * - * \brief The QRenderStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of - * specifying a set of QRenderState objects to be applied during the execution - * of a framegraph branch. - * - * States set on a QRenderStateSet are set globally, contrary to the per-material - * states that can be set on a QRenderPass. By default, an empty - * QRenderStateSet will result in all render states being disabled when - * executed. Adding a QRenderState state explicitly enables that render - * state at runtime. - * - * \since 5.5 - * - * \sa QRenderState, QRenderPass + \class Qt3DRender::QRenderStateSet + \inmodule Qt3DRender + \since 5.5 + \brief The QRenderStateSet \l {QFrameGraphNode}{FrameGraph} node offers a way of + specifying a set of QRenderState objects to be applied during the execution + of a framegraph branch. + + States set on a QRenderStateSet are set globally, contrary to the per-material + states that can be set on a QRenderPass. By default, an empty + QRenderStateSet will result in all render states being disabled when + executed. Adding a QRenderState state explicitly enables that render + state at runtime. + + \sa QRenderState, QRenderPass */ +/*! + \qmltype RenderStateSet + \inmodule Qt3D.Render + \since 5.5 + \inherits FrameGraphNode + \instantiates Qt3DRender::QRenderStateSet + \brief The RenderStateSet \l {FrameGraphNode}{FrameGraph} node offers a way of + specifying a set of RenderState objects to be applied during the execution + of a framegraph branch. + + States set on a RenderStateSet are set globally, contrary to the per-material + states that can be set on a RenderPass. By default, an empty + RenderStateSet will result in all render states being disabled when + executed. Adding a RenderState state explicitly enables that render + state at runtime. + + \sa RenderState, RenderPass + */ + +/*! + \qmlproperty list RenderStateSet::renderStates + Holds the list of RenderState objects used by the RenderStateSet. +*/ + QRenderStateSet::QRenderStateSet(QNode *parent) : QFrameGraphNode(*new QRenderStateSetPrivate, parent) { @@ -88,10 +109,10 @@ QRenderStateSet::~QRenderStateSet() } /*! - * Adds a new QRenderState \a state to the QRenderStateSet instance. - * - * \note Not setting any QRenderState state on a QRenderStateSet instance - * implies all the render states will be disabled at render time. + Adds a new QRenderState \a state to the QRenderStateSet instance. + + \note Not setting any QRenderState state on a QRenderStateSet instance + implies all the render states will be disabled at render time. */ void QRenderStateSet::addRenderState(QRenderState *state) { @@ -116,7 +137,7 @@ void QRenderStateSet::addRenderState(QRenderState *state) } /*! - * Removes the QRenderState \a state from the QRenderStateSet instance. + Removes the QRenderState \a state from the QRenderStateSet instance. */ void QRenderStateSet::removeRenderState(QRenderState *state) { @@ -134,7 +155,7 @@ void QRenderStateSet::removeRenderState(QRenderState *state) } /*! - * Returns the list of QRenderState objects that compose the QRenderStateSet instance. + Returns the list of QRenderState objects that compose the QRenderStateSet instance. */ QVector QRenderStateSet::renderStates() const { diff --git a/src/render/framegraph/qsortpolicy.cpp b/src/render/framegraph/qsortpolicy.cpp index d293a860d..2eb0dff19 100644 --- a/src/render/framegraph/qsortpolicy.cpp +++ b/src/render/framegraph/qsortpolicy.cpp @@ -74,6 +74,7 @@ QSortPolicyPrivate::QSortPolicyPrivate() \inqmlmodule Qt3D.Render \since 5.7 \instantiates Qt3DRender::QSortPolicy + \inherits FrameGraphNode \brief Provides storage for the sort types to be used A SortPolicy class stores the sorting type used by the FrameGraph. diff --git a/src/render/framegraph/qviewport.cpp b/src/render/framegraph/qviewport.cpp index 973679615..a78e260a5 100644 --- a/src/render/framegraph/qviewport.cpp +++ b/src/render/framegraph/qviewport.cpp @@ -69,7 +69,7 @@ QViewportPrivate::QViewportPrivate() \qmltype Viewport \inqmlmodule Qt3D.Render \since 5.7 - \ingroup + \inherits FrameGraphNode \instantiates Qt3DRender::QViewport \brief A viewport on the Qt3D Scene -- cgit v1.2.3