Enum rafx_api::RafxBuffer

pub enum RafxBuffer {
    Empty(RafxBufferEmpty),
}

Memory that can be accessed by the rendering API. It may reside in CPU or GPU memory.

Buffers must not be dropped if they are in use by the GPU.

Variants

Empty(RafxBufferEmpty)

Implementations

impl RafxBuffer

pub fn copy_to_host_visible_buffer<T: Copy>(&self, data: &[T]) -> RafxResult<()>

Copy all the data in the given slice into the buffer. This function will fail if the buffer is not writable by the CPU. This function will assert/panic if the buffer is too small to hold the data.

pub fn copy_to_host_visible_buffer_with_offset<T: Copy>( &self, data: &[T], buffer_byte_offset: u64 ) -> RafxResult<()>

Copy all the data in the given slice into the buffer with a given offset. The offset is in bytes. This function will assert/panic if the size of the buffer <= size of data + offset

pub fn buffer_def(&self) -> &RafxBufferDef

Return the definition used to create the buffer

pub fn map_buffer(&self) -> RafxResult<*mut u8>

Map the contents of the buffer into CPU memory. This function will fail if the buffer is not possible to map into CPU memory (i.e. it’s GPU-only).

The mappings are “ref-counted”. Repeated calls to map the same buffer are permitted and the buffer will remain mapped until an equal number of calls to unmap_buffer are made.

Generally speaking, keeping a buffer mapped for its entire lifetime is acceptable.

pub fn unmap_buffer(&self) -> RafxResult<()>

Unmap the contents of the buffer from CPU memory. This function will fail if the buffer is not possible to map into CPU memory (i.e. it’s GPU-only). It will also fail if the buffer is not currently mapped.

The mappings are “ref-counted”. Repeated calls to map the same buffer are permitted and the buffer will remain mapped until an equal number of calls to unmap_buffer are made.

pub fn mapped_memory(&self) -> Option<*mut u8>

Obtain a pointer to the mapped memory. If the buffer is not mapped, None is returned.

pub fn set_debug_name(&self, _name: impl AsRef<str>)

Sets a name for this buffer. This is useful for debugging, graphics debuggers/profilers such as nsight graphics or renderdoc will display this buffer with the given name in the list of resources.

pub fn empty_buffer(&self) -> Option<&RafxBufferEmpty>

Get the underlying metal API object. This provides access to any internally created metal objects.

Trait Implementations

impl Debug for RafxBuffer

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

Formats the value using the given formatter.