Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qquickwindow.cpp
Go to the documentation of this file.
1// Copyright (C) 2020 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
3// Qt-Security score:significant reason:default
4
5#include "qquickwindow.h"
7
8#include "qquickitem.h"
9#include "qquickitem_p.h"
14
15#include <QtQuick/private/qsgrenderer_p.h>
16#include <QtQuick/private/qsgplaintexture_p.h>
17#include <QtQuick/private/qquickpointerhandler_p.h>
18#include <QtQuick/private/qquickpointerhandler_p_p.h>
19#include <QtQuick/private/qquicktaphandler_p.h>
20#include <private/qsgrenderloop_p.h>
21#include <private/qsgrhisupport_p.h>
22#include <private/qquickrendercontrol_p.h>
23#include <private/qquickanimatorcontroller_p.h>
24#include <private/qquickprofiler_p.h>
25#include <private/qquicktextinterface_p.h>
26
27#include <private/qguiapplication_p.h>
28
29#include <private/qabstractanimation_p.h>
30
31#include <QtGui/qpainter.h>
32#include <QtGui/qevent.h>
33#include <QtGui/qmatrix4x4.h>
34#include <QtGui/private/qevent_p.h>
35#include <QtGui/private/qpointingdevice_p.h>
36#include <QtCore/qvarlengtharray.h>
37#include <QtCore/qabstractanimation.h>
38#include <QtCore/QLibraryInfo>
39#include <QtCore/QRunnable>
40#include <QtQml/qqmlincubator.h>
41#include <QtQml/qqmlinfo.h>
42#include <QtQml/private/qqmlmetatype_p.h>
43
44#include <QtQuick/private/qquickpixmap_p.h>
45
46#include <private/qqmldebugserviceinterfaces_p.h>
47#include <private/qqmldebugconnector_p.h>
48#include <private/qsgdefaultrendercontext_p.h>
49#include <private/qsgsoftwarerenderer_p.h>
50#if QT_CONFIG(opengl)
51#include <private/qopengl_p.h>
52#include <QOpenGLContext>
53#endif
54#ifndef QT_NO_DEBUG_STREAM
55#include <private/qdebug_p.h>
56#endif
57#include <QtCore/qpointer.h>
58
59#include <rhi/qrhi.h>
60
61#include <utility>
62#include <mutex>
63
65
66Q_STATIC_LOGGING_CATEGORY(lcDirty, "qt.quick.dirty")
67Q_LOGGING_CATEGORY(lcQuickWindow, "qt.quick.window")
68
69bool QQuickWindowPrivate::defaultAlphaBuffer = false;
70
71#if defined(QT_QUICK_DEFAULT_TEXT_RENDER_TYPE)
72QQuickWindow::TextRenderType QQuickWindowPrivate::textRenderType = QQuickWindow::QT_QUICK_DEFAULT_TEXT_RENDER_TYPE;
73#else
74QQuickWindow::TextRenderType QQuickWindowPrivate::textRenderType = QQuickWindow::QtTextRendering;
75#endif
76
78{
80
81public:
94
95protected:
97 {
99 m_timer = 0;
100 incubate();
101 }
102
104 if (m_timer == 0) {
105 // Wait for a while before processing the next batch. Using a
106 // timer to avoid starvation of system events.
108 }
109 }
110
111public slots:
112 void incubate() {
116 } else {
120 }
121 }
122 }
123
125
126protected:
132
133private:
135 int m_incubation_time;
136 int m_timer;
137};
138
139#if QT_CONFIG(accessibility)
140/*!
141 Returns an accessibility interface for this window, or 0 if such an
142 interface cannot be created.
143*/
144QAccessibleInterface *QQuickWindow::accessibleRoot() const
145{
146 return QAccessible::queryAccessibleInterface(const_cast<QQuickWindow*>(this));
147}
148#endif
149
150
151/*
152Focus behavior
153==============
154
155Prior to being added to a valid window items can set and clear focus with no
156effect. Only once items are added to a window (by way of having a parent set that
157already belongs to a window) do the focus rules apply. Focus goes back to
158having no effect if an item is removed from a window.
159
160When an item is moved into a new focus scope (either being added to a window
161for the first time, or having its parent changed), if the focus scope already has
162a scope focused item that takes precedence over the item being added. Otherwise,
163the focus of the added tree is used. In the case of a tree of items being
164added to a window for the first time, which may have a conflicted focus state (two
165or more items in one scope having focus set), the same rule is applied item by item -
166thus the first item that has focus will get it (assuming the scope doesn't already
167have a scope focused item), and the other items will have their focus cleared.
168*/
169
170QQuickRootItem::QQuickRootItem()
171{
172 // child items with ItemObservesViewport can treat the window's content item
173 // as the ultimate viewport: avoid populating SG nodes that fall outside
174 setFlag(ItemIsViewport);
175}
176
177/*! \reimp */
178void QQuickWindow::exposeEvent(QExposeEvent *)
179{
180 Q_D(QQuickWindow);
181 if (d->windowManager)
182 d->windowManager->exposureChanged(this);
183}
184
185/*! \reimp */
186void QQuickWindow::resizeEvent(QResizeEvent *ev)
187{
188 Q_D(QQuickWindow);
189 if (d->contentItem)
190 d->contentItem->setSize(ev->size());
191 if (d->windowManager)
192 d->windowManager->resize(this);
193}
194
195/*! \reimp */
196void QQuickWindow::showEvent(QShowEvent *)
197{
198 Q_D(QQuickWindow);
199 if (d->windowManager)
200 d->windowManager->show(this);
201}
202
203/*! \reimp */
204void QQuickWindow::hideEvent(QHideEvent *)
205{
206 Q_D(QQuickWindow);
207 if (auto da = d->deliveryAgentPrivate())
208 da->handleWindowHidden(this);
209 if (d->windowManager)
210 d->windowManager->hide(this);
211}
212
213/*! \reimp */
214void QQuickWindow::closeEvent(QCloseEvent *e)
215{
216 QQuickCloseEvent qev;
217 qev.setAccepted(e->isAccepted());
218 emit closing(&qev);
219 e->setAccepted(qev.isAccepted());
220}
221
222/*! \reimp */
223void QQuickWindow::focusOutEvent(QFocusEvent *ev)
224{
225 Q_D(QQuickWindow);
226 if (d->contentItem)
227 d->contentItem->setFocus(false, ev->reason());
228}
229
230/*! \reimp */
231void QQuickWindow::focusInEvent(QFocusEvent *ev)
232{
233 Q_D(QQuickWindow);
234 if (d->inDestructor)
235 return;
236 if (d->contentItem)
237 d->contentItem->setFocus(true, ev->reason());
238 if (auto da = d->deliveryAgentPrivate())
239 da->updateFocusItemTransform();
240}
241
242#if QT_CONFIG(im)
243static bool transformDirtyOnItemOrAncestor(const QQuickItem *item)
244{
245 while (item) {
246 if (QQuickItemPrivate::get(item)->dirtyAttributes & (
247 QQuickItemPrivate::TransformOrigin |
248 QQuickItemPrivate::Transform |
249 QQuickItemPrivate::BasicTransform |
250 QQuickItemPrivate::Position |
251 QQuickItemPrivate::Size |
252 QQuickItemPrivate::ParentChanged |
253 QQuickItemPrivate::Clip)) {
254 return true;
255 }
256 item = item->parentItem();
257 }
258 return false;
259}
260#endif
261
262/*!
263 * \internal
264
265 A "polish loop" can occur inside QQuickWindowPrivate::polishItems(). It is when an item calls
266 polish() on an(other?) item from updatePolish(). If this anomaly happens repeatedly and without
267 interruption (of a well-behaved updatePolish() that doesn't call polish()), it is a strong
268 indication that we are heading towards an infinite polish loop. A polish loop is not a bug in
269 Qt Quick - it is a bug caused by ill-behaved items put in the scene.
270
271 We can detect this sequence of polish loops easily, since the
272 QQuickWindowPrivate::itemsToPolish is basically a stack: polish() will push to it, and
273 polishItems() will pop from it.
274 Therefore if updatePolish() calls polish(), the immediate next item polishItems() processes is
275 the item that was polished by the previous call to updatePolish().
276 We therefore just need to count the number of polish loops we detected in _sequence_.
277*/
279{
280 PolishLoopDetector(const QList<QQuickItem*> &itemsToPolish)
282 {
283 }
284
285 /*
286 * returns true when it detected a likely infinite loop
287 * (suggests it should abort the polish loop)
288 **/
289 bool check(QQuickItem *item, int itemsRemainingBeforeUpdatePolish)
290 {
291 if (itemsToPolish.size() > itemsRemainingBeforeUpdatePolish) {
292 // Detected potential polish loop.
294 if (numPolishLoopsInSequence == 10000) {
295 // We have looped 10,000 times without actually reducing the list of items to
296 // polish, give up for now.
297 // This is not a fix, just a remedy so that the application can be somewhat
298 // responsive.
300 return true;
301 }
303 // Start to warn about polish loop after 1000 consecutive polish loops
304 // Show the 5 next items involved in the polish loop.
305 // (most likely they will be the same 5 items...)
306 QQuickItem *guiltyItem = itemsToPolish.last();
307 qmlWarning(item) << "possible QQuickItem::polish() loop";
308
309 auto typeAndObjectName = [](QQuickItem *item) {
310 QString typeName = QQmlMetaType::prettyTypeName(item);
311 QString objName = item->objectName();
312 if (!objName.isNull())
313 return QLatin1String("%1(%2)").arg(typeName, objName);
314 return typeName;
315 };
316
317 qmlWarning(guiltyItem) << typeAndObjectName(guiltyItem)
318 << " called polish() inside updatePolish() of " << typeAndObjectName(item);
319 }
320 } else {
322 }
323 return false;
324 }
325 const QList<QQuickItem*> &itemsToPolish; // Just a ref to the one in polishItems()
327};
328
329void QQuickWindowPrivate::polishItems()
330{
331 // An item can trigger polish on another item, or itself for that matter,
332 // during its updatePolish() call. Because of this, we cannot simply
333 // iterate through the set, we must continue pulling items out until it
334 // is empty.
335 // In the case where polish is called from updatePolish() either directly
336 // or indirectly, we use a PolishLoopDetector to determine if a warning should
337 // be printed to the user.
338
339 PolishLoopDetector polishLoopDetector(itemsToPolish);
340 while (!itemsToPolish.isEmpty()) {
341 QQuickItem *item = itemsToPolish.takeLast();
342 QQuickItemPrivate *itemPrivate = QQuickItemPrivate::get(item);
343 itemPrivate->polishScheduled = false;
344 const int itemsRemaining = itemsToPolish.size();
345 itemPrivate->updatePolish();
346 item->updatePolish();
347 if (polishLoopDetector.check(item, itemsRemaining) == true)
348 break;
349 }
350
351#if QT_CONFIG(im)
352 if (QQuickItem *focusItem = q_func()->activeFocusItem()) {
353 // If the current focus item, or any of its anchestors, has changed location
354 // inside the window, we need inform IM about it. This to ensure that overlays
355 // such as selection handles will be updated.
356 const bool isActiveFocusItem = (focusItem == QGuiApplication::focusObject());
357 const bool hasImEnabled = focusItem->inputMethodQuery(Qt::ImEnabled).toBool();
358 if (isActiveFocusItem && hasImEnabled && transformDirtyOnItemOrAncestor(focusItem))
359 deliveryAgentPrivate()->updateFocusItemTransform();
360 }
361#endif
362
363 if (needsChildWindowStackingOrderUpdate) {
364 updateChildWindowStackingOrder();
365 needsChildWindowStackingOrderUpdate = false;
366 }
367}
368
369/*!
370 * Schedules the window to render another frame.
371 *
372 * Calling QQuickWindow::update() differs from QQuickItem::update() in that
373 * it always triggers a repaint, regardless of changes in the underlying
374 * scene graph or not.
375 */
376void QQuickWindow::update()
377{
378 Q_D(QQuickWindow);
379 if (d->windowManager)
380 d->windowManager->update(this);
381 else if (d->renderControl)
382 QQuickRenderControlPrivate::get(d->renderControl)->update();
383}
384
385static void updatePixelRatioHelper(QQuickItem *item, float pixelRatio)
386{
387 if (item->flags() & QQuickItem::ItemHasContents) {
388 QQuickItemPrivate *itemPrivate = QQuickItemPrivate::get(item);
389 itemPrivate->itemChange(QQuickItem::ItemDevicePixelRatioHasChanged, pixelRatio);
390 }
391
392 QList <QQuickItem *> items = item->childItems();
393 for (int i = 0; i < items.size(); ++i)
394 updatePixelRatioHelper(items.at(i), pixelRatio);
395}
396
397void QQuickWindow::physicalDpiChanged()
398{
399 Q_D(QQuickWindow);
400 const qreal newPixelRatio = effectiveDevicePixelRatio();
401 if (qFuzzyCompare(newPixelRatio, d->lastReportedItemDevicePixelRatio))
402 return;
403 d->lastReportedItemDevicePixelRatio = newPixelRatio;
404 if (d->contentItem)
405 updatePixelRatioHelper(d->contentItem, newPixelRatio);
406 d->forcePolish();
407 emit devicePixelRatioChanged();
408}
409
410void QQuickWindow::handleFontDatabaseChanged()
411{
412 Q_D(QQuickWindow);
413 d->pendingFontUpdate = true;
414}
415
416void forcePolishHelper(QQuickItem *item)
417{
418 if (item->flags() & QQuickItem::ItemHasContents) {
419 item->polish();
420 }
421
422 QList <QQuickItem *> items = item->childItems();
423 for (int i=0; i<items.size(); ++i)
424 forcePolishHelper(items.at(i));
425}
426
427void QQuickWindow::handleScreenChanged(QScreen *screen)
428{
429 Q_D(QQuickWindow);
430 Q_UNUSED(screen);
431 d->forcePolish();
432}
433
434/*!
435 Schedules polish events on all items in the scene.
436*/
437void QQuickWindowPrivate::forcePolish()
438{
439 Q_Q(QQuickWindow);
440 if (!q->screen())
441 return;
442 forcePolishHelper(contentItem);
443}
444
445void forceUpdate(QQuickItem *item)
446{
447 if (item->flags() & QQuickItem::ItemHasContents)
448 item->update();
449 QQuickItemPrivate::get(item)->dirty(QQuickItemPrivate::ChildrenUpdateMask);
450
451 QList <QQuickItem *> items = item->childItems();
452 for (int i=0; i<items.size(); ++i)
453 forceUpdate(items.at(i));
454}
455
456void QQuickWindowRenderTarget::reset(QRhi *rhi, ResetFlags flags)
457{
458 if (rhi) {
459 if (rt.owns)
460 delete rt.renderTarget;
461
462 delete res.texture;
463 delete res.renderBuffer;
464 delete res.rpDesc;
465 }
466
467 rt = {};
468 res = {};
469
470 if (!flags.testFlag(ResetFlag::KeepImplicitBuffers))
471 implicitBuffers.reset(rhi);
472
473 if (sw.owns)
474 delete sw.paintDevice;
475
476 sw = {};
477}
478
480{
481 if (rhi) {
482 delete depthStencil;
483 delete depthStencilTexture;
484 delete multisampleTexture;
485 }
486 *this = {};
487}
488
489void QQuickWindowPrivate::invalidateFontData(QQuickItem *item)
490{
491 QQuickTextInterface *textItem = qobject_cast<QQuickTextInterface *>(item);
492 if (textItem != nullptr)
493 textItem->invalidate();
494
495 QList<QQuickItem *> children = item->childItems();
496 for (QQuickItem *child : children)
497 invalidateFontData(child);
498}
499
500void QQuickWindowPrivate::ensureCustomRenderTarget()
501{
502 // resolve() can be expensive when importing an existing native texture, so
503 // it is important to only do it when the QQuickRenderTarget was really changed.
504 if (!redirect.renderTargetDirty)
505 return;
506
507 redirect.renderTargetDirty = false;
508
509 redirect.rt.reset(rhi, QQuickWindowRenderTarget::ResetFlag::KeepImplicitBuffers);
510
511 if (!QQuickRenderTargetPrivate::get(&customRenderTarget)->resolve(rhi, &redirect.rt)) {
512 qWarning("Failed to set up render target redirection for QQuickWindow");
513 redirect.rt.reset(rhi);
514 }
515}
516
517void QQuickWindowPrivate::setCustomCommandBuffer(QRhiCommandBuffer *cb)
518{
519 // ownership not transferred
520 redirect.commandBuffer = cb;
521}
522
523void QQuickWindowPrivate::syncSceneGraph()
524{
525 Q_Q(QQuickWindow);
526
527 const bool wasRtDirty = redirect.renderTargetDirty;
528 ensureCustomRenderTarget();
529
530 QRhiCommandBuffer *cb = nullptr;
531 if (rhi) {
532 if (redirect.commandBuffer)
533 cb = redirect.commandBuffer;
534 else
535 cb = swapchain->currentFrameCommandBuffer();
536 }
537 context->prepareSync(q->effectiveDevicePixelRatio(), cb, graphicsConfig);
538
539 animationController->beforeNodeSync();
540
541 emit q->beforeSynchronizing();
542 runAndClearJobs(&beforeSynchronizingJobs);
543
544 if (pendingFontUpdate) {
545 QFont::cleanup();
546 invalidateFontData(contentItem);
547 context->invalidateGlyphCaches();
548 }
549
550 if (Q_UNLIKELY(!renderer)) {
551 forceUpdate(contentItem);
552
553 QSGRootNode *rootNode = new QSGRootNode;
554 rootNode->appendChildNode(QQuickItemPrivate::get(contentItem)->itemNode());
555 const bool useDepth = graphicsConfig.isDepthBufferEnabledFor2D();
556 const QSGRendererInterface::RenderMode renderMode = useDepth ? QSGRendererInterface::RenderMode2D
557 : QSGRendererInterface::RenderMode2DNoDepthBuffer;
558 renderer = context->createRenderer(renderMode);
559 renderer->setRootNode(rootNode);
560 } else if (Q_UNLIKELY(wasRtDirty)
561 && q->rendererInterface()->graphicsApi() == QSGRendererInterface::Software) {
562 auto softwareRenderer = static_cast<QSGSoftwareRenderer *>(renderer);
563 softwareRenderer->markDirty();
564 }
565
566 updateDirtyNodes();
567
568 animationController->afterNodeSync();
569
570 renderer->setClearColor(clearColor);
571
572 renderer->setVisualizationMode(visualizationMode);
573
574 if (pendingFontUpdate) {
575 context->flushGlyphCaches();
576 pendingFontUpdate = false;
577 }
578
579 emit q->afterSynchronizing();
580 runAndClearJobs(&afterSynchronizingJobs);
581}
582
583void QQuickWindowPrivate::emitBeforeRenderPassRecording(void *ud)
584{
585 QQuickWindow *w = reinterpret_cast<QQuickWindow *>(ud);
586 emit w->beforeRenderPassRecording();
587}
588
589void QQuickWindowPrivate::emitAfterRenderPassRecording(void *ud)
590{
591 QQuickWindow *w = reinterpret_cast<QQuickWindow *>(ud);
592 emit w->afterRenderPassRecording();
593}
594
595int QQuickWindowPrivate::multiViewCount()
596{
597 if (rhi) {
598 ensureCustomRenderTarget();
599 if (redirect.rt.rt.renderTarget)
600 return redirect.rt.rt.multiViewCount;
601 }
602
603 // Note that on QRhi level 0 and 1 are often used interchangeably, as both mean
604 // no-multiview. Here in Qt Quick let's always use 1 as the default
605 // (no-multiview), so that higher layers (effects, materials) do not need to
606 // handle both 0 and 1, only 1.
607 return 1;
608}
609
610QRhiRenderTarget *QQuickWindowPrivate::activeCustomRhiRenderTarget()
611{
612 if (rhi) {
613 ensureCustomRenderTarget();
614 return redirect.rt.rt.renderTarget;
615 }
616 return nullptr;
617}
618
619void QQuickWindowPrivate::renderSceneGraph()
620{
621 Q_Q(QQuickWindow);
622 if (!renderer)
623 return;
624
625 ensureCustomRenderTarget();
626
627 QSGRenderTarget sgRenderTarget;
628 if (rhi) {
629 QRhiRenderTarget *rt;
630 QRhiRenderPassDescriptor *rp;
631 QRhiCommandBuffer *cb;
632 if (redirect.rt.rt.renderTarget) {
633 rt = redirect.rt.rt.renderTarget;
634 rp = rt->renderPassDescriptor();
635 if (!rp) {
636 qWarning("Custom render target is set but no renderpass descriptor has been provided.");
637 return;
638 }
639 cb = redirect.commandBuffer;
640 if (!cb) {
641 qWarning("Custom render target is set but no command buffer has been provided.");
642 return;
643 }
644 } else {
645 if (!swapchain) {
646 qWarning("QQuickWindow: No render target (neither swapchain nor custom target was provided)");
647 return;
648 }
649 rt = swapchain->currentFrameRenderTarget();
650 rp = rpDescForSwapchain;
651 cb = swapchain->currentFrameCommandBuffer();
652 }
653 sgRenderTarget = QSGRenderTarget(rt, rp, cb);
654 sgRenderTarget.multiViewCount = multiViewCount();
655 } else {
656 sgRenderTarget = QSGRenderTarget(redirect.rt.sw.paintDevice);
657 }
658
659 context->beginNextFrame(renderer,
660 sgRenderTarget,
661 emitBeforeRenderPassRecording,
662 emitAfterRenderPassRecording,
663 q);
664
665 animationController->advance();
666 emit q->beforeRendering();
667 runAndClearJobs(&beforeRenderingJobs);
668
669 const qreal devicePixelRatio = q->effectiveDevicePixelRatio();
670 QSize pixelSize;
671 if (redirect.rt.rt.renderTarget)
672 pixelSize = redirect.rt.rt.renderTarget->pixelSize();
673 else if (redirect.rt.sw.paintDevice)
674 pixelSize = QSize(redirect.rt.sw.paintDevice->width(), redirect.rt.sw.paintDevice->height());
675 else if (rhi)
676 pixelSize = swapchain->currentPixelSize();
677 else // software or other backend
678 pixelSize = q->size() * devicePixelRatio;
679
680 renderer->setDevicePixelRatio(devicePixelRatio);
681 renderer->setDeviceRect(QRect(QPoint(0, 0), pixelSize));
682 renderer->setViewportRect(QRect(QPoint(0, 0), pixelSize));
683
684 QSGAbstractRenderer::MatrixTransformFlags matrixFlags;
685 bool flipY = rhi ? !rhi->isYUpInNDC() : false;
686 if (!customRenderTarget.isNull() && customRenderTarget.mirrorVertically())
687 flipY = !flipY;
688 if (flipY)
689 matrixFlags |= QSGAbstractRenderer::MatrixTransformFlipY;
690
691 const QRectF rect(QPointF(0, 0), pixelSize / devicePixelRatio);
692 renderer->setProjectionMatrixToRect(rect, matrixFlags, rhi && !rhi->isYUpInNDC());
693
694 context->renderNextFrame(renderer);
695
696 emit q->afterRendering();
697 runAndClearJobs(&afterRenderingJobs);
698
699 context->endNextFrame(renderer);
700
701 if (renderer && renderer->hasVisualizationModeWithContinuousUpdate()) {
702 // For the overdraw visualizer. This update is not urgent so avoid a
703 // direct update() call, this is only here to keep the overdraw
704 // visualization box rotating even when the scene is static.
705 QCoreApplication::postEvent(q, new QEvent(QEvent::Type(FullUpdateRequest)));
706 }
707}
708
709QQuickWindowPrivate::QQuickWindowPrivate()
710 : contentItem(nullptr)
711 , dirtyItemList(nullptr)
712 , lastReportedItemDevicePixelRatio(0)
713 , context(nullptr)
714 , renderer(nullptr)
715 , windowManager(nullptr)
716 , renderControl(nullptr)
717 , clearColor(Qt::white)
718 , persistentGraphics(true)
719 , persistentSceneGraph(true)
720 , inDestructor(false)
721 , incubationController(nullptr)
722 , hasActiveSwapchain(false)
723 , hasRenderableSwapchain(false)
724 , swapchainJustBecameRenderable(false)
725 , updatesEnabled(true)
726{
727}
728
729QQuickWindowPrivate::~QQuickWindowPrivate()
730{
731#ifdef QT_BUILD_INTERNAL
732 qCDebug(lcQuickWindow, "lifetime total, in all windows: constructed %d QQuickItems, %d ExtraData (%d%%)",
733 QQuickItemPrivate::item_counter, QQuickItemPrivate::itemExtra_counter,
734 QQuickItemPrivate::itemExtra_counter * 100 / QQuickItemPrivate::item_counter);
735 qCDebug(lcQuickWindow, "event-handling items fully within parent bounds: %d (%d%%)",
736 QQuickItemPrivate::eventHandlingChildrenWithinBounds_counter,
737 QQuickItemPrivate::eventHandlingChildrenWithinBounds_counter * 100 / QQuickItemPrivate::item_counter);
738 qCDebug(lcQuickWindow, "transform accessor calls: itemToParent %lld itemToWindow %lld windowToItem %lld; skipped due to effectiveClipping: %lld",
739 QQuickItemPrivate::itemToParentTransform_counter,
740 QQuickItemPrivate::itemToWindowTransform_counter,
741 QQuickItemPrivate::windowToItemTransform_counter,
742 QQuickItemPrivate::effectiveClippingSkips_counter);
743#endif
744 inDestructor = true;
745 redirect.rt.reset(rhi);
746 if (QQmlInspectorService *service = QQmlDebugConnector::service<QQmlInspectorService>())
747 service->removeWindow(q_func());
748 deliveryAgent = nullptr;
749}
750
751void QQuickWindowPrivate::setPalette(QQuickPalette* palette)
752{
753 if (windowPaletteRef == palette)
754 return;
755
756 if (windowPaletteRef)
757 disconnect(windowPaletteRef, &QQuickPalette::changed, this, &QQuickWindowPrivate::updateWindowPalette);
758 windowPaletteRef = palette;
759 updateWindowPalette();
760 if (windowPaletteRef)
761 connect(windowPaletteRef, &QQuickPalette::changed, this, &QQuickWindowPrivate::updateWindowPalette);
762}
763
764void QQuickWindowPrivate::updateWindowPalette()
765{
766 QQuickPaletteProviderPrivateBase::setPalette(windowPaletteRef);
767}
768
769void QQuickWindowPrivate::updateChildrenPalettes(const QPalette &parentPalette)
770{
771 Q_Q(QQuickWindow);
772 if (auto root = q->contentItem()) {
773 for (auto &&child: root->childItems()) {
774 QQuickItemPrivate::get(child)->inheritPalette(parentPalette);
775 }
776 }
777}
778
779void QQuickWindowPrivate::init(QQuickWindow *c, QQuickRenderControl *control)
780{
781 q_ptr = c;
782
783
784 Q_Q(QQuickWindow);
785
786 contentItem = new QQuickRootItem;
787 contentItem->setObjectName(q->objectName());
788 QQml_setParent_noEvent(contentItem, c);
789 QQmlEngine::setObjectOwnership(contentItem, QQmlEngine::CppOwnership);
790 QQuickItemPrivate *contentItemPrivate = QQuickItemPrivate::get(contentItem);
791 contentItemPrivate->window = q;
792 contentItemPrivate->windowRefCount = 1;
793 contentItemPrivate->flags |= QQuickItem::ItemIsFocusScope;
794 contentItem->setSize(q->size());
795 deliveryAgent = new QQuickDeliveryAgent(contentItem);
796
797 visualizationMode = qgetenv("QSG_VISUALIZE");
798 renderControl = control;
799 if (renderControl)
800 QQuickRenderControlPrivate::get(renderControl)->window = q;
801
802 if (!renderControl)
803 windowManager = QSGRenderLoop::instance();
804
805 Q_ASSERT(windowManager || renderControl);
806
807 QObject::connect(static_cast<QGuiApplication *>(QGuiApplication::instance()),
808 &QGuiApplication::fontDatabaseChanged,
809 q,
810 &QQuickWindow::handleFontDatabaseChanged);
811
812 if (q->screen()) {
813 lastReportedItemDevicePixelRatio = q->effectiveDevicePixelRatio();
814 }
815
816 QSGContext *sg;
817 if (renderControl) {
818 QQuickRenderControlPrivate *renderControlPriv = QQuickRenderControlPrivate::get(renderControl);
819 sg = renderControlPriv->sg;
820 context = renderControlPriv->rc;
821 } else {
822 windowManager->addWindow(q);
823 sg = windowManager->sceneGraphContext();
824 context = windowManager->createRenderContext(sg);
825 }
826
827 q->setSurfaceType(windowManager ? windowManager->windowSurfaceType() : QSurface::OpenGLSurface);
828 q->setFormat(sg->defaultSurfaceFormat());
829 // When using Vulkan, associating a scenegraph-managed QVulkanInstance with
830 // the window (but only when not using renderControl) is deferred to
831 // QSGRhiSupport::createRhi(). This allows applications to set up their own
832 // QVulkanInstance and set that on the window, if they wish to.
833
834 animationController.reset(new QQuickAnimatorController(q));
835
836 connections = {
837 QObject::connect(context, &QSGRenderContext::initialized, q, &QQuickWindow::sceneGraphInitialized, Qt::DirectConnection),
838 QObject::connect(context, &QSGRenderContext::invalidated, q, &QQuickWindow::sceneGraphInvalidated, Qt::DirectConnection),
839 QObject::connect(context, &QSGRenderContext::invalidated, q, &QQuickWindow::cleanupSceneGraph, Qt::DirectConnection),
840
841 QObject::connect(q, &QQuickWindow::focusObjectChanged, q, &QQuickWindow::activeFocusItemChanged),
842 QObject::connect(q, &QQuickWindow::screenChanged, q, &QQuickWindow::handleScreenChanged),
843 QObject::connect(qApp, &QGuiApplication::applicationStateChanged, q, &QQuickWindow::handleApplicationStateChanged),
844 QObject::connect(q, &QQuickWindow::frameSwapped, q, &QQuickWindow::runJobsAfterSwap, Qt::DirectConnection),
845 };
846
847 if (QQmlInspectorService *service = QQmlDebugConnector::service<QQmlInspectorService>())
848 service->addWindow(q);
849}
850
851void QQuickWindow::handleApplicationStateChanged(Qt::ApplicationState state)
852{
853 Q_D(QQuickWindow);
854 if (state != Qt::ApplicationActive && d->contentItem) {
855 auto da = d->deliveryAgentPrivate();
856 Q_ASSERT(da);
857 da->handleWindowDeactivate(this);
858 }
859}
860
861/*!
862 \property QQuickWindow::data
863 \internal
864*/
865
866QQmlListProperty<QObject> QQuickWindowPrivate::data()
867{
868 QQmlListProperty<QObject> ret;
869
870 ret.object = q_func();
871 ret.append = QQuickWindowPrivate::data_append;
872 ret.count = QQuickWindowPrivate::data_count;
873 ret.at = QQuickWindowPrivate::data_at;
874 ret.clear = QQuickWindowPrivate::data_clear;
875 // replace is not supported by QQuickItem. Don't synthesize it.
876 ret.removeLast = QQuickWindowPrivate::data_removeLast;
877
878 return ret;
879}
880
881void QQuickWindowPrivate::dirtyItem(QQuickItem *item)
882{
883 Q_Q(QQuickWindow);
884
885 QQuickItemPrivate *itemPriv = QQuickItemPrivate::get(item);
886 if (itemPriv->dirtyAttributes & QQuickItemPrivate::ChildrenStackingChanged)
887 needsChildWindowStackingOrderUpdate = true;
888
889 q->maybeUpdate();
890}
891
892/*!
893 \deprecated Use QPointerEvent::exclusiveGrabber().
894 Returns the item which currently has the mouse grab.
895*/
896QQuickItem *QQuickWindow::mouseGrabberItem() const
897{
898 Q_D(const QQuickWindow);
899 auto da = const_cast<QQuickWindowPrivate *>(d)->deliveryAgentPrivate();
900 Q_ASSERT(da);
901 // The normal use case is to call this function while an event is being delivered;
902 // but if the caller knows about the event, it should call QPointerEvent::exclusiveGrabber() instead.
903 if (auto epd = da->mousePointData())
904 return qmlobject_cast<QQuickItem *>(epd->exclusiveGrabber);
905
906 if (Q_LIKELY(d->deliveryAgentPrivate()->eventsInDelivery.isEmpty()))
907 // mousePointData() checked that already: it's one reason epd can be null
908 qCDebug(lcMouse, "mouse grabber ambiguous: no event is currently being delivered");
909 // If no event is being delivered, we can return "the mouse" grabber,
910 // but in general there could be more than one mouse, could be only a touchscreen etc.
911 // That's why this function is obsolete.
912 return qmlobject_cast<QQuickItem *>(QPointingDevicePrivate::get(QPointingDevice::primaryPointingDevice())->
913 firstPointExclusiveGrabber());
914}
915
916void QQuickWindowPrivate::cleanup(QSGNode *n)
917{
918 Q_Q(QQuickWindow);
919
920 Q_ASSERT(!cleanupNodeList.contains(n));
921 cleanupNodeList.append(n);
922 q->maybeUpdate();
923}
924
925/*!
926 \qmltype Window
927 \nativetype QQuickWindow
928 \inqmlmodule QtQuick
929 \ingroup qtquick-visual
930 \brief Creates a new top-level window.
931
932 The Window object creates a new top-level window for a Qt Quick scene. It automatically sets up the
933 window for use with \c {QtQuick} graphical types.
934
935 A Window can be declared inside an Item or inside another Window, in which
936 case the inner Window will automatically become "transient for" the outer
937 Window, with the outer Window as its \l transientParent. Most platforms will
938 show the Window centered upon the outer window in this case, and there may be
939 other platform-dependent behaviors, depending also on the \l flags. If the nested
940 window is intended to be a dialog in your application, you should also set \l flags
941 to \c Qt.Dialog, because some window managers will not provide the centering behavior
942 without that flag.
943
944 You can also declare multiple windows inside a top-level \l QtObject, in which
945 case the windows will have no transient relationship.
946
947 Alternatively you can set or bind \l x and \l y to position the Window
948 explicitly on the screen.
949
950 When the user attempts to close a window, the \l closing signal will be
951 emitted. You can force the window to stay open (for example to prompt the
952 user to save changes) by writing an \c onClosing handler that sets
953 \c {close.accepted = false} unless it's safe to close the window (for example,
954 because there are no more unsaved changes).
955
956 \code
957 onClosing: (close) => {
958 if (document.changed) {
959 close.accepted = false
960 confirmExitPopup.open()
961 }
962 }
963
964 // The confirmExitPopup allows user to save or discard the document,
965 // or to cancel the closing.
966 \endcode
967
968 \section1 Styling
969
970 As with all visual types in Qt Quick, Window supports
971 \l {palette}{palettes}. However, as with types like \l Text, Window does
972 not use palettes by default. For example, to change the background color
973 of the window when the operating system's theme changes, the \l color must
974 be set:
975
976 \snippet qml/windowPalette.qml declaration-and-color
977 \codeline
978 \snippet qml/windowPalette.qml text-item
979 \snippet qml/windowPalette.qml closing-brace
980
981 Use \l {ApplicationWindow} (and \l {Label}) from \l {Qt Quick Controls}
982 instead of Window to get automatic styling.
983*/
984
985/*!
986 \class QQuickWindow
987 \since 5.0
988
989 \inmodule QtQuick
990
991 \brief The QQuickWindow class provides the window for displaying a graphical QML scene.
992
993 QQuickWindow provides the graphical scene management needed to interact with and display
994 a scene of QQuickItems.
995
996 A QQuickWindow always has a single invisible root item. To add items to this window,
997 reparent the items to the root item or to an existing item in the scene.
998
999 For easily displaying a scene from a QML file, see \l{QQuickView}.
1000
1001 \section1 Rendering
1002
1003 QQuickWindow uses a scene graph to represent what needs to be rendered.
1004 This scene graph is disconnected from the QML scene and potentially lives in
1005 another thread, depending on the platform implementation. Since the
1006 rendering scene graph lives independently from the QML scene, it can also be
1007 completely released without affecting the state of the QML scene.
1008
1009 The sceneGraphInitialized() signal is emitted on the rendering thread before
1010 the QML scene is rendered to the screen for the first time. If the rendering
1011 scene graph has been released, the signal will be emitted again before the
1012 next frame is rendered. A visible, on-screen QQuickWindow is driven
1013 internally by a \c{render loop}, of which there are multiple implementations
1014 provided in the scene graph. For details on the scene graph rendering
1015 process, see \l{Qt Quick Scene Graph}.
1016
1017 By default, a QQuickWindow renders using an accelerated 3D graphics API,
1018 such as OpenGL or Vulkan. See \l{Scene Graph Adaptations} for a detailed
1019 overview of scene graph backends and the supported graphics APIs.
1020
1021 \warning It is crucial that graphics operations and interaction with the
1022 scene graph happens exclusively on the rendering thread, primarily during
1023 the updatePaintNode() phase.
1024
1025 \warning As many of the signals related to rendering are emitted from the
1026 rendering thread, connections should be made using Qt::DirectConnection.
1027
1028 \section2 Integration with Accelerated 3D Graphics APIs
1029
1030 It is possible to integrate OpenGL, Vulkan, Metal, or Direct3D 11 calls
1031 directly into the QQuickWindow, as long as the QQuickWindow and the
1032 underlying scene graph is rendering using the same API. To access native
1033 graphics objects, such as device or context object handles, use
1034 QSGRendererInterface. An instance of QSGRendererInterface is queriable from
1035 QQuickWindow by calling rendererInterface(). The enablers for this
1036 integration are the beforeRendering(), beforeRenderPassRecording(),
1037 afterRenderPassRecording(), and related signals. These allow rendering
1038 underlays or overlays. Alternatively, QNativeInterface::QSGOpenGLTexture,
1039 QNativeInterface::QSGVulkanTexture, and other similar classes allow
1040 wrapping an existing native texture or image object in a QSGTexture that
1041 can then be used with the scene graph.
1042
1043 \section2 Rendering without Acceleration
1044
1045 A limited, pure software based rendering path is available as well. With the
1046 \c software backend, a number of Qt Quick features are not available, QML
1047 items relying on these will not be rendered at all. At the same time, this
1048 allows QQuickWindow to be functional even on systems where there is no 3D
1049 graphics API available at all. See \l{Qt Quick Software Adaptation} for more
1050 details.
1051
1052 \section2 Redirected Rendering
1053
1054 A QQuickWindow is not necessarily backed by a native window on screen. The
1055 rendering can be redirected to target a custom render target, such as a
1056 given native texture. This is achieved in combination with the
1057 QQuickRenderControl class, and functions such as setRenderTarget(),
1058 setGraphicsDevice(), and setGraphicsConfiguration().
1059
1060 In this case, the QQuickWindow represents the scene, and provides the
1061 intrastructure for rendering a frame. It will not be backed by a render
1062 loop and a native window. Instead, in this case the application drives
1063 rendering, effectively substituting for the render loops. This allows
1064 generating image sequences, rendering into textures for use in external 3D
1065 engines, or rendering Qt Quick content within a VR environment.
1066
1067 \section2 Resource Management
1068
1069 QML will try to cache images and scene graph nodes to improve performance,
1070 but in some low-memory scenarios it might be required to aggressively
1071 release these resources. The releaseResources() function can be used to
1072 force the clean up of certain resources, especially resource that are cached
1073 and can be recreated later when needed again.
1074
1075 Additionally, calling releaseResources() may result in releasing the entire
1076 scene graph and the associated graphics resources. The
1077 sceneGraphInvalidated() signal will be emitted when this happens. This
1078 behavior is controlled by the setPersistentGraphics() and
1079 setPersistentSceneGraph() functions.
1080
1081 \note All classes with QSG prefix should be used solely on the scene graph's
1082 rendering thread. See \l {Scene Graph and Rendering} for more information.
1083
1084 \section2 Exposure and Visibility
1085
1086 When a QQuickWindow instance is deliberately hidden with hide() or
1087 setVisible(false), it will stop rendering and its scene graph and graphics
1088 context might be released as well. This depends on the settings configured
1089 by setPersistentGraphics() and setPersistentSceneGraph(). The behavior in
1090 this respect is identical to explicitly calling the releaseResources()
1091 function. A window can become not exposed, in other words non-renderable, by
1092 other means as well. This depends on the platform and windowing system. For
1093 example, on Windows minimizing a window makes it stop rendering. On \macos
1094 fully obscuring a window by other windows on top triggers the same. On
1095 Linux/X11, the behavior is dependent on the window manager.
1096
1097 \section2 OpenGL Context and Surface Formats
1098
1099 While it is possible to specify a QSurfaceFormat for every QQuickWindow by
1100 calling the member function setFormat(), windows may also be created from
1101 QML by using the Window and ApplicationWindow elements. In this case there
1102 is no C++ code involved in the creation of the window instance, yet
1103 applications may still wish to set certain surface format values, for
1104 example to request a given OpenGL version or profile. Such applications can
1105 call the static function QSurfaceFormat::setDefaultFormat() at startup. The
1106 specified format will be used for all Quick windows created afterwards.
1107
1108 \section2 Vulkan Instance
1109
1110 When using Vulkan, a QQuickWindow is automatically associated with a
1111 QVulkanInstance that is created and managed internally by the scene graph.
1112 This way most applications do not need to worry about having a \c
1113 VkInstance available since it all happens automatically. In advanced cases
1114 an application may wish to create its own QVulkanInstance, in order to
1115 configure it in a specific way. That is possible as well. Calling
1116 \l{QWindow::setVulkanInstance()}{setVulkanInstance()} on the QQuickWindow
1117 right after construction, before making it visible, leads to using the
1118 application-supplied QVulkanInstance (and the underlying \c VkInstance).
1119 When redirecting via QQuickRenderControl, there is no QVulkanInstance
1120 provided automatically, but rather the application is expected to provide
1121 its own and associate it with the QQuickWindow.
1122
1123 \section2 Graphics Contexts and Devices
1124
1125 When the scene graph is initialized, which typically happens when the
1126 window becomes exposed or, in case of redirected rendering, initialization
1127 is performed \l{QQuickRenderControl::initialize()}{via
1128 QQuickRenderControl}, the context or device objects necessary for rendering
1129 are created automatically. This includes OpenGL contexts, Direct3D devices
1130 and device contexts, Vulkan and Metal devices. These are also queriable by
1131 application code afterwards via
1132 \l{QSGRendererInterface::getResource()}{QSGRendererInterface}. When using
1133 the \c basic render loop, which performs all rendering on the GUI thread,
1134 the same context or device is used with all visible QQuickWindows. The \c
1135 threaded render loop uses a dedicated context or device object for each
1136 rendering thread, and so for each QQuickWindow. With some graphics APIs,
1137 there is a degree of customizability provided via
1138 setGraphicsConfiguration(). This makes it possible, for example, to specify
1139 the list of Vulkan extensions to enable on the \c VkDevice. Alternatively,
1140 it is also possible to provide a set of existing context or device objects
1141 for use by the QQuickWindow, instead of letting it construct its own. This
1142 is achieved through setGraphicsDevice().
1143
1144 \sa QQuickView, QQuickRenderControl, QQuickRenderTarget,
1145 QQuickGraphicsDevice, QQuickGraphicsConfiguration, QSGRendererInterface
1146*/
1147
1148/*!
1149 \qmlmethod void Window::startSystemMove()
1150 \since 6.8
1151
1152 \brief Starts a system-specific move operation.
1153
1154 Starts an interactive move operation on the window using platform support.
1155 The window follows the mouse cursor until the mouse button is released.
1156
1157 Use this method instead of \c setPosition, because it allows the window manager
1158 to handle snapping, tiling, and related animations. On Wayland, \c setPosition
1159 is not supported, so this is the only way the application can influence the
1160 window’s position.
1161*/
1162
1163/*!
1164 \qmlmethod void Window::startSystemResize(Qt::Edges edges)
1165 \since 6.8
1166
1167 \brief Starts a system-specific resize operation.
1168
1169 Starts an interactive resize operation on the window using platform support.
1170 The specified edge follows the mouse cursor while dragging.
1171
1172 Use this method instead of \c setGeometry, because it allows the window manager
1173 to handle snapping and resize animations when resizing to screen edges.
1174
1175 \a edges must be a single edge or a combination of two adjacent edges (a corner).
1176 Other values are not allowed.
1177*/
1178
1179/*!
1180 Constructs a window for displaying a QML scene with parent window \a parent.
1181*/
1182QQuickWindow::QQuickWindow(QWindow *parent)
1183 : QQuickWindow(*new QQuickWindowPrivate, parent)
1184{
1185}
1186
1187
1188
1189/*!
1190 \internal
1191*/
1192QQuickWindow::QQuickWindow(QQuickWindowPrivate &dd, QWindow *parent)
1193 : QWindow(dd, parent)
1194{
1195 Q_D(QQuickWindow);
1196 d->init(this);
1197}
1198
1199/*!
1200 Constructs a window for displaying a QML scene, whose rendering will
1201 be controlled by the \a control object.
1202 Please refer to QQuickRenderControl's documentation for more information.
1203
1204 \since 5.4
1205*/
1206QQuickWindow::QQuickWindow(QQuickRenderControl *control)
1207 : QWindow(*(new QQuickWindowPrivate), nullptr)
1208{
1209 Q_D(QQuickWindow);
1210 d->init(this, control);
1211}
1212
1213/*!
1214 \internal
1215*/
1216QQuickWindow::QQuickWindow(QQuickWindowPrivate &dd, QQuickRenderControl *control)
1217 : QWindow(dd, nullptr)
1218{
1219 Q_D(QQuickWindow);
1220 d->init(this, control);
1221}
1222
1223/*!
1224 Destroys the window.
1225*/
1226QQuickWindow::~QQuickWindow()
1227{
1228 Q_D(QQuickWindow);
1229 d->inDestructor = true;
1230 if (d->renderControl) {
1231 QQuickRenderControlPrivate::get(d->renderControl)->windowDestroyed();
1232 } else if (d->windowManager) {
1233 d->windowManager->removeWindow(this);
1234 d->windowManager->windowDestroyed(this);
1235 }
1236
1237 disconnect(this, &QQuickWindow::focusObjectChanged, this, &QQuickWindow::activeFocusItemChanged);
1238 disconnect(this, &QQuickWindow::screenChanged, this, &QQuickWindow::handleScreenChanged);
1239 disconnect(qApp, &QGuiApplication::applicationStateChanged, this, &QQuickWindow::handleApplicationStateChanged);
1240 disconnect(this, &QQuickWindow::frameSwapped, this, &QQuickWindow::runJobsAfterSwap);
1241
1242 delete d->incubationController; d->incubationController = nullptr;
1243 QQuickRootItem *root = d->contentItem;
1244 d->contentItem = nullptr;
1245 root->setParent(nullptr); // avoid QChildEvent delivery during deletion
1246 delete root;
1247 d->deliveryAgent = nullptr; // avoid forwarding events there during destruction
1248
1249
1250 {
1251 const std::lock_guard locker(d->renderJobMutex);
1252 qDeleteAll(std::exchange(d->beforeSynchronizingJobs, {}));
1253 qDeleteAll(std::exchange(d->afterSynchronizingJobs, {}));
1254 qDeleteAll(std::exchange(d->beforeRenderingJobs, {}));
1255 qDeleteAll(std::exchange(d->afterRenderingJobs, {}));;
1256 qDeleteAll(std::exchange(d->afterSwapJobs, {}));
1257 }
1258
1259 // It is important that the pixmap cache is cleaned up during shutdown.
1260 // Besides playing nice, this also solves a practical problem that
1261 // QQuickTextureFactory implementations in other libraries need
1262 // have their destructors loaded while they the library is still
1263 // loaded into memory.
1264 QQuickPixmap::purgeCache();
1265
1266 for (const QMetaObject::Connection &connection : d->connections)
1267 disconnect(connection);
1268}
1269
1270#if QT_CONFIG(quick_shadereffect)
1271void qtquick_shadereffect_purge_gui_thread_shader_cache();
1272#endif
1273
1274/*!
1275 This function tries to release redundant resources currently held by the QML scene.
1276
1277 Calling this function requests the scene graph to release cached graphics
1278 resources, such as graphics pipeline objects, shader programs, or image
1279 data.
1280
1281 Additionally, depending on the render loop in use, this function may also
1282 result in the scene graph and all window-related rendering resources to be
1283 released. If this happens, the sceneGraphInvalidated() signal will be
1284 emitted, allowing users to clean up their own graphics resources. The
1285 setPersistentGraphics() and setPersistentSceneGraph() functions can be used
1286 to prevent this from happening, if handling the cleanup is not feasible in
1287 the application, at the cost of higher memory usage.
1288
1289 \note The releasing of cached graphics resources, such as graphics
1290 pipelines or shader programs is not dependent on the persistency hints. The
1291 releasing of those will happen regardless of the values of the persistent
1292 graphics and scenegraph hints.
1293
1294 \note This function is not related to the QQuickItem::releaseResources()
1295 virtual function.
1296
1297 \sa sceneGraphInvalidated(), setPersistentGraphics(), setPersistentSceneGraph()
1298 */
1299
1300void QQuickWindow::releaseResources()
1301{
1302 Q_D(QQuickWindow);
1303 if (d->windowManager)
1304 d->windowManager->releaseResources(this);
1305 QQuickPixmap::purgeCache();
1306#if QT_CONFIG(quick_shadereffect)
1307 qtquick_shadereffect_purge_gui_thread_shader_cache();
1308#endif
1309}
1310
1311
1312
1313/*!
1314 Sets whether the graphics resources (graphics device or context,
1315 swapchain, buffers, textures) should be preserved, and cannot be
1316 released until the last window is deleted, to \a persistent. The
1317 default value is true.
1318
1319 When calling releaseResources(), or when the window gets hidden (more
1320 specifically, not renderable), some render loops have the possibility
1321 to release all, not just the cached, graphics resources. This can free
1322 up memory temporarily, but it also means the rendering engine will have
1323 to do a full, potentially costly reinitialization of the resources when
1324 the window needs to render again.
1325
1326 \note The rules for when a window is not renderable are platform and
1327 window manager specific.
1328
1329 \note All graphics resources are released when the last QQuickWindow is
1330 deleted, regardless of this setting.
1331
1332 \note This is a hint, and is not guaranteed that it is taken into account.
1333
1334 \note This hint does not apply to cached resources, that are relatively
1335 cheap to drop and then recreate later. Therefore, calling releaseResources()
1336 will typically lead to releasing those regardless of the value of this hint.
1337
1338 \sa setPersistentSceneGraph(), sceneGraphInitialized(), sceneGraphInvalidated(), releaseResources()
1339 */
1340
1341void QQuickWindow::setPersistentGraphics(bool persistent)
1342{
1343 Q_D(QQuickWindow);
1344 d->persistentGraphics = persistent;
1345}
1346
1347
1348
1349/*!
1350 Returns whether essential graphics resources can be released during the
1351 lifetime of the QQuickWindow.
1352
1353 \note This is a hint, and is not guaranteed that it is taken into account.
1354
1355 \sa setPersistentGraphics()
1356 */
1357
1358bool QQuickWindow::isPersistentGraphics() const
1359{
1360 Q_D(const QQuickWindow);
1361 return d->persistentGraphics;
1362}
1363
1364
1365
1366/*!
1367 Sets whether the scene graph nodes and resources are \a persistent.
1368 Persistent means the nodes and resources cannot be released.
1369 The default value is \c true.
1370
1371 When calling releaseResources(), when the window gets hidden (more
1372 specifically, not renderable), some render loops have the possibility
1373 to release the scene graph nodes and related graphics resources. This
1374 frees up memory temporarily, but will also mean the scene graph has to
1375 be rebuilt when the window renders next time.
1376
1377 \note The rules for when a window is not renderable are platform and
1378 window manager specific.
1379
1380 \note The scene graph nodes and resources are always released when the
1381 last QQuickWindow is deleted, regardless of this setting.
1382
1383 \note This is a hint, and is not guaranteed that it is taken into account.
1384
1385 \sa setPersistentGraphics(), sceneGraphInvalidated(), sceneGraphInitialized(), releaseResources()
1386 */
1387
1388void QQuickWindow::setPersistentSceneGraph(bool persistent)
1389{
1390 Q_D(QQuickWindow);
1391 d->persistentSceneGraph = persistent;
1392}
1393
1394
1395
1396/*!
1397 Returns whether the scene graph nodes and resources can be
1398 released during the lifetime of this QQuickWindow.
1399
1400 \note This is a hint. When and how this happens is implementation
1401 specific.
1402 */
1403
1404bool QQuickWindow::isPersistentSceneGraph() const
1405{
1406 Q_D(const QQuickWindow);
1407 return d->persistentSceneGraph;
1408}
1409
1410/*!
1411 \qmlattachedproperty Item Window::contentItem
1412 \since 5.4
1413
1414 This attached property holds the invisible root item of the scene or
1415 \c null if the item is not in a window. The Window attached property
1416 can be attached to any Item.
1417*/
1418
1419/*!
1420 \property QQuickWindow::contentItem
1421 \brief The invisible root item of the scene.
1422
1423 A QQuickWindow always has a single invisible root item containing all of its content.
1424 To add items to this window, reparent the items to the contentItem or to an existing
1425 item in the scene.
1426*/
1427QQuickItem *QQuickWindow::contentItem() const
1428{
1429 Q_D(const QQuickWindow);
1430
1431 return d->contentItem;
1432}
1433
1434/*!
1435 \property QQuickWindow::activeFocusItem
1436
1437 \brief The item which currently has active focus or \c null if there is
1438 no item with active focus.
1439
1440 \sa QQuickItem::forceActiveFocus(), {Keyboard Focus in Qt Quick}
1441*/
1442QQuickItem *QQuickWindow::activeFocusItem() const
1443{
1444 Q_D(const QQuickWindow);
1445 auto da = d->deliveryAgentPrivate();
1446 Q_ASSERT(da);
1447 return da->activeFocusItem;
1448}
1449
1450/*!
1451 \internal
1452 \reimp
1453*/
1454QObject *QQuickWindow::focusObject() const
1455{
1456 Q_D(const QQuickWindow);
1457 auto da = d->deliveryAgentPrivate();
1458 Q_ASSERT(da);
1459 if (!d->inDestructor && da->activeFocusItem)
1460 return da->activeFocusItem;
1461 return const_cast<QQuickWindow*>(this);
1462}
1463
1464/*! \reimp */
1465bool QQuickWindow::event(QEvent *event)
1466{
1467 Q_D(QQuickWindow);
1468
1469 // bypass QWindow::event dispatching of input events: deliveryAgent takes care of it
1470 QQuickDeliveryAgent *da = d->deliveryAgent;
1471 if (event->isPointerEvent()) {
1472 /*
1473 We can't bypass the virtual functions like mousePressEvent() tabletEvent() etc.,
1474 for the sake of code that subclasses QQuickWindow and overrides them, even though
1475 we no longer need them as entry points for Qt Quick event delivery.
1476 So dispatch to them now, ahead of normal delivery, and stop them from calling
1477 back into this function if they were called from here (avoid recursion).
1478 It could also be that user code expects them to work as entry points, too;
1479 in that case, windowEventDispatch _won't_ be set, so the event comes here and
1480 we'll dispatch it further below.
1481 */
1482 if (d->windowEventDispatch)
1483 return false;
1484 {
1485 const bool wasAccepted = event->isAccepted();
1486 QScopedValueRollback windowEventDispatchGuard(d->windowEventDispatch, true);
1487 qCDebug(lcPtr) << "dispatching to window functions in case of override" << event;
1488 QWindow::event(event);
1489 if (event->isAccepted() && !wasAccepted)
1490 return true;
1491 }
1492 /*
1493 QQuickWindow does not override touchEvent(). If the application has a subclass
1494 of QQuickWindow which allows the event to remain accepted, it means they want
1495 to stop propagation here, so return early (below). But otherwise we will call
1496 QWindow::touchEvent(), which will ignore(); in that case, we need to continue
1497 with the usual delivery below, so we need to undo the ignore().
1498 */
1499 auto pe = static_cast<QPointerEvent *>(event);
1500 if (QQuickDeliveryAgentPrivate::isTouchEvent(pe))
1501 event->accept();
1502 // end of dispatch to user-overridden virtual window functions
1503
1504 /*
1505 When delivering update and release events to existing grabbers,
1506 use the subscene delivery agent, if any. A possible scenario:
1507 1) Two touchpoints pressed on the main window: QQuickWindowPrivate::deliveryAgent delivers to QQuick3DViewport,
1508 which does picking and finds two subscenes ("root" Items mapped onto two different 3D objects) to deliver it to.
1509 2) The QTouchEvent is split up so that each subscene sees points relevant to it.
1510 3) During delivery to either subscene, an item in the subscene grabs.
1511 4) The user moves finger(s) generating a move event: the correct grabber item needs to get the update
1512 via the same subscene delivery agent from which it got the press, so that the coord transform will be done properly.
1513 5) Likewise with the touchpoint releases.
1514 With single-point events (mouse, or only one finger) it's simplified: there can only be one subscene of interest;
1515 for (pt : pe->points()) would only iterate once, so we might as well skip that logic.
1516 */
1517 if (pe->pointCount()) {
1518 const bool synthMouse = QQuickDeliveryAgentPrivate::isSynthMouse(pe);
1519 if (QQuickDeliveryAgentPrivate::subsceneAgentsExist) {
1520 bool ret = false;
1521 // Split up the multi-point event according to the relevant QQuickDeliveryAgent that should deliver to each existing grabber
1522 // but send ungrabbed points to d->deliveryAgent()
1523 QFlatMap<QQuickDeliveryAgent*, QList<QEventPoint>> deliveryAgentsNeedingPoints;
1524 QEventPoint::States eventStates;
1525
1526 auto insert = [&](QQuickDeliveryAgent *ptda, const QEventPoint &pt) {
1527 if (pt.state() == QEventPoint::Pressed && !synthMouse)
1528 pe->clearPassiveGrabbers(pt);
1529 auto &ptList = deliveryAgentsNeedingPoints[ptda];
1530 auto idEquals = [](auto id) { return [id] (const auto &e) { return e.id() == id; }; };
1531 if (std::none_of(ptList.cbegin(), ptList.cend(), idEquals(pt.id())))
1532 ptList.append(pt);
1533 };
1534
1535 for (const auto &pt : pe->points()) {
1536 eventStates |= pt.state();
1537 auto epd = QPointingDevicePrivate::get(const_cast<QPointingDevice*>(pe->pointingDevice()))->queryPointById(pt.id());
1538 Q_ASSERT(epd);
1539 bool foundAgent = false;
1540 if (!epd->exclusiveGrabber.isNull() && !epd->exclusiveGrabberContext.isNull()) {
1541 if (auto ptda = qobject_cast<QQuickDeliveryAgent *>(epd->exclusiveGrabberContext.data())) {
1542 insert(ptda, pt);
1543 qCDebug(lcPtr) << pe->type() << "point" << pt.id() << pt.state()
1544 << "@" << pt.scenePosition() << "will be re-delivered via known grabbing agent" << ptda << "to" << epd->exclusiveGrabber.data();
1545 foundAgent = true;
1546 }
1547 }
1548 for (auto pgda : epd->passiveGrabbersContext) {
1549 if (auto ptda = qobject_cast<QQuickDeliveryAgent *>(pgda.data())) {
1550 insert(ptda, pt);
1551 qCDebug(lcPtr) << pe->type() << "point" << pt.id() << pt.state()
1552 << "@" << pt.scenePosition() << "will be re-delivered via known passive-grabbing agent" << ptda;
1553 foundAgent = true;
1554 }
1555 }
1556 // fallback: if we didn't find remembered/known grabber agent(s), expect the root DA to handle it
1557 if (!foundAgent)
1558 insert(da, pt);
1559 }
1560 for (auto daAndPoints : deliveryAgentsNeedingPoints) {
1561 if (pe->pointCount() > 1) {
1562 Q_ASSERT(QQuickDeliveryAgentPrivate::isTouchEvent(pe));
1563 // if all points have the same state, set the event type accordingly
1564 QEvent::Type eventType = pe->type();
1565 switch (eventStates) {
1566 case QEventPoint::State::Pressed:
1567 eventType = QEvent::TouchBegin;
1568 break;
1569 case QEventPoint::State::Released:
1570 eventType = QEvent::TouchEnd;
1571 break;
1572 default:
1573 eventType = QEvent::TouchUpdate;
1574 break;
1575 }
1576 // Make a new touch event for the subscene, the same way QQuickItemPrivate::localizedTouchEvent() does it
1577 QMutableTouchEvent te(eventType, pe->pointingDevice(), pe->modifiers(), daAndPoints.second);
1578 te.setTimestamp(pe->timestamp());
1579 te.accept();
1580 qCDebug(lcTouch) << daAndPoints.first << "shall now receive" << &te;
1581 ret = daAndPoints.first->event(&te) || ret;
1582 } else {
1583 qCDebug(lcPtr) << daAndPoints.first << "shall now receive" << pe;
1584 ret = daAndPoints.first->event(pe) || ret;
1585 }
1586 }
1587
1588 if (ret) {
1589 d->deliveryAgentPrivate()->clearGrabbers(pe);
1590 return true;
1591 }
1592 } else if (!synthMouse) {
1593 // clear passive grabbers unless it's a system synth-mouse event
1594 // QTBUG-104890: Windows sends synth mouse events (which should be ignored) after touch events
1595 for (const auto &pt : pe->points()) {
1596 if (pt.state() == QEventPoint::Pressed)
1597 pe->clearPassiveGrabbers(pt);
1598 }
1599 }
1600 }
1601
1602 // If it has no points, it's probably a TouchCancel, and DeliveryAgent needs to handle it.
1603 // If we didn't handle it in the block above, handle it now.
1604 // TODO should we deliver to all DAs at once then, since we don't know which one should get it?
1605 // or fix QTBUG-90851 so that the event always has points?
1606 qCDebug(lcHoverTrace) << this << "some sort of event" << event;
1607 bool ret = (da && da->event(event));
1608
1609 d->deliveryAgentPrivate()->clearGrabbers(pe);
1610
1611 if (pe->type() == QEvent::MouseButtonPress || pe->type() == QEvent::MouseButtonRelease) {
1612 // Ensure that we synthesize a context menu event as QWindow::event does, if necessary.
1613 // We only send the context menu event if the pointer event wasn't accepted (ret == false).
1614 d->maybeSynthesizeContextMenuEvent(static_cast<QMouseEvent *>(pe));
1615 }
1616
1617 if (ret)
1618 return true;
1619 } else if (event->isInputEvent()) {
1620 if (da && da->event(event))
1621 return true;
1622 }
1623
1624 switch (event->type()) {
1625 // a few more types that are not QInputEvents, but QQuickDeliveryAgent needs to handle them anyway
1626 case QEvent::FocusAboutToChange:
1627 case QEvent::Enter:
1628 case QEvent::Leave:
1629 case QEvent::InputMethod:
1630 case QEvent::InputMethodQuery:
1631#if QT_CONFIG(quick_draganddrop)
1632 case QEvent::DragEnter:
1633 case QEvent::DragLeave:
1634 case QEvent::DragMove:
1635 case QEvent::Drop:
1636#endif
1637 if (d->inDestructor)
1638 return false;
1639 if (da && da->event(event))
1640 return true;
1641 break;
1642 case QEvent::LanguageChange:
1643 case QEvent::LocaleChange:
1644 if (d->contentItem)
1645 QCoreApplication::sendEvent(d->contentItem, event);
1646 break;
1647 case QEvent::UpdateRequest:
1648 if (d->windowManager)
1649 d->windowManager->handleUpdateRequest(this);
1650 break;
1651 case QEvent::PlatformSurface:
1652 if ((static_cast<QPlatformSurfaceEvent *>(event))->surfaceEventType() == QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed) {
1653 // Ensure that the rendering thread is notified before
1654 // the QPlatformWindow is destroyed.
1655 if (d->windowManager)
1656 d->windowManager->hide(this);
1657 }
1658 break;
1659 case QEvent::WindowDeactivate:
1660 if (auto da = d->deliveryAgentPrivate())
1661 da->handleWindowDeactivate(this);
1662 Q_FALLTHROUGH();
1663 case QEvent::WindowActivate:
1664 if (d->contentItem)
1665 QCoreApplication::sendEvent(d->contentItem, event);
1666 break;
1667 case QEvent::ApplicationPaletteChange:
1668 d->inheritPalette(QGuiApplication::palette());
1669 if (d->contentItem)
1670 QCoreApplication::sendEvent(d->contentItem, event);
1671 break;
1672 case QEvent::DevicePixelRatioChange:
1673 physicalDpiChanged();
1674 break;
1675 case QEvent::SafeAreaMarginsChange:
1676 QQuickSafeArea::updateSafeAreasRecursively(d->contentItem);
1677 break;
1678 case QEvent::ChildWindowAdded: {
1679 auto *childEvent = static_cast<QChildWindowEvent*>(event);
1680 auto *childWindow = childEvent->child();
1681 qCDebug(lcQuickWindow) << "Child window" << childWindow << "added to" << this;
1682 if (childWindow->handle()) {
1683 // The reparenting has already resulted in the native window
1684 // being added to its parent, on top of all other windows. We need
1685 // to do a synchronous re-stacking of the windows here, to avoid
1686 // leaving the window in the wrong position while waiting for the
1687 // asynchronous callback to QQuickWindow::polishItems().
1688 d->updateChildWindowStackingOrder();
1689 } else {
1690 qCDebug(lcQuickWindow) << "No platform window yet."
1691 << "Deferring child window stacking until surface creation";
1692 }
1693 break;
1694 }
1695 default:
1696 break;
1697 }
1698
1699 if (event->type() == QEvent::Type(QQuickWindowPrivate::FullUpdateRequest))
1700 update();
1701 else if (event->type() == QEvent::Type(QQuickWindowPrivate::TriggerContextCreationFailure))
1702 d->windowManager->handleContextCreationFailure(this);
1703
1704 if (event->isPointerEvent())
1705 return true;
1706 else
1707 return QWindow::event(event);
1708}
1709
1710void QQuickWindowPrivate::maybeSynthesizeContextMenuEvent(QMouseEvent *event)
1711{
1712 // See comment in QQuickWindow::event; we need to follow that pattern here,
1713 // otherwise the context menu event will be sent before the press (since
1714 // QQuickWindow::mousePressEvent returns early if windowEventDispatch is true).
1715 // If we don't do this, the incorrect order will cause the menu to
1716 // immediately close when the press is delivered.
1717 // Also, don't send QContextMenuEvent if a menu has already been opened while
1718 // handling a QMouseEvent in which the right button was pressed or released.
1719 if (windowEventDispatch || !rmbContextMenuEventEnabled)
1720 return;
1721
1722#if QT_VERSION < QT_VERSION_CHECK(7, 0, 0)
1723 /*
1724 If this is a press event and the EventPoint already has a grab, it may be
1725 that a TapHandler.onTapped() or MouseArea.onClicked() function
1726 intends to show a context menu. Menus were often added that way; so if
1727 we can detect that it's likely, then don't synthesize a QContextMenuEvent,
1728 in case it could be redundant, even though we can't tell in advance
1729 whether the TapHandler or MouseArea will open a menu or do something else.
1730 However, we are only checking for MouseArea and TapHandler; it's also
1731 possible (but hopefully much less likely) that a user adds a custom
1732 QQuickItem subclass to handle mouse events to open a context menu.
1733 If a bug gets written about that, we can ask them to try out the
1734 ContextMenu attached property instead, or handle the QContextMenuEvent
1735 in their subclass. Anyway, let's expect applications to be adjusted for
1736 Qt 7 or before, so that we can get rid of this second-guessing hack.
1737 */
1738 const auto &firstPoint = event->points().first();
1739 auto hasRightButtonTapHandler = [](const auto &passiveGrabbers) {
1740 return std::find_if(passiveGrabbers.constBegin(), passiveGrabbers.constEnd(),
1741 [](const auto grabber) {
1742 auto *tapHandler = qmlobject_cast<QQuickTapHandler *>(grabber);
1743 return tapHandler && tapHandler->acceptedButtons().testFlag(Qt::RightButton); })
1744 != passiveGrabbers.constEnd();
1745 };
1746 if (event->type() == QEvent::MouseButtonPress && event->button() == Qt::RightButton &&
1747 (qmlobject_cast<QQuickMouseArea *>(event->exclusiveGrabber(firstPoint))
1748 || hasRightButtonTapHandler(event->passiveGrabbers(firstPoint)))) {
1749 qCDebug(lcPtr) << "skipping QContextMenuEvent synthesis due to grabber(s)" << event;
1750 return;
1751 }
1752#endif
1753
1754 QWindowPrivate::maybeSynthesizeContextMenuEvent(event);
1755}
1756
1757void QQuickWindowPrivate::updateChildWindowStackingOrder(QQuickItem *item)
1758{
1759 Q_Q(QQuickWindow);
1760
1761 if (!item) {
1762 qCDebug(lcQuickWindow) << "Updating child window stacking order for" << q;
1763 item = contentItem;
1764 }
1765 auto *itemPrivate = QQuickItemPrivate::get(item);
1766 const auto paintOrderChildItems = itemPrivate->paintOrderChildItems();
1767 for (auto *child : paintOrderChildItems) {
1768 if (auto *windowContainer = qobject_cast<QQuickWindowContainer*>(child)) {
1769 auto *window = windowContainer->containedWindow();
1770 if (!window) {
1771 qCDebug(lcQuickWindow) << windowContainer << "has no contained window yet";
1772 continue;
1773 }
1774 if (window->parent() != q) {
1775 qCDebug(lcQuickWindow) << window << "is not yet child of this window";
1776 continue;
1777 }
1778 qCDebug(lcQuickWindow) << "Raising" << window << "owned by" << windowContainer;
1779 window->raise();
1780 }
1781
1782 updateChildWindowStackingOrder(child);
1783 }
1784}
1785
1786/*! \reimp */
1787void QQuickWindow::keyPressEvent(QKeyEvent *e)
1788{
1789 Q_D(QQuickWindow);
1790 if (d->windowEventDispatch)
1791 return;
1792 auto da = d->deliveryAgentPrivate();
1793 Q_ASSERT(da);
1794 da->deliverKeyEvent(e);
1795}
1796
1797/*! \reimp */
1798void QQuickWindow::keyReleaseEvent(QKeyEvent *e)
1799{
1800 Q_D(QQuickWindow);
1801 if (d->windowEventDispatch)
1802 return;
1803 auto da = d->deliveryAgentPrivate();
1804 Q_ASSERT(da);
1805 da->deliverKeyEvent(e);
1806}
1807
1808#if QT_CONFIG(wheelevent)
1809/*! \reimp */
1810void QQuickWindow::wheelEvent(QWheelEvent *event)
1811{
1812 Q_D(QQuickWindow);
1813 if (d->windowEventDispatch)
1814 return;
1815 auto da = d->deliveryAgentPrivate();
1816 Q_ASSERT(da);
1817 da->deliverSinglePointEventUntilAccepted(event);
1818}
1819#endif // wheelevent
1820
1821#if QT_CONFIG(tabletevent)
1822/*! \reimp */
1823void QQuickWindow::tabletEvent(QTabletEvent *event)
1824{
1825 Q_D(QQuickWindow);
1826 if (d->windowEventDispatch)
1827 return;
1828 auto da = d->deliveryAgentPrivate();
1829 Q_ASSERT(da);
1830 da->deliverPointerEvent(event);
1831}
1832#endif // tabletevent
1833
1834/*! \reimp */
1835void QQuickWindow::mousePressEvent(QMouseEvent *event)
1836{
1837 Q_D(QQuickWindow);
1838 if (d->windowEventDispatch)
1839 return;
1840 auto da = d->deliveryAgentPrivate();
1841 Q_ASSERT(da);
1842 da->handleMouseEvent(event);
1843}
1844/*! \reimp */
1845void QQuickWindow::mouseMoveEvent(QMouseEvent *event)
1846{
1847 Q_D(QQuickWindow);
1848 if (d->windowEventDispatch)
1849 return;
1850 auto da = d->deliveryAgentPrivate();
1851 Q_ASSERT(da);
1852 da->handleMouseEvent(event);
1853}
1854/*! \reimp */
1855void QQuickWindow::mouseDoubleClickEvent(QMouseEvent *event)
1856{
1857 Q_D(QQuickWindow);
1858 if (d->windowEventDispatch)
1859 return;
1860 auto da = d->deliveryAgentPrivate();
1861 Q_ASSERT(da);
1862 da->handleMouseEvent(event);
1863}
1864/*! \reimp */
1865void QQuickWindow::mouseReleaseEvent(QMouseEvent *event)
1866{
1867 Q_D(QQuickWindow);
1868 if (d->windowEventDispatch)
1869 return;
1870 auto da = d->deliveryAgentPrivate();
1871 Q_ASSERT(da);
1872 da->handleMouseEvent(event);
1873}
1874
1875#if QT_CONFIG(cursor)
1876void QQuickWindowPrivate::updateCursor(const QPointF &scenePos, QQuickItem *rootItem)
1877{
1878 Q_Q(QQuickWindow);
1879 if (!rootItem)
1880 rootItem = contentItem;
1881 auto cursorItemAndHandler = findCursorItemAndHandler(rootItem, scenePos, scenePos);
1882 if (cursorItem != cursorItemAndHandler.first || cursorHandler != cursorItemAndHandler.second ||
1883 (cursorItemAndHandler.second && QQuickPointerHandlerPrivate::get(cursorItemAndHandler.second)->cursorDirty)) {
1884 QWindow *renderWindow = QQuickRenderControl::renderWindowFor(q);
1885 QWindow *window = renderWindow ? renderWindow : q;
1886 cursorItem = cursorItemAndHandler.first;
1887 cursorHandler = cursorItemAndHandler.second;
1888 if (cursorHandler)
1889 QQuickPointerHandlerPrivate::get(cursorItemAndHandler.second)->cursorDirty = false;
1890 if (cursorItem) {
1891 const auto cursor = QQuickItemPrivate::get(cursorItem)->effectiveCursor(cursorHandler);
1892 qCDebug(lcHoverCursor) << "setting cursor" << cursor << "from" << cursorHandler << "or" << cursorItem;
1893 window->setCursor(cursor);
1894 } else {
1895 qCDebug(lcHoverCursor) << "unsetting cursor";
1896 window->unsetCursor();
1897 }
1898 }
1899}
1900
1901std::pair<QQuickItem*, QQuickPointerHandler*> QQuickWindowPrivate::findCursorItemAndHandler(QQuickItem *item,
1902 const QPointF &localPos, const QPointF &scenePos) const
1903{
1904 QQuickItemPrivate *itemPrivate = QQuickItemPrivate::get(item);
1905 if (itemPrivate->effectivelyClipsEventHandlingChildren() &&
1906 !itemPrivate->eventHandlingBounds().contains(localPos)) {
1907#ifdef QT_BUILD_INTERNAL
1908 ++QQuickItemPrivate::effectiveClippingSkips_counter;
1909#endif
1910 return {nullptr, nullptr};
1911 }
1912
1913 if (itemPrivate->subtreeCursorEnabled) {
1914 QList<QQuickItem *> children = itemPrivate->paintOrderChildItems();
1915 for (int ii = children.size() - 1; ii >= 0; --ii) {
1916 QQuickItem *child = children.at(ii);
1917 if (!child->isVisible() || !child->isEnabled() || QQuickItemPrivate::get(child)->culled)
1918 continue;
1919
1920 const QQuickItemPrivate *childPrivate = QQuickItemPrivate::get(child);
1921 QTransform childToParent;
1922 childPrivate->itemToParentTransform(&childToParent);
1923 const QPointF childLocalPos = childToParent.inverted().map(localPos);
1924 auto ret = findCursorItemAndHandler(child, childLocalPos, scenePos);
1925 if (ret.first)
1926 return ret;
1927 }
1928 if (itemPrivate->hasCursorHandler) {
1929 if (auto handler = itemPrivate->effectiveCursorHandler()) {
1930 if (handler->parentContains(localPos, scenePos))
1931 return {item, handler};
1932 }
1933 }
1934 if (itemPrivate->hasCursor) {
1935 if (item->contains(localPos))
1936 return {item, nullptr};
1937 }
1938 }
1939
1940 return {nullptr, nullptr};
1941}
1942#endif
1943
1944void QQuickWindowPrivate::clearFocusObject()
1945{
1946 if (auto da = deliveryAgentPrivate())
1947 da->clearFocusObject();
1948}
1949
1950void QQuickWindowPrivate::setFocusToTarget(FocusTarget target, Qt::FocusReason reason)
1951{
1952 if (!contentItem)
1953 return;
1954
1955 QQuickItem *newFocusItem = nullptr;
1956 switch (target) {
1957 case FocusTarget::First:
1958 case FocusTarget::Last: {
1959 const bool forward = (target == FocusTarget::First);
1960 newFocusItem = QQuickItemPrivate::nextPrevItemInTabFocusChain(contentItem, forward);
1961 if (newFocusItem) {
1962 const auto *itemPriv = QQuickItemPrivate::get(newFocusItem);
1963 if (itemPriv->subFocusItem && itemPriv->flags & QQuickItem::ItemIsFocusScope)
1964 deliveryAgentPrivate()->clearFocusInScope(newFocusItem, itemPriv->subFocusItem, reason);
1965 }
1966 break;
1967 }
1968 case FocusTarget::Next:
1969 case FocusTarget::Prev: {
1970 const auto da = deliveryAgentPrivate();
1971 Q_ASSERT(da);
1972 QQuickItem *focusItem = da->focusTargetItem() ? da->focusTargetItem() : contentItem;
1973 bool forward = (target == FocusTarget::Next);
1974 newFocusItem = QQuickItemPrivate::nextPrevItemInTabFocusChain(focusItem, forward);
1975 break;
1976 }
1977 default:
1978 break;
1979 }
1980
1981 if (newFocusItem)
1982 newFocusItem->forceActiveFocus(reason);
1983}
1984
1985/*!
1986 \qmlproperty list<QtObject> Window::data
1987 \qmldefault
1988
1989 The data property allows you to freely mix visual children, resources
1990 and other Windows in a Window.
1991
1992 If you assign another Window to the data list, the nested window will
1993 become "transient for" the outer Window.
1994
1995 If you assign an \l Item to the data list, it becomes a child of the
1996 Window's \l contentItem, so that it appears inside the window. The item's
1997 parent will be the window's contentItem, which is the root of the Item
1998 ownership tree within that Window.
1999
2000 If you assign any other object type, it is added as a resource.
2001
2002 It should not generally be necessary to refer to the \c data property,
2003 as it is the default property for Window and thus all child items are
2004 automatically assigned to this property.
2005
2006 \sa QWindow::transientParent()
2007 */
2008
2009void QQuickWindowPrivate::data_append(QQmlListProperty<QObject> *property, QObject *o)
2010{
2011 if (!o)
2012 return;
2013 QQuickWindow *that = static_cast<QQuickWindow *>(property->object);
2014 QQmlListProperty<QObject> itemProperty = QQuickItemPrivate::get(that->contentItem())->data();
2015 itemProperty.append(&itemProperty, o);
2016}
2017
2018qsizetype QQuickWindowPrivate::data_count(QQmlListProperty<QObject> *property)
2019{
2020 QQuickWindow *win = static_cast<QQuickWindow*>(property->object);
2021 if (!win || !win->contentItem() || !QQuickItemPrivate::get(win->contentItem())->data().count)
2022 return 0;
2023 QQmlListProperty<QObject> itemProperty = QQuickItemPrivate::get(win->contentItem())->data();
2024 return itemProperty.count(&itemProperty);
2025}
2026
2027QObject *QQuickWindowPrivate::data_at(QQmlListProperty<QObject> *property, qsizetype i)
2028{
2029 QQuickWindow *win = static_cast<QQuickWindow*>(property->object);
2030 QQmlListProperty<QObject> itemProperty = QQuickItemPrivate::get(win->contentItem())->data();
2031 return itemProperty.at(&itemProperty, i);
2032}
2033
2034void QQuickWindowPrivate::data_clear(QQmlListProperty<QObject> *property)
2035{
2036 QQuickWindow *win = static_cast<QQuickWindow*>(property->object);
2037 QQmlListProperty<QObject> itemProperty = QQuickItemPrivate::get(win->contentItem())->data();
2038 itemProperty.clear(&itemProperty);
2039}
2040
2041void QQuickWindowPrivate::data_removeLast(QQmlListProperty<QObject> *property)
2042{
2043 QQuickWindow *win = static_cast<QQuickWindow*>(property->object);
2044 QQmlListProperty<QObject> itemProperty = QQuickItemPrivate::get(win->contentItem())->data();
2045 itemProperty.removeLast(&itemProperty);
2046}
2047
2048bool QQuickWindowPrivate::isRenderable() const
2049{
2050 Q_Q(const QQuickWindow);
2051 return ((q->isExposed() && q->isVisible())) && q->geometry().isValid();
2052}
2053
2054void QQuickWindowPrivate::rhiCreationFailureMessage(const QString &backendName,
2055 QString *translatedMessage,
2056 QString *untranslatedMessage)
2057{
2058 const char msg[] = QT_TRANSLATE_NOOP("QQuickWindow",
2059 "Failed to initialize graphics backend for %1.");
2060 *translatedMessage = QQuickWindow::tr(msg).arg(backendName);
2061 *untranslatedMessage = QString::fromLatin1(msg).arg(backendName);
2062}
2063
2064void QQuickWindowPrivate::cleanupNodes()
2065{
2066 qDeleteAll(cleanupNodeList);
2067 cleanupNodeList.clear();
2068}
2069
2070void QQuickWindowPrivate::cleanupNodesOnShutdown(QQuickItem *item)
2071{
2072 QQuickItemPrivate *p = QQuickItemPrivate::get(item);
2073 if (p->itemNodeInstance) {
2074 delete p->itemNodeInstance;
2075 p->itemNodeInstance = nullptr;
2076
2077 if (p->extra.isAllocated()) {
2078 p->extra->opacityNode = nullptr;
2079 p->extra->clipNode = nullptr;
2080 p->extra->rootNode = nullptr;
2081 }
2082
2083 p->paintNode = nullptr;
2084
2085 p->dirty(QQuickItemPrivate::Window);
2086 }
2087
2088 // Qt 7: Make invalidateSceneGraph a virtual member of QQuickItem
2089 if (p->flags & QQuickItem::ItemHasContents) {
2090 const QMetaObject *mo = item->metaObject();
2091 int index = mo->indexOfSlot("invalidateSceneGraph()");
2092 if (index >= 0) {
2093 const QMetaMethod &method = mo->method(index);
2094 // Skip functions named invalidateSceneGraph() in QML items.
2095 if (strstr(method.enclosingMetaObject()->className(), "_QML_") == nullptr)
2096 method.invoke(item, Qt::DirectConnection);
2097 }
2098 }
2099
2100 for (int ii = 0; ii < p->childItems.size(); ++ii)
2101 cleanupNodesOnShutdown(p->childItems.at(ii));
2102}
2103
2104// This must be called from the render thread, with the main thread frozen
2105void QQuickWindowPrivate::cleanupNodesOnShutdown()
2106{
2107 Q_Q(QQuickWindow);
2108 cleanupNodes();
2109 cleanupNodesOnShutdown(contentItem);
2110 for (QSet<QQuickItem *>::const_iterator it = parentlessItems.begin(), cend = parentlessItems.end(); it != cend; ++it)
2111 cleanupNodesOnShutdown(*it);
2112 animationController->windowNodesDestroyed();
2113 q->cleanupSceneGraph();
2114}
2115
2116void QQuickWindowPrivate::updateDirtyNodes()
2117{
2118 qCDebug(lcDirty) << "QQuickWindowPrivate::updateDirtyNodes():";
2119
2120 cleanupNodes();
2121
2122 QQuickItem *updateList = dirtyItemList;
2123 dirtyItemList = nullptr;
2124 if (updateList) QQuickItemPrivate::get(updateList)->prevDirtyItem = &updateList;
2125
2126 while (updateList) {
2127 QQuickItem *item = updateList;
2128 QQuickItemPrivate *itemPriv = QQuickItemPrivate::get(item);
2129 itemPriv->removeFromDirtyList();
2130
2131 qCDebug(lcDirty) << " QSGNode:" << item << qPrintable(itemPriv->dirtyToString());
2132 updateDirtyNode(item);
2133 }
2134}
2135
2136static inline QSGNode *qquickitem_before_paintNode(QQuickItemPrivate *d)
2137{
2138 const QList<QQuickItem *> childItems = d->paintOrderChildItems();
2139 QQuickItem *before = nullptr;
2140 for (int i=0; i<childItems.size(); ++i) {
2141 QQuickItemPrivate *dd = QQuickItemPrivate::get(childItems.at(i));
2142 // Perform the same check as the in fetchNextNode below.
2143 if (dd->z() < 0 && (dd->explicitVisible || (dd->extra.isAllocated() && dd->extra->effectRefCount)))
2144 before = childItems.at(i);
2145 else
2146 break;
2147 }
2148 return Q_UNLIKELY(before) ? QQuickItemPrivate::get(before)->itemNode() : nullptr;
2149}
2150
2151static QSGNode *fetchNextNode(QQuickItemPrivate *itemPriv, int &ii, bool &returnedPaintNode)
2152{
2153 QList<QQuickItem *> orderedChildren = itemPriv->paintOrderChildItems();
2154
2155 for (; ii < orderedChildren.size() && orderedChildren.at(ii)->z() < 0; ++ii) {
2156 QQuickItemPrivate *childPrivate = QQuickItemPrivate::get(orderedChildren.at(ii));
2157 if (!childPrivate->explicitVisible &&
2158 (!childPrivate->extra.isAllocated() || !childPrivate->extra->effectRefCount))
2159 continue;
2160
2161 ii++;
2162 return childPrivate->itemNode();
2163 }
2164
2165 if (itemPriv->paintNode && !returnedPaintNode) {
2166 returnedPaintNode = true;
2167 return itemPriv->paintNode;
2168 }
2169
2170 for (; ii < orderedChildren.size(); ++ii) {
2171 QQuickItemPrivate *childPrivate = QQuickItemPrivate::get(orderedChildren.at(ii));
2172 if (!childPrivate->explicitVisible &&
2173 (!childPrivate->extra.isAllocated() || !childPrivate->extra->effectRefCount))
2174 continue;
2175
2176 ii++;
2177 return childPrivate->itemNode();
2178 }
2179
2180 return nullptr;
2181}
2182
2183void QQuickWindowPrivate::updateDirtyNode(QQuickItem *item)
2184{
2185 QQuickItemPrivate *itemPriv = QQuickItemPrivate::get(item);
2186 quint32 dirty = itemPriv->dirtyAttributes;
2187 itemPriv->dirtyAttributes = 0;
2188
2189 if ((dirty & QQuickItemPrivate::TransformUpdateMask) ||
2190 (dirty & QQuickItemPrivate::Size && itemPriv->origin() != QQuickItem::TopLeft &&
2191 (itemPriv->scale() != 1. || itemPriv->rotation() != 0.))) {
2192
2193 QMatrix4x4 matrix;
2194
2195 if (itemPriv->x != 0. || itemPriv->y != 0.)
2196 matrix.translate(itemPriv->x, itemPriv->y);
2197
2198 for (int ii = itemPriv->transforms.size() - 1; ii >= 0; --ii)
2199 itemPriv->transforms.at(ii)->applyTo(&matrix);
2200
2201 if (itemPriv->scale() != 1. || itemPriv->rotation() != 0.) {
2202 QPointF origin = item->transformOriginPoint();
2203 matrix.translate(origin.x(), origin.y());
2204 if (itemPriv->scale() != 1.)
2205 matrix.scale(itemPriv->scale(), itemPriv->scale());
2206 if (itemPriv->rotation() != 0.)
2207 matrix.rotate(itemPriv->rotation(), 0, 0, 1);
2208 matrix.translate(-origin.x(), -origin.y());
2209 }
2210
2211 itemPriv->itemNode()->setMatrix(matrix);
2212 }
2213
2214 const bool clipEffectivelyChanged = dirty & (QQuickItemPrivate::Clip | QQuickItemPrivate::Window);
2215 if (clipEffectivelyChanged) {
2216 QSGNode *parent = itemPriv->opacityNode() ? (QSGNode *)itemPriv->opacityNode()
2217 : (QSGNode *)itemPriv->itemNode();
2218 QSGNode *child = itemPriv->rootNode();
2219
2220 if (bool initializeClipNode = item->clip() && itemPriv->clipNode() == nullptr;
2221 initializeClipNode) {
2222 QQuickDefaultClipNode *clip = new QQuickDefaultClipNode(item->clipRect());
2223 itemPriv->extra.value().clipNode = clip;
2224 clip->update();
2225
2226 if (!child) {
2227 parent->reparentChildNodesTo(clip);
2228 parent->appendChildNode(clip);
2229 } else {
2230 parent->removeChildNode(child);
2231 clip->appendChildNode(child);
2232 parent->appendChildNode(clip);
2233 }
2234
2235 } else if (bool updateClipNode = item->clip() && itemPriv->clipNode() != nullptr;
2236 updateClipNode) {
2237 QQuickDefaultClipNode *clip = itemPriv->clipNode();
2238 clip->setClipRect(item->clipRect());
2239 clip->update();
2240 } else if (bool removeClipNode = !item->clip() && itemPriv->clipNode() != nullptr;
2241 removeClipNode) {
2242 QQuickDefaultClipNode *clip = itemPriv->clipNode();
2243 parent->removeChildNode(clip);
2244 if (child) {
2245 clip->removeChildNode(child);
2246 parent->appendChildNode(child);
2247 } else {
2248 clip->reparentChildNodesTo(parent);
2249 }
2250
2251 delete itemPriv->clipNode();
2252 itemPriv->extra->clipNode = nullptr;
2253 }
2254 }
2255
2256 const int effectRefCount = itemPriv->extra.isAllocated() ? itemPriv->extra->effectRefCount : 0;
2257 const bool effectRefEffectivelyChanged =
2258 (dirty & (QQuickItemPrivate::EffectReference | QQuickItemPrivate::Window))
2259 && ((effectRefCount == 0) != (itemPriv->rootNode() == nullptr));
2260 if (effectRefEffectivelyChanged) {
2261 if (dirty & QQuickItemPrivate::ChildrenUpdateMask)
2262 itemPriv->childContainerNode()->removeAllChildNodes();
2263
2264 QSGNode *parent = itemPriv->clipNode();
2265 if (!parent)
2266 parent = itemPriv->opacityNode();
2267 if (!parent)
2268 parent = itemPriv->itemNode();
2269
2270 if (itemPriv->extra.isAllocated() && itemPriv->extra->effectRefCount) {
2271 Q_ASSERT(itemPriv->rootNode() == nullptr);
2272 QSGRootNode *root = new QSGRootNode();
2273 itemPriv->extra->rootNode = root;
2274 parent->reparentChildNodesTo(root);
2275 parent->appendChildNode(root);
2276 } else {
2277 Q_ASSERT(itemPriv->rootNode() != nullptr);
2278 QSGRootNode *root = itemPriv->rootNode();
2279 parent->removeChildNode(root);
2280 root->reparentChildNodesTo(parent);
2281 delete itemPriv->rootNode();
2282 itemPriv->extra->rootNode = nullptr;
2283 }
2284 }
2285
2286 if (dirty & QQuickItemPrivate::ChildrenUpdateMask) {
2287 int ii = 0;
2288 bool fetchedPaintNode = false;
2289 QList<QQuickItem *> orderedChildren = itemPriv->paintOrderChildItems();
2290 int desiredNodesSize = orderedChildren.size() + (itemPriv->paintNode ? 1 : 0);
2291
2292 // now start making current state match the promised land of
2293 // desiredNodes. in the case of our current state matching desiredNodes
2294 // (though why would we get ChildrenUpdateMask with no changes?) then we
2295 // should make no changes at all.
2296
2297 // how many nodes did we process, when examining changes
2298 int desiredNodesProcessed = 0;
2299
2300 // currentNode is how far, in our present tree, we have processed. we
2301 // make use of this later on to trim the current child list if the
2302 // desired list is shorter.
2303 QSGNode *groupNode = itemPriv->childContainerNode();
2304 QSGNode *currentNode = groupNode->firstChild();
2305 QSGNode *desiredNode = nullptr;
2306
2307 while (currentNode && (desiredNode = fetchNextNode(itemPriv, ii, fetchedPaintNode))) {
2308 if (currentNode != desiredNode) {
2309 // uh oh... reality and our utopic paradise are diverging!
2310 // we need to reconcile this...
2311 if (currentNode->nextSibling() == desiredNode) {
2312 // nice and simple: a node was removed, and the next in line is correct.
2313 groupNode->removeChildNode(currentNode);
2314 } else {
2315 // a node needs to be added..
2316 // remove it from any pre-existing parent, and push it before currentNode,
2317 // so it's in the correct place...
2318 if (desiredNode->parent()) {
2319 desiredNode->parent()->removeChildNode(desiredNode);
2320 }
2321 groupNode->insertChildNodeBefore(desiredNode, currentNode);
2322 }
2323
2324 // continue iteration at the correct point, now desiredNode is in place...
2325 currentNode = desiredNode;
2326 }
2327
2328 currentNode = currentNode->nextSibling();
2329 desiredNodesProcessed++;
2330 }
2331
2332 // if we didn't process as many nodes as in the new list, then we have
2333 // more nodes at the end of desiredNodes to append to our list.
2334 // this will be the case when adding new nodes, for instance.
2335 if (desiredNodesProcessed < desiredNodesSize) {
2336 while ((desiredNode = fetchNextNode(itemPriv, ii, fetchedPaintNode))) {
2337 if (desiredNode->parent())
2338 desiredNode->parent()->removeChildNode(desiredNode);
2339 groupNode->appendChildNode(desiredNode);
2340 }
2341 } else if (currentNode) {
2342 // on the other hand, if we processed less than our current node
2343 // tree, then nodes have been _removed_ from the scene, and we need
2344 // to take care of that here.
2345 while (currentNode) {
2346 QSGNode *node = currentNode->nextSibling();
2347 groupNode->removeChildNode(currentNode);
2348 currentNode = node;
2349 }
2350 }
2351 }
2352
2353 if ((dirty & QQuickItemPrivate::Size) && itemPriv->clipNode()) {
2354 itemPriv->clipNode()->setRect(item->clipRect());
2355 itemPriv->clipNode()->update();
2356 }
2357
2358 if (dirty & (QQuickItemPrivate::OpacityValue | QQuickItemPrivate::Visible
2359 | QQuickItemPrivate::HideReference | QQuickItemPrivate::Window))
2360 {
2361 qreal opacity = itemPriv->explicitVisible && (!itemPriv->extra.isAllocated() || itemPriv->extra->hideRefCount == 0)
2362 ? itemPriv->opacity() : qreal(0);
2363
2364 if (opacity != 1 && !itemPriv->opacityNode()) {
2365 QSGOpacityNode *node = new QSGOpacityNode;
2366 itemPriv->extra.value().opacityNode = node;
2367
2368 QSGNode *parent = itemPriv->itemNode();
2369 QSGNode *child = itemPriv->clipNode();
2370 if (!child)
2371 child = itemPriv->rootNode();
2372
2373 if (child) {
2374 parent->removeChildNode(child);
2375 node->appendChildNode(child);
2376 parent->appendChildNode(node);
2377 } else {
2378 parent->reparentChildNodesTo(node);
2379 parent->appendChildNode(node);
2380 }
2381 }
2382 if (itemPriv->opacityNode())
2383 itemPriv->opacityNode()->setOpacity(opacity);
2384 }
2385
2386 if (dirty & QQuickItemPrivate::ContentUpdateMask) {
2387
2388 if (itemPriv->flags & QQuickItem::ItemHasContents) {
2389 updatePaintNodeData.transformNode = itemPriv->itemNode();
2390 itemPriv->paintNode = item->updatePaintNode(itemPriv->paintNode, &updatePaintNodeData);
2391
2392 Q_ASSERT(itemPriv->paintNode == nullptr ||
2393 itemPriv->paintNode->parent() == nullptr ||
2394 itemPriv->paintNode->parent() == itemPriv->childContainerNode());
2395
2396 if (itemPriv->paintNode && itemPriv->paintNode->parent() == nullptr) {
2397 QSGNode *before = qquickitem_before_paintNode(itemPriv);
2398 if (before && before->parent()) {
2399 Q_ASSERT(before->parent() == itemPriv->childContainerNode());
2400 itemPriv->childContainerNode()->insertChildNodeAfter(itemPriv->paintNode, before);
2401 } else {
2402 itemPriv->childContainerNode()->prependChildNode(itemPriv->paintNode);
2403 }
2404 }
2405 } else if (itemPriv->paintNode) {
2406 delete itemPriv->paintNode;
2407 itemPriv->paintNode = nullptr;
2408 }
2409 }
2410
2411#ifndef QT_NO_DEBUG
2412 // Check consistency.
2413
2414 QList<QSGNode *> nodes;
2415 nodes << itemPriv->itemNodeInstance
2416 << itemPriv->opacityNode()
2417 << itemPriv->clipNode()
2418 << itemPriv->rootNode()
2419 << itemPriv->paintNode;
2420 nodes.removeAll(nullptr);
2421
2422 Q_ASSERT(nodes.constFirst() == itemPriv->itemNodeInstance);
2423 for (int i=1; i<nodes.size(); ++i) {
2424 QSGNode *n = nodes.at(i);
2425 // Failing this means we messed up reparenting
2426 Q_ASSERT(n->parent() == nodes.at(i-1));
2427 // Only the paintNode and the one who is childContainer may have more than one child.
2428 Q_ASSERT(n == itemPriv->paintNode || n == itemPriv->childContainerNode() || n->childCount() == 1);
2429 }
2430#endif
2431
2432}
2433
2434bool QQuickWindowPrivate::emitError(QQuickWindow::SceneGraphError error, const QString &msg)
2435{
2436 Q_Q(QQuickWindow);
2437 static const QMetaMethod errorSignal = QMetaMethod::fromSignal(&QQuickWindow::sceneGraphError);
2438 if (q->isSignalConnected(errorSignal)) {
2439 emit q->sceneGraphError(error, msg);
2440 return true;
2441 }
2442 return false;
2443}
2444
2445void QQuickWindow::maybeUpdate()
2446{
2447 Q_D(QQuickWindow);
2448 if (d->renderControl)
2449 QQuickRenderControlPrivate::get(d->renderControl)->maybeUpdate();
2450 else if (d->windowManager)
2451 d->windowManager->maybeUpdate(this);
2452}
2453
2454void QQuickWindow::cleanupSceneGraph()
2455{
2456 Q_D(QQuickWindow);
2457 if (!d->renderer)
2458 return;
2459
2460 delete d->renderer->rootNode();
2461 delete d->renderer;
2462 d->renderer = nullptr;
2463
2464 d->runAndClearJobs(&d->beforeSynchronizingJobs);
2465 d->runAndClearJobs(&d->afterSynchronizingJobs);
2466 d->runAndClearJobs(&d->beforeRenderingJobs);
2467 d->runAndClearJobs(&d->afterRenderingJobs);
2468 d->runAndClearJobs(&d->afterSwapJobs);
2469}
2470
2471QOpenGLContext *QQuickWindowPrivate::openglContext()
2472{
2473#if QT_CONFIG(opengl)
2474 if (context && context->isValid()) {
2475 QSGRendererInterface *rif = context->sceneGraphContext()->rendererInterface(context);
2476 if (rif) {
2477 Q_Q(QQuickWindow);
2478 return reinterpret_cast<QOpenGLContext *>(rif->getResource(q, QSGRendererInterface::OpenGLContextResource));
2479 }
2480 }
2481#endif
2482 return nullptr;
2483}
2484
2485/*!
2486 Returns true if the scene graph has been initialized; otherwise returns false.
2487 */
2488bool QQuickWindow::isSceneGraphInitialized() const
2489{
2490 Q_D(const QQuickWindow);
2491 return d->context != nullptr && d->context->isValid();
2492}
2493
2494/*!
2495 \fn void QQuickWindow::frameSwapped()
2496
2497 This signal is emitted when a frame has been queued for presenting. With
2498 vertical synchronization enabled the signal is emitted at most once per
2499 vsync interval in a continuously animating scene.
2500
2501 This signal will be emitted from the scene graph rendering thread.
2502*/
2503
2504/*!
2505 \qmlsignal QtQuick::Window::frameSwapped()
2506
2507 This signal is emitted when a frame has been queued for presenting. With
2508 vertical synchronization enabled the signal is emitted at most once per
2509 vsync interval in a continuously animating scene.
2510 */
2511
2512/*!
2513 \fn void QQuickWindow::sceneGraphInitialized()
2514
2515 This signal is emitted when the scene graph has been initialized.
2516
2517 This signal will be emitted from the scene graph rendering thread.
2518 */
2519
2520/*!
2521 \qmlsignal QtQuick::Window::sceneGraphInitialized()
2522 \internal
2523 */
2524
2525/*!
2526 \fn void QQuickWindow::sceneGraphInvalidated()
2527
2528 This signal is emitted when the scene graph has been invalidated.
2529
2530 This signal implies that the graphics rendering context used
2531 has been invalidated and all user resources tied to that context
2532 should be released.
2533
2534 When rendering with OpenGL, the QOpenGLContext of this window will
2535 be bound when this function is called. The only exception is if
2536 the native OpenGL has been destroyed outside Qt's control, for
2537 instance through EGL_CONTEXT_LOST.
2538
2539 This signal will be emitted from the scene graph rendering thread.
2540 */
2541
2542/*!
2543 \qmlsignal QtQuick::Window::sceneGraphInvalidated()
2544 \internal
2545 */
2546
2547/*!
2548 \fn void QQuickWindow::sceneGraphError(SceneGraphError error, const QString &message)
2549
2550 This signal is emitted when an \a error occurred during scene graph initialization.
2551
2552 Applications should connect to this signal if they wish to handle errors,
2553 like graphics context creation failures, in a custom way. When no slot is
2554 connected to the signal, the behavior will be different: Quick will print
2555 the \a message, or show a message box, and terminate the application.
2556
2557 This signal will be emitted from the GUI thread.
2558
2559 \since 5.3
2560 */
2561
2562/*!
2563 \qmlsignal QtQuick::Window::sceneGraphError(SceneGraphError error, QString message)
2564
2565 This signal is emitted when an \a error occurred during scene graph initialization.
2566
2567 You can implement onSceneGraphError(error, message) to handle errors,
2568 such as graphics context creation failures, in a custom way.
2569 If no handler is connected to this signal, Quick will print the \a message,
2570 or show a message box, and terminate the application.
2571
2572 \since 5.3
2573 */
2574
2575/*!
2576 \class QQuickCloseEvent
2577 \internal
2578 \since 5.1
2579
2580 \inmodule QtQuick
2581
2582 \brief Notification that a \l QQuickWindow is about to be closed
2583*/
2584/*!
2585 \qmltype CloseEvent
2586 \nativetype QQuickCloseEvent
2587 \inqmlmodule QtQuick
2588 \ingroup qtquick-visual
2589 \brief Notification that a \l Window is about to be closed.
2590 \since 5.1
2591
2592 Notification that a window is about to be closed by the windowing system
2593 (e.g. the user clicked the title bar close button). The CloseEvent contains
2594 an accepted property which can be set to false to abort closing the window.
2595*/
2596
2597/*!
2598 \qmlproperty bool CloseEvent::accepted
2599
2600 This property indicates whether the application will allow the user to
2601 close the window. It is true by default.
2602*/
2603
2604/*!
2605 \internal
2606 \fn void QQuickWindow::closing(QQuickCloseEvent *close)
2607 \since 5.1
2608
2609 This signal is emitted when the window receives the event \a close from
2610 the windowing system.
2611
2612 On \macOs, Qt will create a menu item \c Quit if there is no menu item
2613 whose text is "quit" or "exit". This menu item calls the \c QCoreApplication::quit
2614 signal, not the \c QQuickWindow::closing() signal.
2615
2616 \sa {QMenuBar as a Global Menu Bar}
2617*/
2618
2619/*!
2620 \qmlsignal QtQuick::Window::closing(CloseEvent close)
2621 \since 5.1
2622
2623 This signal is emitted when the user tries to close the window.
2624
2625 This signal includes a \a close parameter. The \c {close.accepted}
2626 property is true by default so that the window is allowed to close; but you
2627 can implement an \c onClosing handler and set \c {close.accepted = false} if
2628 you need to do something else before the window can be closed.
2629 */
2630
2631/*!
2632 Sets the render target for this window to be \a target.
2633
2634 A QQuickRenderTarget serves as an opaque handle for a renderable native
2635 object, most commonly a 2D texture, and associated metadata, such as the
2636 size in pixels.
2637
2638 A default constructed QQuickRenderTarget means no redirection. A valid
2639 \a target, created via one of the static QQuickRenderTarget factory functions,
2640 on the other hand, enables redirection of the rendering of the Qt Quick
2641 scene: it will no longer target the color buffers for the surface
2642 associated with the window, but rather the textures or other graphics
2643 objects specified in \a target.
2644
2645 For example, assuming the scenegraph is using Vulkan to render, one can
2646 redirect its output into a \c VkImage. For graphics APIs like Vulkan, the
2647 image layout must be provided as well. QQuickRenderTarget instances are
2648 implicitly shared and are copyable and can be passed by value. They do not
2649 own the associated native objects (such as, the VkImage in the example),
2650 however.
2651
2652 \badcode
2653 QQuickRenderTarget rt = QQuickRenderTarget::fromVulkanImage(vulkanImage, VK_IMAGE_LAYOUT_PREINITIALIZED, pixelSize);
2654 quickWindow->setRenderTarget(rt);
2655 \endcode
2656
2657 This function is very often used in combination with QQuickRenderControl
2658 and an invisible QQuickWindow, in order to render Qt Quick content into a
2659 texture, without creating an on-screen native window for this QQuickWindow.
2660
2661 When the desired target, or associated data, such as the size, changes,
2662 call this function with a new QQuickRenderTarget. Constructing
2663 QQuickRenderTarget instances and calling this function is cheap, but be
2664 aware that setting a new \a target with a different native object or other
2665 data may lead to potentially expensive initialization steps when the
2666 scenegraph is about to render the next frame. Therefore change the target
2667 only when necessary.
2668
2669 \note The window does not take ownership of any native objects referenced
2670 in \a target.
2671
2672 \note It is the caller's responsibility to ensure the native objects
2673 referred to in \a target are valid for the scenegraph renderer too. For
2674 instance, with Vulkan, Metal, and Direct3D this implies that the texture or
2675 image is created on the same graphics device that is used by the scenegraph
2676 internally. Therefore, when texture objects created on an already existing
2677 device or context are involved, this function is often used in combination
2678 with setGraphicsDevice().
2679
2680 \note With graphics APIs where relevant, the application must pay attention
2681 to image layout transitions performed by the scenegraph. For example, once
2682 a VkImage is associated with the scenegraph by calling this function, its
2683 layout will transition to \c VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL when
2684 rendering a frame.
2685
2686 \warning This function can only be called from the thread doing the
2687 rendering.
2688
2689 \since 6.0
2690
2691 \sa QQuickRenderControl, setGraphicsDevice(), setGraphicsApi()
2692 */
2693void QQuickWindow::setRenderTarget(const QQuickRenderTarget &target)
2694{
2695 Q_D(QQuickWindow);
2696 if (target != d->customRenderTarget) {
2697 d->customRenderTarget = target;
2698 d->redirect.renderTargetDirty = true;
2699 }
2700}
2701
2702/*!
2703 \return the QQuickRenderTarget passed to setRenderTarget(), or a default
2704 constructed one otherwise
2705
2706 \since 6.0
2707
2708 \sa setRenderTarget()
2709 */
2710QQuickRenderTarget QQuickWindow::renderTarget() const
2711{
2712 Q_D(const QQuickWindow);
2713 return d->customRenderTarget;
2714}
2715
2716#ifdef Q_OS_WEBOS
2717class GrabWindowForProtectedContent : public QRunnable
2718{
2719public:
2720 GrabWindowForProtectedContent(QQuickWindow *window, QImage *image, QWaitCondition *condition)
2721 : m_window(window)
2722 , m_image(image)
2723 , m_condition(condition)
2724 {
2725 }
2726
2727 bool checkGrabbable()
2728 {
2729 if (!m_window)
2730 return false;
2731 if (!m_image)
2732 return false;
2733 if (!QQuickWindowPrivate::get(m_window))
2734 return false;
2735
2736 return true;
2737 }
2738
2739 void run() override
2740 {
2741 if (!checkGrabbable())
2742 return;
2743
2744 *m_image = QSGRhiSupport::instance()->grabOffscreenForProtectedContent(m_window);
2745 if (m_condition)
2746 m_condition->wakeOne();
2747 return;
2748 }
2749
2750private:
2751 QQuickWindow *m_window;
2752 QImage *m_image;
2753 QWaitCondition *m_condition;
2754
2755};
2756#endif
2757
2758/*!
2759 Grabs the contents of the window and returns it as an image.
2760
2761 It is possible to call the grabWindow() function when the window is not
2762 visible. This requires that the window is \l{QWindow::create()} {created}
2763 and has a valid size and that no other QQuickWindow instances are rendering
2764 in the same process.
2765
2766 \note When using this window in combination with QQuickRenderControl, the
2767 result of this function is an empty image, unless the \c software backend
2768 is in use. This is because when redirecting the output to an
2769 application-managed graphics resource (such as, a texture) by using
2770 QQuickRenderControl and setRenderTarget(), the application is better suited
2771 for managing and executing an eventual read back operation, since it is in
2772 full control of the resource to begin with.
2773
2774 \warning Calling this function will cause performance problems.
2775
2776 \warning This function can only be called from the GUI thread.
2777 */
2778QImage QQuickWindow::grabWindow()
2779{
2780 Q_D(QQuickWindow);
2781
2782 if (!d->isRenderable() && !d->renderControl) {
2783 // backends like software can grab regardless of the window state
2784 if (d->windowManager && (d->windowManager->flags() & QSGRenderLoop::SupportsGrabWithoutExpose))
2785 return d->windowManager->grab(this);
2786
2787 if (!isSceneGraphInitialized()) {
2788 // We do not have rendering up and running. Forget the render loop,
2789 // do a frame completely offscreen and synchronously into a
2790 // texture. This can be *very* slow due to all the device/context
2791 // and resource initialization but the documentation warns for it,
2792 // and is still important for some use cases.
2793 Q_ASSERT(!d->rhi);
2794 return QSGRhiSupport::instance()->grabOffscreen(this);
2795 }
2796 }
2797
2798#ifdef Q_OS_WEBOS
2799 if (requestedFormat().testOption(QSurfaceFormat::ProtectedContent)) {
2800 QImage image;
2801 QMutex mutex;
2802 QWaitCondition condition;
2803 mutex.lock();
2804 GrabWindowForProtectedContent *job = new GrabWindowForProtectedContent(this, &image, &condition);
2805 if (!job) {
2806 qWarning("QQuickWindow::grabWindow: Failed to create a job for capturing protected content");
2807 mutex.unlock();
2808 return QImage();
2809 }
2810 scheduleRenderJob(job, QQuickWindow::NoStage);
2811 condition.wait(&mutex);
2812 mutex.unlock();
2813 return image;
2814 }
2815#endif
2816 // The common case: we have an exposed window with an initialized
2817 // scenegraph, meaning we can request grabbing via the render loop, or we
2818 // are not targeting the window, in which case the request is to be
2819 // forwarded to the rendercontrol.
2820 if (d->renderControl)
2821 return QQuickRenderControlPrivate::get(d->renderControl)->grab();
2822 else if (d->windowManager)
2823 return d->windowManager->grab(this);
2824
2825 return QImage();
2826}
2827
2828/*!
2829 Returns an incubation controller that splices incubation between frames
2830 for this window. QQuickView automatically installs this controller for you,
2831 otherwise you will need to install it yourself using \l{QQmlEngine::setIncubationController()}.
2832
2833 The controller is owned by the window and will be destroyed when the window
2834 is deleted.
2835*/
2836QQmlIncubationController *QQuickWindow::incubationController() const
2837{
2838 Q_D(const QQuickWindow);
2839
2840 if (!d->windowManager)
2841 return nullptr; // TODO: make sure that this is safe
2842
2843 if (!d->incubationController)
2844 d->incubationController = new QQuickWindowIncubationController(d->windowManager);
2845 return d->incubationController;
2846}
2847
2848
2849
2850/*!
2851 \enum QQuickWindow::CreateTextureOption
2852
2853 The CreateTextureOption enums are used to customize a texture is wrapped.
2854
2855 \value TextureHasAlphaChannel The texture has an alpha channel and should
2856 be drawn using blending.
2857
2858 \value TextureHasMipmaps The texture has mipmaps and can be drawn with
2859 mipmapping enabled.
2860
2861 \value TextureOwnsGLTexture As of Qt 6.0, this flag is not used in practice
2862 and is ignored. Native graphics resource ownership is not transferable to
2863 the wrapping QSGTexture, because Qt Quick may not have the necessary details
2864 on how such an object and the associated memory should be freed.
2865
2866 \value TextureCanUseAtlas The image can be uploaded into a texture atlas.
2867
2868 \value TextureIsOpaque The texture will return false for
2869 QSGTexture::hasAlphaChannel() and will not be blended. This flag was added
2870 in Qt 5.6.
2871
2872 */
2873
2874/*!
2875 \enum QQuickWindow::SceneGraphError
2876
2877 This enum describes the error in a sceneGraphError() signal.
2878
2879 \value ContextNotAvailable graphics context creation failed. This typically means that
2880 no suitable OpenGL implementation was found, for example because no graphics drivers
2881 are installed and so no OpenGL 2 support is present. On mobile and embedded boards
2882 that use OpenGL ES such an error is likely to indicate issues in the windowing system
2883 integration and possibly an incorrect configuration of Qt.
2884
2885 \since 5.3
2886 */
2887
2888/*!
2889 \enum QQuickWindow::TextRenderType
2890 \since 5.10
2891
2892 This enum describes the default render type of text-like elements in Qt
2893 Quick (\l Text, \l TextInput, etc.).
2894
2895 Select NativeTextRendering if you prefer text to look native on the target
2896 platform and do not require advanced features such as transformation of the
2897 text. Using such features in combination with the NativeTextRendering
2898 render type will lend poor and sometimes pixelated results.
2899
2900 Both \c QtTextRendering and \c CurveTextRendering are hardware-accelerated techniques.
2901 \c QtTextRendering is the faster of the two, but uses more memory and will exhibit rendering
2902 artifacts at large sizes. \c CurveTextRendering should be considered as an alternative in cases
2903 where \c QtTextRendering does not give good visual results or where reducing graphics memory
2904 consumption is a priority.
2905
2906 \value QtTextRendering Use Qt's own rasterization algorithm.
2907 \value NativeTextRendering Use the operating system's native rasterizer for text.
2908 \value CurveTextRendering Text is rendered using a curve rasterizer running directly on
2909 the graphics hardware. (Introduced in Qt 6.7.0.)
2910*/
2911
2912/*!
2913 \fn void QQuickWindow::beforeSynchronizing()
2914
2915 This signal is emitted before the scene graph is synchronized with the QML state.
2916
2917 Even though the signal is emitted from the scene graph rendering thread,
2918 the GUI thread is guaranteed to be blocked, like it is in
2919 QQuickItem::updatePaintNode(). Therefore, it is safe to access GUI thread
2920 thread data in a slot or lambda that is connected with
2921 Qt::DirectConnection.
2922
2923 This signal can be used to do any preparation required before calls to
2924 QQuickItem::updatePaintNode().
2925
2926 When using OpenGL, the QOpenGLContext used for rendering by the scene graph
2927 will be bound at this point.
2928
2929 \warning This signal is emitted from the scene graph rendering thread. If your
2930 slot function needs to finish before execution continues, you must make sure that
2931 the connection is direct (see Qt::ConnectionType).
2932
2933 \warning When using OpenGL, be aware that setting OpenGL 3.x or 4.x specific
2934 states and leaving these enabled or set to non-default values when returning
2935 from the connected slot can interfere with the scene graph's rendering.
2936*/
2937
2938/*!
2939 \qmlsignal QtQuick::Window::beforeSynchronizing()
2940 \internal
2941*/
2942
2943/*!
2944 \fn void QQuickWindow::afterSynchronizing()
2945
2946 This signal is emitted after the scene graph is synchronized with the QML state.
2947
2948 This signal can be used to do preparation required after calls to
2949 QQuickItem::updatePaintNode(), while the GUI thread is still locked.
2950
2951 When using OpenGL, the QOpenGLContext used for rendering by the scene graph
2952 will be bound at this point.
2953
2954 \warning This signal is emitted from the scene graph rendering thread. If your
2955 slot function needs to finish before execution continues, you must make sure that
2956 the connection is direct (see Qt::ConnectionType).
2957
2958 \warning When using OpenGL, be aware that setting OpenGL 3.x or 4.x specific
2959 states and leaving these enabled or set to non-default values when returning
2960 from the connected slot can interfere with the scene graph's rendering.
2961
2962 \since 5.3
2963 */
2964
2965/*!
2966 \qmlsignal QtQuick::Window::afterSynchronizing()
2967 \internal
2968 \since 5.3
2969 */
2970
2971/*!
2972 \fn void QQuickWindow::beforeRendering()
2973
2974 This signal is emitted after the preparations for the frame have been done,
2975 meaning there is a command buffer in recording mode, where applicable. If
2976 desired, the slot function connected to this signal can query native
2977 resources like the command before via QSGRendererInterface. Note however
2978 that the recording of the main render pass is not yet started at this point
2979 and it is not possible to add commands within that pass. Starting a pass
2980 means clearing the color, depth, and stencil buffers so it is not possible
2981 to achieve an underlay type of rendering by just connecting to this
2982 signal. Rather, connect to beforeRenderPassRecording(). However, connecting
2983 to this signal is still important if the recording of copy type of commands
2984 is desired since those cannot be enqueued within a render pass.
2985
2986 \warning This signal is emitted from the scene graph rendering thread. If your
2987 slot function needs to finish before execution continues, you must make sure that
2988 the connection is direct (see Qt::ConnectionType).
2989
2990 \note When using OpenGL, be aware that setting OpenGL 3.x or 4.x specific
2991 states and leaving these enabled or set to non-default values when
2992 returning from the connected slot can interfere with the scene graph's
2993 rendering. The QOpenGLContext used for rendering by the scene graph will be
2994 bound when the signal is emitted.
2995
2996 \sa rendererInterface(), {Scene Graph - RHI Under QML}, {Scene Graph -
2997 OpenGL Under QML}, {Scene Graph - Metal Under QML}, {Scene Graph - Vulkan
2998 Under QML}, {Scene Graph - Direct3D 11 Under QML}
2999*/
3000
3001/*!
3002 \qmlsignal QtQuick::Window::beforeRendering()
3003 \internal
3004*/
3005
3006/*!
3007 \fn void QQuickWindow::afterRendering()
3008
3009 The signal is emitted after scene graph has added its commands to the
3010 command buffer, which is not yet submitted to the graphics queue. If
3011 desired, the slot function connected to this signal can query native
3012 resources, like the command buffer, before via QSGRendererInterface. Note
3013 however that the render pass (or passes) are already recorded at this point
3014 and it is not possible to add more commands within the scenegraph's
3015 pass. Instead, use afterRenderPassRecording() for that. This signal has
3016 therefore limited use in Qt 6, unlike in Qt 5. Rather, it is the combination
3017 of beforeRendering() and beforeRenderPassRecording(), or beforeRendering()
3018 and afterRenderPassRecording(), that is typically used to achieve under- or
3019 overlaying of the custom rendering.
3020
3021 \warning This signal is emitted from the scene graph rendering thread. If your
3022 slot function needs to finish before execution continues, you must make sure that
3023 the connection is direct (see Qt::ConnectionType).
3024
3025 \note When using OpenGL, be aware that setting OpenGL 3.x or 4.x specific
3026 states and leaving these enabled or set to non-default values when
3027 returning from the connected slot can interfere with the scene graph's
3028 rendering. The QOpenGLContext used for rendering by the scene graph will be
3029 bound when the signal is emitted.
3030
3031 \sa rendererInterface(), {Scene Graph - RHI Under QML}, {Scene Graph -
3032 OpenGL Under QML}, {Scene Graph - Metal Under QML}, {Scene Graph - Vulkan
3033 Under QML}, {Scene Graph - Direct3D 11 Under QML}
3034 */
3035
3036/*!
3037 \qmlsignal QtQuick::Window::afterRendering()
3038 \internal
3039 */
3040
3041/*!
3042 \fn void QQuickWindow::beforeRenderPassRecording()
3043
3044 This signal is emitted before the scenegraph starts recording commands for
3045 the main render pass. (Layers have their own passes and are fully recorded
3046 by the time this signal is emitted.) The render pass is already active on
3047 the command buffer when the signal is emitted.
3048
3049 This signal is emitted later than beforeRendering() and it guarantees that
3050 not just the frame, but also the recording of the scenegraph's main render
3051 pass is active. This allows inserting commands without having to generate an
3052 entire, separate render pass (which would typically clear the attached
3053 images). The native graphics objects can be queried via
3054 QSGRendererInterface.
3055
3056 \note Resource updates (uploads, copies) typically cannot be enqueued from
3057 within a render pass. Therefore, more complex user rendering will need to
3058 connect to both beforeRendering() and this signal.
3059
3060 \warning This signal is emitted from the scene graph rendering thread. If your
3061 slot function needs to finish before execution continues, you must make sure that
3062 the connection is direct (see Qt::ConnectionType).
3063
3064 \sa rendererInterface()
3065
3066 \since 5.14
3067
3068 \sa {Scene Graph - RHI Under QML}
3069*/
3070
3071/*!
3072 \qmlsignal QtQuick::Window::beforeRenderPassRecording()
3073 \internal
3074 \since 5.14
3075*/
3076
3077/*!
3078 \fn void QQuickWindow::afterRenderPassRecording()
3079
3080 This signal is emitted after the scenegraph has recorded the commands for
3081 its main render pass, but the pass is not yet finalized on the command
3082 buffer.
3083
3084 This signal is emitted earlier than afterRendering(), and it guarantees that
3085 not just the frame but also the recording of the scenegraph's main render
3086 pass is still active. This allows inserting commands without having to
3087 generate an entire, separate render pass (which would typically clear the
3088 attached images). The native graphics objects can be queried via
3089 QSGRendererInterface.
3090
3091 \note Resource updates (uploads, copies) typically cannot be enqueued from
3092 within a render pass. Therefore, more complex user rendering will need to
3093 connect to both beforeRendering() and this signal.
3094
3095 \warning This signal is emitted from the scene graph rendering thread. If your
3096 slot function needs to finish before execution continues, you must make sure that
3097 the connection is direct (see Qt::ConnectionType).
3098
3099 \sa rendererInterface()
3100
3101 \since 5.14
3102
3103 \sa {Scene Graph - RHI Under QML}
3104*/
3105
3106/*!
3107 \fn void QQuickWindow::beforeFrameBegin()
3108
3109 This signal is emitted before the scene graph starts preparing the frame.
3110 This precedes signals like beforeSynchronizing() or beforeRendering(). It is
3111 the earliest signal that is emitted by the scene graph rendering thread
3112 when starting to prepare a new frame.
3113
3114 This signal is relevant for lower level graphics frameworks that need to
3115 execute certain operations, such as resource cleanup, at a stage where Qt
3116 Quick has not initiated the recording of a new frame via the underlying
3117 rendering hardware interface APIs.
3118
3119 \warning This signal is emitted from the scene graph rendering thread. If your
3120 slot function needs to finish before execution continues, you must make sure that
3121 the connection is direct (see Qt::ConnectionType).
3122
3123 \since 6.0
3124
3125 \sa afterFrameEnd(), rendererInterface()
3126*/
3127
3128/*!
3129 \qmlsignal QtQuick::Window::beforeFrameBegin()
3130 \internal
3131*/
3132
3133/*!
3134 \fn void QQuickWindow::afterFrameEnd()
3135
3136 This signal is emitted when the scene graph has submitted a frame. This is
3137 emitted after all other related signals, such as afterRendering(). It is
3138 the last signal that is emitted by the scene graph rendering thread when
3139 rendering a frame.
3140
3141 \note Unlike frameSwapped(), this signal is guaranteed to be emitted also
3142 when the Qt Quick output is redirected via QQuickRenderControl.
3143
3144 \warning This signal is emitted from the scene graph rendering thread. If your
3145 slot function needs to finish before execution continues, you must make sure that
3146 the connection is direct (see Qt::ConnectionType).
3147
3148 \since 6.0
3149
3150 \sa beforeFrameBegin(), rendererInterface()
3151*/
3152
3153/*!
3154 \qmlsignal QtQuick::Window::afterFrameEnd()
3155 \internal
3156*/
3157
3158/*!
3159 \qmlsignal QtQuick::Window::afterRenderPassRecording()
3160 \internal
3161 \since 5.14
3162*/
3163
3164/*!
3165 \fn void QQuickWindow::afterAnimating()
3166
3167 This signal is emitted on the GUI thread before requesting the render thread to
3168 perform the synchronization of the scene graph.
3169
3170 Unlike the other similar signals, this one is emitted on the GUI thread
3171 instead of the render thread. It can be used to synchronize external
3172 animation systems with the QML content. At the same time this means that
3173 this signal is not suitable for triggering graphics operations.
3174
3175 \since 5.3
3176 */
3177
3178/*!
3179 \qmlsignal QtQuick::Window::afterAnimating()
3180
3181 This signal is emitted on the GUI thread before requesting the render thread to
3182 perform the synchronization of the scene graph.
3183
3184 You can implement onAfterAnimating to do additional processing after each animation step.
3185
3186 \since 5.3
3187 */
3188
3189/*!
3190 \fn void QQuickWindow::sceneGraphAboutToStop()
3191
3192 This signal is emitted on the render thread when the scene graph is
3193 about to stop rendering. This happens usually because the window
3194 has been hidden.
3195
3196 Applications may use this signal to release resources, but should be
3197 prepared to reinstantiated them again fast. The scene graph and the
3198 graphics context are not released at this time.
3199
3200 \warning This signal is emitted from the scene graph rendering thread. If your
3201 slot function needs to finish before execution continues, you must make sure that
3202 the connection is direct (see Qt::ConnectionType).
3203
3204 \warning Make very sure that a signal handler for sceneGraphAboutToStop() leaves the
3205 graphics context in the same state as it was when the signal handler was entered.
3206 Failing to do so can result in the scene not rendering properly.
3207
3208 \sa sceneGraphInvalidated()
3209 \since 5.3
3210 */
3211
3212/*!
3213 \qmlsignal QtQuick::Window::sceneGraphAboutToStop()
3214 \internal
3215 \since 5.3
3216 */
3217
3218/*!
3219 \overload
3220 */
3221
3222QSGTexture *QQuickWindow::createTextureFromImage(const QImage &image) const
3223{
3224 return createTextureFromImage(image, {});
3225}
3226
3227
3228/*!
3229 Creates a new QSGTexture from the supplied \a image. If the image has an
3230 alpha channel, the corresponding texture will have an alpha channel.
3231
3232 The caller of the function is responsible for deleting the returned texture.
3233 The underlying native texture object is then destroyed together with the
3234 QSGTexture.
3235
3236 When \a options contains TextureCanUseAtlas, the engine may put the image
3237 into a texture atlas. Textures in an atlas need to rely on
3238 QSGTexture::normalizedTextureSubRect() for their geometry and will not
3239 support QSGTexture::Repeat. Other values from CreateTextureOption are
3240 ignored.
3241
3242 When \a options contains TextureIsOpaque, the engine will create an RGB
3243 texture which returns false for QSGTexture::hasAlphaChannel(). Opaque
3244 textures will in most cases be faster to render. When this flag is not set,
3245 the texture will have an alpha channel based on the image's format.
3246
3247 When \a options contains TextureHasMipmaps, the engine will create a texture
3248 which can use mipmap filtering. Mipmapped textures can not be in an atlas.
3249
3250 Setting TextureHasAlphaChannel in \a options serves no purpose for this
3251 function since assuming an alpha channel and blending is the default. To opt
3252 out, set TextureIsOpaque.
3253
3254 When the scene graph uses OpenGL, the returned texture will be using \c
3255 GL_TEXTURE_2D as texture target and \c GL_RGBA as internal format. With
3256 other graphics APIs, the texture format is typically \c RGBA8. Reimplement
3257 QSGTexture to create textures with different parameters.
3258
3259 \warning This function will return 0 if the scene graph has not yet been
3260 initialized.
3261
3262 \warning The returned texture is not memory managed by the scene graph and
3263 must be explicitly deleted by the caller on the rendering thread. This is
3264 achieved by deleting the texture from a QSGNode destructor or by using
3265 deleteLater() in the case where the texture already has affinity to the
3266 rendering thread.
3267
3268 This function can be called from both the main and the render thread.
3269
3270 \sa sceneGraphInitialized(), QSGTexture
3271 */
3272
3273QSGTexture *QQuickWindow::createTextureFromImage(const QImage &image, CreateTextureOptions options) const
3274{
3275 Q_D(const QQuickWindow);
3276 if (!isSceneGraphInitialized()) // check both for d->context and d->context->isValid()
3277 return nullptr;
3278 uint flags = 0;
3279 if (options & TextureCanUseAtlas) flags |= QSGRenderContext::CreateTexture_Atlas;
3280 if (options & TextureHasMipmaps) flags |= QSGRenderContext::CreateTexture_Mipmap;
3281 if (!(options & TextureIsOpaque)) flags |= QSGRenderContext::CreateTexture_Alpha;
3282 return d->context->createTexture(image, flags);
3283}
3284
3285/*!
3286 Creates a new QSGTexture from the supplied \a texture.
3287
3288 Use \a options to customize the texture attributes. Only the
3289 TextureHasAlphaChannel flag is taken into account by this function. When
3290 set, the resulting QSGTexture is always treated by the scene graph renderer
3291 as needing blending. For textures that are fully opaque, not setting the
3292 flag can save the cost of performing alpha blending during rendering. The
3293 flag has no direct correspondence to the \l{QRhiTexture::format()}{format}
3294 of the QRhiTexture, i.e. not setting the flag while having a texture format
3295 such as the commonly used \l QRhiTexture::RGBA8 is perfectly normal.
3296
3297 Mipmapping is not controlled by \a options since \a texture is already
3298 created and has the presence or lack of mipmaps baked in.
3299
3300 The returned QSGTexture owns the QRhiTexture, meaning \a texture is
3301 destroyed together with the returned QSGTexture.
3302
3303 If \a texture owns its underlying native graphics resources (OpenGL texture
3304 object, Vulkan image, etc.), that depends on how the QRhiTexture was created
3305 (\l{QRhiTexture::create()} or \l{QRhiTexture::createFrom()}), and that is
3306 not controlled or changed by this function.
3307
3308 \note This is only functional when the scene graph has already initialized
3309 and is using the default, \l{QRhi}-based \l{Scene Graph
3310 Adaptations}{adaptation}. The return value is \nullptr otherwise.
3311
3312 \note This function can only be called on the scene graph render thread.
3313
3314 \since 6.6
3315
3316 \sa createTextureFromImage(), sceneGraphInitialized(), QSGTexture
3317 */
3318QSGTexture *QQuickWindow::createTextureFromRhiTexture(QRhiTexture *texture, CreateTextureOptions options) const
3319{
3320 Q_D(const QQuickWindow);
3321 if (!d->rhi)
3322 return nullptr;
3323
3324 QSGPlainTexture *t = new QSGPlainTexture;
3325 t->setOwnsTexture(true);
3326 t->setTexture(texture);
3327 t->setHasAlphaChannel(options & QQuickWindow::TextureHasAlphaChannel);
3328 t->setTextureSize(texture->pixelSize());
3329 return t;
3330}
3331
3332// Legacy, private alternative to createTextureFromRhiTexture() that internally
3333// creates a QRhiTexture wrapping the existing native graphics resource.
3334// New code should prefer using the public API.
3335QSGTexture *QQuickWindowPrivate::createTextureFromNativeTexture(quint64 nativeObjectHandle,
3336 int nativeLayoutOrState,
3337 uint nativeFormat,
3338 const QSize &size,
3339 QQuickWindow::CreateTextureOptions options,
3340 TextureFromNativeTextureFlags flags) const
3341{
3342 if (!rhi)
3343 return nullptr;
3344
3345 QSGPlainTexture *texture = new QSGPlainTexture;
3346 texture->setTextureFromNativeTexture(rhi, nativeObjectHandle, nativeLayoutOrState, nativeFormat,
3347 size, options, flags);
3348 texture->setHasAlphaChannel(options & QQuickWindow::TextureHasAlphaChannel);
3349 // note that the QRhiTexture does not (and cannot) own the native object
3350 texture->setOwnsTexture(true); // texture meaning the QRhiTexture here, not the native object
3351 texture->setTextureSize(size);
3352 return texture;
3353}
3354
3355/*!
3356 \qmlproperty color Window::color
3357
3358 The background color for the window.
3359
3360 Setting this property is more efficient than using a separate Rectangle.
3361
3362 \note If you set the color to \c "transparent" or to a color with alpha translucency,
3363 you should also set suitable \l flags such as \c {flags: Qt.FramelessWindowHint}.
3364 Otherwise, window translucency may not be enabled consistently on all platforms.
3365*/
3366
3367/*!
3368 \property QQuickWindow::color
3369 \brief The color used to clear the color buffer at the beginning of each frame.
3370
3371 By default, the clear color is white.
3372
3373 \sa setDefaultAlphaBuffer()
3374 */
3375
3376void QQuickWindow::setColor(const QColor &color)
3377{
3378 Q_D(QQuickWindow);
3379 if (color == d->clearColor)
3380 return;
3381
3382 if (color.alpha() != d->clearColor.alpha()) {
3383 QSurfaceFormat fmt = requestedFormat();
3384 if (color.alpha() < 255)
3385 fmt.setAlphaBufferSize(8);
3386 else
3387 fmt.setAlphaBufferSize(-1);
3388 setFormat(fmt);
3389 }
3390 d->clearColor = color;
3391 emit colorChanged(color);
3392 update();
3393}
3394
3395QColor QQuickWindow::color() const
3396{
3397 return d_func()->clearColor;
3398}
3399
3400/*!
3401 \brief Returns whether to use alpha transparency on newly created windows.
3402
3403 \since 5.1
3404 \sa setDefaultAlphaBuffer()
3405 */
3406bool QQuickWindow::hasDefaultAlphaBuffer()
3407{
3408 return QQuickWindowPrivate::defaultAlphaBuffer;
3409}
3410
3411/*!
3412 \brief \a useAlpha specifies whether to use alpha transparency on newly created windows.
3413 \since 5.1
3414
3415 In any application which expects to create translucent windows, it's necessary to set
3416 this to true before creating the first QQuickWindow. The default value is false.
3417
3418 \sa hasDefaultAlphaBuffer()
3419 */
3420void QQuickWindow::setDefaultAlphaBuffer(bool useAlpha)
3421{
3422 QQuickWindowPrivate::defaultAlphaBuffer = useAlpha;
3423}
3424
3425/*!
3426 \struct QQuickWindow::GraphicsStateInfo
3427 \inmodule QtQuick
3428 \since 5.14
3429
3430 \brief Describes some of the RHI's graphics state at the point of a
3431 \l{QQuickWindow::beginExternalCommands()}{beginExternalCommands()} call.
3432 */
3433
3434/*!
3435 \variable QQuickWindow::GraphicsStateInfo::currentFrameSlot
3436 \since 5.14
3437 \brief the current frame slot index while recording a frame.
3438
3439 When the scenegraph renders with lower level 3D APIs such as Vulkan or
3440 Metal, it is the Qt's responsibility to ensure blocking whenever starting a
3441 new frame and finding the CPU is already a certain number of frames ahead
3442 of the GPU (because the command buffer submitted in frame no. \c{current} -
3443 \c{FramesInFlight} has not yet completed). With other graphics APIs, such
3444 as OpenGL or Direct 3D 11 this level of control is not exposed to the API
3445 client but rather handled by the implementation of the graphics API.
3446
3447 By extension, this also means that the appropriate double (or triple)
3448 buffering of resources, such as buffers, is up to the graphics API client
3449 to manage. Most commonly, a uniform buffer where the data changes between
3450 frames cannot simply change its contents when submitting a frame, given
3451 that the frame may still be active ("in flight") when starting to record
3452 the next frame. To avoid stalling the pipeline, one way is to have multiple
3453 buffers (and memory allocations) under the hood, thus realizing at least a
3454 double buffered scheme for such resources.
3455
3456 Applications that integrate rendering done directly with a graphics API
3457 such as Vulkan may want to perform a similar double or triple buffering of
3458 their own graphics resources, in a way that is compatible with the Qt
3459 rendering engine's frame submission process. That then involves knowing the
3460 values for the maximum number of in-flight frames (which is typically 2 or
3461 3) and the current frame slot index, which is a number running 0, 1, ..,
3462 FramesInFlight-1, and then wrapping around. The former is exposed in the
3463 \l{QQuickWindow::GraphicsStateInfo::framesInFlight}{framesInFlight}
3464 variable. The latter, current index, is this value.
3465
3466 For an example of using these values in practice, refer to the {Scene Graph
3467 - Vulkan Under QML} and {Scene Graph - Vulkan Texture Import} examples.
3468 */
3469
3470/*!
3471 \variable QQuickWindow::GraphicsStateInfo::framesInFlight
3472 \since 5.14
3473 \brief the maximum number of frames kept in flight.
3474
3475 See \l{QQuickWindow::GraphicsStateInfo::currentFrameSlot}{currentFrameSlot}
3476 for a detailed description.
3477 */
3478
3479/*!
3480 \return a reference to a GraphicsStateInfo struct describing some of the
3481 RHI's internal state, in particular, the double or tripple buffering status
3482 of the backend (such as, the Vulkan or Metal integrations). This is
3483 relevant when the underlying graphics APIs is Vulkan or Metal, and the
3484 external rendering code wishes to perform double or tripple buffering of
3485 its own often-changing resources, such as, uniform buffers, in order to
3486 avoid stalling the pipeline.
3487 */
3488const QQuickWindow::GraphicsStateInfo &QQuickWindow::graphicsStateInfo()
3489{
3490 Q_D(QQuickWindow);
3491 if (d->rhi) {
3492 d->rhiStateInfo.currentFrameSlot = d->rhi->currentFrameSlot();
3493 d->rhiStateInfo.framesInFlight = d->rhi->resourceLimit(QRhi::FramesInFlight);
3494 }
3495 return d->rhiStateInfo;
3496}
3497
3498/*!
3499 When mixing raw graphics (OpenGL, Vulkan, Metal, etc.) commands with scene
3500 graph rendering, it is necessary to call this function before recording
3501 commands to the command buffer used by the scene graph to render its main
3502 render pass. This is to avoid clobbering state.
3503
3504 In practice this function is often called from a slot connected to the
3505 beforeRenderPassRecording() or afterRenderPassRecording() signals.
3506
3507 The function does not need to be called when recording commands to the
3508 application's own command buffer (such as, a VkCommandBuffer or
3509 MTLCommandBuffer + MTLRenderCommandEncoder created and managed by the
3510 application, not retrieved from the scene graph). With graphics APIs where
3511 no native command buffer concept is exposed (OpenGL, Direct 3D 11),
3512 beginExternalCommands() and endExternalCommands() together provide a
3513 replacement for the Qt 5 resetOpenGLState() function.
3514
3515 Calling this function and endExternalCommands() is not necessary within the
3516 \l{QSGRenderNode::render()}{render()} implementation of a QSGRenderNode
3517 because the scene graph performs the necessary steps implicitly for render
3518 nodes.
3519
3520 Native graphics objects (such as, graphics device, command buffer or
3521 encoder) are accessible via QSGRendererInterface::getResource().
3522
3523 \warning Watch out for the fact that
3524 QSGRendererInterface::CommandListResource may return a different object
3525 between beginExternalCommands() - endExternalCommands(). This can happen
3526 when the underlying implementation provides a dedicated secondary command
3527 buffer for recording external graphics commands within a render pass.
3528 Therefore, always query CommandListResource after calling this function. Do
3529 not attempt to reuse an object from an earlier query.
3530
3531 \note When the scenegraph is using OpenGL, pay attention to the fact that
3532 the OpenGL state in the context can have arbitrary settings, and this
3533 function does not perform any resetting of the state back to defaults.
3534
3535 \sa endExternalCommands(), QQuickOpenGLUtils::resetOpenGLState()
3536
3537 \since 5.14
3538 */
3539void QQuickWindow::beginExternalCommands()
3540{
3541 Q_D(QQuickWindow);
3542 if (d->rhi && d->context && d->context->isValid()) {
3543 QSGDefaultRenderContext *rc = static_cast<QSGDefaultRenderContext *>(d->context);
3544 QRhiCommandBuffer *cb = rc->currentFrameCommandBuffer();
3545 if (cb)
3546 cb->beginExternal();
3547 }
3548}
3549
3550/*!
3551 When mixing raw graphics (OpenGL, Vulkan, Metal, etc.) commands with scene
3552 graph rendering, it is necessary to call this function after recording
3553 commands to the command buffer used by the scene graph to render its main
3554 render pass. This is to avoid clobbering state.
3555
3556 In practice this function is often called from a slot connected to the
3557 beforeRenderPassRecording() or afterRenderPassRecording() signals.
3558
3559 The function does not need to be called when recording commands to the
3560 application's own command buffer (such as, a VkCommandBuffer or
3561 MTLCommandBuffer + MTLRenderCommandEncoder created and managed by the
3562 application, not retrieved from the scene graph). With graphics APIs where
3563 no native command buffer concept is exposed (OpenGL, Direct 3D 11),
3564 beginExternalCommands() and endExternalCommands() together provide a
3565 replacement for the Qt 5 resetOpenGLState() function.
3566
3567 Calling this function and beginExternalCommands() is not necessary within the
3568 \l{QSGRenderNode::render()}{render()} implementation of a QSGRenderNode
3569 because the scene graph performs the necessary steps implicitly for render
3570 nodes.
3571
3572 \sa beginExternalCommands(), QQuickOpenGLUtils::resetOpenGLState()
3573
3574 \since 5.14
3575 */
3576void QQuickWindow::endExternalCommands()
3577{
3578 Q_D(QQuickWindow);
3579 if (d->rhi && d->context && d->context->isValid()) {
3580 QSGDefaultRenderContext *rc = static_cast<QSGDefaultRenderContext *>(d->context);
3581 QRhiCommandBuffer *cb = rc->currentFrameCommandBuffer();
3582 if (cb)
3583 cb->endExternal();
3584 }
3585}
3586
3587/*!
3588 \qmlproperty string Window::title
3589
3590 The window's title in the windowing system.
3591
3592 The window title might appear in the title area of the window decorations,
3593 depending on the windowing system and the window flags. It might also
3594 be used by the windowing system to identify the window in other contexts,
3595 such as in the task switcher.
3596 */
3597
3598/*!
3599 \qmlproperty Qt::WindowModality Window::modality
3600
3601 The modality of the window.
3602
3603 A modal window prevents other windows from receiving input events.
3604 Possible values are Qt.NonModal (the default), Qt.WindowModal,
3605 and Qt.ApplicationModal.
3606 */
3607
3608/*!
3609 \qmlproperty Qt::WindowFlags Window::flags
3610
3611 The window flags of the window.
3612
3613 The window flags control the window's appearance in the windowing system,
3614 whether it's a dialog, popup, or a regular window, and whether it should
3615 have a title bar, etc.
3616
3617 The flags that you read from this property might differ from the ones
3618 that you set if the requested flags could not be fulfilled.
3619
3620 \snippet qml/splashWindow.qml entire
3621
3622 \sa Qt::WindowFlags, {Qt Quick Examples - Window and Screen}
3623 */
3624
3625/*!
3626 \qmlattachedproperty Window Window::window
3627 \since 5.7
3628
3629 This attached property holds the item's window.
3630 The Window attached property can be attached to any Item.
3631*/
3632
3633/*!
3634 \qmlattachedproperty int Window::width
3635 \qmlattachedproperty int Window::height
3636 \since 5.5
3637
3638 These attached properties hold the size of the item's window.
3639 The Window attached property can be attached to any Item.
3640*/
3641
3642/*!
3643 \qmlproperty int Window::x
3644 \qmlproperty int Window::y
3645 \qmlproperty int Window::width
3646 \qmlproperty int Window::height
3647
3648 Defines the window's position and size.
3649
3650 The (x,y) position is relative to the \l Screen if there is only one,
3651 or to the virtual desktop (arrangement of multiple screens).
3652
3653 \note Not all windowing systems support setting or querying top level
3654 window positions. On such a system, programmatically moving windows
3655 may not have any effect, and artificial values may be returned for
3656 the current positions, such as \c QPoint(0, 0).
3657
3658 \qml
3659 Window { x: 100; y: 100; width: 100; height: 100 }
3660 \endqml
3661
3662 \image screen-and-window-dimensions.jpg
3663 */
3664
3665/*!
3666 \qmlproperty int Window::minimumWidth
3667 \qmlproperty int Window::minimumHeight
3668 \since 5.1
3669
3670 Defines the window's minimum size.
3671
3672 This is a hint to the window manager to prevent resizing below the specified
3673 width and height.
3674 */
3675
3676/*!
3677 \qmlproperty int Window::maximumWidth
3678 \qmlproperty int Window::maximumHeight
3679 \since 5.1
3680
3681 Defines the window's maximum size.
3682
3683 This is a hint to the window manager to prevent resizing above the specified
3684 width and height.
3685 */
3686
3687/*!
3688 \qmlproperty bool Window::visible
3689
3690 Whether the window is visible on the screen.
3691
3692 Setting visible to false is the same as setting \l visibility to \l {QWindow::}{Hidden}.
3693
3694 The default value is \c false, unless overridden by setting \l visibility.
3695
3696 \sa visibility
3697 */
3698
3699/*!
3700 \keyword qml-window-visibility-prop
3701 \qmlproperty QWindow::Visibility Window::visibility
3702
3703 The screen-occupation state of the window.
3704
3705 Visibility is whether the window should appear in the windowing system as
3706 normal, minimized, maximized, fullscreen or hidden.
3707
3708 To set the visibility to \l {QWindow::}{AutomaticVisibility} means to give the
3709 window a default visible state, which might be \l {QWindow::}{FullScreen} or
3710 \l {QWindow::}{Windowed} depending on the platform. However when reading the
3711 visibility property you will always get the actual state, never
3712 \c AutomaticVisibility.
3713
3714 When a window is not \l visible, its visibility is \c Hidden.
3715 Setting visibility to \l {QWindow::}{Hidden} is the same as setting \l visible to \c false.
3716
3717 The default value is \l {QWindow::}{Hidden}
3718
3719 \snippet qml/windowVisibility.qml entire
3720
3721 \sa visible, {Qt Quick Examples - Window and Screen}
3722 \since 5.1
3723 */
3724
3725/*!
3726 \qmlattachedproperty QWindow::Visibility Window::visibility
3727 \readonly
3728 \since 5.4
3729
3730 This attached property holds whether the window is currently shown
3731 in the windowing system as normal, minimized, maximized, fullscreen or
3732 hidden. The \c Window attached property can be attached to any Item. If the
3733 item is not shown in any window, the value will be \l {QWindow::}{Hidden}.
3734
3735 \sa visible, {qml-window-visibility-prop}{visibility}
3736*/
3737
3738/*!
3739 \qmlproperty Item Window::contentItem
3740 \readonly
3741 \brief The invisible root item of the scene.
3742*/
3743
3744/*!
3745 \qmlproperty Qt::ScreenOrientation Window::contentOrientation
3746
3747 This is a hint to the window manager in case it needs to display
3748 additional content like popups, dialogs, status bars, or similar
3749 in relation to the window.
3750
3751 The recommended orientation is \l {Screen::orientation}{Screen.orientation}, but
3752 an application doesn't have to support all possible orientations,
3753 and thus can opt to ignore the current screen orientation.
3754
3755 The difference between the window and the content orientation
3756 determines how much to rotate the content by.
3757
3758 The default value is Qt::PrimaryOrientation.
3759
3760 \sa Screen
3761
3762 \since 5.1
3763 */
3764
3765/*!
3766 \qmlproperty real Window::opacity
3767
3768 The opacity of the window.
3769
3770 If the windowing system supports window opacity, this can be used to fade the
3771 window in and out, or to make it semitransparent.
3772
3773 A value of 1.0 or above is treated as fully opaque, whereas a value of 0.0 or below
3774 is treated as fully transparent. Values inbetween represent varying levels of
3775 translucency between the two extremes.
3776
3777 The default value is 1.0.
3778
3779 \since 5.1
3780 */
3781
3782/*!
3783 \qmlproperty Screen Window::screen
3784
3785 The screen with which the window is associated.
3786
3787 If specified before showing a window, will result in the window being shown
3788 on that screen, unless an explicit window position has been set. The value
3789 must be an element from the \l{Application::screens}{Application.screens}
3790 array.
3791
3792 \note To ensure that the window is associated with the desired screen when
3793 the underlying native window is created, make sure this property is set as
3794 early as possible and that the setting of its value is not deferred. This
3795 can be particularly important on embedded platforms without a windowing system,
3796 where only one window per screen is allowed at a time. Setting the screen after
3797 a window has been created does not move the window if the new screen is part of
3798 the same virtual desktop as the old screen.
3799
3800 \since 5.9
3801
3802 \sa QWindow::setScreen(), QWindow::screen(), QScreen, {QtQuick::Application}{Application}
3803 */
3804
3805/*!
3806 \qmlproperty QWindow Window::transientParent
3807 \since 5.13
3808
3809 The window for which this window is a transient pop-up.
3810
3811 This is a hint to the window manager that this window is a dialog or pop-up
3812 on behalf of the transient parent. It usually means that the transient
3813 window will be centered over its transient parent when it is initially
3814 shown, that minimizing the parent window will also minimize the transient
3815 window, and so on; however results vary somewhat from platform to platform.
3816
3817 Declaring a Window inside an Item or another Window, either via the
3818 \l{Window::data}{default property} or a dedicated property, will automatically
3819 set up a transient parent relationship to the containing window,
3820 unless the \l transientParent property is explicitly set. This applies
3821 when creating Window items via \l [QML] {QtQml::Qt::createComponent()}
3822 {Qt.createComponent} or \l [QML] {QtQml::Qt::createQmlObject()}
3823 {Qt.createQmlObject} as well, as long as an Item or Window is passed
3824 as the \c parent argument.
3825
3826 A Window with a transient parent will not be shown until its transient
3827 parent is shown, even if the \l visible property is \c true. This also
3828 applies for the automatic transient parent relationship described above.
3829 In particular, if the Window's containing element is an Item, the window
3830 will not be shown until the containing item is added to a scene, via its
3831 \l{Concepts - Visual Parent in Qt Quick}{visual parent hierarchy}. Setting
3832 the \l transientParent to \c null will override this behavior:
3833
3834 \snippet qml/nestedWindowTransientParent.qml 0
3835 \snippet qml/nestedWindowTransientParent.qml 1
3836
3837 In order to cause the window to be centered above its transient parent by
3838 default, depending on the window manager, it may also be necessary to set
3839 the \l Window::flags property with a suitable \l Qt::WindowType (such as
3840 \c Qt::Dialog).
3841
3842 \sa {QQuickWindow::}{parent()}
3843*/
3844
3845/*!
3846 \property QQuickWindow::transientParent
3847 \brief The window for which this window is a transient pop-up.
3848 \since 5.13
3849
3850 This is a hint to the window manager that this window is a dialog or pop-up
3851 on behalf of the transient parent, which may be any kind of \l QWindow.
3852
3853 In order to cause the window to be centered above its transient parent by
3854 default, depending on the window manager, it may also be necessary to set
3855 the \l flags property with a suitable \l Qt::WindowType (such as \c Qt::Dialog).
3856
3857 \sa parent()
3858 */
3859
3860/*!
3861 \qmlproperty Item Window::activeFocusItem
3862 \since 5.1
3863
3864 The item which currently has active focus or \c null if there is
3865 no item with active focus.
3866 */
3867
3868/*!
3869 \qmlattachedproperty Item Window::activeFocusItem
3870 \since 5.4
3871
3872 This attached property holds the item which currently has active focus or
3873 \c null if there is no item with active focus. The Window attached property
3874 can be attached to any Item.
3875*/
3876
3877/*!
3878 \qmlproperty bool Window::active
3879 \since 5.1
3880
3881 The active status of the window.
3882
3883 \snippet qml/windowPalette.qml declaration-and-color
3884 \snippet qml/windowPalette.qml closing-brace
3885
3886 \sa requestActivate()
3887 */
3888
3889/*!
3890 \qmlattachedproperty bool Window::active
3891 \since 5.4
3892
3893 This attached property tells whether the window is active. The Window
3894 attached property can be attached to any Item.
3895
3896 Here is an example which changes a label to show the active state of the
3897 window in which it is shown:
3898
3899 \snippet qml/windowActiveAttached.qml entire
3900*/
3901
3902/*!
3903 \qmlmethod void QtQuick::Window::requestActivate()
3904 \since 5.1
3905
3906 Requests the window to be activated, i.e. receive keyboard focus.
3907 */
3908
3909/*!
3910 \qmlmethod void QtQuick::Window::alert(int msec)
3911 \since 5.1
3912
3913 Causes an alert to be shown for \a msec milliseconds. If \a msec is \c 0
3914 (the default), then the alert is shown indefinitely until the window
3915 becomes active again.
3916
3917 In alert state, the window indicates that it demands attention, for example
3918 by flashing or bouncing the taskbar entry.
3919*/
3920
3921/*!
3922 \qmlmethod void QtQuick::Window::close()
3923
3924 Closes the window.
3925
3926 When this method is called, or when the user tries to close the window by
3927 its title bar button, the \l closing signal will be emitted. If there is no
3928 handler, or the handler does not revoke permission to close, the window
3929 will subsequently close. If the QGuiApplication::quitOnLastWindowClosed
3930 property is \c true, and there are no other windows open, the application
3931 will quit.
3932*/
3933
3934/*!
3935 \qmlmethod void QtQuick::Window::raise()
3936
3937 Raises the window in the windowing system.
3938
3939 Requests that the window be raised to appear above other windows.
3940*/
3941
3942/*!
3943 \qmlmethod void QtQuick::Window::lower()
3944
3945 Lowers the window in the windowing system.
3946
3947 Requests that the window be lowered to appear below other windows.
3948*/
3949
3950/*!
3951 \qmlmethod void QtQuick::Window::show()
3952
3953 Shows the window.
3954
3955 This is equivalent to calling showFullScreen(), showMaximized(), or showNormal(),
3956 depending on the platform's default behavior for the window type and flags.
3957
3958 \sa showFullScreen(), showMaximized(), showNormal(), hide(), QQuickItem::flags()
3959*/
3960
3961/*!
3962 \qmlmethod void QtQuick::Window::hide()
3963
3964 Hides the window.
3965
3966 Equivalent to setting \l visible to \c false or \l visibility to \l {QWindow::}{Hidden}.
3967
3968 \sa show()
3969*/
3970
3971/*!
3972 \qmlmethod void QtQuick::Window::showMinimized()
3973
3974 Shows the window as minimized.
3975
3976 Equivalent to setting \l visibility to \l {QWindow::}{Minimized}.
3977*/
3978
3979/*!
3980 \qmlmethod void QtQuick::Window::showMaximized()
3981
3982 Shows the window as maximized.
3983
3984 Equivalent to setting \l visibility to \l {QWindow::}{Maximized}.
3985*/
3986
3987/*!
3988 \qmlmethod void QtQuick::Window::showFullScreen()
3989
3990 Shows the window as fullscreen.
3991
3992 Equivalent to setting \l visibility to \l {QWindow::}{FullScreen}.
3993*/
3994
3995/*!
3996 \qmlmethod void QtQuick::Window::showNormal()
3997
3998 Shows the window as normal, i.e. neither maximized, minimized, nor fullscreen.
3999
4000 Equivalent to setting \l visibility to \l {QWindow::}{Windowed}.
4001*/
4002
4003/*!
4004 \enum QQuickWindow::RenderStage
4005 \since 5.4
4006
4007 \value BeforeSynchronizingStage Before synchronization.
4008 \value AfterSynchronizingStage After synchronization.
4009 \value BeforeRenderingStage Before rendering.
4010 \value AfterRenderingStage After rendering.
4011 \value AfterSwapStage After the frame is swapped.
4012 \value NoStage As soon as possible. This value was added in Qt 5.6.
4013
4014 \sa {Scene Graph and Rendering}
4015 */
4016
4017/*!
4018 \since 5.4
4019
4020 Schedules \a job to run when the rendering of this window reaches
4021 the given \a stage.
4022
4023 This is a convenience to the equivalent signals in QQuickWindow for
4024 "one shot" tasks.
4025
4026 The window takes ownership over \a job and will delete it when the
4027 job is completed.
4028
4029 If rendering is shut down before \a job has a chance to run, the
4030 job will be run and then deleted as part of the scene graph cleanup.
4031 If the window is never shown and no rendering happens before the QQuickWindow
4032 is destroyed, all pending jobs will be destroyed without their run()
4033 method being called.
4034
4035 If the rendering is happening on a different thread, then the job
4036 will happen on the rendering thread.
4037
4038 If \a stage is \l NoStage, \a job will be run at the earliest opportunity
4039 whenever the render thread is not busy rendering a frame. If the window is
4040 not exposed, and is not renderable, at the time the job is either posted or
4041 handled, the job is deleted without executing the run() method. If a
4042 non-threaded renderer is in use, the run() method of the job is executed
4043 synchronously. When rendering with OpenGL, the OpenGL context is changed to
4044 the renderer's context before executing any job, including \l NoStage jobs.
4045
4046 \note This function does not trigger rendering; the jobs targeting any other
4047 stage than NoStage will be stored run until rendering is triggered elsewhere.
4048 To force the job to run earlier, call QQuickWindow::update();
4049
4050 \sa beforeRendering(), afterRendering(), beforeSynchronizing(),
4051 afterSynchronizing(), frameSwapped(), sceneGraphInvalidated()
4052 */
4053
4054void QQuickWindow::scheduleRenderJob(QRunnable *job, RenderStage stage)
4055{
4056 Q_D(QQuickWindow);
4057
4058 d->renderJobMutex.lock();
4059 if (stage == BeforeSynchronizingStage) {
4060 d->beforeSynchronizingJobs << job;
4061 } else if (stage == AfterSynchronizingStage) {
4062 d->afterSynchronizingJobs << job;
4063 } else if (stage == BeforeRenderingStage) {
4064 d->beforeRenderingJobs << job;
4065 } else if (stage == AfterRenderingStage) {
4066 d->afterRenderingJobs << job;
4067 } else if (stage == AfterSwapStage) {
4068 d->afterSwapJobs << job;
4069 } else if (stage == NoStage) {
4070 if (d->renderControl && d->rhi && d->rhi->thread() == QThread::currentThread()) {
4071 job->run();
4072 delete job;
4073 } else if (isExposed()) {
4074 d->windowManager->postJob(this, job);
4075 } else {
4076 delete job;
4077 }
4078 }
4079 d->renderJobMutex.unlock();
4080}
4081
4082void QQuickWindowPrivate::runAndClearJobs(QList<QRunnable *> *jobs)
4083{
4084 renderJobMutex.lock();
4085 QList<QRunnable *> jobList = *jobs;
4086 jobs->clear();
4087 renderJobMutex.unlock();
4088
4089 for (QRunnable *r : std::as_const(jobList)) {
4090 r->run();
4091 delete r;
4092 }
4093}
4094
4095void QQuickWindow::runJobsAfterSwap()
4096{
4097 Q_D(QQuickWindow);
4098 d->runAndClearJobs(&d->afterSwapJobs);
4099}
4100
4101/*!
4102 \fn void QQuickWindow::devicePixelRatioChanged()
4103 \since 6.11
4104 This signal is emitted when the effective device pixel ratio has
4105 been changed.
4106 \sa effectiveDevicePixelRatio()
4107 */
4108
4109/*!
4110 \qmlsignal QtQuick::Window::devicePixelRatioChanged()
4111 */
4112
4113/*!
4114 \property QQuickWindow::devicePixelRatio
4115 \since 6.11
4116
4117 Returns the ratio between physical pixels and device-independent pixels for the window. This value is dependent on the screen the window is on, and may change when the window is moved.
4118 */
4119
4120/*!
4121 Returns the device pixel ratio for this window.
4122
4123 This is different from QWindow::devicePixelRatio() in that it supports
4124 redirected rendering via QQuickRenderControl and QQuickRenderTarget. When
4125 using a QQuickRenderControl, the QQuickWindow is often not fully created,
4126 meaning it is never shown and there is no underlying native window created
4127 in the windowing system. As a result, querying properties like the device
4128 pixel ratio cannot give correct results. This function takes into account
4129 both QQuickRenderControl::renderWindowFor() and
4130 QQuickRenderTarget::devicePixelRatio(). When no redirection is in effect,
4131 the result is same as QWindow::devicePixelRatio().
4132
4133 \sa QQuickRenderControl, QQuickRenderTarget, setRenderTarget(), QWindow::devicePixelRatio()
4134 */
4135qreal QQuickWindow::effectiveDevicePixelRatio() const
4136{
4137 Q_D(const QQuickWindow);
4138 QWindow *w = QQuickRenderControl::renderWindowFor(const_cast<QQuickWindow *>(this));
4139 if (w)
4140 return w->devicePixelRatio();
4141
4142 if (!d->customRenderTarget.isNull())
4143 return d->customRenderTarget.devicePixelRatio();
4144
4145 return devicePixelRatio();
4146}
4147
4148/*!
4149 \return the current renderer interface. The value is always valid and is never null.
4150
4151 \note This function can be called at any time after constructing the
4152 QQuickWindow, even while isSceneGraphInitialized() is still false. However,
4153 some renderer interface functions, in particular
4154 QSGRendererInterface::getResource() will not be functional until the
4155 scenegraph is up and running. Backend queries, like
4156 QSGRendererInterface::graphicsApi() or QSGRendererInterface::shaderType(),
4157 will always be functional on the other hand.
4158
4159 \note The ownership of the returned pointer stays with Qt. The returned
4160 instance may or may not be shared between different QQuickWindow instances,
4161 depending on the scenegraph backend in use. Therefore applications are
4162 expected to query the interface object for each QQuickWindow instead of
4163 reusing the already queried pointer.
4164
4165 \sa QSGRenderNode, QSGRendererInterface
4166
4167 \since 5.8
4168 */
4169QSGRendererInterface *QQuickWindow::rendererInterface() const
4170{
4171 Q_D(const QQuickWindow);
4172
4173 // no context validity check - it is essential to be able to return a
4174 // renderer interface instance before scenegraphInitialized() is emitted
4175 // (depending on the backend, that can happen way too late for some of the
4176 // rif use cases, like examining the graphics api or shading language in
4177 // use)
4178
4179 return d->context->sceneGraphContext()->rendererInterface(d->context);
4180}
4181
4182/*!
4183 \return the QRhi object used by this window for rendering.
4184
4185 Available only when the window is using Qt's 3D API and shading language
4186 abstractions, meaning the result is always null when using the \c software
4187 adaptation.
4188
4189 The result is valid only when rendering has been initialized, which is
4190 indicated by the emission of the sceneGraphInitialized() signal. Before
4191 that point, the returned value is null. With a regular, on-screen
4192 QQuickWindow scenegraph initialization typically happens when the native
4193 window gets exposed (shown) the first time. When using QQuickRenderControl,
4194 initialization is done in the explicit
4195 \l{QQuickRenderControl::initialize()}{initialize()} call.
4196
4197 In practice this function is a shortcut to querying the QRhi via the
4198 QSGRendererInterface.
4199
4200 \since 6.6
4201 */
4202QRhi *QQuickWindow::rhi() const
4203{
4204 Q_D(const QQuickWindow);
4205 return d->rhi;
4206}
4207
4208/*!
4209 \return the QRhiSwapChain used by this window, if there is one.
4210
4211 \note Only on-screen windows backed by one of the standard render loops
4212 (such as, \c basic or \c threaded) will have a swapchain. Otherwise the
4213 returned value is null. For example, the result is always null when the
4214 window is used with QQuickRenderControl.
4215
4216 \since 6.6
4217 */
4218QRhiSwapChain *QQuickWindow::swapChain() const
4219{
4220 Q_D(const QQuickWindow);
4221 return d->swapchain;
4222}
4223
4224/*!
4225 Requests the specified graphics \a api.
4226
4227 When the built-in, default graphics adaptation is used, \a api specifies
4228 which graphics API (OpenGL, Vulkan, Metal, or Direct3D) the scene graph
4229 should use to render. In addition, the \c software backend is built-in as
4230 well, and can be requested by setting \a api to
4231 QSGRendererInterface::Software.
4232
4233 Unlike setSceneGraphBackend(), which can only be used to request a given
4234 backend (shipped either built-in or installed as dynamically loaded
4235 plugins), this function works with the higher level concept of graphics
4236 APIs. It covers the backends that ship with Qt Quick, and thus have
4237 corresponding values in the QSGRendererInterface::GraphicsApi enum.
4238
4239 When this function is not called at all, and the equivalent environment
4240 variable \c{QSG_RHI_BACKEND} is not set either, the scene graph will choose
4241 the graphics API to use based on the platform.
4242
4243 This function becomes important in applications that are only prepared for
4244 rendering with a given API. For example, if there is native OpenGL or
4245 Vulkan rendering done by the application, it will want to ensure Qt Quick
4246 is rendering using OpenGL or Vulkan too. Such applications are expected to
4247 call this function early in their main() function.
4248
4249 \note The call to the function must happen before constructing the first
4250 QQuickWindow in the application. The graphics API cannot be changed
4251 afterwards.
4252
4253 \note When used in combination with QQuickRenderControl, this rule is
4254 relaxed: it is possible to change the graphics API, but only when all
4255 existing QQuickRenderControl and QQuickWindow instances have been
4256 destroyed.
4257
4258 To query what graphics API the scene graph is using to render,
4259 QSGRendererInterface::graphicsApi() after the scene graph
4260 \l{QQuickWindow::isSceneGraphInitialized()}{has initialized}, which
4261 typically happens either when the window becomes visible for the first time, or
4262 when QQuickRenderControl::initialize() is called.
4263
4264 To switch back to the default behavior, where the scene graph chooses a
4265 graphics API based on the platform and other conditions, set \a api to
4266 QSGRendererInterface::Unknown.
4267
4268 \since 6.0
4269 */
4270void QQuickWindow::setGraphicsApi(QSGRendererInterface::GraphicsApi api)
4271{
4272 // Special cases: these are different scenegraph backends.
4273 switch (api) {
4274 case QSGRendererInterface::Software:
4275 setSceneGraphBackend(QStringLiteral("software"));
4276 break;
4277 case QSGRendererInterface::OpenVG:
4278 setSceneGraphBackend(QStringLiteral("openvg"));
4279 break;
4280 default:
4281 break;
4282 }
4283
4284 // Standard case: tell the QRhi-based default adaptation what graphics api
4285 // (QRhi backend) to use.
4286 if (QSGRendererInterface::isApiRhiBased(api) || api == QSGRendererInterface::Unknown)
4287 QSGRhiSupport::instance_internal()->configure(api);
4288}
4289
4290/*!
4291 \return the graphics API that would be used by the scene graph if it was
4292 initialized at this point in time.
4293
4294 The standard way to query the API used by the scene graph is to use
4295 QSGRendererInterface::graphicsApi() once the scene graph has initialized,
4296 for example when or after the sceneGraphInitialized() signal is emitted. In
4297 that case one gets the true, real result, because then it is known that
4298 everything was initialized correctly using that graphics API.
4299
4300 This is not always convenient. If the application needs to set up external
4301 frameworks, or needs to work with setGraphicsDevice() in a manner that
4302 depends on the scene graph's built in API selection logic, it is not always
4303 feasiable to defer such operations until after the QQuickWindow has been
4304 made visible or QQuickRenderControl::initialize() has been called.
4305
4306 Therefore, this static function is provided as a counterpart to
4307 setGraphicsApi(): it can be called at any time, and the result reflects
4308 what API the scene graph would choose if it was initialized at the point of
4309 the call.
4310
4311 \note This static function is intended to be called on the main (GUI)
4312 thread only. For querying the API when rendering, use QSGRendererInterface
4313 since that object lives on the render thread.
4314
4315 \note This function does not take scene graph backends into account.
4316
4317 \since 6.0
4318 */
4319QSGRendererInterface::GraphicsApi QQuickWindow::graphicsApi()
4320{
4321 // Note that this applies the settings e.g. from the env vars
4322 // (QSG_RHI_BACKEND) if it was not done at least once already. Whereas if
4323 // setGraphicsApi() was called before, or the scene graph is already
4324 // initialized, then this is just a simple query.
4325 return QSGRhiSupport::instance()->graphicsApi();
4326}
4327
4328/*!
4329 Requests a Qt Quick scenegraph \a backend. Backends can either be built-in
4330 or be installed in form of dynamically loaded plugins.
4331
4332 \overload
4333
4334 \note The call to the function must happen before constructing the first
4335 QQuickWindow in the application. It cannot be changed afterwards.
4336
4337 See \l{Switch Between Adaptations in Your Application} for more information
4338 about the list of backends. If \a backend is invalid or an error occurs, the
4339 request is ignored.
4340
4341 \note Calling this function is equivalent to setting the
4342 \c QT_QUICK_BACKEND or \c QMLSCENE_DEVICE environment variables. However, this
4343 API is safer to use in applications that spawn other processes as there is
4344 no need to worry about environment inheritance.
4345
4346 \since 5.8
4347 */
4348void QQuickWindow::setSceneGraphBackend(const QString &backend)
4349{
4350 QSGContext::setBackend(backend);
4351}
4352
4353/*!
4354 Returns the requested Qt Quick scenegraph backend.
4355
4356 \note The return value of this function may still be outdated by
4357 subsequent calls to setSceneGraphBackend() until the first QQuickWindow in the
4358 application has been constructed.
4359
4360 \note The value only reflects the request in the \c{QT_QUICK_BACKEND}
4361 environment variable after a QQuickWindow has been constructed.
4362
4363 \since 5.9
4364 */
4365QString QQuickWindow::sceneGraphBackend()
4366{
4367 return QSGContext::backend();
4368}
4369
4370/*!
4371 Sets the graphics device objects for this window. The scenegraph will use
4372 existing device, physical device, and other objects specified by \a device
4373 instead of creating new ones.
4374
4375 This function is very often used in combination with QQuickRenderControl
4376 and setRenderTarget(), in order to redirect Qt Quick rendering into a
4377 texture.
4378
4379 A default constructed QQuickGraphicsDevice does not change the default
4380 behavior in any way. Once a \a device created via one of the
4381 QQuickGraphicsDevice factory functions, such as,
4382 QQuickGraphicsDevice::fromDeviceObjects(), is passed in, and the scenegraph
4383 uses a matching graphics API (with the example of fromDeviceObjects(), that
4384 would be Vulkan), the scenegraph will use the existing device objects (such
4385 as, the \c VkPhysicalDevice, \c VkDevice, and graphics queue family index,
4386 in case of Vulkan) encapsulated by the QQuickGraphicsDevice. This allows
4387 using the same device, and so sharing resources, such as buffers and
4388 textures, between Qt Quick and native rendering engines.
4389
4390 \warning This function can only be called before initializing the
4391 scenegraph and will have no effect if called afterwards. In practice this
4392 typically means calling it right before QQuickRenderControl::initialize().
4393
4394 As an example, this time with Direct3D, the typical usage is expected to be
4395 the following:
4396
4397 \badcode
4398 // native graphics resources set up by a custom D3D rendering engine
4399 ID3D11Device *device;
4400 ID3D11DeviceContext *context;
4401 ID3D11Texture2D *texture;
4402 ...
4403 // now to redirect Qt Quick content into 'texture' we could do the following:
4404 QQuickRenderControl *renderControl = new QQuickRenderControl;
4405 QQuickWindow *window = new QQuickWindow(renderControl); // this window will never be shown on-screen
4406 ...
4407 window->setGraphicsDevice(QQuickGraphicsDevice::fromDeviceAndContext(device, context));
4408 renderControl->initialize();
4409 window->setRenderTarget(QQuickRenderTarget::fromD3D11Texture(texture, textureSize);
4410 ...
4411 \endcode
4412
4413 The key aspect of using this function is to ensure that resources or
4414 handles to resources, such as \c texture in the above example, are visible
4415 to and usable by both the external rendering engine and the scenegraph
4416 renderer. This requires using the same graphics device (or with OpenGL,
4417 OpenGL context).
4418
4419 QQuickGraphicsDevice instances are implicitly shared, copyable, and
4420 can be passed by value. They do not own the associated native objects (such
4421 as, the ID3D11Device in the example).
4422
4423 \note Using QQuickRenderControl does not always imply having to call this
4424 function. When adopting an existing device or context is not needed, this
4425 function should not be called, and the scene graph will then initialize its
4426 own devices and contexts normally, just as it would with an on-screen
4427 QQuickWindow.
4428
4429 \since 6.0
4430
4431 \sa QQuickRenderControl, setRenderTarget(), setGraphicsApi()
4432 */
4433void QQuickWindow::setGraphicsDevice(const QQuickGraphicsDevice &device)
4434{
4435 Q_D(QQuickWindow);
4436 d->customDeviceObjects = device;
4437}
4438
4439/*!
4440 \return the QQuickGraphicsDevice passed to setGraphicsDevice(), or a
4441 default constructed one otherwise
4442
4443 \since 6.0
4444
4445 \sa setGraphicsDevice()
4446 */
4447QQuickGraphicsDevice QQuickWindow::graphicsDevice() const
4448{
4449 Q_D(const QQuickWindow);
4450 return d->customDeviceObjects;
4451}
4452
4453/*!
4454 Sets the graphics configuration for this window. \a config contains various
4455 settings that may be taken into account by the scene graph when
4456 initializing the underlying graphics devices and contexts.
4457
4458 Such additional configuration, specifying for example what device
4459 extensions to enable for Vulkan, becomes relevant and essential when
4460 integrating native graphics rendering code that relies on certain
4461 extensions. The same is true when integrating with an external 3D or VR
4462 engines, such as OpenXR.
4463
4464 \note The configuration is ignored when adopting existing graphics devices
4465 via setGraphicsDevice() since the scene graph is then not in control of the
4466 actual construction of those objects.
4467
4468 QQuickGraphicsConfiguration instances are implicitly shared, copyable, and
4469 can be passed by value.
4470
4471 \warning Setting a QQuickGraphicsConfiguration on a QQuickWindow must
4472 happen early enough, before the scene graph is initialized for the first
4473 time for that window. With on-screen windows this means the call must be
4474 done before invoking show() on the QQuickWindow or QQuickView. With
4475 QQuickRenderControl the configuration must be finalized before calling
4476 \l{QQuickRenderControl::initialize()}{initialize()}.
4477
4478 \since 6.0
4479 */
4480void QQuickWindow::setGraphicsConfiguration(const QQuickGraphicsConfiguration &config)
4481{
4482 Q_D(QQuickWindow);
4483 d->graphicsConfig = config;
4484}
4485
4486/*!
4487 \return the QQuickGraphicsConfiguration passed to
4488 setGraphicsConfiguration(), or a default constructed one otherwise.
4489
4490 \since 6.0
4491
4492 \sa setGraphicsConfiguration()
4493 */
4494QQuickGraphicsConfiguration QQuickWindow::graphicsConfiguration() const
4495{
4496 Q_D(const QQuickWindow);
4497 return d->graphicsConfig;
4498}
4499
4500/*!
4501 Creates a text node. When the scenegraph is not initialized, the return value is null.
4502
4503 \since 6.7
4504 \sa QSGTextNode
4505 */
4506QSGTextNode *QQuickWindow::createTextNode() const
4507{
4508 Q_D(const QQuickWindow);
4509 return isSceneGraphInitialized() ? d->context->sceneGraphContext()->createTextNode(d->context) : nullptr;
4510}
4511
4512/*!
4513 Creates a simple rectangle node. When the scenegraph is not initialized, the return value is null.
4514
4515 This is cross-backend alternative to constructing a QSGSimpleRectNode directly.
4516
4517 \since 5.8
4518 \sa QSGRectangleNode
4519 */
4520QSGRectangleNode *QQuickWindow::createRectangleNode() const
4521{
4522 Q_D(const QQuickWindow);
4523 return isSceneGraphInitialized() ? d->context->sceneGraphContext()->createRectangleNode() : nullptr;
4524}
4525
4526/*!
4527 Creates a simple image node. When the scenegraph is not initialized, the return value is null.
4528
4529 This is cross-backend alternative to constructing a QSGSimpleTextureNode directly.
4530
4531 \since 5.8
4532 \sa QSGImageNode
4533 */
4534QSGImageNode *QQuickWindow::createImageNode() const
4535{
4536 Q_D(const QQuickWindow);
4537 return isSceneGraphInitialized() ? d->context->sceneGraphContext()->createImageNode() : nullptr;
4538}
4539
4540/*!
4541 Creates a nine patch node. When the scenegraph is not initialized, the return value is null.
4542
4543 \since 5.8
4544 */
4545QSGNinePatchNode *QQuickWindow::createNinePatchNode() const
4546{
4547 Q_D(const QQuickWindow);
4548 return isSceneGraphInitialized() ? d->context->sceneGraphContext()->createNinePatchNode() : nullptr;
4549}
4550
4551/*!
4552 \since 5.10
4553
4554 Returns the render type of text-like elements in Qt Quick.
4555 The default is QQuickWindow::QtTextRendering.
4556
4557 \sa setTextRenderType()
4558*/
4559QQuickWindow::TextRenderType QQuickWindow::textRenderType()
4560{
4561 return QQuickWindowPrivate::textRenderType;
4562}
4563
4564/*!
4565 \since 5.10
4566
4567 Sets the default render type of text-like elements in Qt Quick to \a renderType.
4568
4569 \note setting the render type will only affect elements created afterwards;
4570 the render type of existing elements will not be modified.
4571
4572 \sa textRenderType()
4573*/
4574void QQuickWindow::setTextRenderType(QQuickWindow::TextRenderType renderType)
4575{
4576 QQuickWindowPrivate::textRenderType = renderType;
4577}
4578
4579
4580/*!
4581 \since 6.0
4582 \qmlproperty Palette Window::palette
4583
4584 This property holds the palette currently set for the window.
4585
4586 The default palette depends on the system environment. QGuiApplication maintains a system/theme
4587 palette which serves as a default for all application windows. You can also set the default palette
4588 for windows by passing a custom palette to QGuiApplication::setPalette(), before loading any QML.
4589
4590 Window propagates explicit palette properties to child items and controls,
4591 overriding any system defaults for that property.
4592
4593 \snippet qml/windowPalette.qml entire
4594
4595 \sa Item::palette, Popup::palette, ColorGroup, SystemPalette
4596 //! internal \sa QQuickAbstractPaletteProvider, QQuickPalette
4597*/
4598
4599#ifndef QT_NO_DEBUG_STREAM
4600QDebug operator<<(QDebug debug, const QQuickWindow *win)
4601{
4602 QDebugStateSaver saver(debug);
4603 debug.nospace();
4604 if (!win) {
4605 debug << "QQuickWindow(nullptr)";
4606 return debug;
4607 }
4608
4609 debug << win->metaObject()->className() << '(' << static_cast<const void *>(win);
4610 if (win->isActive())
4611 debug << " active";
4612 if (win->isExposed())
4613 debug << " exposed";
4614 debug << ", visibility=" << win->visibility() << ", flags=" << win->flags();
4615 if (!win->title().isEmpty())
4616 debug << ", title=" << win->title();
4617 if (!win->objectName().isEmpty())
4618 debug << ", name=" << win->objectName();
4619 if (win->parent())
4620 debug << ", parent=" << static_cast<const void *>(win->parent());
4621 if (win->transientParent())
4622 debug << ", transientParent=" << static_cast<const void *>(win->transientParent());
4623 debug << ", geometry=";
4624 QtDebugUtils::formatQRect(debug, win->geometry());
4625 debug << ')';
4626 return debug;
4627}
4628#endif
4629
4630QT_END_NAMESPACE
4631
4632#include "qquickwindow.moc"
4633#include "moc_qquickwindow_p.cpp"
4634#include "moc_qquickwindow.cpp"
QT_BEGIN_NAMESPACE Q_STATIC_LOGGING_CATEGORY(lcSynthesizedIterableAccess, "qt.iterable.synthesized", QtWarningMsg)
static void updatePixelRatioHelper(QQuickItem *item, float pixelRatio)
void forcePolishHelper(QQuickItem *item)
void forceUpdate(QQuickItem *item)
QDebug operator<<(QDebug debug, const QQuickWindow *win)
static QSGNode * qquickitem_before_paintNode(QQuickItemPrivate *d)
static QSGNode * fetchNextNode(QQuickItemPrivate *itemPriv, int &ii, bool &returnedPaintNode)
const QList< QQuickItem * > & itemsToPolish
bool check(QQuickItem *item, int itemsRemainingBeforeUpdatePolish)
PolishLoopDetector(const QList< QQuickItem * > &itemsToPolish)
QRhiRenderPassDescriptor * rpDesc
QRhiRenderBuffer * renderBuffer