type_ptr.hpp 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230
  1. /// @ref gtc_type_ptr
  2. /// @file glm/gtc/type_ptr.hpp
  3. ///
  4. /// @see core (dependence)
  5. /// @see gtc_quaternion (dependence)
  6. ///
  7. /// @defgroup gtc_type_ptr GLM_GTC_type_ptr
  8. /// @ingroup gtc
  9. ///
  10. /// Include <glm/gtc/type_ptr.hpp> to use the features of this extension.
  11. ///
  12. /// Handles the interaction between pointers and vector, matrix types.
  13. ///
  14. /// This extension defines an overloaded function, glm::value_ptr. It returns
  15. /// a pointer to the memory layout of the object. Matrix types store their values
  16. /// in column-major order.
  17. ///
  18. /// This is useful for uploading data to matrices or copying data to buffer objects.
  19. ///
  20. /// Example:
  21. /// @code
  22. /// #include <glm/glm.hpp>
  23. /// #include <glm/gtc/type_ptr.hpp>
  24. ///
  25. /// glm::vec3 aVector(3);
  26. /// glm::mat4 someMatrix(1.0);
  27. ///
  28. /// glUniform3fv(uniformLoc, 1, glm::value_ptr(aVector));
  29. /// glUniformMatrix4fv(uniformMatrixLoc, 1, GL_FALSE, glm::value_ptr(someMatrix));
  30. /// @endcode
  31. ///
  32. /// <glm/gtc/type_ptr.hpp> need to be included to use the features of this extension.
  33. #pragma once
  34. // Dependency:
  35. #include "../gtc/quaternion.hpp"
  36. #include "../gtc/vec1.hpp"
  37. #include "../vec2.hpp"
  38. #include "../vec3.hpp"
  39. #include "../vec4.hpp"
  40. #include "../mat2x2.hpp"
  41. #include "../mat2x3.hpp"
  42. #include "../mat2x4.hpp"
  43. #include "../mat3x2.hpp"
  44. #include "../mat3x3.hpp"
  45. #include "../mat3x4.hpp"
  46. #include "../mat4x2.hpp"
  47. #include "../mat4x3.hpp"
  48. #include "../mat4x4.hpp"
  49. #include <cstring>
  50. #if GLM_MESSAGES == GLM_ENABLE && !defined(GLM_EXT_INCLUDED)
  51. # pragma message("GLM: GLM_GTC_type_ptr extension included")
  52. #endif
  53. namespace glm
  54. {
  55. /// @addtogroup gtc_type_ptr
  56. /// @{
  57. /// Return the constant address to the data of the input parameter.
  58. /// @see gtc_type_ptr
  59. template<typename genType>
  60. GLM_FUNC_DECL typename genType::value_type const * value_ptr(genType const& v);
  61. /// Build a vector from a pointer.
  62. /// @see gtc_type_ptr
  63. template <typename T, qualifier Q>
  64. GLM_FUNC_DECL vec<1, T, Q> make_vec1(vec<1, T, Q> const& v);
  65. /// Build a vector from a pointer.
  66. /// @see gtc_type_ptr
  67. template <typename T, qualifier Q>
  68. GLM_FUNC_DECL vec<1, T, Q> make_vec1(vec<2, T, Q> const& v);
  69. /// Build a vector from a pointer.
  70. /// @see gtc_type_ptr
  71. template <typename T, qualifier Q>
  72. GLM_FUNC_DECL vec<1, T, Q> make_vec1(vec<3, T, Q> const& v);
  73. /// Build a vector from a pointer.
  74. /// @see gtc_type_ptr
  75. template <typename T, qualifier Q>
  76. GLM_FUNC_DECL vec<1, T, Q> make_vec1(vec<4, T, Q> const& v);
  77. /// Build a vector from a pointer.
  78. /// @see gtc_type_ptr
  79. template <typename T, qualifier Q>
  80. GLM_FUNC_DECL vec<2, T, Q> make_vec2(vec<1, T, Q> const& v);
  81. /// Build a vector from a pointer.
  82. /// @see gtc_type_ptr
  83. template <typename T, qualifier Q>
  84. GLM_FUNC_DECL vec<2, T, Q> make_vec2(vec<2, T, Q> const& v);
  85. /// Build a vector from a pointer.
  86. /// @see gtc_type_ptr
  87. template <typename T, qualifier Q>
  88. GLM_FUNC_DECL vec<2, T, Q> make_vec2(vec<3, T, Q> const& v);
  89. /// Build a vector from a pointer.
  90. /// @see gtc_type_ptr
  91. template <typename T, qualifier Q>
  92. GLM_FUNC_DECL vec<2, T, Q> make_vec2(vec<4, T, Q> const& v);
  93. /// Build a vector from a pointer.
  94. /// @see gtc_type_ptr
  95. template <typename T, qualifier Q>
  96. GLM_FUNC_DECL vec<3, T, Q> make_vec3(vec<1, T, Q> const& v);
  97. /// Build a vector from a pointer.
  98. /// @see gtc_type_ptr
  99. template <typename T, qualifier Q>
  100. GLM_FUNC_DECL vec<3, T, Q> make_vec3(vec<2, T, Q> const& v);
  101. /// Build a vector from a pointer.
  102. /// @see gtc_type_ptr
  103. template <typename T, qualifier Q>
  104. GLM_FUNC_DECL vec<3, T, Q> make_vec3(vec<3, T, Q> const& v);
  105. /// Build a vector from a pointer.
  106. /// @see gtc_type_ptr
  107. template <typename T, qualifier Q>
  108. GLM_FUNC_DECL vec<3, T, Q> make_vec3(vec<4, T, Q> const& v);
  109. /// Build a vector from a pointer.
  110. /// @see gtc_type_ptr
  111. template <typename T, qualifier Q>
  112. GLM_FUNC_DECL vec<4, T, Q> make_vec4(vec<1, T, Q> const& v);
  113. /// Build a vector from a pointer.
  114. /// @see gtc_type_ptr
  115. template <typename T, qualifier Q>
  116. GLM_FUNC_DECL vec<4, T, Q> make_vec4(vec<2, T, Q> const& v);
  117. /// Build a vector from a pointer.
  118. /// @see gtc_type_ptr
  119. template <typename T, qualifier Q>
  120. GLM_FUNC_DECL vec<4, T, Q> make_vec4(vec<3, T, Q> const& v);
  121. /// Build a vector from a pointer.
  122. /// @see gtc_type_ptr
  123. template <typename T, qualifier Q>
  124. GLM_FUNC_DECL vec<4, T, Q> make_vec4(vec<4, T, Q> const& v);
  125. /// Build a vector from a pointer.
  126. /// @see gtc_type_ptr
  127. template<typename T>
  128. GLM_FUNC_DECL vec<2, T, defaultp> make_vec2(T const * const ptr);
  129. /// Build a vector from a pointer.
  130. /// @see gtc_type_ptr
  131. template<typename T>
  132. GLM_FUNC_DECL vec<3, T, defaultp> make_vec3(T const * const ptr);
  133. /// Build a vector from a pointer.
  134. /// @see gtc_type_ptr
  135. template<typename T>
  136. GLM_FUNC_DECL vec<4, T, defaultp> make_vec4(T const * const ptr);
  137. /// Build a matrix from a pointer.
  138. /// @see gtc_type_ptr
  139. template<typename T>
  140. GLM_FUNC_DECL mat<2, 2, T, defaultp> make_mat2x2(T const * const ptr);
  141. /// Build a matrix from a pointer.
  142. /// @see gtc_type_ptr
  143. template<typename T>
  144. GLM_FUNC_DECL mat<2, 3, T, defaultp> make_mat2x3(T const * const ptr);
  145. /// Build a matrix from a pointer.
  146. /// @see gtc_type_ptr
  147. template<typename T>
  148. GLM_FUNC_DECL mat<2, 4, T, defaultp> make_mat2x4(T const * const ptr);
  149. /// Build a matrix from a pointer.
  150. /// @see gtc_type_ptr
  151. template<typename T>
  152. GLM_FUNC_DECL mat<3, 2, T, defaultp> make_mat3x2(T const * const ptr);
  153. /// Build a matrix from a pointer.
  154. /// @see gtc_type_ptr
  155. template<typename T>
  156. GLM_FUNC_DECL mat<3, 3, T, defaultp> make_mat3x3(T const * const ptr);
  157. /// Build a matrix from a pointer.
  158. /// @see gtc_type_ptr
  159. template<typename T>
  160. GLM_FUNC_DECL mat<3, 4, T, defaultp> make_mat3x4(T const * const ptr);
  161. /// Build a matrix from a pointer.
  162. /// @see gtc_type_ptr
  163. template<typename T>
  164. GLM_FUNC_DECL mat<4, 2, T, defaultp> make_mat4x2(T const * const ptr);
  165. /// Build a matrix from a pointer.
  166. /// @see gtc_type_ptr
  167. template<typename T>
  168. GLM_FUNC_DECL mat<4, 3, T, defaultp> make_mat4x3(T const * const ptr);
  169. /// Build a matrix from a pointer.
  170. /// @see gtc_type_ptr
  171. template<typename T>
  172. GLM_FUNC_DECL mat<4, 4, T, defaultp> make_mat4x4(T const * const ptr);
  173. /// Build a matrix from a pointer.
  174. /// @see gtc_type_ptr
  175. template<typename T>
  176. GLM_FUNC_DECL mat<2, 2, T, defaultp> make_mat2(T const * const ptr);
  177. /// Build a matrix from a pointer.
  178. /// @see gtc_type_ptr
  179. template<typename T>
  180. GLM_FUNC_DECL mat<3, 3, T, defaultp> make_mat3(T const * const ptr);
  181. /// Build a matrix from a pointer.
  182. /// @see gtc_type_ptr
  183. template<typename T>
  184. GLM_FUNC_DECL mat<4, 4, T, defaultp> make_mat4(T const * const ptr);
  185. /// Build a quaternion from a pointer.
  186. /// @see gtc_type_ptr
  187. template<typename T>
  188. GLM_FUNC_DECL qua<T, defaultp> make_quat(T const * const ptr);
  189. /// @}
  190. }//namespace glm
  191. #include "type_ptr.inl"