#include <qsgdefaultcontext_p.h>

Inheritance diagram for QSGDefaultContext:

Collaboration diagram for QSGDefaultContext:

Public Member Functions
	QSGDefaultContext (QObject *parent=nullptr)

	~QSGDefaultContext ()

void	renderContextInitialized (QSGRenderContext *renderContext) override

void	renderContextInvalidated (QSGRenderContext *) override

QSGRenderContext *	createRenderContext () override

QSGInternalRectangleNode *	createInternalRectangleNode () override

QSGInternalImageNode *	createInternalImageNode (QSGRenderContext *renderContext) override

QSGPainterNode *	createPainterNode (QQuickPaintedItem *item) override

QSGGlyphNode *	createGlyphNode (QSGRenderContext *rc, QSGTextNode::RenderType renderType, int renderTypeQuality) override

QSGInternalTextNode *	createInternalTextNode (QSGRenderContext *renderContext) override

QSGLayer *	createLayer (QSGRenderContext *renderContext) override

QSurfaceFormat	defaultSurfaceFormat () const override

QSGRendererInterface *	rendererInterface (QSGRenderContext *renderContext) override
	Returns a pointer to the (presumably) global renderer interface.

QSGRectangleNode *	createRectangleNode () override

QSGImageNode *	createImageNode () override

QSGNinePatchNode *	createNinePatchNode () override

QSGGuiThreadShaderEffectManager *	createGuiThreadShaderEffectManager () override
	Creates a new shader effect helper instance.

QSGShaderEffectNode *	createShaderEffectNode (QSGRenderContext *renderContext) override
	Creates a new shader effect node.

void	setDistanceFieldEnabled (bool enabled)

bool	isDistanceFieldEnabled () const

GraphicsApi	graphicsApi () const override
	Returns the graphics API that is in use by the Qt Quick scenegraph.

void *	getResource (QQuickWindow *window, Resource resource) const override
	Queries a graphics resource in window.

ShaderType	shaderType () const override

ShaderCompilationTypes	shaderCompilationType () const override

ShaderSourceTypes	shaderSourceType () const override

Public Member Functions inherited from QSGContext
	QSGContext (QObject *parent=nullptr)

	~QSGContext () override

QSGInternalRectangleNode *	createInternalRectangleNode (const QRectF &rect, const QColor &c)
	Convenience factory function for creating a colored rectangle with the given geometry.

virtual QAnimationDriver *	createAnimationDriver (QObject *parent)
	Creates a new animation driver.

virtual float	vsyncIntervalForAnimationDriver (QAnimationDriver *driver)

virtual bool	isVSyncDependent (QAnimationDriver *driver)

virtual QSize	minimumFBOSize () const

virtual QSGTextNode *	createTextNode (QSGRenderContext *renderContext)

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	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 QSGRendererInterface
virtual	~QSGRendererInterface ()

virtual void *	getResource (QQuickWindow window, const char resource) const
	Queries a graphics resource.

Additional Inherited Members
Public Types inherited from QSGContext
enum	AntialiasingMethod { UndecidedAntialiasing , VertexAntialiasing , MsaaAntialiasing }

Public Types inherited from QSGRendererInterface
enum	GraphicsApi { Unknown , Software , OpenVG , OpenGL , Direct3D11 , Vulkan , Metal , Null , Direct3D12 , OpenGLRhi = OpenGL , Direct3D11Rhi = Direct3D11 , VulkanRhi = Vulkan , MetalRhi = Metal , NullRhi = Null }
	\value Unknown An unknown graphics API is in use \value Software The Qt Quick 2D Renderer is in use \value OpenVG OpenVG via EGL \value [since 5.14] OpenGL OpenGL ES 2.0 or higher via a graphics abstraction layer. More...

enum	Resource { DeviceResource , CommandQueueResource , CommandListResource , PainterResource , RhiResource , RhiSwapchainResource , RhiRedirectCommandBuffer , RhiRedirectRenderTarget , PhysicalDeviceResource , OpenGLContextResource , DeviceContextResource , CommandEncoderResource , VulkanInstanceResource , RenderPassResource , RedirectPaintDevice , GraphicsQueueFamilyIndexResource , GraphicsQueueIndexResource }
	\value DeviceResource The resource is a pointer to the graphics device, when applicable. More...

