Struct pasture_core::containers::InterleavedPointView

pub struct InterleavedPointView<'d> { /* fields omitted */ }

A non-owning view for a contiguous slice of interleaved point data. This is like InterleavedVecPointBuffer, but it does not own the point data. It is useful for passing around point data in an untyped but safe manner, for example in I/O heavy code.

Implementations

impl<'d> InterleavedPointView<'d>

pub fn from_slice<T: PointType>(points: &'d [T]) -> Self

Creates a new InterleavedPointView referencing the given slice of points

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

let points = vec![MyPointType(42), MyPointType(43)];
let view = InterleavedPointView::from_slice(points.as_slice());

pub fn from_raw_slice(points: &'d [u8], layout: PointLayout) -> Self

Creates a new InterleavedPointView referencing the given slice of untyped point data

pub fn get_typed_data<T: PointType>(&self) -> &'d [T]

Returns the data for the points of the associated InterleavedPointView as a typed slice.

Panics

If the PointLayout of the view does not match the layout of type T

#[repr(C)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, PointType)]
struct MyPointType(#[pasture(BUILTIN_INTENSITY)] u16);

let points = vec![MyPointType(42), MyPointType(43)];
let view = InterleavedPointView::from_slice(points.as_slice());
let points_ref = view.get_typed_data::<MyPointType>();
assert_eq!(points_ref, points.as_slice());

Trait Implementations

impl<'d> InterleavedPointBuffer for InterleavedPointView<'d>

fn get_raw_point_ref(&self, point_index: usize) -> &[u8]

Returns a pointer to the raw memory of the point entry at the given index in this PointBuffer. In contrast to get_raw_point, this function performs no copy operations and thus can yield better performance. Panics if point_index is out of bounds.

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

Returns a pointer to the raw memory of a range of point entries in this PointBuffer. In contrast to get_raw_point, this function performs no copy operations and thus can yield better performance. Panics if any index in index_range is out of bounds.

impl<'d> PointBuffer for InterleavedPointView<'d>

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, index_range: 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,
    index_range: 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_interleaved(&self) -> Option<&dyn InterleavedPointBuffer>

Try to downcast the associated PointBuffer into an InterleavedPointBuffer

fn is_empty(&self) -> bool

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

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

Try to downcast the associated PointBuffer into an PerAttributePointBuffer