diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2019-12-06 13:09:24 +0100 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2019-12-10 10:59:02 +0100 |
| commit | 98b8894856dd7359ebfe1075962ce770b5d110e0 (patch) | |
| tree | 4196cc1451becd7a758d30dc9065c17e249aeb37 /src/render/lights/qpointlight.cpp | |
| parent | 068309acaa787fe8a094869e839c1d0131721f55 (diff) | |
Doc: Add note about implementation specific property meaning
Fixes: QTBUG-73095
Change-Id: I843b0376ed0e4ece6ef949acb596a0303aac977d
Reviewed-by: Andy Shaw <andy.shaw@qt.io>
Diffstat (limited to 'src/render/lights/qpointlight.cpp')
| -rw-r--r-- | src/render/lights/qpointlight.cpp | 30 |
1 files changed, 24 insertions, 6 deletions
diff --git a/src/render/lights/qpointlight.cpp b/src/render/lights/qpointlight.cpp index 2b042c91d..c16291709 100644 --- a/src/render/lights/qpointlight.cpp +++ b/src/render/lights/qpointlight.cpp @@ -135,12 +135,18 @@ QPointLight::QPointLight(QPointLightPrivate &dd, QNode *parent) /*! \qmlproperty float Qt3D.Render::PointLight::constantAttenuation - Specifies the constant attenuation of the point light + Specifies the constant attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ /*! \property Qt3DRender::QPointLight::constantAttenuation - Specifies the constant attenuation of the point light + Specifies the constant attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ float QPointLight::constantAttenuation() const { @@ -159,12 +165,18 @@ void QPointLight::setConstantAttenuation(float value) /*! \qmlproperty float Qt3D.Render::PointLight::linearAttenuation - Specifies the linear attenuation of the point light + Specifies the linear attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ /*! \property Qt3DRender::QPointLight::linearAttenuation - Specifies the linear attenuation of the point light + Specifies the linear attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ float QPointLight::linearAttenuation() const { @@ -183,12 +195,18 @@ void QPointLight::setLinearAttenuation(float value) /*! \qmlproperty float Qt3D.Render::PointLight::quadraticAttenuation - Specifies the quadratic attenuation of the point light + Specifies the quadratic attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ /*! \property Qt3DRender::QPointLight::quadraticAttenuation - Specifies the quadratic attenuation of the point light + Specifies the quadratic attenuation of the point light. + + \note The exact meaning and use of this property is up to the + material implementation. */ float QPointLight::quadraticAttenuation() const { |