summaryrefslogtreecommitdiffstats
path: root/src/render/geometry/qabstractbuffer.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/render/geometry/qabstractbuffer.cpp')
-rw-r--r--src/render/geometry/qabstractbuffer.cpp45
1 files changed, 40 insertions, 5 deletions
diff --git a/src/render/geometry/qabstractbuffer.cpp b/src/render/geometry/qabstractbuffer.cpp
index 7f7c11654..7cabeee56 100644
--- a/src/render/geometry/qabstractbuffer.cpp
+++ b/src/render/geometry/qabstractbuffer.cpp
@@ -44,32 +44,61 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
-/*!
- \class Qt3DCore::QAbstractBufferPrivate
- \internal
-*/
QAbstractBufferPrivate::QAbstractBufferPrivate()
: QNodePrivate()
{
}
+/*!
+ * \qmltype AbstractBuffer
+ * \instantiates Qt3DRender::QAbstractBuffer
+ * \inqmlmodule Qt3D.Render
+ * \brief Uncreatable
+ */
+
+/*!
+ * \class Qt3DRender::QAbstractBuffer
+ * \inmodule Qt3DRender
+ *
+ * \inherits Qt3DCore::QNode
+ *
+ * Abstract class.
+ */
+
+/*!
+ * \fn void Qt3DRender::QAbstractBuffer::dataChanged(const QByteArray &bytes)
+ *
+ * This signal is emitted with \a bytes when data changes.
+ */
+
+/*!
+ * Constructs a new QAbstractBuffer with \a parent.
+ */
QAbstractBuffer::QAbstractBuffer(QNode *parent)
: QNode(*new QAbstractBufferPrivate(), parent)
{
}
+/*!
+ * Destroys the abstract buffer.
+ */
QAbstractBuffer::~QAbstractBuffer()
{
Q_ASSERT_X(Qt3DCore::QNodePrivate::get(this)->m_wasCleanedUp, Q_FUNC_INFO, "QNode::cleanup should have been called by now. A Qt3DRender::QAbstractBuffer subclass didn't call QNode::cleanup in its destructor");
}
-/*! \internal */
+/*!
+ * \internal
+ */
QAbstractBuffer::QAbstractBuffer(QAbstractBufferPrivate &dd, QNode *parent)
: QNode(dd, parent)
{
}
+/*!
+ * \internal
+ */
void QAbstractBuffer::copy(const QNode *ref)
{
QNode::copy(ref);
@@ -77,6 +106,9 @@ void QAbstractBuffer::copy(const QNode *ref)
d_func()->m_data = buffer->d_func()->m_data;
}
+/*!
+ * Sets \a bytes as data.
+ */
void QAbstractBuffer::setData(const QByteArray &bytes)
{
Q_D(QAbstractBuffer);
@@ -87,6 +119,9 @@ void QAbstractBuffer::setData(const QByteArray &bytes)
}
}
+/*!
+ * \return the data.
+ */
QByteArray QAbstractBuffer::data() const
{
Q_D(const QAbstractBuffer);