enum	ShaderType { UnknownShadingLanguage , GLSL , HLSL , RhiShader }
	\value UnknownShadingLanguage Not yet known due to no window and scenegraph associated \value GLSL GLSL or GLSL ES \value HLSL HLSL \value [since 5.14] RhiShader Consumes QShader instances containing shader variants for multiple target languages and intermediate formats. More...

enum	ShaderCompilationType { RuntimeCompilation = 0x01 , OfflineCompilation = 0x02 }
	\value RuntimeCompilation Runtime compilation of shader source code is supported \value OfflineCompilation Pre-compiled bytecode supported More...

enum	ShaderSourceType { ShaderSourceString = 0x01 , ShaderSourceFile = 0x02 , ShaderByteCode = 0x04 }
	\value ShaderSourceString Shader source can be provided as a string in the corresponding properties of ShaderEffect More...

enum	RenderMode { RenderMode2D , RenderMode2DNoDepthBuffer , RenderMode3D }
	\value RenderMode2D Normal 2D rendering \value RenderMode2DNoDepthBuffer Normal 2D rendering with depth buffer disabled \value RenderMode3D Scene is rendered as part of a 3D graph More...

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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 QSGContext
static QSGContext *	createDefaultContext ()
	Creates a default scene graph context for the current hardware.

static QQuickTextureFactory *	createTextureFactoryFromImage (const QImage &image)
	Calls into the scene graph adaptation if available and creates a texture factory.

static QSGRenderLoop *	createWindowManager ()
	Calls into the scene graph adaptation if available and creates a hardware specific window manager.

static void	setBackend (const QString &backend)

static QString	backend ()

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)

Static Public Member Functions inherited from QSGRendererInterface
static bool	isApiRhiBased (GraphicsApi api)

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 Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Properties inherited from QObject
QString	objectName
	the name of this object

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 24 of file qsgdefaultcontext_p.h.

Constructor & Destructor Documentation

◆ QSGDefaultContext()

QSGDefaultContext::QSGDefaultContext ( QObject * parent = nullptr )

Definition at line 54 of file qsgdefaultcontext.cpp.

References QSGGlyphNode::GrayAntialiasing, QSGGlyphNode::HighQualitySubPixelAntialiasing, QSGGlyphNode::LowQualitySubPixelAntialiasing, Q_UNLIKELY, qEnvironmentVariableIsEmpty(), qEnvironmentVariableIsSet(), qgetenv(), and QtDebugMsg.

Here is the call graph for this function:

◆ ~QSGDefaultContext()

QSGDefaultContext::~QSGDefaultContext ( )

Definition at line 82 of file qsgdefaultcontext.cpp.

Member Function Documentation

◆ createGlyphNode()

QSGGlyphNode * QSGDefaultContext::createGlyphNode	(	QSGRenderContext *	rc,
		QSGTextNode::RenderType	renderType,
		int	renderTypeQuality )

overridevirtual

Implements QSGContext.

Definition at line 155 of file qsgdefaultcontext.cpp.

References QSGTextNode::CurveRendering, QSGTextNode::NativeRendering, QSGDistanceFieldGlyphNode::setPreferredAntialiasingMode(), and QSGDistanceFieldGlyphNode::setRenderTypeQuality().

Here is the call graph for this function:

◆ createGuiThreadShaderEffectManager()

QSGGuiThreadShaderEffectManager * QSGDefaultContext::createGuiThreadShaderEffectManager ( )

overridevirtual

Creates a new shader effect helper instance.

This function is called on the GUI thread, unlike the others. This is necessary in order to provide adaptable, backend-specific shader effect functionality to the GUI thread too.

Reimplemented from QSGContext.

Definition at line 241 of file qsgdefaultcontext.cpp.

◆ createImageNode()

QSGImageNode * QSGDefaultContext::createImageNode ( )

overridevirtual

Implements QSGContext.

Definition at line 224 of file qsgdefaultcontext.cpp.

◆ createInternalImageNode()

QSGInternalImageNode * QSGDefaultContext::createInternalImageNode ( QSGRenderContext * renderContext )

overridevirtual

Implements QSGContext.

Definition at line 138 of file qsgdefaultcontext.cpp.

References QSGContext::MsaaAntialiasing.

◆ createInternalRectangleNode()

