diff options
Diffstat (limited to 'src/quick/items/qquickgraphicsinfo.cpp')
| -rw-r--r-- | src/quick/items/qquickgraphicsinfo.cpp | 306 |
1 files changed, 306 insertions, 0 deletions
diff --git a/src/quick/items/qquickgraphicsinfo.cpp b/src/quick/items/qquickgraphicsinfo.cpp new file mode 100644 index 0000000000..2dbad82acf --- /dev/null +++ b/src/quick/items/qquickgraphicsinfo.cpp @@ -0,0 +1,306 @@ +/**************************************************************************** +** +** Copyright (C) 2016 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$ +** +****************************************************************************/ + +#include "qquickgraphicsinfo_p.h" +#include "qquickwindow.h" +#include "qquickitem.h" +#include <QtGui/qopenglcontext.h> + +QT_BEGIN_NAMESPACE + +/*! + \qmltype GraphicsInfo + \instantiates QQuickGraphicsInfo + \inqmlmodule QtQuick + \ingroup qtquick-visual + \since 5.8 + \since QtQuick 2.8 + \brief Provides information about the used Qt Quick backend + + The GraphicsInfo attached type provides information about the scenegraph + backend used to render the contents of the associated window. + + If the item to which the properties are attached is not currently + associated with any window, the properties are set to default values. When + the associated window changes, the properties will update. + */ + +QQuickGraphicsInfo::QQuickGraphicsInfo(QQuickItem *item) + : QObject(item) + , m_window(0) + , m_api(Unknown) + , m_shaderType(UnknownShadingLanguage) + , m_shaderCompilationType(ShaderCompilationType(0)) + , m_shaderSourceType(ShaderSourceType(0)) + , m_majorVersion(2) + , m_minorVersion(0) + , m_profile(NoProfile) + , m_renderableType(SurfaceFormatUnspecified) +{ + connect(item, SIGNAL(windowChanged(QQuickWindow*)), this, SLOT(setWindow(QQuickWindow*))); + setWindow(item->window()); +} + +QQuickGraphicsInfo *QQuickGraphicsInfo::qmlAttachedProperties(QObject *object) +{ + if (QQuickItem *item = qobject_cast<QQuickItem *>(object)) + return new QQuickGraphicsInfo(item); + + return nullptr; +} + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::api + + This property describes the graphics API that is currently in use. + + The possible values are: + \list + \li GraphicsInfo.Unknown - the default value when no active scenegraph is associated with the item + \li GraphicsInfo.Software - Qt Quick's software renderer based on QPainter with the raster paint engine + \li GraphicsInfo.OpenGL - OpenGL or OpenGL ES + \li GraphicsInfo.Direct3D12 - Direct3D 12 + \endlist + */ + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::shaderType + + This property contains the shading language supported by the Qt Quick + backend the application is using. + + \list + \li GraphicsInfo.UnknownShadingLanguage - Not yet known due to no window and scenegraph associated + \li GraphicsInfo.GLSL - GLSL or GLSL ES + \li GraphicsInfo.HLSL - HLSL + \endlist + + \note The value is only up-to-date once the item is associated with a + window and the window's scenegraph has initialized. Bindings relying on the + value have to keep this in mind since the value may change from + GraphicsInfo.UnknownShadingLanguage to the actual value after component + initialization is complete. This is particularly relevant for ShaderEffect + items inside ShaderEffectSource items set as property values. + + \since 5.8 + \since QtQuick 2.8 + + \sa shaderCompilationType, shaderSourceType +*/ + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::shaderCompilationType + + This property contains a bitmask of the shader compilation approaches + supported by the Qt Quick backend the application is using. + + \list + \li GraphicsInfo.RuntimeCompilation + \li GraphicsInfo.OfflineCompilation + \endlist + + With OpenGL the value is GraphicsInfo.RuntimeCompilation, which corresponds + to the traditional way of using ShaderEffect. Non-OpenGL backends are + expected to focus more on GraphicsInfo.OfflineCompilation, however. + + \note The value is only up-to-date once the item is associated with a + window and the window's scenegraph has initialized. Bindings relying on the + value have to keep this in mind since the value may change from \c 0 to the + actual bitmask after component initialization is complete. This is + particularly relevant for ShaderEffect items inside ShaderEffectSource + items set as property values. + + \since 5.8 + \since QtQuick 2.8 + + \sa shaderType, shaderSourceType +*/ + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::shaderSourceType + + This property contains a bitmask of the supported ways of providing shader + sources. + + \list + \li GraphicsInfo.ShaderSourceString + \li GraphicsInfo.ShaderSourceFile + \li GraphicsInfo.ShaderByteCode + \endlist + + With OpenGL the value is GraphicsInfo.ShaderSourceString, which corresponds + to the traditional way of inlining GLSL source code into QML. Other, + non-OpenGL Qt Quick backends may however decide not to support inlined + shader sources, or even shader sources at all. In this case shaders are + expected to be pre-compiled into formats like SPIR-V or D3D shader + bytecode. + + \note The value is only up-to-date once the item is associated with a + window and the window's scenegraph has initialized. Bindings relying on the + value have to keep this in mind since the value may change from \c 0 to the + actual bitmask after component initialization is complete. This is + particularly relevant for ShaderEffect items inside ShaderEffectSource + items set as property values. + + \since 5.8 + \since QtQuick 2.8 + + \sa shaderType, shaderCompilationType +*/ + +/*! + \qmlproperty int QtQuick::GraphicsInfo::majorVersion + + This property holds the major version of the graphics API in use. + + With OpenGL the default version is \c 2.0. + + \sa minorVersion, profile + */ + +/*! + \qmlproperty int QtQuick::GraphicsInfo::minorVersion + + This property holds the minor version of the graphics API in use. + + With OpenGL the default version is \c 2.0. + + \sa majorVersion, profile + */ + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::profile + + This property holds the configured OpenGL context profile. + + The possible values are: + \list + \li GraphicsInfo.NoProfile (default) - OpenGL version is lower than 3.2 or OpenGL is not in use. + \li GraphicsInfo.CoreProfile - Functionality deprecated in OpenGL version 3.0 is not available. + \li GraphicsInfo.CompatibilityProfile - Functionality from earlier OpenGL versions is available. + \endlist + + Reusable QML components will typically use this property in bindings in order to + choose between core and non core profile compatible shader sources. + + \sa majorVersion, minorVersion, QSurfaceFormat + */ + +/*! + \qmlproperty enumeration QtQuick::GraphicsInfo::renderableType + + This property holds the renderable type. The value has no meaning for APIs + other than OpenGL. + + The possible values are: + \list + \li GraphicsInfo.SurfaceFormatUnspecified (default) - Unspecified rendering method + \li GraphicsInfo.SurfaceFormatOpenGL - Desktop OpenGL or other graphics API + \li GraphicsInfo.SurfaceFormatOpenGLES - OpenGL ES + \endlist + + \sa QSurfaceFormat + */ + +void QQuickGraphicsInfo::updateInfo() +{ + const bool sgReady = m_window && m_window->isSceneGraphInitialized(); + + if (sgReady) { + QSGRendererInterface *rif = m_window->rendererInterface(); + if (rif) { + GraphicsApi newAPI = GraphicsApi(rif->graphicsApi()); + if (m_api != newAPI) { + m_api = newAPI; + emit apiChanged(); + m_shaderType = ShaderType(rif->shaderType()); + emit shaderTypeChanged(); + m_shaderCompilationType = ShaderCompilationType(int(rif->shaderCompilationType())); + emit shaderCompilationTypeChanged(); + m_shaderSourceType = ShaderSourceType(int(rif->shaderSourceType())); + emit shaderSourceTypeChanged(); + } + } + } + + QSurfaceFormat format = QSurfaceFormat::defaultFormat(); +#ifndef QT_NO_OPENGL + if (sgReady) { + QOpenGLContext *context = m_window->openglContext(); + if (context) + format = context->format(); + } +#endif + if (m_majorVersion != format.majorVersion()) { + m_majorVersion = format.majorVersion(); + emit majorVersionChanged(); + } + if (m_minorVersion != format.minorVersion()) { + m_minorVersion = format.minorVersion(); + emit minorVersionChanged(); + } + ContextProfile profile = static_cast<ContextProfile>(format.profile()); + if (m_profile != profile) { + m_profile = profile; + emit profileChanged(); + } + RenderableType renderableType = static_cast<RenderableType>(format.renderableType()); + if (m_renderableType != renderableType) { + m_renderableType = renderableType; + emit renderableTypeChanged(); + } +} + +void QQuickGraphicsInfo::setWindow(QQuickWindow *window) +{ + if (m_window != window) { + if (m_window) { + disconnect(m_window, SIGNAL(sceneGraphInitialized()), this, SLOT(updateInfo())); + disconnect(m_window, SIGNAL(sceneGraphInvalidated()), this, SLOT(updateInfo())); + } + if (window) { + connect(window, SIGNAL(sceneGraphInitialized()), this, SLOT(updateInfo())); + connect(window, SIGNAL(sceneGraphInvalidated()), this, SLOT(updateInfo())); + } + m_window = window; + } + updateInfo(); +} + +QT_END_NAMESPACE |