1.0.0 API documentation: GLM_GTC_constants

| 1.0.0 API documentation

Functions
GLM_GTC_constants
Recommended extensions

## Functions
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | e ()
| Return e constant. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | euler ()
| Return Euler's constant. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | four_over_pi ()
| Return 4 / pi. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | golden_ratio ()
| Return the golden ratio constant. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | half_pi ()
| Return pi / 2. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | ln_ln_two ()
| Return ln(ln(2)). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | ln_ten ()
| Return ln(10). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | ln_two ()
| Return ln(2). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | one ()
| Return 1. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | one_over_pi ()
| Return 1 / pi. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | one_over_root_two ()
| Return 1 / sqrt(2). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | one_over_two_pi ()
| Return 1 / (pi * 2). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | quarter_pi ()
| Return pi / 4. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_five ()
| Return sqrt(5). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_half_pi ()
| Return sqrt(pi / 2). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_ln_four ()
| Return sqrt(ln(4)). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_pi ()
| Return square root of pi. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_three ()
| Return sqrt(3). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_two ()
| Return sqrt(2). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | root_two_pi ()
| Return sqrt(2 * pi). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | tau ()
| Return unit-circle circumference, or pi * 2. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | third ()
| Return 1 / 3. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | three_over_two_pi ()
| Return pi / 2 * 3. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | two_over_pi ()
| Return 2 / pi. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | two_over_root_pi ()
| Return 2 / sqrt(pi). More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | two_pi ()
| Return pi * 2. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | two_thirds ()
| Return 2 / 3. More...
template<typename genType >
GLM_FUNC_DECL GLM_CONSTEXPR genType | zero ()
| Return 0. More...

## Detailed Description

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

Provide a list of constants and precomputed useful values.

## Function Documentation

## ◆ e()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::e | ( |  | ) |

Return e constant.

See also
  GLM_GTC_constants

## ◆ euler()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::euler | ( |  | ) |

Return Euler's constant.

See also
  GLM_GTC_constants

## ◆ four_over_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::four_over_pi | ( |  | ) |

Return 4 / pi.

See also
  GLM_GTC_constants

## ◆ golden_ratio()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::golden_ratio | ( |  | ) |

Return the golden ratio constant.

See also
  GLM_GTC_constants

## ◆ half_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::half_pi | ( |  | ) |

Return pi / 2.

See also
  GLM_GTC_constants

## ◆ ln_ln_two()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::ln_ln_two | ( |  | ) |

Return ln(ln(2)).

See also
  GLM_GTC_constants

## ◆ ln_ten()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::ln_ten | ( |  | ) |

Return ln(10).

See also
  GLM_GTC_constants

## ◆ ln_two()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::ln_two | ( |  | ) |

Return ln(2).

See also
  GLM_GTC_constants

## ◆ one()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::one | ( |  | ) |

Return 1.

See also
  GLM_GTC_constants

## ◆ one_over_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::one_over_pi | ( |  | ) |

Return 1 / pi.

See also
  GLM_GTC_constants

## ◆ one_over_root_two()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::one_over_root_two | ( |  | ) |

Return 1 / sqrt(2).

See also
  GLM_GTC_constants

## ◆ one_over_two_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::one_over_two_pi | ( |  | ) |

Return 1 / (pi * 2).

See also
  GLM_GTC_constants

## ◆ quarter_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::quarter_pi | ( |  | ) |

Return pi / 4.

See also
  GLM_GTC_constants

## ◆ root_five()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_five | ( |  | ) |

Return sqrt(5).

See also
  GLM_GTC_constants

## ◆ root_half_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_half_pi | ( |  | ) |

Return sqrt(pi / 2).

See also
  GLM_GTC_constants

## ◆ root_ln_four()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_ln_four | ( |  | ) |

Return sqrt(ln(4)).

See also
  GLM_GTC_constants

## ◆ root_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_pi | ( |  | ) |

Return square root of pi.

See also
  GLM_GTC_constants

## ◆ root_three()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_three | ( |  | ) |

Return sqrt(3).

See also
  GLM_GTC_constants

## ◆ root_two()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_two | ( |  | ) |

Return sqrt(2).

See also
  GLM_GTC_constants

## ◆ root_two_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::root_two_pi | ( |  | ) |

Return sqrt(2 * pi).

See also
  GLM_GTC_constants

## ◆ tau()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::tau | ( |  | ) |

Return unit-circle circumference, or pi * 2.

See also
  GLM_GTC_constants

## ◆ third()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::third | ( |  | ) |

Return 1 / 3.

See also
  GLM_GTC_constants

## ◆ three_over_two_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::three_over_two_pi | ( |  | ) |

Return pi / 2 * 3.

See also
  GLM_GTC_constants

## ◆ two_over_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::two_over_pi | ( |  | ) |

Return 2 / pi.

See also
  GLM_GTC_constants

## ◆ two_over_root_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::two_over_root_pi | ( |  | ) |

Return 2 / sqrt(pi).

See also
  GLM_GTC_constants

## ◆ two_pi()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::two_pi | ( |  | ) |

Return pi * 2.

See also
  GLM_GTC_constants

## ◆ two_thirds()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::two_thirds | ( |  | ) |

Return 2 / 3.

See also
  GLM_GTC_constants

## ◆ zero()

GLM_FUNC_DECL GLM_CONSTEXPR genType glm::zero | ( |  | ) |

Return 0.

See also
  GLM_GTC_constants