Enum BinaryOperator

pub enum BinaryOperator {
    Add,
    Subtract,
    Multiply,
    Divide,
    Modulo,
    Equal,
    NotEqual,
    Less,
    LessEqual,
    Greater,
    GreaterEqual,
    And,
    ExclusiveOr,
    InclusiveOr,
    LogicalAnd,
    LogicalOr,
    ShiftLeft,
    ShiftRight,
}

Operation that can be applied on two values.

Arithmetic type rules

The arithmetic operations Add, Subtract, Multiply, Divide, and Modulo can all be applied to Scalar types other than Bool, or Vectors thereof. Both operands must have the same type.

Add and Subtract can also be applied to Matrix values. Both operands must have the same type.

Multiply supports additional cases:

• A Matrix or Vector can be multiplied by a scalar Float, either on the left or the right.

• A Matrix on the left can be multiplied by a Vector on the right if the matrix has as many columns as the vector has components (`matCxR

  • VecC`).

• A Vector on the left can be multiplied by a Matrix on the right if the matrix has as many rows as the vector has components (VecR * matCxR).

• Two matrices can be multiplied if the left operand has as many columns as the right operand has rows (matNxR * matCxN).

In all the above Multiply cases, the byte widths of the underlying scalar types of both operands must be the same.

Note that Multiply supports mixed vector and scalar operations directly, whereas the other arithmetic operations require an explicit Splat for mixed-type use.

Variants

Add

Subtract

Multiply

Divide

Modulo

Equivalent of the WGSL’s % operator or SPIR-V’s OpFRem

Equal

NotEqual

Less

LessEqual

Greater

GreaterEqual

And

ExclusiveOr

InclusiveOr

LogicalAnd

LogicalOr

ShiftLeft

ShiftRight

Right shift carries the sign of signed integers only.

Trait Implementations

impl Clone for BinaryOperator

fn clone(&self) -> BinaryOperator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryOperator

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

Formats the value using the given formatter.

impl Hash for BinaryOperator

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 Ord for BinaryOperator

fn cmp(&self, other: &BinaryOperator) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BinaryOperator

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

fn partial_cmp(&self, other: &BinaryOperator) -> 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 Copy for BinaryOperator

impl Eq for BinaryOperator

impl StructuralPartialEq for BinaryOperator