diff options
author | Paul Wicking <paul.wicking@qt.io> | 2019-05-16 15:13:34 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-06-07 13:45:54 +0000 |
commit | 614eddc31186a05bc37cfcb071caf9851ac1d010 (patch) | |
tree | 4d3f4b5a355857b60e2a2244e4a1205e4e639adb /src/render/geometry | |
parent | ad305807bd7005084ca8cadb281b6735651c9b02 (diff) |
Doc: Extend Qt3D documentation
This change adds missing C++ and/or QML documentation for:
* enum QBuffer::AccessType
* QBuffer::accessType()
* QBuffer::dataAvailable()
* ForwardRenderer::externalRenderTargetSize
* enumeration Qt3D.Render.Light::type
* Qt3D.Render.Light::color
* Qt3D.Render.Light::intensity
Fixes: QTBUG-73071
Change-Id: I48b13cb8001558b20bd801b6f96f5b5933144d82
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/render/geometry')
-rw-r--r-- | src/render/geometry/qbuffer.cpp | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/src/render/geometry/qbuffer.cpp b/src/render/geometry/qbuffer.cpp index fe065929d..e0574a4c5 100644 --- a/src/render/geometry/qbuffer.cpp +++ b/src/render/geometry/qbuffer.cpp @@ -117,6 +117,12 @@ QBufferPrivate::QBufferPrivate() */ /*! + * \fn void Qt3DRender::QBuffer::dataAvailable() + * + * This signal is emitted when data becomes available. + */ + +/*! \class Qt3DRender::QBufferDataGenerator \inmodule Qt3DRender @@ -252,6 +258,17 @@ QBufferPrivate::QBufferPrivate() */ /*! + * \enum QBuffer::AccessType + * + * \value Write + * Write access + * \value Read + * Read access + * \value ReadWrite + * Write|Read + */ + +/*! * \typedef Qt3DRender::QBufferDataGeneratorPtr * \relates Qt3DRender::QBuffer */ @@ -443,6 +460,13 @@ bool QBuffer::isSyncData() const return d->m_syncData; } +/*! + * \property Qt3DRender::QBuffer::accessType + * + * Returns the \l {QBuffer::}{AccessType} of the buffer. + * + * \sa QBuffer::AccessType + */ QBuffer::AccessType QBuffer::accessType() const { Q_D(const QBuffer); |