Struct Filter 

pub struct Filter<'a> { /* private fields */ }

Generic filter created by type name (e.g. "RT", "RTLightmap").

Exposes the full OIDN filter API: buffer or shared image/data, progress monitor, async execute.

Implementations

impl<'a> Filter<'a>

pub fn new(device: &'a OidnDevice, type_name: &str) -> Result<Self, Error>

Creates a filter of the given type (e.g. "RT", "RTLightmap").

pub fn set_image( &self, name: &str, buffer: &OidnBuffer, format: ImageFormat, width: usize, height: usize, byte_offset: usize, pixel_byte_stride: usize, row_byte_stride: usize, )

Sets an image parameter from an OIDN buffer.

pub unsafe fn set_shared_image( &self, name: &str, dev_ptr: *mut c_void, format: ImageFormat, width: usize, height: usize, byte_offset: usize, pixel_byte_stride: usize, row_byte_stride: usize, )

Sets an image parameter from a raw device pointer (zero-copy). Caller keeps ownership.

pub fn unset_image(&self, name: &str)

Unsets a previously set image parameter.

pub unsafe fn set_shared_data( &self, name: &str, host_ptr: *mut c_void, byte_size: usize, )

Sets an opaque data parameter (host pointer). Caller keeps ownership.

pub fn update_data(&self, name: &str)

Notifies the filter that the contents of an opaque data parameter have changed.

pub fn unset_data(&self, name: &str)

Unsets a previously set opaque data parameter.

pub fn set_bool(&self, name: &str, value: bool)

Sets a boolean parameter.

pub fn get_bool(&self, name: &str) -> bool

Gets a boolean parameter.

pub fn set_int(&self, name: &str, value: i32)

Sets an integer parameter.

pub fn get_int(&self, name: &str) -> i32

Gets an integer parameter.

pub fn set_float(&self, name: &str, value: f32)

Sets a float parameter.

pub fn get_float(&self, name: &str) -> f32

Gets a float parameter.

pub unsafe fn set_progress_monitor_raw( &self, func: Option<unsafe extern "C" fn(user_ptr: *mut c_void, n: f64) -> bool>, user_ptr: *mut c_void, )

Sets the progress monitor callback. Call with (None, null) to clear.

pub fn commit(&self)

Commits all previous filter parameter changes. Must be called before execute.

pub fn execute(&self)

Executes the filter (synchronous). Call device.sync() after if using a GPU device.

pub fn execute_async(&self)

Executes the filter asynchronously. Call device.sync() before reading output.

pub fn device(&self) -> &'a OidnDevice

Underlying device (for sync/error).

pub fn retain(&self)

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

Trait Implementations

impl Debug for Filter<'_>

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

Formats the value using the given formatter.

impl Drop for Filter<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Filter<'_>