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

#include <qquickgraphicsinfo_p.h>

Inheritance diagram for QQuickGraphicsInfo:
Collaboration diagram for QQuickGraphicsInfo:

Public Types

enum  GraphicsApi {
  Unknown = QSGRendererInterface::Unknown , Software = QSGRendererInterface::Software , OpenVG = QSGRendererInterface::OpenVG , OpenGL = QSGRendererInterface::OpenGL ,
  Direct3D11 = QSGRendererInterface::Direct3D11 , Vulkan = QSGRendererInterface::Vulkan , Metal = QSGRendererInterface::Metal , Null = QSGRendererInterface::Null ,
  Direct3D12 = QSGRendererInterface::Direct3D12 , OpenGLRhi = QSGRendererInterface::OpenGLRhi , Direct3D11Rhi = QSGRendererInterface::Direct3D11Rhi , VulkanRhi = QSGRendererInterface::VulkanRhi ,
  MetalRhi = QSGRendererInterface::MetalRhi , NullRhi = QSGRendererInterface::NullRhi
}
enum  ShaderType { UnknownShadingLanguage = QSGRendererInterface::UnknownShadingLanguage , GLSL = QSGRendererInterface::GLSL , HLSL = QSGRendererInterface::HLSL , RhiShader = QSGRendererInterface::RhiShader }
enum  ShaderCompilationType { RuntimeCompilation = QSGRendererInterface::RuntimeCompilation , OfflineCompilation = QSGRendererInterface::OfflineCompilation }
enum  ShaderSourceType { ShaderSourceString = QSGRendererInterface::ShaderSourceString , ShaderSourceFile = QSGRendererInterface::ShaderSourceFile , ShaderByteCode = QSGRendererInterface::ShaderByteCode }
enum  OpenGLContextProfile { OpenGLNoProfile = QSurfaceFormat::NoProfile , OpenGLCoreProfile = QSurfaceFormat::CoreProfile , OpenGLCompatibilityProfile = QSurfaceFormat::CompatibilityProfile }
enum  RenderableType { SurfaceFormatUnspecified = QSurfaceFormat::DefaultRenderableType , SurfaceFormatOpenGL = QSurfaceFormat::OpenGL , SurfaceFormatOpenGLES = QSurfaceFormat::OpenGLES }

Signals

void apiChanged ()
void shaderTypeChanged ()
void shaderCompilationTypeChanged ()
void shaderSourceTypeChanged ()
void majorVersionChanged ()
void minorVersionChanged ()
void profileChanged ()
void renderableTypeChanged ()
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

 QQuickGraphicsInfo (QQuickItem *item=nullptr)
 \qmltype GraphicsInfo \nativetype QQuickGraphicsInfo \inqmlmodule QtQuick
GraphicsApi api () const
ShaderType shaderType () const
ShaderCompilationType shaderCompilationType () const
ShaderSourceType shaderSourceType () const
int majorVersion () const
int minorVersion () const
OpenGLContextProfile profile () const
RenderableType renderableType () 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 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.

Static Public Member Functions

static QQuickGraphicsInfoqmlAttachedProperties (QObject *object)
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)

Properties

GraphicsApi api
ShaderType shaderType
ShaderCompilationType shaderCompilationType
ShaderSourceType shaderSourceType
int majorVersion
int minorVersion
OpenGLContextProfile profile
RenderableType renderableType
Properties inherited from QObject
QString objectName
 the name of this object

Additional Inherited Members

Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
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)
Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr

Detailed Description

Definition at line 31 of file qquickgraphicsinfo_p.h.

Member Enumeration Documentation

◆ GraphicsApi

Enumerator
Unknown 
Software 
OpenVG 
OpenGL 
Direct3D11 
Vulkan 
Metal 
Null 
Direct3D12 
OpenGLRhi 
Direct3D11Rhi 
VulkanRhi 
MetalRhi 
NullRhi 

Definition at line 50 of file qquickgraphicsinfo_p.h.

◆ OpenGLContextProfile

Enumerator
OpenGLNoProfile 
OpenGLCoreProfile 
OpenGLCompatibilityProfile 

Definition at line 90 of file qquickgraphicsinfo_p.h.

◆ RenderableType

Enumerator
SurfaceFormatUnspecified 
SurfaceFormatOpenGL 
SurfaceFormatOpenGLES 

Definition at line 97 of file qquickgraphicsinfo_p.h.

◆ ShaderCompilationType

Enumerator
RuntimeCompilation 
OfflineCompilation 

Definition at line 77 of file qquickgraphicsinfo_p.h.

◆ ShaderSourceType

Enumerator
ShaderSourceString 
ShaderSourceFile 
ShaderByteCode 

