Struct sierra::MappableBuffer

#[repr(transparent)]
pub struct MappableBuffer { /* private fields */ }

Handle to GPU buffer object.

Variation of Buffer which is not shared and thus can be mapped onto host memory.

Mapping of shared buffer is forbidden due to requirement of GPU driver to map any memory object at most once. This allows accessing mapped memory safely without causing data races.

If buffer sharing is required and mapping is not, [MappedBuffer] can be converted into Buffer with no cost.

Implementations

impl MappableBuffer

pub fn share(self) -> Buffer

Methods from Deref<Target = Buffer>

pub fn info(&self) -> &BufferInfo

pub fn address(&self) -> Option<DeviceAddress>

pub fn is_unused(&self) -> bool

Check if buffer is unused. Caller should have exclusive access to the reference, otherwise buffer can be used at any moment.

pub fn is_mappable(&self) -> bool

Trait Implementations

impl Debug for MappableBuffer

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

Formats the value using the given formatter.

impl Deref for MappableBuffer

type Target = Buffer

The resulting type after dereferencing.

fn deref(&self) -> &Buffer

Dereferences the value.

impl From<MappableBuffer> for Buffer

fn from(buffer: MappableBuffer) -> Self

Converts to this type from the input type.

impl Hash for MappableBuffer

fn hash<H>(&self, hasher: &mut H)where
    H: Hasher,

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 PartialEq<MappableBuffer> for MappableBuffer

fn eq(&self, rhs: &Self) -> 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 Eq for MappableBuffer