Revision control
Copy as Markdown
// Copyright (C) 2016 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
// Qt-Security score:significant reason:default
#include "qquickgraphicsinfo_p.h"
#include <private/qquickitem_p.h>
#include <qopenglcontext.h>
QT_BEGIN_NAMESPACE
/*!
\qmltype GraphicsInfo
\nativetype QQuickGraphicsInfo
\inqmlmodule QtQuick
\ingroup qtquick-visual
\since 5.8
\since QtQuick 2.8
\brief Provides information about the scenegraph backend and the graphics API used by Qt Quick.
The GraphicsInfo attached type provides information about the scenegraph
backend and the graphics API 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)
{
if (Q_LIKELY(item)) {
connect(item, &QQuickItem::windowChanged, this, &QQuickGraphicsInfo::setWindow);
setWindow(item->window());
}
}
QQuickGraphicsInfo::QQuickGraphicsInfo(QQuickWindow *window)
: QObject(window)
{
if (Q_LIKELY(window))
setWindow(window);
}
QQuickGraphicsInfo *QQuickGraphicsInfo::qmlAttachedProperties(QObject *object)
{
if (QQuickItem *item = qobject_cast<QQuickItem *>(object))
return new QQuickGraphicsInfo(item);
if (QQuickWindow *window = qobject_cast<QQuickWindow *>(object))
return new QQuickGraphicsInfo(window);
return nullptr;
}
/*!
\qmlproperty enumeration QtQuick::GraphicsInfo::api
This property describes the graphics API that is currently in use.
The possible values are:
\value GraphicsInfo.Unknown the default value when no active scenegraph is associated with the item
\value GraphicsInfo.Software Qt Quick's software renderer based on QPainter with the raster paint engine
\value GraphicsInfo.OpenVG OpenVG
\value GraphicsInfo.OpenGL OpenGL or OpenGL ES on top of QRhi, a graphics abstraction layer
\value GraphicsInfo.Direct3D11 Direct3D 11 on top of QRhi, a graphics abstraction layer
\value GraphicsInfo.Direct3D12 Direct3D 12 on top of QRhi, a graphics abstraction layer
\value GraphicsInfo.Vulkan Vulkan on top of QRhi, a graphics abstraction layer
\value GraphicsInfo.Metal Metal on top of QRhi, a graphics abstraction layer
\value GraphicsInfo.Null Null (no output) on top of QRhi, a graphics abstraction layer
*/
/*!
\qmlproperty enumeration QtQuick::GraphicsInfo::shaderType
This property contains the shading language supported by the Qt Quick
backend the application is using.
\value GraphicsInfo.UnknownShadingLanguage Not yet known due to no window and scenegraph associated
\value GraphicsInfo.GLSL GLSL or GLSL ES
\value GraphicsInfo.HLSL HLSL
\value GraphicsInfo.RhiShader QShader
\note The value is only up-to-date once the item is associated with a
window. 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.
\value GraphicsInfo.RuntimeCompilation
\value GraphicsInfo.OfflineCompilation
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. 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.
\value GraphicsInfo.ShaderSourceString
\value GraphicsInfo.ShaderSourceFile
\value GraphicsInfo.ShaderByteCode
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. 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.
\note This is applicable only to OpenGL.
\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.
\note This is applicable only to OpenGL.
\sa majorVersion, profile
*/
/*!
\qmlproperty enumeration QtQuick::GraphicsInfo::profile
This property holds the configured OpenGL context profile.
The possible values are:
\value GraphicsInfo.OpenGLNoProfile (default) OpenGL version is lower than 3.2 or OpenGL is not in use.
\value GraphicsInfo.OpenGLCoreProfile Functionality deprecated in OpenGL version 3.0 is not available.
\value GraphicsInfo.OpenGLCompatibilityProfile Functionality from earlier OpenGL versions is available.
Reusable QML components will typically use this property in bindings in order to
choose between core and non core profile compatible shader sources.
\note This is applicable only to OpenGL.
\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:
\value GraphicsInfo.SurfaceFormatUnspecified (default) Unspecified rendering method
\value GraphicsInfo.SurfaceFormatOpenGL Desktop OpenGL or other graphics API
\value GraphicsInfo.SurfaceFormatOpenGLES OpenGL ES
\note This is applicable only to OpenGL.
\sa QSurfaceFormat
*/
void QQuickGraphicsInfo::updateInfo()
{
// The queries via the RIF do not depend on isSceneGraphInitialized(), they only need a window.
if (m_window) {
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();
#if QT_CONFIG(opengl)
if (m_window && m_window->isSceneGraphInitialized()) {
QOpenGLContext *context = QQuickWindowPrivate::get(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();
}
OpenGLContextProfile profile = static_cast<OpenGLContextProfile>(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
#include "moc_qquickgraphicsinfo_p.cpp"