#ifndef Magnum_MeshTools_Interleave_h #define Magnum_MeshTools_Interleave_h /* This file is part of Magnum. Copyright © 2010, 2011, 2012, 2013, 2014 Vladimír Vondruš Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /** @file * @brief Function @ref Magnum::MeshTools::interleave() */ #include #include #include #include #include "Magnum/Mesh.h" #include "Magnum/Buffer.h" namespace Magnum { namespace MeshTools { namespace Implementation { class Interleave { public: Interleave(): _attributeCount(0), _stride(0) {} template std::tuple> operator()(const T&... attributes) { /* Compute buffer size and stride */ _attributeCount = attributeCount(attributes...); Containers::Array data; if(_attributeCount && _attributeCount != ~std::size_t(0)) { _stride = stride(attributes...); /* Create output buffer */ data = Containers::Array(_attributeCount*_stride); /* Save the data */ write(data.begin(), attributes...); } return std::make_tuple(_attributeCount, _stride, std::move(data)); } template void operator()(Mesh& mesh, Buffer& buffer, BufferUsage usage, const T&... attributes) { Containers::Array data; std::tie(std::ignore, std::ignore, data) = operator()(attributes...); mesh.setVertexCount(_attributeCount); buffer.setData(data, usage); } /* Specialization for only one attribute array */ template typename std::enable_if::value, void>::type operator()(Mesh& mesh, Buffer& buffer, BufferUsage usage, const T& attribute) { mesh.setVertexCount(attribute.size()); buffer.setData(attribute, usage); } template 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, expected" << first.size() << "but got" << attributeCount(next...), 0); return first.size(); } template static std::size_t attributeCount(std::size_t, const T&... next) { return attributeCount(next...); } template static std::size_t attributeCount(std::size_t) { return ~std::size_t(0); } template 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 static std::size_t stride(std::size_t gap, const T&... next) { return gap + stride(next...); } private: template 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) std::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) { for(std::size_t i = 0; i != _attributeCount; ++i) std::memset(startingOffset+i*_stride, 0, gap); return gap; } /* Terminator functions for recursive calls */ static std::size_t attributeCount() { return 0; } static std::size_t stride() { return 0; } void write(char*) {} std::size_t _attributeCount; std::size_t _stride; }; } /** @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; Containers::Array data; std::tie(attributeCount, stride, data) = MeshTools::interleave(positions, textureCoordinates); // ... @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; Containers::Array 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 @ref interleave(Mesh&, Buffer&, BufferUsage, 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 @ref 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 @ref Mesh::setVertexCount() on your own. @attention You still must call @ref Mesh::setPrimitive() and @ref Mesh::addVertexBuffer() on the mesh afterwards. 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 @ref MeshTools::compressIndices() @todo rework so Mesh & Buffer doesn't need to be included in header */ template inline void interleave(Mesh& mesh, Buffer& buffer, BufferUsage usage, const T&... attributes) { return Implementation::Interleave()(mesh, buffer, usage, attributes...); } }} #endif