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

#include <qquick3dshaderutils_p.h>

Inheritance diagram for QQuick3DShaderUtilsRenderablesFilter:
Collaboration diagram for QQuick3DShaderUtilsRenderablesFilter:

Public Types

enum class  RenderableType : quint32 { None = 0x0 , Opaque = 0x1 , Transparent = 0x2 }

Public Member Functions

 QQuick3DShaderUtilsRenderablesFilter ()=default
 ~QQuick3DShaderUtilsRenderablesFilter () override
RenderableTypes renderableTypes () const
 \qmltype RenderablesFilter \inherits Command \inqmlmodule QtQuick3D
void setRenderableTypes (RenderableTypes types)
QSSGCommandcloneCommand () override
Public Member Functions inherited from QQuick3DShaderUtilsRenderCommand
 QQuick3DShaderUtilsRenderCommand ()=default
 ~QQuick3DShaderUtilsRenderCommand () override=default
virtual int bufferCount () const
virtual QQuick3DShaderUtilsBufferbufferAt (int idx) 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 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 Attributes

QSSGRenderablesFilterCommand command { }
quint32layerMask = command.layerMask

Properties

quint32 layerMask
RenderableTypes renderableTypes
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
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.
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 Member Functions inherited from QQuick3DObject
virtual QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node)
virtual void markAllDirty ()
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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 492 of file qquick3dshaderutils_p.h.

Member Enumeration Documentation

◆ RenderableType

Enumerator
None 
Opaque 
Transparent 

Definition at line 502 of file qquick3dshaderutils_p.h.

Constructor & Destructor Documentation

◆ QQuick3DShaderUtilsRenderablesFilter()

QQuick3DShaderUtilsRenderablesFilter::QQuick3DShaderUtilsRenderablesFilter ( )
default

◆ ~QQuick3DShaderUtilsRenderablesFilter()

QQuick3DShaderUtilsRenderablesFilter::~QQuick3DShaderUtilsRenderablesFilter ( )
override

Definition at line 1020 of file qquick3dshaderutils.cpp.

Member Function Documentation

◆ cloneCommand()

QSSGCommand * QQuick3DShaderUtilsRenderablesFilter::cloneCommand ( )
inlineoverridevirtual

Reimplemented from QQuick3DShaderUtilsRenderCommand.

Definition at line 516 of file qquick3dshaderutils_p.h.

◆ renderableTypes()

QQuick3DShaderUtilsRenderablesFilter::RenderableTypes QQuick3DShaderUtilsRenderablesFilter::renderableTypes ( ) const

\qmltype RenderablesFilter \inherits Command \inqmlmodule QtQuick3D

Defines a filter for selecting which renderables to affect in a \l {RenderPass}{pass}.

Since
6.11

The RenderablesFilter type is used to specify which renderables in the scene should be affected by a \l RenderPass. By setting the renderableTypes property, you can control whether the pass affects Opaque, Transparent, or no objects at all.

Setting renderableTypes to None is useful when a RenderPass acts as a container for SubRenderPasses and should not render any objects itself.

In addition to filtering by renderable types, you can also use the \l{RenderablesFilter::layerMask}{layerMask} to further refine which renderables are affected based on their assigned \l{QtQuick3D::Node::layers}{layers}.

\qmlproperty int RenderablesFilter::layerMask Sets the layer mask for the filter. Only renderables on the specified layers will be affected by the filter.

See also
l{QtQuick3D::Node::layers}

\qmlproperty enumeration RenderablesFilter::renderableTypes Sets the types of renderables that the filter will affect.

\value RenderablesFilter.None No renderables will be rendered. Useful for container passes that only have SubRenderPasses. \value RenderablesFilter.Opaque Only opaque renderables will be rendered. \value RenderablesFilter.Transparent Only transparent renderables will be rendered.

Note
Multiple values can be combined using the | operator.

\default RenderablesFilter.Opaque | RenderablesFilter.Transparent

Definition at line 1015 of file qquick3dshaderutils.cpp.

◆ setRenderableTypes()

void QQuick3DShaderUtilsRenderablesFilter::setRenderableTypes ( RenderableTypes types)

Definition at line 1025 of file qquick3dshaderutils.cpp.

Member Data Documentation

◆ command

QSSGRenderablesFilterCommand QQuick3DShaderUtilsRenderablesFilter::command { }

Definition at line 517 of file qquick3dshaderutils_p.h.

◆ layerMask

quint32& QQuick3DShaderUtilsRenderablesFilter::layerMask = command.layerMask

Definition at line 519 of file qquick3dshaderutils_p.h.

Property Documentation

◆ layerMask

quint32 QQuick3DShaderUtilsRenderablesFilter::layerMask

Definition at line 496 of file qquick3dshaderutils_p.h.

◆ renderableTypes

RenderableTypes QQuick3DShaderUtilsRenderablesFilter::renderableTypes
readwrite

Definition at line 497 of file qquick3dshaderutils_p.h.


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