Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Mathf

Description

A collection of common math functions.

Static Variables

Deg2RadDegrees-to-radians conversion constant (Read Only).
EpsilonA tiny floating point value (Read Only).
InfinityA representation of positive infinity (Read Only).
NegativeInfinityA representation of negative infinity (Read Only).
PIThe infamous 3.14159265358979... value (Read Only).
Rad2DegRadians-to-degrees conversion constant (Read Only).

Static Functions

AbsReturns the absolute value of f.
AcosReturns the arc-cosine of f - the angle in radians whose cosine is f.
ApproximatelyCompares two floating point values if they are similar.
AsinReturns the arc-sine of f - the angle in radians whose sine is f.
AtanReturns the arc-tangent of f - the angle in radians whose tangent is f.
Atan2Returns the angle in radians whose Tan is y/x.
CeilReturns the smallest integer greater to or equal to f.
CeilToIntReturns the smallest integer greater to or equal to f.
ClampClamps a value between a minimum float and maximum float value.
Clamp01Clamps value between 0 and 1 and returns value.
ClosestPowerOfTwoReturns the closest power of two value.
CosReturns the cosine of angle f in radians.
DeltaAngleCalculates the shortest difference between two given angles.
ExpReturns e raised to the specified power.
FloorReturns the largest integer smaller to or equal to f.
FloorToIntReturns the largest integer smaller to or equal to f.
GammaToLinearSpaceConverts the given value from gamma to linear color space.
InverseLerpCalculates the Lerp parameter between of two values.
IsPowerOfTwoReturns true if the value is power of two.
LerpInterpolates between a and b by t. t is clamped between 0 and 1.
LerpAngleSame as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
LinearToGammaSpaceConverts the given value from linear to gamma color space.
LogReturns the logarithm of a specified number in a specified base.
Log10Returns the base 10 logarithm of a specified number.
MaxReturns largest of two or more values.
MinReturns the smallest of two or more values.
MoveTowardsMoves a value current towards target.
MoveTowardsAngleSame as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
NextPowerOfTwoReturns the next power of two value.
PerlinNoiseGenerate 2D Perlin noise.
PingPongPingPongs the value t, so that it is never larger than length and never smaller than 0.
PowReturns f raised to power p.
RepeatLoops the value t, so that it is never larger than length and never smaller than 0.
RoundReturns f rounded to the nearest integer.
RoundToIntReturns f rounded to the nearest integer.
SignReturns the sign of f.
SinReturns the sine of angle f in radians.
SmoothDampGradually changes a value towards a desired goal over time.
SmoothDampAngleGradually changes an angle given in degrees towards a desired goal angle over time.
SmoothStepInterpolates between min and max with smoothing at the limits.
SqrtReturns square root of f.
TanReturns the tangent of angle f in radians.