mirror of https://github.com/mosra/magnum.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
76 lines
2.5 KiB
76 lines
2.5 KiB
#ifndef Magnum_MeshTools_CompressIndices_h |
|
#define Magnum_MeshTools_CompressIndices_h |
|
/* |
|
Copyright © 2010, 2011, 2012 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
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::compressIndices() |
|
*/ |
|
|
|
#include <tuple> |
|
|
|
#include "Buffer.h" |
|
#include "IndexedMesh.h" |
|
|
|
#include "magnumMeshToolsVisibility.h" |
|
|
|
namespace Magnum { namespace MeshTools { |
|
|
|
/** |
|
@brief Compress vertex indices |
|
@param indices Index array |
|
@return Index count, type and compressed index array. Deleting the array is |
|
user responsibility. |
|
|
|
This function takes index array and outputs them compressed to smallest |
|
possible size. For example when your indices have maximum number 463, it's |
|
wasteful to store them in array of 32bit integers, array of 16bit integers is |
|
sufficient. Size of the buffer can be computed from index count and type, as |
|
shown below. Example usage: |
|
@code |
|
std::size_t indexCount; |
|
Type indexType; |
|
char* data; |
|
std::tie(indexCount, indexType, data) = MeshTools::compressIndices(indices); |
|
std::size_t dataSize = indexCount*TypeInfo::sizeOf(indexType); |
|
// ... |
|
delete[] data; |
|
@endcode |
|
|
|
See also compressIndices(IndexedMesh*, Buffer::Usage, const std::vector<std::uint32_t>&), |
|
which writes the compressed data directly into index buffer of given mesh. |
|
*/ |
|
std::tuple<std::size_t, IndexedMesh::IndexType, char*> MAGNUM_MESHTOOLS_EXPORT compressIndices(const std::vector<std::uint32_t>& indices); |
|
|
|
/** |
|
@brief Compress vertex indices and write them to index buffer |
|
@param mesh Output mesh |
|
@param buffer Index buffer |
|
@param usage Index buffer usage |
|
@param indices Index array |
|
|
|
The same as compressIndices(const std::vector<std::uint32_t>&), but this |
|
function writes the output to given index buffer and updates index count and |
|
type in the mesh accordingly, so you don't have to call |
|
IndexedMesh::setIndexBuffer(), IndexedMesh::setIndexCount() and |
|
IndexedMesh::setIndexType() on your own. |
|
|
|
@see MeshTools::interleave() |
|
*/ |
|
void MAGNUM_MESHTOOLS_EXPORT compressIndices(IndexedMesh* mesh, Buffer* buffer, Buffer::Usage usage, const std::vector<std::uint32_t>& indices); |
|
|
|
}} |
|
|
|
#endif
|
|
|