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

#include <qsgopenvgcontext_p.h>

Inheritance diagram for QSGOpenVGRenderContext:
Collaboration diagram for QSGOpenVGRenderContext:

Classes

struct  InitParams

Public Member Functions

 QSGOpenVGRenderContext (QSGContext *context)
void initialize (const QSGRenderContext::InitParams *params) override
void invalidate () override
void renderNextFrame (QSGRenderer *renderer) override
QSGTexture * createTexture (const QImage &image, uint flags) const override
QSGRenderer * createRenderer (QSGRendererInterface::RenderMode renderMode=QSGRendererInterface::RenderMode2D) override
int maxTextureSize () const override
GraphicsApi graphicsApi () const override
 Returns the graphics API that is in use by the Qt Quick scenegraph.
ShaderType shaderType () const override
ShaderCompilationTypes shaderCompilationType () const override
ShaderSourceTypes shaderSourceType () const override
QOpenVGContext * vgContext ()
QSGOpenVGFontGlyphCache * glyphCache (const QRawFont &rawFont)
Public Member Functions inherited from QSGRenderContext
 QSGRenderContext (QSGContext *context)
 ~QSGRenderContext () override
QSGContext * sceneGraphContext () const
virtual bool isValid () const
virtual void prepareSync (qreal devicePixelRatio, QRhiCommandBuffer *cb, const QQuickGraphicsConfiguration &config)
virtual void beginNextFrame (QSGRenderer *renderer, const QSGRenderTarget &renderTarget, RenderPassCallback mainPassRecordingStart, RenderPassCallback mainPassRecordingEnd, void *callbackUserData)
virtual void endNextFrame (QSGRenderer *renderer)
virtual void endSync ()
virtual void preprocess ()
 Do necessary preprocessing before the frame.
virtual void invalidateGlyphCaches ()
virtual void flushGlyphCaches ()
virtual QSGDistanceFieldGlyphCache * distanceFieldGlyphCache (const QRawFont &font, int renderTypeQuality)
 Factory function for scene graph backends of the distance-field glyph cache.
virtual QSGCurveGlyphAtlas * curveGlyphAtlas (const QRawFont &font)
 Factory function for curve atlases that can be used to provide geometry for the curve renderer for a given font.
QSGTexture * textureForFactory (QQuickTextureFactory *factory, QQuickWindow *window)
 Factory function for the scene graph renderers.
virtual QSGTexture * compressedTextureForFactory (const QSGCompressedTextureFactory *) const
 Return the texture corresponding to a texture factory.
void unregisterFontengineForCleanup (QFontEngine *engine)
void registerFontengineForCleanup (QFontEngine *engine)
virtual QRhi * rhi () 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 QSGRendererInterface
virtual ~QSGRendererInterface ()
virtual void * getResource (QQuickWindow *window, Resource resource) const
virtual void * getResource (QQuickWindow *window, const char *resource) const
 Queries a graphics resource.

Static Public Attributes

static const int INIT_PARAMS_MAGIC = 0x51E

Additional Inherited Members

Public Types inherited from QSGRenderContext
enum  CreateTextureFlags { CreateTexture_Alpha = 0x1 , CreateTexture_Atlas = 0x2 , CreateTexture_Mipmap = 0x4 }
using RenderPassCallback = void (*)(void *)
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 QSGRenderContext
void textureFactoryDestroyed (QObject *o)
Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
Signals inherited from QSGRenderContext
void initialized ()
void invalidated ()
void releaseCachedResourcesRequested ()
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 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 QSGRenderContext
QPointer< QSGContext > m_sg
QMutex m_mutex
QHash< QObject *, QSGTexture * > m_textures
QSet< QSGTexture * > m_texturesToDelete
QHash< FontKey, QSGDistanceFieldGlyphCache * > m_glyphCaches
QList< QSGDistanceFieldGlyphCache * > m_staleGlyphCaches
QHash< QFontEngine *, int > m_fontEnginesToClean
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
 Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.
 \macro Q_CLASSINFO(Name, Value)

Detailed Description

Definition at line 18 of file qsgopenvgcontext_p.h.

Constructor & Destructor Documentation

◆ QSGOpenVGRenderContext()

QT_BEGIN_NAMESPACE QSGOpenVGRenderContext::QSGOpenVGRenderContext ( QSGContext * context)

Definition at line 27 of file qsgopenvgcontext.cpp.

Member Function Documentation

◆ createRenderer()

QSGRenderer * QSGOpenVGRenderContext::createRenderer ( QSGRendererInterface::RenderMode renderMode = QSGRendererInterface::RenderMode2D)
overridevirtual

Implements QSGRenderContext.

Definition at line 73 of file qsgopenvgcontext.cpp.

◆ createTexture()

QSGTexture * QSGOpenVGRenderContext::createTexture ( const QImage & image,
uint flags ) const
overridevirtual

Implements QSGRenderContext.

Definition at line 60 of file qsgopenvgcontext.cpp.

References maxTextureSize().

Here is the call graph for this function:

◆ glyphCache()

QSGOpenVGFontGlyphCache * QSGOpenVGRenderContext::glyphCache ( const QRawFont & rawFont)

Definition at line 179 of file qsgopenvgcontext.cpp.

◆ graphicsApi()

QSGRendererInterface::GraphicsApi QSGOpenVGRenderContext::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 159 of file qsgopenvgcontext.cpp.

◆ initialize()

void QSGOpenVGRenderContext::initialize ( const QSGRenderContext::InitParams * params)
overridevirtual

Reimplemented from QSGRenderContext.

Definition at line 35 of file qsgopenvgcontext.cpp.

References INIT_PARAMS_MAGIC, and QSGOpenVGRenderContext::InitParams::sType.

◆ invalidate()

void QSGOpenVGRenderContext::invalidate ( )
overridevirtual

Reimplemented from QSGRenderContext.

Definition at line 46 of file qsgopenvgcontext.cpp.

◆ maxTextureSize()

int QSGOpenVGRenderContext::maxTextureSize ( ) const
overridevirtual

Implements QSGRenderContext.

Definition at line 139 of file qsgopenvgcontext.cpp.

Referenced by createTexture().

Here is the caller graph for this function:

◆ renderNextFrame()

void QSGOpenVGRenderContext::renderNextFrame ( QSGRenderer * renderer)
overridevirtual

Implements QSGRenderContext.

Definition at line 55 of file qsgopenvgcontext.cpp.

◆ shaderCompilationType()

QSGRendererInterface::ShaderCompilationTypes QSGOpenVGRenderContext::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 169 of file qsgopenvgcontext.cpp.

◆ shaderSourceType()

QSGRendererInterface::ShaderSourceTypes QSGOpenVGRenderContext::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 174 of file qsgopenvgcontext.cpp.

◆ shaderType()

QSGRendererInterface::ShaderType QSGOpenVGRenderContext::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 164 of file qsgopenvgcontext.cpp.

◆ vgContext()

QOpenVGContext * QSGOpenVGRenderContext::vgContext ( )
inline

Definition at line 43 of file qsgopenvgcontext_p.h.

Member Data Documentation

◆ INIT_PARAMS_MAGIC

const int QSGOpenVGRenderContext::INIT_PARAMS_MAGIC = 0x51E
static

Definition at line 24 of file qsgopenvgcontext_p.h.

Referenced by initialize().

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