Vector3 Struct

Definition

Represents a vector with three single-precision floating-point values.

public struct Vector3 : IEquatable<System.Numerics.Vector3>, IFormattable
Inheritance
Vector3
Implements

Remarks

The Vector3 structure provides support for hardware acceleration.

For matrix transformations, the Vector2, Vector3, and Vector4 instances are represented as rows: a vector v is transformed by a matrix M with vM multiplication.

Constructors

Vector3(ReadOnlySpan<Single>)

Constructs a vector from the given ReadOnlySpan<T>. The span must contain at least 3 elements.

Vector3(Single, Single, Single)

Creates a vector whose elements have the specified values.

Vector3(Single)

Creates a new Vector3 object whose three elements have the same value.

Vector3(Vector2, Single)

Creates a new Vector3 object from the specified Vector2 object and the specified value.

Fields

X

The X component of the vector.

Y

The Y component of the vector.

Z

The Z component of the vector.

Properties

E

Gets a vector whose elements are equal to E.

Epsilon

Gets a vector whose elements are equal to Epsilon.

Item[Int32]

Gets or sets the element at the specified index.

NaN

Gets a vector whose elements are equal to NaN.

NegativeInfinity

Gets a vector whose elements are equal to NegativeInfinity.

NegativeZero

Gets a vector whose elements are equal to NegativeZero.

One

Gets a vector whose 3 elements are equal to one.

Pi

Gets a vector whose elements are equal to Pi.

PositiveInfinity

Gets a vector whose elements are equal to PositiveInfinity.

Tau

Gets a vector whose elements are equal to Tau.

UnitX

Gets the vector (1,0,0).

UnitY

Gets the vector (0,1,0).

UnitZ

Gets the vector (0,0,1).

Zero

Gets a vector whose 3 elements are equal to zero.

Methods

Abs(Vector3)

Returns a vector whose elements are the absolute values of each of the specified vector's elements.

Add(Vector3, Vector3)

Adds two vectors together.

Clamp(Vector3, Vector3, Vector3)

Restricts a vector between a minimum and a maximum value.

ClampNative(Vector3, Vector3, Vector3)

Restricts a vector between a minimum and a maximum value using platform specific behavior for NaN and NegativeZero..

CopySign(Vector3, Vector3)

Copies the per-element sign of a vector to the per-element sign of another vector.

CopyTo(Single[], Int32)

Copies the elements of the vector to a specified array starting at a specified index position.

CopyTo(Single[])

Copies the elements of the vector to a specified array.

CopyTo(Span<Single>)

Copies the vector to the given Span<T>. The length of the destination span must be at least 3.

Cos(Vector3)
Create(ReadOnlySpan<Single>)

Constructs a vector from the given ReadOnlySpan<T>. The span must contain at least 3 elements.

Create(Single, Single, Single)

Creates a vector whose elements have the specified values.

Create(Single)

Creates a new Vector3 object whose three elements have the same value.

Create(Vector2, Single)

Creates a new Vector3 object from the specified Vector2 object and a Z component.

Cross(Vector3, Vector3)

Computes the cross product of two vectors.

DegreesToRadians(Vector3)
Distance(Vector3, Vector3)

Computes the Euclidean distance between the two given points.

DistanceSquared(Vector3, Vector3)

Returns the Euclidean distance squared between two specified points.

Divide(Vector3, Single)

Divides the specified vector by a specified scalar value.

Divide(Vector3, Vector3)

Divides the first vector by the second.

Dot(Vector3, Vector3)

Returns the dot product of two vectors.

Equals(Object)

Returns a value that indicates whether this instance and a specified object are equal.

Equals(Vector3)

Returns a value that indicates whether this instance and another vector are equal.

Exp(Vector3)
FusedMultiplyAdd(Vector3, Vector3, Vector3)
GetHashCode()

Returns the hash code for this instance.

Hypot(Vector3, Vector3)
Length()

Returns the length of this vector object.

LengthSquared()

Returns the length of the vector squared.

Lerp(Vector3, Vector3, Single)

Performs a linear interpolation between two vectors based on the given weighting.

Lerp(Vector3, Vector3, Vector3)
Log(Vector3)
Log2(Vector3)
Max(Vector3, Vector3)

Returns a vector whose elements are the maximum of each of the pairs of elements in two specified vectors.

MaxMagnitude(Vector3, Vector3)

Compares two vectors to compute which has the greater magnitude on a per-element basis.

