Struct BufferSliceMut

pub struct BufferSliceMut<'a, T: BorrowedMutBuffer<'a> + ?Sized> { /* private fields */ }

A mutable slice to a point buffer. Works like BufferSlice, but allows mutable access to the underlying buffer. This type conditionally implements the InterleavedBufferMut and ColumnarBufferMut traits if T implements them

Implementations

impl<'a, T: BorrowedMutBuffer<'a> + ?Sized> BufferSliceMut<'a, T>

pub fn new(buffer: &'a mut T, point_range: Range<usize>) -> Self

Creates a new BufferSliceMut for the given point_range in the given buffer

Trait Implementations

impl<'a, T: BorrowedMutBuffer<'a> + ?Sized> BorrowedBuffer<'a> for BufferSliceMut<'a, T>

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

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

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 is_empty(&self) -> bool

Returns true if this buffer does not store any points

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 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 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, T: BorrowedMutBuffer<'a> + ?Sized> BorrowedMutBuffer<'a> for BufferSliceMut<'a, T>

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 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<'a, T: ColumnarBuffer<'a> + BorrowedMutBuffer<'a> + ?Sized> ColumnarBuffer<'a> for BufferSliceMut<'a, T>

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

where 'a: 'b,

Get an immutable slice to the memory of the given attribute for the point at index. See InterleavedBuffer::get_point_ref for an explanation of the lifetime bounds.

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

where 'a: 'b,

Get an immutable slice to the memory for the attribute of the given range of points

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, T: ColumnarBufferMut<'a> + BorrowedMutBuffer<'a> + ?Sized> ColumnarBufferMut<'a> for BufferSliceMut<'a, T>

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

where 'a: 'b,

Get a mutable slice to the memory of the given attribute for the point at index. This is the mutable version of ColumnarBuffer::get_attribute_ref

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

where 'a: 'b,

Get a mutable slice to the memory for the attribute of the given range of points. This is the mutable version of ColumnarBuffer::get_attribute_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, T: InterleavedBuffer<'a> + BorrowedMutBuffer<'a> + ?Sized> InterleavedBuffer<'a> for BufferSliceMut<'a, T>

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, T: InterleavedBufferMut<'a> + BorrowedMutBuffer<'a> + ?Sized> InterleavedBufferMut<'a> for BufferSliceMut<'a, T>

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, T: BorrowedBuffer<'a> + BorrowedMutBuffer<'a> + ?Sized> SliceBuffer<'a> for BufferSliceMut<'a, T>

type SliceType = BufferSlice<'a, T>

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, T: BorrowedBuffer<'a> + BorrowedMutBuffer<'a> + ?Sized> SliceBufferMut<'a> for BufferSliceMut<'a, T>

type SliceTypeMut = BufferSliceMut<'a, T>

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

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