Struct voladdress::VolGrid2dStrided

#[repr(transparent)]
pub struct VolGrid2dStrided<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> { /* private fields */ }

Models having many “frames” of VolGrid2d within a chunk of memory.

Each frame may or may not overlap, according to the stride specified.

• If the byte stride per frame is less than the byte size of a frame, the frames will have some amount of overlap.
• If the stride bytes equals the frame bytes, then each frame will directly follow the previous one.
• If the stride bytes exceeds the frame bytes, then there will be some amount of gap between frames.

Generic Parameters

• T / R / W: These parameters are applied to the VolAddress type returned when accessing the block in any way (indexing, iteration, etc).
• WIDTH / HEIGHT: the width and height of a given frame.
• FRAMES: the number of frames.
• BYTE_STRIDE: The number of bytes between the start of each frame.

Safety

• This type stores a base VolAddress internally, and so you must follow all of those safety rules. Notably, the base address must never be zero.
• The address space must legally contain WIDTH * HEIGHT * FRAMES contiguous values of the T type, starting from the base address.
• The memory block must not wrap around past the end of the address space.

Implementations

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

pub const unsafe fn new(address: usize) -> Self

A VolAddress with multi-frame access pattern.

Safety

The given address must be a valid for WIDTH * HEIGHT elements per frame, at frame indexes 0..FRAMES, with all non-zero frame indexes being offset by BYTE_STRIDE bytes from the previous frame.

pub const fn get_frame( self, z: usize ) -> Option<VolGrid2d<T, R, W, WIDTH, HEIGHT>>

Gets a single frame as a VolGrid2d.

Returns None if z is out of bounds.

Trait Implementations

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> Clone for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Hash, R: Hash, W: Hash, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> Hash for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

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

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<T: Ord, R: Ord, W: Ord, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> Ord for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

fn cmp( &self, other: &VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE> ) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T: PartialEq, R: PartialEq, W: PartialEq, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> PartialEq<VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>> for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

fn eq( &self, other: &VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE> ) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd, R: PartialOrd, W: PartialOrd, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> PartialOrd<VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>> for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

fn partial_cmp( &self, other: &VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE> ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> Copy for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

impl<T: Eq, R: Eq, W: Eq, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> Eq for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> StructuralEq for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>

impl<T, R, W, const WIDTH: usize, const HEIGHT: usize, const FRAMES: usize, const BYTE_STRIDE: usize> StructuralPartialEq for VolGrid2dStrided<T, R, W, WIDTH, HEIGHT, FRAMES, BYTE_STRIDE>