mirror of https://github.com/mosra/magnum.git
Browse Source
To be more consistent with GLSL naming. Also, the original naming was
quite misleading, as normalize() is used in GLSL for something
completely different.
If building with deprecated APIs, the Functions.h header includes the
new Packing.h header and the {de,}normalize() functions are defined as
deprecated aliases to the new functions. This will be removed at some
point in the future.
pull/190/head
Vladimír Vondruš
9 years ago
11 changed files with 458 additions and 350 deletions
@ -0,0 +1,135 @@
|
||||
#ifndef Magnum_Math_Packing_h |
||||
#define Magnum_Math_Packing_h |
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016 |
||||
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. |
||||
*/ |
||||
|
||||
#include <limits> |
||||
|
||||
#include "Magnum/Math/Functions.h" |
||||
|
||||
namespace Magnum { namespace Math { |
||||
|
||||
/**
|
||||
@brief Unpack integral value into a floating-point representation |
||||
|
||||
Converts integral value from full range of given *unsigned* integral type to |
||||
value in range @f$ [0, 1] @f$ or from *signed* integral to range @f$ [-1, 1] @f$. |
||||
|
||||
@note For best precision, resulting `FloatingPoint` type should be always |
||||
larger that `Integral` type (e.g. @ref Magnum::Float "Float" from |
||||
@ref Magnum::Short "Short", @ref Magnum::Double "Double" from |
||||
@ref Magnum::Int "Int" and similarly for vector types). |
||||
|
||||
@attention To ensure the integral type is correctly detected when using |
||||
literals, this function should be called with both template parameters |
||||
explicit, e.g.: |
||||
@code |
||||
// Literal type is (signed) char, but we assumed unsigned char, a != 1.0f
|
||||
Float a = Math::unpack<Float>('\xFF'); |
||||
|
||||
// b = 1.0f
|
||||
Float b = Math::unpack<Float, UnsignedByte>('\xFF'); |
||||
@endcode |
||||
|
||||
@see @ref pack() |
||||
*/ |
||||
#ifdef DOXYGEN_GENERATING_OUTPUT |
||||
template<class FloatingPoint, class Integral> inline FloatingPoint unpack(const Integral& value); |
||||
#else |
||||
template<class FloatingPoint, class Integral> inline typename std::enable_if<std::is_arithmetic<Integral>::value && std::is_unsigned<Integral>::value, FloatingPoint>::type unpack(Integral value) { |
||||
static_assert(std::is_floating_point<FloatingPoint>::value && std::is_integral<Integral>::value, |
||||
"unpacking must be done from integral to floating-point type"); |
||||
return value/FloatingPoint(std::numeric_limits<Integral>::max()); |
||||
} |
||||
template<class FloatingPoint, class Integral> inline typename std::enable_if<std::is_arithmetic<Integral>::value && std::is_signed<Integral>::value, FloatingPoint>::type unpack(Integral value) { |
||||
static_assert(std::is_floating_point<FloatingPoint>::value && std::is_integral<Integral>::value, |
||||
"unpacking must be done from integral to floating-point type"); |
||||
return Math::max(value/FloatingPoint(std::numeric_limits<Integral>::max()), FloatingPoint(-1.0)); |
||||
} |
||||
template<class FloatingPoint, class Integral> inline typename std::enable_if<std::is_unsigned<typename Integral::Type>::value, FloatingPoint>::type unpack(const Integral& value) { |
||||
static_assert(std::is_floating_point<typename FloatingPoint::Type>::value && std::is_integral<typename Integral::Type>::value, |
||||
"unpacking must be done from integral to floating-point type"); |
||||
return FloatingPoint(value)/typename FloatingPoint::Type(std::numeric_limits<typename Integral::Type>::max()); |
||||
} |
||||
template<class FloatingPoint, class Integral> inline typename std::enable_if<std::is_signed<typename Integral::Type>::value, FloatingPoint>::type unpack(const Integral& value) { |
||||
static_assert(std::is_floating_point<typename FloatingPoint::Type>::value && std::is_integral<typename Integral::Type>::value, |
||||
"unpacking must be done from integral to floating-point type"); |
||||
return Math::max(FloatingPoint(value)/typename FloatingPoint::Type(std::numeric_limits<typename Integral::Type>::max()), FloatingPoint(-1.0)); |
||||
} |
||||
#endif |
||||
|
||||
#ifdef MAGNUM_BUILD_DEPRECATED |
||||
/** @copybrief unpack()
|
||||
* @deprecated Use @ref unpack() instead. |
||||
*/ |
||||
template<class FloatingPoint, class Integral> CORRADE_DEPRECATED("use unpack() instead") inline FloatingPoint normalize(const Integral& value) { |
||||
return unpack<FloatingPoint, Integral>(value); |
||||
} |
||||
#endif |
||||
|
||||
/**
|
||||
@brief Pack floating-point value into an integer representation |
||||
|
||||
Converts floating-point value in range @f$ [0, 1] @f$ to full range of given |
||||
*unsigned* integral type or range @f$ [-1, 1] @f$ to full range of given *signed* |
||||
integral type. |
||||
|
||||
@note For best precision, `FloatingPoint` type should be always larger that |
||||
resulting `Integral` type (e.g. @ref Magnum::Float "Float" to |
||||
@ref Magnum::Short "Short", @ref Magnum::Double "Double" to @ref Magnum::Int "Int" |
||||
and similarly for vector types). |
||||
|
||||
@attention Return value for floating point numbers outside the normalized |
||||
range is undefined. |
||||
|
||||
@see @ref unpack() |
||||
*/ |
||||
#ifdef DOXYGEN_GENERATING_OUTPUT |
||||
template<class Integral, class FloatingPoint> inline Integral pack(const FloatingPoint& value); |
||||
#else |
||||
template<class Integral, class FloatingPoint> inline typename std::enable_if<std::is_arithmetic<FloatingPoint>::value, Integral>::type pack(FloatingPoint value) { |
||||
static_assert(std::is_floating_point<FloatingPoint>::value && std::is_integral<Integral>::value, |
||||
"packing must be done from floating-point to integral type"); |
||||
return Integral(value*std::numeric_limits<Integral>::max()); |
||||
} |
||||
template<class Integral, class FloatingPoint> inline typename std::enable_if<std::is_arithmetic<typename Integral::Type>::value, Integral>::type pack(const FloatingPoint& value) { |
||||
static_assert(std::is_floating_point<typename FloatingPoint::Type>::value && std::is_integral<typename Integral::Type>::value, |
||||
"packing must be done from floating-point to integral type"); |
||||
return Integral(value*std::numeric_limits<typename Integral::Type>::max()); |
||||
} |
||||
#endif |
||||
|
||||
#ifdef MAGNUM_BUILD_DEPRECATED |
||||
/** @copybrief pack()
|
||||
* @deprecated Use @ref pack() instead. |
||||
*/ |
||||
template<class Integral, class FloatingPoint> CORRADE_DEPRECATED("use pack() instead") inline Integral denormalize(const FloatingPoint& value) { |
||||
return pack<Integral, FloatingPoint>(value); |
||||
} |
||||
#endif |
||||
|
||||
}} |
||||
|
||||
#endif |
||||
@ -0,0 +1,226 @@
|
||||
/*
|
||||
This file is part of Magnum. |
||||
|
||||
Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016 |
||||
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. |
||||
*/ |
||||
|
||||
#include <Corrade/TestSuite/Tester.h> |
||||
|
||||
#include "Magnum/Math/Packing.h" |
||||
#include "Magnum/Math/Vector3.h" |
||||
|
||||
namespace Magnum { namespace Math { namespace Test { |
||||
|
||||
struct PackingTest: Corrade::TestSuite::Tester { |
||||
explicit PackingTest(); |
||||
|
||||
void unpackUnsigned(); |
||||
void unpackSigned(); |
||||
void packUnsigned(); |
||||
void packSigned(); |
||||
void reunpackUnsinged(); |
||||
void reunpackSinged(); |
||||
void unpackTypeDeduction(); |
||||
}; |
||||
|
||||
typedef Math::Vector3<Float> Vector3; |
||||
typedef Math::Vector3<UnsignedByte> Vector3ub; |
||||
typedef Math::Vector3<Byte> Vector3b; |
||||
|
||||
PackingTest::PackingTest() { |
||||
addTests({&PackingTest::unpackUnsigned, |
||||
&PackingTest::unpackSigned, |
||||
&PackingTest::packUnsigned, |
||||
&PackingTest::packSigned, |
||||
&PackingTest::reunpackUnsinged, |
||||
&PackingTest::reunpackSinged, |
||||
&PackingTest::unpackTypeDeduction}); |
||||
} |
||||
|
||||
void PackingTest::unpackUnsigned() { |
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedByte>(0)), 0.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedByte>(255)), 1.0f); |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Double, UnsignedInt>(0)), 0.0); |
||||
CORRADE_COMPARE((Math::unpack<Double, UnsignedInt>(std::numeric_limits<UnsignedInt>::max())), 1.0); |
||||
|
||||
#ifndef MAGNUM_TARGET_WEBGL |
||||
CORRADE_COMPARE((Math::unpack<long double, UnsignedLong>(0)), 0.0); |
||||
CORRADE_COMPARE((Math::unpack<long double, UnsignedLong>(std::numeric_limits<UnsignedLong>::max())), 1.0); |
||||
#endif |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(0)), 0.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(std::numeric_limits<UnsignedShort>::max())), 1.0f); |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(8192)), 0.125002f); |
||||
CORRADE_COMPARE((Math::unpack<Float, UnsignedShort>(49152)), 0.750011f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Vector3>(Vector3ub(0, 127, 255)), Vector3(0.0f, 0.498039f, 1.0f)); |
||||
} |
||||
|
||||
void PackingTest::unpackSigned() { |
||||
CORRADE_COMPARE((Math::unpack<Float, Byte>(127)), 1.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, Byte>(0)), 0.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, Byte>(-128)), -1.0f); |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Float, Short>(std::numeric_limits<Short>::min())), -1.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, Short>(0)), 0.0f); |
||||
CORRADE_COMPARE((Math::unpack<Float, Short>(std::numeric_limits<Short>::max())), 1.0f); |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Double, Int>(std::numeric_limits<Int>::min())), -1.0); |
||||
CORRADE_COMPARE((Math::unpack<Double, Int>(0)), 0.0); |
||||
CORRADE_COMPARE((Math::unpack<Double, Int>(std::numeric_limits<Int>::max())), 1.0); |
||||
|
||||
#ifndef MAGNUM_TARGET_WEBGL |
||||
CORRADE_COMPARE((Math::unpack<long double, Long>(std::numeric_limits<Long>::min())), -1.0); |
||||
CORRADE_COMPARE((Math::unpack<long double, Long>(0)), 0.0); |
||||
CORRADE_COMPARE((Math::unpack<long double, Long>(std::numeric_limits<Long>::max())), 1.0); |
||||
#endif |
||||
|
||||
CORRADE_COMPARE((Math::unpack<Float, Short>(16384)), 0.500015f); |
||||
CORRADE_COMPARE((Math::unpack<Float, Short>(-16384)), -0.500015f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Vector3>(Vector3b(0, -127, 64)), Vector3(0.0f, -1.0f, 0.503937f)); |
||||
} |
||||
|
||||
void PackingTest::packUnsigned() { |
||||
CORRADE_COMPARE(Math::pack<UnsignedByte>(0.0f), 0); |
||||
CORRADE_COMPARE(Math::pack<UnsignedByte>(1.0f), 255); |
||||
|
||||
CORRADE_COMPARE(Math::pack<UnsignedShort>(0.0f), 0); |
||||
CORRADE_COMPARE(Math::pack<UnsignedShort>(1.0f), std::numeric_limits<UnsignedShort>::max()); |
||||
|
||||
CORRADE_COMPARE(Math::pack<UnsignedInt>(0.0), 0); |
||||
CORRADE_COMPARE(Math::pack<UnsignedInt>(1.0), std::numeric_limits<UnsignedInt>::max()); |
||||
|
||||
#ifndef MAGNUM_TARGET_WEBGL |
||||
CORRADE_COMPARE(Math::pack<UnsignedLong>(0.0l), 0); |
||||
{ |
||||
#ifdef CORRADE_MSVC2015_COMPATIBILITY |
||||
CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015."); |
||||
#endif |
||||
CORRADE_COMPARE(Math::pack<UnsignedLong>(1.0l), std::numeric_limits<UnsignedLong>::max()); |
||||
} |
||||
#endif |
||||
|
||||
CORRADE_COMPARE(Math::pack<UnsignedShort>(0.33f), 21626); |
||||
CORRADE_COMPARE(Math::pack<UnsignedShort>(0.66f), 43253); |
||||
|
||||
CORRADE_COMPARE(Math::pack<Vector3ub>(Vector3(0.0f, 0.5f, 1.0f)), Vector3ub(0, 127, 255)); |
||||
} |
||||
|
||||
void PackingTest::packSigned() { |
||||
CORRADE_COMPARE(Math::pack<Byte>(-1.0f), -127); |
||||
CORRADE_COMPARE(Math::pack<Byte>(0.0f), 0); |
||||
CORRADE_COMPARE(Math::pack<Byte>(1.0f), 127); |
||||
|
||||
CORRADE_COMPARE(Math::pack<Short>(-1.0f), std::numeric_limits<Short>::min()+1); |
||||
CORRADE_COMPARE(Math::pack<Short>(0.0f), 0); |
||||
CORRADE_COMPARE(Math::pack<Short>(1.0f), std::numeric_limits<Short>::max()); |
||||
|
||||
#ifndef MAGNUM_TARGET_GLES |
||||
CORRADE_COMPARE(Math::pack<Int>(-1.0), std::numeric_limits<Int>::min()+1); |
||||
CORRADE_COMPARE(Math::pack<Int>(0.0), 0); |
||||
CORRADE_COMPARE(Math::pack<Int>(1.0), std::numeric_limits<Int>::max()); |
||||
|
||||
{ |
||||
#ifdef CORRADE_MSVC2015_COMPATIBILITY |
||||
CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015."); |
||||
#endif |
||||
CORRADE_COMPARE(Math::pack<Long>(-1.0l), std::numeric_limits<Long>::min()+1); |
||||
} |
||||
CORRADE_COMPARE(Math::pack<Long>(0.0l), 0); |
||||
{ |
||||
#ifdef CORRADE_MSVC2015_COMPATIBILITY |
||||
CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015."); |
||||
#endif |
||||
CORRADE_COMPARE(Math::pack<Long>(1.0l), std::numeric_limits<Long>::max()); |
||||
} |
||||
#endif |
||||
|
||||
CORRADE_COMPARE(Math::pack<Short>(-0.33f), -10813); |
||||
CORRADE_COMPARE(Math::pack<Short>(0.66f), 21626); |
||||
|
||||
CORRADE_COMPARE(Math::pack<Vector3b>(Vector3(0.0f, -1.0f, 0.5f)), Vector3b(0, -127, 63)); |
||||
} |
||||
|
||||
void PackingTest::reunpackUnsinged() { |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedByte>(0.0f)), 0.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedByte>(1.0f)), 1.0f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedShort>(0.0f)), 0.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<UnsignedShort>(1.0f)), 1.0f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Double>(Math::pack<UnsignedInt>(0.0)), 0.0); |
||||
CORRADE_COMPARE(Math::unpack<Double>(Math::pack<UnsignedInt>(1.0)), 1.0); |
||||
|
||||
#ifndef MAGNUM_TARGET_WEBGL |
||||
CORRADE_COMPARE(Math::unpack<long double>(Math::pack<UnsignedLong>(0.0l)), 0.0l); |
||||
{ |
||||
#ifdef CORRADE_MSVC2015_COMPATIBILITY |
||||
CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015."); |
||||
#endif |
||||
CORRADE_COMPARE(Math::unpack<long double>(Math::pack<UnsignedLong>(1.0l)), 1.0l); |
||||
} |
||||
#endif |
||||
} |
||||
|
||||
void PackingTest::reunpackSinged() { |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(-1.0f)), -1.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(0.0f)), 0.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Byte>(1.0f)), 1.0f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(-1.0f)), -1.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(0.0f)), 0.0f); |
||||
CORRADE_COMPARE(Math::unpack<Float>(Math::pack<Short>(1.0f)), 1.0f); |
||||
|
||||
CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(-1.0)), -1.0); |
||||
CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(0.0)), 0.0); |
||||
CORRADE_COMPARE(Math::unpack<Double>(Math::pack<Int>(1.0)), 1.0); |
||||
|
||||
#ifndef MAGNUM_TARGET_WEBGL |
||||
CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(-1.0l)), -1.0l); |
||||
CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(0.0l)), 0.0l); |
||||
{ |
||||
#ifdef CORRADE_MSVC2015_COMPATIBILITY |
||||
CORRADE_EXPECT_FAIL("Long double (de)normalization is broken on MSVC <= 2015."); |
||||
#endif |
||||
CORRADE_COMPARE(Math::unpack<long double>(Math::pack<Long>(1.0l)), 1.0l); |
||||
} |
||||
#endif |
||||
} |
||||
|
||||
void PackingTest::unpackTypeDeduction() { |
||||
if(std::is_signed<char>::value) |
||||
CORRADE_COMPARE(Math::unpack<Float>('\x7F'), 1.0f); |
||||
else { |
||||
/* Raspberry Pi `char` is unsigned (huh) */ |
||||
CORRADE_VERIFY(std::is_unsigned<char>::value); |
||||
CORRADE_COMPARE(Math::unpack<Float>('\x7F'), 0.498039f); |
||||
} |
||||
CORRADE_COMPARE((Math::unpack<Float, Byte>('\x7F')), 1.0f); |
||||
} |
||||
|
||||
}}} |
||||
|
||||
CORRADE_TEST_MAIN(Magnum::Math::Test::PackingTest) |
||||
|
||||
Loading…
Reference in new issue