summaryrefslogtreecommitdiffstats
path: root/src/render/lights/qabstractlight.cpp
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2019-05-16 15:13:34 +0200
committerPaul Wicking <paul.wicking@qt.io>2019-06-07 13:45:54 +0000
commit614eddc31186a05bc37cfcb071caf9851ac1d010 (patch)
tree4d3f4b5a355857b60e2a2244e4a1205e4e639adb /src/render/lights/qabstractlight.cpp
parentad305807bd7005084ca8cadb281b6735651c9b02 (diff)
Doc: Extend Qt3D documentation
This change adds missing C++ and/or QML documentation for: * enum QBuffer::AccessType * QBuffer::accessType() * QBuffer::dataAvailable() * ForwardRenderer::externalRenderTargetSize * enumeration Qt3D.Render.Light::type * Qt3D.Render.Light::color * Qt3D.Render.Light::intensity Fixes: QTBUG-73071 Change-Id: I48b13cb8001558b20bd801b6f96f5b5933144d82 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/render/lights/qabstractlight.cpp')
-rw-r--r--src/render/lights/qabstractlight.cpp25
1 files changed, 24 insertions, 1 deletions
diff --git a/src/render/lights/qabstractlight.cpp b/src/render/lights/qabstractlight.cpp
index e5376f712..5ad16d3b4 100644
--- a/src/render/lights/qabstractlight.cpp
+++ b/src/render/lights/qabstractlight.cpp
@@ -67,9 +67,22 @@ QAbstractLightPrivate::~QAbstractLightPrivate()
}
/*!
+ \qmlproperty enumeration Qt3D.Render::Light::type
+ \readonly
+
+ Holds the particular type of light.
+
+ \value Light.PointLight
+ A point light
+ \value Light.DirectionalLight
+ A directional light
+ \value Light.SpotLight
+ a spot light
+*/
+/*!
\property Qt3DRender::QAbstractLight::type
- Contains the type of light.
+ The type of light.
*/
/*!
\enum Qt3DRender::QAbstractLight::Type
@@ -118,6 +131,11 @@ QAbstractLight::Type QAbstractLight::type() const
}
/*!
+ * \qmlproperty QColor Qt3D.Render.Light::color
+ *
+ * Holds the current Light color.
+ */
+/*!
* \property Qt3DRender::QAbstractLight::color
*
* Holds the current QAbstractLight color.
@@ -138,6 +156,11 @@ void QAbstractLight::setColor(const QColor &c)
}
/*!
+ \qmlproperty float Qt3D.Render.Light::intensity
+
+ Holds the current Light intensity.
+*/
+/*!
\property Qt3DRender::QAbstractLight::intensity
Holds the current QAbstractLight intensity.