fennec-org/fennec
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Fixed Documentation for Consistency

Browse Source 
- Added more documentation, predominantly in the Math Library
This commit is contained in:
Medusa Slockbower
2025-06-16 01:48:31 -04:00
parent 096e82f47a
commit db7d52c86c
28 changed files with 861 additions and 538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

176
include/fennec/math/common.h
View File

@@ -18,7 +18,7 @@
///
/// \file common.h
/// \brief \ref page_fennec_math_common
/// \brief \ref fennec_math_common
///
///
/// \details
@@ -36,7 +36,7 @@
///
///
///
/// \page page_fennec_math_common Common
/// \page fennec_math_common Common
///
/// \brief The Common Functions defined in the [OpenGL 4.6 Shading Language Specification](https://registry.khronos.org/OpenGL/specs/gl/GLSLangSpec.4.60.pdf).
///
@@ -49,17 +49,17 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::abs(fennec::genType) "genIType abs(genIType)" <br>
/// \ref fennec::abs(fennec::genType) "genFType abs(genFType)" <br>
/// \ref fennec::abs(fennec::genType) "genDType abs(genDType)"
/// \ref fennec::abs(fennec::genType) "genIType abs(genIType x)" <br>
/// \ref fennec::abs(fennec::genType) "genFType abs(genFType x)" <br>
/// \ref fennec::abs(fennec::genType) "genDType abs(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::abs(fennec::genType)
///
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::sign(fennec::genType) "genIType sign(genIType)" <br>
/// \ref fennec::sign(fennec::genType) "genFType sign(genFType)" <br>
/// \ref fennec::sign(fennec::genType) "genDType sign(genDType)"
/// \ref fennec::sign(fennec::genType) "genIType sign(genIType x)" <br>
/// \ref fennec::sign(fennec::genType) "genFType sign(genFType x)" <br>
/// \ref fennec::sign(fennec::genType) "genDType sign(genDType x)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::sign(fennec::genType)
///
@@ -73,36 +73,36 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::floor(fennec::genType) "genFType floor(genFType)" <br>
/// \ref fennec::floor(fennec::genType) "genDType floor(genDType)"
/// \ref fennec::floor(fennec::genType) "genFType floor(genFType x)" <br>
/// \ref fennec::floor(fennec::genType) "genDType floor(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::floor(fennec::genType)
///
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::ceil(fennec::genType) "genFType ceil(genFType)" <br>
/// \ref fennec::ceil(fennec::genType) "genDType ceil(genDType)"
/// \ref fennec::ceil(fennec::genType) "genFType ceil(genFType x)" <br>
/// \ref fennec::ceil(fennec::genType) "genDType ceil(genDType x)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::ceil(fennec::genType)
///
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::round(fennec::genType) "genFType round(genFType)" <br>
/// \ref fennec::round(fennec::genType) "genDType round(genDType)"
/// \ref fennec::round(fennec::genType) "genFType round(genFType x)" <br>
/// \ref fennec::round(fennec::genType) "genDType round(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::round(fennec::genType)
///
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::roundEven(fennec::genType) "genFType roundEven(genFType)" <br>
/// \ref fennec::roundEven(fennec::genType) "genDType roundEven(genDType)"
/// \ref fennec::roundEven(fennec::genType) "genFType roundEven(genFType x)" <br>
/// \ref fennec::roundEven(fennec::genType) "genDType roundEven(genDType x)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::roundEven(fennec::genType)
///
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::trunc(fennec::genType) "genFType trunc(genFType)" <br>
/// \ref fennec::trunc(fennec::genType) "genDType trunc(genDType)"
/// \ref fennec::trunc(fennec::genType) "genFType trunc(genFType x)" <br>
/// \ref fennec::trunc(fennec::genType) "genDType trunc(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::trunc(fennec::genType)
///
@@ -116,46 +116,46 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::fract(fennec::genType) "genFType fract(genFType)" <br>
/// \ref fennec::fract(fennec::genType) "genDType fract(genDType)"
/// \ref fennec::fract(fennec::genType) "genFType fract(genFType x)" <br>
/// \ref fennec::fract(fennec::genType) "genDType fract(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::fract(fennec::genType)
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::mod(fennec::genType, fennec::genType) "genFType mod(genFType, float)" <br>
/// \ref fennec::mod(fennec::genType, fennec::genType) "genFType mod(genFType, genFType)" <br>
/// \ref fennec::mod(fennec::genType, fennec::genType) "genDType mod(genDType, double)" <br>
/// \ref fennec::mod(fennec::genType, fennec::genType) "genDType mod(genDType, genDType)"
/// \ref fennec::mod "genFType mod(genFType x, float y)" <br>
/// \ref fennec::mod "genFType mod(genFType x, genFType y)" <br>
/// \ref fennec::mod "genDType mod(genDType x, double y)" <br>
/// \ref fennec::mod "genDType mod(genDType x, genDType y)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::mod(fennec::genType, fennec::genType)
/// \copydetails fennec::mod
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::modf(fennec::genType, fennec::genType&) "genFType modf(genFType, out genFType)" <br>
/// \ref fennec::modf(fennec::genType, fennec::genType&) "genDType modf(genDType, out genDType)"
/// \ref fennec::modf(fennec::genType, fennec::genType&) "genFType modf(genFType x, out genFType i)" <br>
/// \ref fennec::modf(fennec::genType, fennec::genType&) "genDType modf(genDType x, out genDType i)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::modf(fennec::genType, fennec::genType&)
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::isnan(fennec::genType) "genBType isnan(genFType)" <br>
/// \ref fennec::isnan(fennec::genType) "genBType isnan(genDType)"
/// \ref fennec::isnan(fennec::genType) "genBType isnan(genFType x)" <br>
/// \ref fennec::isnan(fennec::genType) "genBType isnan(genDType x)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::isnan(fennec::genType)
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::isinf(fennec::genType) "genBType isinf(genFType)" <br>
/// \ref fennec::isinf(fennec::genType) "genBType isinf(genDType)"
/// \ref fennec::isinf(fennec::genType) "genBType isinf(genFType x)" <br>
/// \ref fennec::isinf(fennec::genType) "genBType isinf(genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::isinf(fennec::genType)
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::frexp(fennec::genType, fennec::genIType&) "genFType frexp(genFType, out genIType)" <br>
/// \ref fennec::frexp(fennec::genType, fennec::genIType&) "genDType frexp(genDType, out genIType)"
/// \ref fennec::frexp(fennec::genType, fennec::genIType&) "genFType frexp(genFType x, out genIType exp)" <br>
/// \ref fennec::frexp(fennec::genType, fennec::genIType&) "genDType frexp(genDType x, out genIType exp)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::frexp(fennec::genType, fennec::genIType&)
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::ldexp(fennec::genType, fennec::genIType) "genFType ldexp(genFType, genIType)" <br>
/// \ref fennec::ldexp(fennec::genType, fennec::genIType) "genDType ldexp(genDType, genIType)"
/// \ref fennec::ldexp(fennec::genType, fennec::genIType) "genFType ldexp(genFType x, genIType exp)" <br>
/// \ref fennec::ldexp(fennec::genType, fennec::genIType) "genDType ldexp(genDType x, genIType exp)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::ldexp(fennec::genType, fennec::genIType)
///
@@ -169,14 +169,14 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::floatBitsToInt(fennec::genType) "genIType floatBitsToInt(genType)" <br>
/// \ref fennec::floatBitsToUint(fennec::genType) "genUType floatBitsToUint(genType)"
/// \ref fennec::floatBitsToInt(fennec::genType) "genIType floatBitsToInt(genType value)" <br>
/// \ref fennec::floatBitsToUint(fennec::genType) "genUType floatBitsToUint(genType value)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::floatBitsToUint(fennec::genType)
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::intBitsToFloat(fennec::genIType) "genFType intBitsToFloat(genIType)" <br>
/// \ref fennec::uintBitsToFloat(fennec::genUType) "genFType uintBitsToFloat(genUType)"
/// \ref fennec::intBitsToFloat(fennec::genIType) "genFType intBitsToFloat(genIType value)" <br>
/// \ref fennec::uintBitsToFloat(fennec::genUType) "genFType uintBitsToFloat(genUType value)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::uintBitsToFloat(fennec::genType)
///
@@ -190,40 +190,40 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genFType min(genFType, float)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genFType min(genFType, genFType)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genDType min(genDType, double)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genDType min(genDType, genDType)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genIType min(genDType, int)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genIType min(genIType, genIType)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genUType min(genUType, uint)" <br>
/// \ref fennec::min(fennec::genType, fennec::genType) "genUType min(genUType, genUType)"
/// \ref fennec::min "genFType min(genFType x, float y)" <br>
/// \ref fennec::min "genFType min(genFType x, genFType y)" <br>
/// \ref fennec::min "genDType min(genDType x, double y)" <br>
/// \ref fennec::min "genDType min(genDType x, genDType y)" <br>
/// \ref fennec::min "genIType min(genDType x, int y)" <br>
/// \ref fennec::min "genIType min(genIType x, genIType y)" <br>
/// \ref fennec::min "genUType min(genUType x, uint y)" <br>
/// \ref fennec::min "genUType min(genUType x, genUType y)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::min(fennec::genType, fennec::genType)
/// \copydetails fennec::min
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genFType max(genFType, float)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genFType max(genFType, genFType)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genDType max(genDType, double)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genDType max(genDType, genDType)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genIType max(genDType, int)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genIType max(genIType, genIType)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genUType max(genUType, uint)" <br>
/// \ref fennec::max(fennec::genType, fennec::genType) "genUType max(genUType, genUType)"
/// \ref fennec::max "genFType max(genFType x, float y)" <br>
/// \ref fennec::max "genFType max(genFType x, genFType y)" <br>
/// \ref fennec::max "genDType max(genDType x, double y)" <br>
/// \ref fennec::max "genDType max(genDType x, genDType y)" <br>
/// \ref fennec::max "genIType max(genDType x, int y)" <br>
/// \ref fennec::max "genIType max(genIType x, genIType y)" <br>
/// \ref fennec::max "genUType max(genUType x, uint y)" <br>
/// \ref fennec::max "genUType max(genUType x, genUType y)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::max(fennec::genType, fennec::genType)
/// \copydetails fennec::max
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genFType clamp(genFType, float, float)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genFType clamp(genFType, genFType, genFType)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genDType clamp(genDType, double, double)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genDType clamp(genDType, genDType, genDType)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genIType clamp(genDType, int, int)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genIType clamp(genIType, genIType, genIType)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genUType clamp(genUType(genUType, uint)" <br>
/// \ref fennec::clamp(fennec::genType, fennec::genType, fennec::genType) "genUType clamp(genUType, genUType, genUType)"
/// \ref fennec::clamp "genFType clamp(genFType x, float minVal, float maxVal)" <br>
/// \ref fennec::clamp "genFType clamp(genFType x, genFType minVal, genFType maxVal)" <br>
/// \ref fennec::clamp "genDType clamp(genDType x, double minVal, double maxVal)" <br>
/// \ref fennec::clamp "genDType clamp(genDType x, genDType minVal, genDType maxVal)" <br>
/// \ref fennec::clamp "genIType clamp(genDType x, int minVal, int maxVal)" <br>
/// \ref fennec::clamp "genIType clamp(genIType x, genIType minVal, genIType maxVal)" <br>
/// \ref fennec::clamp "genUType clamp(genUType x, genUType minVal, uint maxVal)" <br>
/// \ref fennec::clamp "genUType clamp(genUType x, genUType minVal, genUType maxVal)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::clamp(fennec::genType, fennec::genType, fennec::genType)
/// \copydetails fennec::clamp
///
/// </table>
///
@@ -235,37 +235,37 @@
/// <th style="vertical-align: top">Description
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::step(fennec::genType, fennec::genType) "step(float, genFType)" <br>
/// \ref fennec::step(fennec::genType, fennec::genType) "step(genFType, genFType)" <br>
/// \ref fennec::step(fennec::genType, fennec::genType) "step(double, genDType)" <br>
/// \ref fennec::step(fennec::genType, fennec::genType) "step(genFType, genDType)"
/// \ref fennec::step "step(float edge, genFType x)" <br>
/// \ref fennec::step "step(genFType edge, genFType x)" <br>
/// \ref fennec::step "step(double edge, genDType x)" <br>
/// \ref fennec::step "step(genFType edge, genDType x)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::step(fennec::genType, fennec::genType)
/// \copydetails fennec::step
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::smoothstep(fennec::genType, fennec::genType, fennec::genType) "smoothstep(float, float, genFType)" <br>
/// \ref fennec::smoothstep(fennec::genType, fennec::genType, fennec::genType) "smoothstep(genFType, genFType, genFType)" <br>
/// \ref fennec::smoothstep(fennec::genType, fennec::genType, fennec::genType) "smoothstep(double, double, genDType)" <br>
/// \ref fennec::smoothstep(fennec::genType, fennec::genType, fennec::genType) "smoothstep(genFType, genFType, genDType)"
/// \ref fennec::smoothstep "smoothstep(float edge0, float edge1, genFType x)" <br>
/// \ref fennec::smoothstep "smoothstep(genFType edge0, genFType edge1, genFType x)" <br>
/// \ref fennec::smoothstep "smoothstep(double edge0, double edge1, genDType x)" <br>
/// \ref fennec::smoothstep "smoothstep(genFType edge0, genFType edge1, genDType x)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::smoothstep(fennec::genType, fennec::genType, fennec::genType)
/// \copydetails fennec::smoothstep
///
/// <tr><td width="50%" style="vertical-align: top"> <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genType) "mix(genFType, genFType, float)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genType) "mix(genFType, genFType, genFType)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genType) "mix(genDType, genDType, double)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genType) "mix(genDType, genDType, genDType)"
/// \ref fennec::mix "mix(genFType x, genFType y, float a)" <br>
/// \ref fennec::mix "mix(genFType x, genFType y, genFType a)" <br>
/// \ref fennec::mix "mix(genDType x, genDType y, double a)" <br>
/// \ref fennec::mix "mix(genDType x, genDType y, genDType a)"
/// <td width="50%" style="vertical-align: top">
/// \copydetails fennec::mix(fennec::genType, fennec::genType, fennec::genType)
/// \copydetails fennec::mix
///
/// <tr><td width="50%" style="vertical-align: top" class="odd_c"> <br>
/// \ref fennec::mix(fennec::genBType, fennec::genBType, fennec::genBType) "mix(genBType, genBType, genBType)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genIType, genIType, genBType)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genUType, genUType, genBType)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genFType, genFType, genBType)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genDType, genDType, genBType)"
/// \ref fennec::mix(fennec::genBType, fennec::genBType, fennec::genBType) "mix(genBType x, genBType y, genBType a)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genIType x, genIType y, genBType a)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genUType x, genUType y, genBType a)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genFType x, genFType y, genBType a)" <br>
/// \ref fennec::mix(fennec::genType, fennec::genType, fennec::genBType) "mix(genDType x, genDType y, genBType a)"
/// <td width="50%" style="vertical-align: top" class="odd_c">
/// \copydetails fennec::mix(fennec::genType, fennec::genType, fennec::genType)
/// \copydetails fennec::mix
///
/// </table>
///
@@ -332,7 +332,7 @@ template<typename genType, size_t...i>
constexpr vector<genType, i...> sign(const vector<genType, i...>& x)
{ return vector<genType, i...>(fennec::sign(x[i]) ...); }
// @}
/// @}