diff options
Diffstat (limited to 'src/render')
37 files changed, 67 insertions, 67 deletions
diff --git a/src/render/framegraph/qcameraselector.cpp b/src/render/framegraph/qcameraselector.cpp index b0e55902a..45abf638e 100644 --- a/src/render/framegraph/qcameraselector.cpp +++ b/src/render/framegraph/qcameraselector.cpp @@ -54,7 +54,7 @@ namespace Qt3DRender { \since 5.5 \ingroup framegraph - \brief Class to allow for selection of camera to be used + \brief Class to allow for selection of camera to be used. A Qt3DRender::QCameraSelector can be used to select the camera, which is used by the FrameGraph when drawing the entities. @@ -66,7 +66,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QCameraSelector \inherits FrameGraphNode \since 5.5 - \brief Class to allow for selection of camera to be used + \brief Class to allow for selection of camera to be used. A CameraSelector can be used to select the camera, which is used by the FrameGraph when drawing the entities. diff --git a/src/render/framegraph/qclearbuffers.cpp b/src/render/framegraph/qclearbuffers.cpp index 7b2868e66..597a30c19 100644 --- a/src/render/framegraph/qclearbuffers.cpp +++ b/src/render/framegraph/qclearbuffers.cpp @@ -50,7 +50,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.7 \ingroup framegraph - \brief Class to clear buffers + \brief Class to clear buffers. A Qt3DRender::QClearBuffers FrameGraph node enables clearing of the specific render target buffers with specific values. @@ -62,7 +62,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QClearBuffers \inherits FrameGraphNode \since 5.7 - \brief Class to clear buffers + \brief Class to clear buffers. A Qt3DRender::QClearBuffers FrameGraph node enables clearing of the specific render target buffers with specific values. diff --git a/src/render/framegraph/qdispatchcompute.cpp b/src/render/framegraph/qdispatchcompute.cpp index 4ef55998e..6e018d8ef 100644 --- a/src/render/framegraph/qdispatchcompute.cpp +++ b/src/render/framegraph/qdispatchcompute.cpp @@ -49,7 +49,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.7 \ingroup framegraph - \brief FrameGraph node to issue work for the compute shader on GPU + \brief FrameGraph node to issue work for the compute shader on GPU. A Qt3DRender::QDispatchCompute allows work to be issued for the compute shader to run on the GPU. The workGroupX, workGroupY and workGroupZ properties specify the work group @@ -66,7 +66,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QDispatchCompute \inherits FrameGraphNode \since 5.7 - \brief FrameGraph node to issue work for the compute shader on GPU + \brief FrameGraph node to issue work for the compute shader on GPU. A DispatchCompute allows work to be issued for the compute shader to run on the GPU. The workGroupX, workGroupY and workGroupZ properties specify the work group sizes for diff --git a/src/render/framegraph/qfrustumculling.cpp b/src/render/framegraph/qfrustumculling.cpp index 1d95892b3..c34d666b5 100644 --- a/src/render/framegraph/qfrustumculling.cpp +++ b/src/render/framegraph/qfrustumculling.cpp @@ -47,7 +47,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.7 \ingroup framegraph - \brief Enable frustum culling for the FrameGraph + \brief Enable frustum culling for the FrameGraph. A QFrustumCulling class enables frustum culling of the drawable entities based on the camera view and QGeometry bounds of the entities. If QFrustumCulling is present in @@ -66,7 +66,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QFrustumCulling \inherits FrameGraphNode \since 5.7 - \brief Enable frustum culling for the FrameGraph + \brief Enable frustum culling for the FrameGraph. A FrustumCulling type enables frustum culling of the drawable entities based on the camera view and Geometry bounds of the entities. If FrustumCulling is present in diff --git a/src/render/framegraph/qmemorybarrier.cpp b/src/render/framegraph/qmemorybarrier.cpp index 4c1685ef7..b39537dcf 100644 --- a/src/render/framegraph/qmemorybarrier.cpp +++ b/src/render/framegraph/qmemorybarrier.cpp @@ -50,7 +50,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.9 \ingroup framegraph - \brief Class to emplace a memory barrier + \brief Class to emplace a memory barrier. A Qt3DRender::QMemoryBarrier FrameGraph node is used to emplace a specific memory barrier at a specific time of the rendering. This is required to @@ -76,7 +76,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QMemoryBarrier \inherits FrameGraphNode \since 5.9 - \brief Class to place a memory barrier + \brief Class to place a memory barrier. A MemoryBarrier FrameGraph node is used to emplace a specific memory barrier at a specific time of the rendering. This is required to diff --git a/src/render/framegraph/qrendercapture.cpp b/src/render/framegraph/qrendercapture.cpp index 7d40c33dc..d5b6d63ae 100644 --- a/src/render/framegraph/qrendercapture.cpp +++ b/src/render/framegraph/qrendercapture.cpp @@ -52,7 +52,7 @@ namespace Qt3DRender { * \inheaderfile Qt3DRender/QRenderCapture * \inmodule Qt3DRender * - * \brief Frame graph node for render capture + * \brief Frame graph node for render capture. * * The QRenderCapture is used to capture rendering into an image at any render stage. * Capturing must be initiated by the user and one image is returned per capture request. @@ -68,7 +68,7 @@ namespace Qt3DRender { * \inherits FrameGraphNode * \inqmlmodule Qt3D.Render * \since 5.8 - * \brief Capture rendering + * \brief Capture rendering. */ /*! diff --git a/src/render/framegraph/qrenderpassfilter.cpp b/src/render/framegraph/qrenderpassfilter.cpp index 409a97c01..56c229d9c 100644 --- a/src/render/framegraph/qrenderpassfilter.cpp +++ b/src/render/framegraph/qrenderpassfilter.cpp @@ -57,7 +57,7 @@ namespace Qt3DRender { \class Qt3DRender::QRenderPassFilter \inmodule Qt3DRender \since 5.7 - \brief Provides storage for vectors of Filter Keys and Parameters + \brief Provides storage for vectors of Filter Keys and Parameters. A Qt3DRender::QRenderPassFilter FrameGraph node is used to select which Qt3DRender::QRenderPass objects are selected for drawing. QRenderPassFilter @@ -76,7 +76,7 @@ namespace Qt3DRender { \since 5.7 \instantiates Qt3DRender::QRenderPassFilter \inherits FrameGraphNode - \brief Provides storage for vectors of Filter Keys and Parameters + \brief Provides storage for vectors of Filter Keys and Parameters. A RenderPassFilter FrameGraph node is used to select which RenderPass objects are selected for drawing. When RenderPassFilter is present in the FrameGraph, diff --git a/src/render/framegraph/qrendersurfaceselector.cpp b/src/render/framegraph/qrendersurfaceselector.cpp index 41112101a..848d86f53 100644 --- a/src/render/framegraph/qrendersurfaceselector.cpp +++ b/src/render/framegraph/qrendersurfaceselector.cpp @@ -55,7 +55,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QRenderSurfaceSelector \inmodule Qt3DRender - \brief Provides a way of specifying the render surface + \brief Provides a way of specifying the render surface. \since 5.7 The Qt3DRender::QRenderSurfaceSelector can be used to select the surface, where @@ -77,7 +77,7 @@ namespace Qt3DRender { \since 5.7 \instantiates Qt3DRender::QRenderSurfaceSelector \inherits FrameGraphNode - \brief Provides a way of specifying the render surface + \brief Provides a way of specifying the render surface. The RenderSurfaceSelector can be used to select the surface, where Qt3D renders the content. The surface can either be window surface or offscreen diff --git a/src/render/framegraph/qrendertargetselector.cpp b/src/render/framegraph/qrendertargetselector.cpp index f05f6b581..1b4afc7e6 100644 --- a/src/render/framegraph/qrendertargetselector.cpp +++ b/src/render/framegraph/qrendertargetselector.cpp @@ -53,7 +53,7 @@ namespace Qt3DRender { \class Qt3DRender::QRenderTargetSelector \inmodule Qt3DRender \since 5.7 - \brief Provides a way of specifying a render target + \brief Provides a way of specifying a render target. A Qt3DRender::QRenderTargetSelector is used to select active Qt3DRender::QRenderTarget for the FrameGraph. When QRenderTargetSelector is present in the FrameGraph, @@ -70,7 +70,7 @@ namespace Qt3DRender { \since 5.7 \instantiates Qt3DRender::QRenderTargetSelector \inherits FrameGraphNode - \brief Provides a way of specifying a render target + \brief Provides a way of specifying a render target. A RenderTargetSelector is used to select active RenderTarget for the FrameGraph. When RenderTargetSelector is present in the FrameGraph, diff --git a/src/render/framegraph/qsortpolicy.cpp b/src/render/framegraph/qsortpolicy.cpp index e5a6e096c..979d6e1f0 100644 --- a/src/render/framegraph/qsortpolicy.cpp +++ b/src/render/framegraph/qsortpolicy.cpp @@ -56,7 +56,7 @@ QSortPolicyPrivate::QSortPolicyPrivate() /*! \class Qt3DRender::QSortPolicy \inmodule Qt3DRender - \brief Provides storage for the sort types to be used + \brief Provides storage for the sort types to be used. \since 5.7 \inherits Qt3DRender::QFrameGraphNode @@ -75,7 +75,7 @@ QSortPolicyPrivate::QSortPolicyPrivate() \since 5.7 \instantiates Qt3DRender::QSortPolicy \inherits FrameGraphNode - \brief Provides storage for the sort types to be used + \brief Provides storage for the sort types to be used. A SortPolicy class stores the sorting type used by the FrameGraph. The sort types determine how drawable entities are sorted before drawing to diff --git a/src/render/framegraph/qtechniquefilter.cpp b/src/render/framegraph/qtechniquefilter.cpp index 0f64d8765..404ad6991 100644 --- a/src/render/framegraph/qtechniquefilter.cpp +++ b/src/render/framegraph/qtechniquefilter.cpp @@ -61,7 +61,7 @@ QTechniqueFilterPrivate::QTechniqueFilterPrivate() \class Qt3DRender::QTechniqueFilter \inmodule Qt3DRender \since 5.7 - \brief A QFrameGraphNode used to select QTechniques to use + \brief A QFrameGraphNode used to select QTechniques to use. A Qt3DRender::QTechniqueFilter specifies which techniques are used by the FrameGraph when rendering the entities. QTechniqueFilter specifies @@ -78,7 +78,7 @@ QTechniqueFilterPrivate::QTechniqueFilterPrivate() \instantiates Qt3DRender::QTechniqueFilter \inherits FrameGraphNode \since 5.7 - \brief A FrameGraphNode used to select used Techniques + \brief A FrameGraphNode used to select used Techniques. A TechniqueFilter specifies which techniques are used by the FrameGraph when rendering the entities. TechniqueFilter specifies diff --git a/src/render/framegraph/qviewport.cpp b/src/render/framegraph/qviewport.cpp index 8c1ebe67c..539e02d65 100644 --- a/src/render/framegraph/qviewport.cpp +++ b/src/render/framegraph/qviewport.cpp @@ -57,7 +57,7 @@ QViewportPrivate::QViewportPrivate() /*! \class Qt3DRender::QViewport \inmodule Qt3DRender - \brief A viewport on the Qt3D Scene + \brief A viewport on the Qt3D Scene. \since 5.7 \inherits Qt3DRender::QFrameGraphNode @@ -73,7 +73,7 @@ QViewportPrivate::QViewportPrivate() \since 5.7 \inherits FrameGraphNode \instantiates Qt3DRender::QViewport - \brief A viewport on the Qt3D Scene + \brief A viewport on the Qt3D Scene. Viewport of the scene specifies at which portion of the render surface Qt3D is rendering to. Area outside the viewport is left untouched. It also controls global parameters diff --git a/src/render/frontend/qcomputecommand.cpp b/src/render/frontend/qcomputecommand.cpp index e23f9e158..5cb72a6ce 100644 --- a/src/render/frontend/qcomputecommand.cpp +++ b/src/render/frontend/qcomputecommand.cpp @@ -48,7 +48,7 @@ namespace Qt3DRender { \class Qt3DRender::QComputeCommand \since 5.7 \inmodule Qt3DRender - \brief QComponent to issue work for the compute shader on GPU + \brief QComponent to issue work for the compute shader on GPU. A Qt3DRender::QComputeCommand is used to issue work for the compute shader. The compute shader is specified in the QMaterial component of the same entity the @@ -69,7 +69,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \inherits Component3D \instantiates Qt3DRender::QComputeCommand - \brief Component to issue work for the compute shader on GPU + \brief Component to issue work for the compute shader on GPU. A ComputeCommand is used to issue work for the compute shader. The compute shader is specified in the Material component of the same entity the diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp index 04ddfdd46..82cc5956a 100644 --- a/src/render/frontend/qrenderaspect.cpp +++ b/src/render/frontend/qrenderaspect.cpp @@ -177,7 +177,7 @@ namespace Qt3DRender { * \inheaderfile Qt3DRender/QRenderAspect * \brief The QRenderAspect class * \since 5.7 - * \inmodule Qt3DRender + * \inmodule Qt3DRender. */ /*! \internal */ diff --git a/src/render/geometry/qgeometry.cpp b/src/render/geometry/qgeometry.cpp index 83a06d040..c49dde822 100644 --- a/src/render/geometry/qgeometry.cpp +++ b/src/render/geometry/qgeometry.cpp @@ -72,7 +72,7 @@ QGeometryPrivate::~QGeometryPrivate() \inqmlmodule Qt3D.Render \inherits Node \since 5.7 - \brief Encapsulates geometry + \brief Encapsulates geometry. A Geometry type is used to group a list of Attribute objects together to form a geometric shape Qt3D is able to render using GeometryRenderer. @@ -83,7 +83,7 @@ QGeometryPrivate::~QGeometryPrivate() \class Qt3DRender::QGeometry \inmodule Qt3DRender \since 5.7 - \brief Encapsulates geometry + \brief Encapsulates geometry. A Qt3DRender::QGeometry class is used to group a list of Qt3DRender::QAttribute objects together to form a geometric shape Qt3D is able to render using diff --git a/src/render/geometry/qgeometryrenderer.cpp b/src/render/geometry/qgeometryrenderer.cpp index a497bab97..b8572cded 100644 --- a/src/render/geometry/qgeometryrenderer.cpp +++ b/src/render/geometry/qgeometryrenderer.cpp @@ -77,7 +77,7 @@ QGeometryRendererPrivate::~QGeometryRendererPrivate() \inqmlmodule Qt3D.Render \inherits Component3D \since 5.7 - \brief Encapsulates geometry rendering + \brief Encapsulates geometry rendering. A GeometryRenderer holds all the information necessary to draw a Geometry. A Geometry holds the coordinates of the geometry data - @@ -88,7 +88,7 @@ QGeometryRendererPrivate::~QGeometryRendererPrivate() \class Qt3DRender::QGeometryRenderer \inmodule Qt3DRender \since 5.7 - \brief Encapsulates geometry rendering + \brief Encapsulates geometry rendering. A Qt3DRender::QGeometryRenderer holds all the information necessary to draw a Qt3DRender::QGeometry. A QGeometry holds the coordinates of the geometry data - diff --git a/src/render/io/qsceneloader.cpp b/src/render/io/qsceneloader.cpp index 3bc842c3d..70af313a2 100644 --- a/src/render/io/qsceneloader.cpp +++ b/src/render/io/qsceneloader.cpp @@ -65,7 +65,7 @@ namespace Qt3DRender { \since 5.7 \ingroup io - \brief Provides the facility to load an existing Scene + \brief Provides the facility to load an existing Scene. Given a 3D source file, the Qt3DRender::QSceneLoader will try to parse it and build a tree of Qt3DCore::QEntity objects with proper Qt3DRender::QGeometryRenderer, @@ -97,7 +97,7 @@ namespace Qt3DRender { \instantiates Qt3DRender::QSceneLoader \inherits Component \since 5.7 - \brief Provides the facility to load an existing Scene + \brief Provides the facility to load an existing Scene. Given a 3D source file, the SceneLoader will try to parse it and build a tree of Entity objects with proper GeometryRenderer, Transform and Material diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp index 65ad77d28..70f329172 100644 --- a/src/render/materialsystem/qgraphicsapifilter.cpp +++ b/src/render/materialsystem/qgraphicsapifilter.cpp @@ -111,7 +111,7 @@ QGraphicsApiFilterPrivate *QGraphicsApiFilterPrivate::get(QGraphicsApiFilter *q) \class Qt3DRender::QGraphicsApiFilter \inmodule Qt3DRender \since 5.5 - \brief The QGraphicsApiFilter class identifies the API required for the attached QTechnique + \brief The QGraphicsApiFilter class identifies the API required for the attached QTechnique. */ /*! @@ -120,7 +120,7 @@ QGraphicsApiFilterPrivate *QGraphicsApiFilterPrivate::get(QGraphicsApiFilter *q) \inherits QtObject \inqmlmodule Qt3D.Render \since 5.5 - \brief For OpenGL identifies the API required for the attached technique + \brief For OpenGL identifies the API required for the attached technique. */ /*! \fn Qt3DRender::QGraphicsApiFilter::QGraphicsApiFilter(QObject *parent) diff --git a/src/render/picking/qabstractraycaster.cpp b/src/render/picking/qabstractraycaster.cpp index 4d7a77765..fa48cf0b0 100644 --- a/src/render/picking/qabstractraycaster.cpp +++ b/src/render/picking/qabstractraycaster.cpp @@ -86,7 +86,7 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit /*! \class Qt3DRender::QAbstractRayCaster - \brief An abstract base class for ray casting in 3d scenes + \brief An abstract base class for ray casting in 3d scenes. \inmodule Qt3DRender \since 5.11 \inherits QComponent @@ -117,7 +117,7 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit */ /*! \qmltype AbstractRayCaster - \brief An abstract base class for ray casting in 3d scenes + \brief An abstract base class for ray casting in 3d scenes. \inqmlmodule Qt3D.Render \since 5.11 \instantiates Qt3DRender::QAbstractRayCaster diff --git a/src/render/picking/qpickevent.cpp b/src/render/picking/qpickevent.cpp index fa83e08da..9230cc5e5 100644 --- a/src/render/picking/qpickevent.cpp +++ b/src/render/picking/qpickevent.cpp @@ -49,7 +49,7 @@ namespace Qt3DRender { \class Qt3DRender::QPickEvent \inmodule Qt3DRender - \brief The QPickEvent class holds information when an object is picked + \brief The QPickEvent class holds information when an object is picked. This is received as a parameter in most of the QObjectPicker component signals when picking succeeds. diff --git a/src/render/picking/qpicklineevent.cpp b/src/render/picking/qpicklineevent.cpp index 5b9ef0d76..a079fb557 100644 --- a/src/render/picking/qpicklineevent.cpp +++ b/src/render/picking/qpicklineevent.cpp @@ -65,7 +65,7 @@ public: \class Qt3DRender::QPickLineEvent \inmodule Qt3DRender - \brief The QPickLineEvent class holds information when a segment of a line is picked + \brief The QPickLineEvent class holds information when a segment of a line is picked. \sa QPickEvent \since 5.10 diff --git a/src/render/picking/qpickpointevent.cpp b/src/render/picking/qpickpointevent.cpp index 295860e75..2e035d3f2 100644 --- a/src/render/picking/qpickpointevent.cpp +++ b/src/render/picking/qpickpointevent.cpp @@ -61,7 +61,7 @@ public: \class Qt3DRender::QPickPointEvent \inmodule Qt3DRender - \brief The QPickPointEvent class holds information when a segment of a point cloud is picked + \brief The QPickPointEvent class holds information when a segment of a point cloud is picked. \sa QPickEvent \since 5.10 diff --git a/src/render/picking/qpicktriangleevent.cpp b/src/render/picking/qpicktriangleevent.cpp index 7db603c79..3e8e8c72c 100644 --- a/src/render/picking/qpicktriangleevent.cpp +++ b/src/render/picking/qpicktriangleevent.cpp @@ -68,7 +68,7 @@ public: \class Qt3DRender::QPickTriangleEvent \inmodule Qt3DRender - \brief The QPickTriangleEvent class holds information when a triangle is picked + \brief The QPickTriangleEvent class holds information when a triangle is picked. When QPickingSettings::pickMode() is set to QPickingSettings::TrianglePicking, the signals on QObjectPicker will carry an instance of QPickTriangleEvent. diff --git a/src/render/picking/qraycasterhit.cpp b/src/render/picking/qraycasterhit.cpp index 3c237354b..6e81c05d0 100644 --- a/src/render/picking/qraycasterhit.cpp +++ b/src/render/picking/qraycasterhit.cpp @@ -82,7 +82,7 @@ QRayCasterHitData::QRayCasterHitData(QRayCasterHit::HitType type, Qt3DCore::QNod /*! \class Qt3DRender::QRayCasterHit - \brief Details of a hit when casting a ray through a model + \brief Details of a hit when casting a ray through a model. \inmodule Qt3DRender \since 5.11 diff --git a/src/render/picking/qscreenraycaster.cpp b/src/render/picking/qscreenraycaster.cpp index 99c3015f5..95df8e4c1 100644 --- a/src/render/picking/qscreenraycaster.cpp +++ b/src/render/picking/qscreenraycaster.cpp @@ -50,7 +50,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QScreenRayCaster - \brief Performe ray casting test based on screen coordinates + \brief Performe ray casting test based on screen coordinates. \inmodule Qt3DRender \since 5.11 \inherits QAbstractRayCaster @@ -63,7 +63,7 @@ namespace Qt3DRender { */ /*! \qmltype ScreenRayCaster - \brief Performe ray casting test based on screen coordinates + \brief Performe ray casting test based on screen coordinates. \inqmlmodule Qt3D.Render \since 5.11 \instantiates Qt3DRender::QScreenRayCaster diff --git a/src/render/renderstates/qalphacoverage.cpp b/src/render/renderstates/qalphacoverage.cpp index 6383f2469..785e79057 100644 --- a/src/render/renderstates/qalphacoverage.cpp +++ b/src/render/renderstates/qalphacoverage.cpp @@ -50,7 +50,7 @@ namespace Qt3DRender { \since 5.7 \ingroup renderstates \inmodule Qt3DRender - \brief Enable alpha-to-coverage multisampling mode + \brief Enable alpha-to-coverage multisampling mode. A Qt3DRender::QAlphaCoverage class enables alpha-to-coverage multisampling mode. When enabled, the fragment alpha value is used as a coverage for the sample @@ -97,7 +97,7 @@ namespace Qt3DRender { \inqmlmodule Qt3D.Render \instantiates Qt3DRender::QAlphaCoverage \inherits RenderState - \brief Enable alpha-to-coverage multisampling mode + \brief Enable alpha-to-coverage multisampling mode. An AlphaCoverage type enables alpha-to-coverage multisampling mode. When enabled, the fragment alpha value is used as a coverage for the sample diff --git a/src/render/renderstates/qalphatest.cpp b/src/render/renderstates/qalphatest.cpp index 81227d499..1e6606c02 100644 --- a/src/render/renderstates/qalphatest.cpp +++ b/src/render/renderstates/qalphatest.cpp @@ -48,7 +48,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QAlphaTest - \brief The QAlphaTest class specify alpha reference test + \brief The QAlphaTest class specify alpha reference test. \since 5.7 \inmodule Qt3DRender \ingroup renderstates @@ -60,7 +60,7 @@ namespace Qt3DRender { /*! \qmltype AlphaTest - \brief The AlphaTest class specify alpha reference test + \brief The AlphaTest class specify alpha reference test. \since 5.7 \inqmlmodule Qt3D.Render \inherits RenderState diff --git a/src/render/renderstates/qblendequation.cpp b/src/render/renderstates/qblendequation.cpp index 220116626..1f3f56f92 100644 --- a/src/render/renderstates/qblendequation.cpp +++ b/src/render/renderstates/qblendequation.cpp @@ -42,7 +42,7 @@ * \class Qt3DRender::QBlendEquation * \inheaderfile Qt3DRender/QBlendEquation * \brief The QBlendEquation class specifies the equation used for both the RGB - * blend equation and the Alpha blend equation + * blend equation and the Alpha blend equation. * \inmodule Qt3DRender * \since 5.7 * \ingroup renderstates @@ -58,7 +58,7 @@ \inqmlmodule Qt3D.Render \since 5.5 \brief The BlendEquation class specifies the equation used for both the RGB - blend equation and the Alpha blend equation + blend equation and the Alpha blend equation. The blend equation is used to determine how a new pixel is combined with a pixel already in the framebuffer. diff --git a/src/render/renderstates/qclipplane.cpp b/src/render/renderstates/qclipplane.cpp index 19053c147..8f67ae11c 100644 --- a/src/render/renderstates/qclipplane.cpp +++ b/src/render/renderstates/qclipplane.cpp @@ -50,7 +50,7 @@ namespace Qt3DRender { \inmodule Qt3DRender \since 5.5 \brief Enables an additional OpenGL clipping plane that can be in shaders - using gl_ClipDistance + using gl_ClipDistance. By default, OpenGL supports up to 8 additional clipping planes. Qt3DCore::QClipPlane allows to enable one of these additional planes. These @@ -66,7 +66,7 @@ namespace Qt3DRender { \inqmlmodule Qt3D.Render \since 5.5 \brief Enables an additional OpenGL clipping plane that can be in shaders - using gl_ClipDistance + using gl_ClipDistance. By default, OpenGL supports up to 8 additional clipping planes. ClipPlane allows to enable one of these additional planes. These planes can then be diff --git a/src/render/renderstates/qdithering.cpp b/src/render/renderstates/qdithering.cpp index 102cfa0ff..ae77ced97 100644 --- a/src/render/renderstates/qdithering.cpp +++ b/src/render/renderstates/qdithering.cpp @@ -51,7 +51,7 @@ namespace Qt3DRender { \class Qt3DRender::QDithering \since 5.7 \inmodule Qt3DRender - \brief Enable dithering + \brief Enable dithering. A Qt3DRender::QDithering class enables dithering. Dithering adds noise to the color values to randomize quantization error in order to prevent large scale @@ -65,7 +65,7 @@ namespace Qt3DRender { \inqmlmodule Qt3D.Render \inherits RenderState \instantiates Qt3DRender::QDithering - \brief Enable dithering + \brief Enable dithering. A Dithering type enables dithering. Dithering adds noise to the color values to randomize quantization error in order to prevent large scale diff --git a/src/render/renderstates/qmultisampleantialiasing.cpp b/src/render/renderstates/qmultisampleantialiasing.cpp index 156489008..bb5136846 100644 --- a/src/render/renderstates/qmultisampleantialiasing.cpp +++ b/src/render/renderstates/qmultisampleantialiasing.cpp @@ -48,7 +48,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QMultiSampleAntiAliasing - \brief Enable multisample antialiasing + \brief Enable multisample antialiasing. \since 5.7 \ingroup renderstates \inmodule Qt3DRender @@ -108,7 +108,7 @@ namespace Qt3DRender { /*! \qmltype MultiSampleAntiAliasing - \brief Enable multisample antialiasing + \brief Enable multisample antialiasing. \since 5.7 \ingroup renderstates \inqmlmodule Qt3D.Render diff --git a/src/render/renderstates/qnodepthmask.cpp b/src/render/renderstates/qnodepthmask.cpp index f0376cfb6..7be7f24f4 100644 --- a/src/render/renderstates/qnodepthmask.cpp +++ b/src/render/renderstates/qnodepthmask.cpp @@ -49,7 +49,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QNoDepthMask - \brief Disable depth write + \brief Disable depth write. \since 5.7 \ingroup renderstates \inmodule Qt3DRender @@ -61,7 +61,7 @@ namespace Qt3DRender { /*! \qmltype NoDepthMask - \brief Disable depth write + \brief Disable depth write. \since 5.7 \ingroup renderstates \inqmlmodule Qt3D.Render diff --git a/src/render/renderstates/qrenderstate.cpp b/src/render/renderstates/qrenderstate.cpp index e49292dbd..8a7d897be 100644 --- a/src/render/renderstates/qrenderstate.cpp +++ b/src/render/renderstates/qrenderstate.cpp @@ -48,7 +48,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QRenderState - \brief An abstract base class for all render states + \brief An abstract base class for all render states. \since 5.7 \ingroup renderstates \inmodule Qt3DRender @@ -59,7 +59,7 @@ namespace Qt3DRender { /*! \qmltype RenderState - \brief An abstract base type for all render states + \brief An abstract base type for all render states. \since 5.7 \inherits Node \instantiates Qt3DRender::QRenderState diff --git a/src/render/renderstates/qstenciloperation.cpp b/src/render/renderstates/qstenciloperation.cpp index 66a326d55..af7e014f5 100644 --- a/src/render/renderstates/qstenciloperation.cpp +++ b/src/render/renderstates/qstenciloperation.cpp @@ -49,7 +49,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QStencilOperation - \brief The QStencilOperation class specifies stencil operation + \brief The QStencilOperation class specifies stencil operation. \since 5.7 \ingroup renderstates \inmodule Qt3DRender @@ -63,7 +63,7 @@ namespace Qt3DRender { /*! \qmltype StencilOperation - \brief The StencilOperation type specifies stencil operation + \brief The StencilOperation type specifies stencil operation. \since 5.7 \ingroup renderstates \inqmlmodule Qt3D.Render diff --git a/src/render/renderstates/qstenciltest.cpp b/src/render/renderstates/qstenciltest.cpp index 74acfe3bc..a364c3b88 100644 --- a/src/render/renderstates/qstenciltest.cpp +++ b/src/render/renderstates/qstenciltest.cpp @@ -53,7 +53,7 @@ namespace Qt3DRender { \since 5.7 \ingroup renderstates \inmodule Qt3DRender - \brief The QStencilTest class specifies arguments for the stecil test + \brief The QStencilTest class specifies arguments for the stecil test. A Qt3DRender::QStencilTest class specifies argument for the stencil test. The stencil test comprises of three arguments: stencil test function, @@ -68,7 +68,7 @@ namespace Qt3DRender { \since 5.7 \ingroup renderstates \inqmlmodule Qt3D.Render - \brief The StencilTest type specifies arguments for the stecil test + \brief The StencilTest type specifies arguments for the stecil test. \inherits RenderState \instantiates Qt3DRender::QStencilTest diff --git a/src/render/renderstates/qstenciltestarguments.cpp b/src/render/renderstates/qstenciltestarguments.cpp index ae1fd1111..dc8ff7292 100644 --- a/src/render/renderstates/qstenciltestarguments.cpp +++ b/src/render/renderstates/qstenciltestarguments.cpp @@ -46,7 +46,7 @@ namespace Qt3DRender { /*! \class Qt3DRender::QStencilTestArguments - \brief The QStencilTestArguments class specifies arguments for stencil test + \brief The QStencilTestArguments class specifies arguments for stencil test. \since 5.7 \ingroup renderstates \inmodule Qt3DRender @@ -57,7 +57,7 @@ namespace Qt3DRender { /*! \qmltype StencilTestArguments - \brief The StencilTestArguments type specifies arguments for stencil test + \brief The StencilTestArguments type specifies arguments for stencil test. \since 5.7 \ingroup renderstates \inqmlmodule Qt3D.Render diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp index 8da24d936..a95e1fffd 100644 --- a/src/render/texture/qabstracttextureimage.cpp +++ b/src/render/texture/qabstracttextureimage.cpp @@ -52,7 +52,7 @@ namespace Qt3DRender { \class Qt3DRender::QTextureImageDataGenerator \inmodule Qt3DRender \since 5.7 - \brief Provides texture image data for QAbstractTextureImage + \brief Provides texture image data for QAbstractTextureImage. QTextureImageDataGenerator is a data provider for QAbstractTexture. QTextureImageDataGenerator can be used to expand Qt3D with more ways to load |