Struct Scalar 

#[repr(transparent)]
pub struct Scalar<T>(pub T);

This type wraps an underlying Rust-native scalar (or someday SIMD) type to provide only methods and operators which are compatible with shader function behaviors. That is, they act like Vec* even where T might not. This allows the code generator to not worry as much about mismatches between Rust and shader semantics.

TODO: This isn’t actually used yet.

Tuple Fields

0: T

Implementations

impl<T> Scalar<T>

pub fn splat(value: T) -> Self

where T: Copy,

pub fn splat_from_scalar(value: Scalar<T>) -> Self

where T: Copy,

pub const fn select(self, trues: Self, mask: Scalar<bool>) -> Self

where T: Copy,

Replaces the elements of self with the elements of trues wherever mask contains true.

pub fn map<U, F>(self, f: F) -> Scalar<U>

where F: FnMut(T) -> U,

impl Scalar<i32>

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

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

impl Scalar<u32>

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

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

impl Scalar<f32>

pub const fn clamp(self, low: Self, high: Self) -> Self

As per WGSL clamp().

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

As per WGSL distance().

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

As per WGSL dot().

pub fn face_forward(self, e2: Self, e3: Self) -> Self

As per WGSL faceForward().

pub fn length(self) -> f32

As per WGSL length().

pub const fn mix(self, rhs: Self, blend: f32) -> Self

As per WGSL mix().

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

As per WGSL fma().

pub fn normalize(self) -> Self

As per WGSL normalize().

pub fn reflect(self, rhs: Self) -> Self

As per WGSL reflect().

pub const fn saturate(self) -> Self

As per WGSL saturate().

pub const fn sign(self) -> Self

As per WGSL sign().

pub const fn abs(self) -> Self

pub fn acos(self) -> Self

pub fn acosh(self) -> Self

pub fn asin(self) -> Self

pub fn asinh(self) -> Self

pub fn atan(self) -> Self

pub fn atanh(self) -> Self

pub fn ceil(self) -> Self

pub fn cos(self) -> Self

pub fn cosh(self) -> Self

pub fn exp(self) -> Self

pub fn exp2(self) -> Self

pub fn floor(self) -> Self

pub fn fract(self) -> Self

pub fn log2(self) -> Self

pub fn round(self) -> Self

pub fn sin(self) -> Self

pub fn sinh(self) -> Self

pub fn tan(self) -> Self

pub fn tanh(self) -> Self

pub fn trunc(self) -> Self

pub fn to_degrees(self) -> Self

pub fn to_radians(self) -> Self

pub fn atan2(self, rhs: Self) -> Self

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

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

pub fn powf(self, rhs: Self) -> Self

impl Scalar<f64>

pub const fn clamp(self, low: Self, high: Self) -> Self

As per WGSL clamp().

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

As per WGSL distance().

pub const fn dot(self, rhs: Self) -> f64

As per WGSL dot().

pub fn face_forward(self, e2: Self, e3: Self) -> Self

As per WGSL faceForward().

pub fn length(self) -> f64

As per WGSL length().

pub const fn mix(self, rhs: Self, blend: f64) -> Self

As per WGSL mix().

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

As per WGSL fma().

pub fn normalize(self) -> Self

As per WGSL normalize().

pub fn reflect(self, rhs: Self) -> Self

As per WGSL reflect().

pub const fn saturate(self) -> Self

As per WGSL saturate().

pub const fn sign(self) -> Self

As per WGSL sign().

pub const fn abs(self) -> Self

pub fn acos(self) -> Self

pub fn acosh(self) -> Self

pub fn asin(self) -> Self

pub fn asinh(self) -> Self

pub fn atan(self) -> Self

pub fn atanh(self) -> Self

pub fn ceil(self) -> Self

pub fn cos(self) -> Self

pub fn cosh(self) -> Self

pub fn exp(self) -> Self

pub fn exp2(self) -> Self

pub fn floor(self) -> Self

pub fn fract(self) -> Self

pub fn log2(self) -> Self

pub fn round(self) -> Self

pub fn sin(self) -> Self

pub fn sinh(self) -> Self

pub fn tan(self) -> Self

pub fn tanh(self) -> Self

pub fn trunc(self) -> Self

