Struct vulkano::memory::MappingState

pub struct MappingState { /* private fields */ }

Represents the currently host-mapped region of a DeviceMemory block.

Implementations

impl MappingState

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

Returns the pointer to the start of the mapped memory. Meaning that the pointer is already offset by the offset.

pub fn offset(&self) -> DeviceSize

Returns the offset given to DeviceMemory::map.

pub fn size(&self) -> DeviceSize

Returns the size given to DeviceMemory::map.

pub fn slice(&self, range: Range<DeviceSize>) -> Option<NonNull<[u8]>>

Returns a pointer to a slice of the mapped memory. Returns None if out of bounds.

range is specified in bytes relative to the start of the memory allocation, and must fall within the range of the memory mapping given to DeviceMemory::map.

This function is safe in the sense that the returned pointer is guaranteed to be within bounds of the mapped memory, however dereferencing the pointer isn’t:

• Normal Rust aliasing rules apply: if you create a mutable reference out of the pointer, you must ensure that no other references exist in Rust to any portion of the same memory.
• While a reference created from the pointer exists, there must be no operations pending or executing in any queue on the device, that write to any portion of the same memory.
• While a mutable reference created from the pointer exists, there must be no operations pending or executing in any queue on the device, that read from any portion of the same memory.

Trait Implementations

impl Debug for MappingState

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

Formats the value using the given formatter.

impl Send for MappingState

impl Sync for MappingState