Struct Float2

pub struct Float2 {
    pub x: f32,
    pub y: f32,
}

Vector containing 2 floating point values.

Fields

x: f32

The x-component of the vector.

y: f32

The y-component of the vector.

Implementations

impl Float2

pub fn new(x: f32, y: f32) -> Self

Creates a vector from 2 floating point values.

pub fn abs(&self) -> Self

Computes the per-component absolute numbers.

pub fn acos(&self) -> Self

Computes the per-component arccosine numbers (in radians). Each component should be a value within the range of -1 to 1. Return values are in the range 0, pi or NaN if the number is outside the range -1 to 1.

pub fn all(&self) -> bool

Determines if all components of the vector are non-zero.

pub fn any(&self) -> bool

Determines if any components of the vector are non-zero.

pub fn asin(&self) -> Self

Computes the per-component arcsine numbers (in radians). Each component should be a value within the range of -1 to 1. Return values are in the range -pi/2 to pi/2 or NaN if the number is outside the range -1 to 1.

pub fn atan(&self) -> Self

Computes the per-component arctangent numbers (in radians). Return values are in the range -pi/2 to pi/2.

pub fn atan2(&self) -> f32

Computes the four quadrant arctangent of y and x (in radians).

pub fn ceil(&self) -> Self

Computes the per-component smallest integers greater than or equal to self.x and self.y respectively.

pub fn clamp(&self, min: f32, max: f32) -> Self

Computes the per-component clamped numbers between min and max.

pub fn cos(&self) -> Self

Computes the per-component cosine numbers (in radians).

pub fn cosh(&self) -> Self

Computes the per-component hyperbolic cosine numbers.

pub fn degrees(&self) -> Self

Converts the per-component numbers from radians to degrees.

pub fn distance(&self, rhs: &Self) -> f32

Computes the distance scalar between two vectors.

pub fn dot(&self, rhs: &Self) -> f32

Computes the dot product of two vectors.

pub fn exp(&self) -> Self

Computes the per-component e^(self), the exponential function.

pub fn exp2(&self) -> Self

Computes the per-component 2^(self).

pub fn floor(&self) -> Self

Computes the per-component largest integers less than or equal to self.x and self.y respectively.

pub fn fmod(&self, rhs: &Self) -> Self

Computes the floating-point remainder of division for each component.

pub fn frac(&self) -> Self

Computes the fractional (or decimal) part of each component; which is greater than or equal to 0 and less than 1.

pub fn ldexp(&self, exponent: &Self) -> Self

Computes value * 2^exponent for each component of the vector.

pub fn length(&self) -> f32

Computes the length scalar between two vectors.

pub fn lerp(&self, rhs: &Self, t: f32) -> Self

Computes a linear interpolation between two vectors.

pub fn log(&self) -> Self

Computes the natural logarithm (base e) of each component of the vector.

pub fn log10(&self) -> Self

Computes the natural logarithm (base 10) of each component of the vector.

pub fn log2(&self) -> Self

Computes the natural logarithm (base 2) of each component of the vector.

pub fn mad(&self, b: &Self, c: &Self) -> Self

Computes the multiply-add operation: (self * b) + c.

pub fn max(&self, rhs: &Self) -> Self

Computes the component-wise maximum of two vectors.

pub fn min(&self, rhs: &Self) -> Self

Computes the component-wise minimum of two vectors.

pub fn normalize(&self) -> Self

Computes the normalized vector (unit vector) of self.

pub fn pow(&self, exponent: f32) -> Self

Computes the component-wise power: self^exponent.

pub fn radians(&self) -> Self

Converts the per-component numbers from degrees to radians.

pub fn rcp(&self) -> Self

Computes the reciprocal of each component of the vector. Equivalent to 1 / self.

pub fn rcp_safe(&self) -> Self

Computes the reciprocal of each component of the vector. Equivalent to 1 / self and returning 0 when self is 0.

pub fn reflect(&self, normal: &Self) -> Self

Computes the reflection of an incident vector self about a normal vector normal.

pub fn refract(&self, normal: &Self, eta: f32) -> Self

Computes the refraction vector for the given incident vector, normal, and refraction index.

pub fn round(&self) -> Self

Rounds each component of the vector to the nearest integer.

pub fn rsqrt(&self) -> Self

