Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qquickshadereffectsource_p.h>
Public Member Functions | |
QQuickShaderEffectSource (QQuickItem *parent=nullptr) | |
\qmltype ShaderEffectSource \nativetype QQuickShaderEffectSource \inqmlmodule QtQuick | |
~QQuickShaderEffectSource () override | |
WrapMode | wrapMode () const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::wrapMode | |
void | setWrapMode (WrapMode mode) |
QQuickItem * | sourceItem () const |
\qmlproperty Item QtQuick::ShaderEffectSource::sourceItem | |
void | setSourceItem (QQuickItem *item) |
QRectF | sourceRect () const |
\qmlproperty rect QtQuick::ShaderEffectSource::sourceRect | |
void | setSourceRect (const QRectF &rect) |
QSize | textureSize () const |
\qmlproperty size QtQuick::ShaderEffectSource::textureSize | |
void | setTextureSize (const QSize &size) |
Format | format () const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::format | |
void | setFormat (Format format) |
bool | live () const |
\qmlproperty bool QtQuick::ShaderEffectSource::live | |
void | setLive (bool live) |
bool | hideSource () const |
\qmlproperty bool QtQuick::ShaderEffectSource::hideSource | |
void | setHideSource (bool hide) |
bool | mipmap () const |
\qmlproperty bool QtQuick::ShaderEffectSource::mipmap | |
void | setMipmap (bool enabled) |
bool | recursive () const |
\qmlproperty bool QtQuick::ShaderEffectSource::recursive | |
void | setRecursive (bool enabled) |
TextureMirroring | textureMirroring () const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::textureMirroring | |
void | setTextureMirroring (TextureMirroring mirroring) |
bool | isTextureProvider () const override |
Returns true if this item is a texture provider. | |
QSGTextureProvider * | textureProvider () const override |
Returns the texture provider for an item. | |
Q_INVOKABLE void | scheduleUpdate () |
\qmlmethod QtQuick::ShaderEffectSource::scheduleUpdate() | |
int | samples () const |
\qmlproperty int QtQuick::ShaderEffectSource::samples | |
void | setSamples (int count) |
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 () |
Public Member Functions inherited from QQuickItemChangeListener | |
virtual | ~QQuickItemChangeListener () |
virtual void | itemSiblingOrderChanged (QQuickItem *) |
virtual void | itemVisibilityChanged (QQuickItem *) |
virtual void | itemEnabledChanged (QQuickItem *) |
virtual void | itemOpacityChanged (QQuickItem *) |
virtual void | itemDestroyed (QQuickItem *) |
virtual void | itemChildAdded (QQuickItem *, QQuickItem *) |
virtual void | itemChildRemoved (QQuickItem *, QQuickItem *) |
virtual void | itemParentChanged (QQuickItem *, QQuickItem *) |
virtual void | itemRotationChanged (QQuickItem *) |
virtual void | itemImplicitWidthChanged (QQuickItem *) |
virtual void | itemImplicitHeightChanged (QQuickItem *) |
virtual void | itemFocusChanged (QQuickItem *, Qt::FocusReason) |
virtual void | itemScaleChanged (QQuickItem *) |
virtual void | itemTransformChanged (QQuickItem *) |
virtual QQuickAnchorsPrivate * | anchorPrivate () |
Protected Member Functions | |
void | releaseResources () override |
This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode(). | |
QSGNode * | updatePaintNode (QSGNode *, UpdatePaintNodeData *) override |
Called on the render thread when it is time to sync the state of the item with the scene graph. | |
void | itemGeometryChanged (QQuickItem *item, QQuickGeometryChange change, const QRectF &) override |
void | itemChange (ItemChange change, const ItemChangeData &value) override |
Called when change occurs for this item. | |
Protected Member Functions inherited from QQuickItem | |
bool | event (QEvent *) override |
\reimp | |
bool | isComponentComplete () const |
Returns true if construction of the QML component is complete; otherwise returns false. | |
virtual void | geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) |
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 | |
WrapMode | wrapMode |
QQuickItem * | sourceItem |
QRectF | sourceRect |
QSize | textureSize |
Format | format |
bool | live |
bool | hideSource |
bool | mipmap |
bool | recursive |
TextureMirroring | textureMirroring |
int | samples |
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 | |
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) | |
Definition at line 42 of file qquickshadereffectsource_p.h.
Enumerator | |
---|---|
RGBA8 | |
RGBA16F | |
RGBA32F | |
Alpha | |
RGB | |
RGBA |
Definition at line 68 of file qquickshadereffectsource_p.h.
Enumerator | |
---|---|
NoMirroring | |
MirrorHorizontally | |
MirrorVertically |
Definition at line 80 of file qquickshadereffectsource_p.h.
Enumerator | |
---|---|
ClampToEdge | |
RepeatHorizontally | |
RepeatVertically | |
Repeat |
Definition at line 60 of file qquickshadereffectsource_p.h.
QQuickShaderEffectSource::QQuickShaderEffectSource | ( | QQuickItem * | parent = nullptr | ) |
\qmltype ShaderEffectSource \nativetype QQuickShaderEffectSource \inqmlmodule QtQuick
Renders a \l {Qt Quick} item into a texture and displays it.
The ShaderEffectSource type renders \l sourceItem into a texture and displays it in the scene. \l sourceItem is drawn into the texture as though it was a fully opaque root item. Thus \l sourceItem itself can be invisible, but still appear in the texture.
You can use the ShaderEffectSource as: \list
\table \row
Rectangle { width: 200 height: 100 gradient: Gradient { GradientStop { position: 0; color: "white" } GradientStop { position: 1; color: "black" } } Row { opacity: 0.5 Item { id: foo width: 100; height: 100 Rectangle { x: 5; y: 5; width: 60; height: 60; color: "red" } Rectangle { x: 20; y: 20; width: 60; height: 60; color: "orange" } Rectangle { x: 35; y: 35; width: 60; height: 60; color: "yellow" } } ShaderEffectSource { width: 100; height: 100 sourceItem: foo } } } \endqml \endtable
The ShaderEffectSource type does not redirect any mouse or keyboard input to \l sourceItem. If you hide the \l sourceItem by setting \l{Item::visible}{visible} to false or \l{Item::opacity}{opacity} to zero, it will no longer react to input. In cases where the ShaderEffectSource is meant to replace the \l sourceItem, you typically want to hide the \l sourceItem while still handling input. For this, you can use the \l hideSource property.
shadereffectsource and multieffect
{smooth:
true} (this is the default value of smooth). This will be equivalent to 4x multisampling, at the cost of lower performance and higher memory use.Definition at line 146 of file qquickshadereffectsource.cpp.
|
override |
Definition at line 165 of file qquickshadereffectsource.cpp.
QQuickShaderEffectSource::Format QQuickShaderEffectSource::format | ( | ) | const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::format
This property defines the format of the backing texture. Modifying this property makes most sense when the item is used as a source texture of a \l ShaderEffect.
\value ShaderEffectSource.RGBA8 \value ShaderEffectSource.RGBA16F \value ShaderEffectSource.RGBA32F \value ShaderEffectSource.Alpha Starting with Qt 6.0, this value is not in use and has the same effect as RGBA8
in practice. \value ShaderEffectSource.RGB Starting with Qt 6.0, this value is not in use and has the same effect as RGBA8
in practice. \value ShaderEffectSource.RGBA Starting with Qt 6.0, this value is not in use and has the same effect as RGBA8
in practice.
Definition at line 396 of file qquickshadereffectsource.cpp.
|
signal |
bool QQuickShaderEffectSource::hideSource | ( | ) | const |
\qmlproperty bool QtQuick::ShaderEffectSource::hideSource
If this property is true, the \l sourceItem is hidden, though it will still be rendered into the texture. As opposed to hiding the \l sourceItem by setting \l{Item::visible}{visible} to false, setting this property to true will not prevent mouse or keyboard input from reaching \l sourceItem. The property is useful when the ShaderEffectSource is anchored on top of, and meant to replace the \l sourceItem.
Definition at line 443 of file qquickshadereffectsource.cpp.
|
signal |
|
inlineoverridevirtual |
Returns true if this item is a texture provider.
The default implementation returns false.
This function can be called from any thread.
Reimplemented from QQuickItem.
Definition at line 120 of file qquickshadereffectsource_p.h.
|
overrideprotectedvirtual |
Called when change occurs for this item.
value contains extra information relating to the change, when applicable.
If you re-implement this method in a subclass, be sure to call
typically at the end of your implementation, to ensure the \l windowChanged() signal will be emitted.
Reimplemented from QQuickItem.
Definition at line 755 of file qquickshadereffectsource.cpp.
|
overrideprotectedvirtual |
Reimplemented from QQuickItemChangeListener.
Definition at line 272 of file qquickshadereffectsource.cpp.
bool QQuickShaderEffectSource::live | ( | ) | const |
\qmlproperty bool QtQuick::ShaderEffectSource::live
If this property is true, the texture is updated whenever the \l sourceItem updates. Otherwise, it will be a frozen image, even if \l sourceItem is assigned a new item. The property is true by default.
Definition at line 418 of file qquickshadereffectsource.cpp.
|
signal |
bool QQuickShaderEffectSource::mipmap | ( | ) | const |
\qmlproperty bool QtQuick::ShaderEffectSource::mipmap
If this property is true, mipmaps are generated for the texture.
Definition at line 470 of file qquickshadereffectsource.cpp.
|
signal |
bool QQuickShaderEffectSource::recursive | ( | ) | const |
\qmlproperty bool QtQuick::ShaderEffectSource::recursive
Set this property to true if the ShaderEffectSource has a dependency on itself. ShaderEffectSources form a dependency chain, where one ShaderEffectSource can be part of the \l sourceItem of another. If there is a loop in this chain, a ShaderEffectSource could end up trying to render into the same texture it is using as source, which is not allowed by OpenGL. When this property is set to true, an extra texture is allocated so that ShaderEffectSource can keep a copy of the texture from the previous frame. It can then render into one texture and use the texture from the previous frame as source.
Setting both this property and \l live to true will cause the scene graph to render continuously. Since the ShaderEffectSource depends on itself, updating it means that it immediately becomes dirty again.
Definition at line 502 of file qquickshadereffectsource.cpp.
|
signal |
|
overrideprotectedvirtual |
This function is called when an item should release graphics resources which are not already managed by the nodes returned from QQuickItem::updatePaintNode().
This happens when the item is about to be removed from the window it was previously rendering to. The item is guaranteed to have a \l {QQuickItem::window()}{window} when the function is called.
The function is called on the GUI thread and the state of the rendering thread, when it is used, is unknown. Objects should not be deleted directly, but instead scheduled for cleanup using QQuickWindow::scheduleRenderJob().
Reimplemented from QQuickItem.
Definition at line 619 of file qquickshadereffectsource.cpp.
int QQuickShaderEffectSource::samples | ( | ) | const |
\qmlproperty int QtQuick::ShaderEffectSource::samples
This property allows requesting multisampled rendering.
By default multisampling is enabled whenever multisampling is enabled for the entire window, assuming the scenegraph renderer in use and the underlying graphics API supports this.
By setting the value to 2, 4, etc. multisampled rendering can be requested for a part of the scene without enabling multisampling for the entire scene. This way multisampling is applied only to a given subtree, which can lead to significant performance gains since multisampling is not applied to other parts of the scene.
Definition at line 568 of file qquickshadereffectsource.cpp.
|
signal |
|
signal |
void QQuickShaderEffectSource::scheduleUpdate | ( | ) |
\qmlmethod QtQuick::ShaderEffectSource::scheduleUpdate()
Schedules a re-rendering of the texture for the next frame. Use this to update the texture when \l live is false.
Definition at line 589 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setFormat | ( | QQuickShaderEffectSource::Format | format | ) |
Definition at line 401 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setHideSource | ( | bool | hide | ) |
Definition at line 448 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setLive | ( | bool | live | ) |
Definition at line 423 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setMipmap | ( | bool | enabled | ) |
Definition at line 475 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setRecursive | ( | bool | enabled | ) |
Definition at line 507 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setSamples | ( | int | count | ) |
Definition at line 573 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setSourceItem | ( | QQuickItem * | item | ) |
Definition at line 280 of file qquickshadereffectsource.cpp.
Definition at line 344 of file qquickshadereffectsource.cpp.
void QQuickShaderEffectSource::setTextureMirroring | ( | TextureMirroring | mirroring | ) |
Definition at line 535 of file qquickshadereffectsource.cpp.
Definition at line 372 of file qquickshadereffectsource.cpp.
Definition at line 250 of file qquickshadereffectsource.cpp.
QQuickItem * QQuickShaderEffectSource::sourceItem | ( | ) | const |
\qmlproperty Item QtQuick::ShaderEffectSource::sourceItem
This property holds the item to be rendered into the texture. Setting this to null while \l live is true, will release the texture resources.
Definition at line 267 of file qquickshadereffectsource.cpp.
|
signal |
QRectF QQuickShaderEffectSource::sourceRect | ( | ) | const |
\qmlproperty rect QtQuick::ShaderEffectSource::sourceRect
This property defines which rectangular area of the \l sourceItem to render into the texture. The source rectangle can be larger than \l sourceItem itself. If the rectangle is null, which is the default, the whole \l sourceItem is rendered to texture.
Definition at line 339 of file qquickshadereffectsource.cpp.
|
signal |
QQuickShaderEffectSource::TextureMirroring QQuickShaderEffectSource::textureMirroring | ( | ) | const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::textureMirroring
This property defines how the generated OpenGL texture should be mirrored. The default value is {ShaderEffectSource.MirrorVertically}. Custom mirroring can be useful if the generated texture is directly accessed by custom shaders, such as those specified by ShaderEffect. Mirroring has no effect on the UI representation of the ShaderEffectSource item itself.
\value ShaderEffectSource.NoMirroring No mirroring \value ShaderEffectSource.MirrorHorizontally The generated texture is flipped along X-axis. \value ShaderEffectSource.MirrorVertically The generated texture is flipped along Y-axis.
Definition at line 530 of file qquickshadereffectsource.cpp.
|
signal |
|
overridevirtual |
Returns the texture provider for an item.
The default implementation returns \nullptr.
This function may only be called on the rendering thread.
Reimplemented from QQuickItem.
Definition at line 206 of file qquickshadereffectsource.cpp.
QSize QQuickShaderEffectSource::textureSize | ( | ) | const |
\qmlproperty size QtQuick::ShaderEffectSource::textureSize
This property holds the requested pixel size of the texture. If it is empty, which is the default, the size of the source rectangle is used.
Definition at line 367 of file qquickshadereffectsource.cpp.
|
signal |
|
overrideprotectedvirtual |
Called on the render thread when it is time to sync the state of the item with the scene graph.
The function is called as a result of QQuickItem::update(), if the user has set the QQuickItem::ItemHasContents flag on the item.
The function should return the root of the scene graph subtree for this item. Most implementations will return a single QSGGeometryNode containing the visual representation of this item. oldNode is the node that was returned the last time the function was called. updatePaintNodeData provides a pointer to the QSGTransformNode associated with this QQuickItem.
The main thread is blocked while this function is executed so it is safe to read values from the QQuickItem instance and other objects in the main thread.
If no call to QQuickItem::updatePaintNode() result in actual scene graph changes, like QSGNode::markDirty() or adding and removing nodes, then the underlying implementation may decide to not render the scene again as the visual outcome is identical.
Reimplemented from QQuickItem.
Definition at line 656 of file qquickshadereffectsource.cpp.
QQuickShaderEffectSource::WrapMode QQuickShaderEffectSource::wrapMode | ( | ) | const |
\qmlproperty enumeration QtQuick::ShaderEffectSource::wrapMode
This property defines the OpenGL wrap modes associated with the texture. Modifying this property makes most sense when the item is used as a source texture of a \l ShaderEffect.
The default value is {ShaderEffectSource.ClampToEdge}.
\value ShaderEffectSource.ClampToEdge GL_CLAMP_TO_EDGE both horizontally and vertically \value ShaderEffectSource.RepeatHorizontally GL_REPEAT horizontally, GL_CLAMP_TO_EDGE vertically \value ShaderEffectSource.RepeatVertically GL_CLAMP_TO_EDGE horizontally, GL_REPEAT vertically \value ShaderEffectSource.Repeat GL_REPEAT both horizontally and vertically
Definition at line 245 of file qquickshadereffectsource.cpp.
|
signal |
|
readwrite |
Definition at line 49 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 51 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 50 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 52 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 53 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 55 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 46 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 47 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 54 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 48 of file qquickshadereffectsource_p.h.
|
readwrite |
Definition at line 45 of file qquickshadereffectsource_p.h.