![]() |
Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
|
#include <qquick3dskymaterial_p.h>
Public Types | |
| enum class | SkyboxMode { Cubemap , ScreenSpaceFull , ScreenSpaceHalf , ScreenSpaceQuarter } |
| Public Types inherited from QQuick3DPropertyChangedTracker | |
| enum class | DirtyPropertyHint { Value , Reference } |
| using | UniformProperty = QSSGUserShaderAugmentation::Property |
| using | UniformPropertyList = QVector<UniformProperty> |
Public Slots | |
| Q_REVISION (6, 12) void setRadianceMapSize(int radianceMapSize) | |
| Q_REVISION (6, 12) void setFragmentShader(const QUrl &newFragmentShader) | |
| Q_REVISION (6, 12) void setFragmentShaderCode(const QString &newFragmentShaderCode) | |
| Q_REVISION (6, 12) void setEnableIBL(bool new EnableIBL) | |
| Q_REVISION (6, 12) void setIblSampleCount(int new IblSampleCount) | |
| Q_REVISION (6, 12) void setIblRenderFrames(int new IblRenderFrames) | |
| Q_REVISION (6, 12) void setSkyboxMode(SkyboxMode skyboxMode) | |
| Public Slots inherited from QQuick3DObject | |
| void | update () |
| void | setParentItem (QQuick3DObject *parentItem) |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| \threadsafe | |
Signals | |
| Q_REVISION (6, 12) void radianceMapSizeChanged() | |
| Q_REVISION (6, 12) void fragmentShaderChanged() | |
| Q_REVISION (6, 12) void fragmentShaderCodeChanged() | |
| Q_REVISION (6, 12) void enableIBLChanged() | |
| Q_REVISION (6, 12) void iblSampleCountChanged() | |
| Q_REVISION (6, 12) void iblRenderFramesChanged() | |
| Q_REVISION (6, 12) void skyboxModeChanged() | |
| 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 | |
| QQuick3DSkyMaterial (QQuick3DObject *parent=nullptr) | |
| \qmlproperty int SkyMaterial::radianceMapSize | |
| Q_REVISION (6, 12) int radianceMapSize() const | |
| Q_REVISION (6, 12) QUrl fragmentShader() const | |
| Q_REVISION (6, 12) bool enableIBL() const | |
| Q_REVISION (6, 12) QString fragmentShaderCode() const | |
| Q_REVISION (6, 12) int iblSampleCount() const | |
| Q_REVISION (6, 12) int iblRenderFrames() const | |
| Q_REVISION (6, 12) SkyboxMode skyboxMode() 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< 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 | isQmlExposed () const noexcept |
| 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 () |
| Public Member Functions inherited from QQuick3DPropertyChangedTracker | |
| template<typename T> | |
| QQuick3DPropertyChangedTracker (QQuick3DObject *owner, QQuick3DSuperClassInfo< T > info) | |
| virtual | ~QQuick3DPropertyChangedTracker () |
Protected Member Functions | |
| QSSGRenderGraphObject * | updateSpatialNode (QSSGRenderGraphObject *node) override |
| void | markTrackedPropertyDirty (QMetaProperty property, DirtyPropertyHint hint) override |
| Protected Member Functions inherited from QQuick3DObject | |
| 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 | |
| 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) | |
| Protected Member Functions inherited from QQuick3DPropertyChangedTracker | |
| QList< UniformProperty > | extractProperties () |
| void | addPropertyWatcher (QMetaProperty property, DirtyPropertyHint hint, QQuick3DObject *object=nullptr) |
Properties | |
| int | radianceMapSize |
| QUrl | fragmentShader |
| QString | fragmentShaderCode |
| bool | enableIBL |
| int | iblSampleCount |
| int | iblRenderFrames |
| SkyboxMode | skyboxMode |
| 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 | |
| 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 &) |
| Disconnects connection and resets it to \l{QMetaObject::Connection::operator bool()}{invalid}. | |
| static bool | disconnect (QMetaObject::Connection &) |
| static bool | disconnect (QMetaObject::Connection &&conn) |
| 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 |
| Protected Attributes inherited from QQuick3DPropertyChangedTracker | |
| QHash< int, Tracked > | m_trackedProperties |
| QQuick3DObject * | m_owner = nullptr |
| const char * | m_superClassName = nullptr |
| QList< UniformProperty > | m_propertyList |
| 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 27 of file qquick3dskymaterial_p.h.
|
strong |
| Enumerator | |
|---|---|
| Cubemap | |
| ScreenSpaceFull | |
| ScreenSpaceHalf | |
| ScreenSpaceQuarter | |
Definition at line 43 of file qquick3dskymaterial_p.h.
|
explicit |
\qmlproperty int SkyMaterial::radianceMapSize
\qmltype SkyMaterial
\inqmlmodule QtQuick3D
\since 6.12
\brief Renders a procedural sky and generates image-based lighting data.
SkyMaterial renders a sky environment into a cubemap using custom
fragment shader code. The resulting cubemap can optionally be filtered
and used as image-based lighting (IBL) for physically based rendering.
The shader is evaluated for all six faces of the cubemap and may
implement arbitrary procedural skies, gradients, or analytical models.
The generated cubemap is used both as the visible scene background and
as the source for image-based lighting when enabled.
\note Changes to shader code or properties may take a frame or more
before being reflected in the generated IBL.
\section1 Shader
The shader has access to the built-in variable \c qt_eyeDir (\c vec3),
which provides the non-normalized direction vector from the center of
the cubemap to the current sample direction.
The fragment shader must define a \c MAIN() entry point, which is
executed for each fragment generated while rendering the cubemap.
The final pixel color must be written to \c FRAGCOLOR (\c vec4), which
is the output variable of the fragment shader.
A minimal shader example:
\badcode
void MAIN()
{
vec3 dir = normalize(qt_eyeDir);
Output color (encoded direction as RGB) FRAGCOLOR = vec4(dir * 0.5 + 0.5, 1.0); }
Custom QML properties declared on SkyMaterial are automatically exposed as uniforms in the fragment shader. The property name must match the GLSL variable name. No explicit uniform declaration is required.
The following type mappings are supported:
\table \header
Specifies the resolution of the generated environment cubemap used for image-based lighting and reflection probes.
Higher values improve reflection sharpness and lighting quality, especially for glossy materials, but increase memory usage and rendering cost.
Values are snapped to the nearest power of two and clamped to the range [8, 2048].
ScreenSpace value, the visible sky is evaluated directly on screen and this property only affects the IBL/reflection cubemap. With SkyMaterial.Cubemap it also determines the sharpness of the visible background. When \l enableIBL is false, \l skyboxMode is a ScreenSpace value, and no reflection probes are present, no cubemap is generated at all.\qmlproperty url SkyMaterial::fragmentShader
Specifies a fragment shader loaded from a file or resource URL.
If both \l fragmentShader and \l fragmentShaderCode are set, \l fragmentShaderCode takes precedence.
If no shader is specified, a built-in debug shader is used.
\qmlproperty string SkyMaterial::fragmentShaderCode
Specifies inline fragment shader source code.
This behaves identically to \l fragmentShader and uses the same execution model, built-ins, and automatic property-to-uniform mapping.
If both \l fragmentShader and \l fragmentShaderCode are set, this property takes precedence.
\qmlproperty bool SkyMaterial::enableIBL
Determines whether the generated sky cubemap is used for image-based lighting.
When enabled, the engine generates filtered radiance and irradiance maps used for ambient lighting and reflections in physically based rendering.
When disabled, the sky is only rendered as a visual background and no IBL preprocessing is performed.
\qmlproperty int SkyMaterial::iblSampleCount
The total number of GGX importance samples evaluated per output texel of the filtered radiance map. Higher values reduce shimmering on high-frequency features such as a sun disk, at the cost of generation time.
Values are clamped to the range [1, 1024].
false.\qmlproperty int SkyMaterial::iblRenderFrames
Controls how the IBL prefilter work is spread across frames.
\list
ceil(iblSampleCount / N) samples per frame), followed by a dedicated normalization and irradiance frame. \endlistHigher values amortize the GGX prefilter cost across more frames, which is useful when the sky changes infrequently and a high \l iblSampleCount is required for quality.
false.\qmlproperty enumeration SkyMaterial::skyboxMode
Selects what the SkyMaterial produces for the visible background.
\value SkyMaterial.Cubemap The background samples the radiance cubemap (the same cube used for image-based lighting), whose resolution follows \l radianceMapSize. For a static sky the cube is rendered once and then sampled cheaply every frame, so this is the lowest per-frame cost when nothing but the camera is moving. Sharpness is capped at \l radianceMapSize. \value SkyMaterial.ScreenSpaceFull The sky shader is evaluated directly on screen at full viewport resolution every frame (sharpest, most costly). \value SkyMaterial.ScreenSpaceHalf Direct screen-space evaluation at half resolution per axis (quarter the pixels), upscaled to the viewport. \value SkyMaterial.ScreenSpaceQuarter Direct screen-space evaluation at quarter resolution per axis (one sixteenth the pixels), upscaled to the viewport.
The ScreenSpace modes decouple the visible background from the IBL cube and are best for dynamic skies (e.g. moving sun, animated volumetric clouds); Cubemap is best for static skies. Cubemap forces the cubemap to be generated even when \l enableIBL is false.
Definition at line 221 of file qquick3dskymaterial.cpp.
|
overrideprotectedvirtual |
Implements QQuick3DPropertyChangedTracker.
Definition at line 274 of file qquick3dskymaterial.cpp.
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
| QQuick3DSkyMaterial::Q_REVISION | ( | 6 | , |
| 12 | ) const |
|
signal |
|
signal |
|
signal |
|
signal |
|
signal |
|
signal |
|
newslot |
|
slot |
|
slot |
|
newslot |
|
newslot |
|
slot |
|
slot |
|
signal |
|
overrideprotectedvirtual |
Reimplemented from QQuick3DObject.
Definition at line 231 of file qquick3dskymaterial.cpp.
|
readwrite |
Definition at line 33 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 31 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 32 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 35 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 34 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 30 of file qquick3dskymaterial_p.h.
|
readwrite |
Definition at line 36 of file qquick3dskymaterial_p.h.