aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGunnar Sletta <gunnar.sletta@digia.com>2012-11-27 16:57:02 +0100
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-11-27 17:20:29 +0100
commit76251c91afdfbe6d0d9679c2036cbf72c7ee3cde (patch)
treea217e3c10a34f4f2416d909b0072e14c581c8fe2
parent80fd41c06019ed07eb44218c72faf54c0f7be696 (diff)
Fix the QML Effects docs up a bit
Change-Id: I09226e8796be6a9785496192a5e3114d01e2ffd7 Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
-rw-r--r--src/quick/doc/src/concepts/effects/shaders.qdoc53
-rw-r--r--src/quick/doc/src/concepts/effects/sprites.qdoc2
-rw-r--r--src/quick/doc/src/concepts/effects/topic.qdoc15
-rw-r--r--src/quick/doc/src/concepts/effects/transformations.qdoc26
4 files changed, 36 insertions, 60 deletions
diff --git a/src/quick/doc/src/concepts/effects/shaders.qdoc b/src/quick/doc/src/concepts/effects/shaders.qdoc
deleted file mode 100644
index f31f653edb..0000000000
--- a/src/quick/doc/src/concepts/effects/shaders.qdoc
+++ /dev/null
@@ -1,53 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
-** Contact: http://www.qt-project.org/legal
-**
-** 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 Digia. For licensing terms and
-** conditions see http://qt.digia.com/licensing. For further information
-** use the contact form at http://qt.digia.com/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: http://www.gnu.org/copyleft/fdl.html.
-** $QT_END_LICENSE$
-**
-****************************************************************************/
-
-/*!
-\ingroup qtquick-shaders
-\page qtquick-effects-shaders.html
-\title Qt Quick Shader Effects
-\brief For applying OpenGL vertex and fragment shaders to rectangles
-
-\section1 Related Types
-\generatelist{related}
-
-\section1 Shaders
-Describe Shaders and where it could be used in UIs or applications
-Mention OpenGL shader language (GLSL)
-
-\section1 ShaderEffect Element
-Introduce the \l{QtQuick2::ShaderEffect} Element.
-Say what is possible and how to load shaders
-
-\section1 Shader Overview
-Go over shaders in more detail and what shaders actually do.
-
-\section2 Vertex Shader
-Go over vertex shaders
-
-\section2 Fragment Shader
-Go over fragment shaders
-*/
diff --git a/src/quick/doc/src/concepts/effects/sprites.qdoc b/src/quick/doc/src/concepts/effects/sprites.qdoc
index 2b0681a28d..9f32724bfb 100644
--- a/src/quick/doc/src/concepts/effects/sprites.qdoc
+++ b/src/quick/doc/src/concepts/effects/sprites.qdoc
@@ -32,8 +32,6 @@
\title Sprite Animations
\brief Sprite-based animations with flexible transitioning
-\section1 Related Types
-
\generatelist{related}
\section1 Sprite Engine
diff --git a/src/quick/doc/src/concepts/effects/topic.qdoc b/src/quick/doc/src/concepts/effects/topic.qdoc
index 3e796e2f37..03450d8a05 100644
--- a/src/quick/doc/src/concepts/effects/topic.qdoc
+++ b/src/quick/doc/src/concepts/effects/topic.qdoc
@@ -52,14 +52,13 @@ page titled \l{qtquick-effects-transformations.html}
\section1 Shader Effects
Shader effects allow the full, raw power of a graphics processing unit to be
-utilized directly via vertex and pixel shaders. Using too many shader effects
+utilized directly via vertex and fragment shaders. Using too many shader effects
can result in increased power usage and sometimes slow performance, but if
used sparingly and carefully, a shader can allow complex and visually appealing
effects to be applied to a visual object (for example, ripples in water).
-For information about shader programs and shader effects, see the page
-titled \l{qtquick-effects-shaders.html}
-{Qt Quick Shader Effects}.
+For information about shader effects, see the \l {ShaderEffect}
+reference documentation.
\section1 Particles
@@ -83,6 +82,14 @@ which use sprites extensively (such as games).
For information about sprite animations, see the page titled
\l{qtquick-effects-sprites.html}{Sprite Animations}.
+\section1 Opacity
+
+Visual objects can be opaque or translucent. For example, an application
+can make one visual object opaque and other visual objects translucent
+to focus the users attention on the opaque one. This is controlled using the
+\c{opacity} property of the Item.
+
+For more information about opacity, see the \l {Item} documentation.
*/
diff --git a/src/quick/doc/src/concepts/effects/transformations.qdoc b/src/quick/doc/src/concepts/effects/transformations.qdoc
index b9a549cdea..7c632c4360 100644
--- a/src/quick/doc/src/concepts/effects/transformations.qdoc
+++ b/src/quick/doc/src/concepts/effects/transformations.qdoc
@@ -31,6 +31,30 @@
\title Qt Quick Transformation Types
\brief Types for applying transformations to visual types
-\section1 Related Types
\generatelist{related}
+
+Transformations are applied to child hierarchies and also will also transform
+mouse and touch input so coordinates in event handlers behave as expected.
+
+\section1 Item Properties
+
+The \l {Item} contains a number of convenience properties,
+covering the most common types of transformations.
+
+\list
+ \li \c {x} and \c{y}; Translates the item.
+ \li \c {scale}; Applies a uniform scale factor to the item.
+ \li \c {rotation}; Applies a counterclockwise rotation of the item.
+ \li \c {transformOrigin}; Used in conjunction with scale and rotation to
+ change the origin of the transformation.
+\endlist
+
+\section1 Transform List
+
+In addition to the convenience types, it is possible to define more
+comprehensive transformations using a list of
+\l {Scale}, \l {Rotation},
+and \l {Translate} objects to the \c {transform}
+property of the \l {Item}.
+
*/