程序代做CS代考 x86 data structure compiler GPU c++ algorithm 9/3/2018 – cscodehelp代写
9/3/2018
GLM 0.9.9 Manual
1 / 55
Table of Contents
0. Licenses
1. Getting started
1.1. Using global headers
1.2. Using separated headers
1.3. Using extension headers
1.4. Dependencies
2. Preprocessor configurations
2.1. GLM_FORCE_MESSAGES: Platform auto detection and default configuration
2.2. GLM_FORCE_PLATFORM_UNKNOWN: Force GLM to no detect the build platform
2.3. GLM_FORCE_COMPILER_UNKNOWN: Force GLM to no detect the C++ compiler
2.4. GLM_FORCE_ARCH_UNKNOWN: Force GLM to no detect the build architecture
2.5. GLM_FORCE_CXX_UNKNOWN: Force GLM to no detect the C++ standard
2.6. GLM_FORCE_CXX**: C++ language detection
2.7. GLM_FORCE_EXPLICIT_CTOR: Requiring explicit conversions
2.8. GLM_FORCE_INLINE: Force inline
2.9. GLM_FORCE_DEFAULT_ALIGNED_GENTYPES: Force GLM to use aligned types by default 2.10. GLM_FORCE_SIMD_**: Using SIMD optimizations
2.11. GLM_FORCE_PRECISION_**: Default precision
2.12. GLM_FORCE_SINGLE_ONLY: Removed explicit 64-bits floating point types
2.13. GLM_FORCE_SWIZZLE: Enable swizzle operators
2.14. GLM_FORCE_XYZW_ONLY: Only exposes x, y, z and w components
2.15. GLM_FORCE_LEFT_HANDED: Force left handed coordinate system
2.16. GLM_FORCE_DEPTH_ZERO_TO_ONE: Force the use of a clip space between 0 to 1 2.17. GLM_FORCE_SIZE_T_LENGTH: Vector and matrix static size type
2.18. GLM_FORCE_UNRESTRICTED_GENTYPE: Removing genType restriction
3. Stable extensions
3.1. Scalar types
3.2. Scalar functions
3.3. Vector types
3.4. Vector types with precision qualifiers
3.5. Vector functions
3.6. Matrix types
3.7. Matrix types with precision qualifiers
3.8. Matrix functions
3.9. Quaternion types
3.10. Quaternion types with precision qualifiers
3.11. Quaternion functions
4. Recommended extensions
4.1. GLM_GTC_bitfield
4.2. GLM_GTC_color_space
4.3. GLM_GTC_constants
4.4. GLM_GTC_epsilon
4.5. GLM_GTC_integer
4.6. GLM_GTC_matrix_access
2 / 55
9/3/2018
4.7. GLM_GTC_matrix_integer 4.8. GLM_GTC_matrix_inverse 4.9. GLM_GTC_matrix_transform 4.10. GLM_GTC_noise
4.11. GLM_GTC_packing
4.12. GLM_GTC_quaternion
4.13. GLM_GTC_random
4.14. GLM_GTC_reciprocal
4.15. GLM_GTC_round
4.16. GLM_GTC_type_alignment
4.17. GLM_GTC_type_precision
4.18. GLM_GTC_type_ptr
4.19. GLM_GTC_ulp
4.20. GLM_GTC_vec1
5. OpenGL interoperability
5.1. GLM Replacements for deprecated OpenGL functions
5.2. GLM Replacements for GPU functions
6. Known issues
6.1. Not function
6.2. Precision qualifiers support
7. FAQ
7.1 Why GLM follows GLSL specification and conventions?
7.2. Does GLM run GLSL programs?
7.3. Does a GLSL compiler build GLM codes?
7.4. Should I use ‘GTX’ extensions?
7.5. Where can I ask my questions?
7.6. Where can I find the documentation of extensions?
7.7. Should I use ‘using namespace glm;’?
7.8. Is GLM fast?
7.9. When I build with Visual C++ with /w4 warning level, I have warnings… 7.10. Why some GLM functions can crash because of division by zero? 7.11. What unit for angles us used in GLM?
7.12. Windows headers cause build errors…
7.13. Constant expressions support
8. Code samples
8.1. Compute a triangle normal
8.2. Matrix transform
8.3. Vector types
8.4. Lighting
9. Contributing to GLM
9.1. Submitting bug reports
9.2. Contributing to GLM with pull request
9.3. Coding style
10. References
10.1. OpenGL specifications
10.2. External links
3 / 55
9/3/2018
10.3. Projects using GLM
10.4. Tutorials using GLM
10.5. Equivalent for other languages 10.6. Alternatives to GLM
10.7. Acknowledgements
4 / 55
9/3/2018
Licenses
The License (Modified MIT License) Copyright (c) 2005 – G-Truc Creation
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.
Restrictions: By making use of the Software for military purposes, you choose to make a Bunny unhappy.
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.
The MIT License
Copyright (c) 2005 – G-Truc Creation
5 / 55
9/3/2018
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.
6 / 55
9/3/2018
9/3/2018
1. Getting started
1.1. Using global headers
GLM is a header-only library, and thus does not need to be compiled. We can use GLM’s implementation of GLSL’s mathematics functionality by including the
To extend the feature set supported by GLM and keeping the library as close to GLSL as possible, new features are implemented as extensions that can be included thought a separated header:
#include
// Include all GLM core / GLSL features
#include
// Include all GLM extensions
#include
glm::mat4 transform(glm::vec2 const& Orientation, glm::vec3 const& Translate,
glm::vec3 const& Up)
{
glm::mat4 Proj = glm::perspective(glm::radians(45.f), 1.33f, 0.1f, 10.f);
glm::mat4 ViewTranslate = glm::translate(glm::mat4(1.f), Translate);
glm::mat4 ViewRotateX = glm::rotate(ViewTranslate, Orientation.y, Up);
glm::mat4 View = glm::rotate(ViewRotateX, Orientation.x, Up);
glm::mat4 Model = glm::mat4(1.0f);
return Proj * View * Model;
}
Note: Including
1.2. Using separated headers
GLM relies on C++ templates heavily, and may significantly increase compilation times for projects that use it. Hence, user projects could only include the features they actually use. Following is the list of all the core features, based on GLSL specification, headers:
#include
#include
#include
#include
#include
#include
#include
// vec2, bvec2, dvec2, ivec2 and uvec2
// vec3, bvec3, dvec3, ivec3 and uvec3
// vec4, bvec4, dvec4, ivec4 and uvec4
// mat2, dmat2
// mat2x3, dmat2x3
// mat2x4, dmat2x4
// mat3x2, dmat3x2
7 / 55
9/3/201
8
The following is a code sample using separated core headers and an extension:
// Include GLM core features
#include
#include
#include
#include
// Include GLM extension
#include
glm::mat4 transform(glm::vec2 const& Orientation, glm::vec3 const& Translate,
glm::vec3 const& Up)
{
glm::mat4 Proj = glm::perspective(glm::radians(45.f), 1.33f, 0.1f, 10.f);
glm::mat4 ViewTranslate = glm::translate(glm::mat4(1.f), Translate);
glm::mat4 ViewRotateX = glm::rotate(ViewTranslate, Orientation.y, Up);
glm::mat4 View = glm::rotate(ViewRotateX, Orientation.x, Up);
glm::mat4 Model = glm::mat4(1.0f);
return Proj * View * Model;
}
// vec2
// vec3
// mat4
1.3. Using extension headers
Using GLM through split headers to minimize the project build time:
#include
#include
#include
#include
#include
#include
mix, isnan, fma, etc.
#include
log, exp2, sqrt, etc.
#include
cross, reflect, etc.
#include
bitfieldExtract, etc.
#include
inverse, etc.
// mat3, dmat3
// mat3x4, dmat2
// mat4x2, dmat4x2
// mat4x3, dmat4x3
// mat4, dmat4
// all the GLSL common functions: abs, min,
// all the GLSL exponential functions: pow,
// all the GLSL geometry functions: dot,
// all the GLSL integer functions: findMSB,
// all the GLSL matrix functions: transpose,
// all the GLSL packing functions:
#include
packUnorm4x8, unpackHalf2x16, etc.
#include
radians, cos, asin, etc.
#include
equal, less, etc.
// all the GLSL trigonometric functions:
8 / 55
8
9 / 55
9/3/201
1.4. Dependencies
GLM does not depend on external libraries or headers such as
// Include GLM vector extensions:
#include
#include
#include
// Include GLM matrix extensions:
#include
#include
rotate
// vec2
// vec3
// radians
// mat4
// perspective, translate,
glm::mat4 transform(glm::vec2 const& Orientation, glm::vec3 const& Translate,
glm::vec3 const& Up)
{
glm::mat4 Proj = glm::perspective(glm::radians(45.f), 1.33f, 0.1f, 10.f);
glm::mat4 ViewTranslate = glm::translate(glm::mat4(1.f), Translate);
glm::mat4 ViewRotateX = glm::rotate(ViewTranslate, Orientation.y, Up);
glm::mat4 View = glm::rotate(ViewRotateX, Orientation.x, Up);
glm::mat4 Model = glm::mat4(1.0f);
return Proj * View * Model;
}
2. Preprocessor configurations
2.1. GLM_FORCE_MESSAGES: Platform auto detection and default configuration
When included, GLM will first automatically detect the compiler used, the C++ standard supported, the compiler arguments used to configure itself matching the build environment.
For example, if the compiler arguments request AVX code generation, GLM will rely on its code path providing AVX optimizations when available.
We can change GLM configuration using specific C++ preprocessor defines that must be declared before including any GLM headers.
Using GLM_FORCE_MESSAGES, GLM will report the configuration as part of the build log.
Example of configuration log generated by GLM_FORCE_MESSAGES:
#define GLM_FORCE_MESSAGES // Or defined when building (e.g. -DGLM_FORCE_SWIZZLE)
#include
GLM: version 0.9.9.1
GLM: C++ 17 with extensions
GLM: Clang compiler detected
GLM: x86 64 bits with AVX instruction set build target
GLM: Linux platform detected
GLM: GLM_FORCE_SWIZZLE is undefined. swizzling functions or operators are
disabled.
GLM: GLM_FORCE_SIZE_T_LENGTH is undefined. .length() returns a glm::length_t, a
typedef of int following GLSL.
GLM: GLM_FORCE_UNRESTRICTED_GENTYPE is undefined. Follows strictly GLSL on valid
function genTypes.
GLM: GLM_FORCE_DEPTH_ZERO_TO_ONE is undefined. Using negative one to one depth
clip space.
GLM: GLM_FORCE_LEFT_HANDED is undefined. Using right handed coordinate system.
The following subsections describe each configurations and defines.
2.2. GLM_FORCE_PLATFORM_UNKNOWN: Force GLM to no detect the build platform
GLM_FORCE_PLATFORM_UNKNOWN prevents GLM from detecting the build platform.
2.3. GLM_FORCE_COMPILER_UNKNOWN: Force GLM to no detect the C++ compiler
GLM_FORCE_COMPILER_UNKNOWN prevents GLM from detecting the C++ compiler.
2.4. GLM_FORCE_ARCH_UNKNOWN: Force GLM to no detect the build architecture
GLM_FORCE_ARCH_UNKNOWN prevents GLM from detecting the build target architechture.
10 / 55
9/3/2018
9/3/2018
2.5. GLM_FORCE_CXX_UNKNOWN: Force GLM to no detect the C++ standard GLM_FORCE_CSS_UNKNOWN prevents GLM from detecting the C++ compiler standard support.
2.6. GLM_FORCE_CXX**: C++ language detection
GLM will automatically take advantage of compilers’ language extensions when enabled. To increase cross platform compatibility and to avoid compiler extensions, a programmer can define GLM_FORCE_CXX98 before any inclusion of
For C++11, C++14, and C++17 equivalent defines are available:
GLM_FORCE_CXX11
GLM_FORCE_CXX14
GLM_FORCE_CXX14
GLM_FORCE_CXX17 overrides GLM_FORCE_CXX14; GLM_FORCE_CXX14 overrides GLM_FORCE_CXX11; and GLM_FORCE_CXX11 overrides GLM_FORCE_CXX98 defines.
2.7. GLM_FORCE_EXPLICIT_CTOR: Requiring explicit conversions
GLSL supports implicit conversions of vector and matrix types. For example, an ivec4 can be implicitly
converted into vec4.
Often, this behaviour is not desirable but following the spirit of the library, this is the default behavior in GLM. However, GLM 0.9.6 introduced the define GLM_FORCE_EXPLICIT_CTOR to require explicit conversion for GLM types.
#define GLM_FORCE_CXX98
#include
#define GLM_FORCE_CXX11
#include
// If the compiler doesn’t support C++11, compiler errors will happen.
#include
void foo() {
glm::ivec4 a;
…
glm::vec4 b(a); // Explicit conversion, OK
glm::vec4 c = a; // Implicit conversion, OK
…
}
11 / 55
9/3/201
8
With GLM_FORCE_EXPLICIT_CTOR define, implicit conversions are not allowed:
#define GLM_FORCE_EXPLICIT_CTOR
#include
void foo() {
glm::ivec4 a;
{
}
glm::vec4 b(a); // Explicit conversion, OK
glm::vec4 c = a; // Implicit conversion, ERROR
…
2.8. GLM_FORCE_INLINE: Force inline
To push further the software performance, a programmer can define GLM_FORCE_INLINE before any inclusion
of
2.9. GLM_FORCE_DEFAULT_ALIGNED_GENTYPES: Force GLM to use aligned types by default
Every object type has the property called alignment requirement, which is an integer value (of type std::size_t, always a power of 2) representing the number of bytes between successive addresses at which objects of this type can be allocated. The alignment requirement of a type can be queried with alignof or std::alignment_of. The pointer alignment function std::align can be used to obtain a suitably-aligned pointer within some buffer, and std::aligned_storage can be used to obtain suitably-aligned storage.
Each object type imposes its alignment requirement on every object of that type; stricter alignment (with larger alignment requirement) can be requested using C++11 alignas.
In order to satisfy alignment requirements of all non-static members of a class, padding may be inserted after some of its members.
GLM supports both packed and aligned types. Packed types allow filling data structure without inserting extra padding. Aligned GLM types align addresses based on the size of the value type of a GLM type.
#define GLM_FORCE_INLINE
#include
#define GLM_FORCE_DEFAULT_ALIGNED_GENTYPES
#include
struct MyStruct
{
glm::vec4 a;
12 / 55
9/3/201
8
#include
struct MyStruct
{
glm::vec4 a;
float b;
glm::vec3 c;
};
void foo() {
printf(“MyStruct is tightly packed: %d bytes
”, sizeof(MyStruct));
}
>>> MyStruct is tightly packed: 32 bytes
Note: GLM SIMD optimizations require the use of aligned types
2.10. GLM_FORCE_SIMD_**: Using SIMD optimizations
GLM provides some SIMD optimizations based on compiler intrinsics. These optimizations will be automatically thanks to compiler arguments. For example, if a program is compiled with Visual Studio using /arch:AVX, GLM will detect this argument and generate code using AVX instructions automatically when available.
It’s possible to avoid the instruction set detection by forcing the use of a specific instruction set with one of the fallowing define: GLM_FORCE_SSE2, GLM_FORCE_SSE3, GLM_FORCE_SSSE3, GLM_FORCE_SSE41, GLM_FORCE_SSE42, GLM_FORCE_AVX, GLM_FORCE_AVX2 or GLM_FORCE_AVX512.
The use of intrinsic functions by GLM implementation can be avoided using the define GLM_FORCE_PURE before any inclusion of GLM headers. This can be particularly useful if we want to rely on C++14 constexpr.
float b;
glm::vec3 c;
};
void foo() {
printf(“MyStruct requires memory padding: %d bytes
”, sizeof(MyStruct));
}
>>> MyStruct requires memory padding: 48 bytes
#define GLM_FORCE_PURE
#include
static_assert(glm::vec4::length() == 4, “Using GLM C++ 14 constexpr support for
compile time tests”);
13 / 55
14 / 55
8
9/3/201
#define GLM_FORCE_SIMD_AVX2
#include
// If the compiler doesn’t support AVX2 instrinsics, compiler errors will happen.
Additionally, GLM provides a low level SIMD API in glm/simd directory for users who are really interested in writing fast algorithms.
2.11. GLM_FORCE_PRECISION_**: Default precision
C++ does not provide a way to implement GLSL default precision selection (as defined in GLSL 4.10 specification section 4.5.3) with GLSL-like syntax.
To use the default precision functionality, GLM provides some defines that need to added before any include of glm.hpp:
Available defines for floating point types (glm::vec*, glm::mat*):
GLM_FORCE_PRECISION_LOWP_FLOAT: Low precision GLM_FORCE_PRECISION_MEDIUMP_FLOAT: Medium precision GLM_FORCE_PRECISION_HIGHP_FLOAT: High precision (default)
Available defines for floating point types (glm::dvec*, glm::dmat*):
GLM_FORCE_PRECISION_LOWP_DOUBLE: Low precision GLM_FORCE_PRECISION_MEDIUMP_DOUBLE: Medium precision GLM_FORCE_PRECISION_HIGHP_DOUBLE: High precision (default)
Available defines for signed integer types (glm::ivec*):
GLM_FORCE_PRECISION_LOWP_INT: Low precision GLM_FORCE_PRECISION_MEDIUMP_INT: Medium precision GLM_FORCE_PRECISION_HIGHP_INT: High precision (default)
precision mediump int;
precision highp float;
#define GLM_FORCE_PRECISION_MEDIUMP_INT
#define GLM_FORCE_PRECISION_HIGHP_FLOAT
#include
Available defines for unsigned integer types (glm::uvec*):
// GLM code will be compiled using pure C++ code without any intrinsics
9/3/2018
GLM_FORCE_PRECISION_LOWP_UINT: Low precision GLM_FORCE_PRECISION_MEDIUMP_UINT: Medium precision GLM_FORCE_PRECISION_HIGHP_UINT: High precision (default)
2.12. GLM_FORCE_SINGLE_ONLY: Removed explicit 64-bits floating point types
Some platforms (Dreamcast) doesn’t support double precision floating point values. To compile on such platforms, GCC has the –m4-single-only build argument. When defining GLM_FORCE_SINGLE_ONLY before including GLM headers, GLM releases the requirement of double precision floating point values support. Effectivement, all the float64 types are no longer defined and double behaves like float.
2.13. GLM_FORCE_SWIZZLE: Enable swizzle operators
Shader languages like GLSL often feature so-called swizzle expressions, which may be used to freely select and arrange a vector’s components. For example, variable.x, variable.xzy and variable.zxyy respectively form a scalar, a 3D vector and a 4D vector. The result of a swizzle expression in GLSL can be either an R-value or an L-value. Swizzle expressions can be written with characters from exactly one of xyzw (usually for positions), rgba (usually for colors), and stpq (usually for texture coordinates).
vec4 A;
vec2 B;
B.yx = A.wy;
B = A.xx;
vec3 C = A.bgr;
vec3 D = B.rsz; // Invalid, won’t compile
GLM supports some of this functionality. Swizzling can be enabled by defining GLM_FORCE_SWIZZLE. Note: Enabling swizzle expressions will massively increase the size of your binaries and the time it takes to
compile them!
GLM has two levels of swizzling support described in the following subsections.
2.13.1. Swizzle functions for standard C++ 98
When compiling GLM as C++98, R-value swizzle expressions are simulated through member functions of each vector type.
#define GLM_FORCE_SWIZZLE // Or defined when building (e.g. -DGLM_FORCE_SWIZZLE)
#include
void foo() {
glm::vec4 const ColorRGBA = glm::vec4(1.0f, 0.5f, 0.0f, 1.0f);
glm::vec3 const ColorBGR = ColorRGBA.bgr();
glm::vec3 const PositionA = glm::vec3(1.0f, 0.5f, 0.0f);
15 / 55
16 / 55
8
9/3/201
Swizzle operators return a copy of the component values, and thus can’t be used as L-values to change a vector’s values.
#define GLM_FORCE_SWIZZLE
#include
void foo() {
glm::vec3 const A = glm::vec3(1.0f, 0.5f, 0.0f);
// No compiler error, but A is not modified.
// An anonymous copy is being modified (and then discarded).
A.bgr() = glm::vec3(2.0f, 1.5f, 1.0f); // A is not modified!
}
2.13.2. Swizzle operations for C++ 98 with language extensions
Visual C++, GCC and Clang support, as a non-standard language extension, anonymous structs as union members. This permits a powerful swizzling implementation that both allows L-value swizzle expressions and GLSL-like syntax. To use this feature, the language extension must be enabled by a supporting compiler and GLM_FORCE_SWIZZLE must be #defined.
#define GLM_FORCE_SWIZZLE
#include
// Only guaranteed to work with Visual C++!
// Some compilers that support Microsoft extensions may compile this.
void foo()
{
glm::vec4 ColorRGBA = glm::vec4(1.0f, 0.5f, 0.0f, 1.0f);
// l-value:
glm::vec4 ColorBGRA = ColorRGBA.bgra;
// r-value:
ColorRGBA.bgra = ColorRGBA;
// Both l-value and r-value
ColorRGBA.bgra = ColorRGBA.rgba;
}
glm::vec3 const PositionB = PositionXYZ.xyz() * 2.0f;
glm::vec2 const TexcoordST = glm::vec2(1.0f, 0.5f);
glm::vec4 const TexcoordSTPQ = TexcoordST.stst();
}
This version returns implementation-specific objects that implicitly convert to their respective vector types. As a consequence of this design, these extra types can’t be directly used as C++ function arguments; they must be converted through constructors or operator().
#define GLM_FORCE_SWIZZLE
#include
using namespace glm;
void foo() {
vec4 Color = vec4(1.0f, 0.5f, 0.0f, 1.0f);
// Generates compiler errors. Color.rgba is not a vector type.
vec4 ClampedA = clamp(Color.rgba, 0.f, 1.f); // ERROR
// Explicit conversion through a constructor
vec4 ClampedB = clamp(vec4(Color.rgba), 0.f, 1.f); // OK
// Explicit conversion through operator()
vec4 ClampedC = clamp(Color.rgba(), 0.f, 1.f); // OK
}
Note: The implementation has a caveat: Swizzle operator types must be different on both size of the equal operator or the operation will fail. There is no known fix for this issue to date
2.14. GLM_FORCE_XYZW_ONLY: Only exposes x, y, z and w components
Following GLSL specifications, GLM supports three sets of components to access vector types member: x, y, z, w; r, g, b, a; and s, t, p, q. Also, this is making vector component very expressive in the code, it may make debugging vector types a little cubersom as the debuggers will typically display three time the values for each compoenents due to the existance of the three sets.
To simplify vector types, GLM allows exposing only x, y, z and w components thanks to GLM_FORCE_XYZW_ONLY define.
2.15. GLM_FORCE_LEFT_HANDED: Force left handed coordinate system
By default, OpenGL is using a right handed coordinate system. However, others APIs such as Direct3D have done different choice and relies on the left handed coordinate system.
GLM allows switching the coordinate system to left handed by defining GLM_FORCE_LEFT_HANDED. 2.16. GLM_FORCE_DEPTH_ZERO_TO_ONE: Force the use of a clip space between 0 to 1
By default, OpenGL is using a -1 to 1 clip space in Z-axis. However, others APIs such as Direct3D relies on a clip space between 0 to 1 in Z-axis.
GLM allows switching the clip space in Z-axis to 0 to 1 by defining GLM_FORCE_DEPTH_ZERO_TO_ONE.
17 / 55
9/3/2018
9/3/2018
2.17. GLM_FORCE_SIZE_T_LENGTH: Vector and matrix static size GLSL supports the member function .length() for all vector and matrix types.
#include
void foo(vec4 const& v)
{
int Length = v.length();
… }
This function returns an int however this function typically interacts with STL size_t based code. GLM provides GLM_FORCE_SIZE_T_LENGTH pre-processor configuration so that member functions length() return a size_t.
Additionally, GLM defines the type glm::length_t to identify length() returned type, independently from GLM_FORCE_SIZE_T_LENGTH.
#define GLM_FORCE_SIZE_T_LENGTH
#include
void foo(vec4 const& v)
{
glm::length_t Length = v.length();
… }
2.18. GLM_FORCE_UNRESTRICTED_GENTYPE: Removing genType restriction
GLSL has restrictions on types supported by certain functions that may appear excessive. By default, GLM follows the GLSL specification as accurately as possible however it’s possible to relax these rules using GLM_FORCE_UNRESTRICTED_GENTYPE define.
#include
float average(float const A, float const B)
{
return glm::mix(A, B, 0.5f); // By default glm::mix only supports floating-
point types
}
By defining GLM_FORCE_UNRESTRICTED_GENTYPE, we allow using integer types:
18 / 55
8
19 / 55
9/3/201
#define GLM_FORCE_UNRESTRICTED_GENTYPE
#include
int average(int const A, int const B)
{
return glm::mix(A, B, 0.5f); // integers are ok thanks to
GLM_FORCE_UNRESTRICTED_GENTYPE
}
3. Stable extensions 3.1. Scalar types
3.1.1. GLM_EXT_scalar_int_sized
This extension exposes sized and signed integer types.
Include
3.1.2. GLM_EXT_scalar_uint_sized
This extension exposes sized and unsigned integer types.
#include
glm::uint64 pack(glm::uint32 A, glm::uint16 B, glm::uint8 C, glm::uint8 D)
{
glm::uint64 ShiftA = 0;
glm::uint64 ShiftB = sizeof(glm::uint32) * 8;
glm::uint64 ShiftC = (sizeof(glm::uint32) + sizeof(glm::uint16)) * 8;
glm::uint64 ShiftD = (sizeof(glm::uint32) + sizeof(glm::uint16) +
sizeof(glm::uint8)) * 8;
return (glm::uint64(A) << ShiftA) | (glm::uint64(B) << ShiftB) |
(glm::uint64(C) << ShiftC) | (glm::uint64(D) << ShiftD);
}
Include
3.2.1. GLM_EXT_scalar_common
This extension exposes support for min and max functions taking more than two scalar arguments. Also, it adds fmin and fmax variants which prevents NaN propagation.
#include
float positiveMax(float const a, float const b)
{
return glm::fmax(a, b, 0.0f);
}
Include
20 / 55
9/3/2018
This extension exposes equal and notEqual scalar variants which takes an epsilon argument.
#include
bool epsilonEqual(float const a, float const b)
{
float const CustomEpsilon = 0.0001f;
return glm::equal(a, b, CustomEpsilon);
}
Include
This extension exposes useful constants such as epsilon and pi.
#include
float circumference(float const Diameter)
{
return glm::pi
}
#include
#include
bool equalULP1(float const a, float const b)
{
return glm::abs(a – b) <= glm::epsilon
}
Include
3.3.1. GLM_EXT_vector_float1
This extension exposes single-precision floating point vector with 1 component: vec1. Include
3.3.2. GLM_EXT_vector_float2
This extension exposes single-precision floating point vector with 2 components: vec2. Include
21 / 55
9/3/2018
3.3.3. GLM_EXT_vector_float3
This extension exposes single-precision floating point vector with 3 components: vec3. Include
3.3.4. GLM_EXT_vector_float4
This extension exposes single-precision floating point vector with 4 components: vec4. Include
3.3.5. GLM_EXT_vector_double1
This extension exposes double-precision floating point vector with 1 component: dvec1. Include
3.3.6. GLM_EXT_vector_double2
This extension exposes double-precision floating point vector with 2 components: dvec2. Include
3.3.7. GLM_EXT_vector_double3
This extension exposes double-precision floating point vector with 3 components: dvec3. Include
3.3.8. GLM_EXT_vector_double4
This extension exposes double-precision floating point vector with 4 components: dvec4. Include
3.3.9. GLM_EXT_vector_int1
This extension exposes signed integer vector with 1 component: ivec1. Include
3.3.10. GLM_EXT_vector_int2
This extension exposes signed integer vector with 2 components: ivec2. Include
3.3.11. GLM_EXT_vector_int3
This extension exposes signed integer vector with 3 components: ivec3.
22 / 55
9/3/2018
Include
This extension exposes signed integer vector with 4 components: ivec4. Include
3.3.13. GLM_EXT_vector_int1
This extension exposes unsigned integer vector with 1 component: uvec1. Include
3.3.14. GLM_EXT_vector_uint2
This extension exposes unsigned integer vector with 2 components: uvec2. Include
3.3.15. GLM_EXT_vector_uint3
This extension exposes unsigned integer vector with 3 components: uvec3. Include
3.3.16. GLM_EXT_vector_uint4
This extension exposes unsigned integer vector with 4 components: uvec4. Include
3.3.17. GLM_EXT_vector_bool1
This extension exposes boolean vector with 1 component: bvec1. Include
3.3.18. GLM_EXT_vector_bool2
This extension exposes boolean vector with 2 components: bvec2. Include
3.3.19. GLM_EXT_vector_bool3
This extension exposes boolean vector with 3 components: bvec3. Include
3.3.20. GLM_EXT_vector_bool4
23 / 55
9/3/2018
This extension exposes boolean vector with 4 components: bvec4. Include
3.4. Vector types with precision qualifiers
3.4.1. GLM_EXT_vector_float1_precision
This extension exposes single-precision floating point vector with 1 component using various precision in term of ULPs: lowp_vec1, mediump_vec1 and highp_vec1.
Include
3.4.2. GLM_EXT_vector_float2_precision
This extension exposes single-precision floating point vector with 2 components using various precision in term of ULPs: lowp_vec2, mediump_vec2 and highp_vec2.
Include
3.4.3. GLM_EXT_vector_float3_precision
This extension exposes single-precision floating point vector with 3 components using various precision in term of ULPs: lowp_vec3, mediump_vec3 and highp_vec3.
Include
3.4.4. GLM_EXT_vector_float4_precision
This extension exposes single-precision floating point vector with 4 components using various precision in term of ULPs: lowp_vec4, mediump_vec4 and highp_vec4.
Include
3.4.5. GLM_EXT_vector_double1_precision
This extension exposes double-precision floating point vector with 1 component using various precision in term of ULPs: lowp_dvec1, mediump_dvec1 and highp_dvec1.
Include
3.4.6. GLM_EXT_vector_double2_precision
This extension exposes double-precision floating point vector with 2 components using various precision in term of ULPs: lowp_dvec2, mediump_dvec2 and highp_dvec2.
Include
24 / 55
9/3/2018
This extension exposes double-precision floating point vector with 3 components using various precision in term of ULPs: lowp_dvec3, mediump_dvec3 and highp_dvec3.
Include
3.4.8. GLM_EXT_vector_double4_precision
This extension exposes double-precision floating point vector with 4 components using various precision in term of ULPs: lowp_dvec4, mediump_dvec4 and highp_dvec4.
Include
3.5.1. GLM_EXT_vector_common
This extension exposes support for min and max functions taking more than two vector arguments. Also, it adds fmin and fmax variants which prevents NaN propagation.
#include
#include
float positiveMax(float const a, float const b)
{
return glm::fmax(a, b, 0.0f);
}
Include
3.5.2. GLM_EXT_vector_relational
This extension exposes equal and notEqual vector variants which takes an epsilon argument.
#include
#include
bool epsilonEqual(glm::vec2 const& A, glm::vec2 const& B)
{
float const CustomEpsilon = 0.0001f;
return glm::all(glm::equal(A, B, CustomEpsilon));
}
Include
3.6.1. GLM_EXT_matrix_float2x2
25 / 55
9/3/2018
This extension exposes single-precision floating point vector with 2 columns by 2 rows: mat2x2. Include
3.6.2. GLM_EXT_matrix_float2x3
This extension exposes single-precision floating point vector with 2 columns by 3 rows: mat2x3. Include
3.6.3. GLM_EXT_matrix_float2x4
This extension exposes single-precision floating point vector with 2 columns by 4 rows: mat2x4. Include
3.6.4. GLM_EXT_matrix_float3x2
This extension exposes single-precision floating point vector with 3 columns by 2 rows: mat3x2. Include
3.6.5. GLM_EXT_matrix_float3x3
This extension exposes single-precision floating point vector with 3 columns by 3 rows: mat3x3. Include
3.6.6. GLM_EXT_matrix_float3x4
This extension exposes single-precision floating point vector with 3 columns by 4 rows: mat3x4. Include
3.6.7. GLM_EXT_matrix_float4x2
This extension exposes single-precision floating point vector with 4 columns by 2 rows: mat4x2. Include
3.6.8. GLM_EXT_matrix_float4x3
This extension exposes single-precision floating point vector with 4 columns by 3 rows: mat4x3. Include
3.6.9. GLM_EXT_matrix_float4x4
This extension exposes single-precision floating point vector with 4 columns by 4 rows: mat4x4. Include
26 / 55
9/3/2018
3.6.10. GLM_EXT_matrix_double2x2
This extension exposes double-precision floating point vector with 2 columns by 2 rows: dmat2x2. Include
3.6.11. GLM_EXT_matrix_double2x3
This extension exposes double-precision floating point vector with 2 columns by 3 rows: dmat2x3. Include
3.6.12. GLM_EXT_matrix_double2x4
This extension exposes double-precision floating point vector with 2 columns by 4 rows: dmat2x4. Include
3.6.13. GLM_EXT_matrix_double3x2
This extension exposes double-precision floating point vector with 3 columns by 2 rows: dmat3x2. Include
3.6.14. GLM_EXT_matrix_double3x3
This extension exposes double-precision floating point vector with 3 columns by 3 rows: dmat3x3. Include
3.6.15. GLM_EXT_matrix_double3x4
This extension exposes double-precision floating point vector with 3 columns by 4 rows: dmat3x4. Include
3.6.16. GLM_EXT_matrix_double4x2
This extension exposes double-precision floating point vector with 4 columns by 2 rows: dmat4x2. Include
3.6.17. GLM_EXT_matrix_double4x3
This extension exposes double-precision floating point vector with 4 columns by 3 rows: dmat4x3. Include
3.6.18. GLM_EXT_matrix_double4x4
This extension exposes double-precision floating point vector with 4 columns by 4 rows: dmat4x4.
27 / 55
9/3/2018
Include
3.7. Matrix types with precision qualifiers
3.7.1. GLM_EXT_matrix_float2x2_precision
This extension exposes single-precision floating point vector with 2 columns by 2 rows using various precision in term of ULPs: lowp_mat2x2, mediump_mat2x2 and highp_mat2x2.
Include
3.7.2. GLM_EXT_matrix_float2x3_precision
This extension exposes single-precision floating point vector with 2 columns by 3 rows using various precision in term of ULPs: lowp_mat2x3, mediump_mat2x3 and highp_mat2x3.
Include
3.7.3. GLM_EXT_matrix_float2x4_precision
This extension exposes single-precision floating point vector with 2 columns by 4 rows using various precision in term of ULPs: lowp_mat2x4, mediump_mat2x4 and highp_mat2x4.
Include
3.7.4. GLM_EXT_matrix_float3x2_precision
This extension exposes single-precision floating point vector with 3 columns by 2 rows using various precision in term of ULPs: lowp_mat3x2, mediump_mat3x2 and highp_mat3x2.
Include
3.7.5. GLM_EXT_matrix_float3x3_precision
This extension exposes single-precision floating point vector with 3 columns by 3 rows using various precision in term of ULPs: lowp_mat3x3, mediump_mat3x3 and highp_mat3x3.
Include
3.7.6. GLM_EXT_matrix_float3x4_precision
This extension exposes single-precision floating point vector with 3 columns by 4 rows using various precision in term of ULPs: lowp_mat3x4, mediump_mat3x4 and highp_mat3x4.
Include
3.7.7. GLM_EXT_matrix_float4x2_precision
This extension exposes single-precision floating point vector with 4 columns by 2 rows using various precision in term of ULPs: lowp_mat4x2, mediump_mat4x2 and highp_mat4x2.
28 / 55
9/3/2018
Include
3.7.8. GLM_EXT_matrix_float4x3_precision
This extension exposes single-precision floating point vector with 4 columns by 3 rows using various precision in term of ULPs: lowp_mat4x3, mediump_mat4x3 and highp_mat4x3.
Include
3.7.9. GLM_EXT_matrix_float4x4_precision
This extension exposes single-precision floating point vector with 4 columns by 4 rows using various precision in term of ULPs: lowp_mat4x4, mediump_mat4x4 and highp_mat4x4.
Include
3.7.10. GLM_EXT_matrix_double2x2_precision
This extension exposes double-precision floating point vector with 2 columns by 2 rows using various precision in term of ULPs: lowp_dmat2x2, mediump_dmat2x2 and highp_dmat2x2.
Include
3.7.11. GLM_EXT_matrix_double2x3_precision
This extension exposes double-precision floating point vector with 2 columns by 3 rows using various precision in term of ULPs: lowp_dmat2x3, mediump_dmat2x3 and highp_dmat2x3.
Include
3.7.12. GLM_EXT_matrix_double2x4_precision
This extension exposes double-precision floating point vector with 2 columns by 4 rows using various precision in term of ULPs: lowp_dmat2x4, mediump_dmat2x4 and highp_dmat2x4.
Include
3.7.13. GLM_EXT_matrix_double3x2_precision
This extension exposes double-precision floating point vector with 3 columns by 2 rows using various precision in term of ULPs: lowp_dmat3x2, mediump_dmat3x2 and highp_dmat3x2.
Include
3.7.14. GLM_EXT_matrix_double3x3_precision
This extension exposes double-precision floating point vector with 3 columns by 3 rows using various precision in term of ULPs: lowp_dmat3x3, mediump_dmat3x3 and highp_dmat3x3.
Include
29 / 55
9/3/2018
3.7.15. GLM_EXT_matrix_double3x4_precision
This extension exposes double-precision floating point vector with 3 columns by 4 rows using various precision in term of ULPs: lowp_dmat3x4, mediump_dmat3x4 and highp_dmat3x4.
Include
3.7.16. GLM_EXT_matrix_double4x2_precision
This extension exposes double-precision floating point vector with 4 columns by 2 rows using various precision in term of ULPs: lowp_dmat4x2, mediump_dmat4x2 and highp_dmat4x2.
Include
3.7.17. GLM_EXT_matrix_double4x3_precision
This extension exposes double-precision floating point vector with 4 columns by 3 rows using various precision in term of ULPs: lowp_dmat4x3, mediump_dmat4x3 and highp_dmat4x3.
Include
3.7.18. GLM_EXT_matrix_double4x4_precision
This extension exposes double-precision floating point vector with 4 columns by 4 rows using various precision in term of ULPs: lowp_dmat4x4, mediump_dmat4x4 and highp_dmat4x4.
Include
3.8.1. GLM_EXT_matrix_relational
This extension exposes equal and notEqual matrix variants which takes an optional epsilon argument.
#include
#include
#include
bool epsilonEqual(glm::mat4 const& A, glm::mat4 const& B)
{
float const CustomEpsilon = 0.0001f;
glm::bvec4 const ColumnEqual = glm::equal(A, B, CustomEpsilon); // Evaluation
per column
return glm::all(ColumnEqual);
}
Include
30 / 55
9/3/2018
This extension exposes matrix transformation functions: translate, rotate and scale.
#include
#include
#include
#include
glm::mat4 computeModelViewMatrix(float Translate, glm::vec2 const & Rotate)
{
glm::mat4 View = glm::translate(glm::identity(), glm::vec3(0.0f, 0.0f, –
Translate));
}
View = glm::rotate(View, Rotate.y, glm::vec3(-1.0f, 0.0f, 0.0f));
View = glm::rotate(View, Rotate.x, glm::vec3(0.0f, 1.0f, 0.0f));
glm::mat4 Model = glm::scale(glm::identity(), glm::vec3(0.5f));
return View * Model;
Include
This extension exposes functions to transform scenes into the clip space.
#include
#include
#include
glm::mat4 computeProjection(float Width, float Height)
{
}
return glm::perspective(glm::radians(45.0f), Width / Height, 0.1f, 100.f);
Include
3.8.4. GLM_EXT_matrix_projection
This extension exposes functions to map object coordinates into window coordinates and reverse Include
3.9. Quaternion types
3.9.1. GLM_EXT_quaternion_float
This extension exposes single-precision floating point quaternion: quat. Include
31 / 55
9/3/2018
3.9.2. GLM_EXT_quaternion_double
This extension exposes double-precision floating point quaternion: dquat. Include
3.10. Quaternion types with precision qualifiers
3.10.1. GLM_EXT_quaternion_float_precision
This extension exposes single-precision floating point quaternion using various precision in term of ULPs: lowp_quat, mediump_quat and highp_quat.
Include
3.10.2. GLM_EXT_quaternion_double_precision
This extension exposes double-precision floating point quaternion using various precision in term of ULPs: lowp_dquat, mediump_dquat and highp_dquat.
Include
3.11.1. GLM_EXT_quaternion_common
This extension exposes common quaternion functions such as slerp, conjugate and inverse. Include
3.11.2. GLM_EXT_quaternion_geometric
This extension exposes geometric quaternion functions such as length, normalize, dot and cross. Include
3.11.3. GLM_EXT_quaternion_trigonometric
This extension exposes trigonometric quaternion functions such as angle and axis. Include
3.11.4. GLM_EXT_quaternion_exponential
This extensions expose exponential functions for quaternions such as exp, log, pow and sqrt. Include
3.11.5. GLM_EXT_quaternion_relational
This extension exposes relational functions to compare quaternions.
32 / 55
9/3/2018
Include
3.11.6. GLM_EXT_quaternion_transform
This extension exposes functions to transform objects.
Include
33 / 55
9/3/2018
4. Recommended extensions
GLM extends the core GLSL feature set with extensions. These extensions include: quaternion, transformation, spline, matrix inverse, color spaces, etc.
To include an extension, we only need to include the dedicated header file. Once included, the features are added to the GLM namespace.
#include
#include
int foo() {
glm::vec4 Position = glm::vec4(glm:: vec3(0.0f), 1.0f);
glm::mat4 Model = glm::translate(glm::mat4(1.0f), glm::vec3(1.0f));
glm::vec4 Transformed = Model * Position;
…
return 0; }
When an extension is included, all the dependent core functionalities and extensions will be included as well.
4.1. GLM_GTC_bitfield
Fast bitfield operations on scalar and vector variables.
4.2. GLM_GTC_color_space
Conversion between linear RGB and sRGB color spaces.
4.3. GLM_GTC_constants
Provide a list of built-in constants.
4.4. GLM_GTC_epsilon
Approximate equality comparisons for floating-point numbers, possibly with a user-defined epsilon.
4.5. GLM_GTC_integer
34 / 55
9/3/2018
Integer variants of core GLM functions.
4.6. GLM_GTC_matrix_access
Functions to conveniently access the individual rows or columns of a matrix.
4.7. GLM_GTC_matrix_integer
Integer matrix types similar to the core floating-point matrices. Some operations (such as inverse and determinant) are not supported.
4.8. GLM_GTC_matrix_inverse
Additional matrix inverse functions.
4.9. GLM_GTC_matrix_transform
Matrix transformation functions that follow the OpenGL fixed-function conventions.
For example, the lookAt function generates a transformation matrix that projects world coordinates into eye coordinates suitable for projection matrices (e.g. perspective, ortho). See the OpenGL compatibility specifications for more information about
