From 1a0b8328c2d9ec82333b483e99b1b8560fbf468f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tor=20Arne=20Vestb=C3=B8?= Date: Thu, 15 Oct 2020 14:32:03 +0200 Subject: doc: Group QSGTexture native interfaces Change-Id: I1b305bf1b74e7e7a078d7bd4b1358d773f5d2580 Reviewed-by: Venugopal Shivashankar --- src/quick/scenegraph/coreapi/qsgtexture.cpp | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) (limited to 'src/quick/scenegraph') diff --git a/src/quick/scenegraph/coreapi/qsgtexture.cpp b/src/quick/scenegraph/coreapi/qsgtexture.cpp index 859118ae66..fc44de7eeb 100644 --- a/src/quick/scenegraph/coreapi/qsgtexture.cpp +++ b/src/quick/scenegraph/coreapi/qsgtexture.cpp @@ -694,8 +694,11 @@ QSGDynamicTexture::QSGDynamicTexture(QSGTexturePrivate &dd) Returns a native interface of the given type for the texture. This function provides access to platform specific functionality of - QSGTexture, as defined in the QNativeInterface namespace. This allows - accessing the underlying native texture object, such as, the \c GLuint + QSGTexture, as declared in the QNativeInterface namespace: + + \annotatedlist native-interfaces-qsgtexture + + This allows accessing the underlying native texture object, such as, the \c GLuint texture ID with OpenGL, or the \c VkImage handle with Vulkan. If the requested interface is not available a \nullptr is returned. @@ -707,6 +710,8 @@ namespace QNativeInterface { /*! \class QNativeInterface::QSGOpenGLTexture \inmodule QtQuick + \ingroup native-interfaces + \ingroup native-interfaces-qsgtexture \brief Provides access to and enables adopting OpenGL texture objects. \since 6.0 */ @@ -772,6 +777,8 @@ namespace QNativeInterface { /*! \class QNativeInterface::QSGD3D11Texture \inmodule QtQuick + \ingroup native-interfaces + \ingroup native-interfaces-qsgtexture \brief Provides access to and enables adopting Direct3D 11 texture objects. \since 6.0 */ @@ -836,6 +843,8 @@ namespace QNativeInterface { /*! \class QNativeInterface::QSGMetalTexture \inmodule QtQuick + \ingroup native-interfaces + \ingroup native-interfaces-qsgtexture \brief Provides access to and enables adopting Metal texture objects. \since 6.0 */ @@ -887,6 +896,8 @@ namespace QNativeInterface { /*! \class QNativeInterface::QSGVulkanTexture \inmodule QtQuick + \ingroup native-interfaces + \ingroup native-interfaces-qsgtexture \brief Provides access to and enables adopting Vulkan image objects. \since 6.0 */ -- cgit v1.2.3