summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@theqtcompany.com>2016-01-22 13:17:44 +0100
committerTopi Reiniƶ <topi.reinio@theqtcompany.com>2016-01-25 08:30:30 +0000
commitedcfa7aada9ff7edceb5808d3a7860256d4b91b7 (patch)
treef08b6f8c3ded446ae160b831b435d9cce8899ed7
parentd237b754d4a50b5e2e2aa3ef1f87f5dee9234983 (diff)
Doc: Use 'Qt 3D' instead of Qt3D consistently
Change-Id: I91c0d00c0116a05209239da399f4076316a51fc7 Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
-rw-r--r--examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc6
-rw-r--r--examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc6
-rw-r--r--examples/qt3d/wireframe/doc/src/wireframe.qdoc10
-rw-r--r--src/doc/src/qt3d-index.qdoc4
-rw-r--r--src/doc/src/qt3d-overview.qdoc8
-rw-r--r--src/doc/src/qt3drender-module.qdoc5
6 files changed, 20 insertions, 19 deletions
diff --git a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
index 86ed7e3e8..68b817553 100644
--- a/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
+++ b/examples/qt3d/basicshapes-cpp/doc/src/basicshapes.qdoc
@@ -29,12 +29,12 @@
\example basicshapes-cpp
\title Qt 3D: Basic Shapes C++ Example
\ingroup qt3d-examples-cpp
- \brief Shows four basic shapes that Qt3D offers and sets up a mesh for each of them.
+ \brief Shows four basic shapes that Qt 3D offers and sets up a mesh for each of them.
\image basicshapes-cpp-example.jpg
- \e {Basic Shapes} shows four basic shapes that Qt3D offers: a torus, a cylinder,
- a cube, and a sphere. The example also shows how to embed a Qt3D scene
+ \e {Basic Shapes} shows four basic shapes that Qt 3D offers: a torus, a cylinder,
+ a cube, and a sphere. The example also shows how to embed a Qt 3D scene
into a widget and connect with other widgets.
\include examples-run.qdocinc
diff --git a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
index c2437100d..b22ebaf53 100644
--- a/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
+++ b/examples/qt3d/shadow-map-qml/doc/src/shadow-map-qml.qdoc
@@ -111,10 +111,10 @@
\section1 Configuring the Framegraph
- In Qt3D, the framegraph is the data-driven configuration for the rendering.
+ In Qt 3D, the framegraph is the data-driven configuration for the rendering.
We implement the framegraph in the \e ShadowMapFrameGraph.qml file.
- In addition to the Qt3D and Qt3D Renderer modules, we also import the
+ In addition to the Qt 3D and Qt 3D Render modules, we also import the
Qt Quick module:
\quotefromfile shadow-map-qml/ShadowMapFrameGraph.qml
@@ -157,7 +157,7 @@
\section1 Generating the Shadow Map
In the shadow map generation pass, we must render to an offscreen surface
- (Framebuffer Object) which has a depth texture attachment. In Qt3D, it is
+ (Framebuffer Object) which has a depth texture attachment. In Qt 3D, it is
represented by the RenderTarget entity, which has a number of attachments.
In this example, we need only a depth attachment. We define it as a
diff --git a/examples/qt3d/wireframe/doc/src/wireframe.qdoc b/examples/qt3d/wireframe/doc/src/wireframe.qdoc
index a3e9c03ae..79d649188 100644
--- a/examples/qt3d/wireframe/doc/src/wireframe.qdoc
+++ b/examples/qt3d/wireframe/doc/src/wireframe.qdoc
@@ -30,12 +30,12 @@
\title Qt 3D: Wireframe QML Example
\ingroup qt3d-examples-qml
- \brief A Qt3D QML application that implements a single-pass wireframe
+ \brief A Qt 3D QML application that implements a single-pass wireframe
rendering method.
\image qt3d-wireframe-rendering.png
- \e {Qt3D Wireframe Rendering} illustrates how to draw a single entity
+ \e {Qt 3D Wireframe Rendering} illustrates how to draw a single entity
(a trefoil knot) using a custom set of shaders to implement a single-pass
wireframe rendering method.
@@ -92,7 +92,7 @@
\printuntil }
- In addition to the \l Mesh element, Qt3D also enables dynamic generation of
+ In addition to the \l Mesh element, Qt 3D also enables dynamic generation of
per-vertex attribute data through C++ hooks that are called by the
task-based engine.
@@ -154,7 +154,7 @@
\section1 Mapping Materials
- Qt3D has a robust and very flexible \l {Qt 3D Overview#Materials}{material
+ Qt 3D has a robust and very flexible \l {Qt 3D Overview#Materials}{material
system} that allows multiple levels of customization. We use the
WireframeMaterial custom type to wrap the \l Material type:
@@ -165,7 +165,7 @@
\skipto TrefoilKnot
\printuntil }
- The Qt3D engine in conjunction with the renderer aspect now has enough
+ The Qt 3D engine in conjunction with the renderer aspect now has enough
information to finally render our mesh using the material we specified.
\section1 Using Animation Elements
diff --git a/src/doc/src/qt3d-index.qdoc b/src/doc/src/qt3d-index.qdoc
index 9c4255ac8..e97f83c02 100644
--- a/src/doc/src/qt3d-index.qdoc
+++ b/src/doc/src/qt3d-index.qdoc
@@ -47,7 +47,7 @@
\annotatedlist qt3d-modules
- For Qt Quick applications, Qt3D provides the following QML modules:
+ For Qt Quick applications, Qt 3D provides the following QML modules:
\annotatedlist qt3d-qmlmodules
@@ -79,7 +79,7 @@
\section1 Overview
- The high level design and motivation for Qt3D is described in the \l {Qt 3D
+ The high level design and motivation for Qt 3D is described in the \l {Qt 3D
Overview}. The Qt 3D Render aspect offers support for data-driven
configuration as described in \l {Qt 3D Render Framegraph}.
diff --git a/src/doc/src/qt3d-overview.qdoc b/src/doc/src/qt3d-overview.qdoc
index 331f508e6..2e1dd053f 100644
--- a/src/doc/src/qt3d-overview.qdoc
+++ b/src/doc/src/qt3d-overview.qdoc
@@ -42,7 +42,7 @@
applications.
Qt 3D provides a fully configurable renderer that enables developers to
- quickly implement any rendering pipeline that they need. Further, Qt3D
+ quickly implement any rendering pipeline that they need. Further, Qt 3D
provides a generic framework for near-realtime simulations beyond rendering.
Qt 3D is cleanly separated into a core and any number of \e aspects that can
@@ -163,7 +163,7 @@
\e Instancing is a way of getting the GPU to draw many copies (instances) of
a base object that varies in some way for each copy. Often, in position,
- orientation, color, material properties, scale, and so on. Qt3D provides an
+ orientation, color, material properties, scale, and so on. Qt 3D provides an
API similar to the Qt Quick \l Repeater element. In this case, the delegate
is the base object and the model provides the per-instance data. So whereas
an entity with a \l Mesh component attached eventually gets transformed into
@@ -196,7 +196,7 @@
\section1 3D Extensions
- Beyond the essentials of displaying 3D content on the screen, Qt3D is
+ Beyond the essentials of displaying 3D content on the screen, Qt 3D is
extensible and flexible enough to act as a host for following types of
extensions related to the 3D objects:
@@ -311,7 +311,7 @@
ignores it.
Qt 3D builds custom entities by aggregating components that provide
- additional capabilities. The Qt3D engine uses aspects to process and
+ additional capabilities. The Qt 3D engine uses aspects to process and
update entities with specific components.
For example, a physics aspect looks for entities that have some kind of
diff --git a/src/doc/src/qt3drender-module.qdoc b/src/doc/src/qt3drender-module.qdoc
index 7bab5cdf8..6cc53fe9d 100644
--- a/src/doc/src/qt3drender-module.qdoc
+++ b/src/doc/src/qt3drender-module.qdoc
@@ -37,14 +37,15 @@
/*!
\module Qt3DRender
\title Qt 3D Render C++ Classes
- \brief The Qt 3D Render module contains functionality to support 2D and 3D rendering using Qt3D.
+ \brief The Qt 3D Render module contains functionality to support 2D and 3D
+ rendering using Qt 3D.
\ingroup modules
\ingroup qt3d-modules
\qtvariable 3drender
The Qt 3D Render module provides an aspect, components, and other supporting types necessary
- to implement 2D and 3D rendering as part of the Qt3D framework.
+ to implement 2D and 3D rendering as part of the Qt 3D framework.
To use classes from this module, add this directive into the C++ files: