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)
	Q_REVISION (6, 8) void setVertexShaderCode(const QString &code)
	Q_REVISION (6, 8) void setFragmentShaderCode(const QString &code)
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 ()
	Q_REVISION (6, 8) void vertexShaderCodeChanged()
	Q_REVISION (6, 8) void fragmentShaderCodeChanged()
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
	Q_REVISION (6, 8) QString vertexShaderCode() const
	Q_REVISION (6, 8) QString fragmentShaderCode() 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
QQuick3DTexture *	lightProbe () 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< 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	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).
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 ()

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

Protected Member Functions
QSSGRenderGraphObject *	updateSpatialNode (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
QSSGRenderGraphObject *	updateSpatialNode (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
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)

Static Protected Member Functions
static void	markDirty (QQuick3DCustomMaterial &that, QQuick3DCustomMaterial::Dirty type)

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

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< QObjectData >	d_ptr
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)

Detailed Description

Definition at line 27 of file qquick3dcustommaterial_p.h.

Member Enumeration Documentation

BlendMode

enum class QQuick3DCustomMaterial::BlendMode

strong

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

Definition at line 52 of file qquick3dcustommaterial_p.h.

Dirty

enum QQuick3DCustomMaterial::Dirty : quint32

protected

Enumerator
TextureDirty
PropertyDirty
ShaderSettingsDirty
DynamicPropertiesDirty
AllDirty

Definition at line 115 of file qquick3dcustommaterial_p.h.

ShadingMode

enum class QQuick3DCustomMaterial::ShadingMode

strong

Enumerator
Unshaded
Shaded

Definition at line 45 of file qquick3dcustommaterial_p.h.

Constructor & Destructor Documentation

QQuick3DCustomMaterial()

QQuick3DCustomMaterial::QQuick3DCustomMaterial ( QQuick3DObject * parent = nullptr )

explicit

Definition at line 1490 of file qquick3dcustommaterial.cpp.

~QQuick3DCustomMaterial()

QQuick3DCustomMaterial::~QQuick3DCustomMaterial ( )

override

Definition at line 1495 of file qquick3dcustommaterial.cpp.

Member Function Documentation

alwaysDirty()

bool QQuick3DCustomMaterial::alwaysDirty

(

)

const

Definition at line 1661 of file qquick3dcustommaterial.cpp.

alwaysDirtyChanged

void QQuick3DCustomMaterial::alwaysDirtyChanged ( )

signal

dstBlend()

QQuick3DCustomMaterial::BlendMode QQuick3DCustomMaterial::dstBlend

(

)

const

Definition at line 1512 of file qquick3dcustommaterial.cpp.

dstBlendChanged

void QQuick3DCustomMaterial::dstBlendChanged ( )

signal

fragmentShader()

QUrl QQuick3DCustomMaterial::fragmentShader

(

)

const

Definition at line 1587 of file qquick3dcustommaterial.cpp.

fragmentShaderChanged

void QQuick3DCustomMaterial::fragmentShaderChanged ( )

signal

itemChange()

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

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 2060 of file qquick3dcustommaterial.cpp.

lineWidth()

float QQuick3DCustomMaterial::lineWidth

(

)

const

Definition at line 1633 of file qquick3dcustommaterial.cpp.

lineWidthChanged

void QQuick3DCustomMaterial::lineWidthChanged ( )

signal

markAllDirty()

void QQuick3DCustomMaterial::markAllDirty ( )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 1647 of file qquick3dcustommaterial.cpp.

markDirty()

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

staticprotected

Definition at line 1653 of file qquick3dcustommaterial.cpp.

Q_REVISION() [1/10]

QQuick3DCustomMaterial::Q_REVISION	(	6	,
		7	) const

Q_REVISION() [2/10]

QQuick3DCustomMaterial::Q_REVISION	(	6	,
		7	) const

Q_REVISION [3/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 7  )

signal

Q_REVISION [4/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 7  )

signal

Q_REVISION() [5/10]

QQuick3DCustomMaterial::Q_REVISION	(	6	,
		8	) const

Q_REVISION() [6/10]

QQuick3DCustomMaterial::Q_REVISION	(	6	,
		8	) const

