diff options
author | Laszlo Agocs <laszlo.agocs@qt.io> | 2016-07-13 12:03:13 +0200 |
---|---|---|
committer | Laszlo Agocs <laszlo.agocs@qt.io> | 2016-07-14 13:05:07 +0000 |
commit | ff8c0b053cc2085670a3013c58191d4886fda5ca (patch) | |
tree | 76b24ef2ffc583e85f63d239c04c3996d17763da | |
parent | b37d6969f1dfb83fd2e1285230d116e0cf076f7f (diff) |
Doc cleanup for D3D12 and SW
Fix formatting, wrong class names, and remove sprites as an unsupported
feature. Add a note about the glslcore file selector.
Change-Id: I2caffc4485157d053bb0fffa47fed8ee1d506774
Reviewed-by: Andy Nichols <andy.nichols@qt.io>
-rw-r--r-- | src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc | 15 | ||||
-rw-r--r-- | src/quick/items/qquickshadereffect.cpp | 4 | ||||
-rw-r--r-- | src/quick/scenegraph/coreapi/qsgrendererinterface.cpp | 16 | ||||
-rw-r--r-- | src/quick/scenegraph/coreapi/qsgrendernode.cpp | 2 |
4 files changed, 20 insertions, 17 deletions
diff --git a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc index 3053196692..55c8c2c535 100644 --- a/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc +++ b/src/quick/doc/src/concepts/visualcanvas/adaptations.qdoc @@ -127,9 +127,6 @@ It is not possible to render particle effects with the Software adaptation. When possible, remove particles completely from the scene. Otherwise they will still require some processing, even though they are not visible. -\section2 Sprites -The Sprite item depends on OpenGL functions and will not be visible. - \section2 Rendering Text The text rendering with the Software adaptation is based on software rasterization and does not respond as well to transformations such as scaling @@ -243,8 +240,8 @@ GraphicsInfo.shaderCompilationType and GraphicsInfo.shaderSourceType. Unlike OpenGL, there is a QFileSelector with the extra selector \c hlsl used whenever opening a file. This allows easy creation of ShaderEffect items that are functional across both backends, for example by placing the GLSL source -code into "shaders/effect.frag", the HLSL source code or - preferably - -pre-compiled bytecode into "shaders/+hlsl/effect.frag", while simply writing +code into \c{shaders/effect.frag}, the HLSL source code or - preferably - +pre-compiled bytecode into \c{shaders/+hlsl/effect.frag}, while simply writing \c{fragmentShader: "qrc:shaders/effect.frag"} in QML. See the ShaderEffect documentation for more details. @@ -277,13 +274,17 @@ conversion on the CPU first. \section2 Unsupported Features -Particles, sprites, and other OpenGL-dependent tools like -QQuickFramebufferObject are not currently supported. +Particles and some other OpenGL-dependent utilities, like +QQuickFramebufferObject, are not currently supported. Like with the \l{qtquick-visualcanvas-adaptations-software.html}{Software adaptation}, text is always rendered using the native method. Distance field-based text rendering is not currently implemented. +The shader sources in the \l {Qt Graphical Effects} module have not been ported +to any format other than the OpenGL 2.0 compatible one, meaning the QML types +provided by that module are not currently functional with the D3D12 backend. + Texture atlases are not currently in use. The renderer may lack support for certain minor features, for example drawing diff --git a/src/quick/items/qquickshadereffect.cpp b/src/quick/items/qquickshadereffect.cpp index 57462219f9..5670696ce2 100644 --- a/src/quick/items/qquickshadereffect.cpp +++ b/src/quick/items/qquickshadereffect.cpp @@ -432,7 +432,9 @@ QT_BEGIN_NAMESPACE do its job. The selector-less version is the GLSL source, while the \c hlsl selector is used when running on the D3D12 backend. The file under \c{+hlsl} can then contain either HLSL source code or compiled bytecode - from the \c fxc tool. + from the \c fxc tool. Additionally, when using a version 3.2 or newer core + profile context with OpenGL, GLSL sources with a core profile compatible + syntax can be placed under \c{+glslcore}. \qml import QtQuick 2.8 // for GraphicsInfo diff --git a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp index e818d35dd7..04e71441f6 100644 --- a/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp +++ b/src/quick/scenegraph/coreapi/qsgrendererinterface.cpp @@ -88,27 +88,27 @@ QT_BEGIN_NAMESPACE /*! \enum QSGRendererInterface::ShaderType - \value UnknownShadingLanguage - Not yet known due to no window and scenegraph associated - \value GLSL - GLSL or GLSL ES - \value HLSL - HLSL + \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 + \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 + \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 + \value ShaderSourceFile Local or resource files containing shader source code are supported - \value ShaderByteCode - Local or resource files containing shader bytecode are + \value ShaderByteCode Local or resource files containing shader bytecode are supported */ diff --git a/src/quick/scenegraph/coreapi/qsgrendernode.cpp b/src/quick/scenegraph/coreapi/qsgrendernode.cpp index 6c61b35aa1..29e8251cb2 100644 --- a/src/quick/scenegraph/coreapi/qsgrendernode.cpp +++ b/src/quick/scenegraph/coreapi/qsgrendernode.cpp @@ -44,7 +44,7 @@ QT_BEGIN_NAMESPACE /*! \class QSGRenderNode - \brief The QSGMaterialShader class represents a set of custom rendering commands + \brief The QSGRenderNode class represents a set of custom rendering commands targeting the graphics API that is in use by the scenegraph. \inmodule QtQuick \since 5.8 |