1/****************************************************************************
2**
3** Copyright (C) 2016 Klaralvdalens Datakonsult AB (KDAB).
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DRENDER_RENDER_RENDERVIEWBUILDER_H
41#define QT3DRENDER_RENDER_RENDERVIEWBUILDER_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <functional>
55#include <Qt3DCore/qaspectjob.h>
56#include <Qt3DRender/private/filterentitybycomponentjob_p.h>
57#include <Qt3DRender/private/filterlayerentityjob_p.h>
58#include <Qt3DRender/private/genericlambdajob_p.h>
59#include <Qt3DRender/private/materialparametergathererjob_p.h>
60#include <Qt3DRender/private/nodemanagers_p.h>
61#include <Qt3DRender/private/renderviewbuilderjob_p.h>
62#include <Qt3DRender/private/renderview_p.h>
63#include <Qt3DRender/private/frustumcullingjob_p.h>
64#include <Qt3DRender/private/lightgatherer_p.h>
65#include <Qt3DRender/private/filterproximitydistancejob_p.h>
66
67QT_BEGIN_NAMESPACE
68
69namespace Qt3DRender {
70
71namespace Render {
72
73class Renderer;
74
75using SynchronizerJobPtr = GenericLambdaJobPtr<std::function<void()>>;
76using ComputableEntityFilterPtr = FilterEntityByComponentJobPtr<Render::ComputeCommand, Render::Material>;
77using RenderableEntityFilterPtr = FilterEntityByComponentJobPtr<Render::GeometryRenderer, Render::Material>;
78
79class Q_AUTOTEST_EXPORT RenderViewBuilder
80{
81public:
82 explicit RenderViewBuilder(Render::FrameGraphNode *leafNode, int renderViewIndex, Renderer *renderer);
83
84 RenderViewInitializerJobPtr renderViewJob() const;
85 FilterLayerEntityJobPtr filterEntityByLayerJob() const;
86 LightGathererPtr lightGathererJob() const;
87 RenderableEntityFilterPtr renderableEntityFilterJob() const;
88 ComputableEntityFilterPtr computableEntityFilterJob() const;
89 FrustumCullingJobPtr frustumCullingJob() const;
90 QVector<RenderViewBuilderJobPtr> renderViewBuilderJobs() const;
91 QVector<MaterialParameterGathererJobPtr> materialGathererJobs() const;
92 SynchronizerJobPtr syncRenderViewInitializationJob() const;
93 SynchronizerJobPtr syncFrustumCullingJob() const;
94 SynchronizerJobPtr syncRenderCommandBuildingJob() const;
95 SynchronizerJobPtr syncRenderViewCommandBuildersJob() const;
96 SynchronizerJobPtr setClearDrawBufferIndexJob() const;
97 SynchronizerJobPtr syncFilterEntityByLayerJob() const;
98 FilterProximityDistanceJobPtr filterProximityJob() const;
99 SynchronizerJobPtr syncMaterialGathererJob() const;
100
101 void prepareJobs();
102 QVector<Qt3DCore::QAspectJobPtr> buildJobHierachy() const;
103
104 Renderer *renderer() const;
105 int renderViewIndex() const;
106
107 void setLayerCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
108 bool layerCacheNeedsToBeRebuilt() const;
109 void setMaterialGathererCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
110 bool materialGathererCacheNeedsToBeRebuilt() const;
111
112 void setRenderableCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
113 bool renderableCacheNeedsToBeRebuilt() const;
114
115 void setComputableCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
116 bool computableCacheNeedsToBeRebuilt() const;
117
118 void setLightGathererCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
119 bool lightGathererCacheNeedsToBeRebuilt() const;
120
121 static int optimalJobCount();
122 static QVector<Entity *> entitiesInSubset(const QVector<Entity *> &entities, const QVector<Entity *> &subset);
123
124private:
125 Render::FrameGraphNode *m_leafNode;
126 const int m_renderViewIndex;
127 Renderer *m_renderer;
128 bool m_layerCacheNeedsToBeRebuilt;
129 bool m_materialGathererCacheNeedsToBeRebuilt;
130 bool m_lightsCacheNeedsToBeRebuilt;
131 bool m_renderableCacheNeedsToBeRebuilt;
132 bool m_computableCacheNeedsToBeRebuilt;
133
134 RenderViewInitializerJobPtr m_renderViewJob;
135 FilterLayerEntityJobPtr m_filterEntityByLayerJob;
136 LightGathererPtr m_lightGathererJob;
137 RenderableEntityFilterPtr m_renderableEntityFilterJob;
138 ComputableEntityFilterPtr m_computableEntityFilterJob;
139 FrustumCullingJobPtr m_frustumCullingJob;
140 QVector<RenderViewBuilderJobPtr> m_renderViewBuilderJobs;
141 QVector<MaterialParameterGathererJobPtr> m_materialGathererJobs;
142
143 SynchronizerJobPtr m_syncRenderViewInitializationJob;
144 SynchronizerJobPtr m_syncFrustumCullingJob;
145 SynchronizerJobPtr m_syncRenderCommandBuildingJob;
146 SynchronizerJobPtr m_syncRenderViewCommandBuildersJob;
147 SynchronizerJobPtr m_setClearDrawBufferIndexJob;
148 SynchronizerJobPtr m_syncFilterEntityByLayerJob;
149 SynchronizerJobPtr m_syncMaterialGathererJob;
150 FilterProximityDistanceJobPtr m_filterProximityJob;
151
152 SynchronizerJobPtr m_cacheRenderableEntitiesJob;
153 SynchronizerJobPtr m_cacheComputableEntitiesJob;
154 SynchronizerJobPtr m_cacheLightsJob;
155
156 static const int m_optimalParallelJobCount;
157};
158
159} // Render
160
161} // Qt3DRender
162
163QT_END_NAMESPACE
164
165#endif // QT3DRENDER_RENDER_RENDERVIEWBUILDER_H
166