Definition at line 83 of file qquickgraphicsinfo_p.h.

◆ ShaderType

Enumerator
UnknownShadingLanguage 
GLSL 
HLSL 
RhiShader 

Definition at line 69 of file qquickgraphicsinfo_p.h.

Constructor & Destructor Documentation

◆ QQuickGraphicsInfo()

QT_BEGIN_NAMESPACE QQuickGraphicsInfo::QQuickGraphicsInfo ( QQuickItem * item = nullptr)

\qmltype GraphicsInfo \nativetype QQuickGraphicsInfo \inqmlmodule QtQuick

Since
5.8
QtQuick 2.8

Provides information about the scenegraph backend and the graphics API used by Qt Quick.

The GraphicsInfo attached type provides information about the scenegraph backend and the graphics API used to render the contents of the associated window.

If the item to which the properties are attached is not currently associated with any window, the properties are set to default values. When the associated window changes, the properties will update.

Definition at line 28 of file qquickgraphicsinfo.cpp.

References item.

Member Function Documentation

◆ api()

GraphicsApi QQuickGraphicsInfo::api ( ) const
inline

Definition at line 108 of file qquickgraphicsinfo_p.h.

◆ apiChanged

void QQuickGraphicsInfo::apiChanged ( )
signal

◆ majorVersion()

int QQuickGraphicsInfo::majorVersion ( ) const
inline

Definition at line 113 of file qquickgraphicsinfo_p.h.

◆ majorVersionChanged

void QQuickGraphicsInfo::majorVersionChanged ( )
signal

◆ minorVersion()

int QQuickGraphicsInfo::minorVersion ( ) const
inline

Definition at line 114 of file qquickgraphicsinfo_p.h.

◆ minorVersionChanged

void QQuickGraphicsInfo::minorVersionChanged ( )
signal

◆ profile()

OpenGLContextProfile QQuickGraphicsInfo::profile ( ) const
inline

Definition at line 115 of file qquickgraphicsinfo_p.h.

◆ profileChanged

void QQuickGraphicsInfo::profileChanged ( )
signal

◆ qmlAttachedProperties()

QQuickGraphicsInfo * QQuickGraphicsInfo::qmlAttachedProperties ( QObject * object)
static

Definition at line 46 of file qquickgraphicsinfo.cpp.

◆ renderableType()

RenderableType QQuickGraphicsInfo::renderableType ( ) const
inline

Definition at line 116 of file qquickgraphicsinfo_p.h.

◆ renderableTypeChanged

void QQuickGraphicsInfo::renderableTypeChanged ( )
signal

◆ shaderCompilationType()

ShaderCompilationType QQuickGraphicsInfo::shaderCompilationType ( ) const
inline

Definition at line 110 of file qquickgraphicsinfo_p.h.

◆ shaderCompilationTypeChanged

void QQuickGraphicsInfo::shaderCompilationTypeChanged ( )
signal

◆ shaderSourceType()

ShaderSourceType QQuickGraphicsInfo::shaderSourceType ( ) const
inline

Definition at line 111 of file qquickgraphicsinfo_p.h.

◆ shaderSourceTypeChanged

void QQuickGraphicsInfo::shaderSourceTypeChanged ( )
signal

◆ shaderType()

ShaderType QQuickGraphicsInfo::shaderType ( ) const
inline

Definition at line 109 of file qquickgraphicsinfo_p.h.

◆ shaderTypeChanged

void QQuickGraphicsInfo::shaderTypeChanged ( )
signal

Property Documentation

◆ api

GraphicsApi QQuickGraphicsInfo::api
read

Definition at line 34 of file qquickgraphicsinfo_p.h.

◆ majorVersion

int QQuickGraphicsInfo::majorVersion
read

Definition at line 39 of file qquickgraphicsinfo_p.h.

◆ minorVersion

int QQuickGraphicsInfo::minorVersion
read

Definition at line 40 of file qquickgraphicsinfo_p.h.

◆ profile

OpenGLContextProfile QQuickGraphicsInfo::profile
read

Definition at line 41 of file qquickgraphicsinfo_p.h.

◆ renderableType

RenderableType QQuickGraphicsInfo::renderableType
read

Definition at line 42 of file qquickgraphicsinfo_p.h.

◆ shaderCompilationType

ShaderCompilationType QQuickGraphicsInfo::shaderCompilationType
read

Definition at line 36 of file qquickgraphicsinfo_p.h.

◆ shaderSourceType

ShaderSourceType QQuickGraphicsInfo::shaderSourceType
read

Definition at line 37 of file qquickgraphicsinfo_p.h.

◆ shaderType

ShaderType QQuickGraphicsInfo::shaderType
read

Definition at line 35 of file qquickgraphicsinfo_p.h.


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