diff options
author | Sean Harmer <sean.harmer@kdab.com> | 2017-05-24 12:09:44 +0100 |
---|---|---|
committer | Sean Harmer <sean.harmer@kdab.com> | 2017-05-24 12:10:02 +0100 |
commit | 77d294db076dac19e8b549b445ffede9f7260c84 (patch) | |
tree | 828ee7a6862ec5c0bd24f97cb540625a2c647376 /examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc | |
parent | 59f8fec8a41606b3185fe3a4e276978e3e1ed5ef (diff) | |
parent | 939b9b4b7591e8a421cf048a0a84ed3e75d81d21 (diff) |
Merge branch 'dev' into wip/animationwip/animation
Change-Id: I6e770609c90a7745d08fa4e2f424e865678c5d6f
Diffstat (limited to 'examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc')
-rw-r--r-- | examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc new file mode 100644 index 000000000..eeb59f07b --- /dev/null +++ b/examples/qt3d/advancedcustommaterial/doc/src/advancedcustommaterial.qdoc @@ -0,0 +1,84 @@ +/**************************************************************************** +** +** Copyright (C) 2017 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \example advancedcustommaterial + \title Qt 3D: Advanced custom material QML Example + \ingroup qt3d-examples-qml + \brief Demonstrates creating advanced materials in Qt3D + + \image advanced-custom-material.jpg + + \e This example demonstrates creating advanced custom materials. + + \include examples-run.qdocinc + + \section1 Description + + Advanced custom material example shows more complex shaders, and demonstrates controlling your + shader properties with QtQuick user interface and Animation. Water is a 3D mesh, that is + modeled and uv mapped inside Blender, and then brought into Scene 3D as an \c {.obj} file. + Shader properties that user can control, are defined in \l {advancedcustommaterial/WaterMaterial.qml}{WaterMaterial}. + + \section1 Controls + \section2 Texture scale slider + + Multiplies texture coordinates inside the vertex shader. Controls the size of the textures + on water surface. + + \section2 Texture speed slider + + Offsets values for texture coordinates which are animated in + \l {advancedcustommaterial/Water.qml}{Water.qml} and then passed to vertex shader. + Creates the effect of textures scrolling over the surface. + + \section2 Specularity + + Multiplies specular texture values inside fragment shader. Makes the water reflective. + + \section2 Distortion + + Multiplies the offset in red and blue channels of wave texture in fragment shader. + Makes the surface textures animate more randomly. + + \section2 Normal amount + + Multiplies the normal map values inside fragment shader. Controls the visibility of + smaller waves on the water surface. + + \section2 Wave speed + + Modifies the frequency of the sine wave inside vertex shader. Controls the speed of the waves. + + \section2 Wave height + + Multiplies the vertex \c {Y} position inside vertex shader. Controls the height of the waves. + + \section2 Mesh rotation + + Rotates the water mesh in \l {advancedcustommaterial/Water.qml}{Water.qml}. +*/ |