\inmodule QtQuick More...

#include <qquickrhiitem.h>

Inheritance diagram for QQuickRhiItem:

Collaboration diagram for QQuickRhiItem:

Public Types
enum class	TextureFormat { RGBA8 , RGBA16F , RGBA32F , RGB10A2 }

Public Types inherited from QQuickItem
enum	Flag { ItemClipsChildrenToShape = 0x01 , ItemIsFocusScope = 0x04 , ItemHasContents = 0x08 , ItemAcceptsDrops = 0x10 , ItemIsViewport = 0x20 , ItemObservesViewport = 0x40 }
	\qmltype Item \nativetype QQuickItem \inherits QtObject \inqmlmodule QtQuick More...

enum	ItemChange { ItemChildAddedChange , ItemChildRemovedChange , ItemSceneChange , ItemVisibleHasChanged , ItemParentHasChanged , ItemOpacityHasChanged , ItemActiveFocusHasChanged , ItemRotationHasChanged , ItemAntialiasingHasChanged , ItemDevicePixelRatioHasChanged , ItemEnabledHasChanged , ItemScaleHasChanged , ItemTransformHasChanged }
	Used in conjunction with QQuickItem::itemChange() to notify the item about certain types of changes. More...

enum	TransformOrigin { TopLeft , Top , TopRight , Left , Center , Right , BottomLeft , Bottom , BottomRight }
	\variable QQuickItem::ItemChangeData::realValue The numeric value that has changed: \l {QQuickItem::opacity()}{opacity}, \l {QQuickItem::rotation()}{rotation}, or \l {QQuickItem::scale()}{scale}, or \l {QScreen::devicePixelRatio}{device pixel ratio}. More...

Signals
void	sampleCountChanged ()

void	colorBufferFormatChanged ()

void	autoRenderTargetChanged ()

void	mirrorVerticallyChanged ()

void	alphaBlendingChanged ()

void	fixedColorBufferWidthChanged ()

void	fixedColorBufferHeightChanged ()

void	effectiveColorBufferSizeChanged ()

Signals inherited from QQuickItem
void	childrenRectChanged (const QRectF &)

void	baselineOffsetChanged (qreal)

void	stateChanged (const QString &)

void	focusChanged (bool)

void	activeFocusChanged (bool)

