summaryrefslogtreecommitdiffstats
path: root/src/render/renderstates/qfrontface.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/renderstates/qfrontface.cpp')
-rw-r--r--src/render/renderstates/qfrontface.cpp62
1 files changed, 46 insertions, 16 deletions
diff --git a/src/render/renderstates/qfrontface.cpp b/src/render/renderstates/qfrontface.cpp
index 016f27370..a814be82f 100644
--- a/src/render/renderstates/qfrontface.cpp
+++ b/src/render/renderstates/qfrontface.cpp
@@ -38,13 +38,6 @@
**
****************************************************************************/
-/*!
- * \class QFrontFace
- * \brief The QFrontFace class defines front and back facing polygons.
- * \since 5.7
- * \ingroup renderstates
- *
- */
#include "qfrontface.h"
#include "qfrontface_p.h"
#include <Qt3DRender/private/qrenderstatecreatedchange_p.h>
@@ -54,8 +47,52 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
/*!
- * The constructor creates a new QFrontFace::QFrontFace instance with the
- * specified \a parent
+ \class Qt3DRender::QFrontFace
+ \brief The QFrontFace class defines front and back facing polygons.
+ \since 5.7
+ \ingroup renderstates
+ \inmodule Qt3DRender
+
+ A Qt3DRender::QFrontFace sets the winding direction of the front facing polygons.
+
+ \sa QCullFace
+ */
+
+/*!
+ \qmltype FrontFace
+ \brief The FrontFace type defines front and back facing polygons.
+ \since 5.7
+ \ingroup renderstates
+ \inqmlmodule Qt3D.Render
+ \inherits RenderState
+ \instantiates Qt3DRender::QFrontFace
+
+ A FrontFace sets the winding direction of the front facing polygons.
+
+ \sa CullFace
+ */
+
+/*!
+ \enum QFrontFace::WindingDirection
+
+ This enumeration specifies the winding direction values.
+ \value ClockWise Clockwise polygons are front facing.
+ \value CounterClockWise Counter clockwise polygons are front facing.
+*/
+
+/*!
+ \qmlproperty enumeration FrontFace::direction
+ Holds the winding direction of the front facing polygons. Default is FrontFace.Clockwise.
+*/
+
+/*!
+ \property QFrontFace::direction
+ Holds the winding direction of the front facing polygons. Default is Clockwise.
+*/
+
+/*!
+ The constructor creates a new QFrontFace::QFrontFace instance with the
+ specified \a parent
*/
QFrontFace::QFrontFace(QNode *parent)
: QRenderState(*new QFrontFacePrivate, parent)
@@ -67,19 +104,12 @@ QFrontFace::~QFrontFace()
{
}
-/*!
- * \return the current winding direction
- */
QFrontFace::WindingDirection QFrontFace::direction() const
{
Q_D(const QFrontFace);
return d->m_direction;
}
-/*!
- * Sets the winding direction to \a direction
- * \param direction
- */
void QFrontFace::setDirection(QFrontFace::WindingDirection direction)
{
Q_D(QFrontFace);