Struct pasture_core::containers::ExternalMemoryBuffer
source · pub struct ExternalMemoryBuffer<T: AsRef<[u8]>> { /* private fields */ }
Expand description
A point buffer that stores point data in interleaved memory layout in an externally borrowed memory resource.
This can be any type that is convertible to a &[u8]
. If T
also is convertible to a &mut [u8]
, this buffer
also implements [BorrowedBufferMut
]
Implementations§
source§impl<T: AsRef<[u8]>> ExternalMemoryBuffer<T>
impl<T: AsRef<[u8]>> ExternalMemoryBuffer<T>
sourcepub fn new(external_memory: T, point_layout: PointLayout) -> Self
pub fn new(external_memory: T, point_layout: PointLayout) -> Self
Creates a new ExternalMemoryBuffer
from the given external_memory
resource and the given PointLayout
Trait Implementations§
source§impl<'a, T: AsRef<[u8]>> BorrowedBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
impl<'a, T: AsRef<[u8]>> BorrowedBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
source§fn point_layout(&self) -> &PointLayout
fn point_layout(&self) -> &PointLayout
Returns the
PointLayout
of this buffer. The PointLayout
describes the structure of a single
point at runtime. Read moresource§unsafe fn get_attribute_unchecked(
&self,
attribute_member: &PointAttributeMember,
index: usize,
data: &mut [u8]
)
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 Read moresource§fn as_interleaved(&self) -> Option<&dyn InterleavedBuffer<'a>>
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
source§fn get_attribute(
&self,
attribute: &PointAttributeDefinition,
index: usize,
data: &mut [u8]
)
fn get_attribute( &self, attribute: &PointAttributeDefinition, index: usize, data: &mut [u8] )
source§fn get_attribute_range(
&self,
attribute: &PointAttributeDefinition,
point_range: Range<usize>,
data: &mut [u8]
)
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. Read moresource§fn view<'b, T: PointType>(&'b self) -> PointView<'a, 'b, Self, T>where
Self: Sized,
'a: 'b,
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 Read more
source§fn view_attribute<'b, T: PrimitiveType>(
&'b self,
attribute: &PointAttributeDefinition
) -> AttributeView<'a, 'b, Self, T>where
Self: Sized,
'a: 'b,
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 Read moresource§fn view_attribute_with_conversion<'b, T: PrimitiveType>(
&'b self,
attribute: &PointAttributeDefinition
) -> Result<AttributeViewConverting<'a, 'b, Self, T>>where
Self: Sized,
'a: 'b,
fn view_attribute_with_conversion<'b, T: PrimitiveType>(
&'b self,
attribute: &PointAttributeDefinition
) -> Result<AttributeViewConverting<'a, 'b, Self, T>>where
Self: Sized,
'a: 'b,
Like
the
view_attribute
, but allows T::data_type()
to be different from the data type ofthe
attribute
within this buffer. Read moresource§fn as_columnar(&self) -> Option<&dyn ColumnarBuffer<'a>>
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
source§impl<'a, T: AsMut<[u8]> + AsRef<[u8]>> BorrowedMutBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
impl<'a, T: AsMut<[u8]> + AsRef<[u8]>> BorrowedMutBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
source§unsafe fn set_point(&mut self, index: usize, point_data: &[u8])
unsafe fn set_point(&mut self, index: usize, point_data: &[u8])
Sets the data for the point at the given
index
Read moresource§unsafe fn set_attribute(
&mut self,
attribute: &PointAttributeDefinition,
index: usize,
attribute_data: &[u8]
)
unsafe fn set_attribute( &mut self, attribute: &PointAttributeDefinition, index: usize, attribute_data: &[u8] )
source§fn swap(&mut self, from_index: usize, to_index: usize)
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
Read moresource§unsafe fn set_point_range(
&mut self,
point_range: Range<usize>,
point_data: &[u8]
)
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
. Read moresource§unsafe fn set_attribute_range(
&mut self,
attribute: &PointAttributeDefinition,
point_range: Range<usize>,
attribute_data: &[u8]
)
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. Read moresource§fn as_interleaved_mut(&mut self) -> Option<&mut dyn InterleavedBufferMut<'a>>
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
source§fn transform_attribute<'b, T: PrimitiveType, F: Fn(usize, T) -> T>(
&'b mut self,
attribute: &PointAttributeDefinition,
func: F
)where
Self: Sized,
'a: 'b,
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. Read moresource§fn view_mut<'b, T: PointType>(&'b mut self) -> PointViewMut<'a, 'b, Self, T>where
Self: Sized,
'a: 'b,
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! Read more
source§fn view_attribute_mut<'b, T: PrimitiveType>(
&'b mut self,
attribute: &PointAttributeDefinition
) -> AttributeViewMut<'a, 'b, Self, T>where
Self: Sized,
'a: 'b,
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! Read moresource§fn as_columnar_mut(&mut self) -> Option<&mut dyn ColumnarBufferMut<'a>>
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
source§impl<'a, T: AsRef<[u8]>> InterleavedBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
impl<'a, T: AsRef<[u8]>> InterleavedBuffer<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
source§fn get_point_ref<'b>(&'b self, index: usize) -> &'b [u8] ⓘwhere
'a: 'b,
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
Read moresource§fn get_point_range_ref<'b>(&'b self, range: Range<usize>) -> &'b [u8] ⓘwhere
'a: 'b,
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 Read moresource§fn view_raw_attribute<'b>(
&'b self,
attribute: &PointAttributeMember
) -> RawAttributeView<'b>where
'a: 'b,
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
repeatedlysource§impl<'a, T: AsRef<[u8]> + AsMut<[u8]>> InterleavedBufferMut<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
impl<'a, T: AsRef<[u8]> + AsMut<[u8]>> InterleavedBufferMut<'a> for ExternalMemoryBuffer<T>where
ExternalMemoryBuffer<T>: 'a,
source§fn get_point_mut<'b>(&'b mut self, index: usize) -> &'b mut [u8] ⓘwhere
'a: 'b,
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
Read moresource§fn get_point_range_mut<'b>(&'b mut self, range: Range<usize>) -> &'b mut [u8] ⓘwhere
'a: 'b,
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
Read moresource§fn view_raw_attribute_mut<'b>(
&'b mut self,
attribute: &PointAttributeMember
) -> RawAttributeViewMut<'b>where
'a: 'b,
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 datasource§impl<'a, T: AsRef<[u8]> + 'a> SliceBuffer<'a> for ExternalMemoryBuffer<T>where
Self: 'a,
impl<'a, T: AsRef<[u8]> + 'a> SliceBuffer<'a> for ExternalMemoryBuffer<T>where
Self: 'a,
source§impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + 'a> SliceBufferMut<'a> for ExternalMemoryBuffer<T>
impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + 'a> SliceBufferMut<'a> for ExternalMemoryBuffer<T>
type SliceTypeMut = BufferSliceInterleavedMut<'a, ExternalMemoryBuffer<T>>
Auto Trait Implementations§
impl<T> RefUnwindSafe for ExternalMemoryBuffer<T>where
T: RefUnwindSafe,
impl<T> Send for ExternalMemoryBuffer<T>where
T: Send,
impl<T> Sync for ExternalMemoryBuffer<T>where
T: Sync,
impl<T> Unpin for ExternalMemoryBuffer<T>where
T: Unpin,
impl<T> UnwindSafe for ExternalMemoryBuffer<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.