Struct gfx_memory::MappedRange

pub struct MappedRange<'a, B: Backend> { /* fields omitted */ }

Represents range of the memory mapped to the host. Provides methods for safer host access to the memory.

Implementations

impl<'a, B: Backend> MappedRange<'a, B>

pub fn ptr(&self) -> NonNull<u8>

Get pointer to beginning of memory region. i.e. to range().start offset from memory origin.

pub fn range(&self) -> Range<Size>

Get mapped range.

pub fn is_coherent(&self) -> bool

Return true if the mapped memory is coherent.

pub unsafe fn read<'b, T>(
    &'b mut self,
    device: &B::Device,
    segment: Segment
) -> Result<&'b [T], MapError> where
    'a: 'b,
    T: Copy, 

Fetch readable slice of sub-range to be read. Invalidating range if memory is not coherent.

Safety

• Caller must ensure that device won't write to the memory region until the borrowing ends.
• T Must be plain-old-data type compatible with data in mapped region.

pub unsafe fn write<'b, T: 'b>(
    &'b mut self,
    device: &'b B::Device,
    segment: Segment
) -> Result<Writer<'a, 'b, T, B>, MapError> where
    'a: 'b,
    T: Copy, 

Fetch writer to the sub-region. This writer will flush data on drop if written at least once.

Safety

• Caller must ensure that device won't write to or read from the memory region.

Trait Implementations

impl<'a, B: Debug + Backend> Debug for MappedRange<'a, B>

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

Formats the value using the given formatter.