mirror of https://github.com/qt/qt5compat.git
Doc: Merge Qt Graphical Effects docs
Currently there are two pages that describe the Qt Graphical Effects module, namely, qtgraphicaleffects5-index.html and graphicaleffects5.html. These pages contain most of the same information. This patch merges the information from both pages into one page, namely, qtgraphicaleffects5-index.html. It keeps the categorization of types from graphicaleffects5.html. It deletes redundant information on the page, graphicaleffects5.html. Fixes: QTBUG-132209 Pick-to: 6.7 6.8 6.9 Change-Id: I05eef8a4eaf7d86fbd18d08e58eb5ff7a0a9bb09 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
parent
2d8df31902
commit
99c4232e53
|
@ -1,14 +1,20 @@
|
|||
// Copyright (C) 2020 The Qt Company Ltd.
|
||||
// Copyright (C) 2025 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page graphicaleffects5.html
|
||||
\title Qt 5 Compatibility APIs: Qt Graphical Effects
|
||||
\page qtgraphicaleffects5-index.html
|
||||
\title Qt 5 Compatibility APIs: Graphical Effects
|
||||
|
||||
\brief Effects provided by the Qt Graphical Effects API
|
||||
|
||||
The Qt Graphical Effects module is provided for compatibility with
|
||||
applications written for Qt 5.
|
||||
|
||||
The Qt Graphical Effects module provides a set of QML types for adding
|
||||
visually impressive and configurable effects to user interfaces.
|
||||
Effects are visual items that can be added to Qt Quick user interface as
|
||||
UI components.
|
||||
|
||||
\note Since the Qt Graphical Effects module has performance constraints
|
||||
when effects are stacked, it is primarily included for compatibility with
|
||||
Qt 5 applications. We recommend that new code is written with one of the
|
||||
|
@ -20,22 +26,34 @@
|
|||
|
||||
\section1 Using Qt Graphical Effects
|
||||
|
||||
Effects are visual items that can be added to Qt Quick user interface as UI
|
||||
components. To import the Qt Graphical Effects types, include the Qt
|
||||
Graphical Effects module by adding the following statement to the QML file:
|
||||
To import the Qt Graphical Effects types, include the
|
||||
Qt Graphical Effects module by adding the following statement to the QML
|
||||
file:
|
||||
|
||||
\qml
|
||||
import Qt5Compat.GraphicalEffects
|
||||
\endqml
|
||||
|
||||
To use the effects, simply add a specific effect declaration to the QML
|
||||
scene and configure the effects properties. The source item type can be any
|
||||
QML type, even video or another effect. Pipelining multiple effects together
|
||||
is a simple way to create even more impressive output.
|
||||
scene and configure the effects properties. Effects have one or more source
|
||||
properties for specifying the visual input for which the effect is applied
|
||||
to. The altered visual output is then presented in the effect item itself.
|
||||
The source item type can be any QML type, even video or another effect.
|
||||
Pipelining multiple effects together is a simple way to create even more
|
||||
impressive output.
|
||||
|
||||
The following list presents the functional division of types that are part
|
||||
of Qt Graphical Effects.
|
||||
|
||||
\note Effects are not available when running with the \c software
|
||||
backend of Qt Quick. For more information on Qt Quick scene graph
|
||||
backends, see \l{qtquick-visualcanvas-adaptations.html}{Scene Graph
|
||||
Adaptations}.
|
||||
|
||||
\note Runtime-generated effects such as GaussianBlur will store the
|
||||
shader-files in temporary storage using QTemporaryFile, thus they
|
||||
require a writable file system.
|
||||
|
||||
\section1 Blend
|
||||
\annotatedlist qtgraphicaleffects-blend
|
||||
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
// Copyright (C) 2020 The Qt Company Ltd.
|
||||
// Copyright (C) 2025 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
|
@ -23,52 +23,3 @@
|
|||
applications written for Qt 5.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\title Qt 5 Compatibility APIs: Graphical Effects
|
||||
\page qtgraphicaleffects5-index.html
|
||||
\brief Qt Graphical Effects module is a Qt Quick Add-On module.
|
||||
|
||||
The Qt Graphical Effects module is provided for compatibility with
|
||||
applications written for Qt 5.
|
||||
|
||||
The Qt Graphical Effects module provides a set of QML types for adding visually
|
||||
impressive and configurable effects to user interfaces. Effects are visual
|
||||
items that can be added to Qt Quick user interface as UI components.
|
||||
|
||||
The API consists of over 20 effects provided as separate QML types. The effects
|
||||
cover functional areas such as masking, blurring, coloring, and many more.
|
||||
|
||||
\section1 Getting Started
|
||||
To load Qt Graphical Effects, add the following import statement to your .qml file:
|
||||
\snippet FastBlur-example.qml import
|
||||
|
||||
To use the effects, simply add a specific effect declaration to the QML scene and
|
||||
configure the effects properties. Effects have one or more source properties for
|
||||
specifying the visual input for which the effect is applied to. The altered visual
|
||||
output is then presented in the effect item itself. The source can be another,
|
||||
often hidden, item in the QML scene. More complex effects can have multiple sources.
|
||||
The source item type can be any QML type, even video or another effect. Pipelining
|
||||
multiple effects together is a simple way to create even more impressive output.
|
||||
|
||||
Each effect has a set of properties that can be used to configure the effect output.
|
||||
Properties can be animated just like any other QML properties. The QML type
|
||||
documentation contains property descriptions and basic usage examples.
|
||||
|
||||
\note Effects are not available when running with the \c software
|
||||
backend of Qt Quick. For more information on Qt Quick scene graph
|
||||
backends, see \l{qtquick-visualcanvas-adaptations.html}{Scene Graph
|
||||
Adaptations}.
|
||||
|
||||
\note Runtime-generated effects such as GaussianBlur will store the shader-files in temporary
|
||||
storage using QTemporaryFile, thus they require a writable file system.
|
||||
|
||||
\section1 QML Types
|
||||
\generatelist {qmltypesbymodule Qt5Compat.GraphicalEffects}
|
||||
|
||||
\section1 Reference
|
||||
|
||||
\list
|
||||
\li \l {Qt 5 Compatibility APIs: Qt Graphical Effects}{QML Types}
|
||||
\endlist
|
||||
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue