ic
/
magnum
mirror of https://github.com/mosra/magnum.git
6
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
5423 Commits
21 Branches
19 Tags
70 MiB
Tree: 762dba470c
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '762dba470c'
${ noResults }
magnum/src/Magnum/MeshTools/CompressIndices.h

99 lines
3.6 KiB
Raw Normal View History Unescape

MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
#ifndef Magnum_MeshTools_CompressIndices_h
#define Magnum_MeshTools_CompressIndices_h
/*
This file is part of Magnum.
Updated copyright year.
9 years ago
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
Happy new year too.
12 years ago
Vladimír Vondruš <mosra@centrum.cz>
Relicensing to MIT/Expat license, part 2: headers.
13 years ago
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.
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
*/
/** @file
Shotgun documentation updates. Fixed old references to Buffer::Usage, fixed parameter order in Image constructor, fixed some function references. Added explicit references to linkable stuff.
13 years ago
* @brief Function @ref Magnum::MeshTools::compressIndices()
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
*/
De-inlined MeshTools::CompressIndices. The class doesn't export anything templated in its API, so it's a waste to have everything in the header.
14 years ago
#include <tuple>
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
Making includes absolute, part 5: absolute includes everywhere. The only places where they aren't absolute are: - when header is included from corresponding source file - when including headers which are not part of final installation (e.g. test-specific configuration, headers from Implementation/)
13 years ago
#include "Magnum/Mesh.h"
Making includes absolute, part 6: better filenames for internal files. As we are now using absolute includes, there is no need to prefix everything with "magnum<Namespace>" etc. All generated configuration files are renamed to configure.h and their path is included _before_ everything else to avoid accidental collisions.
13 years ago
#include "Magnum/MeshTools/visibility.h"
De-inlined MeshTools::CompressIndices. The class doesn't export anything templated in its API, so it's a waste to have everything in the header.
14 years ago
Doc++, minor cleanup.
14 years ago
namespace Magnum { namespace MeshTools {
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
/**
@brief Compress vertex indices
@param indices Index array
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
@return Index range, type and compressed index array
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
This function takes index array and outputs them compressed to smallest
possible size. For example when your indices have maximum number 463, it's
Using fixed-size 32bit integer type for indices.
14 years ago
wasteful to store them in array of 32bit integers, array of 16bit integers is
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
sufficient.
Example usage:
MeshTools: updates for the new documentation theme.
9 years ago
@code{.cpp}
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
std::vector<UnsignedInt> indices;
Containers::Array<char> indexData;
Removing IndexedMesh, part 5: merged documentation, removed IndexedMesh.
13 years ago
Mesh::IndexType indexType;
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
UnsignedInt indexStart, indexEnd;
std::tie(indexData, indexType, indexStart, indexEnd) = MeshTools::compressIndices(indices);
Buffer indexBuffer;
indexBuffer.setData(indexData, BufferUsage::StaticDraw);
Hiding MeshTools implementation classes from user altogether. All classes moved to MeshTools::Implementation namespace and removed from Doxygen output. They now all return tuples instead of custom structures. Updated and improved documentation, removed references to implementation classes.
14 years ago
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
Mesh mesh;
mesh.setCount(indices.size())
.setIndexBuffer(indexBuffer, 0, indexType, indexStart, indexEnd);
@endcode
MeshTools: added compressIndicesAs(). Much more convenient and "good enough" alternative to compressIndices().
11 years ago
@see @ref compressIndicesAs()
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
@todo Extract IndexType out of Mesh class
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
*/
MeshTools: deprecate mesh/buffer-modifying vertex/index tools. The point of this change is to allow greater flexibility and reduce confusion. When instanced meshes are implemented, MeshTools::interleave() can be used for creating interleaved buffers with per-instance data and then the call to Mesh::setCount() will be harmful and/or confusing, becuase the user would in fact want to call Mesh::setInstanceCount() instead. Similarly, MeshTools::compressIndices() can be used to create index buffer for more than one mesh. GL 4.4 has ARB_buffer_storage, which (in relatively distant future) will mean that the current way of Buffer::setData() will be deprecated in favor of Buffer::setStorage(), similarly as Texture::setStorage() replaced Texture::setImage(). Thus any function which calls Buffer::setData() internally is not future-proof. The old MeshTools::compressIndices() and MeshTools::interleave() overloads are marked as deprecated and will be removed in future release.
12 years ago
std::tuple<Containers::Array<char>, Mesh::IndexType, UnsignedInt, UnsignedInt> MAGNUM_MESHTOOLS_EXPORT compressIndices(const std::vector<UnsignedInt>& indices);
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
MeshTools: added compressIndicesAs(). Much more convenient and "good enough" alternative to compressIndices().
11 years ago
/**
@brief Compress vertex indices as given type
The type can be either @ref Magnum::UnsignedByte "UnsignedByte",
@ref Magnum::UnsignedShort "UnsignedShort" or @ref Magnum::UnsignedInt "UnsignedInt".
Values in the index array are expected to be representable with given type.
Example usage:
MeshTools: updates for the new documentation theme.
9 years ago
@code{.cpp}
MeshTools: added compressIndicesAs(). Much more convenient and "good enough" alternative to compressIndices().
11 years ago
std::vector<UnsignedInt> indices;
Containers::Array<UnsignedShort> indexData = MeshTools::compressIndicesAs<UnsignedShort>(indices);
@endcode
@see @ref compressIndices()
*/
template<class T> MAGNUM_MESHTOOLS_EXPORT Containers::Array<T> compressIndicesAs(const std::vector<UnsignedInt>& indices);
MeshTools: fix linker errors on Windows.
11 years ago
#if defined(CORRADE_TARGET_WINDOWS) && !defined(__MINGW32__)
extern template MAGNUM_MESHTOOLS_EXPORT Containers::Array<UnsignedByte> compressIndicesAs<UnsignedByte>(const std::vector<UnsignedInt>& indices);
extern template MAGNUM_MESHTOOLS_EXPORT Containers::Array<UnsignedShort> compressIndicesAs<UnsignedShort>(const std::vector<UnsignedInt>& indices);
extern template MAGNUM_MESHTOOLS_EXPORT Containers::Array<UnsignedInt> compressIndicesAs<UnsignedInt>(const std::vector<UnsignedInt>& indices);
#endif
MeshTools: tool for compressing index array. The same functionality which is buried inside MeshBuilder, but properly tested and more usable.
14 years ago
}}
#endif