Struct pasture_core::containers::VectorBuffer

pub struct VectorBuffer { /* private fields */ }

A point buffer that uses a Vec<u8> as its underlying storage. It stores point data in interleaved memory layout and generally behaves like an untyped vector.

Implementations

impl VectorBuffer

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

Creates a new VectorBuffer with the given capacity and point_layout. This preallocates enough memory to store at least capacity points

Trait Implementations

impl<'a> BorrowedBuffer<'a> for VectorBuffer

where VectorBuffer: 'a,

fn len(&self) -> usize

Returns the length of this buffer, i.e. the number of points

fn point_layout(&self) -> &PointLayout

Returns the PointLayout of this buffer. The PointLayout describes the structure of a single point at runtime.

fn get_point(&self, index: usize, data: &mut [u8])

Writes the data for the point at index from this buffer into data

fn get_point_range(&self, range: Range<usize>, data: &mut [u8])

Writes the data for the given range of points from this buffer into data

unsafe fn get_attribute_unchecked( &self, attribute_member: &PointAttributeMember, index: usize, data: &mut [u8] )

Like get_attribute, but performs no check whether the attribute actually is part of this buffers PointLayout or not. Because of this, this function accepts a PointAttributeMember instead of a PointAttributeDefinition, and this PointAttributeMember must come from the PointLayout of this buffer! The benefit over get_attribute is that this function skips the include checks and thus will be faster if you repeatedly want to get data for a single attribute

fn as_interleaved(&self) -> Option<&dyn InterleavedBuffer<'a>>

Try to get a reference to self as an InterleavedBuffer. Returns None if self does not implement InterleavedBuffer

fn is_empty(&self) -> bool

Returns true if this buffer does not store any points

fn get_attribute( &self, attribute: &PointAttributeDefinition, index: usize, data: &mut [u8] )

Writes the data for the given attribute of the point at index into data

fn get_attribute_range( &self, attribute: &PointAttributeDefinition, point_range: Range<usize>, data: &mut [u8] )

Writes the data for the given attribute of the given range of points into data. The attribute data will be tightly packed in data, irregardless of the memory layout of this buffer. The attribute values might not be correctly aligned, if the alignment requirement of attribute.datatype() is larger than the size of the attribute. All of the built-in attributes in pasture have alignments that are less than or equal to their size, so for built-in attributes you can assume that the attributes in data are correctly aligned.

fn view<'b, T: PointType>(&'b self) -> PointView<'a, 'b, Self, T>

where Self: Sized, 'a: 'b,

Get a strongly typed view of the point data of this buffer

fn view_attribute<'b, T: PrimitiveType>( &'b self, attribute: &PointAttributeDefinition ) -> AttributeView<'a, 'b, Self, T>

where Self: Sized, 'a: 'b,

Gets a strongly typed view of the attribute of all points in this buffer

fn view_attribute_with_conversion<'b, T: PrimitiveType>( &'b self, attribute: &PointAttributeDefinition ) -> Result<AttributeViewConverting<'a, 'b, Self, T>>

where Self: Sized, 'a: 'b,

Like view_attribute, but allows T::data_type() to be different from the data type of
the attribute within this buffer.

fn as_columnar(&self) -> Option<&dyn ColumnarBuffer<'a>>

Try to get a reference to self as a ColumnarBuffer. Returns None if self does not implement ColumnarBuffer

impl<'a> BorrowedMutBuffer<'a> for VectorBuffer

where VectorBuffer: 'a,

unsafe fn set_point(&mut self, index: usize, point_data: &[u8])

Sets the data for the point at the given index

unsafe fn set_attribute( &mut self, attribute: &PointAttributeDefinition, index: usize, attribute_data: &[u8] )

Sets the data for the given attribute of the point at index

fn swap(&mut self, from_index: usize, to_index: usize)

Swaps the two points at from_index and to_index. Implementations should allow the case where from_index == to_index

unsafe fn set_point_range( &mut self, point_range: Range<usize>, point_data: &[u8] )

Sets the data for the given range of points. This function will generally be more efficient than calling [set_point] multiple times, as [set_point] performs size and index checks on every call, whereas this function can perform them only once. Assumes that the point_data is tightly packed, i.e. stored in an interleaved format with point alignment of 1.

unsafe fn set_attribute_range( &mut self, attribute: &PointAttributeDefinition, point_range: Range<usize>, attribute_data: &[u8] )

Sets the data for the given attribute for all points in point_range. This function will generally be more efficient than calling [set_attribute] multiple times, as [set_attribute] has to perform type and bounds checks on each call.

fn as_interleaved_mut(&mut self) -> Option<&mut dyn InterleavedBufferMut<'a>>

Try to get a mutable reference to self as an InterleavedBufferMut. Returns None if self does not implement InterleavedBufferMut

fn transform_attribute<'b, T: PrimitiveType, F: Fn(usize, T) -> T>( &'b mut self, attribute: &PointAttributeDefinition, func: F )

where Self: Sized, 'a: 'b,

