Doc: Update info about 2D effects
The effects can now be dragged to components in Navigator. Add icons to the table to follow the new style of listing components. Fixes: QDS-3153 Change-Id: I2c603acb165f809143b04adb93f65a2655344fab Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
BIN
doc/qtdesignstudio/images/icons/blend-mode-16px.png
Normal file
After Width: | Height: | Size: 299 B |
BIN
doc/qtdesignstudio/images/icons/brightness-contrast-16px.png
Normal file
After Width: | Height: | Size: 226 B |
BIN
doc/qtdesignstudio/images/icons/colourize-16px.png
Normal file
After Width: | Height: | Size: 388 B |
BIN
doc/qtdesignstudio/images/icons/desaturation-16px.png
Normal file
After Width: | Height: | Size: 162 B |
BIN
doc/qtdesignstudio/images/icons/directional-blur-16px.png
Normal file
After Width: | Height: | Size: 277 B |
BIN
doc/qtdesignstudio/images/icons/drop-shadow-16px.png
Normal file
After Width: | Height: | Size: 119 B |
BIN
doc/qtdesignstudio/images/icons/fast-blur-16px.png
Normal file
After Width: | Height: | Size: 258 B |
BIN
doc/qtdesignstudio/images/icons/glow-16px.png
Normal file
After Width: | Height: | Size: 376 B |
BIN
doc/qtdesignstudio/images/icons/hue-saturation-16px.png
Normal file
After Width: | Height: | Size: 371 B |
BIN
doc/qtdesignstudio/images/icons/mask-blur-16px.png
Normal file
After Width: | Height: | Size: 300 B |
BIN
doc/qtdesignstudio/images/icons/opacity-mask-16px.png
Normal file
After Width: | Height: | Size: 150 B |
BIN
doc/qtdesignstudio/images/icons/radial-blur-16px.png
Normal file
After Width: | Height: | Size: 337 B |
BIN
doc/qtdesignstudio/images/icons/zoom-blur-16px.png
Normal file
After Width: | Height: | Size: 325 B |
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2019 The Qt Company Ltd.
|
** Copyright (C) 2020 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Design Studio documentation.
|
** This file is part of the Qt Design Studio documentation.
|
||||||
@@ -30,20 +30,19 @@
|
|||||||
|
|
||||||
\QDS provides a set of Qt Quick Studio effects that inherit the types in the
|
\QDS provides a set of Qt Quick Studio effects that inherit the types in the
|
||||||
\l {Qt Graphical Effects} module. To apply a visual effect to a component,
|
\l {Qt Graphical Effects} module. To apply a visual effect to a component,
|
||||||
you must place the component inside the effect. First drag-and-drop an
|
drag-and-drop it from \uicontrol Library > \uicontrol Effects to the
|
||||||
effect from \uicontrol Library > \uicontrol Effects to the the
|
component in \uicontrol Navigator.
|
||||||
\uicontrol {Form Editor} or the \uicontrol Navigator, and then drag-and-drop
|
|
||||||
the component to the effect. For some effects, you need two source
|
|
||||||
components.
|
|
||||||
|
|
||||||
The following table summarizes the available effects and contains links to
|
The following table summarizes the available effects and contains links to
|
||||||
the documentation of the inherited QML type.
|
the documentation of the inherited QML type.
|
||||||
|
|
||||||
\table
|
\table
|
||||||
\header
|
\header
|
||||||
|
\li Icon
|
||||||
\li Qt Quick Studio Effect
|
\li Qt Quick Studio Effect
|
||||||
\li Description
|
\li Description
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/blend-mode-16px.png
|
||||||
\li \l [QML] {Blend}
|
\li \l [QML] {Blend}
|
||||||
\li Merges two source components by using a blend mode.
|
\li Merges two source components by using a blend mode.
|
||||||
|
|
||||||
@@ -54,34 +53,44 @@
|
|||||||
For a list of possible values and examples of their use, see
|
For a list of possible values and examples of their use, see
|
||||||
\l{Blend::mode}{Blend.mode}.
|
\l{Blend::mode}{Blend.mode}.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/fast-blur-16px.png
|
||||||
\li \l {FastBlur}{Blur}
|
\li \l {FastBlur}{Blur}
|
||||||
\li Applies a fast blur effect to one or more source components.
|
\li Applies a fast blur effect to one or more source components.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/brightness-contrast-16px.png
|
||||||
\li \l {BrightnessContrast}{Brightness Contrast}
|
\li \l {BrightnessContrast}{Brightness Contrast}
|
||||||
\li Adjusts brightness and contrast.
|
\li Adjusts brightness and contrast.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/colourize-16px.png
|
||||||
\li \l {ColorOverlay}{Color Overlay}
|
\li \l {ColorOverlay}{Color Overlay}
|
||||||
\li Alters the colors of the source component by applying an overlay
|
\li Alters the colors of the source component by applying an overlay
|
||||||
color.
|
color.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/colourize-16px.png
|
||||||
\li \l Colorize
|
\li \l Colorize
|
||||||
\li Sets the color in the HSL color space.
|
\li Sets the color in the HSL color space.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/directional-blur-16px.png
|
||||||
\li \l {DirectionalBlur}{Directional Blur}
|
\li \l {DirectionalBlur}{Directional Blur}
|
||||||
\li Applies blur effect to the specified direction.
|
\li Applies blur effect to the specified direction.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/drop-shadow-16px.png
|
||||||
\li \l {DropShadow}{Drop Shadow}
|
\li \l {DropShadow}{Drop Shadow}
|
||||||
\li Generates a soft shadow behind the source component.
|
\li Generates a soft shadow behind the source component.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/glow-16px.png
|
||||||
\li \l [QML] {Glow}
|
\li \l [QML] {Glow}
|
||||||
\li Generates a halo-like glow around the source component.
|
\li Generates a halo-like glow around the source component.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/hue-saturation-16px.png
|
||||||
\li \l {HueSaturation}{Hue Saturation}
|
\li \l {HueSaturation}{Hue Saturation}
|
||||||
\li Alters the source component colors in the HSL color space.
|
\li Alters the source component colors in the HSL color space.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/opacity-mask-16px.png
|
||||||
\li \l {OpacityMask}{Mask}
|
\li \l {OpacityMask}{Mask}
|
||||||
\li Masks the source component with another component.
|
\li Masks the source component with another component.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/mask-blur-16px.png
|
||||||
\li \l {MaskedBlur}{Masked Blur}
|
\li \l {MaskedBlur}{Masked Blur}
|
||||||
\li Applies a blur effect with a varying intesity.
|
\li Applies a blur effect with a varying intesity.
|
||||||
The \l GradientStop type is used to specify the color used at a
|
The \l GradientStop type is used to specify the color used at a
|
||||||
@@ -89,13 +98,16 @@
|
|||||||
The default positions for the stops are 0.20, 0.50, 0.80, and 1.00.
|
The default positions for the stops are 0.20, 0.50, 0.80, and 1.00.
|
||||||
The default color is black.
|
The default color is black.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/radial-blur-16px.png
|
||||||
\li \l {RadialBlur}{Radial Blur}
|
\li \l {RadialBlur}{Radial Blur}
|
||||||
\li Applies directional blur in a circular direction around the
|
\li Applies directional blur in a circular direction around the
|
||||||
component's center point.
|
component's center point.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/desaturation-16px.png
|
||||||
\li \l {Desaturate}{Saturation}
|
\li \l {Desaturate}{Saturation}
|
||||||
\li Reduces the saturation of the colors.
|
\li Reduces the saturation of the colors.
|
||||||
\row
|
\row
|
||||||
|
\li \inlineimage icons/zoom-blur-16px.png
|
||||||
\li \l {ZoomBlur}{Zoom Blur}
|
\li \l {ZoomBlur}{Zoom Blur}
|
||||||
\li Applies directional blur effect towards source component's center
|
\li Applies directional blur effect towards source component's center
|
||||||
point.
|
point.
|
||||||
|