| /**************************************************************************** |
| ** |
| ** 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 "qdispatchcompute.h" |
| #include "qdispatchcompute_p.h" |
| #include <Qt3DRender/qframegraphnodecreatedchange.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| namespace Qt3DRender { |
| /*! |
| \class Qt3DRender::QDispatchCompute |
| \inmodule Qt3DRender |
| \since 5.7 |
| \ingroup framegraph |
| \brief FrameGraph node to issue work for the compute shader on GPU. |
| |
| A Qt3DRender::QDispatchCompute allows work to be issued for the compute shader to |
| run on the GPU. The workGroupX, workGroupY and workGroupZ properties specify the work group |
| sizes for the compute shader invocation. QComputeCommand components need to be added |
| to entities to instruct Qt3D to select the materials and geometry from the entities |
| for the compute invocation. The work group sizes for the shader invocation will be |
| the maximum of the work group sizes specified in QDispatchCompute and QComputeCommand. |
| |
| */ |
| |
| /*! |
| \qmltype DispatchCompute |
| \inqmlmodule Qt3D.Render |
| \instantiates Qt3DRender::QDispatchCompute |
| \inherits FrameGraphNode |
| \since 5.7 |
| \brief FrameGraph node to issue work for the compute shader on GPU. |
| |
| A DispatchCompute allows work to be issued for the compute shader to run on the GPU. |
| The workGroupX, workGroupY and workGroupZ properties specify the work group sizes for |
| the compute shader invocation. ComputeCommand components need to be added |
| to entities to instruct Qt3D to select the materials and geometry from the entities |
| for the compute invocation. The work group sizes for the shader invocation will be |
| the maximum of the work group sizes specified in DispatchCompute and ComputeCommand. |
| */ |
| |
| /*! |
| \qmlproperty int DispatchCompute::workGroupX |
| Specifies X workgroup size. |
| */ |
| |
| /*! |
| \qmlproperty int DispatchCompute::workGroupY |
| Specifies Y workgroup size. |
| */ |
| |
| /*! |
| \qmlproperty int DispatchCompute::workGroupZ |
| Specifies Z workgroup size. |
| */ |
| |
| /*! |
| The constructor creates an instance with the specified \a parent. |
| */ |
| QDispatchCompute::QDispatchCompute(Qt3DCore::QNode *parent) |
| : QFrameGraphNode(*new QDispatchComputePrivate(), parent) |
| { |
| } |
| |
| /*! \internal */ |
| QDispatchCompute::~QDispatchCompute() |
| { |
| } |
| |
| int QDispatchCompute::workGroupX() const |
| { |
| Q_D(const QDispatchCompute); |
| return d->m_workGroupX; |
| } |
| |
| int QDispatchCompute::workGroupY() const |
| { |
| Q_D(const QDispatchCompute); |
| return d->m_workGroupY; |
| } |
| |
| int QDispatchCompute::workGroupZ() const |
| { |
| Q_D(const QDispatchCompute); |
| return d->m_workGroupZ; |
| } |
| |
| /*! |
| \property Qt3DRender::QDispatchCompute::workGroupX |
| Specifies X workgroup. |
| */ |
| void QDispatchCompute::setWorkGroupX(int workGroupX) |
| { |
| Q_D(QDispatchCompute); |
| if (d->m_workGroupX != workGroupX) { |
| d->m_workGroupX = workGroupX; |
| emit workGroupXChanged(); |
| } |
| } |
| |
| /*! |
| \property Qt3DRender::QDispatchCompute::workGroupY |
| Specifies Y workgroup. |
| */ |
| void QDispatchCompute::setWorkGroupY(int workGroupY) |
| { |
| Q_D(QDispatchCompute); |
| if (d->m_workGroupY != workGroupY) { |
| d->m_workGroupY = workGroupY; |
| emit workGroupYChanged(); |
| } |
| } |
| |
| /*! |
| \property Qt3DRender::QDispatchCompute::workGroupZ |
| Specifies Z workgroup. |
| */ |
| void QDispatchCompute::setWorkGroupZ(int workGroupZ) |
| { |
| Q_D(QDispatchCompute); |
| if (d->m_workGroupZ != workGroupZ) { |
| d->m_workGroupZ = workGroupZ; |
| emit workGroupZChanged(); |
| } |
| |
| } |
| |
| Qt3DCore::QNodeCreatedChangeBasePtr QDispatchCompute::createNodeCreationChange() const |
| { |
| auto creationChange = QFrameGraphNodeCreatedChangePtr<QDispatchComputeData>::create(this); |
| auto &data = creationChange->data; |
| Q_D(const QDispatchCompute); |
| data.workGroupX = d->m_workGroupX; |
| data.workGroupY = d->m_workGroupY; |
| data.workGroupZ = d->m_workGroupZ; |
| return creationChange; |
| } |
| |
| } // Qt3DRender |
| |
| QT_END_NAMESPACE |
| |