1.0.2 API documentation: packing.hpp Source File

| 1.0.2 API documentation

gtc/packing.hpp
Go to the documentation of this file.
1
14 #pragma once
15
16 // Dependency:
17 #include "type_precision.hpp"
18 #include "../ext/vector_packing.hpp"
19
20 #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
21 # pragma message("GLM: GLM_GTC_packing extension included")
22 #endif
23
24 namespace glm
25 {
28
40 GLM_FUNC_DECL uint8 packUnorm1x8(float v);
41
52 GLM_FUNC_DECL float unpackUnorm1x8(uint8 p);
53
68 GLM_FUNC_DECL uint16 packUnorm2x8(vec2 const& v);
69
84 GLM_FUNC_DECL vec2 unpackUnorm2x8(uint16 p);
85
97 GLM_FUNC_DECL uint8 packSnorm1x8(float s);
98
110 GLM_FUNC_DECL float unpackSnorm1x8(uint8 p);
111
126 GLM_FUNC_DECL uint16 packSnorm2x8(vec2 const& v);
127
142 GLM_FUNC_DECL vec2 unpackSnorm2x8(uint16 p);
143
155 GLM_FUNC_DECL uint16 packUnorm1x16(float v);
156
168 GLM_FUNC_DECL float unpackUnorm1x16(uint16 p);
169
184 GLM_FUNC_DECL uint64 packUnorm4x16(vec4 const& v);
185
200 GLM_FUNC_DECL vec4 unpackUnorm4x16(uint64 p);
201
213 GLM_FUNC_DECL uint16 packSnorm1x16(float v);
214
226 GLM_FUNC_DECL float unpackSnorm1x16(uint16 p);
227
242 GLM_FUNC_DECL uint64 packSnorm4x16(vec4 const& v);
243
258 GLM_FUNC_DECL vec4 unpackSnorm4x16(uint64 p);
259
269 GLM_FUNC_DECL uint16 packHalf1x16(float v);
270
280 GLM_FUNC_DECL float unpackHalf1x16(uint16 v);
281
293 GLM_FUNC_DECL uint64 packHalf4x16(vec4 const& v);
294
306 GLM_FUNC_DECL vec4 unpackHalf4x16(uint64 p);
307
319 GLM_FUNC_DECL uint32 packI3x10_1x2(ivec4 const& v);
320
330 GLM_FUNC_DECL ivec4 unpackI3x10_1x2(uint32 p);
331
343 GLM_FUNC_DECL uint32 packU3x10_1x2(uvec4 const& v);
344
354 GLM_FUNC_DECL uvec4 unpackU3x10_1x2(uint32 p);
355
372 GLM_FUNC_DECL uint32 packSnorm3x10_1x2(vec4 const& v);
373
389 GLM_FUNC_DECL vec4 unpackSnorm3x10_1x2(uint32 p);
390
407 GLM_FUNC_DECL uint32 packUnorm3x10_1x2(vec4 const& v);
408
424 GLM_FUNC_DECL vec4 unpackUnorm3x10_1x2(uint32 p);
425
435 GLM_FUNC_DECL uint32 packF2x11_1x10(vec3 const& v);
436
445 GLM_FUNC_DECL vec3 unpackF2x11_1x10(uint32 p);
446
447
459 GLM_FUNC_DECL uint32 packF3x9_E1x5(vec3 const& v);
460
471 GLM_FUNC_DECL vec3 unpackF3x9_E1x5(uint32 p);
472
481 template<length_t L, typename T, qualifier Q>
482 GLM_FUNC_DECL vec<4, T, Q> packRGBM(vec<3, T, Q> const& rgb);
483
491 template<length_t L, typename T, qualifier Q>
492 GLM_FUNC_DECL vec<3, T, Q> unpackRGBM(vec<4, T, Q> const& rgbm);
493
502 template<length_t L, qualifier Q>
503 GLM_FUNC_DECL vec<L, uint16, Q> packHalf(vec<L, float, Q> const& v);
504
512 template<length_t L, qualifier Q>
513 GLM_FUNC_DECL vec<L, float, Q> unpackHalf(vec<L, uint16, Q> const& p);
514
519 template<typename uintType, length_t L, typename floatType, qualifier Q>
520 GLM_FUNC_DECL vec<L, uintType, Q> packUnorm(vec<L, floatType, Q> const& v);
521
526 template<typename floatType, length_t L, typename uintType, qualifier Q>
527 GLM_FUNC_DECL vec<L, floatType, Q> unpackUnorm(vec<L, uintType, Q> const& v);
528
533 template<typename intType, length_t L, typename floatType, qualifier Q>
534 GLM_FUNC_DECL vec<L, intType, Q> packSnorm(vec<L, floatType, Q> const& v);
535
540 template<typename floatType, length_t L, typename intType, qualifier Q>
541 GLM_FUNC_DECL vec<L, floatType, Q> unpackSnorm(vec<L, intType, Q> const& v);
542
547 GLM_FUNC_DECL uint8 packUnorm2x4(vec2 const& v);
548
553 GLM_FUNC_DECL vec2 unpackUnorm2x4(uint8 p);
554
559 GLM_FUNC_DECL uint16 packUnorm4x4(vec4 const& v);
560
565 GLM_FUNC_DECL vec4 unpackUnorm4x4(uint16 p);
566
571 GLM_FUNC_DECL uint16 packUnorm1x5_1x6_1x5(vec3 const& v);
572
577 GLM_FUNC_DECL vec3 unpackUnorm1x5_1x6_1x5(uint16 p);
578
583 GLM_FUNC_DECL uint16 packUnorm3x5_1x1(vec4 const& v);
584
589 GLM_FUNC_DECL vec4 unpackUnorm3x5_1x1(uint16 p);
590
595 GLM_FUNC_DECL uint8 packUnorm2x3_1x2(vec3 const& v);
596
601 GLM_FUNC_DECL vec3 unpackUnorm2x3_1x2(uint8 p);
602
603
604
609 GLM_FUNC_DECL int16 packInt2x8(i8vec2 const& v);
610
615 GLM_FUNC_DECL i8vec2 unpackInt2x8(int16 p);
616
621 GLM_FUNC_DECL uint16 packUint2x8(u8vec2 const& v);
622
627 GLM_FUNC_DECL u8vec2 unpackUint2x8(uint16 p);
628
633 GLM_FUNC_DECL int32 packInt4x8(i8vec4 const& v);
634
639 GLM_FUNC_DECL i8vec4 unpackInt4x8(int32 p);
640
645 GLM_FUNC_DECL uint32 packUint4x8(u8vec4 const& v);
646
651 GLM_FUNC_DECL u8vec4 unpackUint4x8(uint32 p);
652
657 GLM_FUNC_DECL int packInt2x16(i16vec2 const& v);
658
663 GLM_FUNC_DECL i16vec2 unpackInt2x16(int p);
664
669 GLM_FUNC_DECL int64 packInt4x16(i16vec4 const& v);
670
675 GLM_FUNC_DECL i16vec4 unpackInt4x16(int64 p);
676
681 GLM_FUNC_DECL uint packUint2x16(u16vec2 const& v);
682
687 GLM_FUNC_DECL u16vec2 unpackUint2x16(uint p);
688
693 GLM_FUNC_DECL uint64 packUint4x16(u16vec4 const& v);
694
699 GLM_FUNC_DECL u16vec4 unpackUint4x16(uint64 p);
700
705 GLM_FUNC_DECL int64 packInt2x32(i32vec2 const& v);
706
711 GLM_FUNC_DECL i32vec2 unpackInt2x32(int64 p);
712
717 GLM_FUNC_DECL uint64 packUint2x32(u32vec2 const& v);
718
723 GLM_FUNC_DECL u32vec2 unpackUint2x32(uint64 p);
724
726 }// namespace glm
727
728 #include "packing.inl"
glm::i16vec2
vec< 2, int16, defaultp > i16vec2
16 bit signed integer vector of 2 components type.
Definition: vector_int2_sized.hpp:36
glm::unpackInt2x32
GLM_FUNC_DECL i32vec2 unpackInt2x32(int64 p)
Convert a packed integer into an integer vector.
glm::uint32
detail::uint32 uint32
32 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:64
glm::unpackInt4x8
GLM_FUNC_DECL i8vec4 unpackInt4x8(int32 p)
Convert a packed integer into an integer vector.
glm::packRGBM
GLM_FUNC_DECL vec< 4, T, Q > packRGBM(vec< 3, T, Q > const &rgb)
Returns an unsigned integer vector obtained by converting the components of a floating-point vector t...
glm::packUnorm3x5_1x1
GLM_FUNC_DECL uint16 packUnorm3x5_1x1(vec4 const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::unpackUint2x8
GLM_FUNC_DECL u8vec2 unpackUint2x8(uint16 p)
Convert a packed integer into an integer vector.
glm::packI3x10_1x2
GLM_FUNC_DECL uint32 packI3x10_1x2(ivec4 const &v)
Returns an unsigned integer obtained by converting the components of a four-component signed integer ...
glm::ivec4
vec< 4, int, defaultp > ivec4
4 components vector of signed integer numbers.
Definition: vector_int4.hpp:15
glm::packUnorm3x10_1x2
GLM_FUNC_DECL uint32 packUnorm3x10_1x2(vec4 const &v)
First, converts the first three components of the normalized floating-point value v into 10-bit unsig...
glm::unpackSnorm
GLM_FUNC_DECL vec< L, floatType, Q > unpackSnorm(vec< L, intType, Q > const &v)
Convert a packed integer to a normalized floating-point vector.
glm::u16vec2
vec< 2, uint16, defaultp > u16vec2
16 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_sized.hpp:36
glm::u8vec4
vec< 4, uint8, defaultp > u8vec4
8 bit unsigned integer vector of 4 components type.
Definition: vector_uint4_sized.hpp:31
glm::packU3x10_1x2
GLM_FUNC_DECL uint32 packU3x10_1x2(uvec4 const &v)
Returns an unsigned integer obtained by converting the components of a four-component unsigned intege...
glm::unpackF2x11_1x10
GLM_FUNC_DECL vec3 unpackF2x11_1x10(uint32 p)
First, unpacks a single 32-bit unsigned integer p into two 11-bit signless floating-point values and ...
glm::unpackInt2x16
GLM_FUNC_DECL i16vec2 unpackInt2x16(int p)
Convert a packed integer into an integer vector.
glm::unpackUnorm1x8
GLM_FUNC_DECL float unpackUnorm1x8(uint8 p)
Convert a single 8-bit integer to a normalized floating-point value.
glm::unpackHalf
GLM_FUNC_DECL vec< L, float, Q > unpackHalf(vec< L, uint16, Q > const &p)
Returns a floating-point vector with components obtained by reinterpreting an integer vector as 16-bi...
glm::i32vec2
vec< 2, int32, defaultp > i32vec2
32 bit signed integer vector of 2 components type.
Definition: vector_int2_sized.hpp:41
glm::packUnorm1x8
GLM_FUNC_DECL uint8 packUnorm1x8(float v)
First, converts the normalized floating-point value v into a 8-bit integer value.
glm::unpackUnorm3x5_1x1
GLM_FUNC_DECL vec4 unpackUnorm3x5_1x1(uint16 p)
Convert a packed integer to a normalized floating-point vector.
glm::packF2x11_1x10
GLM_FUNC_DECL uint32 packF2x11_1x10(vec3 const &v)
First, converts the first two components of the normalized floating-point value v into 11-bit signles...
glm::packInt2x32
GLM_FUNC_DECL int64 packInt2x32(i32vec2 const &v)
Convert each component from an integer vector into a packed integer.
glm::unpackUint4x16
GLM_FUNC_DECL u16vec4 unpackUint4x16(uint64 p)
Convert a packed integer into an integer vector.
glm::int16
detail::int16 int16
16 bit signed integer type.
Definition: scalar_int_sized.hpp:61
glm::unpackSnorm1x8
GLM_FUNC_DECL float unpackSnorm1x8(uint8 p)
First, unpacks a single 8-bit unsigned integer p into a single 8-bit signed integers.
glm::uint64
detail::uint64 uint64
64 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:67
glm::unpackHalf4x16
GLM_FUNC_DECL vec4 unpackHalf4x16(uint64 p)
Returns a four-component floating-point vector with components obtained by unpacking a 64-bit unsigne...
glm::unpackUnorm2x4
GLM_FUNC_DECL vec2 unpackUnorm2x4(uint8 p)
Convert a packed integer to a normalized floating-point vector.
glm::i8vec2
vec< 2, int8, defaultp > i8vec2
8 bit signed integer vector of 2 components type.
Definition: vector_int2_sized.hpp:31
glm::vec2
vec< 2, float, defaultp > vec2
2 components vector of single-precision floating-point numbers.
Definition: vector_float2.hpp:15
type_precision.hpp
GLM_GTC_type_precision
glm::unpackUnorm3x10_1x2
GLM_FUNC_DECL vec4 unpackUnorm3x10_1x2(uint32 p)
First, unpacks a single 32-bit unsigned integer p into four 16-bit signed integers.
glm::unpackSnorm2x8
GLM_FUNC_DECL vec2 unpackSnorm2x8(uint16 p)
First, unpacks a single 16-bit unsigned integer p into a pair of 8-bit signed integers.
glm::packUnorm2x4
GLM_FUNC_DECL uint8 packUnorm2x4(vec2 const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::uvec4
vec< 4, unsigned int, defaultp > uvec4
4 components vector of unsigned integer numbers.
Definition: vector_uint4.hpp:15
glm::packUnorm1x5_1x6_1x5
GLM_FUNC_DECL uint16 packUnorm1x5_1x6_1x5(vec3 const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::packHalf
GLM_FUNC_DECL vec< L, uint16, Q > packHalf(vec< L, float, Q > const &v)
Returns an unsigned integer vector obtained by converting the components of a floating-point vector t...
glm::unpackUnorm1x16
GLM_FUNC_DECL float unpackUnorm1x16(uint16 p)
First, unpacks a single 16-bit unsigned integer p into a of 16-bit unsigned integers.
glm::packInt2x8
GLM_FUNC_DECL int16 packInt2x8(i8vec2 const &v)
Convert each component from an integer vector into a packed integer.
glm::unpackUnorm4x16
GLM_FUNC_DECL vec4 unpackUnorm4x16(uint64 p)
First, unpacks a single 64-bit unsigned integer p into four 16-bit unsigned integers.
glm::i16vec4
vec< 4, int16, defaultp > i16vec4
16 bit signed integer vector of 4 components type.
Definition: vector_int4_sized.hpp:36
glm::packUnorm4x16
GLM_FUNC_DECL uint64 packUnorm4x16(vec4 const &v)
First, converts each component of the normalized floating-point value v into 16-bit integer values.
glm::uint8
detail::uint8 uint8
8 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:58
glm::packUint2x32
GLM_FUNC_DECL uint64 packUint2x32(u32vec2 const &v)
Convert each component from an integer vector into a packed unsigned integer.
glm::unpackUnorm4x4
GLM_FUNC_DECL vec4 unpackUnorm4x4(uint16 p)
Convert a packed integer to a normalized floating-point vector.
glm::u16vec4
vec< 4, uint16, defaultp > u16vec4
16 bit unsigned integer vector of 4 components type.
Definition: vector_uint4_sized.hpp:36
glm::packSnorm
GLM_FUNC_DECL vec< L, intType, Q > packSnorm(vec< L, floatType, Q > const &v)
Convert each component of the normalized floating-point vector into signed integer values.
glm::unpackSnorm3x10_1x2
GLM_FUNC_DECL vec4 unpackSnorm3x10_1x2(uint32 p)
First, unpacks a single 32-bit unsigned integer p into four 16-bit signed integers.
glm::packF3x9_E1x5
GLM_FUNC_DECL uint32 packF3x9_E1x5(vec3 const &v)
First, converts the first two components of the normalized floating-point value v into 11-bit signles...
glm::unpackUint2x16
GLM_FUNC_DECL u16vec2 unpackUint2x16(uint p)
Convert a packed integer into an integer vector.
glm::unpackSnorm1x16
GLM_FUNC_DECL float unpackSnorm1x16(uint16 p)
First, unpacks a single 16-bit unsigned integer p into a single 16-bit signed integers.
glm::unpackUnorm
GLM_FUNC_DECL vec< L, floatType, Q > unpackUnorm(vec< L, uintType, Q > const &v)
Convert a packed integer to a normalized floating-point vector.
glm::packUnorm
GLM_FUNC_DECL vec< L, uintType, Q > packUnorm(vec< L, floatType, Q > const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::packInt2x16
GLM_FUNC_DECL int packInt2x16(i16vec2 const &v)
Convert each component from an integer vector into a packed integer.
glm::packUint4x16
GLM_FUNC_DECL uint64 packUint4x16(u16vec4 const &v)
Convert each component from an integer vector into a packed unsigned integer.
glm::packUnorm2x3_1x2
GLM_FUNC_DECL uint8 packUnorm2x3_1x2(vec3 const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::unpackUnorm2x3_1x2
GLM_FUNC_DECL vec3 unpackUnorm2x3_1x2(uint8 p)
Convert a packed integer to a normalized floating-point vector.
glm::packHalf1x16
GLM_FUNC_DECL uint16 packHalf1x16(float v)
Returns an unsigned integer obtained by converting the components of a floating-point scalar to the 1...
glm::unpackInt4x16
GLM_FUNC_DECL i16vec4 unpackInt4x16(int64 p)
Convert a packed integer into an integer vector.
glm::packUnorm4x4
GLM_FUNC_DECL uint16 packUnorm4x4(vec4 const &v)
Convert each component of the normalized floating-point vector into unsigned integer values.
glm::packSnorm1x16
GLM_FUNC_DECL uint16 packSnorm1x16(float v)
First, converts the normalized floating-point value v into 16-bit integer value.
glm::unpackUint4x8
GLM_FUNC_DECL u8vec4 unpackUint4x8(uint32 p)
Convert a packed integer into an integer vector.
glm::packSnorm3x10_1x2
GLM_FUNC_DECL uint32 packSnorm3x10_1x2(vec4 const &v)
First, converts the first three components of the normalized floating-point value v into 10-bit signe...
glm::unpackUint2x32
GLM_FUNC_DECL u32vec2 unpackUint2x32(uint64 p)
Convert a packed integer into an integer vector.
glm::vec3
vec< 3, float, defaultp > vec3
3 components vector of single-precision floating-point numbers.
Definition: vector_float3.hpp:15
glm::packUint2x8
GLM_FUNC_DECL uint16 packUint2x8(u8vec2 const &v)
Convert each component from an integer vector into a packed unsigned integer.
glm::packInt4x16
GLM_FUNC_DECL int64 packInt4x16(i16vec4 const &v)
Convert each component from an integer vector into a packed integer.
glm::vec4
vec< 4, float, defaultp > vec4
4 components vector of single-precision floating-point numbers.
Definition: vector_float4.hpp:15
glm::unpackRGBM
GLM_FUNC_DECL vec< 3, T, Q > unpackRGBM(vec< 4, T, Q > const &rgbm)
Returns a floating-point vector with components obtained by reinterpreting an integer vector as 16-bi...
glm::unpackUnorm1x5_1x6_1x5
GLM_FUNC_DECL vec3 unpackUnorm1x5_1x6_1x5(uint16 p)
Convert a packed integer to a normalized floating-point vector.
glm::unpackU3x10_1x2
GLM_FUNC_DECL uvec4 unpackU3x10_1x2(uint32 p)
Unpacks a single 32-bit unsigned integer p into three 10-bit and one 2-bit unsigned integers.
glm::u32vec2
vec< 2, uint32, defaultp > u32vec2
32 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_sized.hpp:41
glm::packUnorm2x8
GLM_FUNC_DECL uint16 packUnorm2x8(vec2 const &v)
First, converts each component of the normalized floating-point value v into 8-bit integer values.
glm::u8vec2
vec< 2, uint8, defaultp > u8vec2
8 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_sized.hpp:31
glm::unpackI3x10_1x2
GLM_FUNC_DECL ivec4 unpackI3x10_1x2(uint32 p)
Unpacks a single 32-bit unsigned integer p into three 10-bit and one 2-bit signed integers.
glm::packInt4x8
GLM_FUNC_DECL int32 packInt4x8(i8vec4 const &v)
Convert each component from an integer vector into a packed integer.
glm::unpackHalf1x16
GLM_FUNC_DECL float unpackHalf1x16(uint16 v)
Returns a floating-point scalar with components obtained by unpacking a 16-bit unsigned integer into ...
glm::packUint2x16
GLM_FUNC_DECL uint packUint2x16(u16vec2 const &v)
Convert each component from an integer vector into a packed unsigned integer.
glm::packHalf4x16
GLM_FUNC_DECL uint64 packHalf4x16(vec4 const &v)
Returns an unsigned integer obtained by converting the components of a four-component floating-point ...
glm::i8vec4
vec< 4, int8, defaultp > i8vec4
8 bit signed integer vector of 4 components type.
Definition: vector_int4_sized.hpp:31
glm::int64
detail::int64 int64
64 bit signed integer type.
Definition: scalar_int_sized.hpp:67
glm::uint16
detail::uint16 uint16
16 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:61
glm::packSnorm4x16
GLM_FUNC_DECL uint64 packSnorm4x16(vec4 const &v)
First, converts each component of the normalized floating-point value v into 16-bit integer values.
glm::packUint4x8
GLM_FUNC_DECL uint32 packUint4x8(u8vec4 const &v)
Convert each component from an integer vector into a packed unsigned integer.
glm::unpackInt2x8
GLM_FUNC_DECL i8vec2 unpackInt2x8(int16 p)
Convert a packed integer into an integer vector.
glm::packUnorm1x16
GLM_FUNC_DECL uint16 packUnorm1x16(float v)
First, converts the normalized floating-point value v into a 16-bit integer value.
glm::unpackUnorm2x8
GLM_FUNC_DECL vec2 unpackUnorm2x8(uint16 p)
First, unpacks a single 16-bit unsigned integer p into a pair of 8-bit unsigned integers.
glm::unpackF3x9_E1x5
GLM_FUNC_DECL vec3 unpackF3x9_E1x5(uint32 p)
First, unpacks a single 32-bit unsigned integer p into two 11-bit signless floating-point values and ...
glm::unpackSnorm4x16
GLM_FUNC_DECL vec4 unpackSnorm4x16(uint64 p)
First, unpacks a single 64-bit unsigned integer p into four 16-bit signed integers.
glm::packSnorm2x8
GLM_FUNC_DECL uint16 packSnorm2x8(vec2 const &v)
First, converts each component of the normalized floating-point value v into 8-bit integer values.
glm::int32
detail::int32 int32
32 bit signed integer type.
Definition: scalar_int_sized.hpp:64
glm::packSnorm1x8
GLM_FUNC_DECL uint8 packSnorm1x8(float s)
First, converts the normalized floating-point value v into 8-bit integer value.