diff options
Diffstat (limited to 'src/render/framegraph/qlayerfilter.cpp')
-rw-r--r-- | src/render/framegraph/qlayerfilter.cpp | 63 |
1 files changed, 50 insertions, 13 deletions
diff --git a/src/render/framegraph/qlayerfilter.cpp b/src/render/framegraph/qlayerfilter.cpp index 4944fb6cc..04ebca572 100644 --- a/src/render/framegraph/qlayerfilter.cpp +++ b/src/render/framegraph/qlayerfilter.cpp @@ -51,7 +51,7 @@ namespace Qt3DRender { QLayerFilterPrivate::QLayerFilterPrivate() : QFrameGraphNodePrivate() - , m_filterMode(QLayerFilter::AcceptMatchingLayers) + , m_filterMode(QLayerFilter::AcceptAnyMatchingLayers) { } @@ -67,8 +67,17 @@ QLayerFilterPrivate::QLayerFilterPrivate() the QLayerFilter and as components to Qt3DCore::QEntity. QLayerFilter can be configured to select or discard entities with a - specific QLayer depending on the filterMode property. By default, entities - referencing a QLayer that is also added to the QLayerFilter are selected. + specific \l QLayer depending on the filterMode property. By default, + entities referencing one of the \l QLayer objects that are also being + referenced by the \l QLayerFilter are selected (AcceptAnyMatchingLayers). + + Within the FrameGraph tree, multiple \l QLayerFilter nodes can be nested + within a branch going from root to a leaf. In that case the filtering will + first operate on all entities of the scene using the filtering method + specified by the first declared \l QLayerFilter. Then the filtered subset + of entities will be filtered again based on the filtering method set on the + second \l QLayerFilter declared. This is then repeated until all \l + QLayerFilter nodes of the branch have been consumed. */ /*! @@ -76,11 +85,21 @@ QLayerFilterPrivate::QLayerFilterPrivate() Specifies the rules for selecting entities to draw. - \value AcceptMatchingLayers - Accept entities that reference a QLayer added to this QLayerFilter + \value AcceptAnyMatchingLayers + Accept entities that reference one or more \l QLayer objects added to this + QLayerFilter. This is the default - \value DiscardMatchingLayers - Discard entities that reference a QLayer added to this QLayerFilter + \value AcceptAllMatchingLayers + Accept entities that reference all the \l QLayer objects added to this + QLayerFilter + + \value DiscardAnyMatchingLayers + Discard entities that reference one or more \l QLayer objects added to this + QLayerFilter + + \value DiscardAllMatchingLayers + Discard entities that reference all \l QLayer objects added to this + QLayerFilter */ /*! @@ -106,8 +125,16 @@ QLayerFilterPrivate::QLayerFilterPrivate() The LayerFilter can be configured to select or discard entities with a specific \l Layer depending on the filterMode property. By default, - entities referencing a \l Layer that is also added to the LayerFilter are - selected. + entities referencing one of the \l Layer objects that are also being + referenced by the \l LayerFilter are selected (AcceptAnyMatchingLayers). + + Within the FrameGraph tree, multiple \l LayerFilter nodes can be nested + within a branch going from root to a leaf. In that case the filtering will + first operate on all entities of the scene using the filtering method + specified by the first declared \l LayerFilter. Then the filtered subset of + entities will be filtered again based on the filtering method set on the + second \l LayerFilter declared. This is then repeated until all \l + LayerFilter nodes of the branch have been consumed. */ /*! @@ -123,11 +150,21 @@ QLayerFilterPrivate::QLayerFilterPrivate() The default value is \c {LayerFilter.AcceptMatchingLayers}. - \value LayerFilter.AcceptMatchingLayers - Accept entities that reference a \l Layer added to this LayerFilter + \value LayerFilter.AcceptAnyMatchingLayers + Accept entities that reference one or more \l Layer objects added to this + LayerFilter. This is the default + + \value LayerFilter.AcceptAllMatchingLayers + Accept entities that reference all the \l Layer objects added to this + LayerFilter + + \value LayerFilter.DiscardAnyMatchingLayers + Discard entities that reference one or more \l Layer objects added to this + LayerFilter - \value LayerFilter.DiscardMatchingLayers - Discard entities that reference a \l Layer added to this LayerFilter + \value LayerFilter.DiscardAllMatchingLayers + Discard entities that reference all \l Layer objects added to this + LayerFilter */ /*! |