diff options
author | Paul Wicking <paul.wicking@qt.io> | 2019-05-15 15:00:42 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-05-16 12:33:58 +0000 |
commit | 0f02a2e906b9372fe592b106773b809b68cad3f7 (patch) | |
tree | 78f537afbd8b2e751516603fd641ea336c1fe5ce | |
parent | a6cf29815ecc3cc9a83dc7dcccff19302cc68c45 (diff) |
Doc: Add MetalRoughMaterial QML documentation
Fixes: QTBUG-73072
Change-Id: Ifea7152c77c4f6f1759e4872001336bae6d3d2c3
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r-- | src/extras/defaults/qmetalroughmaterial.cpp | 51 |
1 files changed, 50 insertions, 1 deletions
diff --git a/src/extras/defaults/qmetalroughmaterial.cpp b/src/extras/defaults/qmetalroughmaterial.cpp index c6913b490..d404f03de 100644 --- a/src/extras/defaults/qmetalroughmaterial.cpp +++ b/src/extras/defaults/qmetalroughmaterial.cpp @@ -171,6 +171,16 @@ void QMetalRoughMaterialPrivate::handleTextureScaleChanged(const QVariant &var) */ /*! + \qmltype MetalRoughMaterial + \instantiates Qt3DExtras::QMetalRoughMaterial + \inqmlmodule Qt3D.Extras + + \brief This material uses an effect with a single render pass approach and + performs per fragment lighting. Techniques are provided for OpenGL 3 + and OpenGL ES 3. +*/ + +/*! Constructs a new QMetalRoughMaterial instance with parent object \a parent. */ QMetalRoughMaterial::QMetalRoughMaterial(QNode *parent) @@ -201,6 +211,12 @@ QMetalRoughMaterial::~QMetalRoughMaterial() Holds the current base color of the material. This can be either a plain color value or a texture. By default the value of this property is "grey". */ +/*! + \qmlproperty color Qt3D.Extras::MetalRoughMaterial::baseColor + + Holds the current base color of the material. This can be either a plain + color value or a texture. By default the value of this property is "grey". +*/ QVariant QMetalRoughMaterial::baseColor() const { Q_D(const QMetalRoughMaterial); @@ -210,7 +226,15 @@ QVariant QMetalRoughMaterial::baseColor() const /*! \property QMetalRoughMaterial::metalness - Holds the current metalness level of the material, since is a value between + Holds the current metalness level of the material, as a value between + 0 (purely dielectric, the default) and 1 (purely metallic). This can be + either a plain uniform value or a texture. By default the value of this + property is 0. +*/ +/*! + \qmlproperty real Qt3D.Extras::MetalRoughMaterial::metalness + + Holds the current metalness level of the material, as a value between 0 (purely dielectric, the default) and 1 (purely metallic). This can be either a plain uniform value or a texture. By default the value of this property is 0. @@ -228,6 +252,13 @@ QVariant QMetalRoughMaterial::metalness() const plain uniform value or a texture. By default the value of this property is 0. */ +/*! + \qmlproperty real Qt3D.Extras::MetalRoughMaterial::roughness + + Holds the current roughness level of the material. This can be either a + plain uniform value or a texture. By default the value of this property is + 0. +*/ QVariant QMetalRoughMaterial::roughness() const { Q_D(const QMetalRoughMaterial); @@ -240,6 +271,12 @@ QVariant QMetalRoughMaterial::roughness() const Holds the current ambient occlusion map texture of the material. This can only be a texture, otherwise it is ignored. By default this map is not set. */ +/*! + \qmlproperty Texture Qt3D.Extras::MetalRoughMaterial::ambientOcclusion + + Holds the current ambient occlusion map texture of the material. This can + only be a texture, otherwise it is ignored. By default this map is not set. +*/ QVariant QMetalRoughMaterial::ambientOcclusion() const { Q_D(const QMetalRoughMaterial); @@ -252,6 +289,12 @@ QVariant QMetalRoughMaterial::ambientOcclusion() const Holds the current normal map texture of the material. This can only be a texture, otherwise it is ignored. By default this map is not set. */ +/*! + \qmlproperty Texture Qt3D.Extras::MetalRoughMaterial::normal + + Holds the current normal map texture of the material. This can only be a + texture, otherwise it is ignored. By default this map is not set. +*/ QVariant QMetalRoughMaterial::normal() const { Q_D(const QMetalRoughMaterial); @@ -264,6 +307,12 @@ QVariant QMetalRoughMaterial::normal() const Holds the current texture scale. It is applied as a multiplier to texture coordinates at render time. Defaults to 1.0. */ +/*! + \qmlproperty real Qt3D.Extras::MetalRoughMaterial::textureScale + + Holds the current texture scale. It is applied as a multiplier to texture + coordinates at render time. Defaults to 1.0. +*/ float QMetalRoughMaterial::textureScale() const { Q_D(const QMetalRoughMaterial); |