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

#include <qquick3drenderpass_p.h>

Inheritance diagram for QQuick3DRenderPass:
Collaboration diagram for QQuick3DRenderPass:

Public Types

enum  MaterialModes { OriginalMaterial , AugmentMaterial , OverrideMaterial }
enum  PassMode { UserPass , SkyboxPass , Item2DPass }
enum class  RenderTargetFlag { None = 0 , PreserveColorContents = 1 << 0 , PreserveDepthStencilContents = 1 << 1 , DoNotStoreDepthStencilContents = 1 << 2 }
Public Types inherited from QQuick3DPropertyChangedTracker
enum class  DirtyPropertyHint { Value , Reference }
using UniformProperty = QSSGUserShaderAugmentation::Property
using UniformPropertyList = QVector<UniformProperty>

Signals

void outputChanged ()
void materialModeChanged ()
void clearColorChanged ()
void overrideMaterialChanged ()
void augmentShaderChanged ()
void passModeChanged ()
void depthClearValueChanged ()
void stencilClearValueChanged ()
void renderTargetFlagsChanged ()
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

 QQuick3DRenderPass (QQuick3DObject *parent=nullptr)
 \qmltype RenderPass \inherits Object3D \inqmlmodule QtQuick3D
QQmlListProperty< QQuick3DShaderUtilsRenderCommandcommands ()
QColor clearColor () const
 \qmlproperty color RenderPass::clearColor This property holds the clear color for the render pass.
void setClearColor (const QColor &newClearColor)
MaterialModes materialMode () const
 \qmlproperty RenderPass::MaterialModes RenderPass::materialMode This property holds the material mode for the render pass.
void setMaterialMode (MaterialModes newMaterialMode)
QQuick3DMaterialoverrideMaterial () const
 \qmlproperty Material RenderPass::overrideMaterial This property holds the override material for the render pass when \l{RenderPass::materialMode}{materialMode} is set to OverrideMaterial.
void setOverrideMaterial (QQuick3DMaterial *newOverrideMaterial)
QUrl augmentShader () const
void setAugmentShader (const QUrl &newAugmentShader)
PassMode passMode () const
 \qmlproperty RenderPass::PassMode RenderPass::passMode This property holds the pass mode for the render pass.
void setPassMode (PassMode newPassMode)
float depthClearValue () const
 \qmlproperty real RenderPass::depthClearValue This property holds the depth clear value for the render pass.
void setDepthClearValue (float newDepthClearValue)
quint32 stencilClearValue () const
 \qmlproperty int RenderPass::stencilClearValue This property holds the stencil clear value for the render pass.
void setStencilClearValue (quint32 newStencilClearValue)
void markAllDirty () override
RenderTargetFlags renderTargetFlags () const
 \qmlproperty RenderPass::RenderTargetFlags RenderPass::renderTargetFlags This property holds the render target flags for the render pass.
void setRenderTargetFlags (RenderTargetFlags newRenderTargetFlags)
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 event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
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< QStringbindableObjectName ()
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).
QThreadthread () 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>
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>
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 QObjectListchildren () 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< QByteArraydynamicPropertyNames () const
QBindingStoragebindingStorage ()
const QBindingStoragebindingStorage () const
QObjectparent () 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 QQuick3DPropertyChangedTracker
template<typename T>
 QQuick3DPropertyChangedTracker (QQuick3DObject *owner, QQuick3DSuperClassInfo< T > info)
virtual ~QQuick3DPropertyChangedTracker ()

Protected Member Functions

QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
void itemChange (QQuick3DObject::ItemChange, const QQuick3DObject::ItemChangeData &) override
void markTrackedPropertyDirty (QMetaProperty property, QQuick3DPropertyChangedTracker::DirtyPropertyHint hint) override
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
QObjectsender () 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)
Protected Member Functions inherited from QQuick3DPropertyChangedTracker
void extractProperties (UniformPropertyList &outUniforms)
void addPropertyWatcher (QMetaProperty property, DirtyPropertyHint hint, QQuick3DObject *object=nullptr)

