QRasterMode: add documentation

Change-Id: I170ae7db4e7fe338373c8c8d7c35dbd770e6fb0b
Reviewed-by: Mike Krus <mike.krus@kdab.com>

1 files changed, 94 insertions, 0 deletions

diff --git a/src/render/renderstates/qrastermode.cpp b/src/render/renderstates/qrastermode.cpp
index fc255b717..c432f1063 100644
--- a/src/render/renderstates/qrastermode.cpp
+++ b/src/render/renderstates/qrastermode.cpp
@@ -45,6 +45,100 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+    \class Qt3DRender::QRasterMode
+    \brief The QRasterMode render state allows to control the type of
+    rasterization to be performed
+    \since 5.14
+    \inmodule Qt3DRender
+    \ingroup renderstates
+
+    The QRasterMode class is used to control the rasterization step of the
+    primitives at render time. This can be used to choose whether we only
+    want to show points, edges or fill a primitive.
+
+    \note This is not supported when rendering on OpenGL ES 2.0 platforms.
+
+    \sa QAlphaTest, QStencilTest
+ */
+
+/*!
+    \qmltype RasterMode
+    \brief The RasterMode render state allows to control the type of
+    rasterization to be performed
+    \since 5.14
+    \inqmlmodule Qt3D.Render
+    \inherits RenderState
+    \instantiates Qt3DRender::QRasterMode
+    \ingroup renderstates
+
+    The QRasterMode class is used to control the rasterization step of the
+    primitives at render time. This can be used to choose whether we only
+    want to show points, edges or fill a primitive.
+
+    \note This is not supported when rendering on OpenGL ES 2.0 platforms.
+
+    \sa AlphaTest, StencilTest
+ */
+
+/*!
+    \enum Qt3DRender::QRasterMode::RasterMode
+
+    Enumeration for raster mode values
+    \value Points Vertices at the start of an edge are drawn as points.
+    \value Lines Edges of a polygon are draw as line segments.
+    \value Fill Fills the interior of the primitive.
+*/
+
+/*!
+    \enum Qt3DRender::QRasterMode::FaceMode
+
+    Enumeration for face mode values
+    \value Front Applies to front faces only
+    \value Back Applies to back faces only
+    \value FrontAndBack Applies to front and back faces
+*/
+
+/*!
+    \property QRasterMode::rasterMode
+
+    Holds the raster mode to be used.
+*/
+
+/*!
+    \property QRasterMode::faceMode
+
+    Holds the face mode to be used. Controls on which face the raster mode is
+    to be applied.
+*/
+
+/*!
+    \qmlproperty enumeration RasterMode::rasterMode
+
+    Holds the raster mode to be used.
+
+    \list
+    \li Points Vertices at the start of an edge are drawn as points.
+    \li Lines Edges of a polygon are draw as line segments.
+    \li Fill Fills the interior of the primitive.
+    \endlist
+*/
+
+/*!
+    \qmlproperty enumeration RasterMode::faceMode
+
+    Holds the face mode to be used. Controls on which face the raster mode is
+    to be applied.
+
+    \list
+    \li Front Applies to front faces only
+    \li Back Applies to back faces only
+    \li FrontAndBack Applies to front and back faces
+    \endlist
+*/
+
+
+
 QRasterMode::QRasterMode(QNode *parent)
     : QRenderState(*new QRasterModePrivate, parent)
 {