Struct pasture_core::containers::PerAttributeVecPointStorage

pub struct PerAttributeVecPointStorage { /* fields omitted */ }

PointBuffer type that uses PerAttribute memory layout and Vec-based owning storage for point data

Implementations

impl PerAttributeVecPointStorage

pub fn new(layout: PointLayout) -> Self

Creates a new empty PerAttributeVecPointStorage with the given PointLayout

Examples

let layout = PointLayout::from_attributes(&[attributes::POSITION_3D]);
let storage = PerAttributeVecPointStorage::new(layout);

pub fn with_capacity(capacity: usize, layout: PointLayout) -> Self

Creates a new PerAttributeVecPointStorage with enough capacity to store capacity points using the given PointLayout. Calling this method is similar to Vec::with_capacity: Internal memory is reserved but the len() is not affected.

Examples

let layout = PointLayout::from_attributes(&[attributes::POSITION_3D]);
let storage = PerAttributeVecPointStorage::with_capacity(16, layout);

pub fn push_point<T: PointType>(&mut self, point: T)

Pushes a single point into the associated PerAttributeVecPointStorage.

Examples

#[repr(C)]
#[derive(PointType)]
struct MyPointType(#[pasture(BUILTIN_INTENSITY)] u16);

{
  let mut storage = PerAttributeVecPointStorage::new(MyPointType::layout());
  storage.push_point(MyPointType(42));
}

Panics

If the PointLayout of type T does not match the layout of the associated PerAttributeVecPointStorage.

pub fn push_points<T: PointType>(&mut self, points: &[T])

Pushes a range of points into the associated PerAttributeVecPointStorage.

Examples

#[repr(C)]
#[derive(PointType)]
struct MyPointType(#[pasture(BUILTIN_INTENSITY)] u16);

{
  let mut storage = PerAttributeVecPointStorage::new(MyPointType::layout());
  storage.push_points(&[MyPointType(42), MyPointType(43)]);
}

Panics

If the PointLayout of type T does not match the layout of the associated PerAttributeVecPointStorage.

pub fn begin_push_attributes(&mut self) -> PerAttributeVecPointStoragePusher<'_>

Create a builder for pushing attribute data into the associated PerAttributeVecPointStorage one by one

pub fn sort_by_attribute<T: PrimitiveType + Ord>(
    &mut self,
    attribute: &PointAttributeDefinition
)

Sorts all points in the associated PerAttributePointBuffer using the order of the PointType T.

Panics

If the PointLayout of T does not match the underlying layout

pub fn par_sort_by_attribute<T: PrimitiveType + Ord>(
    &mut self,
    attribute: &PointAttributeDefinition
)

Like sort_by_attribute, but sorts each attribute in parallel. Uses the rayon crate for parallelization

pub fn reserve(&mut self, additional_points: usize)

Reserves space for at least additional_points additional points in the associated PerAttributeVecPointStorage

Trait Implementations

impl<T: PointType> From<&'_ [T]> for PerAttributeVecPointStorage

fn from(slice: &[T]) -> Self

Performs the conversion.

impl<T: PointType> From<&'_ mut [T]> for PerAttributeVecPointStorage

fn from(slice: &mut [T]) -> Self

Performs the conversion.

impl<T: PointType> From<Vec<T, Global>> for PerAttributeVecPointStorage

fn from(vec: Vec<T>) -> Self

Performs the conversion.

impl<T: PointType> FromIterator<T> for PerAttributeVecPointStorage

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl PerAttributePointBuffer for PerAttributeVecPointStorage

fn get_raw_attribute_ref(
    &self,
    point_index: usize,
    attribute: &PointAttributeDefinition
) -> &[u8]

Returns a pointer to the raw memory for the attribute entry of the given point in this PointBuffer. In contrast to get_raw_attribute, this function performs no copy operations and thus can yield better performance. Panics if point_index is out of bounds or if the attribute is not part of the point_layout of this PointBuffer.

fn get_raw_attribute_range_ref(
    &self,
    index_range: Range<usize>,
    attribute: &PointAttributeDefinition
) -> &[u8]

Returns a pointer to the raw memory for the given attribute of a range of points in this PointBuffer. In contrast to get_raw_attribute_range, this function performs no copy operations and thus can yield better performance. Panics if any index in index_range is out of bounds or if the attribute is not part of the point_layout of this PointBuffer.

fn slice(&self, range: Range<usize>) -> PerAttributePointBufferSlice<'_>

Returns a read-only slice of the associated PerAttributePointBuffer

impl<'p> PerAttributePointBufferMut<'p> for PerAttributeVecPointStorage

fn get_raw_attribute_mut(
    &mut self,
    point_index: usize,
    attribute: &PointAttributeDefinition
) -> &mut [u8]

Mutable version of get_raw_attribute_ref

fn get_raw_attribute_range_mut(
    &mut self,
    index_range: Range<usize>,
    attribute: &PointAttributeDefinition
) -> &mut [u8]

Mutable version of get_raw_attribute_range_ref

fn slice_mut(
    &'p mut self,
    range: Range<usize>
) -> PerAttributePointBufferSliceMut<'p>

Returns a mutable slice of the associated PerAttributePointBufferMut

fn disjunct_slices_mut<'b>(
    &'b mut self,
    ranges: &[Range<usize>]
) -> Vec<PerAttributePointBufferSliceMut<'p>> where
    'p: 'b, 

Splits the associated PerAttributePointBufferMut into multiple disjoint mutable slices, based on the given disjoint ranges. This function is similar to Vec::split_as_mut, but can split into more than two regions.

fn as_per_attribute_point_buffer(&self) -> &dyn PerAttributePointBuffer

Helper method to access this PerAttributePointBufferMut as a PerAttributePointBuffer

impl PointBuffer for PerAttributeVecPointStorage

fn get_raw_point(&self, point_index: usize, buf: &mut [u8])

Get the data for a single point from this PointBuffer and store it inside the given memory region. Panics if point_index is out of bounds. buf must be at least as big as a single point entry in the corresponding PointLayout of this PointBuffer

fn get_raw_attribute(
    &self,
    point_index: usize,
    attribute: &PointAttributeDefinition,
    buf: &mut [u8]
)

Get the data for the given attribute of a single point from this PointBuffer and store it inside the given memory region. Panics if point_index is out of bounds or if the attribute is not part of the point_layout of this PointBuffer. buf must be at least as big as a single attribute entry of the given attribute.

fn get_raw_points(&self, point_indices: Range<usize>, buf: &mut [u8])

Get the data for a range of points from this PointBuffer and stores it inside the given memory region. Panics if any index in index_range is out of bounds. buf must be at least as big as the size of a single point entry in the corresponding PointLayout of this PointBuffer multiplied by the number of point indices in index_range

fn get_raw_attribute_range(
    &self,
    point_indices: Range<usize>,
    attribute: &PointAttributeDefinition,
    buf: &mut [u8]
)

fn len(&self) -> usize

Returns the number of unique point entries stored inside this PointBuffer

fn point_layout(&self) -> &PointLayout

Returns a reference to the underlying PointLayout of this PointBuffer

fn as_per_attribute(&self) -> Option<&dyn PerAttributePointBuffer>

Try to downcast the associated PointBuffer into an PerAttributePointBuffer

fn is_empty(&self) -> bool

Returns true if the associated PointBuffer is empty, i.e. it stores zero points

fn as_interleaved(&self) -> Option<&dyn InterleavedPointBuffer>

Try to downcast the associated PointBuffer into an InterleavedPointBuffer

impl PointBufferWriteable for PerAttributeVecPointStorage

fn push(&mut self, points: &dyn PointBuffer)

Appends the given points to the end of the associated PointBuffer

fn splice(&mut self, range: Range<usize>, replace_with: &dyn PointBuffer)

Replaces the specified range in the associated PointBuffer with the given replace_with buffer.

fn clear(&mut self)

Clears the contents of the associated PointBufferMut