Struct DeviceAlignment 

pub struct DeviceAlignment(/* private fields */);

Vulkan analog of std’s Alignment, stored as a DeviceSize that is guaranteed to be a valid Vulkan alignment.

Implementations

impl DeviceAlignment

pub const MIN: DeviceAlignment

The smallest possible alignment, 1.

pub const MAX: DeviceAlignment

The largest possible alignment, 2⁶³.

pub const fn of<T>() -> DeviceAlignment

Returns the alignment for a type.

pub const fn new(alignment: u64) -> Option<DeviceAlignment>

Tries to create a DeviceAlignment from a DeviceSize, returning None if it’s not a power of two.

pub const unsafe fn new_unchecked(alignment: u64) -> DeviceAlignment

Creates a DeviceAlignment from a DeviceSize without checking if it’s a power of two.

Safety

• alignment must be a power of two, which also means it must be non-zero.

pub const fn as_devicesize(self) -> u64

Returns the alignment as a DeviceSize.

pub const fn as_nonzero(self) -> NonZero<u64>

Returns the alignment as a NonZeroDeviceSize.

pub const fn log2(self) -> u32

Returns the base-2 logarithm of the alignment.

Trait Implementations

impl Clone for DeviceAlignment

fn clone(&self) -> DeviceAlignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceAlignment

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

Formats the value using the given formatter.

impl Default for DeviceAlignment

fn default() -> DeviceAlignment

Returns the “default value” for a type.

impl From<DeviceAlignment> for NonZero<u64>

fn from(alignment: DeviceAlignment) -> NonZero<u64>

Converts to this type from the input type.

impl From<DeviceAlignment> for u64

fn from(alignment: DeviceAlignment) -> u64

Converts to this type from the input type.

impl Hash for DeviceAlignment

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 DeviceAlignment

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

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

fn partial_cmp(&self, other: &DeviceAlignment) -> 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 TryFrom<NonZero<u64>> for DeviceAlignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from( alignment: NonZero<u64>, ) -> Result<DeviceAlignment, <DeviceAlignment as TryFrom<NonZero<u64>>>::Error>

Performs the conversion.

impl TryFrom<u64> for DeviceAlignment

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from( alignment: u64, ) -> Result<DeviceAlignment, <DeviceAlignment as TryFrom<u64>>::Error>

Performs the conversion.

impl Copy for DeviceAlignment

impl Eq for DeviceAlignment

impl StructuralPartialEq for DeviceAlignment