diff options
| author | Joni Poikelin <joni.poikelin@qt.io> | 2019-01-17 09:53:45 +0200 |
|---|---|---|
| committer | Joni Poikelin <joni.poikelin@qt.io> | 2019-02-14 05:17:55 +0000 |
| commit | 7f9fdca73a17060b9d69db00b5d480690dcae935 (patch) | |
| tree | 1d99ae130b07616640fbf01e277d577dbe876d95 /src/extras/defaults/qdiffusespecularmaterial.cpp | |
| parent | efa4665b316dbd5361b0936a1135f45c141f14aa (diff) | |
Doc: clarify some properties
Change-Id: Ie0e9183ec4fe1730018f695374d32cb78d0e77ed
Reviewed-by: Andy Maloney <asmaloney@gmail.com>
Reviewed-by: Michael Brasser <michael.brasser@live.com>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Diffstat (limited to 'src/extras/defaults/qdiffusespecularmaterial.cpp')
| -rw-r--r-- | src/extras/defaults/qdiffusespecularmaterial.cpp | 38 |
1 files changed, 25 insertions, 13 deletions
diff --git a/src/extras/defaults/qdiffusespecularmaterial.cpp b/src/extras/defaults/qdiffusespecularmaterial.cpp index 14e1c2766..be187b46a 100644 --- a/src/extras/defaults/qdiffusespecularmaterial.cpp +++ b/src/extras/defaults/qdiffusespecularmaterial.cpp @@ -253,7 +253,7 @@ void QDiffuseSpecularMaterialPrivate::handleTextureScaleChanged(const QVariant & \list \li Ambient is the color that is emitted by an object without any other light source. - \li Diffuse is the color that is emitted for rought surface reflections + \li Diffuse is the color that is emitted for rough surface reflections with the lights. \li Specular is the color emitted for shiny surface reflections with the lights. @@ -285,12 +285,14 @@ QDiffuseSpecularMaterial::~QDiffuseSpecularMaterial() /*! \property QDiffuseSpecularMaterial::ambient - Holds the ambient color. + Holds the ambient color that is emitted by an object without any other + light source. */ /*! \qmlproperty color DiffuseSpecularMaterial::ambient - Holds the ambient color. + Holds the ambient color that is emitted by an object without any other + light source. */ QColor QDiffuseSpecularMaterial::ambient() const { @@ -301,14 +303,16 @@ QColor QDiffuseSpecularMaterial::ambient() const /*! \property QDiffuseSpecularMaterial::diffuse - Holds the diffuse color of the material. This can be either a plain color - value or a texture. + Holds the diffuse color of the material that is emitted for rough surface + reflections with the lights. This can be either a plain color value or a + texture. */ /*! \qmlproperty var DiffuseSpecularMaterial::diffuse - Holds the diffuse color of the material. This can be either a plain color - value or a texture. + Holds the diffuse color of the material that is emitted for rough surface + reflections with the lights. This can be either a plain color value or a + texture. */ QVariant QDiffuseSpecularMaterial::diffuse() const { @@ -319,14 +323,16 @@ QVariant QDiffuseSpecularMaterial::diffuse() const /*! \property QDiffuseSpecularMaterial::specular - Holds the specular color of the material. This can be either a plain color - value or a texture. + Holds the specular color of the material that is emitted for shiny surface + reflections with the lights. This can be either a plain color value or a + texture. */ /*! \qmlproperty var DiffuseSpecularMaterial::specular - Holds the specular color of the material. This can be either a plain color - value or a texture. + Holds the specular color of the material that is emitted for shiny surface + reflections with the lights. This can be either a plain color value or a + texture. */ QVariant QDiffuseSpecularMaterial::specular() const { @@ -337,12 +343,18 @@ QVariant QDiffuseSpecularMaterial::specular() const /*! \property QDiffuseSpecularMaterial::shininess - Holds the shininess exponent. + Holds the shininess exponent. Higher values of shininess result in + a smaller and brighter highlight. + + Defaults to 150.0. */ /*! \qmlproperty real DiffuseSpecularMaterial::shininess - Holds the shininess exponent. + Holds the shininess exponent. Higher values of shininess result in + a smaller and brighter highlight. + + Defaults to 150.0. */ float QDiffuseSpecularMaterial::shininess() const { |