Computes the reciprocal square root of each component of the vector.

pub fn saturate(&self) -> Self

Clamps each component of the vector to the range [0, 1].

pub fn sign(&self) -> Self

Computes the sign of each component of the vector.

pub fn sin(&self) -> Self

Computes the per-component sine numbers (in radians).

pub fn sinh(&self) -> Self

Computes the per-component hyperbolic sine numbers.

pub fn smoothstep(&self, min: &Self, max: &Self) -> Self

Performs smoothstep interpolation on each component of the vector.

pub fn sqrt(&self) -> Self

Computes the square root of each component of the vector.

pub fn step(&self, edge: &Self) -> Self

Computes the component-wise step function. For each component: returns 0.0 if self < edge, else returns 1.0.

pub fn tan(&self) -> Self

Computes the per-component tangent numbers (in radians).

pub fn tanh(&self) -> Self

Computes the per-component hyperbolic tangent numbers.

pub fn trunc(&self) -> Self

Truncates each component of the vector to its integer portion.

pub fn xx(&self) -> Float2

Returns a swizzled vector.

pub fn xy(&self) -> Float2

Returns a swizzled vector.

pub fn yx(&self) -> Float2

Returns a swizzled vector.

pub fn yy(&self) -> Float2

Returns a swizzled vector.

pub fn xxx(&self) -> Float3

Returns a swizzled vector.

pub fn xxy(&self) -> Float3

Returns a swizzled vector.

pub fn xyx(&self) -> Float3

Returns a swizzled vector.

pub fn xyy(&self) -> Float3

Returns a swizzled vector.

pub fn yxx(&self) -> Float3

Returns a swizzled vector.

pub fn yxy(&self) -> Float3

Returns a swizzled vector.

pub fn yyx(&self) -> Float3

Returns a swizzled vector.

pub fn yyy(&self) -> Float3

Returns a swizzled vector.

pub fn xxxx(&self) -> Float4

Returns a swizzled vector.

pub fn xxxy(&self) -> Float4

Returns a swizzled vector.

pub fn xxyx(&self) -> Float4

Returns a swizzled vector.

pub fn xxyy(&self) -> Float4

Returns a swizzled vector.

pub fn xyxx(&self) -> Float4

Returns a swizzled vector.

pub fn xyxy(&self) -> Float4

Returns a swizzled vector.

pub fn xyyx(&self) -> Float4

Returns a swizzled vector.

pub fn xyyy(&self) -> Float4

Returns a swizzled vector.

pub fn yxxx(&self) -> Float4

Returns a swizzled vector.

pub fn yxxy(&self) -> Float4

Returns a swizzled vector.

pub fn yxyx(&self) -> Float4

Returns a swizzled vector.

pub fn yxyy(&self) -> Float4

Returns a swizzled vector.

pub fn yyxx(&self) -> Float4

Returns a swizzled vector.

pub fn yyxy(&self) -> Float4

Returns a swizzled vector.

pub fn yyyx(&self) -> Float4

Returns a swizzled vector.

pub fn yyyy(&self) -> Float4

Returns a swizzled vector.

Trait Implementations

impl Add<f32> for Float2

type Output = Float2

The resulting type after applying the + operator.

fn add(self, rhs: f32) -> Self

Performs the + operation.

impl Add for Float2

type Output = Float2

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign<f32> for Float2

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign for Float2

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Float2

fn clone(&self) -> Float2

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Float2

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Float2

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Div<f32> for Float2

type Output = Float2

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl Div for Float2

type Output = Float2

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl DivAssign<f32> for Float2

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign for Float2

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<(f32, f32)> for Float2

fn from(lhs: (f32, f32)) -> Self

Converts to this type from the input type.

impl From<f32> for Float2

fn from(lhs: f32) -> Self

Converts to this type from the input type.

impl Mul<f32> for Float2

type Output = Float2

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Self

Performs the * operation.

impl Mul for Float2

type Output = Float2

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl MulAssign<f32> for Float2

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign for Float2

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Neg for Float2

type Output = Float2

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Float2

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Sub<f32> for Float2

type Output = Float2

The resulting type after applying the - operator.

fn sub(self, rhs: f32) -> Self

Performs the - operation.

impl Sub for Float2

type Output = Float2

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl SubAssign<f32> for Float2

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign for Float2

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Float2