Struct OidnBuffer 

pub struct OidnBuffer { /* private fields */ }

OIDN buffer. Owns or wraps device-accessible memory.

Implementations

impl OidnBuffer

pub fn new(device: &OidnDevice, byte_size: usize) -> Result<Self, Error>

Creates a buffer (host and device accessible) of the given size in bytes.

Errors

Returns Error::OutOfMemory if allocation fails, or an OIDN error from the device.

pub fn new_with_storage( device: &OidnDevice, byte_size: usize, storage: BufferStorage, ) -> Result<Self, Error>

Creates a buffer with the specified storage mode.

Errors

Returns Error::OutOfMemory if allocation fails, or an OIDN error from the device.

pub unsafe fn new_shared( device: &OidnDevice, dev_ptr: *mut c_void, byte_size: usize, ) -> Result<Self, Error>

Creates a shared buffer from user-owned device memory. OIDN does not take ownership.

Safety

dev_ptr must point to valid device memory of at least byte_size bytes, and remain valid for the lifetime of OIDN operations using this buffer.

Errors

Returns Error::OutOfMemory or an OIDN error if creation fails.

pub fn new_shared_from_fd( device: &OidnDevice, fd_type: ExternalMemoryTypeFlag, fd: i32, byte_size: usize, ) -> Result<Self, Error>

Creates a shared buffer from a POSIX file descriptor (e.g. DMA-BUF).

Errors

Returns Error::OutOfMemory or an OIDN error if creation fails.

pub unsafe fn new_shared_from_win32_handle( device: &OidnDevice, handle_type: ExternalMemoryTypeFlag, handle: *mut c_void, name: *const c_void, byte_size: usize, ) -> Result<Self, Error>

Creates a shared buffer from a Win32 handle.

Safety

handle and name must be valid for the given handle_type and remain valid for the lifetime of OIDN operations using this buffer.

Errors

Returns Error::OutOfMemory or an OIDN error if creation fails.

pub unsafe fn new_shared_from_metal( device: &OidnDevice, metal_buffer: *mut c_void, ) -> Result<Self, Error>

Creates a shared buffer from a Metal buffer (MTLBuffer). Only shared/private with hazard tracking.

Safety

metal_buffer must be a valid MTLBuffer and remain valid for the lifetime of OIDN operations.

Errors

Returns Error::OutOfMemory or an OIDN error if creation fails.

pub fn size(&self) -> usize

Size in bytes.

pub fn storage(&self) -> BufferStorage

Storage mode.

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

Raw pointer to buffer data (device-accessible; may be null for device-only storage).

pub unsafe fn read( &self, byte_offset: usize, byte_size: usize, dst: *mut c_void, )

Copies from buffer to host memory (synchronous).

Safety

dst must point to at least byte_size bytes of valid, writable memory.

pub unsafe fn read_async( &self, byte_offset: usize, byte_size: usize, dst: *mut c_void, )

Copies from buffer to host memory (asynchronous). Call device.sync() before using dst.

Safety

dst must point to at least byte_size bytes of valid, writable memory.

pub unsafe fn write( &self, byte_offset: usize, byte_size: usize, src: *const c_void, )

Copies from host memory to buffer (synchronous).

Safety

src must point to at least byte_size bytes of valid, readable memory.

pub unsafe fn write_async( &self, byte_offset: usize, byte_size: usize, src: *const c_void, )

Copies from host memory to buffer (asynchronous). Call device.sync() before using buffer in a filter.

Safety

src must point to at least byte_size bytes of valid, readable memory.

pub fn retain(&self)

Retains the buffer (increments OIDN reference count). For advanced interop when sharing the buffer.

Trait Implementations

impl Debug for OidnBuffer

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

Formats the value using the given formatter.

impl Drop for OidnBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Send for OidnBuffer

impl Sync for OidnBuffer