diff options
-rw-r--r-- | src/render/backend/renderqueue.cpp | 10 | ||||
-rw-r--r-- | src/render/backend/triangleboundingvolume.cpp | 2 | ||||
-rw-r--r-- | src/render/frontend/qabstractfunctor.cpp | 4 | ||||
-rw-r--r-- | src/render/frontend/qlevelofdetailboundingsphere.cpp | 10 | ||||
-rw-r--r-- | src/render/frontend/qpickingsettings.cpp | 2 | ||||
-rw-r--r-- | src/render/frontend/qrenderaspect.cpp | 3 | ||||
-rw-r--r-- | src/render/geometry/qgeometry.cpp | 9 | ||||
-rw-r--r-- | src/render/graphicshelpers/graphicscontext.cpp | 5 | ||||
-rw-r--r-- | src/render/lights/qspotlight.cpp | 6 | ||||
-rw-r--r-- | src/render/materialsystem/qgraphicsapifilter.cpp | 13 | ||||
-rw-r--r-- | src/render/picking/qobjectpicker.cpp | 12 | ||||
-rw-r--r-- | src/render/picking/qpicktriangleevent.cpp | 3 | ||||
-rw-r--r-- | src/render/raycasting/qray3d.cpp | 29 | ||||
-rw-r--r-- | src/render/renderstates/qblendequationarguments.cpp | 4 | ||||
-rw-r--r-- | src/render/renderstates/qrenderstatecreatedchange.cpp | 1 | ||||
-rw-r--r-- | src/render/texture/qabstracttextureimage.cpp | 6 | ||||
-rw-r--r-- | src/render/texture/qtexture.cpp | 4 | ||||
-rw-r--r-- | src/render/texture/qtextureimage.cpp | 2 |
18 files changed, 57 insertions, 68 deletions
diff --git a/src/render/backend/renderqueue.cpp b/src/render/backend/renderqueue.cpp index 2fa1cb7d2..bd9d3ee59 100644 --- a/src/render/backend/renderqueue.cpp +++ b/src/render/backend/renderqueue.cpp @@ -61,7 +61,7 @@ int RenderQueue::currentRenderViewCount() const return m_currentRenderViewCount; } -/*! +/* * In case the framegraph changed or when the current number of render queue * needs to be reset. */ @@ -80,7 +80,7 @@ void RenderQueue::setNoRender() m_noRender = true; } -/*! +/* * Queue up a RenderView for the frame being built. * Thread safe as this is called from the renderer which is locked. * Returns true if the renderView is complete @@ -94,7 +94,7 @@ bool RenderQueue::queueRenderView(RenderView *renderView, uint submissionOrderIn return isFrameQueueComplete(); } -/*! +/* * Called by the Rendering Thread to retrieve the a frame queue to render. * A call to reset is required after rendering of the frame. Otherwise under some * conditions the current but then invalidated frame queue could be reused. @@ -104,7 +104,7 @@ QVector<RenderView *> RenderQueue::nextFrameQueue() return m_currentWorkQueue; } -/*! +/* * Sets the number \a targetRenderViewCount of RenderView objects that make up a frame. */ void RenderQueue::setTargetRenderViewCount(int targetRenderViewCount) @@ -115,7 +115,7 @@ void RenderQueue::setTargetRenderViewCount(int targetRenderViewCount) m_wasReset = false; } -/*! +/* * Returns true if all the RenderView objects making up the current frame have been queued. * Returns false otherwise. * \note a frameQueue or size 0 is considered incomplete. diff --git a/src/render/backend/triangleboundingvolume.cpp b/src/render/backend/triangleboundingvolume.cpp index be5206657..c30b41920 100644 --- a/src/render/backend/triangleboundingvolume.cpp +++ b/src/render/backend/triangleboundingvolume.cpp @@ -96,7 +96,7 @@ TriangleBoundingVolume::TriangleBoundingVolume() { } -/*! +/* The vertices a, b, c are assumed to be in counter clockwise order. */ TriangleBoundingVolume::TriangleBoundingVolume(Qt3DCore::QNodeId id, const Vector3D &a, const Vector3D &b, const Vector3D &c) diff --git a/src/render/frontend/qabstractfunctor.cpp b/src/render/frontend/qabstractfunctor.cpp index 817d06a27..9f4727865 100644 --- a/src/render/frontend/qabstractfunctor.cpp +++ b/src/render/frontend/qabstractfunctor.cpp @@ -57,7 +57,7 @@ namespace Qt3DRender { macro in the class definition. */ /*! - \fn qintptr QAbstractFunctor::id() const + \fn qintptr Qt3DRender::QAbstractFunctor::id() const */ /*! \macro QT3D_FUNCTOR(Class) @@ -68,7 +68,7 @@ namespace Qt3DRender { */ /*! - \fn const T *QAbstractFunctor::functor_cast(const QAbstractFunctor *other) const + \fn template<class T> const T * Qt3DRender::QAbstractFunctor::functor_cast(const QAbstractFunctor *other) const This method is used to cast functor \a other to type T if the other is of type T (or of subclass); otherwise returns 0. This method works similarly diff --git a/src/render/frontend/qlevelofdetailboundingsphere.cpp b/src/render/frontend/qlevelofdetailboundingsphere.cpp index abf8081d3..8354365d8 100644 --- a/src/render/frontend/qlevelofdetailboundingsphere.cpp +++ b/src/render/frontend/qlevelofdetailboundingsphere.cpp @@ -69,15 +69,15 @@ public: \class Qt3DRender::QLevelOfDetailBoundingSphere \inmodule Qt3DRender \since 5.9 - \brief The QLevelOfDetailBoundingSphere class provides a simple spherical volume, defined by it's center and radius. + \brief The QLevelOfDetailBoundingSphere class provides a simple spherical volume, defined by its center and radius. */ /*! - \qmltype LevelOfDetail + \qmltype LevelOfDetailBoundingSphere \instantiates Qt3DRender::QLevelOfDetailBoundingSphere \inherits Component3D \inqmlmodule Qt3D.Render - \brief The LevelOfDetailBoundingSphere class provides a simple spherical volume, defined by it's center and radius. + \brief The LevelOfDetailBoundingSphere QML type provides a simple spherical volume, defined by its center and radius. */ /*! @@ -104,11 +104,9 @@ public: * Specifies the radius of the bounding sphere */ -/*! \fn Qt3DRender::QLevelOfDetailBoundingSphere::QLevelOfDetailBoundingSphere(const QVector3D ¢er = QVector3D(), float radius = -1.0f) +/*! Constructs a new QLevelOfDetailBoundingSphere with the specified \a center and \a radius. */ - - QLevelOfDetailBoundingSphere::QLevelOfDetailBoundingSphere(QVector3D center, float radius) : d_ptr(new QLevelOfDetailBoundingSpherePrivate(center, radius)) { diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp index b24d0b7d0..1fbcc0d8a 100644 --- a/src/render/frontend/qpickingsettings.cpp +++ b/src/render/frontend/qpickingsettings.cpp @@ -258,7 +258,7 @@ void QPickingSettings::setFaceOrientationPickingMode(QPickingSettings::FaceOrien } /*! - \qmlproperty qreal worldSpaceTolerance + \qmlproperty qreal PickingSettings::worldSpaceTolerance Holds the threshold, in model space coordinates, used to evaluate line and point picking. */ diff --git a/src/render/frontend/qrenderaspect.cpp b/src/render/frontend/qrenderaspect.cpp index 1314a7c36..100707b20 100644 --- a/src/render/frontend/qrenderaspect.cpp +++ b/src/render/frontend/qrenderaspect.cpp @@ -420,7 +420,8 @@ void QRenderAspectPrivate::renderSynchronous(bool blocking) m_renderer->doRender(blocking); } -/*! +/* + * \internal * Only called when rendering with QtQuick 2 and a Scene3D item */ void QRenderAspectPrivate::renderShutdown() diff --git a/src/render/geometry/qgeometry.cpp b/src/render/geometry/qgeometry.cpp index cf5ae70ef..83a06d040 100644 --- a/src/render/geometry/qgeometry.cpp +++ b/src/render/geometry/qgeometry.cpp @@ -128,12 +128,12 @@ QGeometry::QGeometry(QNode *parent) : QGeometry(*new QGeometryPrivate(), parent) {} /*! - \fn QGeometryFactory::operator()() + \fn Qt3DRender::QGeometryFactory::operator()() Returns the generated geometry. */ /*! - \fn bool QGeometryFactory::operator==(const QGeometryFactory &other) const = 0 + \fn bool Qt3DRender::QGeometryFactory::operator==(const QGeometryFactory &other) const = 0 Compares the factory with the factory specified in \a other. Returns true if they are equal. @@ -183,11 +183,6 @@ void QGeometry::addAttribute(QAttribute *attribute) } /*! - \fn Qt3DRender::QGeometry(QGeometryPrivate &dd, Qt3DCore::QNode *parent) - - \internal -*/ -/*! \fn void Qt3DRender::QGeometry::removeAttribute(Qt3DRender::QAttribute *attribute) Removes the given \a attribute from this geometry. */ diff --git a/src/render/graphicshelpers/graphicscontext.cpp b/src/render/graphicshelpers/graphicscontext.cpp index 7fa112b12..93f924052 100644 --- a/src/render/graphicshelpers/graphicscontext.cpp +++ b/src/render/graphicshelpers/graphicscontext.cpp @@ -756,6 +756,7 @@ void GraphicsContext::deactivateTexturesWithScope(TextureScope ts) } /*! + * \internal * Finds the highest supported opengl version and internally use the most optimized * helper for a given version. */ @@ -881,6 +882,7 @@ bool GraphicsContext::supportsDrawBuffersBlend() const } /*! + * \internal * Wraps an OpenGL call to glDrawElementsInstanced. * If the call is not supported by the system's OpenGL version, * it is simulated with a loop. @@ -903,6 +905,7 @@ void GraphicsContext::drawElementsInstancedBaseVertexBaseInstance(GLenum primiti } /*! + * \internal * Wraps an OpenGL call to glDrawArraysInstanced. */ void GraphicsContext::drawArraysInstanced(GLenum primitiveType, @@ -926,6 +929,7 @@ void GraphicsContext::drawArraysInstancedBaseInstance(GLenum primitiveType, GLin } /*! + * \internal * Wraps an OpenGL call to glDrawElements. */ void GraphicsContext::drawElements(GLenum primitiveType, @@ -949,6 +953,7 @@ void GraphicsContext::drawElementsIndirect(GLenum mode, } /*! + * \internal * Wraps an OpenGL call to glDrawArrays. */ void GraphicsContext::drawArrays(GLenum primitiveType, diff --git a/src/render/lights/qspotlight.cpp b/src/render/lights/qspotlight.cpp index 09335d432..81c18387b 100644 --- a/src/render/lights/qspotlight.cpp +++ b/src/render/lights/qspotlight.cpp @@ -116,12 +116,6 @@ QSpotLight::QSpotLight(QSpotLightPrivate &dd, QNode *parent) } /*! - \fn QVector3D Qt3DRender::QSpotLight::attenuation() const - - Returns the attenuation of the spot light. -*/ - -/*! \qmlproperty float Qt3D.Render::SpotLight::constantAttenuation Specifies the constant attenuation of the spot light */ diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp index 119a294ac..a94018360 100644 --- a/src/render/materialsystem/qgraphicsapifilter.cpp +++ b/src/render/materialsystem/qgraphicsapifilter.cpp @@ -123,15 +123,6 @@ QGraphicsApiFilterPrivate *QGraphicsApiFilterPrivate::get(QGraphicsApiFilter *q) \brief For OpenGL identifies the API required for the attached technique */ -/*! - \enum QGraphicsApiFilter::OpenGLProfile - - This enum identifies the type of profile required - \value NoProfile - \value CoreProfile - \value CompatibilityProfile -*/ - /*! \fn Qt3DRender::QGraphicsApiFilter::QGraphicsApiFilter(QObject *parent) Constructs a new QGraphicsApiFilter with the specified \a parent. */ @@ -154,7 +145,9 @@ QGraphicsApiFilter::~QGraphicsApiFilter() */ /*! - \enum Qt3DRender::QGraphicsApiFilter::Profile + \enum Qt3DRender::QGraphicsApiFilter::OpenGLProfile + + This enum identifies the type of profile required. \value NoProfile QSurfaceFormat::NoProfile \value CoreProfile QSurfaceFormat::CoreProfile diff --git a/src/render/picking/qobjectpicker.cpp b/src/render/picking/qobjectpicker.cpp index 77d319676..69fa65f3e 100644 --- a/src/render/picking/qobjectpicker.cpp +++ b/src/render/picking/qobjectpicker.cpp @@ -167,7 +167,7 @@ namespace Qt3DRender { */ /*! - \fn QObjectPicker::clicked(Qt3DRender::QPickEvent *pick) + \fn Qt3DRender::QObjectPicker::clicked(Qt3DRender::QPickEvent *pick) This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse click the QPickEvent \a pick contains @@ -175,21 +175,21 @@ namespace Qt3DRender { */ /*! - \fn QObjectPicker::entered() + \fn Qt3DRender::QObjectPicker::entered() This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the mouse entering the volume. */ /*! - \fn QObjectPicker::exited() + \fn Qt3DRender::QObjectPicker::exited() This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on the ray exiting the volume. */ /*! - \fn QObjectPicker::moved(Qt3DRender::QPickEvent *pick) + \fn Qt3DRender::QObjectPicker::moved(Qt3DRender::QPickEvent *pick) This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse move with a button @@ -197,7 +197,7 @@ namespace Qt3DRender { */ /*! - \fn QObjectPicker::pressed(Qt3DRender::QPickEvent *pick) + \fn Qt3DRender::QObjectPicker::pressed(Qt3DRender::QPickEvent *pick) This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse press the @@ -205,7 +205,7 @@ namespace Qt3DRender { */ /*! - \fn QObjectPicker::released(Qt3DRender::QPickEvent *pick) + \fn Qt3DRender::QObjectPicker::released(Qt3DRender::QPickEvent *pick) This signal is emitted when the bounding volume defined by the pickAttribute property intersects with a ray on a mouse release the diff --git a/src/render/picking/qpicktriangleevent.cpp b/src/render/picking/qpicktriangleevent.cpp index cde7a4952..7db603c79 100644 --- a/src/render/picking/qpicktriangleevent.cpp +++ b/src/render/picking/qpicktriangleevent.cpp @@ -119,8 +119,9 @@ QPickTriangleEvent::QPickTriangleEvent() * \a vertex1Index, * \a vertex2Index and * \a vertex3Index + +//! NOTE: remove in Qt6 */ -// NOTE: remove in Qt6 QPickTriangleEvent::QPickTriangleEvent(const QPointF &position, const QVector3D &worldIntersection, const QVector3D &localIntersection, float distance, uint triangleIndex, uint vertex1Index, uint vertex2Index, uint vertex3Index) diff --git a/src/render/raycasting/qray3d.cpp b/src/render/raycasting/qray3d.cpp index e26e1e38c..6d8469aa1 100644 --- a/src/render/raycasting/qray3d.cpp +++ b/src/render/raycasting/qray3d.cpp @@ -47,7 +47,8 @@ namespace Qt3DRender { namespace RayCasting { /*! - \class Qt3DRender::QRay3D + \internal + \class Qt3DRender::RayCasting::QRay3D \inmodule Qt3DRender \brief The QRay3D class defines a directional line in 3D space extending through an origin point. \since 5.5 @@ -70,7 +71,7 @@ namespace RayCasting { */ /*! - \fn Qt3DRender::QRay3D::QRay3D() + \fn Qt3DRender::RayCasting::QRay3D::QRay3D() Construct a default ray with an origin() of (0, 0, 0), a direction() of (0, 0, 1) and a distance of 1. @@ -82,7 +83,7 @@ QRay3D::QRay3D() } /*! - \fn Qt3DRender::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance) + \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance) Construct a ray given its defining \a origin, \a direction and \a distance. The \a direction does not need to be normalized. @@ -104,7 +105,7 @@ QRay3D::~QRay3D() } /*! - \fn QVector3D Qt3DRender::QRay3D::origin() const + \fn QVector3D Qt3DRender::RayCasting::QRay3D::origin() const Returns the origin of this ray. The default value is (0, 0, 0). @@ -116,7 +117,7 @@ Vector3D QRay3D::origin() const } /*! - \fn void Qt3DRender::QRay3D::setOrigin(const QVector3D &value) + \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const QVector3D &value) Sets the origin point of this ray to \a value. @@ -128,7 +129,7 @@ void QRay3D::setOrigin(const Vector3D &value) } /*! - \fn QVector3D Qt3DRender::QRay3D::direction() const + \fn QVector3D Qt3DRender::RayCasting::QRay3D::direction() const Returns the direction vector of this ray. The default value is (0, 0, 1). @@ -140,7 +141,7 @@ Vector3D QRay3D::direction() const } /*! - \fn void Qt3DRender::QRay3D::setDirection(const QVector3D &direction) + \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const QVector3D &direction) Sets the direction vector of this ray to \a direction. @@ -220,7 +221,7 @@ bool QRay3D::contains(const QRay3D &ray) const } /*! - \fn QVector3D Qt3DRender::QRay3D::point(float t) const + \fn QVector3D Qt3DRender::RayCasting::QRay3D::point(float t) const Returns the point on the ray defined by moving \a t units along the ray in the direction of the direction() vector. @@ -284,7 +285,7 @@ float QRay3D::distance(const Vector3D &point) const } /*! - \fn QRay3D &Qt3DRender::QRay3D::transform(const QMatrix4x4 &matrix) + \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const QMatrix4x4 &matrix) Transforms this ray using \a matrix, replacing origin() and direction() with the transformed versions. @@ -293,7 +294,7 @@ float QRay3D::distance(const Vector3D &point) const */ /*! - \fn QRay3D Qt3DRender::QRay3D::transformed(const QMatrix4x4 &matrix) const + \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const QMatrix4x4 &matrix) const Returns a new ray that is formed by transforming origin() and direction() using \a matrix. @@ -302,7 +303,7 @@ float QRay3D::distance(const Vector3D &point) const */ /*! - \fn bool Qt3DRender::QRay3D::operator==(const QRay3D &other) const + \fn bool Qt3DRender::RayCasting::QRay3D::operator==(const QRay3D &other) const Returns \c true if this ray is the same as \a other; \c false otherwise. @@ -310,7 +311,7 @@ float QRay3D::distance(const Vector3D &point) const */ /*! - \fn bool Qt3DRender::QRay3D::operator!=(const QRay3D &other) const + \fn bool Qt3DRender::RayCasting::QRay3D::operator!=(const QRay3D &other) const Returns \c true if this ray is not the same as \a other; \c false otherwise. @@ -318,8 +319,8 @@ float QRay3D::distance(const Vector3D &point) const */ /*! - \fn bool qFuzzyCompare(const Qt3DRender::QRay3D &ray1, const Qt3DRender::QRay3D &ray2) - \relates Qt3DRender::QRay3D + \fn bool qFuzzyCompare(const Qt3DRender::RayCasting::QRay3D &ray1, const Qt3DRender::RayCasting::QRay3D &ray2) + \relates Qt3DRender::RayCasting::QRay3D Returns \c true if \a ray1 and \a ray2 are almost equal; \c false otherwise. diff --git a/src/render/renderstates/qblendequationarguments.cpp b/src/render/renderstates/qblendequationarguments.cpp index 7ea020083..94693cab9 100644 --- a/src/render/renderstates/qblendequationarguments.cpp +++ b/src/render/renderstates/qblendequationarguments.cpp @@ -234,12 +234,12 @@ void QBlendEquationArguments::setDestinationAlpha(QBlendEquationArguments::Blend } /*! - \fn QBlendEquationArguments::sourceRgbaChanged(Blending sourceRgba) + \fn Qt3DRender::QBlendEquationArguments::sourceRgbaChanged(Blending sourceRgba) Notify that both sourceRgb and sourceAlpha properties have changed to \a sourceRgba. */ /*! - \fn QBlendEquationArguments::destinationRgbaChanged(Blending destinationRgba) + \fn Qt3DRender::QBlendEquationArguments::destinationRgbaChanged(Blending destinationRgba) Notify that both destinationRgb and destinationAlpha properties have changed to \a destinationRgba. diff --git a/src/render/renderstates/qrenderstatecreatedchange.cpp b/src/render/renderstates/qrenderstatecreatedchange.cpp index 5e0713552..666543c39 100644 --- a/src/render/renderstates/qrenderstatecreatedchange.cpp +++ b/src/render/renderstates/qrenderstatecreatedchange.cpp @@ -42,6 +42,7 @@ QT_BEGIN_NAMESPACE namespace Qt3DRender { /*! + * \internal * \class Qt3DRender::QRenderStateCreatedChange * \inheaderfile Qt3DRender/QRenderStateCreatedChange * \brief The QRenderStateCreatedChange class diff --git a/src/render/texture/qabstracttextureimage.cpp b/src/render/texture/qabstracttextureimage.cpp index 2f91539ff..8da24d936 100644 --- a/src/render/texture/qabstracttextureimage.cpp +++ b/src/render/texture/qabstracttextureimage.cpp @@ -69,13 +69,13 @@ namespace Qt3DRender { */ /*! - \fn QTextureImageDataPtr QTextureImageDataGenerator::operator()() + \fn Qt3DRender::QTextureImageDataPtr Qt3DRender::QTextureImageDataGenerator::operator()() Implement the method to return the texture image data. */ /*! - \fn bool QTextureImageDataGenerator::operator ==(const QTextureImageDataGenerator &other) const + \fn bool Qt3DRender::QTextureImageDataGenerator::operator ==(const QTextureImageDataGenerator &other) const Implement the method to compare this texture data generator to \a other. Returns a boolean that indicates whether the \l QAbstractTextureImage needs to reload @@ -124,7 +124,7 @@ QAbstractTextureImagePrivate::~QAbstractTextureImagePrivate() */ /*! - \fn QTextureImageDataGeneratorPtr QAbstractTextureImage::dataGenerator() const + \fn Qt3DRender::QTextureImageDataGeneratorPtr Qt3DRender::QAbstractTextureImage::dataGenerator() const Implement this method to return the \l QTextureImageDataGeneratorPtr, which will provide the data for the texture image. diff --git a/src/render/texture/qtexture.cpp b/src/render/texture/qtexture.cpp index 1ccf48b5d..e7c312a1c 100644 --- a/src/render/texture/qtexture.cpp +++ b/src/render/texture/qtexture.cpp @@ -1373,7 +1373,7 @@ void QTextureLoader::setMirrored(bool mirrored) } } -/*! +/* * Constructs a new QTextureFromSourceGenerator::QTextureFromSourceGenerator * instance with properties passed in via \a textureLoader * \param url @@ -1405,7 +1405,7 @@ QTextureFromSourceGenerator::QTextureFromSourceGenerator(QTextureLoader *texture m_format = textureLoader->format(); } -/*! +/* * Takes in a TextureGenerator via \a other and * \return whether generators have the same source. */ diff --git a/src/render/texture/qtextureimage.cpp b/src/render/texture/qtextureimage.cpp index 57c320a82..845e14233 100644 --- a/src/render/texture/qtextureimage.cpp +++ b/src/render/texture/qtextureimage.cpp @@ -271,7 +271,7 @@ void QTextureImage::sceneChangeEvent(const Qt3DCore::QSceneChangePtr &change) setStatus(static_cast<QTextureImage::Status>(e->value().toInt())); } -/*! +/* The constructor creates a new QImageTextureDataFunctor::QImageTextureDataFunctor instance with the specified \a url. */ |