Struct ConstantEvaluator
pub struct ConstantEvaluator<'a> { /* private fields */ }
unstable-wgpu-26
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,
global_expression_kind_tracker: &'a mut ExpressionKindTracker,
layouter: &'a mut Layouter,
in_override_ctx: bool,
) -> ConstantEvaluator<'a>
pub fn for_wgsl_module( module: &'a mut Module, global_expression_kind_tracker: &'a mut ExpressionKindTracker, layouter: &'a mut Layouter, in_override_ctx: bool, ) -> 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,
global_expression_kind_tracker: &'a mut ExpressionKindTracker,
layouter: &'a mut Layouter,
) -> ConstantEvaluator<'a>
pub fn for_glsl_module( module: &'a mut Module, global_expression_kind_tracker: &'a mut ExpressionKindTracker, layouter: &'a mut Layouter, ) -> 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>,
local_expression_kind_tracker: &'a mut ExpressionKindTracker,
layouter: &'a mut Layouter,
emitter: &'a mut Emitter,
block: &'a mut Block,
is_const: bool,
) -> ConstantEvaluator<'a>
pub fn for_wgsl_function( module: &'a mut Module, expressions: &'a mut Arena<Expression>, local_expression_kind_tracker: &'a mut ExpressionKindTracker, layouter: &'a mut Layouter, emitter: &'a mut Emitter, block: &'a mut Block, is_const: bool, ) -> 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>,
local_expression_kind_tracker: &'a mut ExpressionKindTracker,
layouter: &'a mut Layouter,
emitter: &'a mut Emitter,
block: &'a mut Block,
) -> ConstantEvaluator<'a>
pub fn for_glsl_function( module: &'a mut Module, expressions: &'a mut Arena<Expression>, local_expression_kind_tracker: &'a mut ExpressionKindTracker, layouter: &'a mut Layouter, 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, and self
is
contributing to some function’s expression arena, then append expr
to
that arena unchanged (and thus unevaluated). Otherwise, self
must be
contributing to the module’s constant expression arena; since expr
’s
value is not a constant, return an error.
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> Freeze for ConstantEvaluator<'a>
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<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
§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
§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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self
to the equivalent element of its superset.