QQuick3D Class Reference

\inmodule QtQuick3D More...

#include <qquick3d.h>

Collaboration diagram for QQuick3D:

Static Public Member Functions
static Q_QUICK3D_EXPORT QSurfaceFormat	idealSurfaceFormat (int samples=-1)
	Returns an ideal surface format for the platform.

Detailed Description

\inmodule QtQuick3D

Since

5.15

Helper class for selecting correct surface format.

When using Qt Quick 3D with OpenGL it is necessary to take extra steps to define what kind of \l {QSurfaceFormat}{surface format} is used when initializing Qt Quick. This is because by the time Qt Quick is aware that 3D content is being used, the OpenGL context and window surface has already been initialized. So this helper class is provided to request the ideal surface format from Qt Quick 3D so that it can be set as the default surface for Qt Quick before initialization.

If this helper is run when using any other rendering backends than OpenGL then it just returns a copy of the current default QSurfaceFormat with the requested samples.

If this helper is run when using the OpenGL rendering backend, then it will test for sufficiently modern versions of OpenGL and support for multisampling if requested. Normally Qt Quick will request an OpenGL 2.0 or OpenGL ES 2.0 context, which would limit the features available when using Qt Quick 3D, so an extra step is needed to request a more capable context.

The correct usage pattern is to call \l QSurfaceFormat::setDefaultFormat to set the \l QSurfaceFormat returned by \l QQuick3D::idealSurfaceFormat. It is important that this method is called after \l QGuiApplication is constructed, but before the Qt Quick application content is loaded. This code snippet shows the correct usage pattern:

#include <QGuiApplication>
#include <QQmlApplicationEngine>
 
#include <QtGui>
#include <QtQuick3D/qquick3d.h>
 
int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);
 
    QSurfaceFormat::setDefaultFormat(QQuick3D::idealSurfaceFormat(4));
 
    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
    if (engine.rootObjects().isEmpty())
        return -1;
 
    return app.exec();
}

Definition at line 12 of file qquick3d.h.

Member Function Documentation

idealSurfaceFormat()

QT_BEGIN_NAMESPACE QSurfaceFormat QQuick3D::idealSurfaceFormat ( int samples = -1 )

static

Returns an ideal surface format for the platform.

Optionally, samples can be specified to select the number of multisamples for antialiasing.

Definition at line 212 of file qquick3d.cpp.

References QSurfaceFormat::defaultFormat(), fmt, QOpenGLContext::LibGL, QOpenGLContext::openGLModuleType(), and QSGRendererInterface::OpenGLRhi.

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• qtquick3d/src/quick3d/qquick3d.h (ed39d7a18a4ddfc0cc9197b3b0863c1443fe3b8a)
• qtquick3d/src/quick3d/qquick3d.cpp (ed39d7a18a4ddfc0cc9197b3b0863c1443fe3b8a)