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

#include <sceneeffects_p.h>

Inheritance diagram for SceneEffectEnvironment:
Collaboration diagram for SceneEffectEnvironment:

Public Member Functions

 SceneEffectEnvironment (QQuick3DObject *p=nullptr)
void setMainSceneEffect (MainSceneEffect *tonemapper)
void setDeptOfFieldEffect (DepthOfFieldEffect *dof)
void setSsgiEffect (SsgiEnvEffect *ssgi)
Public Member Functions inherited from QQuick3DSceneEnvironment
 QQuick3DSceneEnvironment (QQuick3DObject *parent=nullptr)
 \qmltype SceneEnvironment \inherits Object3D \inqmlmodule QtQuick3D
 ~QQuick3DSceneEnvironment () override
QQuick3DEnvironmentAAModeValues antialiasingMode () const
 \qmlproperty enumeration QtQuick3D::SceneEnvironment::antialiasingMode
QQuick3DEnvironmentAAQualityValues antialiasingQuality () const
 \qmlproperty enumeration QtQuick3D::SceneEnvironment::antialiasingQuality
bool temporalAAEnabled () const
 \qmlproperty bool QtQuick3D::SceneEnvironment::temporalAAEnabled
float temporalAAStrength () const
 \qmlproperty real QtQuick3D::SceneEnvironment::temporalAAStrength
QQuick3DEnvironmentBackgroundTypes backgroundMode () const
 \qmlproperty enumeration QtQuick3D::SceneEnvironment::backgroundMode
QColor clearColor () const
 \qmlproperty color QtQuick3D::SceneEnvironment::clearColor
float aoStrength () const
 \qmlproperty real QtQuick3D::SceneEnvironment::aoStrength
float aoDistance () const
 \qmlproperty real QtQuick3D::SceneEnvironment::aoDistance
float aoSoftness () const
 \qmlproperty real QtQuick3D::SceneEnvironment::aoSoftness
bool aoDither () const
 \qmlproperty bool QtQuick3D::SceneEnvironment::aoDither
int aoSampleRate () const
 \qmlproperty int QtQuick3D::SceneEnvironment::aoSampleRate
float aoBias () const
 \qmlproperty real QtQuick3D::SceneEnvironment::aoBias
 Q_REVISION (6, 5) bool aoEnabled() const
 Q_REVISION (6, 5) void setAoEnabled(bool new AoEnabled)
QQuick3DTexturelightProbe () const
 \qmlproperty QtQuick3D::Texture QtQuick3D::SceneEnvironment::lightProbe
float probeExposure () const
 \qmlproperty real QtQuick3D::SceneEnvironment::probeExposure
float probeHorizon () const
 \qmlproperty real QtQuick3D::SceneEnvironment::probeHorizon
QVector3D probeOrientation () const
 \qmlproperty vector3d QtQuick3D::SceneEnvironment::probeOrientation
bool depthTestEnabled () const
 \qmlproperty bool QtQuick3D::SceneEnvironment::depthTestEnabled
bool depthPrePassEnabled () const
 \qmlproperty bool QtQuick3D::SceneEnvironment::depthPrePassEnabled
QQuick3DEnvironmentTonemapModes tonemapMode () const
 \qmlproperty enumeration QtQuick3D::SceneEnvironment::tonemapMode
QQmlListProperty< QQuick3DEffecteffects ()
 Q_REVISION (6, 4) float skyboxBlurAmount() const
 Q_REVISION (6, 4) bool specularAAEnabled() const
 Q_REVISION (6, 4) QQuick3DLightmapper *lightmapper() const
 Q_REVISION (6, 4) QQuick3DCubeMapTexture *skyBoxCubeMap() const
 Q_REVISION (6, 5) QQuick3DDebugSettings *debugSettings() const
 Q_REVISION (6, 5) QRect scissorRect() const
 Q_REVISION (6, 5) QQuick3DFog *fog() const
QQuick3DEnvironmentOITMethod Q_REVISION (6, 9) oitMethod() const
bool gridEnabled () const
void setGridEnabled (bool newGridEnabled)
float gridScale () const
void setGridScale (float newGridScale)
uint gridFlags () const
void setGridFlags (uint newGridFlags)
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 ()

Protected Member Functions

QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
const QVector< QQuick3DEffect * > & effectList () const override
bool useBuiltinTonemapper () const override
Protected Member Functions inherited from QQuick3DSceneEnvironment
void itemChange (ItemChange, const ItemChangeData &) override
Protected Member Functions inherited from QQuick3DObject
virtual void markAllDirty ()
 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)

Additional Inherited Members

Public Types inherited from QQuick3DSceneEnvironment
enum  QQuick3DEnvironmentAAModeValues { NoAA = 0 , SSAA , MSAA , ProgressiveAA }
enum  QQuick3DEnvironmentAAQualityValues { Medium = 2 , High = 4 , VeryHigh = 8 }
enum  QQuick3DEnvironmentBackgroundTypes {
  Transparent = 0 , Unspecified , Color , SkyBox ,
  SkyBoxCubeMap
}
enum  QQuick3DEnvironmentTonemapModes {
  TonemapModeNone = 0 , TonemapModeLinear , TonemapModeAces , TonemapModeHejlDawson ,
  TonemapModeFilmic
}
enum  QQuick3DEnvironmentOITMethod { OITNone = 0 , OITWeightedBlended }
Public Slots inherited from QQuick3DSceneEnvironment
void setAntialiasingMode (QQuick3DSceneEnvironment::QQuick3DEnvironmentAAModeValues antialiasingMode)
void setAntialiasingQuality (QQuick3DSceneEnvironment::QQuick3DEnvironmentAAQualityValues antialiasingQuality)
void setTemporalAAEnabled (bool temporalAAEnabled)
void setTemporalAAStrength (float strength)
void setBackgroundMode (QQuick3DSceneEnvironment::QQuick3DEnvironmentBackgroundTypes backgroundMode)
void setClearColor (const QColor &clearColor)
void setAoStrength (float aoStrength)
void setAoDistance (float aoDistance)
void setAoSoftness (float aoSoftness)
void setAoDither (bool aoDither)
void setAoSampleRate (int aoSampleRate)
void setAoBias (float aoBias)
void setLightProbe (QQuick3DTexture *lightProbe)
void setProbeExposure (float probeExposure)
void setProbeHorizon (float probeHorizon)
void setProbeOrientation (const QVector3D &orientation)
void setDepthTestEnabled (bool depthTestEnabled)
void setDepthPrePassEnabled (bool depthPrePassEnabled)
void setTonemapMode (QQuick3DSceneEnvironment::QQuick3DEnvironmentTonemapModes tonemapMode)
 Q_REVISION (6, 4) void setSkyboxBlurAmount(float new SkyboxBlurAmount)
 Q_REVISION (6, 4) void setSpecularAAEnabled(bool enabled)
 Q_REVISION (6, 4) void setSkyBoxCubeMap(QQuick3DCubeMapTexture *newSkyBoxCubeMap)
 Q_REVISION (6, 4) void setLightmapper(QQuick3DLightmapper *lightmapper)
 Q_REVISION (6, 5) void setDebugSettings(QQuick3DDebugSettings *newDebugSettings)
 Q_REVISION (6, 5) void setScissorRect(QRect scissorRect)
 Q_REVISION (6, 5) void setFog(QQuick3DFog *fog)
Public Slots inherited from QQuick3DObject
void update ()
void setParentItem (QQuick3DObject *parentItem)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QQuick3DSceneEnvironment
void antialiasingModeChanged ()
void antialiasingQualityChanged ()
void temporalAAEnabledChanged ()
void temporalAAStrengthChanged ()
void backgroundModeChanged ()
void clearColorChanged ()
void aoStrengthChanged ()
void aoDistanceChanged ()
void aoSoftnessChanged ()
void aoDitherChanged ()
void aoSampleRateChanged ()
void aoBiasChanged ()
 Q_REVISION (6, 5) void aoEnabledChanged()