QSGInternalRectangleNode * QSGDefaultContext::createInternalRectangleNode ( )

overridevirtual

Implements QSGContext.

Definition at line 131 of file qsgdefaultcontext.cpp.

References QSGContext::MsaaAntialiasing.

◆ createInternalTextNode()

QSGInternalTextNode * QSGDefaultContext::createInternalTextNode ( QSGRenderContext * renderContext )

overridevirtual

Reimplemented from QSGContext.

Definition at line 150 of file qsgdefaultcontext.cpp.

◆ createLayer()

QSGLayer * QSGDefaultContext::createLayer ( QSGRenderContext * renderContext )

overridevirtual

Implements QSGContext.

Definition at line 171 of file qsgdefaultcontext.cpp.

◆ createNinePatchNode()

QSGNinePatchNode * QSGDefaultContext::createNinePatchNode ( )

overridevirtual

Implements QSGContext.

Definition at line 229 of file qsgdefaultcontext.cpp.

◆ createPainterNode()

QSGPainterNode * QSGDefaultContext::createPainterNode ( QQuickPaintedItem * item )

overridevirtual

Implements QSGContext.

Definition at line 145 of file qsgdefaultcontext.cpp.

References item.

◆ createRectangleNode()

QSGRectangleNode * QSGDefaultContext::createRectangleNode ( )

overridevirtual

Implements QSGContext.

Definition at line 219 of file qsgdefaultcontext.cpp.

◆ createRenderContext()

QSGRenderContext * QSGDefaultContext::createRenderContext ( )

overridevirtual

Implements QSGContext.

Definition at line 126 of file qsgdefaultcontext.cpp.

◆ createShaderEffectNode()

QSGShaderEffectNode * QSGDefaultContext::createShaderEffectNode ( QSGRenderContext * renderContext )

overridevirtual

Creates a new shader effect node.

The default of returning nullptr is valid as long as the backend does not claim SupportsShaderEffectNode or ignoring ShaderEffect elements is acceptable.

Reimplemented from QSGContext.

Definition at line 246 of file qsgdefaultcontext.cpp.

◆ defaultSurfaceFormat()

QSurfaceFormat QSGDefaultContext::defaultSurfaceFormat ( ) const

overridevirtual

Implements QSGContext.

Definition at line 176 of file qsgdefaultcontext.cpp.

References QSurfaceFormat::DebugContext, QSurfaceFormat::defaultFormat(), QSurfaceFormat::DoubleBuffer, qEnvironmentVariableIsEmpty(), and qEnvironmentVariableIsSet().

Here is the call graph for this function:

◆ getResource()

void * QSGDefaultContext::getResource	(	QQuickWindow *	window,
		Resource	resource ) const

overridevirtual

Queries a graphics resource in window.

Returns null when the resource in question is not supported or not available.

When successful, the returned pointer is either a direct pointer to an interface, or a pointer to an opaque handle that needs to be dereferenced first (for example, {VkDevice dev = *static_cast<VkDevice >(result)}). The latter is necessary since such handles may have sizes different from a pointer.

Note: The ownership of the returned pointer is never transferred to the caller.; This function must only be called on the render thread.

Reimplemented from QSGRendererInterface.

Definition at line 256 of file qsgdefaultcontext.cpp.

References QQuickWindowPrivate::get(), QSGRhiSupport::instance(), QSGRhiSupport::rifResource(), QSGRendererInterface::VulkanInstanceResource, and window().

Here is the call graph for this function:

◆ graphicsApi()

QSGRendererInterface::GraphicsApi QSGDefaultContext::graphicsApi ( ) const

overridevirtual

Returns the graphics API that is in use by the Qt Quick scenegraph.

Note: This function can be called on any thread.

Implements QSGRendererInterface.

Definition at line 251 of file qsgdefaultcontext.cpp.

References QSGRhiSupport::instance().

Here is the call graph for this function:

◆ isDistanceFieldEnabled()

bool QSGDefaultContext::isDistanceFieldEnabled ( ) const

Definition at line 208 of file qsgdefaultcontext.cpp.

◆ renderContextInitialized()

void QSGDefaultContext::renderContextInitialized ( QSGRenderContext * renderContext )

overridevirtual

Reimplemented from QSGContext.

