Skip to main content

Vector3.sqrMagnitude()

Instance method on Vector3.

Description​

  • Returns the squared magnitude of this Vector3. Faster than magnitude() as it doesn't use a square root; useful for comparing distances. |

Method Signature​

sqrMagnitude()

Mathematical Definition​

Component-wise or runtime-defined transformation based on overload.

Parameters​

  • None.

Returns​

  • float: returned by overloads of this method.

Mutability​

  • Does not modify the current vector unless explicitly using a Local/Equal variant.

Edge Cases​

  • Zero vectors can produce degenerate outputs for geometric methods.
  • NaN and Infinity inputs propagate according to IEEE-754 floating-point behavior.
  • Repeated operations may accumulate floating-point precision error.

Usage Example​

Vector3 a = new Vector3(1f, 2f, 3f);
// Call the method according to your overload requirements.
// Example:
// a.sqrMagnitude(...);

Mathematical Example​

Example input/output depends on overload; for vector arithmetic operations this is typically computed per-component.

Visualization​