From 1f0828af4f9fa3b590729578f98a71361dfd9142 Mon Sep 17 00:00:00 2001 From: Teea Poldsam Date: Mon, 3 Jun 2024 14:58:09 +0300 Subject: [PATCH] Doc: Create a landing page for Effects Listed all effects and their descriptions to a Effects landing page Fixes: QDS-12890 Change-Id: I18e3df5a11d9aa4e9abfcbd0c23743b839cb7807 Reviewed-by: Johanna Vanhatapio Reviewed-by: Mats Honkamaa --- .../src/qtdesignstudio-toc.qdoc | 1 + doc/qtdesignstudio/src/qtdesignstudio.qdoc | 1 + .../effects/qtdesignstudio-effects.qdoc | 55 +++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 doc/qtdesignstudio/src/working with/effects/qtdesignstudio-effects.qdoc diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 2da0da559b5..1046205e792 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -119,6 +119,7 @@ \li \l{Prototyping} \list \li \l{Creating UI Logic} + \li \l{Effects} \li \l{Simulating Complex Experiences} \list \li \l{Loading Placeholder Data} diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index d3a0b007d12..b4bbf9a0e78 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -45,6 +45,7 @@ \li \b {\l{Prototyping}} \list \li \l{Creating UI Logic} + \li \l{Effects} \li \l{Simulating Complex Experiences} \li \l{Dynamic Behaviors} \li \l{Validating with Target Hardware} diff --git a/doc/qtdesignstudio/src/working with/effects/qtdesignstudio-effects.qdoc b/doc/qtdesignstudio/src/working with/effects/qtdesignstudio-effects.qdoc new file mode 100644 index 00000000000..6bd5ce93544 --- /dev/null +++ b/doc/qtdesignstudio/src/working with/effects/qtdesignstudio-effects.qdoc @@ -0,0 +1,55 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \previouspage studio-terms.html + \page working-with-effects.html + \nextpage best-practices.html + + \title Effects + + \QDS includes various ready-made effects that you can use in your applications. These effects + are customizable to meet your specific requirements. Alternatively, you can use your own shader + files to create a custom effect. + + The following table summarizes the available effects and their corresponding use cases. + + \table + \header + \li Effect + \li Description + \row + \li \l {Effect Composer} + \li A set of ready-made 2D, 3D, and particle effects that you can combine and customize. + Includes effects like \uicontrol {Color Overlay}, \uicontrol Rain, and \uicontrol + Swirl. + \row + \li \l {Adding an Effect to Your Project}{Content Library Effects} + \li A set of ready-made particle effects. Includes customizable effects like \uicontrol + Bubbles, \uicontrol Explosion, and \uicontrol Shockwave. + \row + \li \l {Design Effects} + \li A feature for adding 2D shadow and blur effects from the \uicontrol Properties + view. + \row + \li \l {Particles}{Particle Effects} + \li A set of ready-made particle effect components like \uicontrol Clouds, \uicontrol Dust, + and \uicontrol Steam. Includes also components for more advanced customization like + \uicontrol Attractor, \uicontrol {Scale Affector}, and \uicontrol Gravity. + \row + \li \l {3D Effects} + \li A set of ready-made 3D effect components. Includes customizable effects like \uicontrol + {Brush Strokes}, \uicontrol {Distortion Sphere}, and \uicontrol {Motion Blur}. + \row + \li \l {2D Effects} + \li A set of ready-made 2D effect components. Includes customizable effects like \uicontrol + {Brightness Control}, \uicontrol {Gamma Adjust}, and \uicontrol {Opacity Mask}. + \row + \li \l {Using Qt Quick Effect Maker Effects}{Qt Quick Effect Maker} + \li Import effects made with \QQEM to \QDS. + \row + \li \l {Custom Effects and Materials}{Custom Effects} + \li Use your own shader files to create a custom effect. + \endtable + +*/