diff options
author | Laszlo Agocs <laszlo.agocs@qt.io> | 2019-09-16 16:43:53 +0200 |
---|---|---|
committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2019-09-18 04:27:57 +0200 |
commit | 262bf5c458f83491b7060c1d01ae37ca0cf1a457 (patch) | |
tree | 00e8e2be70694509cebc3a2fdabb849b295249f9 | |
parent | 5d3589b30f1181d1a945902bf8915f1170e457b9 (diff) |
Add some missing since and internal doc tags
Change-Id: I50c6a5c7a55cfc481ff572113c58951983671cdc
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
-rw-r--r-- | src/quick/scenegraph/coreapi/qsgrendererinterface.cpp | 34 | ||||
-rw-r--r-- | src/quick/scenegraph/coreapi/qsgtexture.cpp | 3 |
2 files changed, 23 insertions, 14 deletions
diff --git a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp index bc68199e08..0fee1486cf 100644 --- a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp +++ b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp @@ -78,11 +78,11 @@ QT_BEGIN_NAMESPACE \value OpenGL OpenGL ES 2.0 or higher \value Direct3D12 Direct3D 12 \value OpenVG OpenVG via EGL - \value OpenGLRhi OpenGL ES 2.0 or higher via a graphics abstraction layer - \value Direct3D11Rhi Direct3D 11 via a graphics abstraction layer - \value VulkanRhi Vulkan 1.0 via a graphics abstraction layer - \value MetalRhi Metal via a graphics abstraction layer - \value NullRhi Null (no output) via a graphics abstraction layer + \value OpenGLRhi OpenGL ES 2.0 or higher via a graphics abstraction layer. This value was introduced in Qt 5.14. + \value Direct3D11Rhi Direct3D 11 via a graphics abstraction layer. This value was introduced in Qt 5.14. + \value VulkanRhi Vulkan 1.0 via a graphics abstraction layer. This value was introduced in Qt 5.14. + \value MetalRhi Metal via a graphics abstraction layer. This value was introduced in Qt 5.14. + \value NullRhi Null (no output) via a graphics abstraction layer. This value was introduced in Qt 5.14. */ /*! @@ -111,33 +111,36 @@ QT_BEGIN_NAMESPACE used by the scenegraph, when running with the software backend. \value RhiResource The resource is a pointer to the QRhi instance used by - the scenegraph, when applicable. + the scenegraph, when applicable. This value was introduced in Qt 5.14. \value PhysicalDeviceResource The resource is a pointer to the pysical device object used by the scenegraph, when applicable. For example, a \c{VkPhysicalDevice *}. Note that with Vulkan the returned value is a - pointer to the VkPhysicalDevice, not the handle itself. + pointer to the VkPhysicalDevice, not the handle itself. This value was + introduced in Qt 5.14. \value OpenGLContextResource The resource is a pointer to the QOpenGLContext used by the scenegraph (on the render thread), when - applicable. + applicable. This value was introduced in Qt 5.14. \value DeviceContextResource The resource is a pointer to the device context used by the scenegraph, when applicable. For example, a - \c{ID3D11DeviceContext *}. + \c{ID3D11DeviceContext *}. This value was introduced in Qt 5.14. \value CommandEncoderResource The resource is a pointer to the currently active render command encoder object used by the scenegraph, when applicable. For example, a \c{MTLRenderCommandEncoder *}. This object has limited validity, and is only valid while the scene graph is recording a - render pass for the next frame. + render pass for the next frame. This value was introduced in Qt 5.14. \value VulkanInstanceResource The resource is a pointer to the - QVulkanInstance used by the scenegraph, when applicable. + QVulkanInstance used by the scenegraph, when applicable. This value was + introduced in Qt 5.14. \value RenderPassResource The resource is a pointer to the render pass used by the scenegraph, describing the color and depth/stecil attachments and - how they are used. For example, a \c{VkRenderPass *}. + how they are used. For example, a \c{VkRenderPass *}. This value was + introduced in Qt 5.14. */ /*! @@ -145,8 +148,9 @@ QT_BEGIN_NAMESPACE \value UnknownShadingLanguage Not yet known due to no window and scenegraph associated \value GLSL GLSL or GLSL ES \value HLSL HLSL - \value RhiShader Consumes QShader instances containing shader - variants for multiple target languages and bytecode formats + \value RhiShader Consumes QShader instances containing shader variants for + multiple target languages and intermediate formats. This value was introduced in + Qt 5.14. */ /*! @@ -222,6 +226,8 @@ void *QSGRendererInterface::getResource(QQuickWindow *window, const char *resour instead of directly calling the native graphics API. \note This function can be called on any thread. + + \since 5.14 */ bool QSGRendererInterface::isApiRhiBased(GraphicsApi api) { diff --git a/src/quick/scenegraph/coreapi/qsgtexture.cpp b/src/quick/scenegraph/coreapi/qsgtexture.cpp index c47401e5c0..edcee96bdb 100644 --- a/src/quick/scenegraph/coreapi/qsgtexture.cpp +++ b/src/quick/scenegraph/coreapi/qsgtexture.cpp @@ -717,6 +717,9 @@ void QSGTexture::updateRhiTexture(QRhi *rhi, QRhiResourceUpdateBatch *resourceUp d->updateRhiTexture(rhi, resourceUpdates); } +/*! + \internal + */ void QSGTexture::setWorkResourceUpdateBatch(QRhiResourceUpdateBatch *resourceUpdates) { Q_D(QSGTexture); |