1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 QSGRENDERERINTERFACE_H
41#define QSGRENDERERINTERFACE_H
42
43#include <QtQuick/qsgnode.h>
44
45QT_BEGIN_NAMESPACE
46
47class QQuickWindow;
48
49class Q_QUICK_EXPORT QSGRendererInterface
50{
51public:
52 enum GraphicsApi {
53 Unknown,
54 Software,
55 OpenGL,
56 Direct3D12,
57 OpenVG,
58 OpenGLRhi,
59 Direct3D11Rhi,
60 VulkanRhi,
61 MetalRhi,
62 NullRhi,
63 };
64
65 enum Resource {
66 DeviceResource,
67 CommandQueueResource,
68 CommandListResource,
69 PainterResource,
70 RhiResource,
71 PhysicalDeviceResource,
72 OpenGLContextResource,
73 DeviceContextResource,
74 CommandEncoderResource,
75 VulkanInstanceResource
76 };
77
78 enum ShaderType {
79 UnknownShadingLanguage,
80 GLSL,
81 HLSL,
82 RhiShader
83 };
84
85 enum ShaderCompilationType {
86 RuntimeCompilation = 0x01,
87 OfflineCompilation = 0x02
88 };
89 Q_DECLARE_FLAGS(ShaderCompilationTypes, ShaderCompilationType)
90
91 enum ShaderSourceType {
92 ShaderSourceString = 0x01,
93 ShaderSourceFile = 0x02,
94 ShaderByteCode = 0x04
95 };
96 Q_DECLARE_FLAGS(ShaderSourceTypes, ShaderSourceType)
97
98 virtual ~QSGRendererInterface();
99
100 virtual GraphicsApi graphicsApi() const = 0;
101
102 virtual void *getResource(QQuickWindow *window, Resource resource) const;
103 virtual void *getResource(QQuickWindow *window, const char *resource) const;
104
105 virtual ShaderType shaderType() const = 0;
106 virtual ShaderCompilationTypes shaderCompilationType() const = 0;
107 virtual ShaderSourceTypes shaderSourceType() const = 0;
108
109 static bool isApiRhiBased(GraphicsApi api);
110};
111
112Q_DECLARE_OPERATORS_FOR_FLAGS(QSGRendererInterface::ShaderCompilationTypes)
113Q_DECLARE_OPERATORS_FOR_FLAGS(QSGRendererInterface::ShaderSourceTypes)
114
115QT_END_NAMESPACE
116
117#endif
118