Q_REVISION [7/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 8  )

signal

Q_REVISION [8/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 8  ) const &

slot

Q_REVISION [9/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 8  ) const &

slot

Q_REVISION [10/10]

QQuick3DCustomMaterial::Q_REVISION ( 6 , 8  )

signal

setAlwaysDirty

void QQuick3DCustomMaterial::setAlwaysDirty ( bool alwaysDirty )

slot

Definition at line 1666 of file qquick3dcustommaterial.cpp.

setDstBlend

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

slot

Definition at line 1517 of file qquick3dcustommaterial.cpp.

setFragmentShader

void QQuick3DCustomMaterial::setFragmentShader ( const QUrl & url )

slot

Definition at line 1592 of file qquick3dcustommaterial.cpp.

setLineWidth

void QQuick3DCustomMaterial::setLineWidth ( float width )

slot

Definition at line 1638 of file qquick3dcustommaterial.cpp.

setShadingMode

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

slot

Definition at line 1562 of file qquick3dcustommaterial.cpp.

setSrcBlend

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

slot

Definition at line 1502 of file qquick3dcustommaterial.cpp.

setVertexShader

void QQuick3DCustomMaterial::setVertexShader ( const QUrl & url )

slot

Definition at line 1577 of file qquick3dcustommaterial.cpp.

shadingMode()

QQuick3DCustomMaterial::ShadingMode QQuick3DCustomMaterial::shadingMode

(

)

const

Definition at line 1557 of file qquick3dcustommaterial.cpp.

shadingModeChanged

void QQuick3DCustomMaterial::shadingModeChanged ( )

signal

srcBlend()

QQuick3DCustomMaterial::BlendMode QQuick3DCustomMaterial::srcBlend

(

)

const

Definition at line 1497 of file qquick3dcustommaterial.cpp.

srcBlendChanged

void QQuick3DCustomMaterial::srcBlendChanged ( )

signal

updateSpatialNode()

QSSGRenderGraphObject * QQuick3DCustomMaterial::updateSpatialNode ( QSSGRenderGraphObject * node )

overrideprotectedvirtual

Reimplemented from QQuick3DObject.

Definition at line 1750 of file qquick3dcustommaterial.cpp.

vertexShader()

QUrl QQuick3DCustomMaterial::vertexShader

(

)

const

Definition at line 1572 of file qquick3dcustommaterial.cpp.

vertexShaderChanged

void QQuick3DCustomMaterial::vertexShaderChanged ( )

signal

Friends And Related Symbol Documentation

QQuick3DShaderUtilsTextureInput

friend class QQuick3DShaderUtilsTextureInput

friend

Definition at line 133 of file qquick3dcustommaterial_p.h.

QQuick3DViewport

friend class QQuick3DViewport

friend

Definition at line 134 of file qquick3dcustommaterial_p.h.

Property Documentation

__fragmentShaderCode

QString QQuick3DCustomMaterial::__fragmentShaderCode

readwrite

Definition at line 33 of file qquick3dcustommaterial_p.h.

__vertexShaderCode

QString QQuick3DCustomMaterial::__vertexShaderCode

readwrite

Definition at line 34 of file qquick3dcustommaterial_p.h.

alwaysDirty

bool QQuick3DCustomMaterial::alwaysDirty

readwrite

Definition at line 39 of file qquick3dcustommaterial_p.h.

destinationAlphaBlend

BlendMode QQuick3DCustomMaterial::destinationAlphaBlend

readwrite

Definition at line 38 of file qquick3dcustommaterial_p.h.

destinationBlend

BlendMode QQuick3DCustomMaterial::destinationBlend

readwrite

Definition at line 36 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 40 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 37 of file qquick3dcustommaterial_p.h.

sourceBlend

BlendMode QQuick3DCustomMaterial::sourceBlend

readwrite

Definition at line 35 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:

• qtquick3d/src/quick3d/qquick3dcustommaterial_p.h (e21661b2c7130796b4ca2427e49db1c3dc0ef0eb)
• qtquick3d/src/quick3d/qquick3dcustommaterial.cpp (0cb1e39dcd4e687335d69ff209a215923c9270f6)