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
QQuick3DRenderOutputProvider Class Reference

#include <qquick3drenderoutputprovider_p.h>

Inheritance diagram for QQuick3DRenderOutputProvider:
Collaboration diagram for QQuick3DRenderOutputProvider:

Public Types

enum class  TextureSource : quint32 {
  None = 0 , UserPassTexture = 1 , AoTexture , DepthTexture ,
  ScreenTexture , NormalTexture , MotionVectorTexture
}
enum class  AttachmentSelector : quint32 { Attachment0 = 0 , Attachment1 = 1 , Attachment2 = 2 , Attachment3 = 3 }
Public Types inherited from QQuick3DTextureProviderExtension
enum class  SamplerHint {
  Sampler2D , Sampler2DArray , Sampler3D , SamplerCube ,
  SamplerCubeArray , SamplerBuffer
}

Signals

void textureSourceChanged ()
void renderPassChanged ()
void attachmentSelectorChanged ()
Signals inherited from QQuick3DTextureProviderExtension
void samplerHintChanged ()
Signals inherited from QQuick3DObject
void parentChanged ()
void childrenChanged ()
void stateChanged ()
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

 QQuick3DRenderOutputProvider (QQuick3DObject *parent=nullptr)
TextureSource textureSource () const
 \qmlproperty RenderOutputProvider::TextureSource textureSource This property holds which pass buffer texture to use.
void setTextureSource (TextureSource newTextureSource)
QQuick3DRenderPass * renderPass () const
 \qmlproperty RenderPass renderPass This property holds the user defined render pass to use when accessing a user defined pass texture.
void setRenderPass (QQuick3DRenderPass *newRenderPass)
AttachmentSelector attachmentSelector () const
 \qmlproperty RenderOutputProvider::AttachmentSelector attachmentSelector This property holds which attachment to use when accessing a user defined pass texture.
void setAttachmentSelector (AttachmentSelector newAttachmentSelector)
Public Member Functions inherited from QQuick3DTextureProviderExtension
 QQuick3DTextureProviderExtension (QQuick3DObject *parent=nullptr)
 ~QQuick3DTextureProviderExtension () override
SamplerHint samplerHint () const
void setSamplerHint (SamplerHint newSamplerHint)
Public Member Functions inherited from QQuick3DRenderExtension
 QQuick3DRenderExtension (QQuick3DObject *parent=nullptr)
virtual ~QQuick3DRenderExtension ()
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 isQmlObjectType () const
 Returns whether the object has been created by the QML engine or ownership has been explicitly set via QJSEngine::setObjectOwnership().
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

QSSGRenderGraphObject * updateSpatialNode (QSSGRenderGraphObject *node) override
 This function is called during the synchronization of the QtQuick3D scene graph when an item is created or when an update is requested, usually as a result of a change in the item's properties.
void markAllDirty () override
Protected Member Functions inherited from QQuick3DTextureProviderExtension
bool event (QEvent *event) override
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
QSSGRenderGraphObject * updateSpatialNode (QSSGRenderGraphObject *node) override
 This function is called during the synchronization of the QtQuick3D scene graph when an item is created or when an update is requested, usually as a result of a change in the item's properties.
