1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 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_QRENDERTARGETOUTPUT_H
41 #define QT3DRENDER_QRENDERTARGETOUTPUT_H
42 
43 #include <Qt3DCore/qnode.h>
44 #include <Qt3DRender/qt3drender_global.h>
45 #include <Qt3DRender/QAbstractTexture>
46 
47 QT_BEGIN_NAMESPACE
48 
49 namespace Qt3DRender {
50 
51 class QAbstractTexture;
52 class QRenderTargetOutputPrivate;
53 
54 class Q_3DRENDERSHARED_EXPORT QRenderTargetOutput : public Qt3DCore::QNode
55 {
56     Q_OBJECT
57     Q_PROPERTY(AttachmentPoint attachmentPoint READ attachmentPoint WRITE setAttachmentPoint NOTIFY attachmentPointChanged)
58     Q_PROPERTY(QAbstractTexture *texture READ texture WRITE setTexture NOTIFY textureChanged)
59     Q_PROPERTY(int mipLevel READ mipLevel WRITE setMipLevel NOTIFY mipLevelChanged)
60     Q_PROPERTY(int layer READ layer WRITE setLayer NOTIFY layerChanged)
61     Q_PROPERTY(Qt3DRender::QAbstractTexture::CubeMapFace face READ face WRITE setFace NOTIFY faceChanged)
62 
63 public:
64     enum AttachmentPoint {
65         Color0 = 0,
66         Color1,
67         Color2,
68         Color3,
69         Color4,
70         Color5,
71         Color6,
72         Color7,
73         Color8,
74         Color9,
75         Color10,
76         Color11,
77         Color12,
78         Color13,
79         Color14,
80         Color15,
81         Depth,
82         Stencil,
83         DepthStencil
84     };
85     Q_ENUM(AttachmentPoint) // LCOV_EXCL_LINE
86 
87     explicit QRenderTargetOutput(Qt3DCore::QNode *parent = nullptr);
88     ~QRenderTargetOutput();
89 
90     AttachmentPoint attachmentPoint() const;
91     QAbstractTexture *texture() const;
92     int mipLevel() const;
93     int layer() const;
94     QAbstractTexture::CubeMapFace face() const;
95 
96 public Q_SLOTS:
97     void setAttachmentPoint(AttachmentPoint attachmentPoint);
98     void setTexture(QAbstractTexture *texture);
99     void setMipLevel(int level);
100     void setLayer(int layer);
101     void setFace(QAbstractTexture::CubeMapFace face);
102 
103 Q_SIGNALS:
104     void attachmentPointChanged(AttachmentPoint attachmentPoint);
105     void textureChanged(QAbstractTexture *texture);
106     void mipLevelChanged(int mipLevel);
107     void layerChanged(int layer);
108     void faceChanged(QAbstractTexture::CubeMapFace face);
109 
110 protected:
111     explicit QRenderTargetOutput(QRenderTargetOutputPrivate &dd, Qt3DCore::QNode *parent = nullptr);
112 
113 private:
114     Qt3DCore::QNodeCreatedChangeBasePtr createNodeCreationChange() const override;
115     Q_DECLARE_PRIVATE(QRenderTargetOutput)
116 };
117 
118 } // namespace Qt3DRender
119 
120 QT_END_NAMESPACE
121 
122 Q_DECLARE_METATYPE(Qt3DRender::QRenderTargetOutput::AttachmentPoint) // LCOV_EXCL_LINE
123 
124 #endif // QT3DRENDER_QRENDERTARGETOUTPUT_H
125