Definition at line 87 of file qsgdefaultcontext.cpp.

References QSGGlyphNode::GrayAntialiasing, QMutex::lock(), QSGContext::MsaaAntialiasing, QRhi::OpenGLES2, Q_ASSERT, Q_UNLIKELY, qEnvironmentVariableIsSet(), qgetenv(), QSGContext::UndecidedAntialiasing, QMutex::unlock(), and QSGContext::VertexAntialiasing.

Here is the call graph for this function:

◆ renderContextInvalidated()

void QSGDefaultContext::renderContextInvalidated ( QSGRenderContext * )

overridevirtual

Reimplemented from QSGContext.

Definition at line 122 of file qsgdefaultcontext.cpp.

◆ rendererInterface()

QSGRendererInterface * QSGDefaultContext::rendererInterface ( QSGRenderContext * renderContext )

overridevirtual

Returns a pointer to the (presumably) global renderer interface.

Note: This function may be called on the GUI thread in order to get access to QSGRendererInterface::graphicsApi() and other getters.; it is expected that the simple queries (graphicsApi, shaderType, etc.) are available regardless of the render context validity (i.e. scenegraph status). This does not apply to engine-specific getters like getResource(). In the end this means that this function must always return a valid object in subclasses, even when renderContext->isValid() is false. The typical pattern is to implement the QSGRendererInterface in the QSGContext or QSGRenderContext subclass itself, whichever is more suitable.

Reimplemented from QSGContext.

Definition at line 213 of file qsgdefaultcontext.cpp.

References Q_UNUSED.

◆ setDistanceFieldEnabled()

void QSGDefaultContext::setDistanceFieldEnabled ( bool enabled )

Definition at line 203 of file qsgdefaultcontext.cpp.

References enabled.

◆ shaderCompilationType()

QSGRendererInterface::ShaderCompilationTypes QSGDefaultContext::shaderCompilationType ( ) const

overridevirtual

Returns: a bitmask of the shader compilation approaches supported by the Qt Quick backend the application is using.

Note: This function can be called on any thread.

See also: QtQuick::GraphicsInfo

Implements QSGRendererInterface.

Definition at line 283 of file qsgdefaultcontext.cpp.

References QSGRendererInterface::OfflineCompilation.

◆ shaderSourceType()

QSGRendererInterface::ShaderSourceTypes QSGDefaultContext::shaderSourceType ( ) const

overridevirtual

Returns: a bitmask of the supported ways of providing shader sources in ShaderEffect items.

Note: This function can be called on any thread.

See also: QtQuick::GraphicsInfo

Implements QSGRendererInterface.

Definition at line 288 of file qsgdefaultcontext.cpp.

References QSGRendererInterface::ShaderSourceFile.

◆ shaderType()

QSGRendererInterface::ShaderType QSGDefaultContext::shaderType ( ) const

overridevirtual

Returns: the shading language supported by the Qt Quick backend the application is using.

Note: This function can be called on any thread.

See also: QtQuick::GraphicsInfo

Implements QSGRendererInterface.

Definition at line 278 of file qsgdefaultcontext.cpp.

References QSGRendererInterface::RhiShader.

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

qtdeclarative/src/quick/scenegraph/qsgdefaultcontext_p.h (9dd45fff835a7c261dacc9ee6239d42ef1a74bbe)
qtdeclarative/src/quick/scenegraph/qsgdefaultcontext.cpp (3acc52f3d5eefdb17264c06aa6311b65e230d932)

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QSGDefaultContext()

◆ ~QSGDefaultContext()

Member Function Documentation

◆ createGlyphNode()

◆ createGuiThreadShaderEffectManager()

◆ createImageNode()

◆ createInternalImageNode()

◆ createInternalRectangleNode()

◆ createInternalTextNode()

◆ createLayer()

◆ createNinePatchNode()

◆ createPainterNode()

◆ createRectangleNode()

◆ createRenderContext()

◆ createShaderEffectNode()

◆ defaultSurfaceFormat()

◆ getResource()

◆ graphicsApi()

◆ isDistanceFieldEnabled()

◆ renderContextInitialized()

◆ renderContextInvalidated()

◆ rendererInterface()

◆ setDistanceFieldEnabled()

◆ shaderCompilationType()

◆ shaderSourceType()

◆ shaderType()