README.md

Function Reference

This is where you will find a reference of all the functions that PyGLM provides.

Most functions are overloaded, i.e. they accept more than one type of argument and may or may not behave differently depending on the type of argument(s).
Where possible, I tried to compromise between exactness and readability of the supported data types.
Therefore there are some types that are placeholders for others.
Here are a few examples:

Name	Description
number	Can be (any) numerical type, usually float or int.
vecN	Can be any or most of the available vector types of any length.
vec3	Can be any or most of the available vector types of length 3.
fvecN	A float vector of any length.
matNxM	Can be any or most of the available matrix types of any shape.
matSxS	Can be any or most of the available matrix types of square shape.
quat	Any type of quaternion.

If different combinations of input arguments are possible, multiple ways to call a particular function are presented.

Example:

glm.abs(x: float) -> float

  Returns x if x >= 0; otherwise it returns -x.

glm.abs(x: vecN) -> vecN

  For each component c of x,
  Returns c if c >= 0; otherwise it returns -c.

This means that you can call the glm.abs function with a float "x" and it will return a float value
(as you can tell by the -> float), or you can call it with a vector, e.g. a vec3 and get a vector (vec3 in this case) back.

Table of Contents

• detail
  • func_common methods
    • abs function
    • ceil function
    • clamp function
    • floatBitsToInt function
    • floatBitsToUint function
    • floor function
    • fma function
    • fmax function
    • fmin function
    • fract function
    • frexp function
    • intBitsToFloat function
    • isinf function
    • isnan function
    • ldexp function
    • max function
    • min function
    • mix function
    • mod function
    • modf function
    • round function
    • roundEven function
    • sign function
    • smoothstep function
    • step function
    • trunc function
    • uintBitsToFloat function
  • func_exponential methods
    • exp function
    • exp2 function
    • inversesqrt function
    • log function
    • log2 function
    • pow function
    • sqrt function
  • func_geometric methods
    • cross function
    • distance function
    • dot function
    • faceforward function
    • length function
    • normalize function
    • reflect function
    • refract function
  • func_integer methods
    • bitCount function
    • bitfieldExtract function
    • bitfieldInsert function
    • bitfieldReverse function
    • findLSB function
    • findMSB function
    • imulExtended function
    • uaddCarry function
    • umulExtended function
    • usubBorrow function
  • func_matrix methods
    • determinant function
    • inverse function
    • matrixCompMult function
    • outerProduct function
    • transpose function
  • func_packing methods
    • packDouble2x32 function
    • packHalf2x16 function
    • packSnorm2x16 function
    • packSnorm4x8 function
    • packUnorm2x16 function
    • packUnorm4x8 function
    • unpackDouble2x32 function
    • unpackHalf2x16 function
    • unpackSnorm2x16 function
    • unpackSnorm4x8 function
    • unpackUnorm2x16 function
    • unpackUnorm4x8 function
  • func_trigonometric methods
    • acos function
    • acosh function
    • asin function
    • asinh function
    • atan function
    • atanh function
    • cos function
    • cosh function
    • degrees function
    • radians function
    • sin function
    • sinh function
    • tan function
    • tanh function
  • func_vector_relational methods
    • all function
    • any function
    • equal function
    • greaterThan function
    • greaterThanEqual function
    • lessThan function
    • lessThanEqual function
    • notEqual function
    • not_ function
