1.0.0 API documentation
Functions

Functions

template<typename genType >
GLM_FUNC_DECL genType ceilMultiple (genType v, genType Multiple)
 Higher multiple number of Source. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > ceilMultiple (vec< L, T, Q > const &v, vec< L, T, Q > const &Multiple)
 Higher multiple number of Source. More...
 
template<typename genIUType >
GLM_FUNC_DECL genIUType ceilPowerOfTwo (genIUType v)
 Return the power of two number which value is just higher the input value, round up to a power of two. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > ceilPowerOfTwo (vec< L, T, Q > const &v)
 Return the power of two number which value is just higher the input value, round up to a power of two. More...
 
template<typename genType >
GLM_FUNC_DECL genType floorMultiple (genType v, genType Multiple)
 Lower multiple number of Source. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > floorMultiple (vec< L, T, Q > const &v, vec< L, T, Q > const &Multiple)
 Lower multiple number of Source. More...
 
template<typename genIUType >
GLM_FUNC_DECL genIUType floorPowerOfTwo (genIUType v)
 Return the power of two number which value is just lower the input value, round down to a power of two. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > floorPowerOfTwo (vec< L, T, Q > const &v)
 Return the power of two number which value is just lower the input value, round down to a power of two. More...
 
template<typename genType >
GLM_FUNC_DECL genType roundMultiple (genType v, genType Multiple)
 Lower multiple number of Source. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > roundMultiple (vec< L, T, Q > const &v, vec< L, T, Q > const &Multiple)
 Lower multiple number of Source. More...
 
template<typename genIUType >
GLM_FUNC_DECL genIUType roundPowerOfTwo (genIUType v)
 Return the power of two number which value is the closet to the input value. More...
 
template<length_t L, typename T , qualifier Q>
GLM_FUNC_DECL vec< L, T, Q > roundPowerOfTwo (vec< L, T, Q > const &v)
 Return the power of two number which value is the closet to the input value. More...
 

Detailed Description

Include <glm/gtc/round.hpp> to use the features of this extension.

Rounding value to specific boundings

Function Documentation

◆ ceilMultiple() [1/2]

GLM_FUNC_DECL genType glm::ceilMultiple ( genType  v,
genType  Multiple 
)

Higher multiple number of Source.

Template Parameters
genTypeFloating-point or integer scalar or vector types.
Parameters
vSource value to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ ceilMultiple() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::ceilMultiple ( vec< L, T, Q > const &  v,
vec< L, T, Q > const &  Multiple 
)

Higher multiple number of Source.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
Parameters
vSource values to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ ceilPowerOfTwo() [1/2]

GLM_FUNC_DECL genIUType glm::ceilPowerOfTwo ( genIUType  v)

Return the power of two number which value is just higher the input value, round up to a power of two.

See also
GLM_GTC_round

◆ ceilPowerOfTwo() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::ceilPowerOfTwo ( vec< L, T, Q > const &  v)

Return the power of two number which value is just higher the input value, round up to a power of two.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
See also
GLM_GTC_round

◆ floorMultiple() [1/2]

GLM_FUNC_DECL genType glm::floorMultiple ( genType  v,
genType  Multiple 
)

Lower multiple number of Source.

Template Parameters
genTypeFloating-point or integer scalar or vector types.
Parameters
vSource value to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ floorMultiple() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::floorMultiple ( vec< L, T, Q > const &  v,
vec< L, T, Q > const &  Multiple 
)

Lower multiple number of Source.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
Parameters
vSource values to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ floorPowerOfTwo() [1/2]

GLM_FUNC_DECL genIUType glm::floorPowerOfTwo ( genIUType  v)

Return the power of two number which value is just lower the input value, round down to a power of two.

See also
GLM_GTC_round

◆ floorPowerOfTwo() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::floorPowerOfTwo ( vec< L, T, Q > const &  v)

Return the power of two number which value is just lower the input value, round down to a power of two.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
See also
GLM_GTC_round

◆ roundMultiple() [1/2]

GLM_FUNC_DECL genType glm::roundMultiple ( genType  v,
genType  Multiple 
)

Lower multiple number of Source.

Template Parameters
genTypeFloating-point or integer scalar or vector types.
Parameters
vSource value to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ roundMultiple() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::roundMultiple ( vec< L, T, Q > const &  v,
vec< L, T, Q > const &  Multiple 
)

Lower multiple number of Source.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
Parameters
vSource values to which is applied the function
MultipleMust be a null or positive value
See also
GLM_GTC_round

◆ roundPowerOfTwo() [1/2]

GLM_FUNC_DECL genIUType glm::roundPowerOfTwo ( genIUType  v)

Return the power of two number which value is the closet to the input value.

See also
GLM_GTC_round

◆ roundPowerOfTwo() [2/2]

GLM_FUNC_DECL vec<L, T, Q> glm::roundPowerOfTwo ( vec< L, T, Q > const &  v)

Return the power of two number which value is the closet to the input value.

Template Parameters
LInteger between 1 and 4 included that qualify the dimension of the vector
TFloating-point or integer scalar types
QValue from qualifier enum
See also
GLM_GTC_round