| 1.0.2 API documentation

bitfield.hpp
Go to the documentation of this file.
1
14 #include "../detail/setup.hpp"
15
16 #pragma once
17
18 // Dependencies
19 #include "../ext/scalar_int_sized.hpp"
20 #include "../ext/scalar_uint_sized.hpp"
21 #include "../detail/qualifier.hpp"
22 #include "../detail/_vectorize.hpp"
23 #include "type_precision.hpp"
24 #include <limits>
25
26 #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
27 # pragma message("GLM: GLM_GTC_bitfield extension included")
28 #endif
29
30 namespace glm
31 {
34
38 template<typename genIUType>
39 GLM_FUNC_DECL genIUType mask(genIUType Bits);
40
48 template<length_t L, typename T, qualifier Q>
49 GLM_FUNC_DECL vec<L, T, Q> mask(vec<L, T, Q> const& v);
50
54 template<typename genIUType>
55 GLM_FUNC_DECL genIUType bitfieldRotateRight(genIUType In, int Shift);
56
64 template<length_t L, typename T, qualifier Q>
65 GLM_FUNC_DECL vec<L, T, Q> bitfieldRotateRight(vec<L, T, Q> const& In, int Shift);
66
70 template<typename genIUType>
71 GLM_FUNC_DECL genIUType bitfieldRotateLeft(genIUType In, int Shift);
72
80 template<length_t L, typename T, qualifier Q>
81 GLM_FUNC_DECL vec<L, T, Q> bitfieldRotateLeft(vec<L, T, Q> const& In, int Shift);
82
86 template<typename genIUType>
87 GLM_FUNC_DECL genIUType bitfieldFillOne(genIUType Value, int FirstBit, int BitCount);
88
96 template<length_t L, typename T, qualifier Q>
97 GLM_FUNC_DECL vec<L, T, Q> bitfieldFillOne(vec<L, T, Q> const& Value, int FirstBit, int BitCount);
98
102 template<typename genIUType>
103 GLM_FUNC_DECL genIUType bitfieldFillZero(genIUType Value, int FirstBit, int BitCount);
104
112 template<length_t L, typename T, qualifier Q>
113 GLM_FUNC_DECL vec<L, T, Q> bitfieldFillZero(vec<L, T, Q> const& Value, int FirstBit, int BitCount);
114
120 GLM_FUNC_DECL int16 bitfieldInterleave(int8 x, int8 y);
121
127 GLM_FUNC_DECL uint16 bitfieldInterleave(uint8 x, uint8 y);
128
134 GLM_FUNC_DECL uint16 bitfieldInterleave(u8vec2 const& v);
135
139 GLM_FUNC_DECL glm::u8vec2 bitfieldDeinterleave(glm::uint16 x);
140
146 GLM_FUNC_DECL int32 bitfieldInterleave(int16 x, int16 y);
147
153 GLM_FUNC_DECL uint32 bitfieldInterleave(uint16 x, uint16 y);
154
160 GLM_FUNC_DECL uint32 bitfieldInterleave(u16vec2 const& v);
161
165 GLM_FUNC_DECL glm::u16vec2 bitfieldDeinterleave(glm::uint32 x);
166
172 GLM_FUNC_DECL int64 bitfieldInterleave(int32 x, int32 y);
173
179 GLM_FUNC_DECL uint64 bitfieldInterleave(uint32 x, uint32 y);
180
186 GLM_FUNC_DECL uint64 bitfieldInterleave(u32vec2 const& v);
187
191 GLM_FUNC_DECL glm::u32vec2 bitfieldDeinterleave(glm::uint64 x);
192
198 GLM_FUNC_DECL int32 bitfieldInterleave(int8 x, int8 y, int8 z);
199
205 GLM_FUNC_DECL uint32 bitfieldInterleave(uint8 x, uint8 y, uint8 z);
206
212 GLM_FUNC_DECL int64 bitfieldInterleave(int16 x, int16 y, int16 z);
213
219 GLM_FUNC_DECL uint64 bitfieldInterleave(uint16 x, uint16 y, uint16 z);
220
226 GLM_FUNC_DECL int64 bitfieldInterleave(int32 x, int32 y, int32 z);
227
233 GLM_FUNC_DECL uint64 bitfieldInterleave(uint32 x, uint32 y, uint32 z);
234
240 GLM_FUNC_DECL int32 bitfieldInterleave(int8 x, int8 y, int8 z, int8 w);
241
247 GLM_FUNC_DECL uint32 bitfieldInterleave(uint8 x, uint8 y, uint8 z, uint8 w);
248
254 GLM_FUNC_DECL int64 bitfieldInterleave(int16 x, int16 y, int16 z, int16 w);
255
261 GLM_FUNC_DECL uint64 bitfieldInterleave(uint16 x, uint16 y, uint16 z, uint16 w);
262
264 } //namespace glm
265
266 #include "bitfield.inl"
glm::uint32
detail::uint32 uint32
32 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:64
glm::u16vec2
vec< 2, uint16, defaultp > u16vec2
16 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_sized.hpp:36
glm::int16
detail::int16 int16
16 bit signed integer type.
Definition: scalar_int_sized.hpp:61
glm::bitfieldInterleave
GLM_FUNC_DECL uint64 bitfieldInterleave(uint16 x, uint16 y, uint16 z, uint16 w)
Interleaves the bits of x, y, z and w.
glm::uint64
detail::uint64 uint64
64 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:67
type_precision.hpp
GLM_GTC_type_precision
glm::uint8
detail::uint8 uint8
8 bit unsigned integer type.
Definition: scalar_uint_sized.hpp:58
glm::bitfieldFillOne
GLM_FUNC_DECL vec< L, T, Q > bitfieldFillOne(vec< L, T, Q > const &Value, int FirstBit, int BitCount)
Set to 1 a range of bits.
glm::mask
GLM_FUNC_DECL vec< L, T, Q > mask(vec< L, T, Q > const &v)
Build a mask of 'count' bits.
glm::bitfieldFillZero
GLM_FUNC_DECL vec< L, T, Q > bitfieldFillZero(vec< L, T, Q > const &Value, int FirstBit, int BitCount)
Set to 0 a range of bits.
glm::bitfieldRotateRight
GLM_FUNC_DECL vec< L, T, Q > bitfieldRotateRight(vec< L, T, Q > const &In, int Shift)
Rotate all bits to the right.
glm::int8
detail::int8 int8
8 bit signed integer type.
Definition: scalar_int_sized.hpp:58
glm::u32vec2
vec< 2, uint32, defaultp > u32vec2
32 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_sized.hpp:41
glm::u8vec2
vec< 2, uint8, defaultp > u8vec2
8 bit unsigned integer vector of 2 components type.
Definition: vector_uint2_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::bitfieldDeinterleave
GLM_FUNC_DECL glm::u32vec2 bitfieldDeinterleave(glm::uint64 x)
Deinterleaves the bits of x.
glm::bitfieldRotateLeft
GLM_FUNC_DECL vec< L, T, Q > bitfieldRotateLeft(vec< L, T, Q > const &In, int Shift)
Rotate all bits to the left.
glm::int32
detail::int32 int32
32 bit signed integer type.
Definition: scalar_int_sized.hpp:64