Properties

QQmlListProperty< QQuick3DShaderUtilsRenderCommandcommands
 \qmlproperty list<RenderCommand> RenderPass::commands This property holds the list of render commands for the render pass.
MaterialModes materialMode
QColor clearColor
float depthClearValue
quint32 stencilClearValue
QQuick3DMaterialoverrideMaterial
QUrl augmentShader
PassMode passMode
RenderTargetFlags renderTargetFlags
Properties inherited from QQuick3DObject
QQuick3DObjectparent
 \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 Types inherited from QQuick3DPropertyChangedTracker
using TrackedProperties = std::vector<Tracked>
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Protected Attributes inherited from QQuick3DPropertyChangedTracker
TrackedProperties m_trackedProperties
QQuick3DObjectm_owner = nullptr
const char * m_superClassName = nullptr

Detailed Description

Definition at line 26 of file qquick3drenderpass_p.h.

Member Enumeration Documentation

◆ MaterialModes

Enumerator
OriginalMaterial 
AugmentMaterial 
OverrideMaterial 

Definition at line 41 of file qquick3drenderpass_p.h.

◆ PassMode

Enumerator
UserPass 
SkyboxPass 
Item2DPass 

Definition at line 48 of file qquick3drenderpass_p.h.

◆ RenderTargetFlag

Enumerator
None 
PreserveColorContents 
PreserveDepthStencilContents 
DoNotStoreDepthStencilContents 

Definition at line 55 of file qquick3drenderpass_p.h.

Constructor & Destructor Documentation

◆ QQuick3DRenderPass()

QT_BEGIN_NAMESPACE QQuick3DRenderPass::QQuick3DRenderPass ( QQuick3DObject * parent = nullptr)
explicit

\qmltype RenderPass \inherits Object3D \inqmlmodule QtQuick3D

The RenderPass type defines a custom render pass for rendering 3D content.

Since
6.11

A RenderPass allows you to define a custom rendering step in the rendering pipeline. You can specify various properties such as clear color, material mode, and override materials. Additionally, you can define a list of render commands that dictate how the rendering should be performed.

Definition at line 35 of file qquick3drenderpass.cpp.

Member Function Documentation

◆ augmentShader()

QUrl QQuick3DRenderPass::augmentShader ( ) const
\qmlproperty url RenderPass::augmentShader
This property holds the augment shader URL for the render pass when
\l{RenderPass::materialMode}{materialMode} is set to \c AugmentMaterial.

The shader file should contain a function with the following signature:
\badcode
void MAIN_FRAGMENT_AUGMENT() {

Custom shader code here }

This function will be combined with the existing fragment shader of the material being used by the object being rendered in this render pass. Allowing users to augment the existing material shader with custom code.

Definition at line 435 of file qquick3drenderpass.cpp.

◆ augmentShaderChanged

void QQuick3DRenderPass::augmentShaderChanged ( )
signal

◆ clearColor()

QColor QQuick3DRenderPass::clearColor ( ) const

\qmlproperty color RenderPass::clearColor This property holds the clear color for the render pass.

\default Qt.black

Definition at line 334 of file qquick3drenderpass.cpp.

◆ clearColorChanged

void QQuick3DRenderPass::clearColorChanged ( )
signal

◆ commands()

QQmlListProperty< QQuick3DShaderUtilsRenderCommand > QQuick3DRenderPass::commands ( )

◆ depthClearValue()

float QQuick3DRenderPass::depthClearValue ( ) const

\qmlproperty real RenderPass::depthClearValue This property holds the depth clear value for the render pass.

\default 1.0

Definition at line 483 of file qquick3drenderpass.cpp.

◆ depthClearValueChanged

void QQuick3DRenderPass::depthClearValueChanged ( )
signal

◆ itemChange()

