summaryrefslogtreecommitdiffstats
path: root/src/render
diff options
context:
space:
mode:
Diffstat (limited to 'src/render')
-rw-r--r--src/render/framegraph/qblitframebuffer.cpp2
-rw-r--r--src/render/frontend/qabstractfunctor.cpp3
-rw-r--r--src/render/frontend/qcamera.cpp6
-rw-r--r--src/render/frontend/qpickingsettings.cpp6
-rw-r--r--src/render/materialsystem/qgraphicsapifilter.cpp2
-rw-r--r--src/render/picking/qabstractraycaster.cpp6
-rw-r--r--src/render/picking/qraycaster.cpp31
-rw-r--r--src/render/picking/qscreenraycaster.cpp19
-rw-r--r--src/render/raycasting/qray3d.cpp23
-rw-r--r--src/render/renderstates/qrenderstatecreatedchange.cpp6
10 files changed, 57 insertions, 47 deletions
diff --git a/src/render/framegraph/qblitframebuffer.cpp b/src/render/framegraph/qblitframebuffer.cpp
index d5484b719..b0a29eab8 100644
--- a/src/render/framegraph/qblitframebuffer.cpp
+++ b/src/render/framegraph/qblitframebuffer.cpp
@@ -324,7 +324,7 @@ void QBlitFramebuffer::setSourceRect(const QRectF &inputRect)
}
/*!
- Sets the destination rectangle to \a inputRect. The coordinates are assumed
+ Sets the destination rectangle to \a outputRect. The coordinates are assumed
to follow the normal Qt coordinate system, meaning Y runs from top to
bottom.
*/
diff --git a/src/render/frontend/qabstractfunctor.cpp b/src/render/frontend/qabstractfunctor.cpp
index 9f4727865..4be1da595 100644
--- a/src/render/frontend/qabstractfunctor.cpp
+++ b/src/render/frontend/qabstractfunctor.cpp
@@ -72,7 +72,8 @@ namespace Qt3DRender {
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
- to \l QObject::qobject_cast, except with functors derived from QAbstractFunctor.
+ to \l [QtCore] {qobject_cast(const QObject *object)}{qobject_cast()},
+ except with functors derived from QAbstractFunctor.
\warning If T was not declared with \l QT3D_FUNCTOR macro, then the results are undefined.
*/
diff --git a/src/render/frontend/qcamera.cpp b/src/render/frontend/qcamera.cpp
index 73ec2c71f..274b555f6 100644
--- a/src/render/frontend/qcamera.cpp
+++ b/src/render/frontend/qcamera.cpp
@@ -735,11 +735,11 @@ void QCamera::viewSphere(const QVector3D &center, float radius)
}
/*!
- * Rotates and moves the camera so that it's viewCenter is the center of the entity's bounding volume
- * and the entire entity fits in the view port.
+ * Rotates and moves the camera so that it's viewCenter is the center of the
+ * \a {entity}'s bounding volume and the entire entity fits in the view port.
*
* \note Only works if the lens is in perspective projection mode.
- * \sa Qt3D.Render::Camera::projectionType
+ * \sa {Qt3D.Render::Camera::projectionType}{Camera.projectionType}
*/
void QCamera::viewEntity(Qt3DCore::QEntity *entity)
{
diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp
index 5a49cd182..66d3fc912 100644
--- a/src/render/frontend/qpickingsettings.cpp
+++ b/src/render/frontend/qpickingsettings.cpp
@@ -61,7 +61,7 @@ namespace Qt3DRender {
In both cases, a ray will be cast through the scene to find geometry intersecting the ray.
- \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster.
+ \sa QObjectPicker, QPickEvent, QPickTriangleEvent, QRayCaster, QScreenRayCaster
*/
/*!
@@ -151,7 +151,7 @@ float QPickingSettings::worldSpaceTolerance() const
* any edge of the entity's mesh component.
* \value PointPicking An entity is considered picked if the picking ray intersects with
* any point of the entity's mesh component.
- * \value PrimitePicking An entity is considered picked if the picking ray intersects with
+ * \value PrimitivePicking An entity is considered picked if the picking ray intersects with
* any point, edge or triangle of the entity's mesh component.
*/
@@ -285,7 +285,7 @@ void QPickingSettings::setFaceOrientationPickingMode(QPickingSettings::FaceOrien
Holds the threshold, in model space coordinates, used to evaluate line and point picking.
*/
/*!
- * Set the threshold used for line and point picking
+ * Sets the threshold used for line and point picking to \a worldSpaceTolerance.
*/
void QPickingSettings::setWorldSpaceTolerance(float worldSpaceTolerance)
{
diff --git a/src/render/materialsystem/qgraphicsapifilter.cpp b/src/render/materialsystem/qgraphicsapifilter.cpp
index a94018360..65ad77d28 100644
--- a/src/render/materialsystem/qgraphicsapifilter.cpp
+++ b/src/render/materialsystem/qgraphicsapifilter.cpp
@@ -141,6 +141,8 @@ QGraphicsApiFilter::~QGraphicsApiFilter()
\value OpenGLES QSurfaceFormat::OpenGLES
\value OpenGL QSurfaceFormat::OpenGL
+ \value Vulkan Vulkan
+ \value DirectX DirectX
*/
diff --git a/src/render/picking/qabstractraycaster.cpp b/src/render/picking/qabstractraycaster.cpp
index 804a7e7fb..4d7a77765 100644
--- a/src/render/picking/qabstractraycaster.cpp
+++ b/src/render/picking/qabstractraycaster.cpp
@@ -111,9 +111,9 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit
Furthermore, Qt3DRender::QLayer components can be used to control how entities, or entity
sub-graphs, react to ray casting.
- Note: components derived from QAbstractRayCaster should not be shared amount multiple entities.
+ \note Components derived from QAbstractRayCaster should not be shared amount multiple entities.
- \sa Qt3DRender::QRayCaster, Qt3DRender::QScreenRayCaster, Qt3DRender::QObjectPicker, Qt3DRender::QPickSettings
+ \sa Qt3DRender::QRayCaster, Qt3DRender::QScreenRayCaster, Qt3DRender::QObjectPicker, Qt3DRender::QPickingSettings
*/
/*!
\qmltype AbstractRayCaster
@@ -144,7 +144,7 @@ void QAbstractRayCasterPrivate::dispatchHits(const QAbstractRayCaster::Hits &hit
Note: components derived from AbstractRayCaster should not be shared amount multiple entities.
- \sa Qt3D.Render::RayCaster, Qt3D.Render::ScreenRayCaster, Qt3D.Render::ObjectPicker, Qt3D.Render::PickSettings
+ \sa Qt3D.Render::RayCaster, Qt3D.Render::ScreenRayCaster, Qt3D.Render::ObjectPicker, Qt3D.Render::PickingSettings
*/
/*!
diff --git a/src/render/picking/qraycaster.cpp b/src/render/picking/qraycaster.cpp
index cbc536d46..cfe5bce1b 100644
--- a/src/render/picking/qraycaster.cpp
+++ b/src/render/picking/qraycaster.cpp
@@ -82,34 +82,36 @@ namespace Qt3DRender {
*/
/*!
- \property QVector3D origin
+ \property Qt3DRender::QRayCaster::origin
- Holds the origin of the 3d ray in local coordinates.
+ Holds the origin of the 3D ray in local coordinates.
*/
/*!
- \qmlproperty Vector3D origin
+ \qmlproperty vector3d Qt3D.Render::RayCaster::origin
- Holds the origin of the 3d ray in local coordinates.
+ Holds the origin of the 3D ray in local coordinates.
*/
/*!
- \property QVector3D direction
+ \property Qt3DRender::QRayCaster::direction
- Holds the direction of the 3d ray. This should be a unit vector.
+ Holds the direction of the 3D ray. This should be a unit vector.
*/
+
/*!
- \qmlproperty Vector3D direction
+ \qmlproperty vector3D Qt3D.Render::RayCaster::direction
- Holds the direction of the 3d ray. This should be a unit vector.
+ Holds the direction of the 3D ray. This should be a unit vector.
*/
/*!
- \property float length
+ \property Qt3DRender::QRayCaster::length
- Holds the length of the 3d ray.
+ Holds the length of the 3D ray.
*/
+
/*!
- \qmlproperty real direction
+ \qmlproperty real Qt3D.Render::RayCaster::length
Holds the length of the 3d ray.
*/
@@ -169,7 +171,7 @@ float QRayCaster::length() const
}
/*!
- * \brief Set the length of the ray to \a length
+ * \brief Sets the length of the ray to \a length.
*
* If the value is less than or equal to zero, the ray is concidered to be infinite.
*/
@@ -183,7 +185,7 @@ void QRayCaster::setLength(float length)
}
/*!
- * Convenience method to enable the component and trigger tests using the current ray
+ * Convenience method to enable the component and trigger tests using the current ray.
*/
void QRayCaster::trigger()
{
@@ -191,7 +193,8 @@ void QRayCaster::trigger()
}
/*!
- * Convenience method to set the ray details and enable the component to trigger tests
+ * Convenience method to set the ray details \a origin, \a direction, and \a length,
+ * and enable the component to trigger tests.
*/
void QRayCaster::trigger(const QVector3D &origin, const QVector3D &direction, float length)
{
diff --git a/src/render/picking/qscreenraycaster.cpp b/src/render/picking/qscreenraycaster.cpp
index 5850353f3..99c3015f5 100644
--- a/src/render/picking/qscreenraycaster.cpp
+++ b/src/render/picking/qscreenraycaster.cpp
@@ -56,7 +56,7 @@ namespace Qt3DRender {
\inherits QAbstractRayCaster
QScreenRayCaster can be used to perform ray casting tests by specifying coordinates in
- screen space, which will be used to construct an actual 3d ray between the near and
+ screen space, which will be used to construct an actual 3D ray between the near and
far planes.
\sa QRayCaster
@@ -69,29 +69,28 @@ namespace Qt3DRender {
\instantiates Qt3DRender::QScreenRayCaster
ScreenRayCaster can be used to perform ray casting tests by specifying coordinates in
- screen space, which will be used to construct an actual 3d ray between the near and
+ screen space, which will be used to construct an actual 3D ray between the near and
far planes.
\sa RayCaster
*/
/*!
- \property QPoint position
+ \property Qt3DRender::QScreenRayCaster::position
- Holds the screen space position used to compute the actual 3d ray for intersection tests.
+ Holds the screen space position used to compute the actual 3D ray for intersection tests.
Note: the coordinates will be used for every available render surface as long as they are
in the valid range.
*/
/*!
- \qmlproperty Point2D position
+ \qmlproperty point Qt3D.Render::ScreenRayCaster::position
- Holds the length of the 3d ray.
+ Holds the length of the 3D ray.
- Note: the coordinates will be used for every available render surface as long as they are
+ \note The coordinates will be used for every available render surface as long as they are
in the valid range.
*/
-
QScreenRayCaster::QScreenRayCaster(Qt3DCore::QNode *parent)
: QAbstractRayCaster(parent)
{
@@ -126,7 +125,7 @@ void QScreenRayCaster::setPosition(const QPoint &position)
}
/*!
- Convenience method to enable the component and trigger tests using the current coordinate value
+ Convenience method to enable the component and trigger tests using the current coordinate value.
*/
void QScreenRayCaster::trigger()
{
@@ -134,7 +133,7 @@ void QScreenRayCaster::trigger()
}
/*!
- Convenience method to set the coordinate value and enable the component to trigger tests
+ Convenience method to set the coordinate value \a position and enable the component to trigger tests.
*/
void QScreenRayCaster::trigger(const QPoint &position)
{
diff --git a/src/render/raycasting/qray3d.cpp b/src/render/raycasting/qray3d.cpp
index 6d8469aa1..d8ad25b50 100644
--- a/src/render/raycasting/qray3d.cpp
+++ b/src/render/raycasting/qray3d.cpp
@@ -47,6 +47,11 @@ namespace Qt3DRender {
namespace RayCasting {
/*!
+ \namespace Qt3DRender::RayCasting
+ \internal
+*/
+
+/*!
\internal
\class Qt3DRender::RayCasting::QRay3D
\inmodule Qt3DRender
@@ -83,7 +88,7 @@ QRay3D::QRay3D()
}
/*!
- \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const QVector3D &origin, const QVector3D &direction, float distance)
+ \fn Qt3DRender::RayCasting::QRay3D::QRay3D(const Vector3D &origin, const Vector3D &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.
@@ -117,7 +122,7 @@ Vector3D QRay3D::origin() const
}
/*!
- \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const QVector3D &value)
+ \fn void Qt3DRender::RayCasting::QRay3D::setOrigin(const Vector3D &value)
Sets the origin point of this ray to \a value.
@@ -141,7 +146,7 @@ Vector3D QRay3D::direction() const
}
/*!
- \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const QVector3D &direction)
+ \fn void Qt3DRender::RayCasting::QRay3D::setDirection(const Vector3D &direction)
Sets the direction vector of this ray to \a direction.
@@ -194,7 +199,7 @@ bool QRay3D::operator!=(const QRay3D &other) const
}
/*!
- Returns true if \a point lies on this ray; false otherwise.
+ Returns \c true if \a point lies on this ray; \c false otherwise.
*/
bool QRay3D::contains(const Vector3D &point) const
{
@@ -208,7 +213,7 @@ bool QRay3D::contains(const Vector3D &point) const
}
/*!
- Returns true if \a ray lies on this ray; false otherwise. If true,
+ Returns \c true if \a ray lies on this ray; \c false otherwise. If true,
this implies that the two rays are actually the same, but with
different origin() points or an inverted direction().
*/
@@ -285,7 +290,7 @@ float QRay3D::distance(const Vector3D &point) const
}
/*!
- \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const QMatrix4x4 &matrix)
+ \fn Qt3DRender::RayCasting::QRay3D &Qt3DRender::RayCasting::QRay3D::transform(const Matrix4x4 &matrix)
Transforms this ray using \a matrix, replacing origin() and
direction() with the transformed versions.
@@ -294,7 +299,7 @@ float QRay3D::distance(const Vector3D &point) const
*/
/*!
- \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const QMatrix4x4 &matrix) const
+ \fn Qt3DRender::RayCasting::QRay3D Qt3DRender::RayCasting::QRay3D::transformed(const Matrix4x4 &matrix) const
Returns a new ray that is formed by transforming origin()
and direction() using \a matrix.
@@ -344,7 +349,7 @@ QDebug operator<<(QDebug dbg, const QRay3D &ray)
#ifndef QT_NO_DATASTREAM
/*!
- \relates Qt3DRender::QRay3D
+ \relates Qt3DRender::RayCasting::QRay3D
Writes the given \a ray to the given \a stream and returns a
reference to the stream.
@@ -359,7 +364,7 @@ QDataStream &operator<<(QDataStream &stream, const QRay3D &ray)
}
/*!
- \relates Qt3DRender::QRay3D
+ \relates Qt3DRender::RayCasting::QRay3D
Reads a 3D ray from the given \a stream into the given \a ray
and returns a reference to the stream.
diff --git a/src/render/renderstates/qrenderstatecreatedchange.cpp b/src/render/renderstates/qrenderstatecreatedchange.cpp
index 666543c39..02989a29e 100644
--- a/src/render/renderstates/qrenderstatecreatedchange.cpp
+++ b/src/render/renderstates/qrenderstatecreatedchange.cpp
@@ -64,7 +64,7 @@ public:
Render::StateMask m_type;
};
-/*!
+/*
* The constructor creates a new QRenderStateCreatedChangeBase::QRenderStateCreatedChangeBase
* instance with the specified \a renderState.
*/
@@ -73,8 +73,8 @@ QRenderStateCreatedChangeBase::QRenderStateCreatedChangeBase(const QRenderState
{
}
-/*!
- * \return the current render state type
+/*
+ * Returns the current render state type.
*/
Render::StateMask QRenderStateCreatedChangeBase::renderStateType() const
{