Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
QQuick3DCustomMaterial Class Reference

#include <qquick3dcustommaterial_p.h>

+ Inheritance diagram for QQuick3DCustomMaterial:
+ Collaboration diagram for QQuick3DCustomMaterial:

Public Types

enum class  ShadingMode { Unshaded , Shaded }
 
enum class  BlendMode {
  NoBlend , Zero , One , SrcColor ,
  OneMinusSrcColor , DstColor , OneMinusDstColor , SrcAlpha ,
  OneMinusSrcAlpha , DstAlpha , OneMinusDstAlpha , ConstantColor ,
  OneMinusConstantColor , ConstantAlpha , OneMinusConstantAlpha , SrcAlphaSaturate
}
 
- Public Types inherited from QQuick3DMaterial
enum  CullMode { BackFaceCulling = 1 , FrontFaceCulling = 2 , NoCulling = 3 }
 
enum  TextureChannelMapping { R = 0 , G , B , A }
 
enum  DepthDrawMode { OpaqueOnlyDepthDraw = 0 , AlwaysDepthDraw , NeverDepthDraw , OpaquePrePassDepthDraw }
 
enum  VertexColorMask {
  NoMask = 0 , RoughnessMask = 1 , NormalStrengthMask = 2 , SpecularAmountMask = 4 ,
  ClearcoatAmountMask = 8 , ClearcoatRoughnessAmountMask = 16 , ClearcoatNormalStrengthMask = 32 , HeightAmountMask = 64 ,
  MetalnessMask = 128 , OcclusionAmountMask = 256 , ThicknessFactorMask = 512 , TransmissionFactorMask = 1024
}
 

Public Slots

void setShadingMode (QQuick3DCustomMaterial::ShadingMode mode)
 
void setVertexShader (const QUrl &url)
 
void setFragmentShader (const QUrl &url)
 
void setSrcBlend (QQuick3DCustomMaterial::BlendMode mode)
 
void setDstBlend (QQuick3DCustomMaterial::BlendMode mode)
 
