Browse Source

Trade: document restrictions on morph target IDs in MeshAttributeData.

Forgot that in f84c3679c3.
pull/168/head
Vladimír Vondruš 2 years ago
parent
commit
b1742b85b7
  1. 25
      src/Magnum/Trade/MeshData.h

25
src/Magnum/Trade/MeshData.h

@ -474,9 +474,12 @@ class MAGNUM_TRADE_EXPORT MeshAttributeData {
* Expects that @p data stride fits into a signed 16-bit value, that * Expects that @p data stride fits into a signed 16-bit value, that
* vertex count fits into 32 bits, and for builtin attributes that * vertex count fits into 32 bits, and for builtin attributes that
* @p format corresponds to @p name, @p arraySize is either zero for * @p format corresponds to @p name, @p arraySize is either zero for
* non-array attributes or non-zero for array attributes. The stride * non-array attributes or non-zero for array attributes. The
* can be zero or negative, but note that such data layouts are not * @p morphTargetId is expected to be greater or equal to @cpp -1 @ce
* commonly supported by GPU APIs. * and less than @cpp 128 @ce and has to be @cpp -1 @ce for builtin
* attributes that can't be morph targets. The stride can be zero or
* negative, but note that such data layouts are not commonly supported
* by GPU APIs.
*/ */
explicit MeshAttributeData(MeshAttribute name, VertexFormat format, const Containers::StridedArrayView1D<const void>& data, UnsignedShort arraySize = 0, Int morphTargetId = -1) noexcept; explicit MeshAttributeData(MeshAttribute name, VertexFormat format, const Containers::StridedArrayView1D<const void>& data, UnsignedShort arraySize = 0, Int morphTargetId = -1) noexcept;
@ -494,9 +497,11 @@ class MAGNUM_TRADE_EXPORT MeshAttributeData {
* size matches @p format and @p arraySize, and for builtin attributes * size matches @p format and @p arraySize, and for builtin attributes
* that @p format corresponds to @p name and @p arraySize is either * that @p format corresponds to @p name and @p arraySize is either
* zero for non-array attributes or non-zero for array attributes. The * zero for non-array attributes or non-zero for array attributes. The
* stride is expected to fit into a signed 16-bit value. It can be zero * @p morphTargetId is expected to be greater or equal to @cpp -1 @ce
* or negative, but note that such data layouts are not commonly * and less than @cpp 128 @ce and has to be @cpp -1 @ce for builtin
* supported by GPU APIs. * attributes that can't be morph targets. The stride is expected to
* fit into a signed 16-bit value. It can be zero or negative, but note
* that such data layouts are not commonly supported by GPU APIs.
*/ */
explicit MeshAttributeData(MeshAttribute name, VertexFormat format, const Containers::StridedArrayView2D<const char>& data, UnsignedShort arraySize = 0, Int morphTargetId = -1) noexcept; explicit MeshAttributeData(MeshAttribute name, VertexFormat format, const Containers::StridedArrayView2D<const char>& data, UnsignedShort arraySize = 0, Int morphTargetId = -1) noexcept;
@ -591,9 +596,11 @@ class MAGNUM_TRADE_EXPORT MeshAttributeData {
* *
* For builtin attributes expects that @p arraySize is zero for * For builtin attributes expects that @p arraySize is zero for
* non-array attributes and non-zero for array attributes. The * non-array attributes and non-zero for array attributes. The
* @p stride is expected to fit into a signed 16-bit value. It can be * @p morphTargetId is expected to be greater or equal to @cpp -1 @ce
* zero or negative, but note that such data layouts are not commonly * and less than @cpp 128 @ce and has to be @cpp -1 @ce for builtin
* supported by GPU APIs. * attributes that can't be morph targets. The @p stride is expected to
* fit into a signed 16-bit value. It can be zero or negative, but note
* that such data layouts are not commonly supported by GPU APIs.
* *
* Additionally, for even more flexibility, the @p vertexCount can be * Additionally, for even more flexibility, the @p vertexCount can be
* overridden at @ref MeshData construction time, however all attributes * overridden at @ref MeshData construction time, however all attributes

Loading…
Cancel
Save