logo

Struct ark_api::Vec4

source · [−]
#[repr(C, align(16))]
pub struct Vec4(_);
Expand description

A 4-dimensional vector.

This type uses 16 byte aligned SIMD vector type for storage on supported platforms.

Implementations

All zeroes.

All ones.

[1, 0, 0, 0]: a unit-length vector pointing along the positive X axis.

[0, 1, 0, 0]: a unit-length vector pointing along the positive Y axis.

[0, 0, 1, 0]: a unit-length vector pointing along the positive Z axis.

[0, 0, 0, 1]: a unit-length vector pointing along the positive W axis.

The unit axes.

Creates a new 4D vector.

Creates a Vec3 from the x, y and z elements of self, discarding w.

Truncation to Vec3 may also be performed by using self.xyz() or Vec3::from().

To truncate to Vec3A use Vec3A::from().

[x, y, z, w]

Creates a vector with all elements set to v.

Creates a vector from the elements in if_true and if_false, selecting which to use for each element of self.

A true element in the mask uses the corresponding element from if_true, and false uses the element from if_false.

Computes the dot product of self and other.

Returns a vector containing the minimum values for each element of self and other.

In other words this computes [self.x.min(other.x), self.y.min(other.y), ..].

Returns a vector containing the maximum values for each element of self and other.

In other words this computes [self.x.max(other.x), self.y.max(other.y), ..].

Component-wise clamping of values, similar to f32::clamp.

Each element in min must be less-or-equal to the corresponding element in max.

Panics

Will panic if min is greater than max when glam_assert is enabled.

Returns the horizontal minimum of self.

In other words this computes min(x, y, ..).

Returns the horizontal maximum of self.

In other words this computes max(x, y, ..).

Returns a vector mask containing the result of a == comparison for each element of self and other.

In other words, this computes [self.x == other.x, self.y == other.y, ..] for all elements.

Returns a vector mask containing the result of a != comparison for each element of self and other.

In other words this computes [self.x != other.x, self.y != other.y, ..] for all elements.

Returns a vector mask containing the result of a >= comparison for each element of self and other.

In other words this computes [self.x >= other.x, self.y >= other.y, ..] for all elements.

Returns a vector mask containing the result of a > comparison for each element of self and other.

In other words this computes [self.x > other.x, self.y > other.y, ..] for all elements.

Returns a vector mask containing the result of a <= comparison for each element of self and other.

In other words this computes [self.x <= other.x, self.y <= other.y, ..] for all elements.

Returns a vector mask containing the result of a < comparison for each element of self and other.

In other words this computes [self.x < other.x, self.y < other.y, ..] for all elements.

Creates a vector from the first N values in slice.

Panics

Panics if slice is less than N elements long.

Writes the elements of self to the first N elements in slice.

Panics

Panics if slice is less than N elements long.

Returns a vector containing the absolute value of each element of self.

Returns a vector with elements representing the sign of self.

  • 1.0 if the number is positive, +0.0 or INFINITY
  • -1.0 if the number is negative, -0.0 or NEG_INFINITY
  • NAN if the number is NAN

All NAN.

Returns true if, and only if, all elements are finite. If any element is either NaN, positive or negative infinity, this will return false.

Returns true if any elements are NaN.

Performs is_nan on each element of self, returning a vector mask of the results.

In other words, this computes [x.is_nan(), y.is_nan(), z.is_nan(), w.is_nan()].

Computes the length of self.

Computes the squared length of self.

This is faster than length() as it avoids a square root operation.

Computes 1.0 / length().

For valid results, self must not be of length zero.

Computes the Euclidean distance between two points in space.

Compute the squared euclidean distance between two points in space.

Returns self normalized to length 1.0.

For valid results, self must not be of length zero, nor very close to zero.

See also Self::try_normalize and Self::normalize_or_zero.

Panics

Will panic if self is zero length when glam_assert is enabled.

Returns self normalized to length 1.0 if possible, else returns None.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be None.

See also Self::normalize_or_zero.

Returns self normalized to length 1.0 if possible, else returns zero.

In particular, if the input is zero (or very close to zero), or non-finite, the result of this operation will be zero.

See also Self::try_normalize.

Returns whether self is length 1.0 or not.

Uses a precision threshold of 1e-6.

Returns the vector projection of self onto other.

