summaryrefslogtreecommitdiffstats
path: root/src/render/lights/qabstractlight.cpp
diff options
context:
space:
mode:
authorColin Ogilvie <colin.ogilvie@kdab.com>2016-05-24 09:38:44 +0100
committerSean Harmer <sean.harmer@kdab.com>2016-05-28 16:01:17 +0000
commitc55e51e17dcaecac7cb2f7f53c656636f1fdf1bf (patch)
tree7251d09a6d24fe51d63b5fd55203313236a18651 /src/render/lights/qabstractlight.cpp
parentca953401eb721b322c2dec86d9fa0cc7bd7db13a (diff)
Skeletal Doc for render-lights
Task-number: QTBUG-46037 Change-Id: I045b7ff77827de2410fc785c16508ff1429f14fb Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Diffstat (limited to 'src/render/lights/qabstractlight.cpp')
-rw-r--r--src/render/lights/qabstractlight.cpp15
1 files changed, 15 insertions, 0 deletions
diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp
index ea8fd13d6..a826654c7 100644
--- a/src/render/lights/qabstractlight.cpp
+++ b/src/render/lights/qabstractlight.cpp
@@ -53,6 +53,14 @@ namespace Qt3DRender
* \since 5.6
*/
+/*!
+ \enum QAbstractLight::Type
+
+ This enum type identifies the particular type of light.
+ \value PointLight
+ \value DirectionalLight
+ \value SpotLight
+*/
QAbstractLightPrivate::QAbstractLightPrivate(QAbstractLight::Type type)
: m_type(type)
@@ -79,6 +87,8 @@ Qt3DCore::QNodeCreatedChangeBasePtr QAbstractLight::createNodeCreationChange() c
/*!
\class Qt3DRender::QAbstractLight
\inmodule Qt3DRender
+ \brief Encapsulate a QAbstractLight object in a Qt 3D scene.
+ \since 5.6
*/
/*! \internal */
@@ -93,6 +103,11 @@ QAbstractLight::~QAbstractLight()
{
}
+/*!
+ \property Qt3DRender::QAbstractLight::type
+
+ Holds the current QAbstractLight type.
+*/
QAbstractLight::Type QAbstractLight::type() const
{
Q_D(const QAbstractLight);