void QQuick3DRenderPass::itemChange ( QQuick3DObject::ItemChange ,
const QQuick3DObject::ItemChangeData &  )
overrideprotected

Definition at line 202 of file qquick3drenderpass.cpp.

◆ markAllDirty()

void QQuick3DRenderPass::markAllDirty ( )
inlineoverridevirtual

Reimplemented from QQuick3DObject.

Definition at line 89 of file qquick3drenderpass_p.h.

◆ markTrackedPropertyDirty()

void QQuick3DRenderPass::markTrackedPropertyDirty ( QMetaProperty property,
QQuick3DPropertyChangedTracker::DirtyPropertyHint hint )
overrideprotectedvirtual

Implements QQuick3DPropertyChangedTracker.

Definition at line 208 of file qquick3drenderpass.cpp.

◆ materialMode()

QQuick3DRenderPass::MaterialModes QQuick3DRenderPass::materialMode ( ) const

\qmlproperty RenderPass::MaterialModes RenderPass::materialMode This property holds the material mode for the render pass.

\value RenderPass.OriginalMaterial Use the original material of the object. \value RenderPass.AugmentMaterial Augment the original material with custom shader code. \value RenderPass.OverrideMaterial Override the original material with a user specified \l{RenderPass::overrideMaterial}{material}.

\default RenderPass.OriginalMaterial

Definition at line 358 of file qquick3drenderpass.cpp.

◆ materialModeChanged

void QQuick3DRenderPass::materialModeChanged ( )
signal

◆ outputChanged

void QQuick3DRenderPass::outputChanged ( )
signal

◆ overrideMaterial()

QQuick3DMaterial * QQuick3DRenderPass::overrideMaterial ( ) const

\qmlproperty Material RenderPass::overrideMaterial This property holds the override material for the render pass when \l{RenderPass::materialMode}{materialMode} is set to OverrideMaterial.

Definition at line 377 of file qquick3drenderpass.cpp.

◆ overrideMaterialChanged

void QQuick3DRenderPass::overrideMaterialChanged ( )
signal

◆ passMode()

QQuick3DRenderPass::PassMode QQuick3DRenderPass::passMode ( ) const

\qmlproperty RenderPass::PassMode RenderPass::passMode This property holds the pass mode for the render pass.

In addition to standard user render passes, Qt Quick 3D supports users to manually triggering internal render passes for rendering the skybox and 2D items.

\value RenderPass.UserPass A user specified render pass. \value RenderPass.SkyboxPass Qt Quick 3D's built-in skybox render pass. \value RenderPass.Item2DPass Qt Quick 3D's built-in 2D item render pass. \default RenderPass.UserPass

Definition at line 463 of file qquick3drenderpass.cpp.

◆ passModeChanged

void QQuick3DRenderPass::passModeChanged ( )
signal

◆ renderTargetFlags()

QQuick3DRenderPass::RenderTargetFlags QQuick3DRenderPass::renderTargetFlags ( ) const

\qmlproperty RenderPass::RenderTargetFlags RenderPass::renderTargetFlags This property holds the render target flags for the render pass.

\default RenderPass.RenderTargetFlags.None

Possible values are: \value RenderPass.RenderTargetFlags.None No special behavior. \value RenderPass.RenderTargetFlags.PreserveColorContents Preserve the color contents of the render target between frames. \value RenderPass.RenderTargetFlags.PreserveDepthStencilContents Preserve the depth and stencil contents of the render target between frames. \value RenderPass.RenderTargetFlags.DoNotStoreDepthStencilContents Do not store the depth and stencil contents of the render target after rendering.

See also
QRhiTextureRenderTarget::Flags

Definition at line 532 of file qquick3drenderpass.cpp.

◆ renderTargetFlagsChanged

void QQuick3DRenderPass::renderTargetFlagsChanged ( )
signal

◆ setAugmentShader()

void QQuick3DRenderPass::setAugmentShader ( const QUrl & newAugmentShader)

