Struct shades::var::Var

source · [−]

pub struct Var<T>(pub Expr<T>) 
where
    T: ?Sized;

Expand description

Mutable variable.

A Var<T> is akin to an Expr<T> that can be mutated. You can go from a Var<T> to an Expr<T> via either the From or Var::to_expr method.

Variables, because they allow mutations, allow to write more complicated shader functions. Also, lots of graphics pipelines’ properties are variables you will have to write to, such as [VertexShaderEnv::position].

Tuple Fields

0: Expr<T>

Implementations

source

impl<T> Var<T> where
T: ?Sized,

source

pub fn to_expr(&self) -> Expr<T>

Coerce Var<T> into Expr<T>.

Remember that doing so will move the Var<T>. clone it if you want to preserve the source variable.

Note: use this function only when necessary. Lots of functions will accept both Expr<T> and Var<T>, performing the coercion for you automatically.

Return

The expression representation of Var<T>, allowing to pass the variable to functions or expressions that don’t easily coerce it automatically to Expr<T> already.

source

pub fn at(&self, index: Expr<i32>) -> Var<T>

Methods from Deref<Target = Expr<T>>

source

pub fn eq(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Equality expression.

This method builds an expression representing the equality between two expressions.

Return

An Expr<bool> representing the equality between the two input expressions.

source

pub fn neq(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Inequality expression.

This method builds an expression representing the inequality between two expressions.

Return

An Expr<bool> representing the inequality between the two input expressions.

source

pub fn lt(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Less-than expression.

This method builds an expression representing the binary operation a < b.

Return

An Expr<bool> representing a < b.

source

pub fn lte(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Less-than-or-equal expression.

This method builds an expression representing the binary operation a <= b.

Return

An Expr<bool> representing a <= b.

source

pub fn gt(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Greater-than expression.

This method builds an expression representing the binary operation a > b.

Return

An Expr<bool> representing a > b.

source

pub fn gte(&self, rhs: impl Into<Expr<T>>) -> Expr<bool>

Less-than-or-equal expression.

This method builds an expression representing the binary operation a <= b.

Return

An Expr<bool> representing a <= b.

source

pub fn and(&self, rhs: impl Into<Expr<bool>>) -> Expr<bool>

Logical and expression.

This method builds an expression representing the logical operation a AND b.

Return

An Expr<bool> representing a AND b.

source

pub fn or(&self, rhs: impl Into<Expr<bool>>) -> Expr<bool>

Logical or expression.

This method builds an expression representing the logical operation a OR b.

Return

An Expr<bool> representing a OR b.

source

pub fn xor(&self, rhs: impl Into<Expr<bool>>) -> Expr<bool>

Logical exclusive or expression.

This method builds an expression representing the logical operation a XOR b.

Return

An Expr<bool> representing a XOR b.

source

pub fn at(&self, index: Expr<i32>) -> Expr<T>

Array lookup.

The expression a.at(i) represents an array lookup, where a is an array — which type must be either Expr<[T]> or Expr<[T; N]> – and i is an Expr<i32>.

Return

The resulting Expr<T> represents the array lookup in a at index i.

source

pub fn at(&self, index: impl Into<Expr<i32>>) -> Expr<T>

Array lookup.

The expression a.at(i) represents an array lookup, where a is an array — which type must be either Expr<[T]> or Expr<[T; N]> – and i is an Expr<i32>.