pub fn to_degrees(self) -> Self

pub fn to_radians(self) -> Self

pub fn atan2(self, rhs: Self) -> Self

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

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

pub fn powf(self, rhs: Self) -> Self

impl Scalar<i32>

pub fn cast_elem_as_u32(self) -> Scalar<u32>

pub fn cast_elem_as_i32(self) -> Scalar<i32>

pub fn cast_elem_as_f32(self) -> Scalar<f32>

pub fn cast_elem_as_f64(self) -> Scalar<f64>

impl Scalar<u32>

pub fn cast_elem_as_u32(self) -> Scalar<u32>

pub fn cast_elem_as_i32(self) -> Scalar<i32>

pub fn cast_elem_as_f32(self) -> Scalar<f32>

pub fn cast_elem_as_f64(self) -> Scalar<f64>

impl Scalar<f32>

pub fn cast_elem_as_u32(self) -> Scalar<u32>

pub fn cast_elem_as_i32(self) -> Scalar<i32>

pub fn cast_elem_as_f32(self) -> Scalar<f32>

pub fn cast_elem_as_f64(self) -> Scalar<f64>

impl Scalar<f64>

pub fn cast_elem_as_u32(self) -> Scalar<u32>

pub fn cast_elem_as_i32(self) -> Scalar<i32>

pub fn cast_elem_as_f32(self) -> Scalar<f32>

pub fn cast_elem_as_f64(self) -> Scalar<f64>

impl<T: ConstZero> Scalar<T>

pub const ZERO: Self

impl<T: PartialOrd> Scalar<T>

pub fn elementwise_eq(self, rhs: Self) -> Scalar<bool>

pub fn elementwise_ne(self, rhs: Self) -> Scalar<bool>

pub fn elementwise_lt(self, rhs: Self) -> Scalar<bool>

pub fn elementwise_le(self, rhs: Self) -> Scalar<bool>

pub fn elementwise_gt(self, rhs: Self) -> Scalar<bool>

pub fn elementwise_ge(self, rhs: Self) -> Scalar<bool>

impl Scalar<i32>

pub const fn abs(self) -> Self

impl Scalar<u32>

pub fn abs(self) -> Self

impl<T> Scalar<T>

pub fn new(value: T) -> Self

Trait Implementations

impl<T> Add<Vec2<T>> for Scalar<T>

where Vec2<T>: Add<Scalar<T>>,

type Output = <Vec2<T> as Add<Scalar<T>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Vec2<T>) -> Self::Output

Performs the + operation.

impl<T> Add<Vec3<T>> for Scalar<T>

where Vec3<T>: Add<Scalar<T>>,

type Output = <Vec3<T> as Add<Scalar<T>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Vec3<T>) -> Self::Output

Performs the + operation.

impl<T> Add<Vec4<T>> for Scalar<T>

where Vec4<T>: Add<Scalar<T>>,

type Output = <Vec4<T> as Add<Scalar<T>>>::Output

The resulting type after applying the + operator.

fn add(self, rhs: Vec4<T>) -> Self::Output

Performs the + operation.

impl Add<f32> for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i32> for Scalar<i32>

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

Wrapping addition.

type Output = Scalar<i32>

The resulting type after applying the + operator.

impl Add<u32> for Scalar<u32>

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

Wrapping addition.

type Output = Scalar<u32>

The resulting type after applying the + operator.

impl Add for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Scalar<i32>

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

Wrapping addition.

type Output = Scalar<i32>

The resulting type after applying the + operator.

impl Add for Scalar<u32>

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

Wrapping addition.

type Output = Scalar<u32>

The resulting type after applying the + operator.

impl BitAnd for Scalar<bool>

type Output = Scalar<bool>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAnd for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitOr for Scalar<bool>

type Output = Scalar<bool>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOr for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitXor for Scalar<bool>

type Output = Scalar<bool>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXor for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl<T: Clone> Clone for Scalar<T>

fn clone(&self) -> Scalar<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: ConstZero> ConstZero for Scalar<T>

where Self: Add<Output = Self>,

const ZERO: Self

The additive identity element of Self, 0.

impl<T: Debug> Debug for Scalar<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Scalar<T>

fn default() -> Self

Returns the “default value” for a type.