Q_REVISION(6, 7) void setSrcAlphaBlend(QQuick3DCustomMaterial Q_REVISION(6, 7) void setDstAlphaBlend(QQuick3DCustomMaterial void setAlwaysDirty (bool alwaysDirty)
 
void setLineWidth (float width)
 
- Public Slots inherited from QQuick3DMaterial
void setLightProbe (QQuick3DTexture *lightProbe)
 
void setCullMode (QQuick3DMaterial::CullMode cullMode)
 
void setDepthDrawMode (QQuick3DMaterial::DepthDrawMode depthDrawMode)
 
- Public Slots inherited from QQuick3DObject
void update ()
 
void setParentItem (QQuick3DObject *parentItem)
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void shadingModeChanged ()
 
void vertexShaderChanged ()
 
void fragmentShaderChanged ()
 
void srcBlendChanged ()
 
void dstBlendChanged ()
 
 Q_REVISION (6, 7) void srcAlphaBlendChanged()
 
 Q_REVISION (6, 7) void dstAlphaBlendChanged()
 
void alwaysDirtyChanged ()
 
void lineWidthChanged ()
 
- Signals inherited from QQuick3DMaterial
void lightProbeChanged (QQuick3DTexture *lightProbe)
 
void cullModeChanged (QQuick3DMaterial::CullMode cullMode)
 
void depthDrawModeChanged (QQuick3DMaterial::DepthDrawMode depthDrawMode)
 
- 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

 QQuick3DCustomMaterial (QQuick3DObject *parent=nullptr)
 
 ~QQuick3DCustomMaterial () override
 
ShadingMode shadingMode () const
 
QUrl vertexShader () const
 
QUrl fragmentShader () const
 
BlendMode srcBlend () const
 
BlendMode dstBlend () const
 
 Q_REVISION (6, 7) BlendMode srcAlphaBlend() const
 
 Q_REVISION (6, 7) BlendMode dstAlphaBlend() const
 
bool alwaysDirty () const
 
float lineWidth () const
 
- Public Member Functions inherited from QQuick3DMaterial
 ~QQuick3DMaterial () override
 
QQuick3DTexturelightProbe () const
 
CullMode cullMode () const
 
DepthDrawMode depthDrawMode () 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 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 Types

enum  Dirty : quint32 {
  TextureDirty = 0x1 , PropertyDirty = 0x2 , ShaderSettingsDirty = 0x4 , DynamicPropertiesDirty = 0x8 ,
  AllDirty = std::numeric_limits<quint32>::max() ^ DynamicPropertiesDirty
}
 

Protected Member Functions

QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
 
void itemChange (ItemChange, const ItemChangeData &) override
 
void markAllDirty () override
 
- Protected Member Functions inherited from QQuick3DMaterial
 QQuick3DMaterial (QQuick3DObjectPrivate &dd, QQuick3DObject *parent=nullptr)
 \qmltype Material \inherits Object3D \inqmlmodule QtQuick3D
 
QSSGRenderGraphObjectupdateSpatialNode (QSSGRenderGraphObject *node) override
 
void itemChange (ItemChange, const ItemChangeData &) override
 
- Protected Member Functions inherited from QQuick3DObject
 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)
 

Static Protected Member Functions

static void markDirty (QQuick3DCustomMaterial &that, QQuick3DCustomMaterial::Dirty type)
 

Properties

ShadingMode shadingMode
 
QUrl fragmentShader
 
QUrl vertexShader
 
BlendMode sourceBlend
 
BlendMode destinationBlend
 
BlendMode sourceAlphaBlend
 
BlendMode destinationAlphaBlend
 
bool alwaysDirty
 
float lineWidth
 
- Properties inherited from QQuick3DMaterial
QQuick3DTexturelightProbe
 
CullMode cullMode
 
DepthDrawMode depthDrawMode
 
- 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
 

Friends

class QQuick3DShaderUtilsTextureInput
 
class QQuick3DViewport
 

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 &)
 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
 

Detailed Description

Definition at line 27 of file qquick3dcustommaterial_p.h.

Member Enumeration Documentation

◆ BlendMode

Enumerator
NoBlend 
Zero 
One 
SrcColor 
OneMinusSrcColor 
DstColor 
OneMinusDstColor 
SrcAlpha 
OneMinusSrcAlpha 
DstAlpha 
OneMinusDstAlpha 
ConstantColor 
OneMinusConstantColor 
ConstantAlpha 
OneMinusConstantAlpha 
SrcAlphaSaturate 

Definition at line 50 of file qquick3dcustommaterial_p.h.

◆ Dirty

Enumerator
TextureDirty 
PropertyDirty 
ShaderSettingsDirty 
DynamicPropertiesDirty 
AllDirty 

Definition at line 107 of file qquick3dcustommaterial_p.h.

◆ ShadingMode

Enumerator
Unshaded 
Shaded 

Definition at line 43 of file qquick3dcustommaterial_p.h.

Constructor & Destructor Documentation

◆ QQuick3DCustomMaterial()

QQuick3DCustomMaterial::QQuick3DCustomMaterial ( QQuick3DObject * parent = nullptr)
explicit

Definition at line 1414 of file qquick3dcustommaterial.cpp.

◆ ~QQuick3DCustomMaterial()

QQuick3DCustomMaterial::~QQuick3DCustomMaterial ( )
override

Definition at line 1419 of file qquick3dcustommaterial.cpp.

Member Function Documentation

◆ alwaysDirty()

bool QQuick3DCustomMaterial::alwaysDirty ( ) const

Definition at line 1554 of file qquick3dcustommaterial.cpp.

◆ alwaysDirtyChanged

void QQuick3DCustomMaterial::alwaysDirtyChanged ( )
signal

