diff options
Diffstat (limited to 'src/quick/items/qquickgraphicsdevice.cpp')
| -rw-r--r-- | src/quick/items/qquickgraphicsdevice.cpp | 91 |
1 files changed, 43 insertions, 48 deletions
diff --git a/src/quick/items/qquickgraphicsdevice.cpp b/src/quick/items/qquickgraphicsdevice.cpp index 186df37579..84eeb3e69e 100644 --- a/src/quick/items/qquickgraphicsdevice.cpp +++ b/src/quick/items/qquickgraphicsdevice.cpp @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the QtQuick 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$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only #include "qquickgraphicsdevice_p.h" @@ -109,8 +73,13 @@ bool QQuickGraphicsDevice::isNull() const \return a new QQuickGraphicsDevice referencing an existing OpenGL \a context. This factory function is suitable for OpenGL. + + \note It is up the caller to ensure that \a context is going to be + compatible and usable with the QQuickWindow. Platform-specific mismatches in + the associated QSurfaceFormat, or threading issues due to attempting to use + \a context on multiple threads are up to the caller to avoid. */ -#if QT_CONFIG(opengl) || defined(Q_CLANG_QDOC) +#if QT_CONFIG(opengl) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromOpenGLContext(QOpenGLContext *context) { QQuickGraphicsDevice dev; @@ -124,13 +93,16 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromOpenGLContext(QOpenGLContext *con /*! \return a new QQuickGraphicsDevice describing a DXGI adapter and D3D feature level. - This factory function is suitable for Direct3D 11, particularly in + This factory function is suitable for Direct3D 11 and 12, particularly in combination with OpenXR. \a adapterLuidLow and \a adapterLuidHigh together specify a LUID, while a featureLevel specifies a \c{D3D_FEATURE_LEVEL_} value. \a featureLevel can be set to 0 if it is not intended to be specified, in which case the scene graph's defaults will be used. + + \note With Direct 3D 12 \a featureLevel specifies the \c minimum feature + level passed on to D3D12CreateDevice(). */ -#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC) +#if defined(Q_OS_WIN) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromAdapter(quint32 adapterLuidLow, qint32 adapterLuidHigh, int featureLevel) @@ -151,11 +123,15 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromAdapter(quint32 adapterLuidLow, be a \c{ID3D11Device*}, \a context is expected to be a \c{ID3D11DeviceContext*}. + It also supports Direct 3D 12, if that is the 3D API used at run time. With + D3D12 \a context is unused and can be set to null. \a device is expected to + be a \c{ID3D12Device*}. + \note the resulting QQuickGraphicsDevice does not own any native resources, it merely contains references. It is the caller's responsibility to ensure that the native resource exists as long as necessary. */ -#if defined(Q_OS_WIN) || defined(Q_CLANG_QDOC) +#if defined(Q_OS_WIN) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceAndContext(void *device, void *context) { QQuickGraphicsDevice dev; @@ -177,7 +153,7 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceAndContext(void *device, vo that the native resource exists as long as necessary. */ -#if defined(Q_OS_MACOS) || defined(Q_OS_IOS) || defined(Q_CLANG_QDOC) +#if QT_CONFIG(metal) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceAndCommandQueue(MTLDevice *device, MTLCommandQueue *commandQueue) { @@ -199,7 +175,7 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceAndCommandQueue(MTLDevice * it merely contains references. It is the caller's responsibility to ensure that the native resource exists as long as necessary. */ -#if QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC) +#if QT_CONFIG(vulkan) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromPhysicalDevice(VkPhysicalDevice physicalDevice) { QQuickGraphicsDevice dev; @@ -221,7 +197,7 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromPhysicalDevice(VkPhysicalDevice p it merely contains references. It is the caller's responsibility to ensure that the native resource exists as long as necessary. */ -#if QT_CONFIG(vulkan) || defined(Q_CLANG_QDOC) +#if QT_CONFIG(vulkan) || defined(Q_QDOC) QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceObjects(VkPhysicalDevice physicalDevice, VkDevice device, int queueFamilyIndex, @@ -235,15 +211,34 @@ QQuickGraphicsDevice QQuickGraphicsDevice::fromDeviceObjects(VkPhysicalDevice ph } #endif +/*! + \return a new QQuickGraphicsDevice referencing an existing \a rhi object. + + \note Similarly to fromOpenGLContext(), the caller must be careful to only + share a QRhi (and so the underlying graphics context or device) between + QQuickWindows that are known to be compatible, not breaking the underlying + graphics API's rules when it comes to threading, pixel formats, etc. + + \since 6.6 +*/ +QQuickGraphicsDevice QQuickGraphicsDevice::fromRhi(QRhi *rhi) +{ + QQuickGraphicsDevice dev; + QQuickGraphicsDevicePrivate *d = QQuickGraphicsDevicePrivate::get(&dev); + d->type = QQuickGraphicsDevicePrivate::Type::Rhi; + d->u.rhi = rhi; + return dev; +} + QQuickGraphicsDevicePrivate::QQuickGraphicsDevicePrivate() : ref(1) { } -QQuickGraphicsDevicePrivate::QQuickGraphicsDevicePrivate(const QQuickGraphicsDevicePrivate *other) +QQuickGraphicsDevicePrivate::QQuickGraphicsDevicePrivate(const QQuickGraphicsDevicePrivate &other) : ref(1), - type(other->type), - u(other->u) + type(other.type), + u(other.u) { } |