MaxMagnitudeNumber(Vector3, Vector3)

Compares two vectors, on a per-element basis, to compute which has the greater magnitude and returning the other value if an input is NaN.

MaxNative(Vector3, Vector3)

Compare two vectors to determine which is greater on a per-element basis using platform specific behavior for NaN and NegativeZero.

MaxNumber(Vector3, Vector3)

Compares two vectors, on a per-element basis, to compute which is greater and returning the other value if an element is NaN.

Min(Vector3, Vector3)

Returns a vector whose elements are the minimum of each of the pairs of elements in two specified vectors.

MinMagnitude(Vector3, Vector3)

Compares two vectors to compute which has the lesser magnitude on a per-element basis.

MinMagnitudeNumber(Vector3, Vector3)

Compares two vectors, on a per-element basis, to compute which has the lesser magnitude and returning the other value if an input is NaN.

MinNative(Vector3, Vector3)

Compare two vectors to determine which is lesser on a per-element basis using platform specific behavior for NaN and NegativeZero.

MinNumber(Vector3, Vector3)

Compares two vectors, on a per-element basis, to compute which is lesser and returning the other value if an element is NaN.

Multiply(Single, Vector3)

Multiplies a scalar value by a specified vector.

Multiply(Vector3, Single)

Multiplies a vector by a specified scalar.

Multiply(Vector3, Vector3)

Returns a new vector whose values are the product of each pair of elements in two specified vectors.

MultiplyAddEstimate(Vector3, Vector3, Vector3)
Negate(Vector3)

Negates a specified vector.

Normalize(Vector3)

Returns a vector with the same direction as the specified vector, but with a length of one.

RadiansToDegrees(Vector3)
Reflect(Vector3, Vector3)

Returns the reflection of a vector off a surface that has the specified normal.

Round(Vector3, MidpointRounding)
Round(Vector3)
Sin(Vector3)
SinCos(Vector3)
SquareRoot(Vector3)

Returns a vector whose elements are the square root of each of a specified vector's elements.

Subtract(Vector3, Vector3)

Subtracts the second vector from the first.

ToString()

Returns the string representation of the current instance using default formatting.

ToString(String, IFormatProvider)

Returns the string representation of the current instance using the specified format string to format individual elements and the specified format provider to define culture-specific formatting.

ToString(String)

Returns the string representation of the current instance using the specified format string to format individual elements.

Transform(Vector3, Matrix4x4)

Transforms a vector by a specified 4x4 matrix.

Transform(Vector3, Quaternion)

Transforms a vector by the specified Quaternion rotation value.

TransformNormal(Vector3, Matrix4x4)

Transforms a vector normal by the given 4x4 matrix.

Truncate(Vector3)
TryCopyTo(Span<Single>)

Attempts to copy the vector to the given Span<T>. The length of the destination span must be at least 3.

Operators

Addition(Vector3, Vector3)

Adds two vectors together.

Division(Vector3, Single)

Divides the specified vector by a specified scalar value.

Division(Vector3, Vector3)

Divides the first vector by the second.

Equality(Vector3, Vector3)

Returns a value that indicates whether each pair of elements in two specified vectors is equal.

Inequality(Vector3, Vector3)

Returns a value that indicates whether two specified vectors are not equal.

Multiply(Single, Vector3)

Multiples the scalar value by the specified vector.

Multiply(Vector3, Single)

Multiples the specified vector by the specified scalar value.

Multiply(Vector3, Vector3)

Returns a new vector whose values are the product of each pair of elements in two specified vectors.

Subtraction(Vector3, Vector3)

Subtracts the second vector from the first.

UnaryNegation(Vector3)

Negates the specified vector.

Extension Methods

AsVector4(Vector3)

Converts a Vector3 to a new Vector4 with the new elements zeroed.

AsVector4Unsafe(Vector3)

Converts a Vector3 to a new Vector4 with the new elements undefined.

AsVector128(Vector3)

Reinterprets a Vector3 as a new Vector128<T>.

AsVector128Unsafe(Vector3)

Reinterprets a Vector3 as a new Vector128<T>, leaving the new elements undefined.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 4.6, 4.6.1, 4.6.2, 4.7 (package-provided), 4.7, 4.7.1 (package-provided), 4.7.1, 4.7.2 (package-provided), 4.7.2, 4.8 (package-provided), 4.8, 4.8.1
.NET Standard 2.0 (package-provided), 2.1
UWP 10.0