diff options
author | Antti Määttä <antti.maatta@qt.io> | 2016-09-08 16:00:54 +0300 |
---|---|---|
committer | Sean Harmer <sean.harmer@kdab.com> | 2016-11-14 14:20:06 +0000 |
commit | 8cbca733dc27350cc193e4fefc645fbba67f41c0 (patch) | |
tree | 2f52395c3f2ac20187666096c6ead3d951b8f67c /src/render/renderstates/qfrontface.cpp | |
parent | a6ffc89bec6462b6c49504c4f0fd5a8672665b14 (diff) |
Update docs for render states
Change-Id: I40379d4b20baf79657926a1cef5b29e83579b46c
Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/render/renderstates/qfrontface.cpp')
-rw-r--r-- | src/render/renderstates/qfrontface.cpp | 62 |
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); |