pub struct ConstantEvaluator<'a> { /* private fields */ }
wgpu
only.Expand description
A context for evaluating constant expressions.
A ConstantEvaluator
points at an expression arena to which it can append
newly evaluated expressions: you pass try_eval_and_append
whatever kind
of Naga Expression
you like, and if its value can be computed at compile
time, try_eval_and_append
appends an expression representing the computed
value - a tree of Literal
, Compose
, ZeroValue
, and Swizzle
expressions - to the arena. See the try_eval_and_append
method for details.
A ConstantEvaluator
also holds whatever information we need to carry out
that evaluation: types, other constants, and so on.
Implementations§
§impl<'a> ConstantEvaluator<'a>
impl<'a> ConstantEvaluator<'a>
pub fn for_wgsl_module(module: &'a mut Module) -> ConstantEvaluator<'a>
pub fn for_wgsl_module(module: &'a mut Module) -> ConstantEvaluator<'a>
Return a ConstantEvaluator
that will add expressions to module
’s
constant expression arena.
Report errors according to WGSL’s rules for constant evaluation.
pub fn for_glsl_module(module: &'a mut Module) -> ConstantEvaluator<'a>
pub fn for_glsl_module(module: &'a mut Module) -> ConstantEvaluator<'a>
Return a ConstantEvaluator
that will add expressions to module
’s
constant expression arena.
Report errors according to GLSL’s rules for constant evaluation.
pub fn for_wgsl_function(
module: &'a mut Module,
expressions: &'a mut Arena<Expression>,
expression_constness: &'a mut ExpressionConstnessTracker,
emitter: &'a mut Emitter,
block: &'a mut Block
) -> ConstantEvaluator<'a>
pub fn for_wgsl_function( module: &'a mut Module, expressions: &'a mut Arena<Expression>, expression_constness: &'a mut ExpressionConstnessTracker, emitter: &'a mut Emitter, block: &'a mut Block ) -> ConstantEvaluator<'a>
Return a ConstantEvaluator
that will add expressions to function
’s
expression arena.
Report errors according to WGSL’s rules for constant evaluation.
pub fn for_glsl_function(
module: &'a mut Module,
expressions: &'a mut Arena<Expression>,
expression_constness: &'a mut ExpressionConstnessTracker,
emitter: &'a mut Emitter,
block: &'a mut Block
) -> ConstantEvaluator<'a>
pub fn for_glsl_function( module: &'a mut Module, expressions: &'a mut Arena<Expression>, expression_constness: &'a mut ExpressionConstnessTracker, emitter: &'a mut Emitter, block: &'a mut Block ) -> ConstantEvaluator<'a>
Return a ConstantEvaluator
that will add expressions to function
’s
expression arena.
Report errors according to GLSL’s rules for constant evaluation.
pub fn to_ctx(&self) -> GlobalCtx<'_>
pub fn try_eval_and_append(
&mut self,
expr: &Expression,
span: Span
) -> Result<Handle<Expression>, ConstantEvaluatorError>
pub fn try_eval_and_append( &mut self, expr: &Expression, span: Span ) -> Result<Handle<Expression>, ConstantEvaluatorError>
Try to evaluate expr
at compile time.
The expr
argument can be any sort of Naga Expression
you like. If
we can determine its value at compile time, we append an expression
representing its value - a tree of Literal
, Compose
,
ZeroValue
, and Swizzle
expressions - to the expression arena
self
contributes to.
If expr
’s value cannot be determined at compile time, return a an
error. If it’s acceptable to evaluate expr
at runtime, this error can
be ignored, and the caller can append expr
to the arena itself.
We only consider expr
itself, without recursing into its operands. Its
operands must all have been produced by prior calls to
try_eval_and_append
, to ensure that they have already been reduced to
an evaluated form if possible.
pub fn cast(
&mut self,
expr: Handle<Expression>,
target: Scalar,
span: Span
) -> Result<Handle<Expression>, ConstantEvaluatorError>
pub fn cast( &mut self, expr: Handle<Expression>, target: Scalar, span: Span ) -> Result<Handle<Expression>, ConstantEvaluatorError>
Convert the scalar components of expr
to target
.
Treat span
as the location of the resulting expression.
pub fn cast_array(
&mut self,
expr: Handle<Expression>,
target: Scalar,
span: Span
) -> Result<Handle<Expression>, ConstantEvaluatorError>
pub fn cast_array( &mut self, expr: Handle<Expression>, target: Scalar, span: Span ) -> Result<Handle<Expression>, ConstantEvaluatorError>
Convert the scalar leaves of expr
to target
, handling arrays.
expr
must be a Compose
expression whose type is a scalar, vector,
matrix, or nested arrays of such.
This is basically the same as the cast
method, except that that
should only handle Naga As
expressions, which cannot convert arrays.
Treat span
as the location of the resulting expression.
Trait Implementations§
Auto Trait Implementations§
impl<'a> RefUnwindSafe for ConstantEvaluator<'a>
impl<'a> Send for ConstantEvaluator<'a>
impl<'a> Sync for ConstantEvaluator<'a>
impl<'a> Unpin for ConstantEvaluator<'a>
impl<'a> !UnwindSafe for ConstantEvaluator<'a>
Blanket Implementations§
source§impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for Swhere
T: Real + Zero + Arithmetics + Clone,
Swp: WhitePoint<T>,
Dwp: WhitePoint<T>,
D: AdaptFrom<S, Swp, Dwp, T>,
source§fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
fn adapt_into_using<M>(self, method: M) -> Dwhere
M: TransformMatrix<T>,
source§fn adapt_into(self) -> D
fn adapt_into(self) -> D
source§impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
impl<T, C> ArraysFrom<C> for Twhere
C: IntoArrays<T>,
source§fn arrays_from(colors: C) -> T
fn arrays_from(colors: C) -> T
source§impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
impl<T, C> ArraysInto<C> for Twhere
C: FromArrays<T>,
source§fn arrays_into(self) -> C
fn arrays_into(self) -> C
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
impl<T, C> ComponentsFrom<C> for Twhere
C: IntoComponents<T>,
source§fn components_from(colors: C) -> T
fn components_from(colors: C) -> T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> FromAngle<T> for T
impl<T> FromAngle<T> for T
source§fn from_angle(angle: T) -> T
fn from_angle(angle: T) -> T
angle
.source§impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
impl<T, U> FromStimulus<U> for Twhere
U: IntoStimulus<T>,
source§fn from_stimulus(other: U) -> T
fn from_stimulus(other: U) -> T
other
into Self
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
impl<T, U> IntoAngle<U> for Twhere
U: FromAngle<T>,
source§fn into_angle(self) -> U
fn into_angle(self) -> U
T
.source§impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
impl<T, U> IntoColor<U> for Twhere
U: FromColor<T>,
source§fn into_color(self) -> U
fn into_color(self) -> U
source§impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
impl<T, U> IntoColorUnclamped<U> for Twhere
U: FromColorUnclamped<T>,
source§fn into_color_unclamped(self) -> U
fn into_color_unclamped(self) -> U
source§impl<T> IntoStimulus<T> for T
impl<T> IntoStimulus<T> for T
source§fn into_stimulus(self) -> T
fn into_stimulus(self) -> T
self
into T
, while performing the appropriate scaling,
rounding and clamping.§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
impl<T, C> TryComponentsInto<C> for Twhere
C: TryFromComponents<T>,
§type Error = <C as TryFromComponents<T>>::Error
type Error = <C as TryFromComponents<T>>::Error
try_into_colors
fails to cast.source§fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>
source§impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
impl<T, U> TryIntoColor<U> for Twhere
U: TryFromColor<T>,
source§fn try_into_color(self) -> Result<U, OutOfBounds<U>>
fn try_into_color(self) -> Result<U, OutOfBounds<U>>
OutOfBounds
error is returned which contains
the unclamped color. Read more