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_OPENGL_RENDERVIEWBUILDER_H
41#define QT3DRENDER_RENDER_OPENGL_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/filterlayerentityjob_p.h>
57#include <Qt3DRender/private/genericlambdajob_p.h>
58#include <Qt3DRender/private/nodemanagers_p.h>
59#include <Qt3DRender/private/frustumcullingjob_p.h>
60#include <Qt3DRender/private/filterproximitydistancejob_p.h>
61#include <renderviewcommandbuilderjob_p.h>
62#include <renderviewcommandupdaterjob_p.h>
63#include <materialparametergathererjob_p.h>
64#include <renderview_p.h>
65
66QT_BEGIN_NAMESPACE
67
68namespace Qt3DRender {
69
70namespace Render {
71
72namespace OpenGL {
73
74class Renderer;
75
76using SynchronizerJobPtr = GenericLambdaJobPtr<std::function<void()>>;
77#define CreateSynchronizerJobPtr(lambda, type, instance) \
78 SynchronizerJobPtr::create(lambda, type, #type, instance)
79
80class Q_AUTOTEST_EXPORT RenderViewBuilder
81{
82public:
83 explicit RenderViewBuilder(Render::FrameGraphNode *leafNode, int renderViewIndex, Renderer *renderer);
84
85 RenderViewInitializerJobPtr renderViewJob() const;
86 FilterLayerEntityJobPtr filterEntityByLayerJob() const;
87 FrustumCullingJobPtr frustumCullingJob() const;
88 QVector<RenderViewCommandBuilderJobPtr> renderViewCommandBuilderJobs() const;
89 QVector<RenderViewCommandUpdaterJobPtr> renderViewCommandUpdaterJobs() const;
90 QVector<MaterialParameterGathererJobPtr> materialGathererJobs() const;
91 SynchronizerJobPtr syncRenderViewPostInitializationJob() const;
92 SynchronizerJobPtr syncPreFrustumCullingJob() const;
93 SynchronizerJobPtr syncRenderViewPreCommandBuildingJob() const;
94 SynchronizerJobPtr syncRenderViewPreCommandUpdateJob() const;
95 SynchronizerJobPtr syncRenderViewPostCommandUpdateJob() 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 void setRenderCommandCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
112 bool renderCommandCacheNeedsToBeRebuilt() const;
113 void setLightCacheNeedsToBeRebuilt(bool needsToBeRebuilt);
114 bool lightCacheNeedsToBeRebuilt() const;
115
116 static int defaultJobCount();
117 int optimalJobCount() const;
118 void setOptimalJobCount(int v);
119
120 static QVector<Entity *> entitiesInSubset(const QVector<Entity *> &entities, const QVector<Entity *> &subset);
121
122private:
123 Render::FrameGraphNode *m_leafNode;
124 const int m_renderViewIndex;
125 Renderer *m_renderer;
126 RebuildFlagSet m_rebuildFlags;
127
128 RenderViewInitializerJobPtr m_renderViewJob;
129 FilterLayerEntityJobPtr m_filterEntityByLayerJob;
130 FrustumCullingJobPtr m_frustumCullingJob;
131 QVector<RenderViewCommandBuilderJobPtr> m_renderViewCommandBuilderJobs;
132 QVector<RenderViewCommandUpdaterJobPtr> m_renderViewCommandUpdaterJobs;
133 QVector<MaterialParameterGathererJobPtr> m_materialGathererJobs;
134
135 SynchronizerJobPtr m_syncRenderViewPostInitializationJob;
136 SynchronizerJobPtr m_syncPreFrustumCullingJob;
137 SynchronizerJobPtr m_syncRenderViewPreCommandBuildingJob;
138 SynchronizerJobPtr m_syncRenderViewPreCommandUpdateJob;
139 SynchronizerJobPtr m_syncRenderViewPostCommandUpdateJob;
140 SynchronizerJobPtr m_setClearDrawBufferIndexJob;
141 SynchronizerJobPtr m_syncFilterEntityByLayerJob;
142 SynchronizerJobPtr m_syncMaterialGathererJob;
143 FilterProximityDistanceJobPtr m_filterProximityJob;
144
145 int m_optimalParallelJobCount;
146};
147
148} // OpenGL
149
150} // Render
151
152} // Qt3DRender
153
154QT_END_NAMESPACE
155
156#endif // QT3DRENDER_RENDER_OPENGL_RENDERVIEWBUILDER_H
157

source code of qt3d/src/plugins/renderers/opengl/renderer/renderviewbuilder_p.h