Apply a transformation function to the given attribute of all points within this buffer. This function is helpful if you want to modify a single attribute of a buffer in-place and works for buffers of all memory layouts. For columnar buffers, prefer using get_attribute_range_mut to modify attribute data in-place.

fn view_mut<'b, T: PointType>(&'b mut self) -> PointViewMut<'a, 'b, Self, T>

where Self: Sized, 'a: 'b,

Get a strongly typed view of the point data of this buffer. This view allows mutating the point data!

fn view_attribute_mut<'b, T: PrimitiveType>( &'b mut self, attribute: &PointAttributeDefinition ) -> AttributeViewMut<'a, 'b, Self, T>

where Self: Sized, 'a: 'b,

Get a strongly typed view of the attribute of all points in this buffer. This view allows mutating the attribute data!

fn as_columnar_mut(&mut self) -> Option<&mut dyn ColumnarBufferMut<'a>>

Try to get a mutable reference to self as a ColumnarBufferMut. Returns None if self does not implement ColumnarBufferMut

impl Clone for VectorBuffer

fn clone(&self) -> VectorBuffer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VectorBuffer

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

Formats the value using the given formatter.

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

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

Creates a value from an iterator.

impl Hash for VectorBuffer

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<'a> InterleavedBuffer<'a> for VectorBuffer

where VectorBuffer: 'a,

fn get_point_ref<'b>(&'b self, index: usize) -> &'b [u8]

where 'a: 'b,

Get an immutable slice of the point memory of the point at index

fn get_point_range_ref<'b>(&'b self, range: Range<usize>) -> &'b [u8]

where 'a: 'b,

Get an immutable slice of the memory for the given range of points. This is the range-version of [get_point_ref], see its documentation for more details

fn view_raw_attribute<'b>( &'b self, attribute: &PointAttributeMember ) -> RawAttributeView<'b>

where 'a: 'b,

Get a raw view over the given attribute from this point buffer. Unlike the typed view that view_attribute returns, this view dereferences to byte slices, but it is potentially more efficient to use than calling get_attribute repeatedly

impl<'a> InterleavedBufferMut<'a> for VectorBuffer

where VectorBuffer: 'a,

fn get_point_mut<'b>(&'b mut self, index: usize) -> &'b mut [u8]

where 'a: 'b,

Get a mutable slice of the point memory of the point at index. This is the mutable version of InterleavedBuffer::get_point_ref

fn get_point_range_mut<'b>(&'b mut self, range: Range<usize>) -> &'b mut [u8]

where 'a: 'b,

Get a mutable slice of the memory for the given range of points. This is the mutable version of InterleavedBuffer::get_point_range_ref

fn view_raw_attribute_mut<'b>( &'b mut self, attribute: &PointAttributeMember ) -> RawAttributeViewMut<'b>

where 'a: 'b,

Like view_raw_attribute, but returns mutable byte slices of the attribute data

impl<'a> MakeBufferFromLayout<'a> for VectorBuffer

fn new_from_layout(point_layout: PointLayout) -> Self

Creates a new empty buffer from the given PointLayout

impl<'a> OwningBuffer<'a> for VectorBuffer

where VectorBuffer: 'a,

unsafe fn push_points(&mut self, point_bytes: &[u8])

Push the raw memory for a range of points into this buffer. Works similar to Vec::push

fn resize(&mut self, count: usize)

Resize this buffer to contain exactly count points. If count is less than self.len(), point data is removed, if count is greater than self.len() new points are default-constructed (i.e. zero-initialized).

fn clear(&mut self)

Clears the contents of this buffer, removing all point data and setting the length to 0

fn append_interleaved<'b, B: InterleavedBuffer<'b>>(&mut self, other: &B)

Appends data from the given interleaved buffer to the end of this buffer

fn append_columnar<'b, B: ColumnarBuffer<'b>>(&mut self, other: &B)

Appends data from the given columnar buffer to the end of this buffer

fn append<'b, B: BorrowedBuffer<'b>>(&mut self, other: &B)

Appends data from the given buffer to the end of this buffer. Makes no assumptions about the memory layout of other. If you know the memory layout of other, consider using append_interleaved or append_columnarinstead, as these will give better performance.

impl PartialEq for VectorBuffer

fn eq(&self, other: &VectorBuffer) -> 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<'a> SliceBuffer<'a> for VectorBuffer

where Self: 'a,

type SliceType = BufferSliceInterleaved<'a, VectorBuffer>

The slice type

fn slice(&'a self, range: Range<usize>) -> Self::SliceType

Take a immutable slice to this buffer using the given range of points

impl<'a> SliceBufferMut<'a> for VectorBuffer

where Self: 'a,

type SliceTypeMut = BufferSliceInterleavedMut<'a, VectorBuffer>

fn slice_mut(&'a mut self, range: Range<usize>) -> Self::SliceTypeMut

Take a mutable slice to this buffer using the given range of points

impl Eq for VectorBuffer

impl StructuralEq for VectorBuffer

impl StructuralPartialEq for VectorBuffer