summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarko Niemelä <marko.a.niemela@nokia.com>2012-01-23 10:57:21 +0200
committerMarko Niemelä <marko.a.niemela@nokia.com>2012-01-23 10:57:21 +0200
commitbdc5cd3914fd8861de91060dba1a61a056ed8748 (patch)
treef6d9cd45604a14ba9f25d6a1f9ab5bd0a05b968d /doc
parentbf44122dff24a3407f8f8d33f03b5a6ee7d6c5bf (diff)
downloadqtgraphicaleffects-bdc5cd3914fd8861de91060dba1a61a056ed8748.tar.gz
Clarified transparentBorder property documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/src/qtgraphicaleffects-directionalblur.qdoc19
-rw-r--r--doc/src/qtgraphicaleffects-fastblur.qdoc19
-rw-r--r--doc/src/qtgraphicaleffects-gaussianblur.qdoc19
-rw-r--r--doc/src/qtgraphicaleffects-maskedblur.qdoc19
-rw-r--r--doc/src/qtgraphicaleffects-radialblur.qdoc19
-rw-r--r--doc/src/qtgraphicaleffects-recursiveblur.qdoc16
-rw-r--r--doc/src/qtgraphicaleffects-zoomblur.qdoc19
7 files changed, 62 insertions, 68 deletions
diff --git a/doc/src/qtgraphicaleffects-directionalblur.qdoc b/doc/src/qtgraphicaleffects-directionalblur.qdoc
index 10e1873..0b64a98 100644
--- a/doc/src/qtgraphicaleffects-directionalblur.qdoc
+++ b/doc/src/qtgraphicaleffects-directionalblur.qdoc
@@ -152,19 +152,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::DirectionalBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
*/
diff --git a/doc/src/qtgraphicaleffects-fastblur.qdoc b/doc/src/qtgraphicaleffects-fastblur.qdoc
index 583c1cb..1ace953 100644
--- a/doc/src/qtgraphicaleffects-fastblur.qdoc
+++ b/doc/src/qtgraphicaleffects-fastblur.qdoc
@@ -90,19 +90,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::FastBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
\table
diff --git a/doc/src/qtgraphicaleffects-gaussianblur.qdoc b/doc/src/qtgraphicaleffects-gaussianblur.qdoc
index 67614cf..7679799 100644
--- a/doc/src/qtgraphicaleffects-gaussianblur.qdoc
+++ b/doc/src/qtgraphicaleffects-gaussianblur.qdoc
@@ -161,19 +161,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::GaussianBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
\table
diff --git a/doc/src/qtgraphicaleffects-maskedblur.qdoc b/doc/src/qtgraphicaleffects-maskedblur.qdoc
index bf16d2a..b69f2a3 100644
--- a/doc/src/qtgraphicaleffects-maskedblur.qdoc
+++ b/doc/src/qtgraphicaleffects-maskedblur.qdoc
@@ -140,19 +140,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::MaskedBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
\table
diff --git a/doc/src/qtgraphicaleffects-radialblur.qdoc b/doc/src/qtgraphicaleffects-radialblur.qdoc
index 5fb106a..6fbb282 100644
--- a/doc/src/qtgraphicaleffects-radialblur.qdoc
+++ b/doc/src/qtgraphicaleffects-radialblur.qdoc
@@ -160,19 +160,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::RadialBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
*/
diff --git a/doc/src/qtgraphicaleffects-recursiveblur.qdoc b/doc/src/qtgraphicaleffects-recursiveblur.qdoc
index 3be1041..02dd6bd 100644
--- a/doc/src/qtgraphicaleffects-recursiveblur.qdoc
+++ b/doc/src/qtgraphicaleffects-recursiveblur.qdoc
@@ -95,18 +95,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::RecursiveBlur::transparentBorder
- This property defines the blur behavior near the edges of teh item, where
- the pixel blurring is affected by the pixels utside the source edges.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- If the transparentBorder property is set to \c false, the pixels outside the
- item are interpreted according to the ShaderEffectSource wrapMode property.
- If the source item is Image, the pixels are intrepreted according to the
- fillMode property.
-
- If the property is set to \c true, the pixels outside the item are
+ If the property is set to \c true, the pixels outside the source are
interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
\table
diff --git a/doc/src/qtgraphicaleffects-zoomblur.qdoc b/doc/src/qtgraphicaleffects-zoomblur.qdoc
index 7580772..6970e63 100644
--- a/doc/src/qtgraphicaleffects-zoomblur.qdoc
+++ b/doc/src/qtgraphicaleffects-zoomblur.qdoc
@@ -159,19 +159,18 @@
/*!
\qmlproperty bool QtGraphicalEffects::ZoomBlur::transparentBorder
- This property defines the blur near the edges of the item, where the pixel
- blurring is affected by the pixels just outside the source.
+ This property defines the blur behavior near the edges of the item, where
+ the pixel blurring is affected by the pixels outside the source edges.
- Setting this property to \c false, interprets the pixels outside the item
- according to the OpenGL clamp-to-edge mode. If the source is Image, the pixels
- are interpreted according to the Image::fillMode property. If the source is
- ShaderEffectSource, the pixels are interpreted according to the
- ShaderEffectSource::wrapMode property.
-
- Setting this property to \c true, interprets the pixels outside the item to
- be transparent. This behavior is similar to the OpenGL clamp-to-border
+ If the property is set to \c true, the pixels outside the source are
+ interpreted to be transparent, which is similar to OpenGL clamp-to-border
extension. The blur is expanded slightly outside the effect item area.
+ If the property is set to \c false, the pixels outside the source are
+ interpreted to contain the same color as the pixels at the edge of the item,
+ which is similar to OpenGL clamp-to-edge behavior. The blur does not expand
+ outside the effect item area.
+
By default, the property is set to \c false.
*/