aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp
diff options
context:
space:
mode:
authorLaszlo Agocs <laszlo.agocs@qt.io>2016-06-24 13:41:51 +0200
committerLaszlo Agocs <laszlo.agocs@qt.io>2016-06-24 17:56:15 +0000
commit1d872f7ed1c9e0e8b4f34f4449ad7393f5afbec2 (patch)
treea861d8d62923e3786576bd821f403de39a6d1117 /src/quick/scenegraph/coreapi/qsgrendererinterface.cpp
parentfaa9ef7ce14ad0342ab464461f33365fcd1c7a1e (diff)
Fix up QSGRendererInterface docs
Some enums were missing. Change-Id: I68ff3043eed247b659ccafeb7ee709dd94b653fb Reviewed-by: Andy Nichols <andy.nichols@qt.io>
Diffstat (limited to 'src/quick/scenegraph/coreapi/qsgrendererinterface.cpp')
-rw-r--r--src/quick/scenegraph/coreapi/qsgrendererinterface.cpp30
1 files changed, 27 insertions, 3 deletions
diff --git a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp
index ffde9d8930..149baab3a9 100644
--- a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp
+++ b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp
@@ -68,8 +68,6 @@ QT_BEGIN_NAMESPACE
\value Software The Qt Quick 2D Renderer is in use
\value OpenGL OpenGL ES 2.0 or higher
\value Direct3D12 Direct3D 12
- \value Vulkan Vulkan
- \value Metal Metal
*/
/*!
@@ -79,6 +77,32 @@ QT_BEGIN_NAMESPACE
\value CommandList The command list or buffer used by the scenegraph
*/
+/*!
+ \enum QSGRendererInterface::ShaderType
+ \value UnknownShadingLanguage - Not yet known due to no window and scenegraph associated
+ \value GLSL - GLSL or GLSL ES
+ \value HLSL - HLSL
+ */
+
+/*!
+ \enum QSGRendererInterface::ShaderCompilationType
+ \value RuntimeCompilation - Runtime compilation of shader source code is supported
+ \value OfflineCompilation - Pre-compiled bytecode supported
+ */
+
+/*!
+ \enum QSGRendererInterface::ShaderSourceType
+
+ \value ShaderSourceString - Shader source can be provided as a string in
+ the corresponding properties of ShaderEffect
+
+ \value ShaderSourceFile - Local or resource files containing shader source
+ code are supported
+
+ \value ShaderByteCode - Local or resource files containing shader bytecode are
+ supported
+ */
+
QSGRendererInterface::~QSGRendererInterface()
{
}
@@ -156,7 +180,7 @@ void *QSGRendererInterface::getResource(const char *resource) const
/*!
\fn QSGRendererInterface::ShaderSourceTypes QSGRendererInterface::shaderSourceType() const
- \return a bitmask of the supported ways of providing shader sources.
+ \return a bitmask of the supported ways of providing shader sources in ShaderEffect items.
\note This function can be called on any thread. However, the renderer
interface's lifetime may be tied to the render thread and therefore calling