#ifndef Magnum_MeshTools_Interleave_h #define Magnum_MeshTools_Interleave_h /* Copyright © 2010, 2011, 2012 Vladimír Vondruš This file is part of Magnum. Magnum is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License version 3 only, as published by the Free Software Foundation. Magnum is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License version 3 for more details. */ /** @file * @brief Function Magnum::MeshTools::interleave() */ #include #include #include #include #include "Mesh.h" #include "Buffer.h" namespace Magnum { namespace MeshTools { #ifndef DOXYGEN_GENERATING_OUTPUT namespace Implementation { class Interleave { public: inline Interleave(): _attributeCount(0), _stride(0), _data(nullptr) {} template std::tuple operator()(const T&... attributes) { /* Compute buffer size and stride */ _attributeCount = attributeCount(attributes...); if(_attributeCount && _attributeCount != ~std::size_t(0)) { _stride = stride(attributes...); /* Create output buffer */ _data = new char[_attributeCount*_stride]; /* Save the data */ write(_data, attributes...); } return std::make_tuple(_attributeCount, _stride, _data); } template void operator()(Mesh* mesh, Buffer* buffer, Buffer::Usage usage, const T&... attributes) { operator()(attributes...); mesh->setVertexCount(_attributeCount); buffer->setData(_attributeCount*_stride, _data, usage); delete[] _data; } /* Specialization for only one attribute array */ template typename std::enable_if::value, void>::type operator()(Mesh* mesh, Buffer* buffer, Buffer::Usage usage, const T& attribute) { mesh->setVertexCount(attribute.size()); buffer->setData(attribute, usage); } template inline static typename std::enable_if::value, std::size_t>::type attributeCount(const T& first, const U&... next) { CORRADE_ASSERT(sizeof...(next) == 0 || attributeCount(next...) == first.size() || attributeCount(next...) == ~std::size_t(0), "MeshTools::interleave(): attribute arrays don't have the same length, nothing done.", 0); return first.size(); } template inline static std::size_t attributeCount(std::size_t, const T&... next) { return attributeCount(next...); } template inline static std::size_t attributeCount(std::size_t) { return ~std::size_t(0); } template inline static typename std::enable_if::value, std::size_t>::type stride(const T&, const U&... next) { return sizeof(typename T::value_type) + stride(next...); } template inline static std::size_t stride(std::size_t gap, const T&... next) { return gap + stride(next...); } private: template inline void write(char* startingOffset, const T& first, const U&... next) { write(startingOffset+writeOne(startingOffset, first), next...); } /* Copy data to the buffer */ template typename std::enable_if::value, std::size_t>::type writeOne(char* startingOffset, const T& attributeList) { auto it = attributeList.begin(); for(std::size_t i = 0; i != _attributeCount; ++i, ++it) memcpy(startingOffset+i*_stride, reinterpret_cast(&*it), sizeof(typename T::value_type)); return sizeof(typename T::value_type); } /* Fill gap with zeros */ std::size_t writeOne(char* startingOffset, std::size_t gap) { char* data = new char[gap](); for(std::size_t i = 0; i != _attributeCount; ++i) memcpy(startingOffset+i*_stride, data, gap); delete[] data; return gap; } /* Terminator functions for recursive calls */ inline static std::size_t attributeCount() { return 0; } inline static std::size_t stride() { return 0; } inline void write(char*) {} std::size_t _attributeCount; std::size_t _stride; char* _data; }; } #endif /** @brief %Interleave vertex attributes This function takes list of attribute arrays and returns them interleaved, so data for each attribute are in continuous place in memory. Returned tuple contains attribute count, stride and data array. Deleting the data array is up to the user. Size of the data buffer can be computed from attribute count and stride, as shown below. Example usage: @code std::vector positions; std::vector textureCoordinates; std::size_t attributeCount; std::size_t stride; char* data; std::tie(attributeCount, stride, data) = MeshTools::interleave(positions, textureCoordinates); std::size_t dataSize = attributeCount*stride; // ... delete[] data; @endcode It's often desirable to align data for one vertex on 32bit boundaries. To achieve that, you can specify gaps between the attributes: @code std::vector positions; std::vector weights; std::vector> vertexColors; std::size_t attributeCount; std::size_t stride; char* data; std::tie(attributeCount, stride, data) = MeshTools::interleave(positions, weights, 2, textureCoordinates, 1); @endcode This way vertex stride is 24 bytes, without gaps it would be 21 bytes, causing possible performance loss. @attention The function expects that all arrays have the same size. @note The only requirements to attribute array type is that it must have typedef `T::value_type`, forward iterator (to be used with range-based for) and function `size()` returning count of elements. In most cases it will be `std::vector` or `std::array`. See also interleave(Mesh*, Buffer*, Buffer::Usage, const T&...), which writes the interleaved array directly into buffer of given mesh. */ /* enable_if to avoid clash with overloaded function below */ template inline typename std::enable_if::value, std::tuple>::type interleave(const T& first, const U&... next) { return Implementation::Interleave()(first, next...); } /** @brief %Interleave vertex attributes and write them to array buffer @param mesh Output mesh @param buffer Output vertex buffer @param usage Vertex buffer usage @param attributes Attribute arrays and gaps The same as interleave(const T&, const U&...), but this function writes the output to given array buffer and updates vertex count in the mesh accordingly, so you don't have to call Mesh::setVertexCount() on your own. @attention Setting primitive type and binding the attributes to shader is left to user - see @ref Mesh-configuration "Mesh documentation". For only one attribute array this function is convenient equivalent to the following, without any performance loss: @code buffer->setData(attribute, usage); mesh->setVertexCount(attribute.size()); @endcode @see MeshTools::compressIndices() */ template inline void interleave(Mesh* mesh, Buffer* buffer, Buffer::Usage usage, const T&... attributes) { return Implementation::Interleave()(mesh, buffer, usage, attributes...); } }} #endif