1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtGui 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 QPLATFORMVULKANINSTANCE_H
41#define QPLATFORMVULKANINSTANCE_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is part of the QPA API and is not meant to be used
48// in applications. Usage of this API may make your code
49// source and binary incompatible with future versions of Qt.
50//
51
52#include <QtGui/qtguiglobal.h>
53
54#if QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC)
55
56#include <qvulkaninstance.h>
57
58QT_BEGIN_NAMESPACE
59
60class QPlatformVulkanInstancePrivate;
61
62class Q_GUI_EXPORT QPlatformVulkanInstance
63{
64 Q_DECLARE_PRIVATE(QPlatformVulkanInstance)
65
66public:
67 QPlatformVulkanInstance();
68 virtual ~QPlatformVulkanInstance();
69
70 virtual QVulkanInfoVector<QVulkanLayer> supportedLayers() const = 0;
71 virtual QVulkanInfoVector<QVulkanExtension> supportedExtensions() const = 0;
72 virtual void createOrAdoptInstance() = 0;
73 virtual bool isValid() const = 0;
74 virtual VkResult errorCode() const = 0;
75 virtual VkInstance vkInstance() const = 0;
76 virtual QByteArrayList enabledLayers() const = 0;
77 virtual QByteArrayList enabledExtensions() const = 0;
78 virtual PFN_vkVoidFunction getInstanceProcAddr(const char *name) = 0;
79 virtual bool supportsPresent(VkPhysicalDevice physicalDevice, uint32_t queueFamilyIndex, QWindow *window) = 0;
80 virtual void presentAboutToBeQueued(QWindow *window);
81 virtual void presentQueued(QWindow *window);
82 virtual void setDebugFilters(const QList<QVulkanInstance::DebugFilter> &filters);
83
84private:
85 QScopedPointer<QPlatformVulkanInstancePrivate> d_ptr;
86 Q_DISABLE_COPY(QPlatformVulkanInstance)
87};
88
89QT_END_NAMESPACE
90
91#endif // QT_CONFIG(vulkan)
92
93#if defined(Q_CLANG_QDOC)
94/*
95 The following include file did not exist for clang-qdoc running
96 in macOS, but the classes are documented in qvulkanfunctions.cpp.
97 clang-qdoc must parse the class declarations in an include file,
98 or else it can't find a place to put the documentation for the
99 classes. Apparently these classes are created at build time if
100 Vulkan is present.
101 */
102#ifndef QVULKANFUNCTIONS_H
103#define QVULKANFUNCTIONS_H
104
105#include <QtGui/qtguiglobal.h>
106
107#if QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC)
108
109#ifndef VK_NO_PROTOTYPES
110#define VK_NO_PROTOTYPES
111#endif
112#include <vulkan/vulkan.h>
113
114#include <QtCore/qscopedpointer.h>
115
116QT_BEGIN_NAMESPACE
117
118class QVulkanInstance;
119class QVulkanFunctionsPrivate;
120class QVulkanDeviceFunctionsPrivate;
121
122class Q_GUI_EXPORT QVulkanFunctions
123{
124public:
125 ~QVulkanFunctions();
126
127private:
128 Q_DISABLE_COPY(QVulkanFunctions)
129 QVulkanFunctions(QVulkanInstance *inst);
130
131 QScopedPointer<QVulkanFunctionsPrivate> d_ptr;
132 friend class QVulkanInstance;
133};
134
135class Q_GUI_EXPORT QVulkanDeviceFunctions
136{
137public:
138 ~QVulkanDeviceFunctions();
139
140private:
141 Q_DISABLE_COPY(QVulkanDeviceFunctions)
142 QVulkanDeviceFunctions(QVulkanInstance *inst, VkDevice device);
143
144 QScopedPointer<QVulkanDeviceFunctionsPrivate> d_ptr;
145 friend class QVulkanInstance;
146};
147
148QT_END_NAMESPACE
149
150#endif // QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC)
151#endif // QVULKANFUNCTIONS_H;
152#endif // Q_CLANG_QDOC
153
154#endif // QPLATFORMVULKANINSTANCE_H
155