FlukyEngine
Functions
Vector Relational Functions

Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results. More...

Collaboration diagram for Vector Relational Functions:

Functions

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::lessThan (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison result of x < y. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::lessThanEqual (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison of result x <= y. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::greaterThan (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison of result x > y. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::greaterThanEqual (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison of result x >= y. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::equal (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison of result x == y. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::notEqual (vec< L, T, Q > const &x, vec< L, T, Q > const &y)
 Returns the component-wise comparison of result x != y. More...
 
template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR bool glm::any (vec< L, bool, Q > const &v)
 Returns true if any component of x is true. More...
 
template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR bool glm::all (vec< L, bool, Q > const &v)
 Returns true if all components of x are true. More...
 
template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec< L, bool, Q > glm::not_ (vec< L, bool, Q > const &v)
 Returns the component-wise logical complement of x. More...
 

Detailed Description

Relational and equality operators (<, <=, >, >=, ==, !=) are defined to operate on scalars and produce scalar Boolean results.

For vector results, use the following built-in functions.

In all cases, the sizes of all the input and return vectors for any particular call must match.

Include <glm/vector_relational.hpp> to use these core features.

See also
GLM_EXT_vector_relational

Function Documentation

◆ all()

template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR bool glm::all ( vec< L, bool, Q > const &  v)

Returns true if all components of x are true.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
See also
GLSL all man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ any()

template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR bool glm::any ( vec< L, bool, Q > const &  v)

Returns true if any component of x is true.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
See also
GLSL any man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ equal()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::equal ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison of result x == y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point, integer or bool scalar type.
See also
GLSL equal man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ greaterThan()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::greaterThan ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison of result x > y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point or integer scalar type.
See also
GLSL greaterThan man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ greaterThanEqual()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::greaterThanEqual ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison of result x >= y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point or integer scalar type.
See also
GLSL greaterThanEqual man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ lessThan()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::lessThan ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison result of x < y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point or integer scalar type.
See also
GLSL lessThan man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ lessThanEqual()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::lessThanEqual ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison of result x <= y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point or integer scalar type.
See also
GLSL lessThanEqual man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ not_()

template<length_t L, qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::not_ ( vec< L, bool, Q > const &  v)

Returns the component-wise logical complement of x.

/!\ Because of language incompatibilities between C++ and GLSL, GLM defines the function not but not_ instead.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
See also
GLSL not man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions

◆ notEqual()

template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL GLM_CONSTEXPR vec<L, bool, Q> glm::notEqual ( vec< L, T, Q > const &  x,
vec< L, T, Q > const &  y 
)

Returns the component-wise comparison of result x != y.

Template Parameters
LAn integer between 1 and 4 included that qualify the dimension of the vector.
TA floating-point, integer or bool scalar type.
See also
GLSL notEqual man page
GLSL 4.20.8 specification, section 8.7 Vector Relational Functions