impl Div<f32> for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<f64> for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i32> for Scalar<i32>

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

On division by zero or overflow, returns self, per WGSL.

type Output = Scalar<i32>

The resulting type after applying the / operator.

impl Div<u32> for Scalar<u32>

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

On division by zero or overflow, returns self, per WGSL.

type Output = Scalar<u32>

The resulting type after applying the / operator.

impl Div for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Scalar<i32>

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

On division by zero or overflow, returns the component of self, per WGSL.

type Output = Scalar<i32>

The resulting type after applying the / operator.

impl Div for Scalar<u32>

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

On division by zero or overflow, returns the component of self, per WGSL.

type Output = Scalar<u32>

The resulting type after applying the / operator.

impl<T> From<[T; 1]> for Scalar<T>

fn from([value]: [T; 1]) -> Self

Converts to this type from the input type.

impl<T> From<Scalar<T>> for [T; 1]

fn from(value: Scalar<T>) -> Self

Converts to this type from the input type.

impl<T> From<T> for Scalar<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for Scalar<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Mul<Vec2<T>> for Scalar<T>

where Vec2<T>: Mul<Scalar<T>>,

type Output = <Vec2<T> as Mul<Scalar<T>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Vec2<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<Vec3<T>> for Scalar<T>

where Vec3<T>: Mul<Scalar<T>>,

type Output = <Vec3<T> as Mul<Scalar<T>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Vec3<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<Vec4<T>> for Scalar<T>

where Vec4<T>: Mul<Scalar<T>>,

type Output = <Vec4<T> as Mul<Scalar<T>>>::Output

The resulting type after applying the * operator.

fn mul(self, rhs: Vec4<T>) -> Self::Output

Performs the * operation.

impl Mul<f32> for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i32> for Scalar<i32>

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

Wrapping multiplication.

type Output = Scalar<i32>

The resulting type after applying the * operator.

impl Mul<u32> for Scalar<u32>

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

Wrapping multiplication.

type Output = Scalar<u32>

The resulting type after applying the * operator.

impl Mul for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Scalar<i32>

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

Wrapping multiplication.

type Output = Scalar<i32>

The resulting type after applying the * operator.

impl Mul for Scalar<u32>

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

Wrapping multiplication.

type Output = Scalar<u32>

The resulting type after applying the * operator.

impl Not for Scalar<bool>

type Output = Scalar<bool>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Not for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<T: PartialEq> PartialEq for Scalar<T>

fn eq(&self, other: &Scalar<T>) -> 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<T: PartialOrd> PartialOrd for Scalar<T>

fn partial_cmp(&self, other: &Scalar<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Rem<f32> for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the % operator.

fn rem(self, rhs: f32) -> Self::Output

Performs the % operation.

impl Rem<f64> for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the % operator.

fn rem(self, rhs: f64) -> Self::Output

Performs the % operation.

impl Rem<i32> for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the % operator.

fn rem(self, rhs: i32) -> Self::Output

Performs the % operation.

impl Rem<u32> for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the % operator.

fn rem(self, rhs: u32) -> Self::Output

Performs the % operation.

impl Rem for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Rem for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Rem for Scalar<i32>

type Output = Scalar<i32>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Rem for Scalar<u32>

type Output = Scalar<u32>

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self::Output

Performs the % operation.

impl Sub<f32> for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i32> for Scalar<i32>

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

Wrapping subtraction.

type Output = Scalar<i32>

The resulting type after applying the - operator.

impl Sub<u32> for Scalar<u32>

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

Wrapping subtraction.

type Output = Scalar<u32>

The resulting type after applying the - operator.

impl Sub for Scalar<f32>

type Output = Scalar<f32>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Scalar<f64>

type Output = Scalar<f64>

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Scalar<i32>

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

Wrapping subtraction.

type Output = Scalar<i32>

The resulting type after applying the - operator.

impl Sub for Scalar<u32>

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

Wrapping subtraction.

type Output = Scalar<u32>

The resulting type after applying the - operator.

impl<T: ConstZero> Zero for Scalar<T>

where Self: Add<Output = Self>,

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy> Copy for Scalar<T>

impl<T: Eq> Eq for Scalar<T>

impl<T> StructuralPartialEq for Scalar<T>