Struct Scalar

pub struct Scalar {
    pub kind: ScalarKind,
    pub width: u8,
}

Available on crate feature unstable-wgpu-24 only.

Characteristics of a scalar type.

Fields

kind: ScalarKind

How the value’s bits are to be interpreted.

width: u8

This size of the value in bytes.

Implementations

impl Scalar

pub const fn automatic_conversion_combine(self, other: Scalar) -> Option<Scalar>

Find the common type of self and other under WGSL’s automatic conversions.

If there are any scalars to which WGSL’s automatic conversions will convert both self and other, return the best such scalar. Otherwise, return None.

pub fn automatically_converts_to(self, goal: Scalar) -> bool

Return true if automatic conversions will covert self to goal.

impl Scalar

pub fn to_wgsl(self) -> String

Format a scalar kind+width as a type is written in wgsl.

Examples: f32, u64, bool.

impl Scalar

pub const I32: Scalar

pub const U32: Scalar

pub const F32: Scalar

pub const F64: Scalar

pub const I64: Scalar

pub const U64: Scalar

pub const BOOL: Scalar

pub const ABSTRACT_INT: Scalar

pub const ABSTRACT_FLOAT: Scalar

pub const fn is_abstract(self) -> bool

pub const fn float(width: u8) -> Scalar

Construct a float Scalar with the given width.

This is especially common when dealing with TypeInner::Matrix, where the scalar kind is implicit.

pub const fn to_inner_scalar(self) -> TypeInner

pub const fn to_inner_vector(self, size: VectorSize) -> TypeInner

pub const fn to_inner_atomic(self) -> TypeInner

Trait Implementations

impl Clone for Scalar

fn clone(&self) -> Scalar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scalar

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

Formats the value using the given formatter.

impl From<StorageFormat> for Scalar

fn from(format: StorageFormat) -> Scalar

Converts to this type from the input type.

impl Hash for Scalar

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

where __H: Hasher,

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 Scalar

fn cmp(&self, other: &Scalar) -> 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 Scalar

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

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

impl Eq for Scalar

impl StructuralPartialEq for Scalar