int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);

    QOpenGLContext context;
    context.create();

    QWindow window;
    window.setSurfaceType(QSurface::OpenGLSurface);
    window.setFormat(context.format());
    window.create();

    Q3DSSurfaceViewer viewer;
    viewer.presentation()->setSource(QUrl(QStringLiteral("qrc:/my_presentation.uip")));
    viewer.setUpdateInterval(0); // enable automatic updates

    // Register a scene object for slide management (optional)
    Q3DSSceneElement scene(viewer.presentation(), QStringLiteral("Scene"));

    // Register an element object for attribute setting (optional)
    Q3DSElement element(viewer.presentation(), QStringLiteral("Scene.Layer.myCarModel"));

    viewer.create(&window, &context);

    w.resize(1024, 768);
    w.show();

    return app.exec();
}

Member Function Documentation

Q3DSSurfaceViewer::Q3DSSurfaceViewer(QObject *parent = nullptr)

Q3DSSurfaceViewer::Q3DSSurfaceViewer Constructor. parent Optional parent of the object.

[signal] void Q3DSSurfaceViewer::afterRendering()

Emitted when a frame has been rendered.

[signal] void Q3DSSurfaceViewer::frameUpdate()

Emitted each time a frame has been rendered.

[signal] void Q3DSSurfaceViewer::presentationLoaded()

Emitted when the presentation has been loaded and is ready to be shown.

[signal] void Q3DSSurfaceViewer::presentationReady()

Emitted when first frame is about to be shown. DataInputs and setAttribute are ready to be used after this signal.

[slot] void Q3DSSurfaceViewer::update()

Updates the surface viewer with a new frame.

[virtual] Q3DSSurfaceViewer::~Q3DSSurfaceViewer()

Q3DSSurfaceViewer::~Q3DSSurfaceViewer Destructor

QOpenGLContext *Q3DSSurfaceViewer::context() const

Returns the context given in initialization.

See also create().

bool Q3DSSurfaceViewer::create(QSurface *surface, QOpenGLContext *context)

Initializes Q3DSSurfaceViewer to render the presentation to the given surface using the context.

The source property of the attached presentation must be set before the viewer can be initialized.

Returns whether the initialization succeeded.

See also running, Q3DSPresentation::source, and presentation().

bool Q3DSSurfaceViewer::create(QSurface *surface, QOpenGLContext *context, GLuint fboId)

Initializes Q3DSSurfaceViewer to render the presentation to the given surface using the context and optional framebuffer id (fboId). If fboId is omitted, it defaults to zero.

The source property of the attached presentation must be set before the viewer can be initialized.

Returns whether the initialization succeeded.

See also running, Q3DSPresentation::source, and presentation().

void Q3DSSurfaceViewer::destroy()

Releases the presentation and all related resources. The Q3DSSurfaceViewer instance can be reused by calling create() again.

QString Q3DSSurfaceViewer::error() const

Returns the error string.

Note: Getter function for property error.

int Q3DSSurfaceViewer::fboId() const

Returns the framebuffer id given in initialization.

See also create().

QImage Q3DSSurfaceViewer::grab(const QRect &rect = QRect())

Grabs the data rendered to the framebuffer into an image using the given rect. The rect parameter is optional. If it is omitted, the whole framebuffer is captured.

Note: This is a potentially expensive operation.

Q3DSPresentation *Q3DSSurfaceViewer::presentation() const

Returns the presentation object used by the Q3DSSurfaceViewer.

QQmlEngine *Q3DSSurfaceViewer::qmlEngine() const

Returns the QML engine set with setQmlEngine method.

See also setQmlEngine.

void Q3DSSurfaceViewer::setQmlEngine(QQmlEngine *qmlEngine)

Sets the QML engine for rendering QML streams of the presentation to qmlEngine. The QML engine must be set before Q3DSSurfaceViewer::create is called. If the QML engine is not set, a new one will be created during runtime initialization.

See also qmlEngine.

Q3DSViewerSettings *Q3DSSurfaceViewer::settings() const

Returns the settings object used by the Q3DSSurfaceViewer.

QSurface *Q3DSSurfaceViewer::surface() const

Returns the surface given in initialization.

See also create().