blob: c36e4039c5bdbb227061f65aa1a15444ec3834e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/****************************************************************************
**
** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt3D module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qcomputecommand.h"
#include "qcomputecommand_p.h"
QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
\class Qt3DRender::QComputeCommand
\since 5.7
\inmodule Qt3DRender
\brief QComponent to issue work for the compute shader on GPU
A Qt3DRender::QComputeCommand is used to issue work for the compute shader.
The compute shader is specified in the QMaterial component of the same entity the
QComputeCommand is added to. The workGroupX, workGroupY and workGroupZ properties
specify the work group sizes for the compute shader invocation. Qt3DRender::QDispatchCompute
node needs to be present in the FrameGraph to actually issue the commands.
*/
/*!
\qmltype ComputeCommand
\since 5.7
\inmodule Qt3DRender
\inherits Component3D
\instantiates Qt3DRender::QComputeCommand
\brief Component to issue work for the compute shader on GPU
A ComputeCommand is used to issue work for the compute shader.
The compute shader is specified in the Material component of the same entity the
ComputeCommand is added to. The workGroupX, workGroupY and workGroupZ properties
specify the work group sizes for the compute shader invocation. DispatchCompute
node needs to be present in the FrameGraph to actually issue the commands.
*/
/*!
\qmlproperty int ComputeCommand::workGroupX
Specifies X workgroup size.
*/
/*!
\qmlproperty int ComputeCommand::workGroupY
Specifies Y workgroup size.
*/
/*!
\qmlproperty int ComputeCommand::workGroupZ
Specifies Z workgroup size.
*/
/*!
\property QComputeCommand::workGroupX
Specifies X workgroup size.
*/
/*!
\property QComputeCommand::workGroupY
Specifies Y workgroup size.
*/
/*!
\property QComputeCommand::workGroupZ
Specifies Z workgroup size.
*/
QComputeCommandPrivate::QComputeCommandPrivate()
: Qt3DCore::QComponentPrivate()
, m_workGroupX(1)
, m_workGroupY(1)
, m_workGroupZ(1)
{
}
/*!
The constructor creates a new Qt3DRender::QComputeCommand instance with the
specified \a parent.
*/
QComputeCommand::QComputeCommand(Qt3DCore::QNode *parent)
: Qt3DCore::QComponent(*new QComputeCommandPrivate, parent)
{
}
/*! \internal */
QComputeCommand::~QComputeCommand()
{
}
int QComputeCommand::workGroupX() const
{
Q_D(const QComputeCommand);
return d->m_workGroupX;
}
int QComputeCommand::workGroupY() const
{
Q_D(const QComputeCommand);
return d->m_workGroupY;
}
int QComputeCommand::workGroupZ() const
{
Q_D(const QComputeCommand);
return d->m_workGroupZ;
}
/*!
Sets the workgroup for the first dimension to \a workGroupX.
*/
void QComputeCommand::setWorkGroupX(int workGroupX)
{
Q_D(QComputeCommand);
if (d->m_workGroupX != workGroupX) {
d->m_workGroupX = workGroupX;
emit workGroupXChanged();
}
}
/*!
Sets the workgroup for the second dimension to \a workGroupY.
*/
void QComputeCommand::setWorkGroupY(int workGroupY)
{
Q_D(QComputeCommand);
if (d->m_workGroupY != workGroupY) {
d->m_workGroupY = workGroupY;
emit workGroupYChanged();
}
}
/*!
Sets the workgroup for the third dimension to \a workGroupZ.
*/
void QComputeCommand::setWorkGroupZ(int workGroupZ)
{
Q_D(QComputeCommand);
if (d->m_workGroupZ != workGroupZ) {
d->m_workGroupZ = workGroupZ;
emit workGroupZChanged();
}
}
Qt3DCore::QNodeCreatedChangeBasePtr QComputeCommand::createNodeCreationChange() const
{
auto creationChange = Qt3DCore::QNodeCreatedChangePtr<QComputeCommandData>::create(this);
auto &data = creationChange->data;
Q_D(const QComputeCommand);
data.workGroupX = d->m_workGroupX;
data.workGroupY = d->m_workGroupY;
data.workGroupZ = d->m_workGroupZ;
return creationChange;
}
} // Render
QT_END_NAMESPACE
|