Q_REVISION(6, 7) void focusPolicyChanged(Qt	Q_REVISION (2, 1) void activeFocusOnTabChanged(bool)

void	parentChanged (QQuickItem *)

void	transformOriginChanged (TransformOrigin)

void	smoothChanged (bool)

void	antialiasingChanged (bool)

void	clipChanged (bool)

	Q_REVISION (2, 1) void windowChanged(QQuickWindow *window)

void	childrenChanged ()

void	opacityChanged ()

void	enabledChanged ()

void	visibleChanged ()

void	visibleChildrenChanged ()

void	rotationChanged ()

void	scaleChanged ()

void	xChanged ()

void	yChanged ()

void	widthChanged ()

void	heightChanged ()

void	zChanged ()

void	implicitWidthChanged ()

void	implicitHeightChanged ()

	Q_REVISION (2, 11) void containmentMaskChanged()

	Q_REVISION (6, 0) void paletteChanged()

	Q_REVISION (6, 0) void paletteCreated()

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickRhiItem (QQuickItem *parent=nullptr)
	Constructs a new QQuickRhiItem with the given parent.

	~QQuickRhiItem () override
	Destructor.

int	sampleCount () const

void	setSampleCount (int samples)

TextureFormat	colorBufferFormat () const

void	setColorBufferFormat (TextureFormat format)

bool	isMirrorVerticallyEnabled () const

void	setMirrorVertically (bool enable)

bool	alphaBlending () const

void	setAlphaBlending (bool enable)

int	fixedColorBufferWidth () const

void	setFixedColorBufferWidth (int width)

int	fixedColorBufferHeight () const

void	setFixedColorBufferHeight (int height)

QSize	effectiveColorBufferSize () const

bool	isTextureProvider () const override
	\reimp

QSGTextureProvider *	textureProvider () const override
	\reimp

Public Member Functions inherited from QQuickItem
	QQuickItem (QQuickItem *parent=nullptr)
	Constructs a QQuickItem with the given parent.

	~QQuickItem () override
	Destroys the QQuickItem.

QQuickWindow *	window () const
	Returns the window in which this item is rendered.

QQuickItem *	parentItem () const

void	setParentItem (QQuickItem *parent)

void	stackBefore (const QQuickItem *)
	Moves the specified sibling item to the index before this item within the list of children.

void	stackAfter (const QQuickItem *)
	Moves the specified sibling item to the index after this item within the list of children.

QRectF	childrenRect ()
	\qmlpropertygroup QtQuick::Item::childrenRect \qmlproperty real QtQuick::Item::childrenRect.x \qmlproperty real QtQuick::Item::childrenRect.y \qmlproperty real QtQuick::Item::childrenRect.width \qmlproperty real QtQuick::Item::childrenRect.height \readonly

QList< QQuickItem * >	childItems () const
	Returns the children of this item.

bool	clip () const
	\qmlproperty bool QtQuick::Item::clip This property holds whether clipping is enabled.

void	setClip (bool)

QString	state () const
	\qmlproperty string QtQuick::Item::state

void	setState (const QString &)

qreal	baselineOffset () const
	\qmlproperty int QtQuick::Item::baselineOffset

void	setBaselineOffset (qreal)

QQmlListProperty< QQuickTransform >	transform ()

qreal	x () const

qreal	y () const

QPointF	position () const

void	setX (qreal)

void	setY (qreal)

void	setPosition (const QPointF &)

QBindable< qreal >	bindableX ()

QBindable< qreal >	bindableY ()

qreal	width () const

void	setWidth (qreal)

void	resetWidth ()

void	setImplicitWidth (qreal)

qreal	implicitWidth () const
	Returns the width of the item that is implied by other properties that determine the content.

QBindable< qreal >	bindableWidth ()

qreal	height () const

void	setHeight (qreal)

void	resetHeight ()

void	setImplicitHeight (qreal)

qreal	implicitHeight () const

QBindable< qreal >	bindableHeight ()

QSizeF	size () const

void	setSize (const QSizeF &size)

TransformOrigin	transformOrigin () const

void	setTransformOrigin (TransformOrigin)

QPointF	transformOriginPoint () const

void	setTransformOriginPoint (const QPointF &)

qreal	z () const

void	setZ (qreal)

qreal	rotation () const

void	setRotation (qreal)

qreal	scale () const

void	setScale (qreal)

qreal	opacity () const

void	setOpacity (qreal)

bool	isVisible () const

void	setVisible (bool)

bool	isEnabled () const

void	setEnabled (bool)

bool	smooth () const

void	setSmooth (bool)

bool	activeFocusOnTab () const
	\qmlproperty bool QtQuick::Item::activeFocusOnTab

void	setActiveFocusOnTab (bool)

bool	antialiasing () const

void	setAntialiasing (bool)

void	resetAntialiasing ()

Flags	flags () const
	Returns the item flags for this item.

void	setFlag (Flag flag, bool enabled=true)
	Enables the specified flag for this item if enabled is true; if enabled is false, the flag is disabled.

void	setFlags (Flags flags)
	Enables the specified flags for this item.

virtual QRectF	boundingRect () const
	Returns the extents of the item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

virtual QRectF	clipRect () const
	Returns the rectangular area within this item that is currently visible in \l viewportItem(), if there is a viewport and the \l ItemObservesViewport flag is set; otherwise, the extents of this item in its own coordinate system: a rectangle from {0, 0} to \l width() and \l height().

QQuickItem *	viewportItem () const
	If the \l ItemObservesViewport flag is set, returns the nearest parent with the \l ItemIsViewport flag.

bool	hasActiveFocus () const

bool	hasFocus () const

void	setFocus (bool)

void	setFocus (bool focus, Qt::FocusReason reason)

bool	isFocusScope () const
	Returns true if this item is a focus scope, and false otherwise.

QQuickItem *	scopedFocusItem () const
	If this item is a focus scope, this returns the item in its focus chain that currently has focus.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)
	Sets the focus policy of this item to policy.

bool	isAncestorOf (const QQuickItem *child) const
	Returns `true` if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).

Qt::MouseButtons	acceptedMouseButtons () const
	Returns the mouse buttons accepted by this item.

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
	Sets the mouse buttons accepted by this item to buttons.

bool	acceptHoverEvents () const
	Returns whether hover events are accepted by this item.

void	setAcceptHoverEvents (bool enabled)
	If enabled is true, this sets the item to accept hover events; otherwise, hover events are not accepted by this item.

bool	acceptTouchEvents () const
	Returns whether touch events are accepted by this item.

void	setAcceptTouchEvents (bool accept)
	If enabled is true, this sets the item to accept touch events; otherwise, touch events are not accepted by this item.

bool	isUnderMouse () const

void	grabMouse ()

void	ungrabMouse ()

bool	keepMouseGrab () const
	Returns whether mouse input should exclusively remain with this item.

void	setKeepMouseGrab (bool)
	Sets whether the mouse input should remain exclusively with this item.

bool	filtersChildMouseEvents () const
	Returns whether pointer events intended for this item's children should be filtered through this item.

void	setFiltersChildMouseEvents (bool filter)
	Sets whether pointer events intended for this item's children should be filtered through this item.

void	grabTouchPoints (const QList< int > &ids)