• recommended_extensions
  • color_space methods
    • convertLinearToSRGB function
    • convertSRGBToLinear function
  • constants methods
    • e function
    • epsilon function
    • euler function
    • four_over_pi function
    • golden_ratio function
    • half_pi function
    • ln_ln_two function
    • ln_ten function
    • ln_two function
    • one function
    • one_over_pi function
    • one_over_root_two function
    • one_over_two_pi function
    • pi function
    • quarter_pi function
    • root_five function
    • root_half_pi function
    • root_ln_four function
    • root_pi function
    • root_three function
    • root_two function
    • root_two_pi function
    • third function
    • three_over_two_pi function
    • two_over_pi function
    • two_over_root_pi function
    • two_pi function
    • two_thirds function
    • zero function
  • epsilon methods
    • epsilonEqual function
    • epsilonNotEqual function
  • integer methods
    • iround function
    • uround function
  • matrix_access methods
    • column function
    • row function
  • matrix_inverse methods
    • affineInverse function
    • inverseTranspose function
  • noise methods
    • perlin function
    • simplex function
  • packing methods
    • packF2x11_1x10 function
    • packF3x9_E1x5 function
    • packHalf function
    • packHalf1x16 function
    • packHalf4x16 function
    • packI3x10_1x2 function
    • packInt2x16 function
    • packInt2x32 function
    • packInt2x8 function
    • packInt4x16 function
    • packInt4x8 function
    • packRGBM function
    • packSnorm function
    • packSnorm1x16 function
    • packSnorm1x8 function
    • packSnorm2x8 function
    • packSnorm3x10_1x2 function
    • packSnorm4x16 function
    • packU3x10_1x2 function
    • packUint2x16 function
    • packUint2x32 function
    • packUint2x8 function
    • packUint4x16 function
    • packUint4x8 function
    • packUnorm function
    • packUnorm1x16 function
    • packUnorm1x5_1x6_1x5 function
    • packUnorm1x8 function
    • packUnorm2x3_1x2 function
    • packUnorm2x4 function
    • packUnorm2x8 function
    • packUnorm3x10_1x2 function
    • packUnorm3x5_1x1 function
    • packUnorm4x16 function
    • packUnorm4x4 function
    • unpackF2x11_1x10 function
    • unpackF3x9_E1x5 function
    • unpackHalf function
    • unpackHalf1x16 function
    • unpackHalf4x16 function
    • unpackI3x10_1x2 function
    • unpackInt2x16 function
    • unpackInt2x32 function
    • unpackInt2x8 function
    • unpackInt4x16 function
    • unpackInt4x8 function
    • unpackRGBM function
    • unpackSnorm function
    • unpackSnorm1x16 function
    • unpackSnorm1x8 function
    • unpackSnorm2x8 function
    • unpackSnorm3x10_1x2 function
    • unpackSnorm4x16 function
    • unpackU3x10_1x2 function
    • unpackUint2x16 function
    • unpackUint2x32 function
    • unpackUint2x8 function
    • unpackUint4x16 function
    • unpackUint4x8 function
    • unpackUnorm function
    • unpackUnorm1x16 function
    • unpackUnorm1x5_1x6_1x5 function
    • unpackUnorm1x8 function
    • unpackUnorm2x3_1x2 function
    • unpackUnorm2x4 function
    • unpackUnorm2x8 function
    • unpackUnorm3x10_1x2 function
    • unpackUnorm3x5_1x1 function
    • unpackUnorm4x16 function
    • unpackUnorm4x4 function
  • quaternion methods
    • eulerAngles function
    • mat3_cast function
    • mat4_cast function
    • pitch function
    • quatLookAt function
    • quatLookAtLH function
    • quatLookAtRH function
    • quat_cast function
    • roll function
    • yaw function
  • random methods
    • ballRand function
    • circularRand function
    • diskRand function
    • gaussRand function
    • linearRand function
    • setSeed function
    • sphericalRand function
  • reciprocal methods
    • acot function
    • acoth function
    • acsc function
    • acsch function
    • asec function
    • asech function
    • cot function
    • coth function
    • csc function
    • csch function
    • sec function
    • sech function
  • round methods
    • ceilMultiple function
    • ceilPowerOfTwo function
    • floorMultiple function
    • floorPowerOfTwo function
    • roundMultiple function
    • roundPowerOfTwo function
  • type_ptr methods
    • make_mat2 function
    • make_mat2x2 function
    • make_mat2x3 function
    • make_mat2x4 function
    • make_mat3 function
    • make_mat3x2 function
    • make_mat3x3 function
    • make_mat3x4 function
    • make_mat4 function
    • make_mat4x2 function
    • make_mat4x3 function
    • make_mat4x4 function
    • make_quat function
    • make_vec2 function
    • make_vec3 function
    • make_vec4 function
    • sizeof function
    • value_ptr function
  • ulp methods
    • float_distance function
    • next_float function
    • prev_float function
• stable_extensions
  • matrix_clip_space methods
    • frustum function
    • frustumLH function
    • frustumLH_NO function
    • frustumLH_ZO function
    • frustumNO function
    • frustumRH function
    • frustumRH_NO function
    • frustumRH_ZO function
    • frustumZO function
    • infinitePerspective function
    • infinitePerspectiveLH function
    • infinitePerspectiveRH function
    • ortho function
    • orthoLH function
    • orthoLH_NO function
    • orthoLH_ZO function
    • orthoNO function
    • orthoRH function
    • orthoRH_NO function
    • orthoRH_ZO function
    • orthoZO function
    • perspective function
    • perspectiveFov function
    • perspectiveFovLH function
    • perspectiveFovLH_NO function
    • perspectiveFovLH_ZO function
    • perspectiveFovNO function
    • perspectiveFovRH function
    • perspectiveFovRH_NO function
    • perspectiveFovRH_ZO function
    • perspectiveFovZO function
    • perspectiveLH function
    • perspectiveLH_NO function
    • perspectiveLH_ZO function
    • perspectiveNO function
    • perspectiveRH function
    • perspectiveRH_NO function
    • perspectiveRH_ZO function
    • perspectiveZO function
    • tweakedInfinitePerspective function
  • matrix_projection methods
    • pickMatrix function
    • project function
    • projectNO function
    • projectZO function
    • unProject function
    • unProjectNO function
    • unProjectZO function
  • matrix_transform methods
    • identity function
    • lookAt function
    • lookAtLH function
    • lookAtRH function
    • rotate function
    • rotate_slow function
    • scale function
    • scale_slow function
    • translate function
  • quaternion_common methods
    • conjugate function
    • lerp function
    • slerp function
  • quaternion_trigonometric methods
    • angle function
    • angleAxis function
    • axis function
  • compatibility methods
    • atan2 function
    • isfinite function
    • lerp function
    • saturate function
• unstable_extensions
  • decompose methods
    • decompose function
  • norm methods
    • distance2 function
    • l1Norm function
    • l2Norm function
    • lMaxNorm function
    • length2 function
    • lxNorm function
  • polar_coordinates methods
    • euclidean function
    • polar function
  • matrix_transform_2d methods
    • rotate function
    • scale function
    • shearX function
    • shearY function
    • translate function
  • rotate_vector methods
    • orientation function
    • rotate function
    • rotateX function
    • rotateY function
    • rotateZ function
    • slerp function
• other
  • other methods
    • add function
    • and_ function
    • cmp function
    • div function
    • floordiv function
    • if_else function
    • inv function
    • lshift function
    • mul function
    • neg function
    • or_ function
    • pos function
    • quat_to_vec4 function
    • rshift function
    • silence function
    • sub function
    • vec4_to_quat function
    • xor function