diff options
| author | Paul Lemire <paul.lemire@kdab.com> | 2016-08-09 16:24:48 +0200 |
|---|---|---|
| committer | Sean Harmer <sean.harmer@kdab.com> | 2016-08-09 21:08:23 +0000 |
| commit | 4684acf7c6a1e7bd0672e2523fa7953ae210c588 (patch) | |
| tree | 3dda3e13f11b6782c22b6ad26c7ac2e2dcbd68de /src/render/geometry | |
| parent | 3523106229477290442cf356bd71fd63e01445d5 (diff) | |
Complete QAttribute documentation
Change-Id: Id0d2fa4434a851e4dc0b4565faa15fd5d834c283
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>
Diffstat (limited to 'src/render/geometry')
| -rw-r--r-- | src/render/geometry/qattribute.cpp | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/src/render/geometry/qattribute.cpp b/src/render/geometry/qattribute.cpp index fac4dbd7c..b493f7fe8 100644 --- a/src/render/geometry/qattribute.cpp +++ b/src/render/geometry/qattribute.cpp @@ -65,7 +65,12 @@ QAttributePrivate::QAttributePrivate() * \qmltype Attribute * \instantiates Qt3DRender::QAttribute * \inqmlmodule Qt3D.Render - * \brief Uncreatable + * \brief Defines an attribute and how data should be read from a Buffer. + * + * When providing your own attributes, it may make sense to name your attribute + * using helpers such as QAttribute::defaultPositionAttributeName() as that + * will ensure your geometry will be compatible with picking and the various + * materials provided in the Qt3DExtras module. */ /*! @@ -74,6 +79,14 @@ QAttributePrivate::QAttributePrivate() * * \inherits Qt3DCore::QNode * + * \brief Defines an attribute and how data should be read from a QBuffer. + * + * When providing your own attributes, it may make sense to name your attribute + * using helpers such as QAttribute::defaultPositionAttributeName() as that + * will ensure your geometry will be compatible with picking and the various + * materials provided in the Qt3DExtras module. + * + * \sa QBuffer. */ /*! |