diff options
| author | Paul Lemire <paul.lemire@kdab.com> | 2016-08-09 16:25:20 +0200 |
|---|---|---|
| committer | Sean Harmer <sean.harmer@kdab.com> | 2016-08-10 19:44:45 +0000 |
| commit | 194acb25d72c841a53c22ee56f4b1a86fde6a6e7 (patch) | |
| tree | 402ad60b18f5c5b925e0a4e0868b1c9370865944 | |
| parent | bf439a80677c459441dfe60fb33b868182feb04c (diff) | |
Doc: complete QBuffer doc
Change-Id: I2698dd760c8124fb7cddbd3d22c739db2576dcdd
Reviewed-by: Kevin Ottens <kevin.ottens@kdab.com>
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
| -rw-r--r-- | src/render/geometry/qbuffer.cpp | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/render/geometry/qbuffer.cpp b/src/render/geometry/qbuffer.cpp index c8cc8b778..e79ebcd24 100644 --- a/src/render/geometry/qbuffer.cpp +++ b/src/render/geometry/qbuffer.cpp @@ -59,6 +59,9 @@ QBufferPrivate::QBufferPrivate() * \qmltype Buffer * \instantiates Qt3DRender::QBuffer * \inqmlmodule Qt3D.Render + * + * \brief Provides a data store for raw data to later be used as vertices or + * uniforms. */ /*! @@ -89,6 +92,16 @@ QBufferPrivate::QBufferPrivate() * \inmodule Qt3DRender * * \inherits Qt3DCore::QNode + * + * \brief Provides a data store for raw data to later be used as vertices or + * uniforms. + * + * Data can either be provided directly using QBuffer::setData() or by + * specifying a generator with QBuffer::setDataGenerator() and providing a + * Qt3DRender::QBufferDataGeneratorPtr. + * + * When using a generator the data will be loaded asynchronously in a job. The + * loaded data can be read back if the QBuffer::syncData flag is set to true. */ /*! |