Struct Buffer 

pub struct Buffer(/* private fields */);

A buffer resource that stores data for shader access.

C++ equivalent: MTL::Buffer

Buffers can contain any type of data: vertex data, uniform data, texture data, or any other data that shaders need to access.

Implementations

impl Buffer

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a Buffer from a raw pointer.

Safety

The pointer must be a valid Metal buffer object.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer to the buffer.

pub fn length(&self) -> UInteger

Get the length of the buffer in bytes.

C++ equivalent: NS::UInteger length() const

pub fn contents(&self) -> Option<*mut c_void>

Get a CPU-accessible pointer to the buffer’s contents.

Returns None if the buffer is not CPU-accessible (e.g., private storage mode).

C++ equivalent: void* contents()

pub fn did_modify_range(&self, location: UInteger, length: UInteger)

Notify Metal that the CPU has modified the contents of the buffer.

Call this after modifying the buffer’s contents on the CPU to ensure the GPU sees the updated data.

C++ equivalent: void didModifyRange(NS::Range range)

pub fn gpu_address(&self) -> u64

Get the GPU address for bindless access.

This returns the virtual address of the buffer in GPU memory, which can be used for bindless resource access in shaders.

C++ equivalent: uint64_t gpuAddress() const

pub unsafe fn new_texture( &self, descriptor: *const c_void, offset: UInteger, bytes_per_row: UInteger, ) -> Option<Texture>

Create a texture that shares the buffer’s storage.

C++ equivalent: Texture* newTexture(const TextureDescriptor*, NS::UInteger offset, NS::UInteger bytesPerRow)

Safety

The descriptor pointer must be valid.

pub fn new_tensor( &self, descriptor: &TensorDescriptor, offset: UInteger, bytes_per_row: UInteger, ) -> Option<Tensor>

Create a tensor that shares the buffer’s storage.

C++ equivalent: Tensor* newTensor(const TensorDescriptor*, NS::UInteger offset, NS::UInteger bytesPerRow)

pub fn add_debug_marker( &self, marker: &str, location: UInteger, length: UInteger, )

Add a debug marker to the buffer.

C++ equivalent: void addDebugMarker(const NS::String*, NS::Range)

pub fn remove_all_debug_markers(&self)

Remove all debug markers from the buffer.

C++ equivalent: void removeAllDebugMarkers()

pub fn remote_storage_buffer(&self) -> Option<Buffer>

Get a remote storage buffer (for cross-process sharing).

C++ equivalent: Buffer* remoteStorageBuffer() const

pub fn new_remote_buffer_view_for_device( &self, device: &Device, ) -> Option<Buffer>

Create a remote buffer for a remote device.

C++ equivalent: Buffer* newRemoteBufferViewForDevice(Device*)

pub fn gpu_resource_id(&self) -> ResourceID

Get the GPU resource ID for bindless access.

C++ equivalent: ResourceID gpuResourceID() const

pub fn sparse_buffer_tier(&self) -> BufferSparseTier

Get the sparse buffer tier for this buffer.

C++ equivalent: BufferSparseTier sparseBufferTier() const

pub fn label(&self) -> Option<String>

Get the label for this buffer.

C++ equivalent: NS::String* label() const

pub fn set_label(&self, label: &str)

Set the label for this buffer.

C++ equivalent: void setLabel(const NS::String*)

pub fn device(&self) -> Device

Get the device that created this buffer.

C++ equivalent: Device* device() const

pub fn resource_options(&self) -> ResourceOptions

Get the resource options used to create this buffer.

C++ equivalent: ResourceOptions resourceOptions() const

pub fn allocated_size(&self) -> UInteger

Get the allocated size of this buffer.

C++ equivalent: NS::UInteger allocatedSize() const

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for Buffer

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for Buffer

impl Sync for Buffer