| /**************************************************************************** |
| ** |
| ** Copyright (C) 2014 Klaralvdalens Datakonsult AB (KDAB). |
| ** Copyright (C) 2016 The Qt Company Ltd and/or its subsidiary(-ies). |
| ** Contact: https://www.qt.io/licensing/ |
| ** |
| ** This file is part of the Qt3D module of the Qt Toolkit. |
| ** |
| ** $QT_BEGIN_LICENSE:LGPL$ |
| ** Commercial License Usage |
| ** Licensees holding valid commercial Qt licenses may use this file in |
| ** accordance with the commercial license agreement provided with the |
| ** Software or, alternatively, in accordance with the terms contained in |
| ** a written agreement between you and The Qt Company. For licensing terms |
| ** and conditions see https://www.qt.io/terms-conditions. For further |
| ** information use the contact form at https://www.qt.io/contact-us. |
| ** |
| ** GNU Lesser General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU Lesser |
| ** General Public License version 3 as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
| ** packaging of this file. Please review the following information to |
| ** ensure the GNU Lesser General Public License version 3 requirements |
| ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
| ** |
| ** GNU General Public License Usage |
| ** Alternatively, this file may be used under the terms of the GNU |
| ** General Public License version 2.0 or (at your option) the GNU General |
| ** Public license version 3 or any later version approved by the KDE Free |
| ** Qt Foundation. The licenses are as published by the Free Software |
| ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
| ** included in the packaging of this file. Please review the following |
| ** information to ensure the GNU General Public License requirements will |
| ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
| ** https://www.gnu.org/licenses/gpl-3.0.html. |
| ** |
| ** $QT_END_LICENSE$ |
| ** |
| ****************************************************************************/ |
| |
| #include "qalphatest.h" |
| #include "qalphatest_p.h" |
| #include <Qt3DRender/private/qrenderstatecreatedchange_p.h> |
| |
| QT_BEGIN_NAMESPACE |
| |
| namespace Qt3DRender { |
| |
| /*! |
| \class Qt3DRender::QAlphaTest |
| \brief The QAlphaTest class specify alpha reference test. |
| \since 5.7 |
| \inmodule Qt3DRender |
| \ingroup renderstates |
| |
| As the OpenGL documentation explains; The alpha test discards a fragment |
| conditional on the outcome of a comparison between the incoming fragment's |
| alpha value and a constant reference value. |
| */ |
| |
| /*! |
| \qmltype AlphaTest |
| \brief The AlphaTest class specify alpha reference test. |
| \since 5.7 |
| \inqmlmodule Qt3D.Render |
| \inherits RenderState |
| \instantiates Qt3DRender::QAlphaTest |
| \ingroup renderstates |
| |
| As the OpenGL documentation explains; The alpha test discards a fragment |
| conditional on the outcome of a comparison between the incoming fragment's |
| alpha value and a constant reference value. |
| */ |
| |
| /*! |
| \enum Qt3DRender::QAlphaTest::AlphaFunction |
| |
| Enumeration for the alpha function values |
| \value Never Never pass alpha test |
| \value Always Always pass alpha test |
| \value Less Pass alpha test if fragment alpha is less than reference value |
| \value LessOrEqual Pass alpha test if fragment alpha is less than or equal to reference value |
| \value Equal Pass alpha test if fragment alpha is equal to reference value |
| \value GreaterOrEqual Pass alpha test if fragment alpha is greater than or equal to reference value |
| \value Greater Pass alpha test if fragment alpha is greater than reference value |
| \value NotEqual Pass alpha test if fragment alpha is not equal to reference value |
| */ |
| |
| /*! |
| \qmlproperty enumeration AlphaTest::alphaFunction |
| Holds the alpha function used by the alpha test. Default is AlphaTest.Never. |
| \list |
| \li AlphaTest.Never |
| \li AlphaTest.Always |
| \li AlphaTest.Less |
| \li AlphaTest.LessOrEqual |
| \li AlphaTest.Equal |
| \li AlphaTest.GreaterOrEqual |
| \li AlphaTest.Greater |
| \li AlphaTest.NotEqual |
| \endlist |
| \sa Qt3DRender::QAlphaTest::AlphaFunction |
| */ |
| |
| /*! |
| \qmlproperty real AlphaTest::referenceValue |
| Holds the reference value used by the alpha test. Default is 0.0. |
| When set, the value is clamped between 0 and 1. |
| */ |
| |
| /*! |
| \property QAlphaTest::alphaFunction |
| Holds the alpha function used by the alpha test. Default is Never. |
| */ |
| |
| /*! |
| \property QAlphaTest::referenceValue |
| Holds the reference value used by the alpha test. Default is 0.0. |
| When set, the value is clamped between 0 and 1. |
| */ |
| |
| |
| QAlphaTest::QAlphaTest(QNode *parent) |
| : QRenderState(*new QAlphaTestPrivate, parent) |
| { |
| } |
| |
| /*! \internal */ |
| QAlphaTest::~QAlphaTest() |
| { |
| } |
| |
| QAlphaTest::AlphaFunction QAlphaTest::alphaFunction() const |
| { |
| Q_D(const QAlphaTest); |
| return d->m_alphaFunction; |
| } |
| |
| void QAlphaTest::setAlphaFunction(QAlphaTest::AlphaFunction alphaFunction) |
| { |
| Q_D(QAlphaTest); |
| if (d->m_alphaFunction != alphaFunction) { |
| d->m_alphaFunction = alphaFunction; |
| emit alphaFunctionChanged(alphaFunction); |
| } |
| } |
| |
| float QAlphaTest::referenceValue() const |
| { |
| Q_D(const QAlphaTest); |
| return d->m_referenceValue; |
| } |
| |
| void QAlphaTest::setReferenceValue(float referenceValue) |
| { |
| Q_D(QAlphaTest); |
| if (d->m_referenceValue != referenceValue) { |
| d->m_referenceValue = referenceValue; |
| emit referenceValueChanged(referenceValue); |
| } |
| } |
| |
| Qt3DCore::QNodeCreatedChangeBasePtr QAlphaTest::createNodeCreationChange() const |
| { |
| auto creationChange = QRenderStateCreatedChangePtr<QAlphaTestData>::create(this); |
| auto &data = creationChange->data; |
| Q_D(const QAlphaTest); |
| data.alphaFunction = d->m_alphaFunction; |
| data.referenceValue = d->m_referenceValue; |
| return creationChange; |
| } |
| |
| } // namespace Qt3DRender |
| |
| QT_END_NAMESPACE |