1/****************************************************************************
2**
3** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
4** Copyright (C) 2016 The Qt Company Ltd and/or its subsidiary(-ies).
5** Contact: https://www.qt.io/licensing/
6**
7** This file is part of the Qt3D module of the Qt Toolkit.
8**
9** $QT_BEGIN_LICENSE:LGPL$
10** Commercial License Usage
11** Licensees holding valid commercial Qt licenses may use this file in
12** accordance with the commercial license agreement provided with the
13** Software or, alternatively, in accordance with the terms contained in
14** a written agreement between you and The Qt Company. For licensing terms
15** and conditions see https://www.qt.io/terms-conditions. For further
16** information use the contact form at https://www.qt.io/contact-us.
17**
18** GNU Lesser General Public License Usage
19** Alternatively, this file may be used under the terms of the GNU Lesser
20** General Public License version 3 as published by the Free Software
21** Foundation and appearing in the file LICENSE.LGPL3 included in the
22** packaging of this file. Please review the following information to
23** ensure the GNU Lesser General Public License version 3 requirements
24** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
25**
26** GNU General Public License Usage
27** Alternatively, this file may be used under the terms of the GNU
28** General Public License version 2.0 or (at your option) the GNU General
29** Public license version 3 or any later version approved by the KDE Free
30** Qt Foundation. The licenses are as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
32** included in the packaging of this file. Please review the following
33** information to ensure the GNU General Public License requirements will
34** be met: https://www.gnu.org/licenses/gpl-2.0.html and
35** https://www.gnu.org/licenses/gpl-3.0.html.
36**
37** $QT_END_LICENSE$
38**
39****************************************************************************/
40
41#ifndef QT3DRENDER_RENDER_RENDERSTATE_H
42#define QT3DRENDER_RENDER_RENDERSTATE_H
43
44//
45// W A R N I N G
46// -------------
47//
48// This file is not part of the Qt API. It exists for the convenience
49// of other Qt classes. This header file may change from version to
50// version without notice, or even be removed.
51//
52// We mean it.
53//
54
55#include <Qt3DRender/private/genericstate_p.h>
56#include <Qt3DRender/private/renderstates_p.h>
57#include <Qt3DRender/private/statevariant_p.h>
58#include <QVector>
59
60QT_BEGIN_NAMESPACE
61
62namespace Qt3DRender {
63
64class QRenderState;
65
66namespace Render {
67
68class RenderState;
69
70class RenderStateSet
71{
72public:
73 RenderStateSet();
74 ~RenderStateSet();
75
76 template<typename GenericState>
77 void addState(const GenericState &state)
78 {
79 addState(StateVariant::fromValue(state));
80 }
81
82 /**
83 * @brief changeCost - metric of cost to change to this state-set from
84 * a candidate previous state-set. This is used to find an optimal
85 * ordering of state-sets when sending draw commands.
86 * @param previousState
87 * @return
88 */
89 int changeCost(RenderStateSet* previousState);
90
91 StateMaskSet stateMask() const;
92 void merge(RenderStateSet *other);
93
94 QVector<StateVariant> states() const { return m_states; }
95
96 bool hasStateOfType(StateMask type) const;
97
98
99 /**
100 * @brief contains - check if this set contains a matching piece of state
101 * @param ds
102 * @return
103 */
104 bool contains(const StateVariant &ds) const;
105private:
106 StateMaskSet m_stateMask;
107 QVector<StateVariant> m_states;
108};
109
110template<>
111void RenderStateSet::addState<StateVariant>(const StateVariant &state);
112
113} // namespace Render
114} // namespace Qt3DRender
115
116QT_END_NAMESPACE
117
118#endif // QT3DRENDER_RENDER_RENDERSTATE_H
119