diff --git a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc index 5250f79af3c..47b6b3dd00e 100644 --- a/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc @@ -4,7 +4,11 @@ /*! \page creator-open-documents-view.html \previouspage creator-file-system-view.html + \if defined(qtdesignstudio) + \nextpage studio-content-library.html + \else \nextpage creator-output-panes.html + \endif \title Open Documents diff --git a/doc/qtdesignstudio/images/content-library-add-texture.png b/doc/qtdesignstudio/images/content-library-add-texture.png new file mode 100644 index 00000000000..ae820a39c86 Binary files /dev/null and b/doc/qtdesignstudio/images/content-library-add-texture.png differ diff --git a/doc/qtdesignstudio/images/content-library.webp b/doc/qtdesignstudio/images/content-library.webp new file mode 100644 index 00000000000..ac5ca5f6971 Binary files /dev/null and b/doc/qtdesignstudio/images/content-library.webp differ diff --git a/doc/qtdesignstudio/images/material-editor-browser.webp b/doc/qtdesignstudio/images/material-editor-browser.webp index 8933b9d8e63..160c96e877c 100644 Binary files a/doc/qtdesignstudio/images/material-editor-browser.webp and b/doc/qtdesignstudio/images/material-editor-browser.webp differ diff --git a/doc/qtdesignstudio/images/select-material-property.png b/doc/qtdesignstudio/images/select-material-property.png new file mode 100644 index 00000000000..3202c587473 Binary files /dev/null and b/doc/qtdesignstudio/images/select-material-property.png differ diff --git a/doc/qtdesignstudio/images/texture-editor.png b/doc/qtdesignstudio/images/texture-editor.png new file mode 100644 index 00000000000..e8eecbd13b6 Binary files /dev/null and b/doc/qtdesignstudio/images/texture-editor.png differ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index d6532059598..5271e5507fb 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -32,6 +32,8 @@ \li \l{Projects} \li \l{File System} \li \l{Open Documents} + \li \l{Content Library} + \li \l{Texture Editor} \endlist \li \l{Managing Workspaces} \li \l{Managing Sessions} diff --git a/doc/qtdesignstudio/src/views/studio-content-library.qdoc b/doc/qtdesignstudio/src/views/studio-content-library.qdoc new file mode 100644 index 00000000000..67d67c91534 --- /dev/null +++ b/doc/qtdesignstudio/src/views/studio-content-library.qdoc @@ -0,0 +1,66 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page studio-content-library.html + \previouspage creator-open-documents-view.html + \nextpage studio-texture-editor.html + + \title Content Library + + \note The \uicontrol {Content Library} view is included in the + \l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}. + + The \uicontrol{Content Library} view contains material, texture, and + environment bundles with assets that you can use in your project. When you + have added an asset from \uicontrol {Content Library}, you can use it in + your project. + + \image content-library.webp + + \section1 Adding a Material to Your Project + + You can use materials on 3D models. + + To add a material from the \uicontrol {Content Library} view to your + project, do one of the following: + + \list + \li Select the \inlineimage icons/plus.png + next to the material in the \uicontrol {Content Library} view. + \li Right-click the material in the \uicontrol {Content Library} view and + select \uicontrol{Add an instance to the project}. + \endlist + + You can also add a material to a 3D model straight from the \uicontrol {Content Library} view. + This also adds the material to the project. + + To add a material to a 3D model, do one of the following: + + \list + \li Drag the material from the \uicontrol {Content Library} view to a 3D + model in the \uicontrol 3D or \uicontrol Navigator view. + \li With a 3D model selected, right-click the material in the + \uicontrol {Content Library} view and select \uicontrol{Apply to selected}. + \endlist + + \section1 Adding a Texture or Environment to Your Project + + To add a texture or environment to your project, right-click the image + in the \uicontrol {Content Library} view and select one of the options: + \list + \li \uicontrol {Add image}. This adds the image as an asset to your project. You can + access the image from the \uicontrol Assets view. + \li \uicontrol {Add texture}. This adds the image as a texture to your project. You can + access the texture from the \uicontrol Textures section in the \uicontrol{Material Browser} + view. + \li \uicontrol {Add light probe}. This adds the image as a light probe for your scene, using + the image to illuminate the scene and as a skybox. When you set an image as light probe, the + following properties are set for \uicontrol {Scene Environment}: + \list + \li \uicontrol Background Mode is set to skybox. + \li \uicontrol {Light Probe} > \uicontrol Image is set to the selected texture. + \endlist + \endlist + +*/ diff --git a/doc/qtdesignstudio/src/views/studio-material-editor.qdoc b/doc/qtdesignstudio/src/views/studio-material-editor.qdoc index 4120bb633e4..94209c7bcb9 100644 --- a/doc/qtdesignstudio/src/views/studio-material-editor.qdoc +++ b/doc/qtdesignstudio/src/views/studio-material-editor.qdoc @@ -10,11 +10,13 @@ \title Material Editor and Browser In the \uicontrol {Material Editor} and \uicontrol {Material Browser} views, - you create and manage materials. + you create and manage materials and textures. \image material-editor-browser.webp "Material Editor and Browser" - \section1 Creating a Material + \section1 Working with Materials + + \section2 Creating a Material To create a new material, do one of the following: @@ -25,7 +27,7 @@ . \endlist - \section1 Editing a Material + \section2 Editing a Material To edit a material, select it in \uicontrol{Material Browser} and edit its properties in \uicontrol{Material Editor}. If \uicontrol {Material Editor} @@ -37,7 +39,7 @@ \li In \uicontrol{Material Browser}, double-click a material. \endlist - \section1 Assigning a Material to an Object + \section2 Assigning a Material to an Object To assign a material to a 3D object in your project, drag the material from \uicontrol {Material Browser} to the object in the \uicontrol Navigator or @@ -57,7 +59,7 @@ . This replaces any material already assigned to the object. \endlist - \section1 Removing a Material from an Object + \section2 Removing a Material from an Object To remove an assigned material from an object: \list 1 @@ -68,7 +70,7 @@ \image materials-remove-material.png \endlist - \section1 Copying and Pasting Material Properties + \section2 Copying and Pasting Material Properties You can copy properties from one material to another. You can choose if you want to copy all properties or certain property groups. @@ -88,7 +90,7 @@ \note You can't copy material properties between materials of different material types. - \section1 Using Texture Maps + \section2 Using Texture Maps In \QDS you can add many different texture maps to your material. @@ -100,7 +102,7 @@ the image to \uicontrol{Diffuse Map} in \uicontrol{Material Editor}. \endlist - \section2 Using a Reflection Map for Environmental Mapping + \section3 Using a Reflection Map for Environmental Mapping To use a texture for environmental mapping, you need to set the mapping mode to \e {environment}. @@ -122,7 +124,7 @@ \uicontrol {Environment}. \endlist - \section1 Blending Colors + \section2 Blending Colors To determine how the colors of a model blend with the colors of the models behind it, set the \uicontrol {Blend mode} property. To make opaque objects @@ -144,7 +146,7 @@ For a result with higher contrast, select \uicontrol Overlay, which is a mix of the multiply and screen modes. - \section1 Lighting Materials + \section2 Lighting Materials To set the lighting method for generating a material, use the \uicontrol Lighting property. Select \uicontrol {Fragment lighting} to @@ -164,7 +166,7 @@ the opacity of the material independently of the model as the value of the \uicontrol Opacity property. - \section1 Self-Illuminating Materials + \section2 Self-Illuminating Materials To set the color and amount of self-illumination for a material, use the \uicontrol {Emissive color} and \uicontrol {Emissive factor} properties. In @@ -177,7 +179,7 @@ image does not affect the color of the result, while using a color image produces glowing regions with the color affected by the emissive map. - \section1 Using Highlights and Reflections + \section2 Using Highlights and Reflections You can control the highlights and reflections on a material by setting the properties in the \uicontrol Specular group. You can use the color picker @@ -221,7 +223,7 @@ highlights and blurring reflections. To control the specular roughness of the material using a Texture, set the \uicontrol {Roughness map property}. - \section1 Simulating Geometry Displacement + \section2 Simulating Geometry Displacement Specify the properties in the \uicontrol {Bump/Normal} group to simulate fine geometry displacement across the surface of the material. Set the @@ -240,7 +242,7 @@ of the material. The \uicontrol {Displacement amount} property specifies the offset amount. - \section1 Specifying Material Translucency + \section2 Specifying Material Translucency Set the properties in the \uicontrol Translucency group to control how much light can pass through the material from behind. To use a grayscale texture, @@ -254,7 +256,7 @@ the angle of the normals of the object to the light source, set the \uicontrol {Translucency falloff} property. - \section1 Culling Faces + \section2 Culling Faces Set the \uicontrol {Culling mode} property to determine whether the front and back faces of a model are rendered. Culling modes check whether the @@ -265,4 +267,32 @@ is not rendered. Culling makes rendering objects quicker and more efficient by reducing the number of polygons to draw. + \section1 Working with Textures + + \target creating texture material browser + + \section2 Creating a Texture + + To create a new texture, do one of the following in + \uicontrol {Material Browser}: + \list + \li Select \inlineimage icons/plus.png + in the \uicontrol Textures section. + \li Right-click anywhere in the \uicontrol Textures section and select + \uicontrol {Create new texture}. + \endlist + + \note You can also create textures from the \l {Assets} or + \l {Texture Editor} views. + + \section2 Applying a Texture to a Material + + To apply a texture to a material, select the material in + \uicontrol {Material Browser} and do one of the following: + \list + \li Right-click the texture and select + \uicontrol {Apply to selected material}. + \li Drag the texture to a supported property in the + \uicontrol {Material Editor} + \endlist */ diff --git a/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc b/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc new file mode 100644 index 00000000000..95a99401a9c --- /dev/null +++ b/doc/qtdesignstudio/src/views/studio-texture-editor.qdoc @@ -0,0 +1,47 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page studio-texture-editor.html + \previouspage studio-content-library.html + \nextpage creator-project-managing-workspaces.html + + \title Texture Editor + + In the \uicontrol {Texture Editor} view, you create and manage textures. + + \image texture-editor.png + + \section1 Creating a Texture + + To create a texture, select \inlineimage icons/plus.png + in the \uicontrol {Texture Editor} view. + + \note You can also create textures from the + \l{creating texture material browser}{Material Browser view}. + + When you create a texture, it is empty. To add an image to the texture, + do one of the following: + + \list + \li In the \uicontrol{Texture Editor} view, set the image in the + \uicontrol Source property. + \li From the \uicontrol Assets view, drag an image to the + \uicontrol Source property in the \uicontrol {Texture Editor} view. + \endlist + + \section1 Applying a Texture to a Material + + To apply a texture to a material, first select the material in the + \uicontrol {Material Browser} view and then: + \list 1 + \li Select \inlineimage icons/apply-material.png + . + \li Select the material and property that you want to add the texture to. + \image select-material-property.png + \endlist + + \note You can also apply textures to materials in the + \l {Material Editor and Browser}{Material Browser view}. + +*/ diff --git a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc index a6a6d97dfb0..fdc359d96d1 100644 --- a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc +++ b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc @@ -3,7 +3,11 @@ /*! \page creator-project-managing-workspaces.html + \if defined(qtdesignstudio) + \previouspage studio-texture-editor.html + \else \previouspage creator-open-documents-view.html + \endif \nextpage creator-project-managing-sessions.html \title Managing Workspaces