Referenced by setAlwaysDirty().

+ Here is the caller graph for this function:

◆ dstBlend()

QQuick3DCustomMaterial::BlendMode QQuick3DCustomMaterial::dstBlend ( ) const

Definition at line 1436 of file qquick3dcustommaterial.cpp.

◆ dstBlendChanged

void QQuick3DCustomMaterial::dstBlendChanged ( )
signal

Referenced by setDstBlend().

+ Here is the caller graph for this function:

◆ fragmentShader()

QUrl QQuick3DCustomMaterial::fragmentShader ( ) const

Definition at line 1511 of file qquick3dcustommaterial.cpp.

◆ fragmentShaderChanged

void QQuick3DCustomMaterial::fragmentShaderChanged ( )
signal

Referenced by setFragmentShader().

+ Here is the caller graph for this function:

◆ itemChange()

void QQuick3DCustomMaterial::itemChange ( ItemChange ,
const ItemChangeData &  )
overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 1914 of file qquick3dcustommaterial.cpp.

References QQuick3DObjectPrivate::derefSceneManager(), it, QQuick3DMaterial::itemChange(), and QQuick3DObjectPrivate::refSceneManager().

+ Here is the call graph for this function:

◆ lineWidth()

float QQuick3DCustomMaterial::lineWidth ( ) const

Definition at line 1526 of file qquick3dcustommaterial.cpp.

◆ lineWidthChanged

void QQuick3DCustomMaterial::lineWidthChanged ( )
signal

Referenced by setLineWidth().

+ Here is the caller graph for this function:

◆ markAllDirty()

void QQuick3DCustomMaterial::markAllDirty ( )
overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 1540 of file qquick3dcustommaterial.cpp.

References AllDirty, and QQuick3DObject::markAllDirty().

Referenced by updateSpatialNode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ markDirty()

void QQuick3DCustomMaterial::markDirty ( QQuick3DCustomMaterial & that,
QQuick3DCustomMaterial::Dirty type )
staticprotected

Definition at line 1546 of file qquick3dcustommaterial.cpp.

Referenced by setFragmentShader(), setShadingMode(), and setVertexShader().

+ Here is the caller graph for this function:

◆ Q_REVISION() [1/4]

QQuick3DCustomMaterial::Q_REVISION ( 6 ,
7  ) const

◆ Q_REVISION() [2/4]

QQuick3DCustomMaterial::Q_REVISION ( 6 ,
7  ) const

◆ Q_REVISION [3/4]

QQuick3DCustomMaterial::Q_REVISION ( 6 ,
7  )
signal

◆ Q_REVISION [4/4]

QQuick3DCustomMaterial::Q_REVISION ( 6 ,
7  )
signal

◆ setAlwaysDirty

void QQuick3DCustomMaterial::setAlwaysDirty ( bool alwaysDirty)
slot

Definition at line 1559 of file qquick3dcustommaterial.cpp.

References alwaysDirty, alwaysDirtyChanged(), emit, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setDstBlend

void QQuick3DCustomMaterial::setDstBlend ( QQuick3DCustomMaterial::BlendMode mode)
slot

Definition at line 1441 of file qquick3dcustommaterial.cpp.

References dstBlendChanged(), emit, and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setFragmentShader

void QQuick3DCustomMaterial::setFragmentShader ( const QUrl & url)
slot

Definition at line 1516 of file qquick3dcustommaterial.cpp.

References emit, fragmentShaderChanged(), markDirty(), ShaderSettingsDirty, and url.

+ Here is the call graph for this function:

◆ setLineWidth

void QQuick3DCustomMaterial::setLineWidth ( float width)
slot

Definition at line 1531 of file qquick3dcustommaterial.cpp.

References emit, lineWidthChanged(), qFuzzyCompare(), and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setShadingMode

void QQuick3DCustomMaterial::setShadingMode ( QQuick3DCustomMaterial::ShadingMode mode)
slot

Definition at line 1486 of file qquick3dcustommaterial.cpp.

References emit, markDirty(), ShaderSettingsDirty, and shadingModeChanged().

+ Here is the call graph for this function:

◆ setSrcBlend

void QQuick3DCustomMaterial::setSrcBlend ( QQuick3DCustomMaterial::BlendMode mode)
slot

Definition at line 1426 of file qquick3dcustommaterial.cpp.

References emit, srcBlendChanged(), and QQuick3DObject::update().

+ Here is the call graph for this function:

◆ setVertexShader

void QQuick3DCustomMaterial::setVertexShader ( const QUrl & url)
slot

Definition at line 1501 of file qquick3dcustommaterial.cpp.

References emit, markDirty(), ShaderSettingsDirty, url, and vertexShaderChanged().

+ Here is the call graph for this function:

◆ shadingMode()

QQuick3DCustomMaterial::ShadingMode QQuick3DCustomMaterial::shadingMode ( ) const

Definition at line 1481 of file qquick3dcustommaterial.cpp.

◆ shadingModeChanged

void QQuick3DCustomMaterial::shadingModeChanged ( )
signal

Referenced by setShadingMode().

+ Here is the caller graph for this function:

◆ srcBlend()

QQuick3DCustomMaterial::BlendMode QQuick3DCustomMaterial::srcBlend ( ) const

Definition at line 1421 of file qquick3dcustommaterial.cpp.

◆ srcBlendChanged

void QQuick3DCustomMaterial::srcBlendChanged ( )
signal

Referenced by setSrcBlend().

+ Here is the caller graph for this function:

◆ updateSpatialNode()

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

◆ vertexShader()

QUrl QQuick3DCustomMaterial::vertexShader ( ) const

Definition at line 1496 of file qquick3dcustommaterial.cpp.

◆ vertexShaderChanged

void QQuick3DCustomMaterial::vertexShaderChanged ( )
signal

Referenced by setVertexShader().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ QQuick3DShaderUtilsTextureInput

friend class QQuick3DShaderUtilsTextureInput
friend

Definition at line 125 of file qquick3dcustommaterial_p.h.

◆ QQuick3DViewport

friend class QQuick3DViewport
friend

Definition at line 126 of file qquick3dcustommaterial_p.h.

Property Documentation

◆ alwaysDirty

bool QQuick3DCustomMaterial::alwaysDirty
readwrite

Definition at line 37 of file qquick3dcustommaterial_p.h.

Referenced by setAlwaysDirty().

◆ destinationAlphaBlend

BlendMode QQuick3DCustomMaterial::destinationAlphaBlend
readwrite

Definition at line 36 of file qquick3dcustommaterial_p.h.

◆ destinationBlend

BlendMode QQuick3DCustomMaterial::destinationBlend
readwrite

Definition at line 34 of file qquick3dcustommaterial_p.h.

◆ fragmentShader

QUrl QQuick3DCustomMaterial::fragmentShader
readwrite

Definition at line 31 of file qquick3dcustommaterial_p.h.

◆ lineWidth

float QQuick3DCustomMaterial::lineWidth
readwrite

Definition at line 38 of file qquick3dcustommaterial_p.h.

◆ shadingMode

ShadingMode QQuick3DCustomMaterial::shadingMode
readwrite

Definition at line 30 of file qquick3dcustommaterial_p.h.

◆ sourceAlphaBlend

BlendMode QQuick3DCustomMaterial::sourceAlphaBlend
readwrite

Definition at line 35 of file qquick3dcustommaterial_p.h.

◆ sourceBlend

BlendMode QQuick3DCustomMaterial::sourceBlend
readwrite

Definition at line 33 of file qquick3dcustommaterial_p.h.

◆ vertexShader

QUrl QQuick3DCustomMaterial::vertexShader
readwrite

Definition at line 32 of file qquick3dcustommaterial_p.h.


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