other must be of non-zero length.

Panics

Will panic if other is zero length when glam_assert is enabled.

Returns the vector rejection of self from other.

The vector rejection is the vector perpendicular to the projection of self onto other, in other words the result of self - self.project_onto(other).

other must be of non-zero length.

Panics

Will panic if other has a length of zero when glam_assert is enabled.

Returns the vector projection of self onto other.

other must be normalized.

Panics

Will panic if other is not normalized when glam_assert is enabled.

Returns the vector rejection of self from other.

The vector rejection is the vector perpendicular to the projection of self onto other, in other words the result of self - self.project_onto(other).

other must be normalized.

Panics

Will panic if other is not normalized when glam_assert is enabled.

Returns a vector containing the nearest integer to a number for each element of self. Round half-way cases away from 0.0.

Returns a vector containing the largest integer less than or equal to a number for each element of self.

Returns a vector containing the smallest integer greater than or equal to a number for each element of self.

Returns a vector containing the fractional part of the vector, e.g. self - self.floor().

Note that this is fast but not precise for large numbers.

Returns a vector containing e^self (the exponential function) for each element of self.

Returns a vector containing each element of self raised to the power of n.

Returns a vector containing the reciprocal 1.0/n of each element of self.

Performs a linear interpolation between self and other based on the value s.

When s is 0.0, the result will be equal to self. When s is 1.0, the result will be equal to other. When s is outside of range [0,1], the result is linearly extrapolated.

Returns true if the absolute difference of all elements between self and other is less than or equal to max_abs_diff.

This can be used to compare if two vectors contain similar elements. It works best when comparing with a known value. The max_abs_diff that should be used used depends on the values being compared against.

For more see comparing floating point numbers.

Returns a vector with a length no less than min and no more than max

Panics

Will panic if min is greater than max when glam_assert is enabled.

Returns a vector with a length no more than max

Returns a vector with a length no less than min

Fused multiply-add. Computes (self * a) + b element-wise with only one rounding error, yielding a more accurate result than an unfused multiply-add.

Using mul_add may be more performant than an unfused multiply-add if the target architecture has a dedicated fma CPU instruction. However, this is not always true, and will be heavily dependant on designing algorithms with specific target hardware in mind.

Casts all elements of self to f64.

Casts all elements of self to i32.

Casts all elements of self to u32.

Trait Implementations

The resulting type after applying the + operator.

Performs the + operation. Read more

The resulting type after applying the + operator.

Performs the + operation. Read more

Performs the += operation. Read more

Performs the += operation. Read more

Converts this type into a mutable reference of the (usually inferred) input type.

Converts this type into a shared reference of the (usually inferred) input type.

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Deserialize this value from the given Serde deserializer. Read more

Formats the value using the given formatter. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

The resulting type after applying the / operator.

Performs the / operation. Read more

Performs the /= operation. Read more

Performs the /= operation. Read more

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

Linear RGBA in 0-1 from sRGBA

Converts to this type from the input type.

Converts to this type from the input type.

sRGBA from linear RGBA in [0-1] range

Converts to this type from the input type.

Converts to this type from the input type.

Converts to this type from the input type.

The returned type after indexing.

Performs the indexing (container[index]) operation. Read more

Performs the mutable indexing (container[index]) operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

The resulting type after applying the * operator.

Performs the * operation. Read more

Performs the *= operation. Read more

Performs the *= operation. Read more

The resulting type after applying the - operator.

Performs the unary - operation. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Method which takes an iterator and generates Self from the elements by multiplying the items. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

The resulting type after applying the % operator.

Performs the % operation. Read more

Performs the %= operation. Read more

Performs the %= operation. Read more

Serialize this value into the given Serde serializer. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

The resulting type after applying the - operator.

Performs the - operation. Read more

Performs the -= operation. Read more

Performs the -= operation. Read more

Method which takes an iterator and generates Self from the elements by “summing up” the items. Read more

Wraps the passed-in value in a Value enum.

Extracts the value from a Value enum.

For element i of self, return v[i].trunc()

For element i of the return value, returns 0.0 if value[i] < self[i] and 1.0 otherwise. Read more

Selects between true and false based on the result of value[i] < self[i]

Return only the fractional parts of each component.

Return the square root of each component.

Raw transmute each component to u32.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.