void	ungrabTouchPoints ()

bool	keepTouchGrab () const
	Returns whether the touch points grabbed by this item should exclusively remain with this item.

void	setKeepTouchGrab (bool)
	Sets whether the touch points grabbed by this item should remain exclusively with this item.

	Q_REVISION (2, 4) Q_INVOKABLE bool grabToImage(const QJSValue &callback

QSharedPointer< QQuickItemGrabResult >	grabToImage (const QSize &targetSize=QSize())
	Grabs the item into an in-memory image.

virtual Q_INVOKABLE bool	contains (const QPointF &point) const
	\qmlmethod bool QtQuick::Item::contains(point point)

QObject *	containmentMask () const

void	setContainmentMask (QObject *mask)

QTransform	itemTransform (QQuickItem , bool ) const
	\qmlmethod point QtQuick::Item::mapFromItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapFromItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapFromItem(Item item, rect r)

QPointF	mapToScene (const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within the scene's coordinate system, and returns the mapped coordinate.

QRectF	mapRectToItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within item's coordinate system, and returns the mapped rectangle value.

QRectF	mapRectToScene (const QRectF &rect) const
	Maps the given rect in this item's coordinate system to the equivalent rectangular area within the scene's coordinate system, and returns the mapped rectangle value.

QPointF	mapFromScene (const QPointF &point) const
	Maps the given point in the scene's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.

QRectF	mapRectFromItem (const QQuickItem *item, const QRectF &rect) const
	Maps the given rect in item's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.

QRectF	mapRectFromScene (const QRectF &rect) const
	Maps the given rect in the scene's coordinate system to the equivalent rectangular area within this item's coordinate system, and returns the mapped rectangle value.

void	polish ()
	Schedules a polish event for this item.

Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in item's coordinate system to the equivalent point within this item's coordinate system, and returns the mapped coordinate.

Q_INVOKABLE QPointF	mapFromItem (const QQuickItem *item, qreal x, qreal y)

Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, const QRectF &rect) const

Q_INVOKABLE QRectF	mapFromItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const

Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, const QPointF &point) const
	Maps the given point in this item's coordinate system to the equivalent point within item's coordinate system, and returns the mapped coordinate.

Q_INVOKABLE QPointF	mapToItem (const QQuickItem *item, qreal x, qreal y)

Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, const QRectF &rect) const

