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.
85 lines
3.6 KiB
85 lines
3.6 KiB
#ifndef Magnum_TextureTools_Atlas_h |
|
#define Magnum_TextureTools_Atlas_h |
|
/* |
|
This file is part of Magnum. |
|
|
|
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, |
|
2020, 2021, 2022, 2023 Vladimír Vondruš <mosra@centrum.cz> |
|
|
|
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::TextureTools::atlas(), @ref Magnum::TextureTools::atlasArrayPowerOfTwo() |
|
*/ |
|
|
|
#include <Corrade/Utility/StlForwardVector.h> |
|
|
|
#include "Magnum/Magnum.h" |
|
#include "Magnum/Math/Vector2.h" |
|
#include "Magnum/TextureTools/visibility.h" |
|
|
|
namespace Magnum { namespace TextureTools { |
|
|
|
/** |
|
@brief Pack textures into texture atlas |
|
@param atlasSize Size of resulting atlas |
|
@param sizes Sizes of all textures in the atlas |
|
@param padding Padding around each texture |
|
|
|
Packs many small textures into one larger. If the textures cannot be packed |
|
into required size, empty vector is returned. |
|
|
|
Padding is added twice to each size and the atlas is laid out so the padding |
|
don't overlap. Returned sizes are the same as original sizes, i.e. without the |
|
padding. |
|
*/ |
|
std::vector<Range2Di> MAGNUM_TEXTURETOOLS_EXPORT atlas(const Vector2i& atlasSize, const std::vector<Vector2i>& sizes, const Vector2i& padding = Vector2i()); |
|
|
|
/** |
|
@brief Pack square power-of-two textures into a texture atlas array |
|
@param layerSize Size of the texture layer |
|
@param sizes Sizes of all textures in the atlas |
|
@return Total layer count and offsets of all textures in the atlas, with the Z |
|
coordinate being the layer index |
|
@m_since_latest |
|
|
|
Both @p layerSize and all items in @p sizes are expected to be non-zero, square |
|
and power-of-two. With such constraints the packing is optimal with no wasted |
|
space in all but the last layer. Setting @p layerSize to the size of the |
|
largest texture in the set will lead to the least wasted space in the last |
|
layer. |
|
|
|
The algorithm first sorts the textures by size using @ref std::stable_sort(), |
|
which is usually @f$ \mathcal{O}(n \log{} n) @f$, and then performs the actual |
|
atlasing in a single @f$ \mathcal{O}(n) @f$ operation. Due to the sort |
|
involved, a temporary allocation holds the sorted array and additionally |
|
@ref std::stable_sort() performs its own allocation. |
|
*/ |
|
Containers::Pair<Int, Containers::Array<Vector3i>> MAGNUM_TEXTURETOOLS_EXPORT atlasArrayPowerOfTwo(const Vector2i& layerSize, Containers::StridedArrayView1D<const Vector2i> sizes); |
|
|
|
/** |
|
* @overload |
|
* @m_since_latest |
|
*/ |
|
Containers::Pair<Int, Containers::Array<Vector3i>> MAGNUM_TEXTURETOOLS_EXPORT atlasArrayPowerOfTwo(const Vector2i& layerSize, std::initializer_list<Vector2i> sizes); |
|
|
|
}} |
|
|
|
#endif
|
|
|