summaryrefslogtreecommitdiffstats
path: root/src/render/renderstates/qdithering.cpp
blob: f0b87eeb94e2ee80950725c285f59b04ef5e779a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB).
// Copyright (C) 2016 The Qt Company Ltd and/or its subsidiary(-ies).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "qdithering.h"
#include "qrenderstate_p.h"
#include <private/qnode_p.h>

QT_BEGIN_NAMESPACE

namespace Qt3DRender {

/*!
    \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.
 */

class QDitheringPrivate : public QRenderStatePrivate
{
public:
    QDitheringPrivate()
        : QRenderStatePrivate(Render::DitheringStateMask)
    {}

    Q_DECLARE_PUBLIC(QDithering)
};

/*!
    The constructor creates a new QDithering::QDithering instance with
    the specified \a parent.
 */
QDithering::QDithering(QNode *parent)
    : QRenderState(*new QDitheringPrivate, parent)
{
}

/*! \internal */
QDithering::~QDithering()
{
}

} // namespace Qt3DRender

QT_END_NAMESPACE