Definition at line 440 of file qquick3drenderpass.cpp.

◆ setClearColor()

void QQuick3DRenderPass::setClearColor ( const QColor & newClearColor)

Definition at line 339 of file qquick3drenderpass.cpp.

◆ setDepthClearValue()

void QQuick3DRenderPass::setDepthClearValue ( float newDepthClearValue)

Definition at line 488 of file qquick3drenderpass.cpp.

◆ setMaterialMode()

void QQuick3DRenderPass::setMaterialMode ( MaterialModes newMaterialMode)

Definition at line 363 of file qquick3drenderpass.cpp.

◆ setOverrideMaterial()

void QQuick3DRenderPass::setOverrideMaterial ( QQuick3DMaterial * newOverrideMaterial)

Definition at line 382 of file qquick3drenderpass.cpp.

◆ setPassMode()

void QQuick3DRenderPass::setPassMode ( PassMode newPassMode)

Definition at line 468 of file qquick3drenderpass.cpp.

◆ setRenderTargetFlags()

void QQuick3DRenderPass::setRenderTargetFlags ( RenderTargetFlags newRenderTargetFlags)

Definition at line 537 of file qquick3drenderpass.cpp.

◆ setStencilClearValue()

void QQuick3DRenderPass::setStencilClearValue ( quint32 newStencilClearValue)

Definition at line 508 of file qquick3drenderpass.cpp.

◆ stencilClearValue()

quint32 QQuick3DRenderPass::stencilClearValue ( ) const

\qmlproperty int RenderPass::stencilClearValue This property holds the stencil clear value for the render pass.

\default 0

Definition at line 503 of file qquick3drenderpass.cpp.

◆ stencilClearValueChanged

void QQuick3DRenderPass::stencilClearValueChanged ( )
signal

◆ updateSpatialNode()

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

Reimplemented from QQuick3DObject.

Definition at line 41 of file qquick3drenderpass.cpp.

Property Documentation

◆ augmentShader

QUrl QQuick3DRenderPass::augmentShader
readwrite

Definition at line 35 of file qquick3drenderpass_p.h.

◆ clearColor

QColor QQuick3DRenderPass::clearColor
readwrite

Definition at line 31 of file qquick3drenderpass_p.h.

◆ commands

QQmlListProperty< QQuick3DShaderUtilsRenderCommand > QQuick3DRenderPass::commands
read

\qmlproperty list<RenderCommand> RenderPass::commands This property holds the list of render commands for the render pass.

The commands in the list are executed in the order they appear in the list.

Note
The commands for RenderPass and Effects are similar but not the same, only those marked as compatible can be used with this RenderPass.
See also
renderTargetBlend, PipelineStateOverride, RenderablesFilter, RenderPassTexture, ColorAttachment, DepthTextureAttachment, DepthStencilAttachment, AddDefine

Definition at line 29 of file qquick3drenderpass_p.h.

◆ depthClearValue

float QQuick3DRenderPass::depthClearValue
readwrite

Definition at line 32 of file qquick3drenderpass_p.h.

◆ materialMode

MaterialModes QQuick3DRenderPass::materialMode
readwrite

Definition at line 30 of file qquick3drenderpass_p.h.

◆ overrideMaterial

QQuick3DMaterial* QQuick3DRenderPass::overrideMaterial
readwrite

Definition at line 34 of file qquick3drenderpass_p.h.

◆ passMode

PassMode QQuick3DRenderPass::passMode
readwrite

Definition at line 36 of file qquick3drenderpass_p.h.

◆ renderTargetFlags

RenderTargetFlags QQuick3DRenderPass::renderTargetFlags
readwrite

Definition at line 37 of file qquick3drenderpass_p.h.

◆ stencilClearValue

quint32 QQuick3DRenderPass::stencilClearValue
readwrite

Definition at line 33 of file qquick3drenderpass_p.h.


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