diff --git a/doc/qtdesignstudio/config/style/qt5-sidebar.html b/doc/qtdesignstudio/config/style/qt5-sidebar.html index c6f664c4069..a74b3c31c5b 100644 --- a/doc/qtdesignstudio/config/style/qt5-sidebar.html +++ b/doc/qtdesignstudio/config/style/qt5-sidebar.html @@ -29,6 +29,7 @@
  • Creating UI logic
  • Components
  • Designer-developer workflow
  • +
  • Effects and shaders
  • Qt Design Studio on MCUs
  • @@ -320,7 +321,9 @@
  • Particle System: The rain and the snow effects
  • Setting up a 3D scene
  • Timeline animation
  • -
  • Using AI-generated shader code in Qt Design Studio
  • +
  • Using AI-generated shader code in Effect Composer
  • +
  • Using a shader from Shadertoy in Effect Composer
  • +
  • Using a shader from The Book of Shaders in Effect Composer
  • diff --git a/doc/qtdesignstudio/examples/doc/AIshadercodeTutorial.qdoc b/doc/qtdesignstudio/examples/doc/AIshadercodeTutorial.qdoc index e7411e7b7a9..0d0fbc88cc5 100644 --- a/doc/qtdesignstudio/examples/doc/AIshadercodeTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/AIshadercodeTutorial.qdoc @@ -5,7 +5,7 @@ \page ai-shader-tutorial.html \ingroup gstutorials - \sa {Effect Composer} + \sa {Effect Composer}, {Effect Composer example}, {Working with shader code in Effect Composer} \brief Illustrates how to take AI-genetrated shader code into use in Effect Composer. diff --git a/doc/qtdesignstudio/examples/doc/ShaderToyTutorial.qdoc b/doc/qtdesignstudio/examples/doc/ShaderToyTutorial.qdoc index c232f50a5e4..315db498f31 100644 --- a/doc/qtdesignstudio/examples/doc/ShaderToyTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/ShaderToyTutorial.qdoc @@ -5,7 +5,7 @@ \page effect-composer-shadertoy.html \ingroup gstutorials - \sa {Effect Composer} + \sa {Effect Composer}, {Effect Composer example}, {Working with shader code in Effect Composer} \title Using a shader from Shadertoy in Effect Composer diff --git a/doc/qtdesignstudio/examples/doc/TheBookOfShadersTutorial.qdoc b/doc/qtdesignstudio/examples/doc/TheBookOfShadersTutorial.qdoc index efbbb95569a..15a4a73f68b 100644 --- a/doc/qtdesignstudio/examples/doc/TheBookOfShadersTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/TheBookOfShadersTutorial.qdoc @@ -5,7 +5,7 @@ \page effect-composer-thebookofshaders.html \ingroup gstutorials - \sa {Effect Composer} + \sa {Effect Composer}, {Effect Composer example}, {Working with shader code in Effect Composer} \title Using a shader from The Book of Shaders in Effect Composer @@ -84,7 +84,7 @@ \li In \QDS, open the \uicontrol {Effect Composer} view. \li From the \uicontrol {Add Effect} dropdown menu (1), select \uicontrol {Custom} (2). The custom effect node is an empty effect node. - + \endlist \image add-custom-effect-node.webp Adding a custom effect to an effect composition. \section1 Copying the shader code to Shaders Code Editor @@ -134,7 +134,7 @@ \li \c gl_FragCoord to \c fragCoord \li \c gl_FragColor to \c fragColor \endlist - + \endlist The code in \uicontrol{Shaders Code Editor} should now look like this: \code // 2D Random diff --git a/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc b/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc index 5f85955c8a4..2751d9c1be3 100644 --- a/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc +++ b/doc/qtdesignstudio/examples/doc/effectComposerExample.qdoc @@ -5,6 +5,11 @@ \page effect-composer-example.html \ingroup studioexamples + \sa {Effect Composer}, {Using a shader from Shadertoy in Effect Composer}, + {Using a shader from The Book of Shaders in Effect Composer}, + {Using AI-generated shader code in Effect Composer}, + {Working with shader code in Effect Composer} + \title Effect Composer example \brief Illustrates how to work with the Effect Composer effects. diff --git a/doc/qtdesignstudio/src/best practices/best-practices-shader-code.qdoc b/doc/qtdesignstudio/src/best practices/best-practices-shader-code.qdoc index abbc5691bb3..7ddd066e961 100644 --- a/doc/qtdesignstudio/src/best practices/best-practices-shader-code.qdoc +++ b/doc/qtdesignstudio/src/best practices/best-practices-shader-code.qdoc @@ -6,6 +6,11 @@ \title Working with shader code in Effect Composer + \sa {Effect Composer}, {Effect Composer example}, + {Using a shader from Shadertoy in Effect Composer}, + {Using a shader from The Book of Shaders in Effect Composer}, + {Using AI-generated shader code in Effect Composer} + This page contains tips, tricks, and best practices for working with shader code in the \uicontrol {Effect Composer} view. diff --git a/doc/qtdesignstudio/src/effects-concept.qdoc b/doc/qtdesignstudio/src/effects-concept.qdoc index 715e11a2d2d..a79198edf25 100644 --- a/doc/qtdesignstudio/src/effects-concept.qdoc +++ b/doc/qtdesignstudio/src/effects-concept.qdoc @@ -6,6 +6,11 @@ \previouspage \nextpage + \sa {Effect Composer}, {Effect Composer example}, + {Using a shader from Shadertoy in Effect Composer}, + {Using a shader from The Book of Shaders in Effect Composer}, + {Using AI-generated shader code in Effect Composer} + \title Effects and shaders in \QDS \brief Effects in \QDS. @@ -41,14 +46,14 @@ To get started with Effect Composer, see the following documentation: \li \l {Effect Composer} \li Learn how to work with Effect Composer. \row - \li \l {Effect Composer example}{Example: The Effect Composer Exampler} + \li \l {Effect Composer example}{Example: The Effect Composer Example} \li Download and explore this example to learn how you can create, add and control effects. \row \li \l {Using a shader from Shadertoy in Effect Composer}{Tutorial: Using a shader from Shadertoy in Effect Composer} - \li A step-by-step guide describing how to create a shader in ShaderToy and use it in \QDS. + \li A step-by-step guide describing how to copy a shader from ShaderToy and use it in \QDS. \row \li \l {Using a shader from The Book of Shaders in Effect Composer}{Tutorial: Use a shader from Book of Shaders} - \li A step-by-step guide describing how to use a shader from Book of Shaders and use it in \QDS. + \li A step-by-step guide describing how to copy a shader from Book of Shaders and use it in \QDS. \row \li \l {Using AI-generated shader code in Effect Composer}{Tutorial: Using AI-generated shader code in Effect Composer} \li A step-by-step guide describing how to use chatGPT to create a shader and use it in \QDS. @@ -56,7 +61,7 @@ To get started with Effect Composer, see the following documentation: \li \l {Working with shader code in Effect Composer}{Best practices} \li Tips, tricks, and best practices on how to work with shader code in \QDS. \row - \li \l{https://wiki.qt.io/QtDesignStudio/EffectComposer}{Known Issues} + \li \l{https://wiki.qt.io/QtDesignStudio/EffectComposer}{Known issues} \li Known issues and work arounds. \endtable diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc index 710e6a444b0..76b69952e43 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc @@ -72,6 +72,7 @@ \li \l{Introduction to animation techniques}{Animation techniques} \li \l{Asset creation with other tools}{Creating assets with other tools} \li \l{Creating UI logic} + \li \l{Effects and shaders in \QDS}{Effects and shaders} \li \l{Using components}{Components} \li \l{Designer-developer workflow} \li \l{Qt Design Studio on MCUs} diff --git a/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc b/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc index 0925a9c566c..24196b640ce 100644 --- a/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-effect-maker-view.qdoc @@ -6,6 +6,11 @@ \previouspage studio-qt-insight.html \nextpage studio-model-editor.html + \sa {Effect Composer example}, {Using a shader from Shadertoy in Effect Composer}, + {Using a shader from The Book of Shaders in Effect Composer}, + {Using AI-generated shader code in Effect Composer}, + {Working with shader code in Effect Composer} + \ingroup studio-views \title Effect Composer @@ -154,7 +159,7 @@ can use as a part of your effect composition. For some sources, such as \e {The Book of Shaders}, you may have to re-name the uniforms to use them in the \QDS \uicontrol {Effect Composer}. For more information, see - \l {Working with Shadercode in Effect Composer}. + \l {Working with shader code in Effect Composer}. \section2 Using shaders from Shadertoy @@ -195,6 +200,7 @@ \li Copy the code inside \c {void main} and paste it below the \c {@main} tag, inside {}. \li Edit the uniforms of the original shader code in \uicontrol {Shaders Code Editor} as described in \l {External resources}{Working with Shadercode in Effect Composer}. + \endlist For more information, see \l{Using a shader from The Book of Shaders in Effect Composer}. @@ -303,5 +309,4 @@ in the first step as \uicontrol {Source Item}. \endlist - \sa {Effect Composer example} */