Protected Member Functions inherited from QQuick3DRenderExtension
 QQuick3DRenderExtension (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
 \qmltype RenderExtension \nativetype QQuick3DRenderExtension \inqmlmodule QtQuick3D \inherits Object3D
Protected Member Functions inherited from QQuick3DObject
virtual void itemChange (ItemChange, const ItemChangeData &)
 QQuick3DObject (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
void classBegin () override
 Invoked after class creation, but before any properties have been set.
void componentComplete () override
 Invoked after the root component that caused this instantiation has completed construction.
bool isComponentComplete () const
virtual void preSync ()
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

TextureSource textureSource
QQuick3DRenderPass * renderPass
AttachmentSelector attachmentSelector
Properties inherited from QQuick3DTextureProviderExtension
SamplerHint samplerHint
 \qmltype TextureProviderExtension \nativetype QQuick3DTextureProviderExtension \inqmlmodule QtQuick3D \inherits RenderExtension
Properties inherited from QQuick3DObject
QQuick3DObject * parent
 \qmlproperty Object3D QtQuick3D::Object3D::parent This property holds the parent of the Object3D in a 3D scene.
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectData > d_ptr
Related Symbols inherited from QObject
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 28 of file qquick3drenderoutputprovider_p.h.

Member Enumeration Documentation

◆ AttachmentSelector

enum class QQuick3DRenderOutputProvider::AttachmentSelector : quint32
strong
Enumerator
Attachment0 
Attachment1 
Attachment2 
Attachment3 

Definition at line 49 of file qquick3drenderoutputprovider_p.h.

◆ TextureSource

enum class QQuick3DRenderOutputProvider::TextureSource : quint32
strong
Enumerator
None 
UserPassTexture 
AoTexture 
DepthTexture 
ScreenTexture 
NormalTexture 
MotionVectorTexture 

Definition at line 37 of file qquick3drenderoutputprovider_p.h.

Constructor & Destructor Documentation

◆ QQuick3DRenderOutputProvider()

QQuick3DRenderOutputProvider::QQuick3DRenderOutputProvider ( QQuick3DObject * parent = nullptr)
explicit 
\qmltype RenderOutputProvider
\nativetype QQuick3DRenderOutputProvider
\inqmlmodule QtQuick3D.Helpers
\inherits TextureProviderExtension
\since 6.11
\brief Used as a bridge to access textures provided in passes.

This type is used to provide textures that are generated by passes in the rendering pipeline.

Some example of when this is useful is when you want to access the depth texture generated by the ZPrePass,
or the ambient occlusion texture generated by the SSAO pass. This type can be used to access these generated
textures and use them in materials or effects.

\qml
Texture {
    textureProvider: RenderOutputProvider {

Specify the pass buffer texture you want to access textureSource: RenderOutputProvider.DepthTexture } } \endqml

See also
QQuick3DTextureProviderExtension, QSSGRenderExtension

Definition at line 167 of file qquick3drenderoutputprovider.cpp.

Member Function Documentation

◆ attachmentSelector()

QQuick3DRenderOutputProvider::AttachmentSelector QQuick3DRenderOutputProvider::attachmentSelector ( ) const

\qmlproperty RenderOutputProvider::AttachmentSelector attachmentSelector This property holds which attachment to use when accessing a user defined pass texture.

There are multiple attachments possible when using a user defined render pass, starting from \value RenderOutputProvider.Attachment0 up to \value RenderOutputProvider.Attachment3.

Definition at line 308 of file qquick3drenderoutputprovider.cpp.

◆ attachmentSelectorChanged

void QQuick3DRenderOutputProvider::attachmentSelectorChanged ( )
signal

◆ markAllDirty()

void QQuick3DRenderOutputProvider::markAllDirty ( )
overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 229 of file qquick3drenderoutputprovider.cpp.

◆ renderPass()

QQuick3DRenderPass * QQuick3DRenderOutputProvider::renderPass ( ) const

\qmlproperty RenderPass renderPass This property holds the user defined render pass to use when accessing a user defined pass texture.

When this property is set, the \l textureSource property is automatically set to \value RenderOutputProvider.UserPassTexture.

See also
textureSource, RenderPass

Definition at line 279 of file qquick3drenderoutputprovider.cpp.

◆ renderPassChanged

void QQuick3DRenderOutputProvider::renderPassChanged ( )
signal

◆ setAttachmentSelector()

void QQuick3DRenderOutputProvider::setAttachmentSelector ( AttachmentSelector newAttachmentSelector)

Definition at line 313 of file qquick3drenderoutputprovider.cpp.

◆ setRenderPass()

void QQuick3DRenderOutputProvider::setRenderPass ( QQuick3DRenderPass * newRenderPass)

Definition at line 284 of file qquick3drenderoutputprovider.cpp.

◆ setTextureSource()

void QQuick3DRenderOutputProvider::setTextureSource ( TextureSource newTextureSource)

Definition at line 261 of file qquick3drenderoutputprovider.cpp.

◆ textureSource()

QQuick3DRenderOutputProvider::TextureSource QQuick3DRenderOutputProvider::textureSource ( ) const

\qmlproperty RenderOutputProvider::TextureSource textureSource This property holds which pass buffer texture to use.

\value RenderOutputProvider.None No texture source is selected. \value RenderOutputProvider.UserPassTexture A user defined pass. If this is used to access a user defined pass. \value RenderOutputProvider.AoTexture The ambient occlusion texture created by QtQuick3D's AO pass. \value RenderOutputProvider.DepthTexture The depth texture created by QtQuick3D's Depth map pass. \value RenderOutputProvider.ScreenTexture The texture containing the rendered scene. \value RenderOutputProvider.NormalTexture The normal texture created by QtQuick3D's Normal map pass. \value RenderOutputProvider.MotionVectorTexture The motion vector texture created by QtQuick3D's Motion Vector pass.

Definition at line 256 of file qquick3drenderoutputprovider.cpp.

◆ textureSourceChanged

void QQuick3DRenderOutputProvider::textureSourceChanged ( )
signal

◆ updateSpatialNode()

QSSGRenderGraphObject * QQuick3DRenderOutputProvider::updateSpatialNode ( QSSGRenderGraphObject * node)
overrideprotectedvirtual

This function is called during the synchronization of the QtQuick3D scene graph when an item is created or when an update is requested, usually as a result of a change in the item's properties.

The function should return a QSSGRenderExtension instance that contains the code that should be run during QtQuick3D's rendering pipeline execution.

The node parameter is the previous QSSGRenderExtension instance that was returned from this function, or null if this is the first time the function is called. The function can return the same instance, a different instance, or null. If the function returns null, the extension will be removed from the rendering pipeline.

Note
The QSSGRenderExtension instance is a resource object and will be owned by the QtQuick3D scene graph. If a different instance, or null, is returned, the previous instance will be queued for deletion by the renderer.
See also
QSSGRenderExtension

Reimplemented from QQuick3DRenderExtension.

Definition at line 173 of file qquick3drenderoutputprovider.cpp.

Property Documentation

◆ attachmentSelector

AttachmentSelector QQuick3DRenderOutputProvider::attachmentSelector
readwrite

Definition at line 33 of file qquick3drenderoutputprovider_p.h.

◆ renderPass

QQuick3DRenderPass * QQuick3DRenderOutputProvider::renderPass
readwrite

Definition at line 32 of file qquick3drenderoutputprovider_p.h.

◆ textureSource

TextureSource QQuick3DRenderOutputProvider::textureSource
readwrite

Definition at line 31 of file qquick3drenderoutputprovider_p.h.

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