summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2018-12-03 08:54:30 +0200
committerMats Honkamaa <mats.honkamaa@qt.io>2018-12-03 09:06:47 +0000
commit8d780257bef1cf56835e639429c7d5cbe342915d (patch)
treee4b4d8297b9fac40f03f1982f47f8e48f85f2552
parent821ca83228ff5d5ed2b770e1d122f94a7da7c831 (diff)
Change .material to .shader in documentation
Task-number: QT3DS-2787 Change-Id: Ic8c1048381683e2d2a4e1de11d93fa945599005f Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r--doc/src/07-file-formats/3-material.qdoc10
-rw-r--r--doc/src/07-file-formats/5-custom-material-reference.qdoc2
-rw-r--r--doc/src/07-file-formats/custom-materials-effects.qdoc6
-rw-r--r--doc/src/07-file-formats/formats-index.qdoc2
4 files changed, 10 insertions, 10 deletions
diff --git a/doc/src/07-file-formats/3-material.qdoc b/doc/src/07-file-formats/3-material.qdoc
index a7c84d67..b76469e2 100644
--- a/doc/src/07-file-formats/3-material.qdoc
+++ b/doc/src/07-file-formats/3-material.qdoc
@@ -28,8 +28,8 @@
/*!
-\title The .material Format
-\page file-formats-material.html
+\title The .shader Format
+\page file-formats-shader.html
\ingroup qt3dstudio-file-formats
Qt 3D Studio supports custom
@@ -39,7 +39,7 @@ interface for tweaking material parameters in Studio.
\section1 Overview
-The general structure of a \c{.material} file is shown below. Note
+The general structure of a \c{.shader} file is shown below. Note
that some of the attributes and elements shown here are optional (and
this example does not include all possible attributes):
@@ -67,7 +67,7 @@ The actual code for the shader is placed within the
\section1 Schemata
-Legal \c{.material} files are described by the following formal
+Legal \c{.shader} files are described by the following formal
schemata. The RelaxNG Compact schema is the reference from which the XML
Schema Definition schema was derived.
@@ -109,7 +109,7 @@ grammar \{
attribute type \{"GLSL" | "HLSL"\?, }# Optional shader type; only GLSL supported. default: GLSL
attribute version \{text\?, }# Code version
element Shared \{text\?, }# Arbitrary definition code to run for all shaders (optional)
- ShaderElement+ # There must be at least one <Shader> in the .material file
+ ShaderElement+ # There must be at least one <Shader> in the .shader file
\}
ShaderElement = element Shader \{
diff --git a/doc/src/07-file-formats/5-custom-material-reference.qdoc b/doc/src/07-file-formats/5-custom-material-reference.qdoc
index fb6d4cba..e1c97335 100644
--- a/doc/src/07-file-formats/5-custom-material-reference.qdoc
+++ b/doc/src/07-file-formats/5-custom-material-reference.qdoc
@@ -30,7 +30,7 @@
\page custom-material-reference.html
\ingroup qt3dstudio-file-formats
-This page explains how to write custom \l {file-formats-material.html}{materials}.
+This page explains how to write custom \l {The .shader Format}{materials}.
\section1 Overview
diff --git a/doc/src/07-file-formats/custom-materials-effects.qdoc b/doc/src/07-file-formats/custom-materials-effects.qdoc
index 965d98ab..7a1521cc 100644
--- a/doc/src/07-file-formats/custom-materials-effects.qdoc
+++ b/doc/src/07-file-formats/custom-materials-effects.qdoc
@@ -38,21 +38,21 @@ for adjusting properties in Studio.
You can write your own materials and effects to use in Qt 3D Studio, this requires knowledge in
OpenGL Shading Language (GLSL).
-This document explains the structure of the \c{.effect} and \c{.material} files but does not go
+This document explains the structure of the \c{.effect} and \c{.shader} files but does not go
through how to write shaders in GLSL.
\sa {Custom Material Reference}, {Effect Reference}
\section1 Overview
-The general structure of an \c{.effect} and a \c{.material} is almost the same.
+The general structure of an \c{.effect} and a \c{.shader} is almost the same.
The only different is the \c{<Effect>} and the \c{<Material>} elements.
\note Some of the attributes and elements shown here are optional (and this example does not
include all possible attributes).
The structure of an \c{.effect} file. As mentioned above the same structure applies to
-\c{.material} files as well with the only difference that you will need to use \c{<Material>} and
+\c{.shader} files as well with the only difference that you will need to use \c{<Material>} and
\c{</Material>} instead of \c{<Effect>} and \c{</Effect>}.
\badcode
diff --git a/doc/src/07-file-formats/formats-index.qdoc b/doc/src/07-file-formats/formats-index.qdoc
index 86f6f86c..598b3694 100644
--- a/doc/src/07-file-formats/formats-index.qdoc
+++ b/doc/src/07-file-formats/formats-index.qdoc
@@ -39,7 +39,7 @@
TODO: The whole qdoc for uia needs to be rewritten.
\li \l {The .uia File Format}
\endomit
- \li \l {The .material Format}
+ \li \l {The .shader Format}
\li \l {Custom Materials and Effects}
\endlist
//! [toc]