void lightProbeChanged ()
void probeExposureChanged ()
void probeHorizonChanged ()
void probeOrientationChanged ()
void depthTestEnabledChanged ()
void depthPrePassEnabledChanged ()
void tonemapModeChanged ()
 Q_REVISION (6, 4) void skyboxBlurAmountChanged()
 Q_REVISION (6, 4) void specularAAEnabledChanged()
 Q_REVISION (6, 4) void lightmapperChanged()
 Q_REVISION (6, 4) void skyBoxCubeMapChanged()
 Q_REVISION (6, 5) void debugSettingsChanged()
 Q_REVISION (6, 5) void scissorRectChanged()
 Q_REVISION (6, 5) void fogChanged()
 Q_REVISION (6, 9) void oitMethodChanged()
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 Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
Properties inherited from QQuick3DSceneEnvironment
QQuick3DEnvironmentAAModeValues antialiasingMode
QQuick3DEnvironmentAAQualityValues antialiasingQuality
bool temporalAAEnabled
float temporalAAStrength
QQuick3DEnvironmentBackgroundTypes backgroundMode
QColor clearColor
bool depthTestEnabled
bool depthPrePassEnabled
float aoStrength
float aoDistance
float aoSoftness
bool aoDither
int aoSampleRate
float aoBias
bool aoEnabled
 \qmlproperty bool SceneEnvironment::aoEnabled
QQuick3DTexturelightProbe
float probeExposure
float probeHorizon
QVector3D probeOrientation
QQuick3DCubeMapTextureskyBoxCubeMap
 \qmlproperty QtQuick3D::CubeMapTexture QtQuick3D::SceneEnvironment::skyBoxCubeMap
QQuick3DEnvironmentTonemapModes tonemapMode
QQmlListProperty< QQuick3DEffecteffects
 \qmlproperty List<QtQuick3D::Effect> QtQuick3D::SceneEnvironment::effects
float skyboxBlurAmount
 \qmlproperty real QtQuick3D::SceneEnvironment::skyboxBlurAmount
bool specularAAEnabled
 \qmlproperty bool QtQuick3D::SceneEnvironment::specularAAEnabled
QQuick3DLightmapperlightmapper
 \qmlproperty Lightmapper QtQuick3D::SceneEnvironment::lightmapper
QQuick3DDebugSettingsdebugSettings
 \qmlproperty QtQuick3D::DebugSettings QtQuick3D::SceneEnvironment::debugSettings
QRect scissorRect
 \qmlproperty rect QtQuick3D::SceneEnvironment::scissorRect
QQuick3DFogfog
 \qmlproperty QtQuick3D::Fog QtQuick3D::SceneEnvironment::fog
QQuick3DEnvironmentOITMethod oitMethod
 \qmlproperty enumeration QtQuick3D::SceneEnvironment::oitMethod
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

Detailed Description

Definition at line 102 of file sceneeffects_p.h.

Constructor & Destructor Documentation

◆ SceneEffectEnvironment()

SceneEffectEnvironment::SceneEffectEnvironment ( QQuick3DObject * p = nullptr)
explicit

Definition at line 136 of file sceneeffects.cpp.

Member Function Documentation

◆ effectList()

const QVector< QQuick3DEffect * > & SceneEffectEnvironment::effectList ( ) const
overrideprotectedvirtual

Reimplemented from QQuick3DSceneEnvironment.

Definition at line 185 of file sceneeffects.cpp.

◆ setDeptOfFieldEffect()

void SceneEffectEnvironment::setDeptOfFieldEffect ( DepthOfFieldEffect * dof)

Definition at line 151 of file sceneeffects.cpp.

Referenced by DepthOfFieldEffect::registerWithEnv(), and DepthOfFieldEffect::unregisterWithEnv().

Here is the caller graph for this function:

◆ setMainSceneEffect()

void SceneEffectEnvironment::setMainSceneEffect ( MainSceneEffect * tonemapper)

Definition at line 141 of file sceneeffects.cpp.

Referenced by MainSceneEffect::registerWithEnv(), and MainSceneEffect::unregisterWithEnv().

Here is the caller graph for this function:

◆ setSsgiEffect()

void SceneEffectEnvironment::setSsgiEffect ( SsgiEnvEffect * ssgi)

Definition at line 161 of file sceneeffects.cpp.

Referenced by SsgiEnvEffect::registerWithEnv(), and SsgiEnvEffect::unregisterWithEnv().

Here is the caller graph for this function:

◆ updateSpatialNode()

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

Reimplemented from QQuick3DSceneEnvironment.

Definition at line 171 of file sceneeffects.cpp.

◆ useBuiltinTonemapper()

bool SceneEffectEnvironment::useBuiltinTonemapper ( ) const
overrideprotectedvirtual

Reimplemented from QQuick3DSceneEnvironment.

Definition at line 190 of file sceneeffects.cpp.


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