Q_INVOKABLE QRectF	mapToItem (const QQuickItem *item, qreal x, qreal y, qreal width, qreal height) const

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(qreal x

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapFromGlobal(const QPointF &point) const

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(qreal x

	Q_REVISION (2, 7) Q_INVOKABLE QPointF mapToGlobal(const QPointF &point) const

Q_INVOKABLE void	forceActiveFocus ()
	\qmlmethod point QtQuick::Item::mapToItem(Item item, real x, real y) \qmlmethod point QtQuick::Item::mapToItem(Item item, point p) \qmlmethod rect QtQuick::Item::mapToItem(Item item, real x, real y, real width, real height) \qmlmethod rect QtQuick::Item::mapToItem(Item item, rect r)

Q_INVOKABLE void	forceActiveFocus (Qt::FocusReason reason)
	\qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason) This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Forces active focus on the item with the given reason.

	Q_REVISION (2, 1) Q_INVOKABLE QQuickItem *nextItemInFocusChain(bool forward

Q_INVOKABLE QQuickItem *	childAt (qreal x, qreal y) const
	\qmlmethod QtQuick::Item::childAt(real x, real y)

	Q_REVISION (6, 3) Q_INVOKABLE void ensurePolished()

	Q_REVISION (6, 3) Q_INVOKABLE void dumpItemTree() const

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QQmlParserStatus
	QQmlParserStatus ()

virtual	~QQmlParserStatus ()

Protected Member Functions
virtual QQuickRhiItemRenderer *	createRenderer ()=0
	Reimplement this function to create and return a new instance of a QQuickRhiItemRenderer subclass.

bool	isAutoRenderTargetEnabled () const

void	setAutoRenderTarget (bool enabled)
	Controls if a depth-stencil QRhiRenderBuffer and a QRhiTextureRenderTarget is created and maintained automatically by the item.

QSGNode *	updatePaintNode (QSGNode , UpdatePaintNodeData ) override

bool	event (QEvent *) override
	\reimp

void	geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
	\reimp

void	releaseResources () override
	\reimp

Protected Member Functions inherited from QQuickItem
bool	isComponentComplete () const
	Returns true if construction of the QML component is complete; otherwise returns false.

virtual void	itemChange (ItemChange, const ItemChangeData &)
	Called when change occurs for this item.

bool	widthValid () const
	Returns whether the width property has been set explicitly.

bool	heightValid () const
	Returns whether the height property has been set explicitly.

void	setImplicitSize (qreal, qreal)

void	classBegin () override
	\reimp Derived classes should call the base class method before adding their own action to perform at classBegin.

void	componentComplete () override
	\reimp Derived classes should call the base class method before adding their own actions to perform at componentComplete.

virtual void	keyPressEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key press events for an item.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler can be reimplemented in a subclass to receive key release events for an item.

virtual void	focusInEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-in events for an item.

virtual void	focusOutEvent (QFocusEvent *)
	This event handler can be reimplemented in a subclass to receive focus-out events for an item.

virtual void	mousePressEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse press events for an item.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse move events for an item.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse release events for an item.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler can be reimplemented in a subclass to receive mouse double-click events for an item.

virtual void	mouseUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a mouse ungrab event has occurred on this item.

virtual void	touchUngrabEvent ()
	This event handler can be reimplemented in a subclass to be notified when a touch ungrab event has occurred on this item.

virtual void	touchEvent (QTouchEvent *event)
	This event handler can be reimplemented in a subclass to receive touch events for an item.

virtual void	hoverEnterEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-enter events for an item.

virtual void	hoverMoveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-move events for an item.

virtual void	hoverLeaveEvent (QHoverEvent *event)
	This event handler can be reimplemented in a subclass to receive hover-leave events for an item.

virtual bool	childMouseEventFilter (QQuickItem , QEvent )
	Reimplement this method to filter the pointer events that are received by this item's children.

virtual void	updatePolish ()
	This function should perform any layout as required for this item.

	QQuickItem (QQuickItemPrivate &dd, QQuickItem *parent=nullptr)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties
int	sampleCount
	This property controls for sample count for multisample antialiasing.

TextureFormat	colorBufferFormat
	This property controls the texture format for the texture used as the color buffer.

bool	mirrorVertically
	This property controls if texture UVs are flipped when drawing the textured quad.

bool	alphaBlending
	Controls if blending is always enabled when drawing the quad textured with the content generated by the QQuickRhiItem and its renderer.

int	fixedColorBufferWidth
	The fixed width, in pixels, of the item's associated texture or renderbuffer.

int	fixedColorBufferHeight
	The fixed height, in pixels, of the item's associated texture.

QSize	effectiveColorBufferSize
	This property exposes the size, in pixels, of the underlying color buffer (the QRhiTexture or QRhiRenderBuffer).

Properties inherited from QQuickItem
QQuickItem *	parent
	\qmlproperty Item QtQuick::Item::parent This property holds the visual parent of the item.

qreal	x
	\qmlproperty real QtQuick::Item::x \qmlproperty real QtQuick::Item::y \qmlproperty real QtQuick::Item::width \qmlproperty real QtQuick::Item::height

qreal	y
	Defines the item's y position relative to its parent.

qreal	z
	\qmlproperty real QtQuick::Item::z

qreal	width
	This property holds the width of this item.

qreal	height
	This property holds the height of this item.

qreal	opacity
	\qmlproperty real QtQuick::Item::opacity

bool	enabled
	\qmlproperty bool QtQuick::Item::enabled

bool	visible
	\qmlproperty bool QtQuick::Item::visible

Qt::FocusPolicy	focusPolicy
	\qmlproperty enumeration QtQuick::Item::focusPolicy

qreal	rotation
	\qmlproperty real QtQuick::Item::rotation This property holds the rotation of the item in degrees clockwise around its transformOrigin.

qreal	scale
	\qmlproperty real QtQuick::Item::scale This property holds the scale factor for this item.

TransformOrigin	transformOrigin
	\qmlproperty enumeration QtQuick::Item::transformOrigin This property holds the origin point around which scale and rotation transform.

QPointF	transformOriginPoint

QQmlListProperty< QQuickTransform >	transform
	\qmlproperty list<Transform> QtQuick::Item::transform This property holds the list of transformations to apply.

bool	smooth
	\qmlproperty bool QtQuick::Item::smooth

bool	antialiasing
	\qmlproperty bool QtQuick::Item::antialiasing

qreal	implicitWidth

qreal	implicitHeight

QObject *	containmentMask
	\qmlproperty QObject* QtQuick::Item::containmentMask

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuickRhiItemNode

Additional Inherited Members
Public Slots inherited from QQuickItem
void	update ()
	Schedules a call to updatePaintNode() for this item.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Public Attributes inherited from QQuickItem
const QSize &	targetSize = QSize())

qreal y	const

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtQuick

Since: 6.7

The QQuickRhiItem class is a portable alternative to QQuickFramebufferObject that is not tied to OpenGL, but rather allows integrating rendering with the QRhi APIs with Qt Quick.

\preliminary

Note: QQuickRhiItem is in tech preview in Qt 6.7. {The API is under development and subject to change.}

QQuickRhiItem is effectively the counterpart of \l QRhiWidget in the world of Qt Quick. Both of these are meant to be subclassed, and they both enable recording QRhi-based rendering that targets an offscreen color buffer. The resulting 2D image is then composited with the rest of the Qt Quick scene.

Note: While QQuickRhiItem is a public Qt API, the QRhi family of classes in the Qt Gui module, including QShader and QShaderDescription, offer limited compatibility guarantees. There are no source or binary compatibility guarantees for these classes, meaning the API is only guaranteed to work with the Qt version the application was developed against. Source incompatible changes are however aimed to be kept at a minimum and will only be made in minor releases (6.7, 6.8, and so on). {qquickrhiitem.h} does not directly include any QRhi-related headers. To use those classes when implementing a QQuickRhiItem subclass, link to {Qt::GuiPrivate} (if using CMake), and include the appropriate headers with the rhi prefix, for example {#include <rhi/qrhi.h>}.

QQuickRhiItem is a replacement for the legacy \l QQuickFramebufferObject class. The latter is inherently tied to OpenGL / OpenGL ES, whereas QQuickRhiItem works with the QRhi classes, allowing to run the same rendering code with Vulkan, Metal, Direct 3D 11/12, and OpenGL / OpenGL ES. Conceptually and functionally they are very close, and migrating from QQuickFramebufferObject to QQuickRhiItem is straightforward. QQuickFramebufferObject continues to be available to ensure compatibility for existing application code that works directly with the OpenGL API.

Note: QQuickRhiItem will not be functional when using the software adaptation of the Qt Quick scene graph.

On most platforms, the scene graph rendering, and thus the rendering performed by the QQuickRhiItem will occur on a \l {Scene Graph and Rendering}{dedicated thread}. For this reason, the QQuickRhiItem class enforces a strict separation between the item implementation (the QQuickItem subclass) and the actual rendering logic. All item logic, such as properties and UI-related helper functions exposed to QML must be located in the QQuickRhiItem subclass. Everything that relates to rendering must be located in the QQuickRhiItemRenderer class. To avoid race conditions and read/write issues from two threads it is important that the renderer and the item never read or write shared variables. Communication between the item and the renderer should primarily happen via the QQuickRhiItem::synchronize() function. This function will be called on the render thread while the GUI thread is blocked. Using queued connections or events for communication between item and renderer is also possible.

Applications must subclass both QQuickRhiItem and QQuickRhiItemRenderer. The pure virtual createRenderer() function must be reimplemented to return a new instance of the QQuickRhiItemRenderer subclass.

As with QRhiWidget, QQuickRhiItem automatically managed the color buffer, which is a 2D texture (QRhiTexture) normally, or a QRhiRenderBuffer when multisampling is in use. (some 3D APIs differentiate between textures and renderbuffers, while with some others the underlying native resource is the same; renderbuffers are used mainly to allow multisampling with OpenGL ES 3.0)

The size of the texture will by default adapt to the size of the item (with the \l{QQuickWindow::effectiveDevicePixelRatio()}{device pixel ratio} taken into account). If the item size changes, the texture is recreated with the correct size. If a fixed size is preferred, set \l fixedColorBufferWidth and \l fixedColorBufferHeight to non-zero values.

QQuickRhiItem is a \l{QSGTextureProvider}{texture provider} and can be used directly in \l {ShaderEffect}{ShaderEffects} and other classes that consume texture providers.

While not a primary use case, QQuickRhiItem also allows incorporating rendering code that directly uses a 3D graphics API such as Vulkan, Metal, Direct 3D, or OpenGL. See \l QRhiCommandBuffer::beginExternal() for details on recording native commands within a QRhi render pass, as well as \l QRhiTexture::createFrom() for a way to wrap an existing native texture and then use it with QRhi in a subsequent render pass. See also \l QQuickGraphicsConfiguration regarding configuring the native 3D API environment (e.g. device extensions) and note that the \l QQuickWindow can be associated with a custom \l QVulkanInstance by calling \l QWindow::setVulkanInstance() early enough.

Note: QQuickRhiItem always uses the same QRhi instance the QQuickWindow uses (and by extension, the same OpenGL context, Vulkan device, etc.). To choose which underlying 3D graphics API is used, call \l{QQuickWindow::setGraphicsApi()}{setGraphicsApi()} on the QQuickWindow early enough. Changing it is not possible once the scene graph has initialized, and all QQuickRhiItem instances in the scene will render using the same 3D API.

Definition at line 48 of file qquickrhiitem.h.

Member Enumeration Documentation

◆ TextureFormat

enum class QQuickRhiItem::TextureFormat

strong

Enumerator
RGBA8
RGBA16F
RGBA32F
RGB10A2

Definition at line 62 of file qquickrhiitem.h.

Constructor & Destructor Documentation

◆ QQuickRhiItem()

QQuickRhiItem::QQuickRhiItem ( QQuickItem * parent = nullptr )

explicit

Constructs a new QQuickRhiItem with the given parent.

Definition at line 414 of file qquickrhiitem.cpp.

◆ ~QQuickRhiItem()

QQuickRhiItem::~QQuickRhiItem ( )

override

Destructor.

Definition at line 423 of file qquickrhiitem.cpp.

Member Function Documentation

◆ alphaBlending()

bool QQuickRhiItem::alphaBlending ( ) const

Definition at line 836 of file qquickrhiitem.cpp.

◆ alphaBlendingChanged

void QQuickRhiItem::alphaBlendingChanged ( )

signal

◆ autoRenderTargetChanged

void QQuickRhiItem::autoRenderTargetChanged ( )

signal

◆ colorBufferFormat()

QQuickRhiItem::TextureFormat QQuickRhiItem::colorBufferFormat ( ) const

Definition at line 616 of file qquickrhiitem.cpp.

◆ colorBufferFormatChanged

void QQuickRhiItem::colorBufferFormatChanged ( )

signal

◆ createRenderer()

virtual QQuickRhiItemRenderer * QQuickRhiItem::createRenderer ( )

protectedpure virtual

Reimplement this function to create and return a new instance of a QQuickRhiItemRenderer subclass.

This function will be called on the rendering thread while the GUI thread is blocked.

Implemented in ExampleRhiItem, and ExampleRhiItem.

◆ effectiveColorBufferSize()

QSize QQuickRhiItem::effectiveColorBufferSize ( ) const

Definition at line 803 of file qquickrhiitem.cpp.

◆ effectiveColorBufferSizeChanged

void QQuickRhiItem::effectiveColorBufferSizeChanged ( )

signal

◆ event()

bool QQuickRhiItem::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 487 of file qquickrhiitem.cpp.

◆ fixedColorBufferHeight()

int QQuickRhiItem::fixedColorBufferHeight ( ) const

Definition at line 765 of file qquickrhiitem.cpp.

◆ fixedColorBufferHeightChanged

void QQuickRhiItem::fixedColorBufferHeightChanged ( )

signal

◆ fixedColorBufferWidth()

int QQuickRhiItem::fixedColorBufferWidth ( ) const

Definition at line 729 of file qquickrhiitem.cpp.

◆ fixedColorBufferWidthChanged

void QQuickRhiItem::fixedColorBufferWidthChanged ( )

signal

◆ geometryChange()

void QQuickRhiItem::geometryChange	(	const QRectF &	newGeometry,
		const QRectF &	oldGeometry )

overrideprotectedvirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 495 of file qquickrhiitem.cpp.

◆ isAutoRenderTargetEnabled()

bool QQuickRhiItem::isAutoRenderTargetEnabled ( ) const

protected

Returns: the current automatic depth-stencil buffer and render target management setting.

By default this value is true.

See also: setAutoRenderTarget()

Definition at line 654 of file qquickrhiitem.cpp.

◆ isMirrorVerticallyEnabled()

bool QQuickRhiItem::isMirrorVerticallyEnabled ( ) const

Definition at line 693 of file qquickrhiitem.cpp.

◆ isTextureProvider()

bool QQuickRhiItem::isTextureProvider ( ) const

overridevirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 524 of file qquickrhiitem.cpp.

◆ mirrorVerticallyChanged

void QQuickRhiItem::mirrorVerticallyChanged ( )

signal

◆ releaseResources()

void QQuickRhiItem::releaseResources ( )

overrideprotectedvirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 505 of file qquickrhiitem.cpp.

◆ sampleCount()

int QQuickRhiItem::sampleCount ( ) const

Definition at line 579 of file qquickrhiitem.cpp.

◆ sampleCountChanged

void QQuickRhiItem::sampleCountChanged ( )

signal

◆ setAlphaBlending()

void QQuickRhiItem::setAlphaBlending ( bool enable )

Definition at line 842 of file qquickrhiitem.cpp.

◆ setAutoRenderTarget()

void QQuickRhiItem::setAutoRenderTarget ( bool enabled )

protected

Controls if a depth-stencil QRhiRenderBuffer and a QRhiTextureRenderTarget is created and maintained automatically by the item.

The default value is true. Call this function early on, for example from the derived class' constructor, with enabled set to false to disable this.

In automatic mode, the size and sample count of the depth-stencil buffer follows the color buffer texture's settings. In non-automatic mode, renderTarget() and depthStencilBuffer() always return \nullptr and it is then up to the application's implementation of initialize() to take care of setting up and managing these objects.

Definition at line 672 of file qquickrhiitem.cpp.

◆ setColorBufferFormat()

void QQuickRhiItem::setColorBufferFormat ( TextureFormat format )

Definition at line 622 of file qquickrhiitem.cpp.

◆ setFixedColorBufferHeight()

void QQuickRhiItem::setFixedColorBufferHeight ( int height )

Definition at line 771 of file qquickrhiitem.cpp.

◆ setFixedColorBufferWidth()

void QQuickRhiItem::setFixedColorBufferWidth ( int width )

Definition at line 735 of file qquickrhiitem.cpp.

◆ setMirrorVertically()

void QQuickRhiItem::setMirrorVertically ( bool enable )

Definition at line 699 of file qquickrhiitem.cpp.

◆ setSampleCount()

void QQuickRhiItem::setSampleCount ( int samples )

Definition at line 585 of file qquickrhiitem.cpp.

◆ textureProvider()

QSGTextureProvider * QQuickRhiItem::textureProvider ( ) const

overridevirtual

\reimp

Reimplemented from QQuickItem.

Definition at line 532 of file qquickrhiitem.cpp.

◆ updatePaintNode()

QSGNode * QQuickRhiItem::updatePaintNode	(	QSGNode *	oldNode,
		UpdatePaintNodeData *	)

overrideprotectedvirtual

Reimplemented from QQuickItem.

Definition at line 430 of file qquickrhiitem.cpp.

Friends And Related Symbol Documentation

◆ QQuickRhiItemNode

friend class QQuickRhiItemNode

friend

Definition at line 119 of file qquickrhiitem.h.

Property Documentation

◆ alphaBlending

bool QQuickRhiItem::alphaBlending

readwrite

Controls if blending is always enabled when drawing the quad textured with the content generated by the QQuickRhiItem and its renderer.

The default value is false. This is for performance reasons: if semi-transparency is not involved, because the QQuickRhiItemRenderer clears to an opaque color and never renders fragments with alpha smaller than 1, then there is no point in enabling blending.

If the QQuickRhiItemRenderer subclass renders with semi-transparency involved, set this property to true.

Note: Under certain conditions blending is still going to happen regardless of the value of this property. For example, if the item's \l{QQuickItem::opacity}{opacity} (more precisely, the combined opacity inherited from the parent chain) is smaller than 1, blending will be automatically enabled even when this property is set to false.; The Qt Quick scene graph relies on and expect pre-multiplied alpha. For example, if the intention is to clear the background in the renderer to an alpha value of 0.5, then make sure to multiply the red, green, and blue clear color values with 0.5 as well. Otherwise the blending results will be incorrect.

Definition at line 56 of file qquickrhiitem.h.

◆ colorBufferFormat

TextureFormat QQuickRhiItem::colorBufferFormat

readwrite

This property controls the texture format for the texture used as the color buffer.

The default value is TextureFormat::RGBA8. QQuickRhiItem supports rendering to a subset of the formats supported by \l QRhiTexture. Only formats that are reported as supported from \l QRhi::isTextureFormatSupported() should be specified, rendering will not be functional otherwise.

Note: Setting a new format when the item and its renderer are already initialized and have rendered implies that all QRhiGraphicsPipeline objects created by the renderer may become unusable, if the associated QRhiRenderPassDescriptor is now incompatible due to the different texture format. Similarly to changing \l sampleCount dynamically, this means that initialize() or render() implementations must then take care of releasing the existing pipelines and creating new ones.

Definition at line 54 of file qquickrhiitem.h.

◆ effectiveColorBufferSize

QSize QQuickRhiItem::effectiveColorBufferSize

read

This property exposes the size, in pixels, of the underlying color buffer (the QRhiTexture or QRhiRenderBuffer).

It is provided for use on the GUI (main) thread, in QML bindings or JavaScript.

Note: QQuickRhiItemRenderer implementations, operating on the scene graph render thread, should not use this property. Those should rather query the size from the \l{QQuickRhiItemRenderer::renderTarget()}{render target}.; The value becomes available asynchronously from the main thread's perspective in the sense that the value changes when rendering happens on the render thread. This means that this property is useful mainly in QML bindings. Application code must not assume that the value is up to date already when the QQuickRhiItem object is constructed.

This is a read-only property.

Definition at line 59 of file qquickrhiitem.h.

◆ fixedColorBufferHeight

int QQuickRhiItem::fixedColorBufferHeight

readwrite

The fixed height, in pixels, of the item's associated texture.

Relevant when a fixed texture size is desired that does not depend on the item's size. This size has no effect on the geometry of the item (its size and placement within the scene), which means the texture's content will appear stretched (scaled up) or scaled down onto the item's area.

For example, setting a size that is exactly twice the item's (pixel) size effectively performs 2x supersampling (rendering at twice the resolution and then implicitly scaling down when texturing the quad corresponding to the item in the scene).

By default the value is 0. A value of 0 means that texture's size follows the item's size. ({texture size} = {item size} * {device pixel ratio}).

Definition at line 58 of file qquickrhiitem.h.

◆ fixedColorBufferWidth

int QQuickRhiItem::fixedColorBufferWidth

readwrite

The fixed width, in pixels, of the item's associated texture or renderbuffer.

Relevant when a fixed color buffer size is desired that does not depend on the item's size. This size has no effect on the geometry of the item (its size and placement within the scene), which means the texture's content will appear stretched (scaled up) or scaled down onto the item's area.

For example, setting a size that is exactly twice the item's (pixel) size effectively performs 2x supersampling (rendering at twice the resolution and then implicitly scaling down when texturing the quad corresponding to the item in the scene).

By default the value is 0. A value of 0 means that texture's size follows the item's size. ({texture size} = {item size} * {device pixel ratio}).

Definition at line 57 of file qquickrhiitem.h.

◆ mirrorVertically

bool QQuickRhiItem::mirrorVertically

readwrite

This property controls if texture UVs are flipped when drawing the textured quad.

It has no effect on the contents of the offscreen color buffer and the rendering implemented by the QQuickRhiItemRenderer.

The default value is false.

Definition at line 55 of file qquickrhiitem.h.

◆ sampleCount

int QQuickRhiItem::sampleCount

readwrite

This property controls for sample count for multisample antialiasing.

By default the value is 1 which means MSAA is disabled.

Valid values are 1, 4, 8, and sometimes 16 and 32. \l QRhi::supportedSampleCounts() can be used to query the supported sample counts at run time, but typically applications should request 1 (no MSAA), 4x (normal MSAA) or 8x (high MSAA).

Note: Setting a new value implies that all QRhiGraphicsPipeline objects created by the renderer must use the same sample count from then on. Existing QRhiGraphicsPipeline objects created with a different sample count must not be used anymore. When the value changes, all color and depth-stencil buffers are destroyed and recreated automatically, and \l {QQuickRhiItemRenderer::}{initialize()} is invoked again. However, when isAutoRenderTargetEnabled() is false, it will be up to the application to manage this with regards to the depth-stencil buffer or additional color buffers.

Changing the sample count from the default 1 to a higher value implies that \l {QQuickRhiItemRenderer::}{colorTexture()} becomes \nullptr and \l {QQuickRhiItemRenderer::}{msaaColorBuffer()} starts returning a valid object. Switching back to 1 (or 0), implies the opposite: in the next call to initialize() msaaColorBuffer() is going to return \nullptr, whereas colorTexture() becomes once again valid. In addition, \l {QQuickRhiItemRenderer::}{resolveTexture()} returns a valid (non-multisample) QRhiTexture whenever the sample count is greater than 1 (i.e., MSAA is in use).

See also: QQuickRhiItemRenderer::msaaColorBuffer(), QQuickRhiItemRenderer::resolveTexture()

Definition at line 53 of file qquickrhiitem.h.

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

qtdeclarative/src/quick/items/qquickrhiitem.h (95f77de0d45c6fba3465acf7b632e41cf10ed60d)
qtdeclarative/src/quick/items/qquickrhiitem.cpp (f859f23d07109d79e260c717e5a04c0b2c5e0d68)

Public Types

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ TextureFormat

Constructor & Destructor Documentation

◆ QQuickRhiItem()

◆ ~QQuickRhiItem()

Member Function Documentation

◆ alphaBlending()

◆ alphaBlendingChanged

◆ autoRenderTargetChanged

◆ colorBufferFormat()

◆ colorBufferFormatChanged

◆ createRenderer()

◆ effectiveColorBufferSize()

◆ effectiveColorBufferSizeChanged

◆ event()

◆ fixedColorBufferHeight()

◆ fixedColorBufferHeightChanged

◆ fixedColorBufferWidth()

◆ fixedColorBufferWidthChanged

◆ geometryChange()

◆ isAutoRenderTargetEnabled()

◆ isMirrorVerticallyEnabled()

◆ isTextureProvider()

◆ mirrorVerticallyChanged

◆ releaseResources()

◆ sampleCount()

◆ sampleCountChanged

◆ setAlphaBlending()

◆ setAutoRenderTarget()

◆ setColorBufferFormat()

◆ setFixedColorBufferHeight()

◆ setFixedColorBufferWidth()

◆ setMirrorVertically()

◆ setSampleCount()

◆ textureProvider()

◆ updatePaintNode()

Friends And Related Symbol Documentation

◆ QQuickRhiItemNode

Property Documentation

◆ alphaBlending

◆ colorBufferFormat

◆ effectiveColorBufferSize

◆ fixedColorBufferHeight

◆ fixedColorBufferWidth

◆ mirrorVertically

◆ sampleCount