diff options
Diffstat (limited to 'src/render/renderstates/qdithering.cpp')
| -rw-r--r-- | src/render/renderstates/qdithering.cpp | 32 |
1 files changed, 25 insertions, 7 deletions
diff --git a/src/render/renderstates/qdithering.cpp b/src/render/renderstates/qdithering.cpp index 7b98ed7ae..102cfa0ff 100644 --- a/src/render/renderstates/qdithering.cpp +++ b/src/render/renderstates/qdithering.cpp @@ -48,13 +48,31 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! - * \class Qt3DRender::QDithering - * \brief The QDithering class - * \since 5.7 - * \ingroup + \class Qt3DRender::QDithering + \since 5.7 + \inmodule Qt3DRender + \brief Enable dithering + + A Qt3DRender::QDithering class enables dithering. Dithering adds noise to the + color values to randomize quantization error in order to prevent large scale + patterns in the final image, such as banding. Dithering is most useful when + rendering to a surface with low color bit depth, such as RGB565 or RGBA4444. + */ + +/*! + \qmltype Dithering + \since 5.7 + \inqmlmodule Qt3D.Render + \inherits RenderState + \instantiates Qt3DRender::QDithering + \brief Enable dithering + + A Dithering type enables dithering. Dithering adds noise to the + color values to randomize quantization error in order to prevent large scale + patterns in the final image, such as banding. Dithering is most useful when + rendering to a surface with low color bit depth, such as RGB565 or RGBA4444. */ -/*! \internal */ class QDitheringPrivate : public QRenderStatePrivate { public: @@ -66,8 +84,8 @@ public: }; /*! - * The constructor creates a new QDithering::QDithering instance with - * the specified \a parent. + The constructor creates a new QDithering::QDithering instance with + the specified \a parent. */ QDithering::QDithering(QNode *parent) : QRenderState(*new QDitheringPrivate, parent) |